From 90067a2128d15c6803479d219567e81912c73d6d Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 15 Apr 2013 18:28:12 +0200 Subject: [PATCH] docs: Mark command line options with :option: --- docs/config.rst | 8 ++++---- docs/devtools.rst | 3 ++- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 3b31f0dd..44e65875 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -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``. 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 -passwords masked out so that you safely can share the output with others for -debugging. +run :option:`mopidy --show-config`. It will print your full effective config +with passwords masked out so that you safely can share the output with others +for debugging. 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 @@ -95,7 +95,7 @@ Core configuration values .. confval:: logging/debug_file 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/* diff --git a/docs/devtools.rst b/docs/devtools.rst index 7b5b2f81..bc066cd0 100644 --- a/docs/devtools.rst +++ b/docs/devtools.rst @@ -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. 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 listallinfo