dudki: initial import into svn repository

4 files changed, 282 insertions, 0 deletions

diff --git a/man/.gitignore b/man/.gitignore
new file mode 100644
index 0000000..087e3b6
--- a/dev/null
+++ b/man/.gitignore
@@ -0,0 +1,4 @@
+Makefile
+Makefile.in
+dudki.8
+dudki.conf.5
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..a55b255
--- a/dev/null
+++ b/man/Makefile.am
@@ -0,0 +1 @@
+man_MANS=dudki.8 dudki.conf.5
diff --git a/man/dudki.8.in b/man/dudki.8.in
new file mode 100644
index 0000000..3011034
--- a/dev/null
+++ b/man/dudki.8.in
@@ -0,0 +1,123 @@
+.TH dudki 8 "June 9th, 2004" "dudki(8)" "Klever Group (http://www.klever.net/)"
+.hla en
+.ds longopt @HAVE_GETOPT_LONG@
+
+.SH NAME
+
+dudki \- a process monitoring daemon
+
+.SH SYNOPSYS
+
+\fBdudki\fR [\fB-h\fR]
+.if \*[longopt] [\fB--help\fR] [\fB--usage\fR]
+[\fB-V\fR]
+.if \*[longopt] [\fB--version\fR]
+[\fB-L\fR]
+.if \*[longopt] [\fB--license\fR]
+[\fB-f\fR \fIconfigfile\fR]
+.if \*[longopt] [\fB--config=\fR\fIconfigfile\fR]
+[\fB-k\fR]
+.if \*[longopt] [\fB--kill\fR]
+[\fB-r\fR]
+.if \*[longopt] [\fB--reload\fR]
+[\fB-c\fR]
+.if \*[longopt] [\fB--check\fR]
+[\fB-e\fR]
+.if \*[longopt] [\fB--ensure\fR]
+[\fB-t\fR]
+.if \*[longopt] [\fB--test\fR]
+
+.SH DESCRIPTION
+
+dudki daemon is designed to run in the background and periodically
+check if certain processes specified in the configuration file are
+running. If a process is detected as dead dudki tries to restart it
+using the command line specified in the configuration file and notifies
+the specified contact (currently only via email).
+
+.SH OPTIONS
+
+.TP
+.ie \*[longopt] \fB-f\fR \fIconfigfile\fR, \fB--config=\fR\fIconfigfile\fR
+.el \fB-f\fR \fIconfigfile\fR
+Specify the configuration file to use (default is
+\fI@sysconfdir@/dudki.conf\fR).
+.TP
+.ie \*[longopt] \fB-k\fR, \fB--kill\fR
+.el \fB-k\fR
+Stop the running instance by sending the \fBSIGTERM\fR signal.
+.TP
+.ie \*[longopt] \fB-r\fR, \fB--reload\fR
+.el \fB-r\fR
+Reload the running instance by sending the \fBSIGHUP\fR signal.
+.TP
+.ie \*[longopt] \fB-c\fR, \fB--check\fR
+.el \fB-c\fR
+Check if dudki is running. Exit with non-zero status if not.
+.TP
+.ie \*[longopt] \fB-e\fR, \fB--ensure\fR
+.el \fB-e\fR
+Ensure that dudki is running. Load, if not. Useful for running as a
+cron job once in a while. If the daemon is running runs quietly
+providing no output.
+.TP
+.ie \*[longopt] \fB-t\fR, \fB--test\fR
+.el \fB-t\fR
+Check the syntax of configuration file and exit.
+.TP
+.ie \*[longopt] \fB-h\fR, \fB--help\fR, \fB--usage\fR
+.el \fB-h\fR
+Display short usage message and exit.
+.TP
+.ie \*[longopt] \fB-V\fR, \fB--version\fR
+.el \fB-V\fR
+Report version and exit.
+.TP
+.ie \*[longopt] \fB-L\fR, \fB--license\fR
+.el \fB-L\fR
+Show licensing terms.
+
+.SH EXIT STATUS
+
+Zero in case of success, non-zero otherwise.
+
+.SH FILES
+.TP
+@sysconfdir@/dudki.conf
+Default configuration file.
+.TP
+/var/run/dudki.pid
+Default pid-file for the dudki process.
+
+.SH AUTHOR
+
+Written by Michael 'hacker' Krelin <hacker@klever.net>
+
+.SH COPYRIGHT
+
+Copyright (c) 2004 Klever Group (http://www.klever.net/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+.SH BUGS
+
+You tell me. Send reports to <dudki-bugs@klever.net>
+
+.SH SEE ALSO
+\fBdudki.conf\fR(5)
diff --git a/man/dudki.conf.5.in b/man/dudki.conf.5.in
new file mode 100644
index 0000000..23f636d
--- a/dev/null
+++ b/man/dudki.conf.5.in
@@ -0,0 +1,154 @@
+.TH dudki.conf 5 "July 9th, 2004" "dudki.conf(5)" "Klever Group (http://www.klever.net/)"
+.hla en
+
+.SH NAME
+
+dudki.conf \- The configuration file for the dudki process
+monitoring daemon
+
+.SH SYNOPSIS
+
+The dudki.conf file is a runtime configuration file for the dudki
+process monitoring daemon. It contains the information about the process
+being monitored and the instruction on how to cope with the processes.
+
+.SH FILE FORMAT
+
+The file consist of the global configuration and per-process
+configuration sections. The global configuration controls general
+dudki behaviour and sets defaults for per-process configuration
+directives.
+
+.SH GLOBAL CONFIGURATION
+
+.TP
+\fBCheckInterval\fR \fIseconds\fR
+Specifies interval in seconds at wich dudki performs checks.
+.TP
+\fBDaemonize\fR \fIon/off\fR
+Specifies whether dudki daemon should fork itself into background.
+Normally, you don't want it to run in foreground. Unless you want to run
+it from \fIinit(8)\fR process (I've nevetr tried it) via
+\fIinittab(5)\fR.
+.TP
+\fBPidFile\fR \fIfilename\fR
+Specifies where to store dudki's process id (default is
+/var/run/dudki.pid)
+.TP
+\fBMailtoHeader\fR \fIheader\fR \fIcontent\fR
+Sets global defaults for process section's MailtoHeader directive. See
+below.
+.TP
+\fBNotify\fR \fIschema\fR:\fItarget\fR
+Sets global default for per process notification. See below.
+
+.TP
+\fB<Process\fR \fIidentifier\fR\fB>\fR
+Starts per process configuration section. The process will be referenced
+using the short descriptive name specified (for example in email
+notifications).
+
+.SH PER-PROCESS CONFIGURATION
+
+Per-process configuration sections specifies the processes to monitor.
+And parameters pertaining to the process.
+
+.TP
+\fBPidFile\fR \fIfilename\fR
+Specifies the file where to fetch process id of the process being
+monitored from. The absence of file, as well as the absence of process
+specified by the pid stored in the file signifies the process death and
+triggers restart.
+.TP
+\fBRestartCommand\fR \fIcommand\fR
+Specifies the command to run in order to restart the process.
+.TP
+\fBUser\fR \fIuser\fR
+Specifies the unix user to change to before executing the command
+specified by \fBRestartCommand\fR.
+.TP
+\fBGroup\fR \fIgroup\fR
+Specifies the unix group to change to before executing the command
+specified by \fBRestartCommand\fR.
+.TP
+\fBChroot\fR \fIpath\fR
+Specifies the directory to set filesystem root to before executing the
+command specified by by \fBRestartCommand\fR.
+.TP
+\fBMailtoHeader\fR \fIheader\fR \fIcontent\fR
+Specifies extra headers to add to mailto: notifications sent by the
+dudki daemon. Headers specified in per-process section override the
+ones specified globally.A
+.TP
+\fBNotify\fR \fIschema\fR:\fItarget\fR
+Specifies the contact to be notified whenever something notable happens
+to the process. The only schema currently supported is 'mailto:'.
+.TP
+\fB</Process>\fR
+Signifies the end of process section.
+
+.SH EXAMPLE
+
+.br
+CheckInterval 60
+.br
+PidFile /var/run/dudki.pid
+.br
+Daemonize on
+.br
+MailtoHeader From "Dudki <root@klever.net>"
+.br
+MailtoHeader Reply-To devnull@klever.net
+.br
+Notify mailto:hacker@klever.net
+.br 
+
+.br
+<Process apache>
+.br
+ PidFile /var/run/httpd.pid
+.br
+ RestartCommand "exec /usr/sbin/apachectl start"
+.br
+</Process>
+.br
+<Process named>
+.br
+ PidFile /var/run/named.pid
+.br
+ RestartCommand "exec /usr/sbin/named"
+.br
+</Process>
+
+.SH AUTHOR
+
+Written by Michael 'hacker' Krelin <hacker@klever.net>
+
+.SH COPYRIGHT
+
+Copyright (c) 2004 Klever Group (http://www.klever.net/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+.SH BUGS
+
+You tell me. Send reports to <dudki-bugs@klever.net>
+
+.SH SEE ALSO
+\fBdudki\fR(8), \fBinit\fR(8), \fBinittab\fR(5)