1# NAME
2
3    MySQLTuner 1.7.15 - MySQL High Performance Tuning Script
4
5# IMPORTANT USAGE GUIDELINES
6
7To run the script with the default options, run the script without arguments
8Allow MySQL server to run for at least 24-48 hours before trusting suggestions
9Some routines may require root level privileges (script will provide warnings)
10You must provide the remote server's total memory when connecting to other servers
11
12# CONNECTION AND AUTHENTICATION
13
14    --host <hostname>           Connect to a remote host to perform tests (default: localhost)
15    --socket <socket>           Use a different socket for a local connection
16    --port <port>               Port to use for connection (default: 3306)
17    --user <username>           Username to use for authentication
18    --userenv <envvar>          Name of env variable which contains username to use for authentication
19    --pass <password>           Password to use for authentication
20    --passenv <envvar>          Name of env variable which contains password to use for authentication
21    --ssl-ca <path>             Path to public key
22    --mysqladmin <path>         Path to a custom mysqladmin executable
23    --mysqlcmd <path>           Path to a custom mysql executable
24    --defaults-file <path>      Path to a custom .my.cnf
25
26# PERFORMANCE AND REPORTING OPTIONS
27
28    --skipsize                  Don't enumerate tables and their types/sizes (default: on)
29                                (Recommended for servers with many tables)
30    --skippassword              Don't perform checks on user passwords(default: off)
31    --checkversion              Check for updates to MySQLTuner (default: don't check)
32    --updateversion             Check for updates to MySQLTuner and update when newer version is available (default: don't check)
33    --forcemem <size>           Amount of RAM installed in megabytes
34    --forceswap <size>          Amount of swap memory configured in megabytes
35    --passwordfile <path>       Path to a password file list(one password by line)
36
37# OUTPUT OPTIONS
38
39    --silent                    Don't output anything on screen
40    --nogood                    Remove OK responses
41    --nobad                     Remove negative/suggestion responses
42    --noinfo                    Remove informational responses
43    --debug                     Print debug information
44    --noprocess                Consider no other process is running
45    --dbstat                    Print database information
46    --nodbstat                  Don't Print database information
47    --tbstat                    Print table information
48    --notbstat                  Don't Print table information
49    --idxstat                   Print index information
50    --noidxstat                 Don't Print index information
51    --sysstat                   Print system information
52    --nosysstat                 Don't Print system information
53    --pfstat                    Print Performance schema
54    --nopfstat                  Don't Print Performance schema
55    --verbose                   Prints out all options (default: no verbose, dbstat, idxstat, sysstat, tbstat, pfstat)
56    --bannedports               Ports banned separated by comma(,)
57    --maxportallowed            Number of ports opened allowed on this hosts
58    --cvefile <path>            CVE File for vulnerability checks
59    --nocolor                   Don't print output in color
60    --json                      Print result as JSON string
61    --buffers                   Print global and per-thread buffer values
62    --outputfile <path>         Path to a output txt file
63    --reportfile <path>         Path to a report txt file
64    --template   <path>         Path to a template file
65
66# PERLDOC
67
68You can find documentation for this module with the perldoc command.
69
70    perldoc mysqltuner
71
72## INTERNALS
73
74[https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md](https://github.com/major/MySQLTuner-perl/blob/master/INTERNALS.md)
75
76    Internal documentation
77
78# AUTHORS
79
80Major Hayden - major@mhtx.net
81
82# CONTRIBUTORS
83
84- Matthew Montgomery
85- Paul Kehrer
86- Dave Burgess
87- Jonathan Hinds
88- Mike Jackson
89- Nils Breunese
90- Shawn Ashlee
91- Luuk Vosslamber
92- Ville Skytta
93- Trent Hornibrook
94- Jason Gill
95- Mark Imbriaco
96- Greg Eden
97- Aubin Galinotti
98- Giovanni Bechis
99- Bill Bradford
100- Ryan Novosielski
101- Michael Scheidell
102- Blair Christensen
103- Hans du Plooy
104- Victor Trac
105- Everett Barnes
106- Tom Krouper
107- Gary Barrueto
108- Simon Greenaway
109- Adam Stein
110- Isart Montane
111- Baptiste M.
112- Cole Turner
113- Major Hayden
114- Joe Ashcraft
115- Jean-Marie Renouard
116- Stephan GroBberndt
117- Christian Loos
118
119# SUPPORT
120
121Bug reports, feature requests, and downloads at http://mysqltuner.pl/
122
123Bug tracker can be found at https://github.com/major/MySQLTuner-perl/issues
124
125Maintained by Major Hayden (major\\@mhtx.net) - Licensed under GPL
126
127# SOURCE CODE
128
129[https://github.com/major/MySQLTuner-perl](https://github.com/major/MySQLTuner-perl)
130
131    git clone https://github.com/major/MySQLTuner-perl.git
132
133# COPYRIGHT AND LICENSE
134
135Copyright (C) 2006-2018 Major Hayden - major@mhtx.net
136
137For the latest updates, please visit http://mysqltuner.pl/
138
139Git repository available at https://github.com/major/MySQLTuner-perl
140
141This program is free software: you can redistribute it and/or modify
142it under the terms of the GNU General Public License as published by
143the Free Software Foundation, either version 3 of the License, or
144(at your option) any later version.
145
146This program is distributed in the hope that it will be useful,
147but WITHOUT ANY WARRANTY; without even the implied warranty of
148MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
149
150    See the GNU General Public License for more details.
151
152You should have received a copy of the GNU General Public License
153along with this program.  If not, see &lt;https://www.gnu.org/licenses/>.
154