From 2e4dc2d0075457949c125fdbc9ce5ae2f9a45500 Mon Sep 17 00:00:00 2001 From: azhebel Date: Tue, 7 Feb 2017 16:57:16 +0300 Subject: [PATCH] Reformatting list of options --- docs/pt-mongodb-query-digest.rst | 67 +++++++++++++++++++------------- docs/pt-mongodb-summary.rst | 29 ++++++++------ 2 files changed, 57 insertions(+), 39 deletions(-) diff --git a/docs/pt-mongodb-query-digest.rst b/docs/pt-mongodb-query-digest.rst index 52310d74..46937aba 100644 --- a/docs/pt-mongodb-query-digest.rst +++ b/docs/pt-mongodb-query-digest.rst @@ -27,46 +27,59 @@ By default, the results are sorted by ascending query count. Options ------- --?, --help Show help and exit +-?, --help --a, --authenticationDatabase Specifies the database - used to establish credentials - and privileges with a MongoDB server. - By default, the ``admin`` database is used. + Show help and exit --c, --no-version-check Don't check for updates +-a, --authenticationDatabase --d, --database Specifies which database to profile + Specifies the database used to establish credentials and privileges + with a MongoDB server. + By default, the ``admin`` database is used. --l, --log-level Specifies the log level: - ``panic``, ``fatal``, ``error``, ``warn``, - ``info``, ``debug error`` +-c, --no-version-check --n, --limit Limits the number of queries to show + Don't check for updates --o, --order-by Specifies the sorting order using fields: - ``count``, ``ratio``, ``query-time``, - ``docs-scanned``, ``docs-returned``. +-d, --database - Adding a hypen (``-``) in front of a field - denotes reverse order. + Specifies which database to profile - For example: ``--order-by="count,-ratio"`` +-l, --log-level --p, --password Specifies the password to use - when connecting to a server - with authentication enabled. + Specifies the log level: + ``panic``, ``fatal``, ``error``, ``warn``, ``info``, ``debug error`` - Do not add a space between the option - and its value: ``-p``. +-n, --limit - If you specify the option without any value, - you will be prompted for the password. + Limits the number of queries to show --u, --user Specifies the user name for connecting - to a server with authentication enabled. +-o, --order-by --v, --version Show version and exit + Specifies the sorting order using fields: + ``count``, ``ratio``, ``query-time``, ``docs-scanned``, ``docs-returned``. + + Adding a hypen (``-``) in front of a field denotes reverse order. + For example: ``--order-by="count,-ratio"``. + +-p, --password + + Specifies the password to use when connecting to a server + with authentication enabled. + + Do not add a space between the option and its value: ``-p``. + + If you specify the option without any value, + you will be prompted for the password. + +-u, --user + + Specifies the user name for connecting to a server + with authentication enabled. + +-v, --version + + Show version and exit Output Example ============== diff --git a/docs/pt-mongodb-summary.rst b/docs/pt-mongodb-summary.rst index 0dc3b340..a96b75e2 100644 --- a/docs/pt-mongodb-summary.rst +++ b/docs/pt-mongodb-summary.rst @@ -23,21 +23,26 @@ by running administration commands and formatting the output. Options ------- --a, --auth-db Specifies the database used to establish credentials - and privileges with a MongoDB server. - By default, the ``admin`` database is used. +-a, --auth-db --p, --password Specifies the password to use when connecting - to a server with authentication enabled. + Specifies the database used to establish credentials and privileges + with a MongoDB server. + By default, the ``admin`` database is used. - Do not add a space between the option and its value: - ``-p``. +-p, --password - If you specify the option without any value, - ``pt-mongodb-summary`` will ask for password interactively. + Specifies the password to use when connecting to a server + with authentication enabled. --u, --user Specifies the user name for connecting - to a server with authentication enabled. + Do not add a space between the option and its value: ``-p``. + + If you specify the option without any value, + ``pt-mongodb-summary`` will ask for password interactively. + +-u, --user + + Specifies the user name for connecting to a server + with authentication enabled. Output Example ============== @@ -105,7 +110,7 @@ Output Example Drops: 0 Sections -======== +-------- Output is separated into the following sections: