Reformatting list of options

This commit is contained in:
azhebel
2017-02-07 16:57:16 +03:00
parent 28f275af99
commit 2e4dc2d007
2 changed files with 57 additions and 39 deletions

View File

@@ -27,46 +27,59 @@ By default, the results are sorted by ascending query count.
Options Options
------- -------
-?, --help Show help and exit -?, --help
-a, --authenticationDatabase Specifies the database Show help and exit
used to establish credentials
and privileges with a MongoDB server. -a, --authenticationDatabase
Specifies the database used to establish credentials and privileges
with a MongoDB server.
By default, the ``admin`` database is used. By default, the ``admin`` database is used.
-c, --no-version-check Don't check for updates -c, --no-version-check
-d, --database Specifies which database to profile Don't check for updates
-l, --log-level Specifies the log level: -d, --database
``panic``, ``fatal``, ``error``, ``warn``,
``info``, ``debug error``
-n, --limit Limits the number of queries to show Specifies which database to profile
-o, --order-by Specifies the sorting order using fields: -l, --log-level
``count``, ``ratio``, ``query-time``,
``docs-scanned``, ``docs-returned``.
Adding a hypen (``-``) in front of a field Specifies the log level:
denotes reverse order. ``panic``, ``fatal``, ``error``, ``warn``, ``info``, ``debug error``
For example: ``--order-by="count,-ratio"`` -n, --limit
-p, --password Specifies the password to use Limits the number of queries to show
when connecting to a server
-o, --order-by
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. with authentication enabled.
Do not add a space between the option Do not add a space between the option and its value: ``-p<password>``.
and its value: ``-p<password>``.
If you specify the option without any value, If you specify the option without any value,
you will be prompted for the password. you will be prompted for the password.
-u, --user Specifies the user name for connecting -u, --user
to a server with authentication enabled.
-v, --version Show version and exit Specifies the user name for connecting to a server
with authentication enabled.
-v, --version
Show version and exit
Output Example Output Example
============== ==============

View File

@@ -23,21 +23,26 @@ by running administration commands and formatting the output.
Options Options
------- -------
-a, --auth-db Specifies the database used to establish credentials -a, --auth-db
and privileges with a MongoDB server.
Specifies the database used to establish credentials and privileges
with a MongoDB server.
By default, the ``admin`` database is used. By default, the ``admin`` database is used.
-p, --password Specifies the password to use when connecting -p, --password
to a server with authentication enabled.
Do not add a space between the option and its value: Specifies the password to use when connecting to a server
``-p<password>``. with authentication enabled.
Do not add a space between the option and its value: ``-p<password>``.
If you specify the option without any value, If you specify the option without any value,
``pt-mongodb-summary`` will ask for password interactively. ``pt-mongodb-summary`` will ask for password interactively.
-u, --user Specifies the user name for connecting -u, --user
to a server with authentication enabled.
Specifies the user name for connecting to a server
with authentication enabled.
Output Example Output Example
============== ==============
@@ -105,7 +110,7 @@ Output Example
Drops: 0 Drops: 0
Sections Sections
======== --------
Output is separated into the following sections: Output is separated into the following sections: