Merge remote-tracking branch 'baldurmen/manpages'

docs/man/README.md

@@ -0,0 +1,4 @@
+The man pages in this directory can be generated using the `rst2man` command
+line tool provided by the Python `docutils` project:
+
+    $ rst2man supysonic-cli.rst supysonic.1

docs/man/supysonic-cli-folder.rst

@@ -0,0 +1,55 @@
+====================
+supysonic-cli-folder
+====================
+
+------------------------------------
+Supysonic folder management commands
+------------------------------------
+
+:Author: Louis-Philippe Véronneau
+:Date: 2019
+:Manual section: 1
+
+Synopsis
+========
+
+| supysonic-cli folder **add** <name> <path>
+| supysonic-cli folder **delete** <name>
+| supysonic-cli folder **list**
+| supysonic-cli folder **scan** [-f] [--background | --foreground] [<name>...]
+
+Arguments
+=========
+
+| **add**     Add a new folder
+| **delete**  Delete a folder
+| **list**    List all the folders
+| **scan**    Scan all or specified folders
+
+Options
+=======
+
+| **-f** | **--force**
+|     Force scan of already known files even if they haven't changed
+
+| **--background**
+|     Scan in the background. Requires the daemon to be running
+
+| **--foreground**
+|     Scan in the foreground, blocking the process while the scan is running
+
+Examples
+========
+
+To add a new folder to your music library, you can do something like this::
+
+      $ supysonic-cli folder add MyLibrary /home/username/Music
+
+Once you've added a folder, you will need to scan it::
+
+      $ supysonic-cli folder scan MyLibrary
+
+See Also
+========
+
+supysonic-cli(1), supysonic-cli-user(1)

docs/man/supysonic-cli-user.rst

@@ -0,0 +1,56 @@
+==================
+supysonic-cli-user
+==================
+
+----------------------------------
+Supysonic user management commands
+----------------------------------
+
+:Author: Louis-Philippe Véronneau
+:Date: 2019
+:Manual section: 1
+
+Synopsis
+========
+
+| supysonic-cli user **add** <user> [-a] [-p <password>] [-e <email>]
+| supysonic-cli user **delete** <user>
+| supysonic-cli user **changepass** <user> <password>
+| supysonic-cli user **list**
+| supysonic-cli user **setadmin** [--off] <user>
+
+Arguments
+=========
+
+| **add**         Add a new user
+| **delete**      Delete the user
+| **changepass**  Change the user's password
+| **list**        List all the users
+| **setadmin**    Give admin rights to the user
+
+Options
+=======
+
+| **-a** | **--admin**
+|     Create the user with admin rights
+
+| **-p** | **--password** *<password>*
+|     Specify the user's password
+
+| **-e** | **--email** *<email>*
+|     Specify the user's email
+
+| **--off**
+|     Revoke the admin rights if present
+
+Examples
+========
+
+To add a new admin user::
+
+      $ supysonic-cli user add MyUserName -a -p MyAwesomePassword
+
+See Also
+========
+
+supysonic-cli(1), supysonic-cli-folder(1)

docs/man/supysonic-cli.rst

@@ -0,0 +1,66 @@
+=============
+supysonic-cli
+=============
+
+------------------------------------------------
+Python implementation of the Subsonic server API
+------------------------------------------------
+
+:Author: Louis-Philippe Véronneau
+:Date: 2019
+:Manual section: 1
+
+Synopsis
+========
+
+| supysonic-cli [**subcommand**]
+| supysonic-cli **help**
+| supysonic-cli **help** *user*
+| supysonic-cli **help** *folder*
+
+Description
+===========
+
+| supysonic is a Python implementation of the Subsonic server API.
+| Current supported features are:
+
+| 
+
+| * browsing (by folders or tags)
+| * streaming of various audio file formats
+| * transcoding
+| * user or random playlists
+| * cover arts (as image files in the same folder as music files)
+| * starred tracks/albums and ratings
+| * Last.FM scrobbling
+
+| The "Subsonic API" is a set of adhoc standards to browse, stream or
+| download a music collection over HTTP.
+
+Subcommands
+===========
+
+| If ran without arguments, **supysonic-cli** will open an interactive
+| prompt.
+
+**supysonic-cli** has three different subcommands:
+
+| 
+
+| * help
+| * user
+| * folder
+
+| For more details on the **user** and **folder** subcommands, see the
+| subsonic-cli-user(1), subsonic-cli-folder(1) manual pages.
+
+Bugs
+====
+
+| Bugs can be reported to your distribution's bug tracker or upstream
+| at https://github.com/spl0k/supysonic/issues.
+
+See Also
+========
+
+supysonic-cli-user(1), supysonic-cli-folder(1)

docs/man/supysonic-daemon.rst

@@ -0,0 +1,38 @@
+================
+supysonic-daemon
+================
+
+------------------------
+Supysonic scanner daemon
+------------------------
+
+:Author: Louis-Philippe Véronneau
+:Date: 2019
+:Manual section: 1
+
+Synopsis
+========
+
+| supysonic-daemon
+
+Description
+===========
+
+| **supysonic-daemon** is an optional non-exiting process made to be ran in the
+| background to manage background scans and library changes detection.
+
+| If **supysonic-daemon** is running when you start a manual scan using
+| **supysonic-cli(1)**, the scan will be run by the daemon process in the
+| background instead of running in the foreground. This daemon also enables the
+| web UI scan feature.
+
+Bugs
+====
+
+| Bugs can be reported to your distribution's bug tracker or upstream
+| at https://github.com/spl0k/supysonic/issues.
+
+See Also
+========
+
+supysonic-cli(1)