Complete user docs.

This commit is contained in:
Daniel Nichter
2011-08-03 17:17:46 -06:00
parent 5ca914b932
commit 2a22fa0fcb
53 changed files with 1727 additions and 1427 deletions

20
docs/user/environment.rst Normal file
View File

@@ -0,0 +1,20 @@
.. highlight:: perl
***********
ENVIRONMENT
***********
The environment variable \ ``PTDEBUG``\ enables verbose debugging output to STDERR.
To enable debugging and capture all output to a file, run the tool like:
.. code-block:: perl
PTDEBUG=1 pt-table-checksum ... > FILE 2>&1
Be careful: debugging output is voluminous and can generate several megabytes
of output.