debian man page for pt-sift

PT-SIFT(1p)						User Contributed Perl Documentation					       PT-SIFT(1p)

NAME
       pt-sift - Browses files created by pt-collect.

SYNOPSIS
       Usage: pt-sift FILE|PREFIX|DIRECTORY

       pt-sift browses the files created by pt-collect.  If you specify a FILE or PREFIX, it browses only files with that prefix.  If you specify
       a DIRECTORY, then it browses all files within that directory.

RISKS
       The following section is included to inform users about the potential risks, whether known or unknown, of using this tool.  The two main
       categories of risks are those created by the nature of the tool (e.g. read-only tools vs. read-write tools) and those created by bugs.

       pt-sift is a read-only tool.  It should be very low-risk.

       At the time of this release, we know of no bugs that could cause serious harm to users.

       The authoritative source for updated information is always the online issue tracking system.  Issues that affect this tool will be marked
       as such.  You can see a list of such issues at the following URL: http://www.percona.com/bugs/pt-sift <http://www.percona.com/bugs/pt-
       sift>.

       See also "BUGS" for more information on filing bugs and getting help.

DESCRIPTION
       pt-sift downloads other tools that it might need, such as pt-diskstats, and then makes a list of the unique timestamp prefixes of all the
       files in the directory, as written by the pt-collect tool.  If the user specified a timestamp on the command line, then it begins with that
       sample of data; otherwise it begins by showing a list of the timestamps and prompting for a selection.  Thereafter, it displays a summary
       of the selected sample, and the user can navigate and inspect with keystrokes.  The keystroke commands you can use are as follows:

       d   Sets the action to start the pt-diskstats tool on the sample's disk performance statistics.

       i   Sets the action to view the first INNODB STATUS sample in less.

       m   Displays the first 4 samples of SHOW STATUS counters side by side with the pt-mext tool.

       n   Summarizes the first sample of netstat data in two ways: by originating host, and by connection state.

       j   Select the next timestamp as the active sample.

       k   Select the previous timestamp as the active sample.

       q   Quit the program.

       1   Sets the action for each sample to the default, which is to view a summary of the sample.

       0   Sets the action to just list the files in the sample.

       *   Sets the action to view all of the sample's files in the less program.

OPTIONS
       This tool does not have any command-line options.

ENVIRONMENT
       This tool does not use any environment variables.

SYSTEM REQUIREMENTS
       This tool requires Bash v3 and the following programs: pt-diskstats, pt-pmp, pt-mext, and pt-align.  If these programs are not in your
       PATH, they will be fetched from the Internet if curl is available.

BUGS
       For a list of known bugs, see http://www.percona.com/bugs/pt-sift <http://www.percona.com/bugs/pt-sift>.

       Please report bugs at https://bugs.launchpad.net/percona-toolkit <https://bugs.launchpad.net/percona-toolkit>.  Include the following
       information in your bug report:

       o   Complete command-line used to run the tool

       o   Tool "--version"

       o   MySQL version of all servers involved

       o   Output from the tool including STDERR

       o   Input files (log/dump/config files, etc.)

       If possible, include debugging output by running the tool with "PTDEBUG"; see "ENVIRONMENT".

DOWNLOADING
       Visit http://www.percona.com/software/percona-toolkit/ <http://www.percona.com/software/percona-toolkit/> to download the latest release of
       Percona Toolkit.  Or, get the latest release from the command line:

	  wget percona.com/get/percona-toolkit.tar.gz

	  wget percona.com/get/percona-toolkit.rpm

	  wget percona.com/get/percona-toolkit.deb

       You can also get individual tools from the latest release:

	  wget percona.com/get/TOOL

       Replace "TOOL" with the name of any tool.

AUTHORS
       Baron Schwartz

ABOUT PERCONA TOOLKIT
       This tool is part of Percona Toolkit, a collection of advanced command-line tools developed by Percona for MySQL support and consulting.
       Percona Toolkit was forked from two projects in June, 2011: Maatkit and Aspersa.  Those projects were created by Baron Schwartz and
       developed primarily by him and Daniel Nichter, both of whom are employed by Percona.  Visit <http://www.percona.com/software/> for more
       software developed by Percona.

COPYRIGHT, LICENSE, AND WARRANTY
       This program is copyright 2010-2011 Baron Schwartz, 2011-2012 Percona Inc.  Feedback and improvements are welcome.

       THIS PROGRAM IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
       MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation, version 2; OR the Perl Artistic License.  On UNIX and similar systems, you can issue `man perlgpl' or `man
       perlartistic' to read these licenses.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.

VERSION
       pt-sift 2.1.2

perl v5.14.2							    2012-06-15							       PT-SIFT(1p)