Initial commit

1 files changed, 118 insertions, 0 deletions

diff --git a/grot.1 b/grot.1
new file mode 100644
index 0000000..95e1d4f
--- /dev/null
+++ b/grot.1
@@ -0,0 +1,118 @@
+.\" This file is part of Grot.
+.\" Copyright (C) 2009 Sergey Poznyakoff
+.\"
+.\" Grot 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, or (at your option)
+.\" any later version.
+.\"
+.\" Grot 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 grot.  If not, see <http://www.gnu.org/licenses/>.
+.TH grot "1" "May 15, 2009" "grot (grot 1.0)" "User Commands"
+.SH NAME
+grot \- Gray's Rotation Tool for MySQL binary logs
+
+.SH SYNOPSIS
+\fBgrot\fR
+[\fB-vnh\fR]
+[\fB-H\fR[NAME]]
+[\fB-p\fR[PASS]]
+[\fB-P\fR NUMBER]
+[\fB-S\fR STRING]
+[\fB-u\fR NAME]
+[\fB--host\fR=[NAME]]
+[\fB--password\fR=[PASS]]
+[\fB--port\fR=NUMBER]
+[\fB--socket\fR=STRING]
+[\fB--user\fR=NAME]
+[\fB--verbose\fR]
+[\fB--dry-run\fR]
+[\fB--no-flush\fR]
+[\fB--keep\fR=NUMBER]
+[\fB--help\fR]
+[\fB--usage\fR]
+[\fB--version\fR]
+
+.SH DESCRIPTION
+\fBGrot\fR rotates MySQL binary log files.
+
+.SH OPTIONS
+.TP
+\fB\-H\fR, \fB\-\-host\fR[=\fINAME\fR]
+Set host name or IP address of the master MySQL server.
+.TP
+\fB\-p\fR, \fB\-\-password\fR[=\fIPASS\fR]
+Set password of the MySQL user.  
+.TP
+\fB\-P\fR, \fB\-\-port\fR=\fINUMBER\fR
+Set port number of the master MySQL server, if it differs from the
+default 3306.
+.TP
+\fB\-S\fR, \fB\-\-socket\fR=\fISTRING\fR
+Set socket file name.
+.TP
+\fB\-u\fR, \fB\-\-user\fR=\fINAME\fR
+Set MySQL user name.  This user must have the following
+privileges: PROCESS, SUPER.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Increase verbosity level.  Multiple instances of this option are
+allowed.
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Do not actually rotate the logs, only print what would have been done.
+.TP
+\fB\-\-no\-flush\fR
+Do not flush logs after rotating.
+.TP
+\fB\-\-keep\fR=NUMBER
+Keep NUMBER logs before the oldest one.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Give a concise help list.
+.TP
+\fB\-\-usage\fR
+Give a short usage message.
+.TP
+\fB\-\-version\fR
+Print program version.
+
+.SH CONFIGURATION FILES
+\fBGrot\fR reads its configuration from the following files:
+.TP
+\fB/etc/my.cnf\fR
+Default MySQL configuration file.  \fBGrot\fR attempts to read master server
+configuration from sections \fBgrot\fR and \fBclient\fR.
+.TP
+\fB/etc/grot.cnf\fR
+Site-wide \fBgrot\fR configuration file.  See grot.cfg(5).
+.TP
+\fB~/.grot\fR
+Per-user configuration file.  The tilde (\fB~\fR) here stands for the
+user home directory.  See grot.cfg(5).
+
+.SH "REPORTING BUGS"
+Report bugs to <gray@gnu.org.ua>.
+
+.SH "SEE ALSO"
+grot.cfg(5)
+
+.SH COPYRIGHT
+Copyright \(co 2009 Sergey Poznyakoff
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH grot \"1\" \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 16
+.\" end:
+