add a manpage for sublime-music

This commit is contained in:
Louis-Philippe Véronneau
2020-05-11 23:25:29 -04:00
parent 88f16d10e0
commit 116571d9f6
2 changed files with 48 additions and 0 deletions

View File

@@ -82,3 +82,10 @@ html_theme = 'sphinx_rtd_theme'
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] 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)
]

View File

@@ -0,0 +1,41 @@
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