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