From be5582e2122f8cb7786b0a6bb9e7ed363a06c84b Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Fri, 1 Nov 2013 16:39:03 +0100 Subject: [PATCH] docs: Add manpages for all commands --- docs/commands/index.rst | 13 +++ docs/commands/mopidy-convert-config.rst | 99 ++++++++++++++++++ docs/commands/mopidy-scan.rst | 59 +++++++++++ docs/commands/mopidy.rst | 124 +++++++++++++++++++++++ docs/conf.py | 27 +++++ docs/index.rst | 1 + docs/running.rst | 128 ++---------------------- 7 files changed, 330 insertions(+), 121 deletions(-) create mode 100644 docs/commands/index.rst create mode 100644 docs/commands/mopidy-convert-config.rst create mode 100644 docs/commands/mopidy-scan.rst create mode 100644 docs/commands/mopidy.rst diff --git a/docs/commands/index.rst b/docs/commands/index.rst new file mode 100644 index 00000000..bc169465 --- /dev/null +++ b/docs/commands/index.rst @@ -0,0 +1,13 @@ +.. _commands: + +******** +Commands +******** + +Mopidy comes with the following commands: + +.. toctree:: + :maxdepth: 1 + :glob: + + ** diff --git a/docs/commands/mopidy-convert-config.rst b/docs/commands/mopidy-convert-config.rst new file mode 100644 index 00000000..7f1e6242 --- /dev/null +++ b/docs/commands/mopidy-convert-config.rst @@ -0,0 +1,99 @@ +.. _mopidy-convert-config: + +***************************** +mopidy-convert-config command +***************************** + +Synopsis +======== + +mopidy-convert-config + [-h] [--version] [-q] [-v] + + +Description +=========== + +Mopidy is a music server which can play music both from multiple sources, like +your local hard drive, radio streams, and from Spotify and SoundCloud. Searches +combines results from all music sources, and you can mix tracks from all +sources in your play queue. Your playlists from Spotify or SoundCloud are also +available for use. + +The ``mopidy-convert-config`` command is used to convert ``settings.py`` +configuration files used by ``mopidy`` < 0.14 to the ``mopidy.conf`` config +file used by ``mopidy`` >= 0.14. + + +Options +======= + +.. program:: mopidy-convert-config + +This program does not take any options. It looks for the pre-0.14 settings file +at ``$XDG_CONFIG_DIR/mopidy/settings.py``, and if it exists it converts it and +ouputs a Mopidy 0.14 compatible ini-format configuration. If you don't already +have a config file at ``$XDG_CONFIG_DIR/mopidy/mopidy.conf``, you're asked if +you want to save the converted config to that file. + + +Example +======= + +Given the following contents in ``~/.config/mopidy/settings.py``: + +:: + + LOCAL_MUSIC_PATH = u'~/music' + MPD_SERVER_HOSTNAME = u'::' + SPOTIFY_PASSWORD = u'secret' + SPOTIFY_USERNAME = u'alice' + +Running ``mopidy-convert-config`` will convert the config and create a new +``mopidy.conf`` config file: + +.. code-block:: none + + $ mopidy-convert-config + Checking /home/alice/.config/mopidy/settings.py + Converted config: + + [spotify] + username = alice + password = ******** + + [mpd] + hostname = :: + + [local] + media_dir = ~/music + + Write new config to /home/alice/.config/mopidy/mopidy.conf? [yN] y + Done. + +Contents of ``~/.config/mopidy/mopidy.conf`` after the conversion: + +.. code-block:: ini + + [spotify] + username = alice + password = secret + + [mpd] + hostname = :: + + [local] + media_dir = ~/music + + +See also +======== + +:ref:`mopidy(1) ` + + +Reporting bugs +============== + +Report bugs to Mopidy's issue tracker at + diff --git a/docs/commands/mopidy-scan.rst b/docs/commands/mopidy-scan.rst new file mode 100644 index 00000000..e8c25f77 --- /dev/null +++ b/docs/commands/mopidy-scan.rst @@ -0,0 +1,59 @@ +.. _mopidy-scan-cmd: + +******************* +mopidy-scan command +******************* + +Synopsis +======== + +mopidy-scan + [-h] [--version] [-q] [-v] + + +Description +=========== + +Mopidy is a music server which can play music both from multiple sources, like +your local hard drive, radio streams, and from Spotify and SoundCloud. Searches +combines results from all music sources, and you can mix tracks from all +sources in your play queue. Your playlists from Spotify or SoundCloud are also +available for use. + +The ``mopidy-scan`` command is used to index a music library to make it +available for playback with ``mopidy``. + + +Options +======= + +.. program:: mopidy-scan + +.. cmdoption:: --version + + Show Mopidy's version number and exit. + +.. cmdoption:: -h, --help + + Show help message and exit. + +.. cmdoption:: -q, --quiet + + Show less output: warning level and higher. + +.. cmdoption:: -v, --verbose + + Show more output: debug level and higher. + + +See also +======== + +:ref:`mopidy(1) ` + + +Reporting bugs +============== + +Report bugs to Mopidy's issue tracker at + diff --git a/docs/commands/mopidy.rst b/docs/commands/mopidy.rst new file mode 100644 index 00000000..df4766c3 --- /dev/null +++ b/docs/commands/mopidy.rst @@ -0,0 +1,124 @@ +.. _mopidy-cmd: + +************** +mopidy command +************** + +Synopsis +======== + +mopidy + [-h] [--version] [-q] [-v] [--save-debug-log] [--show-config] + [--show-deps] [--config CONFIG_FILES] [-o CONFIG_OVERRIDES] + + +Description +=========== + +Mopidy is a music server which can play music both from multiple sources, like +your local hard drive, radio streams, and from Spotify and SoundCloud. Searches +combines results from all music sources, and you can mix tracks from all +sources in your play queue. Your playlists from Spotify or SoundCloud are also +available for use. + +The ``mopidy`` command is used to start the server. + + +Options +======= + +.. program:: mopidy + +.. cmdoption:: -h, --help + + Show help message and exit. + +.. cmdoption:: --version + + Show Mopidy's version number and exit. + +.. cmdoption:: -q, --quiet + + Show less output: warning level and higher. + +.. cmdoption:: -v, --verbose + + Show more output: debug level and higher. + +.. cmdoption:: --save-debug-log + + Save debug log to the file specified in the :confval:`logging/debug_file` + config value, typically ``./mopidy.log``. + +.. cmdoption:: --show-config + + Show the current effective config. All configuration sources are merged + together to show the effective document. Secret values like passwords are + masked out. Config for disabled extensions are not included. + +.. cmdoption:: --show-deps + + Show dependencies, their versions and installation location. + +.. cmdoption:: --config + + Specify config file to use. To use multiple config files, separate them + with colon. The later files override the earlier ones if there's a + conflict. + +.. cmdoption:: -o