Commit 86ed75ef authored by Sumner Evans's avatar Sumner Evans 💬

Merge branch 'manpage' into 'master'

Add a manpage for sublime-music

See merge request sumner/sublime-music!38
parents 41ff2dce 116571d9
Pipeline #149152722 failed with stages
in 18 minutes
......@@ -82,3 +82,10 @@ html_theme = 'sphinx_rtd_theme'
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# -- Options for manual page output ---------------------------------------
man_pages = [
('manpages/sublime-music', 'sublime-music', u'native GTK *sonic client',
'Louis-Philippe Véronneau', 1)
]
Manual page for sublime-music
=============================
SYNOPSIS
--------
sublime-music [**-l** *LOGFILE*] [**-m** *LOGLEVEL*] [**-c** *CONFIG*]
sublime-music (**-h** \| **--help**)
sublime-music (**-v** \| **--version**)
DESCRIPTION
-----------
Sublime Music is a GTK3 Revel/Gonic/Subsonic/Airsonic/\*sonic client for the
Linux Desktop.
OPTIONS
-------
**-h**, **--help**
Show the help screen.
**-v**, **--version**
Show the version information.
**-l**, **--logfile** *LOGFILE*
The filename to send logs to.
**-m**, **--loglevel** *LOGLEVEL*
The minimum level of logging to do.
**-c**, **--config** *CONFIG*
Specify a configuration file.
Defaults to ``~/.config/sublime-music/config.json``.
BUGS
----
You can report bugs in your distribution issue tracker or upstream at
https://gitlab.com/sumner/sublime-music/-/issues
......@@ -27,7 +27,7 @@ def main():
parser.add_argument(
'-m',
'--loglevel',
help='the minium level of logging to do',
help='the minimum level of logging to do',
default='WARNING',
)
parser.add_argument(
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment