1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-09-20 03:11:04 +00:00
supysonic/docs/man/supysonic-cli.rst

67 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2019-07-13 22:19:59 +00:00
supysonic-cli
=============
SYNOPSIS
--------
2019-07-13 22:19:59 +00:00
supysonic-cli *--help*
2019-07-13 22:19:59 +00:00
supysonic-cli **user** [*options*]
2019-07-13 22:19:59 +00:00
supysonic-cli **folder** [*options*]
2019-07-13 22:19:59 +00:00
DESCRIPTION
-----------
2019-07-13 22:19:59 +00:00
2021-01-03 15:34:29 +00:00
Supysonic is a Python implementation of the Subsonic server API.
Current supported features are:
2019-07-13 22:19:59 +00:00
* 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
* Jukebox mode
2021-01-03 15:34:29 +00:00
The "Subsonic API" is a set of adhoc standards to browse, stream or download a
music collection over HTTP.
2019-07-13 22:19:59 +00:00
2021-01-03 15:34:29 +00:00
The command-line interface is an interface allowing administration operations
without the use of the web interface.
SUBCOMMANDS
-----------
supysonic-cli has two different subcommands:
2019-07-13 22:19:59 +00:00
**user** [*options*]
User management commands
2019-07-13 22:19:59 +00:00
**folder** [*options*]
Folder management commands
2019-07-13 22:19:59 +00:00
For more details on the **user** and **folder** subcommands, see the
``subsonic-cli-user (1)``, ``subsonic-cli-folder (1)`` manual pages.
2019-07-13 22:19:59 +00:00
OPTIONS
-------
2019-07-13 22:19:59 +00:00
**-h**, **--help**
Shows the help and exits. At top level it only lists the subcommands. To
display the help of a specific subcommand, add the **--help** flag *after*
the said subcommand name.
2019-07-13 22:19:59 +00:00
BUGS
----
2019-07-13 22:19:59 +00:00
2021-01-03 15:34:29 +00:00
Bugs can be reported to your distribution's bug tracker or upstream
at https://github.com/spl0k/supysonic/issues.
2019-07-13 22:19:59 +00:00
SEE ALSO
--------
2019-07-13 22:19:59 +00:00
``supysonic-cli-user (1)``, ``supysonic-cli-folder (1)``,
``supysonic-server (1)``, ``supysonic-daemon (1)``