docs: Mark command line options with :option:

This commit is contained in:
Stein Magnus Jodal 2013-04-15 18:28:12 +02:00
parent 8939167e88
commit 90067a2128
2 changed files with 6 additions and 5 deletions

View File

@ -28,9 +28,9 @@ the config values you want to change. If you want to keep the default for a
config value, you **should not** add it to ``~/.config/mopidy/mopidy.conf``. config value, you **should not** add it to ``~/.config/mopidy/mopidy.conf``.
To see what's the effective configuration for your Mopidy installation, you can To see what's the effective configuration for your Mopidy installation, you can
run ``mopidy --show-config``. It will print your full effective config with run :option:`mopidy --show-config`. It will print your full effective config
passwords masked out so that you safely can share the output with others for with passwords masked out so that you safely can share the output with others
debugging. for debugging.
You can find a description of all config values belonging to Mopidy's core You can find a description of all config values belonging to Mopidy's core
below, together with their default values. In addition, all :ref:`extensions below, together with their default values. In addition, all :ref:`extensions
@ -95,7 +95,7 @@ Core configuration values
.. confval:: logging/debug_file .. confval:: logging/debug_file
The file to dump debug log data to when Mopidy is run with the The file to dump debug log data to when Mopidy is run with the
:option:`--save-debug-log` option. :option:`mopidy --save-debug-log` option.
.. confval:: logging.levels/* .. confval:: logging.levels/*

View File

@ -40,7 +40,8 @@ sends all requests to both, returning the primary response to the client and
then printing any diff in the two responses. then printing any diff in the two responses.
Note that this tool depends on ``gevent`` unlike the rest of Mopidy at the time Note that this tool depends on ``gevent`` unlike the rest of Mopidy at the time
of writing. See ``--help`` for available options. Sample session:: of writing. See :option:`tools/debug-proxy.py --help` for available options.
Sample session::
[127.0.0.1]:59714 [127.0.0.1]:59714
listallinfo listallinfo