diff --git a/docs/api/backends.rst b/docs/api/backends.rst index ec78f250..a85feb03 100644 --- a/docs/api/backends.rst +++ b/docs/api/backends.rst @@ -39,6 +39,11 @@ Library provider .. autoclass:: mopidy.backends.base.BaseLibraryProvider :members: +Sub-command provider +==================== + +.. autoclass:: mopidy.backends.base.BaseSubCommandProvider + :members: Backend listener ================ diff --git a/docs/commands/mopidy-scan.rst b/docs/commands/mopidy-scan.rst deleted file mode 100644 index e8c25f77..00000000 --- a/docs/commands/mopidy-scan.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. _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 index df4766c3..c4a35973 100644 --- a/docs/commands/mopidy.rst +++ b/docs/commands/mopidy.rst @@ -8,8 +8,8 @@ Synopsis ======== mopidy - [-h] [--version] [-q] [-v] [--save-debug-log] [--show-config] - [--show-deps] [--config CONFIG_FILES] [-o CONFIG_OVERRIDES] + [-h] [--version] [-q] [-v] [--save-debug-log] [--config CONFIG_FILES] + [-o CONFIG_OVERRIDES] COMMAND ... Description @@ -21,7 +21,7 @@ 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. +The ``mopidy run`` command is used to start the server. Options @@ -50,16 +50,6 @@ Options 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 @@ -72,6 +62,37 @@ Options be provided multiple times. +Built in sub-commands +===================== + +.. cmdoption:: run + + Run the mopidy server. + +.. cmdoption:: 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:: deps + + Show dependencies, their versions and installation location. + + +Extension sub-commands +====================== + +Additionally, extensions can provide extra sub-commands. See ``mopidy --help`` +for a list of what is availbale on your system and ``mopidy COMMAND --help`` +for command specific help. Sub-commands for disabled extensions will be listed, +but can not be run. + +.. cmdoption:: local + + Scan local media files present in your library. + + Files ===== @@ -88,34 +109,32 @@ Examples To start the music server, run:: - mopidy + mopidy run To start the server with an additional config file than can override configs set in the default config files, run:: - mopidy --config ./my-config.conf + mopidy --config ./my-config.conf run To start the server and change a config value directly on the command line, run:: - mopidy --option mpd/enabled=false + mopidy --option mpd/enabled=false run The :option:`--option` flag may be repeated multiple times to change multiple configs:: - mopidy -o mpd/enabled=false -o spotify/bitrate=320 + mopidy -o mpd/enabled=false -o spotify/bitrate=320 run -The :option:`--show-config` output shows the effect of the :option:`--option` -flags:: +``mopidy config`` output shows the effect of the :option:`--option` flags:: - mopidy -o mpd/enabled=false -o spotify/bitrate=320 --show-config + mopidy -o mpd/enabled=false -o spotify/bitrate=320 config See also ======== -:ref:`mopidy-scan(1) `, :ref:`mopidy-convert-config(1) -` +:ref:`mopidy-convert-config(1) ` Reporting bugs ============== diff --git a/docs/conf.py b/docs/conf.py index 77ee897e..eb23daf5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -141,13 +141,6 @@ man_pages = [ '', '1' ), - ( - 'commands/mopidy-scan', - 'mopidy-scan', - 'index music for playback with mopidy', - '', - '1' - ), ( 'commands/mopidy-convert-config', 'mopidy-convert-config', diff --git a/docs/contributing.rst b/docs/contributing.rst index 22df8ced..b25c5f6d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -70,9 +70,9 @@ repo. #. Now you can run the Mopidy command, and it will run using the code in the Git repo:: - mopidy + mopidy run - If you do any changes to the code, you'll just need to restart ``mopidy`` + If you do any changes to the code, you'll just need to restart ``mopidy run`` to see the changes take effect. diff --git a/docs/ext/local.rst b/docs/ext/local.rst index f6b281bd..79307ea4 100644 --- a/docs/ext/local.rst +++ b/docs/ext/local.rst @@ -71,7 +71,7 @@ music... Generating a tag cache ---------------------- -The program :command:`mopidy-scan` will scan the path set in the +The program :command:`mopidy scan` will scan the path set in the :confval:`local/media_dir` config value for any media files and build a MPD compatible ``tag_cache``. @@ -80,16 +80,11 @@ To make a ``tag_cache`` of your local music available for Mopidy: #. Ensure that the :confval:`local/media_dir` config value points to where your music is located. Check the current setting by running:: - mopidy --show-config + mopidy config -#. Scan your media library. The command outputs the ``tag_cache`` to - standard output, which means that you will need to redirect the output to a - file yourself:: +#. Scan your media library. The command writes the ``tag_cache`` to + the :confval:`local/tag_cache_file`:: - mopidy-scan > tag_cache - -#. Move the ``tag_cache`` file to the location - set in the :confval:`local/tag_cache_file` config value, or change the - config value to point to where your ``tag_cache`` file is. + mopidy scan #. Start Mopidy, find the music library in a client, and play some local music! diff --git a/docs/running.rst b/docs/running.rst index c96805e4..389f6917 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -4,10 +4,10 @@ Running Mopidy To start Mopidy, simply open a terminal and run:: - mopidy + mopidy run For a complete reference to the Mopidy commands and their command line options, -see :ref:`mopidy-cmd` and :ref:`mopidy-scan-cmd`. +see :ref:`mopidy-cmd`. When Mopidy says ``MPD server running at [127.0.0.1]:6600`` it's ready to accept connections by any MPD client. Check out our non-exhaustive diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 7ee4d417..f344b1cf 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -28,7 +28,7 @@ accepted, but large logs should still be shared through a pastebin. Effective configuration ======================= -The command :option:`mopidy --show-config` will print your full effective +The command ``mopidy config`` will print your full effective configuration the way Mopidy sees it after all defaults and all config files have been merged into a single config document. Any secret values like passwords are masked out, so the output of the command should be safe to share @@ -38,7 +38,7 @@ with others for debugging. Installed dependencies ====================== -The command :option:`mopidy --show-deps` will list the paths to and versions of +The command ``mopidy deps`` will list the paths to and versions of any dependency Mopidy or the extensions might need to work. This is very useful data for checking that you're using the right versions, and that you're using the right installation if you have multiple installations of a dependency on