Complete user docs.

docs/user/tools.rst

@@ -1,12 +1,236 @@
-Tools
-=====
+.. highlight:: perl
 
-Contents:
+
+*****
+TOOLS
+*****
+
+
+This release of Percona Toolkit includes the following tools:
+
+
+:doc:`pt-archiver`
+ 
+ Archive rows from a MySQL table into another table or a file.
+ 
+
+
+:doc:`pt-checksum-filter`
+ 
+ Filter checksums from pt-table-checksum.
+ 
+
+
+:doc:`pt-collect`
+ 
+ Collect information from a server for some period of time.
+ 
+
+
+:doc:`pt-config-diff`
+ 
+ Diff MySQL configuration files and server variables.
+ 
+
+
+:doc:`pt-deadlock-logger`
+ 
+ Extract and log MySQL deadlock information.
+ 
+
+
+:doc:`pt-diskstats`
+ 
+ Read a file generated from /proc/diskstats and summarize it.
+ 
+
+
+:doc:`pt-duplicate-key-checker`
+ 
+ Find duplicate indexes and foreign keys on MySQL tables.
+ 
+
+
+:doc:`pt-fifo-split`
+ 
+ Split files and pipe lines to a fifo without really splitting.
+ 
+
+
+:doc:`pt-find`
+ 
+ Find MySQL tables and execute actions, like GNU find.
+ 
+
+
+:doc:`pt-fk-error-logger`
+ 
+ Extract and log MySQL foreign key errors.
+ 
+
+
+:doc:`pt-heartbeat`
+ 
+ Monitor MySQL replication delay.
+ 
+
+
+:doc:`pt-index-usage`
+ 
+ Read queries from a log and analyze how they use indexes.
+ 
+
+
+:doc:`pt-kill`
+ 
+ Kill MySQL queries that match certain criteria.
+ 
+
+
+:doc:`pt-log-player`
+ 
+ Replay MySQL query logs.
+ 
+
+
+:doc:`pt-mext`
+ 
+ Aggregate and summarize mysqladmin extended output.
+ 
+
+
+:doc:`pt-mysql-summary`
+ 
+ Summarize MySQL information in a nice way.
+ 
+
+
+:doc:`pt-online-schema-change`
+ 
+ Perform online, non-blocking table schema changes.
+ 
+
+
+:doc:`pt-pmp`
+ 
+ Aggregate GDB stack traces for a selected program.
+ 
+
+
+:doc:`pt-profile-compact`
+ 
+ Compact the output from pt-query-profiler.
+ 
+
+
+:doc:`pt-query-advisor`
+ 
+ Analyze queries and advise on possible problems.
+ 
+
+
+:doc:`pt-query-digest`
+ 
+ Analyze query execution logs and generate a query report, filter, replay, or transform queries for MySQL, PostgreSQL, memcached, and more.
+ 
+
+
+:doc:`pt-query-profiler`
+ 
+ Execute SQL statements and print statistics, or measure activity caused by other processes.
+ 
+
+
+:doc:`pt-show-grants`
+ 
+ Canonicalize and print MySQL grants so you can effectively replicate, compare and version-control them.
+ 
+
+
+:doc:`pt-sift`
+ 
+ Browses the files created by the collect tool.
+ 
+
+
+:doc:`pt-slave-delay`
+ 
+ Make a MySQL slave server lag behind its master.
+ 
+
+
+:doc:`pt-slave-find`
+ 
+ Find and print replication hierarchy tree of MySQL slaves.
+ 
+
+
+:doc:`pt-slave-restart`
+ 
+ Watch and restart MySQL replication after errors.
+ 
+
+
+:doc:`pt-stalk`
+ 
+ Watch MySQL and run the 'collect' program when some condition becomes true.
+ 
+
+
+:doc:`pt-summary`
+ 
+ Summarize system information in a nice way.
+ 
+
+
+:doc:`pt-table-checksum`
+ 
+ Perform an online replication consistency check, or checksum MySQL tables efficiently on one or many servers.
+ 
+
+
+:doc:`pt-table-sync`
+ 
+ Synchronize MySQL table data efficiently.
+ 
+
+
+:doc:`pt-tcp-model`
+ 
+ Transform tcpdump into metrics that permit performance and scalability modeling.
+ 
+
+
+:doc:`pt-trend`
+ 
+ Compute statistics over a set of time-series data points.
+ 
+
+
+:doc:`pt-upgrade`
+ 
+ Execute queries on multiple servers and check for differences.
+ 
+
+
+:doc:`pt-variable-advisor`
+ 
+ Analyze MySQL variables and advise on possible problems.
+ 
+
+
+:doc:`pt-visual-explain`
+ 
+ Format EXPLAIN output as a tree.
+ 
+
+
+For more free, open-source software developed Percona, visit
+`http://www.percona.com/software/ <http://www.percona.com/software/>`_.
 
 .. toctree::
-   :maxdepth: 1
+   :hidden:
 
-   pt-align
    pt-archiver
    pt-checksum-filter
    pt-collect
@@ -29,7 +253,6 @@ Contents:
    pt-query-advisor
    pt-query-digest
    pt-query-profiler
-   pt-rel
    pt-show-grants
    pt-sift
    pt-slave-delay