aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-08-06 11:15:03 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-08-06 11:15:03 +0300
commitac8848c85bee61cf9c9947dae910c180ed7786de (patch)
tree51d615f59948cf2a2c009a6da6f61af26c3d9df2
parent32dc00e8d4ee1aa0b979c2b7f6b331fd53a70212 (diff)
downloadgrot-ac8848c85bee61cf9c9947dae910c180ed7786de.tar.gz
grot-ac8848c85bee61cf9c9947dae910c180ed7786de.tar.bz2
Update manpages.HEADmaster
-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 @@
1.\" This file is part of Grot. 1.\" This file is part of Grot. -*- nroff -*-
2.\" Copyright (C) 2009, 2010 Sergey Poznyakoff 2.\" Copyright (C) 2009, 2010, 2013 Sergey Poznyakoff
3.\" 3.\"
4.\" Grot is free software; you can redistribute it and/or modify 4.\" Grot is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by 5.\" it under the terms of the GNU General Public License as published by
@@ -13,30 +13,19 @@
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 14.\" You should have received a copy of the GNU General Public License
15.\" along with grot. If not, see <http://www.gnu.org/licenses/>. 15.\" along with grot. If not, see <http://www.gnu.org/licenses/>.
16.TH grot "1" "May 16, 2009" "grot (grot 1.0)" "System Administrator's Manual" 16.TH grot "1" "August 6, 2013" "grot (grot 1.0)" "System Administrator's Manual"
17.SH NAME 17.SH NAME
18grot \- Gray's Rotation Tool for MySQL binary logs 18grot \- Gray's Rotation Tool for MySQL binary logs
19
20.SH SYNOPSIS 19.SH SYNOPSIS
21\fBgrot\fR 20\fBgrot\fR [\fB\-vnh\fR] [\fB\-H\fR[\fINAME\fR]] [\fB\-p\fR[\fIPASS\fR]] [\fB\-P\fR \fINUMBER\fR]\
22[\fB-vnh\fR] 21 [\fB\-S\fR \fIPATH\fR] [\fB\-u\fR \fINAME\fR]
23[\fB-H\fR[NAME]] 22 [\fB\-\-host=\fR[\fINAME\fR]] [\fB\-\-password=\fR[\fIPASS\fR]] [\fB\-\-port=\fINUMBER\fR]
24[\fB-p\fR[PASS]] 23 [\fB\-\-socket=\fIPATH\fR] [\fB\-\-user=\fINAME\fR] [\fB\-\-verbose\fR]\
25[\fB-P\fR NUMBER] 24 [\fB\-\-dry\-run\fR]
26[\fB-S\fR STRING] 25 [\fB\-\-no\-flush\fR] [\fB\-\-keep=\fINUMBER\fR]
27[\fB-u\fR NAME] 26[\fB\-\-help\fR]
28[\fB--host\fR=[NAME]] 27[\fB\-\-usage\fR]
29[\fB--password\fR=[PASS]] 28[\fB\-\-version\fR]
30[\fB--port\fR=NUMBER]
31[\fB--socket\fR=STRING]
32[\fB--user\fR=NAME]
33[\fB--verbose\fR]
34[\fB--dry-run\fR]
35[\fB--no-flush\fR]
36[\fB--keep\fR=NUMBER]
37[\fB--help\fR]
38[\fB--usage\fR]
39[\fB--version\fR]
40 29
41.SH DESCRIPTION 30.SH DESCRIPTION
42\fBGrot\fR rotates MySQL binary log files on replication master 31\fBGrot\fR rotates MySQL binary log files on replication master
@@ -77,7 +66,7 @@ Do not flush logs after rotating.
77.TP 66.TP
78\fB\-\-keep\fR=NUMBER 67\fB\-\-keep\fR=NUMBER
79Keep NUMBER logs before the oldest one. 68Keep NUMBER logs before the oldest one.
80.SS "" 69.PP
81The following options set the connection and account parameters of the 70The following options set the connection and account parameters of the
82master server. They override the corresponding settings from the 71master server. They override the corresponding settings from the
83configuration files: 72configuration files:
@@ -109,8 +98,7 @@ Give a short usage message.
109.TP 98.TP
110\fB\-\-version\fR 99\fB\-\-version\fR
111Print program version. 100Print program version.
112 101.SH "CONFIGURATION FILES"
113.SH CONFIGURATION FILES
114\fBGrot\fR reads its configuration from the following files: 102\fBGrot\fR reads its configuration from the following files:
115.TP 103.TP
116\fB/etc/my.cnf\fR 104\fB/etc/my.cnf\fR
@@ -118,18 +106,25 @@ Default MySQL configuration file. \fBGrot\fR attempts to read master server
118configuration from sections \fBgrot\fR and \fBclient\fR. 106configuration from sections \fBgrot\fR and \fBclient\fR.
119.TP 107.TP
120\fB/etc/grot.cnf\fR 108\fB/etc/grot.cnf\fR
121Site-wide \fBgrot\fR configuration file. See grot.cfg(5). 109Site-wide \fBgrot\fR configuration file. See
110.BR grot.cfg (5).
122.TP 111.TP
123\fB~/.grot\fR 112\fB~/.grot\fR
124Per-user configuration file. The tilde (\fB~\fR) here stands for the 113Per-user configuration file. The tilde (\fB~\fR) here stands for the
125user home directory. See grot.cfg(5). 114user home directory. See
126 115.BR grot.cfg (5).
127.SH "REPORTING BUGS" 116.SH "REPORTING BUGS"
128Report bugs to <gray@gnu.org.ua>. 117Report bugs to <gray@gnu.org.ua>.
129 118.\" The MANCGI variable is set by mansrv script on Ulysses.
119.\" The download.inc file contains the default DOWNLOAD section
120.\" for man-based doc pages.
121.if "\V[MANCGI]"WEBDOC" \{\
122. ds package grot
123. ds version 1.0
124. so download.inc
125\}
130.SH "SEE ALSO" 126.SH "SEE ALSO"
131grot.cfg(5) 127.BR grot.cfg (5).
132
133.SH COPYRIGHT 128.SH COPYRIGHT
134Copyright \(co 2009 Sergey Poznyakoff 129Copyright \(co 2009 Sergey Poznyakoff
135License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> 130License 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 @@
1.\" This file is part of Grot. 1.\" This file is part of Grot. -*- nroff -*-
2.\" Copyright (C) 2009, 2010 Sergey Poznyakoff 2.\" Copyright (C) 2009, 2010, 2013 Sergey Poznyakoff
3.\" 3.\"
4.\" Grot is free software; you can redistribute it and/or modify 4.\" Grot is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by 5.\" it under the terms of the GNU General Public License as published by
@@ -13,71 +13,63 @@
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 14.\" You should have received a copy of the GNU General Public License
15.\" along with grot. If not, see <http://www.gnu.org/licenses/>. 15.\" along with grot. If not, see <http://www.gnu.org/licenses/>.
16.TH grot.cfg "5" "May 16, 2009" "grot (grot 1.0)" "System Administrator's Manual" 16.TH grot.cfg "5" "August 6, 2013" "grot (grot 1.0)" "System Administrator's Manual"
17.SH NAME 17.SH NAME
18grot.cfg \- grot configuration file 18grot.cfg \- grot configuration file
19
20.SH DESCRIPTION 19.SH DESCRIPTION
21The \fBgrot\fR configuration file contains information about master and 20The \fBgrot\fR configuration file contains information about master and
22slave MySQL servers. Its format is the same as of any \fBmy.cfg\fR file, 21slave MySQL servers. Its format is the same as of \fBmy.cfg\fR file,
23i.e. it consists of sections, which contain variable assignments. A section 22i.e. it consists of sections, which contain variable assignments. A section
24begins with a section header enclosed in square brackets. A variable 23begins with a section header enclosed in square brackets. A variable
25assignement occupies a separate line and consists of variable name and value 24assignement occupies a separate line and consists of variable name and value
26separated by equals sign with arbitrary amount of white space around it. 25separated by equals sign with arbitrary amount of white space around it.
27 26.PP
28\fBGrot\fR uses the sections named \fBgrot\fR, \fBslave\fR and, additionally 27\fBGrot\fR uses the sections named \fBgrot\fR, \fBslave\fR and, additionally
29any sections whose names coincide with existing slave host names. 28any sections whose names coincide with existing slave host names.
30 29.SH "THE GROT SECTION"
31.SH THE GROT SECTION
32
33This section defines the master server parameters. Allowed variables are: 30This section defines the master server parameters. Allowed variables are:
34
35.TP 31.TP
36\fBhost\fR 32.B host
37Defines the host name or IP address of the master SQL server. 33Defines the host name or IP address of the master SQL server.
38.TP 34.TP
39\fBport\fR 35.B port
40Specifies the port the server listens to. Use this variable if the port 36Specifies the port the server listens to. Use this variable if the port
41differs from the default 3306. 37differs from the default 3306.
42.TP 38.TP
43\fBsocket\fR 39.B socket
44Specifies the UNIX socket name, if the server listens on a UNIX socket. 40Specifies the UNIX socket name, if the server listens on a UNIX socket.
45.TP 41.TP
46\fBuser\fR 42.B user
47Sets the MySQL user name. This user must be granted the \fBPROCESS\fR, 43Sets the MySQL user name. This user must be granted the \fBPROCESS\fR,
48\fBSUPER\fR and \fBRELOAD\fR global privileges. The latter is optional, 44\fBSUPER\fR and \fBRELOAD\fR global privileges. The latter is optional,
49if \fBgrot\fR is run with the \fB\-\-no\-flush\fR option. 45if \fBgrot\fR is run with the \fB\-\-no\-flush\fR option.
50.TP 46.TP
51\fBpassword\fR 47.B password
52Password for that user. 48Password for that user.
53 49.SH "THE SLAVE SECTION"
54.SH THE SLAVE SECTION
55
56The \fBslave\fR section configures the settings needed to connect to 50The \fBslave\fR section configures the settings needed to connect to
57the host servers, such as user credentials, port number etc. If all 51the host servers, such as user credentials, port number etc. If all
58slaves use the same set of these settings, this section is enough for 52slaves use the same set of these settings, this section is enough for
59\fBgrot\fR to work. Otherwise, you need to specify the credentials for each 53\fBgrot\fR to work. Otherwise, you need to specify the credentials for each
60particular slave in a separate section, named after that slave host 54particular slave in a separate section, named after that slave's host
61name. 55name.
62
63.TP 56.TP
64\fBport\fR 57.B port
65Specifies the port the server listens to. Use this variable if the port 58Specifies the port the server listens to. Use this variable if the port
66differs from the default 3306. 59differs from the default 3306.
67.TP 60.TP
68\fBsocket\fR 61.B socket
69Specifies the UNIX socket name, if the server listens on a UNIX socket. 62Specifies the UNIX socket name, if the server listens on a UNIX socket.
70.TP 63.TP
71\fBuser\fR 64.B user
72Sets the MySQL user name. This user must be granted the \fBREPLICATION CLIENT\fR 65Sets the MySQL user name. This user must be granted the
66.B REPLICATION CLIENT
73global privilege. 67global privilege.
74.TP 68.TP
75\fBpassword\fR 69.B password
76Password for that user. 70Password for that user.
77
78.SH "SEE ALSO" 71.SH "SEE ALSO"
79grot(1) 72.BR grot (1).
80
81.SH COPYRIGHT 73.SH COPYRIGHT
82Copyright \(co 2009 Sergey Poznyakoff 74Copyright \(co 2009 Sergey Poznyakoff
83License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> 75License 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.