summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2013-08-06 08:15:03 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2013-08-06 08:15:03 (GMT)
commitac8848c85bee61cf9c9947dae910c180ed7786de (patch) (side-by-side diff)
tree51d615f59948cf2a2c009a6da6f61af26c3d9df2
parent32dc00e8d4ee1aa0b979c2b7f6b331fd53a70212 (diff)
downloadgrot-ac8848c85bee61cf9c9947dae910c180ed7786de.tar.gz
grot-ac8848c85bee61cf9c9947dae910c180ed7786de.tar.bz2
Update manpages.HEADmaster
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,3 +1,3 @@
-.\" 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
.\"
@@ -15,26 +15,15 @@
.\" 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]
@@ -79,3 +68,3 @@ Do not flush logs after rotating.
Keep NUMBER logs before the oldest one.
-.SS ""
+.PP
The following options set the connection and account parameters of the
@@ -111,4 +100,3 @@ Give a short usage message.
Print program version.
-
-.SH CONFIGURATION FILES
+.SH "CONFIGURATION FILES"
\fBGrot\fR reads its configuration from the following files:
@@ -120,3 +108,4 @@ configuration from sections \fBgrot\fR and \fBclient\fR.
\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
@@ -124,10 +113,16 @@ Site-wide \fBgrot\fR configuration file. See grot.cfg(5).
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
diff --git a/grot.cfg.5 b/grot.cfg.5
index 388a3e0..5d755b7 100644
--- a/grot.cfg.5
+++ b/grot.cfg.5
@@ -1,3 +1,3 @@
-.\" 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
.\"
@@ -15,9 +15,8 @@
.\" 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
@@ -26,15 +25,12 @@ 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
@@ -42,6 +38,6 @@ 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,
@@ -50,7 +46,5 @@ 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
@@ -59,7 +53,6 @@ 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
@@ -67,15 +60,14 @@ 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

Return to:

Send suggestions and report system problems to the System administrator.