aboutsummaryrefslogtreecommitdiff
path: root/grot.cfg.5
blob: 334b0d4873baa5c108fe235c83e9dcebb2340e6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
.\" 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.cfg "5" "May 16, 2009" "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,
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.

\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

This section defines the master server parameters.  Allowed variables are:

.TP
\fBhost\fR
Defines the host name or IP address of the master SQL server.
.TP
\fBport\fR
Specifies the port the server listens to.  Use this variable if the port
differs from the default 3306.
.TP
\fBsocket\fR
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 \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
Password for that user.

.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 may specify the credentials for each
particular slave in a separate section, named after that slave host
name.

.TP
\fBport\fR
Specifies the port the server listens to.  Use this variable if the port
differs from the default 3306.
.TP
\fBsocket\fR
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
global privilege.
.TP
\fBpassword\fR
Password for that user.

.SH "SEE ALSO"
grot(1)

.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.cfg \"5\" \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 16
.\" end:

Return to:

Send suggestions and report system problems to the System administrator.