* Fix case of 'H' for header. (closes: #334509)
* Warn about passwords-on-commandline. (closes: #357150)
* Give advice to use two dashes with long options. (closes: #411055)
@@ -1631,7 +1631,7 @@
read from the buffer rather than disk) and the number of bytes that
MySQL has sent and received, both over all and in the last cycle.
-You can toggle the header by hitting B<h> when running B<mytop>.
+You can toggle the header by hitting B<H> when running B<mytop>.
The second part of the display lists as many threads as can fit on
screen. By default they are sorted according to their idle time (least
@@ -1660,58 +1660,61 @@
Connect - Green
Those are purely arbitrary and will be customizable in a future
-release. If they annoy you just start B<mytop> with the B<-nocolor>
+release. If they annoy you just start B<mytop> with the B<--nocolor>
flag or adjust your config file appropriately.
B<mytop> handles long and short command-line arguments. Not all
options have both long and short formats, however. The long arguments
-can start with one or two dashes `-' or `--'. They are shown here with
+should be specified using two dashes `--' even when only one dash `-'
+is sufficient in most cases since they may clash with the short format.
-=item B<-u> or B<-user> username
+=item B<-u> or B<--user> I<username>
-Username to use when logging in to the MySQL server. Default: ``root''.
+Username to use when logging in to the MySQL server. Default: ``B<root>''.
-=item B<-p> or B<-pass> or B<-password> password
+=item B<-p> or B<--pass> or B<--password> I<password>
Password to use when logging in to the MySQL server. Default: none.
-=item B<-h> or B<-host> hostname[:port]
+WARNING: This is insecure as the password is visible for anyone.
+See B<--prompt> instead!
+=item B<-h> or B<--host> I<hostname>[B<:>I<port>]
Hostname of the MySQL server. The hostname may be followed by an
option port number. Note that the port is specified separate from the
-host when using a config file. Default: ``localhost''.
+host when using a config file. Default: ``B<localhost>''.
-=item B<-port> or B<-P> port
+=item B<--port> or B<-P> I<port>
If you're running MySQL on a non-standard port, use this to specify
-the port number. Default: 3306.
+the port number. Default: B<3306>.
-=item B<-s> or B<-delay> seconds
+=item B<-s> or B<--delay> I<seconds>
-How long between display refreshes. Default: 5
+How long between display refreshes. Default: B<5>
-=item B<-d> or B<-db> or B<-database> database
+=item B<-d> or B<--db> or B<--database> I<database>
Use if you'd like B<mytop> to connect to a specific database by
-default. Default: ``test''.
+default. Default: ``B<test>''.
-=item B<-b> or B<-batch> or B<-batchmode>
+=item B<-b> or B<--batch> or B<--batchmode>
In batch mode, mytop runs only once, does not clear the screen, and
places no limit on the number of lines it will print. This is suitable
-for running periodically (perhaps from cron) to capture the
+for running periodically (perhaps from B<cron>) to capture the
information into a file for later viewing. You might use batch mode in
a CGI script to occasionally display your MySQL server status on the
-=item B<-S> or B<-socket> /path/to/socket
+=item B<-S> or B<--socket> I</path/to/socket>
If you're running B<mytop> on the same host as MySQL, you may wish to
have it use the MySQL socket directly rather than a standard TCP/IP
@@ -1724,14 +1727,14 @@
-=item B<-header> or B<-noheader>
+=item B<--header> or B<--noheader>
Sepcify if you want the header to display or not. You can toggle this
-with the B<h> key while B<mytop> is running.
+with the B<H> key while B<mytop> is running.
-=item B<-color> or B<-nocolor>
+=item B<--color> or B<--nocolor>
Specify if you want a color display. This has no effect if you don't
have color support available.
@@ -1739,7 +1742,7 @@
Default: If you have color support, B<mytop> will try color unless you
tell it not to.
-=item B<-i> or B<-idle> or B<-noidle>
+=item B<-i> or B<--idle> or B<--noidle>
Specify if you want idle (sleeping) threads to appear in the list. If
sleeping threads are omitted, the default sorting order is reversed so
@@ -1747,18 +1750,18 @@
-=item B<-prompt> or B<-noprompt>
+=item B<--prompt> or B<--noprompt>
Specify if you want to be prompted to type in your database password.
This provides a little bit more security since it not only prevents
the password from viewable in a process list, but also doesn't require
-the password to be stored in plain text in your ~/.mytop config file.
+the password to be stored in plain text in your C<~/.mytop> config file.
You will B<only> be prompted if a password has not been specified in
your config file or through another command line option.
If you have skip-resolve set on MySQL (to keep it from doing a reverse
DNS lookup on each inbound connection), mytop can replace IP addresses
@@ -1895,8 +1898,8 @@
The B<s> key has a command-line counterpart: B<-s>.
-The B<h> key has two command-line counterparts: B<-header> and
+The B<h> key has two command-line counterparts: B<--header> and
@@ -2041,12 +2044,12 @@
=item jon r. luini <email@example.com>
-Supplied a patch that formed the basis for C<-prompt> support. Sean
+Supplied a patch that formed the basis for C<--prompt> support. Sean
Leach <firstname.lastname@example.org> submitted a similar patch.
=item Yogish Baliga <email@example.com>
-Supplied a patch that formed the basis for C<-resolve> support.
+Supplied a patch that formed the basis for C<--resolve> support.
=item Per Andreas Buer <firstname.lastname@example.org>