summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2009-05-16 07:23:24 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2009-05-16 07:24:16 (GMT)
commit5e2bb39d15949292bca19362eb8821b8bbee1b88 (patch) (side-by-side diff)
tree3007b0ef5d9e7fe4f06aaf721edb728618e39355
parent168463b46dd58dd24009f2aacef604bab01300a5 (diff)
downloadgrot-5e2bb39d15949292bca19362eb8821b8bbee1b88.tar.gz
grot-5e2bb39d15949292bca19362eb8821b8bbee1b88.tar.bz2
Finish the docs
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cmdline.opt2
-rw-r--r--grot.126
-rw-r--r--grot.cfg.52
3 files changed, 26 insertions, 4 deletions
diff --git a/cmdline.opt b/cmdline.opt
index 16956d7..151dfb4 100644
--- a/cmdline.opt
+++ b/cmdline.opt
@@ -90,7 +90,7 @@ BEGIN
END
OPTION(keep,k,NUMBER,
- [<keep NUMBER of files before oldest>])
+ [<keep NUMBER of files before the oldest>])
BEGIN
char *p;
keep_count = strtoul(optarg, &p, 0);
diff --git a/grot.1 b/grot.1
index 95e1d4f..c2582a4 100644
--- a/grot.1
+++ b/grot.1
@@ -13,7 +13,7 @@
.\"
.\" 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"
+.TH grot "1" "May 16, 2009" "grot (grot 1.0)" "System Administrator's Manual"
.SH NAME
grot \- Gray's Rotation Tool for MySQL binary logs
@@ -39,7 +39,28 @@ grot \- Gray's Rotation Tool for MySQL binary logs
[\fB--version\fR]
.SH DESCRIPTION
-\fBGrot\fR rotates MySQL binary log files.
+\fBGrot\fR rotates MySQL binary log files on replication master
+server. It works by first determining what slaves are connected to
+the server. Then it connects to each slave and determines what
+master log file it currently uses. Finally, it removes those logs
+on master that are older than the oldest of logs used by slaves.
+
+Normally, \fBgrot\fR is executed as a cron job. It is not necessary
+to run it on the master server, it may as well be run on any machine
+that can connect to the master SQL.
+
+An account must be set up on master and each of the slaves for
+\fBgrot\fR to operate. The account on master must have the
+\fBSUPER\fR, \fBPROCESS\fR and \fBRELOAD\fRprivileges. However, the
+latter is not necessary if you use the \fB\-\-no\-flush\fR command
+line option.
+
+The slave accounts must be granted the \fBREPLICATION CLIENT\fR
+privilege.
+
+\fBGrot\fR uses configuration files to obtain the connection
+parameters and account credentials of the master and slave servers.
+See below for a descripton of these.
.SH OPTIONS
.TP
@@ -108,6 +129,7 @@ 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\" \""
diff --git a/grot.cfg.5 b/grot.cfg.5
index 56e12eb..334b0d4 100644
--- a/grot.cfg.5
+++ b/grot.cfg.5
@@ -13,7 +13,7 @@
.\"
.\" 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 15, 2009" "grot (grot 1.0)"
+.TH grot.cfg "5" "May 16, 2009" "grot (grot 1.0)" "System Administrator's Manual"
.SH NAME
grot.cfg \- grot configuration file

Return to:

Send suggestions and report system problems to the System administrator.