summaryrefslogtreecommitdiffabout
path: root/man
Unidiff
Diffstat (limited to 'man') (more/less context) (ignore whitespace changes)
-rw-r--r--man/.gitignore4
-rw-r--r--man/Makefile.am1
-rw-r--r--man/dudki.8.in123
-rw-r--r--man/dudki.conf.5.in154
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 @@
1Makefile
2Makefile.in
3dudki.8
4dudki.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 @@
1.TH dudki 8 "June 9th, 2004" "dudki(8)" "Klever Group (http://www.klever.net/)"
2.hla en
3.ds longopt @HAVE_GETOPT_LONG@
4
5.SH NAME
6
7dudki \- a process monitoring daemon
8
9.SH SYNOPSYS
10
11\fBdudki\fR [\fB-h\fR]
12.if \*[longopt] [\fB--help\fR] [\fB--usage\fR]
13[\fB-V\fR]
14.if \*[longopt] [\fB--version\fR]
15[\fB-L\fR]
16.if \*[longopt] [\fB--license\fR]
17[\fB-f\fR \fIconfigfile\fR]
18.if \*[longopt] [\fB--config=\fR\fIconfigfile\fR]
19[\fB-k\fR]
20.if \*[longopt] [\fB--kill\fR]
21[\fB-r\fR]
22.if \*[longopt] [\fB--reload\fR]
23[\fB-c\fR]
24.if \*[longopt] [\fB--check\fR]
25[\fB-e\fR]
26.if \*[longopt] [\fB--ensure\fR]
27[\fB-t\fR]
28.if \*[longopt] [\fB--test\fR]
29
30.SH DESCRIPTION
31
32dudki daemon is designed to run in the background and periodically
33check if certain processes specified in the configuration file are
34running. If a process is detected as dead dudki tries to restart it
35using the command line specified in the configuration file and notifies
36the specified contact (currently only via email).
37
38.SH OPTIONS
39
40.TP
41.ie \*[longopt] \fB-f\fR \fIconfigfile\fR, \fB--config=\fR\fIconfigfile\fR
42.el \fB-f\fR \fIconfigfile\fR
43Specify the configuration file to use (default is
44\fI@sysconfdir@/dudki.conf\fR).
45.TP
46.ie \*[longopt] \fB-k\fR, \fB--kill\fR
47.el \fB-k\fR
48Stop the running instance by sending the \fBSIGTERM\fR signal.
49.TP
50.ie \*[longopt] \fB-r\fR, \fB--reload\fR
51.el \fB-r\fR
52Reload the running instance by sending the \fBSIGHUP\fR signal.
53.TP
54.ie \*[longopt] \fB-c\fR, \fB--check\fR
55.el \fB-c\fR
56Check if dudki is running. Exit with non-zero status if not.
57.TP
58.ie \*[longopt] \fB-e\fR, \fB--ensure\fR
59.el \fB-e\fR
60Ensure that dudki is running. Load, if not. Useful for running as a
61cron job once in a while. If the daemon is running runs quietly
62providing no output.
63.TP
64.ie \*[longopt] \fB-t\fR, \fB--test\fR
65.el \fB-t\fR
66Check the syntax of configuration file and exit.
67.TP
68.ie \*[longopt] \fB-h\fR, \fB--help\fR, \fB--usage\fR
69.el \fB-h\fR
70Display short usage message and exit.
71.TP
72.ie \*[longopt] \fB-V\fR, \fB--version\fR
73.el \fB-V\fR
74Report version and exit.
75.TP
76.ie \*[longopt] \fB-L\fR, \fB--license\fR
77.el \fB-L\fR
78Show licensing terms.
79
80.SH EXIT STATUS
81
82Zero in case of success, non-zero otherwise.
83
84.SH FILES
85.TP
86@sysconfdir@/dudki.conf
87Default configuration file.
88.TP
89/var/run/dudki.pid
90Default pid-file for the dudki process.
91
92.SH AUTHOR
93
94Written by Michael 'hacker' Krelin <hacker@klever.net>
95
96.SH COPYRIGHT
97
98Copyright (c) 2004 Klever Group (http://www.klever.net/)
99
100Permission is hereby granted, free of charge, to any person obtaining a copy of
101this software and associated documentation files (the "Software"), to deal in
102the Software without restriction, including without limitation the rights to
103use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
104of the Software, and to permit persons to whom the Software is furnished to do
105so, subject to the following conditions:
106
107The above copyright notice and this permission notice shall be included in all
108copies or substantial portions of the Software.
109
110THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
111IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
112FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
113AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
114LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
115OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
116SOFTWARE.
117
118.SH BUGS
119
120You tell me. Send reports to <dudki-bugs@klever.net>
121
122.SH SEE ALSO
123\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 @@
1.TH dudki.conf 5 "July 9th, 2004" "dudki.conf(5)" "Klever Group (http://www.klever.net/)"
2.hla en
3
4.SH NAME
5
6dudki.conf \- The configuration file for the dudki process
7monitoring daemon
8
9.SH SYNOPSIS
10
11The dudki.conf file is a runtime configuration file for the dudki
12process monitoring daemon. It contains the information about the process
13being monitored and the instruction on how to cope with the processes.
14
15.SH FILE FORMAT
16
17The file consist of the global configuration and per-process
18configuration sections. The global configuration controls general
19dudki behaviour and sets defaults for per-process configuration
20directives.
21
22.SH GLOBAL CONFIGURATION
23
24.TP
25\fBCheckInterval\fR \fIseconds\fR
26Specifies interval in seconds at wich dudki performs checks.
27.TP
28\fBDaemonize\fR \fIon/off\fR
29Specifies whether dudki daemon should fork itself into background.
30Normally, you don't want it to run in foreground. Unless you want to run
31it from \fIinit(8)\fR process (I've nevetr tried it) via
32\fIinittab(5)\fR.
33.TP
34\fBPidFile\fR \fIfilename\fR
35Specifies where to store dudki's process id (default is
36/var/run/dudki.pid)
37.TP
38\fBMailtoHeader\fR \fIheader\fR \fIcontent\fR
39Sets global defaults for process section's MailtoHeader directive. See
40below.
41.TP
42\fBNotify\fR \fIschema\fR:\fItarget\fR
43Sets global default for per process notification. See below.
44
45.TP
46\fB<Process\fR \fIidentifier\fR\fB>\fR
47Starts per process configuration section. The process will be referenced
48using the short descriptive name specified (for example in email
49notifications).
50
51.SH PER-PROCESS CONFIGURATION
52
53Per-process configuration sections specifies the processes to monitor.
54And parameters pertaining to the process.
55
56.TP
57\fBPidFile\fR \fIfilename\fR
58Specifies the file where to fetch process id of the process being
59monitored from. The absence of file, as well as the absence of process
60specified by the pid stored in the file signifies the process death and
61triggers restart.
62.TP
63\fBRestartCommand\fR \fIcommand\fR
64Specifies the command to run in order to restart the process.
65.TP
66\fBUser\fR \fIuser\fR
67Specifies the unix user to change to before executing the command
68specified by \fBRestartCommand\fR.
69.TP
70\fBGroup\fR \fIgroup\fR
71Specifies the unix group to change to before executing the command
72specified by \fBRestartCommand\fR.
73.TP
74\fBChroot\fR \fIpath\fR
75Specifies the directory to set filesystem root to before executing the
76command specified by by \fBRestartCommand\fR.
77.TP
78\fBMailtoHeader\fR \fIheader\fR \fIcontent\fR
79Specifies extra headers to add to mailto: notifications sent by the
80dudki daemon. Headers specified in per-process section override the
81ones specified globally.A
82.TP
83\fBNotify\fR \fIschema\fR:\fItarget\fR
84Specifies the contact to be notified whenever something notable happens
85to the process. The only schema currently supported is 'mailto:'.
86.TP
87\fB</Process>\fR
88Signifies the end of process section.
89
90.SH EXAMPLE
91
92.br
93CheckInterval 60
94.br
95PidFile /var/run/dudki.pid
96.br
97Daemonize on
98.br
99MailtoHeader From "Dudki <root@klever.net>"
100.br
101MailtoHeader Reply-To devnull@klever.net
102.br
103Notify mailto:hacker@klever.net
104.br
105
106.br
107<Process apache>
108.br
109 PidFile /var/run/httpd.pid
110.br
111 RestartCommand "exec /usr/sbin/apachectl start"
112.br
113</Process>
114.br
115<Process named>
116.br
117 PidFile /var/run/named.pid
118.br
119 RestartCommand "exec /usr/sbin/named"
120.br
121</Process>
122
123.SH AUTHOR
124
125Written by Michael 'hacker' Krelin <hacker@klever.net>
126
127.SH COPYRIGHT
128
129Copyright (c) 2004 Klever Group (http://www.klever.net/)
130
131Permission is hereby granted, free of charge, to any person obtaining a copy of
132this software and associated documentation files (the "Software"), to deal in
133the Software without restriction, including without limitation the rights to
134use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
135of the Software, and to permit persons to whom the Software is furnished to do
136so, subject to the following conditions:
137
138The above copyright notice and this permission notice shall be included in all
139copies or substantial portions of the Software.
140
141THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
142IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
143FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
144AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
145LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
146OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
147SOFTWARE.
148
149.SH BUGS
150
151You tell me. Send reports to <dudki-bugs@klever.net>
152
153.SH SEE ALSO
154\fBdudki\fR(8), \fBinit\fR(8), \fBinittab\fR(5)