percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-09-18 17:58:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

PT-1662 fix pt-secure-collect doc styles

Browse Source
This commit is contained in:
Dima
2018-12-03 15:52:02 +03:00
parent d6b8863a3a
commit eff5d89e76
1 changed files with 276 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
docs/pt-secure-collect.rst
View File

@@ -1,8 +1,25 @@
pt-secure-collect .. program:: pt-secure-collect
=================
Collect, sanitize, pack and encrypt data. By default, this program will ============================
collect the output of: :program:`pt-secure-collect`
============================
NAME
====
:program:`pt-secure-collect` - collect, sanitize, pack and encrypt data.
SYNOPSIS
========
Usage
-----
::
pt-secure-data [<flags>] <command> [<args> ...]
By default, :program:`pt-secure-collect` will collect the output of:
- ``pt-stalk --no-stalk --iterations=2 --sleep=30 --host=$mysql-host --dest=$temp-dir --port=$mysql-port --user=$mysql-user --password=$mysql-pass`` - ``pt-stalk --no-stalk --iterations=2 --sleep=30 --host=$mysql-host --dest=$temp-dir --port=$mysql-port --user=$mysql-user --password=$mysql-pass``
- ``pt-summary`` - ``pt-summary``
@@ -12,14 +29,8 @@ Internal variables placeholders will be replaced with the corresponding
flag values. For example, ``$mysql-host`` will be replaced with the flag values. For example, ``$mysql-host`` will be replaced with the
values specified in the ``--mysql-host`` flag. values specified in the ``--mysql-host`` flag.
Usage:
::
pt-secure-data [<flags>] <command> [<args> ...]
Global flags Global flags
~~~~~~~~~~~~ ------------
+-----------+----------------------------------------------------------------------+ +-----------+----------------------------------------------------------------------+
| Flag | Description | | Flag | Description |
@@ -29,16 +40,14 @@ Global flags
| --debug | Enable debug log level. | | --debug | Enable debug log level. |
+-----------+----------------------------------------------------------------------+ +-----------+----------------------------------------------------------------------+
**Commands** COMMANDS
~~~~~~~~~~~~ ========
**Help command** * **Help command**
^^^^^^^^^^^^^^^^
Show help Show help
**Collect command** * **Collect command**
^^^^^^^^^^^^^^^^^^^
Collect, sanitize, pack and encrypt data from pt-tools. Usage: Collect, sanitize, pack and encrypt data from pt-tools. Usage:
@@ -216,12 +225,10 @@ Collect, sanitize, pack and encrypt data from pt-tools. Usage:
| | files. | | | files. |
+--------+--------+ +--------+--------+
**Decrypt command** * **Decrypt command**
^^^^^^^^^^^^^^^^^^^
| Decrypt an encrypted file. The password will be requested from the Decrypt an encrypted file. The password will be requested from the
terminal. terminal. Usage:
| Usage:
:: ::
@@ -256,11 +263,9 @@ Collect, sanitize, pack and encrypt data from pt-tools. Usage:
| | on | | | on |
+--------+---------+ +--------+---------+
**Encrypt command** * **Encrypt command**
^^^^^^^^^^^^^^^^^^^
| Encrypt a file. The password will be requested from the terminal. Encrypt a file. The password will be requested from the terminal. Usage:
| Usage:
:: ::
@@ -295,12 +300,10 @@ Collect, sanitize, pack and encrypt data from pt-tools. Usage:
| | on | | | on |
+--------+---------+ +--------+---------+
**Sanitize command** * **Sanitize command**
^^^^^^^^^^^^^^^^^^^^
| Replace queries in a file by their fingerprints and obfuscate Replace queries in a file by their fingerprints and obfuscate hostnames.
hostnames. Usage:
| Usage:
:: ::