Bug fixes with POD documnetation
Adding USAGE.md documentation from POD documentation
This commit is contained in:
root
parent
59ae681265
commit
6b1b44bd52
2 changed files with 117 additions and 6 deletions
115
USAGE.md
Normal file
115
USAGE.md
Normal file
|
|
@ -0,0 +1,115 @@
|
|||
# NAME
|
||||
|
||||
MySQLTuner 1.4.5 - MySQL High Performance Tuning Script
|
||||
|
||||
# IMPORTANT USAGE GUIDELINES
|
||||
|
||||
To run the script with the default options, run the script without arguments
|
||||
Allow MySQL server to run for at least 24-48 hours before trusting suggestions
|
||||
Some routines may require root level privileges (script will provide warnings)
|
||||
You must provide the remote server's total memory when connecting to other servers
|
||||
|
||||
# CONNECTION AND AUTHENTIFICATION
|
||||
|
||||
--host <hostname> Connect to a remote host to perform tests (default: localhost)
|
||||
--socket <socket> Use a different socket for a local connection
|
||||
--port <port> Port to use for connection (default: 3306)
|
||||
--user <username> Username to use for authentication
|
||||
--pass <password> Password to use for authentication
|
||||
--mysqladmin <path> Path to a custom mysqladmin executable
|
||||
--mysqlcmd <path> Path to a custom mysql executable
|
||||
|
||||
# PERFORMANCE AND REPORTING OPTIONS
|
||||
|
||||
--skipsize Don't enumerate tables and their types/sizes (default: on)
|
||||
(Recommended for servers with many tables)
|
||||
--checkversion Check for updates to MySQLTuner (default: don't check)
|
||||
--forcemem <size> Amount of RAM installed in megabytes
|
||||
--forceswap <size> Amount of swap memory configured in megabytes
|
||||
--passwordfile <path>Path to a password file list(one password by line)
|
||||
--reportfile <path> Path to a report txt file
|
||||
|
||||
# OUTPUT OPTIONS
|
||||
|
||||
--nogood Remove OK responses
|
||||
--nobad Remove negative/suggestion responses
|
||||
--noinfo Remove informational responses
|
||||
--debug Print debug information
|
||||
--dbstat Print database information
|
||||
--nocolor Don't print output in color
|
||||
--buffers Print global and per-thread buffer values
|
||||
|
||||
# PERLDOC
|
||||
|
||||
You can find documentation for this module with the perldoc command.
|
||||
|
||||
perldoc mysqltuner
|
||||
|
||||
# AUTHORS
|
||||
|
||||
Major Hayden - major@mhtx.net
|
||||
|
||||
# CONTRIBUTORS
|
||||
|
||||
- Matthew Montgomery
|
||||
- Paul Kehrer
|
||||
- Dave Burgess
|
||||
- Jonathan Hinds
|
||||
- Mike Jackson
|
||||
- Nils Breunese
|
||||
- Shawn Ashlee
|
||||
- Luuk Vosslamber
|
||||
- Ville Skytta
|
||||
- Trent Hornibrook
|
||||
- Jason Gill
|
||||
- Mark Imbriaco
|
||||
- Greg Eden
|
||||
- Aubin Galinotti
|
||||
- Giovanni Bechis
|
||||
- Bill Bradford
|
||||
- Ryan Novosielski
|
||||
- Michael Scheidell
|
||||
- Blair Christensen
|
||||
- Hans du Plooy
|
||||
- Victor Trac
|
||||
- Everett Barnes
|
||||
- Tom Krouper
|
||||
- Gary Barrueto
|
||||
- Simon Greenaway
|
||||
- Adam Stein
|
||||
- Isart Montane
|
||||
- Baptiste M.
|
||||
- Cole Turner
|
||||
- Major Hayden
|
||||
|
||||
# SUPPORT
|
||||
|
||||
Bug reports, feature requests, and downloads at http://mysqltuner.com/
|
||||
Bug tracker can be found at https://github.com/major/MySQLTuner-perl/issues
|
||||
Maintained by Major Hayden (major\\@mhtx.net) - Licensed under GPL
|
||||
|
||||
# SOURCE CODE
|
||||
|
||||
[https://github.com/major/MySQLTuner-perl](https://github.com/major/MySQLTuner-perl)
|
||||
|
||||
git clone https://github.com/major/MySQLTuner-perl.git
|
||||
|
||||
# COPYRIGHT AND LICENSE
|
||||
|
||||
Copyright (C) 2006-2015 Major Hayden - major@mhtx.net
|
||||
|
||||
For the latest updates, please visit http://mysqltuner.com/
|
||||
Git repository available at http://github.com/major/MySQLTuner-perl
|
||||
|
||||
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, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
|
@ -1339,6 +1339,7 @@ close_reportfile; # Close reportfile if needed
|
|||
__END__
|
||||
|
||||
=pod
|
||||
|
||||
=encoding UTF-8
|
||||
|
||||
=head1 NAME
|
||||
|
|
@ -1382,9 +1383,7 @@ You must provide the remote server's total memory when connecting to other serve
|
|||
--nocolor Don't print output in color
|
||||
--buffers Print global and per-thread buffer values
|
||||
|
||||
=back
|
||||
|
||||
=head2 PERLDOC
|
||||
=head1 PERLDOC
|
||||
|
||||
You can find documentation for this module with the perldoc command.
|
||||
|
||||
|
|
@ -1526,11 +1525,8 @@ Bug reports, feature requests, and downloads at http://mysqltuner.com/
|
|||
Bug tracker can be found at https://github.com/major/MySQLTuner-perl/issues
|
||||
Maintained by Major Hayden (major\@mhtx.net) - Licensed under GPL
|
||||
|
||||
=back
|
||||
|
||||
=head1 SOURCE CODE
|
||||
|
||||
|
||||
L<https://github.com/major/MySQLTuner-perl>
|
||||
|
||||
git clone https://github.com/major/MySQLTuner-perl.git
|
||||
|
|
|
|||
Loading…
Reference in a new issue