← Back to branch summary

~percona-toolkit-dev/percona-toolkit/1.0

« back to all changes in this revision

Viewing changes to README

  • Committer: Daniel Nichter
  • Date: 2011-07-14 19:08:47 UTC
  • Revision ID: daniel@percona.com-20110714190847-lggalkuvdrh7c4jp
Add standard pkg files (COPYING, README, etc.), percona-toolkit.pod, and user docs.  Remove dev/docs/html.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
Percona Toolkit
 
2
===============
 
3
 
 
4
Percona Toolkit is a collection of advanced command-line tools used by
 
5
Percona (http://www.percona.com/) support staff to perform a variety of
 
6
MySQL and system tasks that are too difficult or complex to perform manually.
 
7
 
 
8
These tools are ideal alternatives to private or "one-off" scripts because
 
9
they are professionally developed, formally tested, and fully documented.
 
10
They are also fully self-contained, so installation is quick and easy and
 
11
no libraries are installed.
 
12
 
 
13
Percona Toolkit is developed and supported by Percona Inc.  For more
 
14
information and other free, open-source software developed by Percona,
 
15
visit http://www.percona.com/software/.
 
16
 
 
17
Installing
 
18
----------
 
19
 
 
20
To install all tools, run:
 
21
 
 
22
   perl Makefile.PL
 
23
   make
 
24
   make test
 
25
   make install
 
26
 
 
27
You probably need to be root to `make install'.  On most systems, the tools
 
28
are installed in /usr/local/bin.  See the INSTALL file for more information.
 
29
 
 
30
Documentation
 
31
-------------
 
32
 
 
33
Run `man percona-toolkit' to see a list of installed tools, then `man tool'
 
34
to read the embedded documentation for a specific tool.  You can also read
 
35
the documentation online at http://www.percona.com/software/percona-toolkit/.
 
36
 
 
37