summaryrefslogtreecommitdiffabout
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--grot.159
-rw-r--r--grot.cfg.548
2 files changed, 47 insertions, 60 deletions
diff --git a/grot.1 b/grot.1
index 14a5008..5cf00d0 100644
--- a/grot.1
+++ b/grot.1
@@ -1,5 +1,5 @@
-.\" This file is part of Grot.
-.\" Copyright (C) 2009, 2010 Sergey Poznyakoff
+.\" This file is part of Grot. -*- nroff -*-
+.\" Copyright (C) 2009, 2010, 2013 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
@@ -13,30 +13,19 @@
.\"
.\" 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 16, 2009" "grot (grot 1.0)" "System Administrator's Manual"
+.TH grot "1" "August 6, 2013" "grot (grot 1.0)" "System Administrator's Manual"
.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]
+\fBgrot\fR [\fB\-vnh\fR] [\fB\-H\fR[\fINAME\fR]] [\fB\-p\fR[\fIPASS\fR]] [\fB\-P\fR \fINUMBER\fR]\
+ [\fB\-S\fR \fIPATH\fR] [\fB\-u\fR \fINAME\fR]
+ [\fB\-\-host=\fR[\fINAME\fR]] [\fB\-\-password=\fR[\fIPASS\fR]] [\fB\-\-port=\fINUMBER\fR]
+ [\fB\-\-socket=\fIPATH\fR] [\fB\-\-user=\fINAME\fR] [\fB\-\-verbose\fR]\
+ [\fB\-\-dry\-run\fR]
+ [\fB\-\-no\-flush\fR] [\fB\-\-keep=\fINUMBER\fR]
+[\fB\-\-help\fR]
+[\fB\-\-usage\fR]
+[\fB\-\-version\fR]
.SH DESCRIPTION
\fBGrot\fR rotates MySQL binary log files on replication master
@@ -77,7 +66,7 @@ Do not flush logs after rotating.
.TP
\fB\-\-keep\fR=NUMBER
Keep NUMBER logs before the oldest one.
-.SS ""
+.PP
The following options set the connection and account parameters of the
master server. They override the corresponding settings from the
configuration files:
@@ -109,8 +98,7 @@ Give a short usage message.
.TP
\fB\-\-version\fR
Print program version.
-
-.SH CONFIGURATION FILES
+.SH "CONFIGURATION FILES"
\fBGrot\fR reads its configuration from the following files:
.TP
\fB/etc/my.cnf\fR
@@ -118,18 +106,25 @@ 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).
+Site-wide \fBgrot\fR configuration file. See
+.BR 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).
-
+user home directory. See
+.BR grot.cfg (5).
.SH "REPORTING BUGS"
Report bugs to <gray@gnu.org.ua>.
-
+.\" The MANCGI variable is set by mansrv script on Ulysses.
+.\" The download.inc file contains the default DOWNLOAD section
+.\" for man-based doc pages.
+.if "\V[MANCGI]"WEBDOC" \{\
+. ds package grot
+. ds version 1.0
+. so download.inc
+\}
.SH "SEE ALSO"
-grot.cfg(5)
-
+.BR grot.cfg (5).
.SH COPYRIGHT
Copyright \(co 2009 Sergey Poznyakoff
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
diff --git a/grot.cfg.5 b/grot.cfg.5
index 388a3e0..5d755b7 100644
--- a/grot.cfg.5
+++ b/grot.cfg.5
@@ -1,5 +1,5 @@
-.\" This file is part of Grot.
-.\" Copyright (C) 2009, 2010 Sergey Poznyakoff
+.\" This file is part of Grot. -*- nroff -*-
+.\" Copyright (C) 2009, 2010, 2013 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
@@ -13,71 +13,63 @@
.\"
.\" 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.cfg "5" "May 16, 2009" "grot (grot 1.0)" "System Administrator's Manual"
+.TH grot.cfg "5" "August 6, 2013" "grot (grot 1.0)" "System Administrator's Manual"
.SH NAME
grot.cfg \- grot configuration file
-
.SH DESCRIPTION
The \fBgrot\fR configuration file contains information about master and
-slave MySQL servers. Its format is the same as of any \fBmy.cfg\fR file,
+slave MySQL servers. Its format is the same as of \fBmy.cfg\fR file,
i.e. it consists of sections, which contain variable assignments. A section
begins with a section header enclosed in square brackets. A variable
assignement occupies a separate line and consists of variable name and value
separated by equals sign with arbitrary amount of white space around it.
-
+.PP
\fBGrot\fR uses the sections named \fBgrot\fR, \fBslave\fR and, additionally
any sections whose names coincide with existing slave host names.
-
-.SH THE GROT SECTION
-
+.SH "THE GROT SECTION"
This section defines the master server parameters. Allowed variables are:
-
.TP
-\fBhost\fR
+.B host
Defines the host name or IP address of the master SQL server.
.TP
-\fBport\fR
+.B port
Specifies the port the server listens to. Use this variable if the port
differs from the default 3306.
.TP
-\fBsocket\fR
+.B socket
Specifies the UNIX socket name, if the server listens on a UNIX socket.
.TP
-\fBuser\fR
+.B user
Sets the MySQL user name. This user must be granted the \fBPROCESS\fR,
\fBSUPER\fR and \fBRELOAD\fR global privileges. The latter is optional,
if \fBgrot\fR is run with the \fB\-\-no\-flush\fR option.
.TP
-\fBpassword\fR
+.B password
Password for that user.
-
-.SH THE SLAVE SECTION
-
+.SH "THE SLAVE SECTION"
The \fBslave\fR section configures the settings needed to connect to
the host servers, such as user credentials, port number etc. If all
slaves use the same set of these settings, this section is enough for
\fBgrot\fR to work. Otherwise, you need to specify the credentials for each
-particular slave in a separate section, named after that slave host
+particular slave in a separate section, named after that slave's host
name.
-
.TP
-\fBport\fR
+.B port
Specifies the port the server listens to. Use this variable if the port
differs from the default 3306.
.TP
-\fBsocket\fR
+.B socket
Specifies the UNIX socket name, if the server listens on a UNIX socket.
.TP
-\fBuser\fR
-Sets the MySQL user name. This user must be granted the \fBREPLICATION CLIENT\fR
+.B user
+Sets the MySQL user name. This user must be granted the
+.B REPLICATION CLIENT
global privilege.
.TP
-\fBpassword\fR
+.B password
Password for that user.
-
.SH "SEE ALSO"
-grot(1)
-
+.BR grot (1).
.SH COPYRIGHT
Copyright \(co 2009 Sergey Poznyakoff
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

Return to:

Send suggestions and report system problems to the System administrator.