aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README57
1 files changed, 57 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ae10d7f
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+Grot README
+Copyright (C) 2009 Sergey Poznyakoff
+See the end of file for copying conditions.
+
+* Introduction
+
+This file contains brief information about configuring, testing
+and running Grot. It is *not* intended as a replacement for
+documentation. The Grot documentation is available in manpage format.
+After installation, run `man grot', for information about the grot
+program, and `man grot.cfg' for a description of grot configuration
+file format.
+
+* Overview
+
+Grot is Gray's Rotation Tool for MySQL Binary Logs. These are special
+files that the MySQL server creates in order to replicate its data to
+slave servers. These files tend to occupy a lot of disk space, but
+cannot be easily rotated using the usual tools (e.g. logrotate),
+because it is unknown which of them is in use by which slave. Grot is
+designed to fill this gap. It polls each slave and determines the
+oldest log among ones used by them. Then it instructs the server to
+delete all logs that precede it.
+
+* Configuring and Installing
+
+See the INSTALL file for instructions.
+
+* Example
+
+See grot.cfg for an example of run-time configuration file.
+
+* Bug reporting.
+
+Send bug reports to <gray@gnu.org.ua>.
+
+
+* Copyright information:
+
+Copyright (C) 2009 Sergey Poznyakoff
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:

Return to:

Send suggestions and report system problems to the System administrator.