Re-brand standard POD sections (DOWNLOADING, ENVIRONMENT, etc). Change ABOUT MAATKIT to ABOUT PERCONA TOOLKIT.

This commit is contained in:
Daniel Nichter
2011-07-11 16:56:02 -06:00
parent 89f97d6099
commit aa318cb93f
41 changed files with 2281 additions and 1187 deletions

View File

@@ -5207,27 +5207,29 @@ User for login if not current user.
=back
=head1 DOWNLOADING
=head1 DOWNLOADING
Visit L<http://www.percona.com/software/> to download the latest release of
Percona Toolkit. Or, to get the latest release from the command line:
You can download Maatkit from Google Code at
L<http://code.google.com/p/maatkit/>, or you can get any of the tools
easily with a command like the following:
wget percona.com/latest/percona-toolkit/PKG
wget http://www.maatkit.org/get/toolname
or
wget http://www.maatkit.org/trunk/toolname
Replace C<PKG> with C<tar>, C<rpm>, or C<deb> to download the package in that
format. You can also get individual tools from the latest release:
Where C<toolname> can be replaced with the name (or fragment of a name) of any
of the Maatkit tools. Once downloaded, they're ready to run; no installation is
needed. The first URL gets the latest released version of the tool, and the
second gets the latest trunk code from Subversion.
wget percona.com/latest/percona-toolkit/TOOL
Replace C<TOOL> with the name of any tool.
=head1 ENVIRONMENT
The environment variable C<MKDEBUG> enables verbose debugging output in all of
the Maatkit tools:
The environment variable C<PTDEBUG> enables verbose debugging output to STDERR.
To enable debugging and capture all output to a file, run the tool like:
MKDEBUG=1 mk-....
PTDEBUG=1 $TOOL ... > FILE 2>&1
Be careful: debugging output is voluminous and can generate several megabytes
of output.
=head1 SYSTEM REQUIREMENTS
@@ -5236,41 +5238,33 @@ installed in any reasonably new version of Perl.
=head1 BUGS
For a list of known bugs see L<http://www.maatkit.org/bugs/pt-online-schema-change>.
For a list of known bugs, see L<http://www.percona.com/bugs/$TOOL>.
Please use Google Code Issues and Groups to report bugs or request support:
L<http://code.google.com/p/maatkit/>. You can also join #maatkit on Freenode to
discuss Maatkit.
Please report bugs at L<https://bugs.launchpad.net/percona-toolkit>.
Include the following information in your bug report:
Please include the complete command-line used to reproduce the problem you are
seeing, the version of all MySQL servers involved, the complete output of the
tool when run with L<"--version">, and if possible, debugging output produced by
running with the C<MKDEBUG=1> environment variable.
=over
=head1 COPYRIGHT, LICENSE, AND WARRANTY
=item * Complete command-line used to run the tool
This program is copyright 2011-@CURRENTYEAR@ Percona Inc.
Feedback and improvements are welcome.
=item * Tool L<"--version">
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.
=item * MySQL version of all servers involved
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.
=item * Output from the tool including STDERR
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.
=item * Input files (log/dump/config files, etc.)
=back
If possible, include debugging output by running the tool with C<PTDEBUG>;
see L<"ENVIRONMENT">.
=head1 AUTHORS
Daniel Nichter
Baron Schwartz
=head1 HISTORY AND ACKNOWLEDGMENTS
=head1 ACKNOWLEDGMENTS
The "online schema change" concept was first implemented by Shlomi Noach
in his tool C<oak-online-alter-table>, part of
@@ -5289,15 +5283,36 @@ full-featured, tested tool with stable development and support.
This tool was made possible by a generous client of Percona Inc.
=head1 ABOUT MAATKIT
=head1 ABOUT PERCONA TOOLKIT
This tool is part of Maatkit, a toolkit for power users of MySQL. Maatkit
was created by Baron Schwartz; Baron and Daniel Nichter are the primary
code contributors. Both are employed by Percona. Financial support for
Maatkit development is primarily provided by Percona and its clients.
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
L<http://www.percona.com/software/> for more software developed by Percona.
=head1 COPYRIGHT, LICENSE, AND WARRANTY
This program is copyright 2011 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.
=head1 VERSION
This manual page documents Ver @VERSION@ Distrib @DISTRIB@ $Revision: 7479 $.
Percona Toolkit v1.0.0 released 2011-08-01
=cut