1 .\" Copyright (c) 1999 Berkeley Software Design, Inc. All rights reserved.
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\" notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\" notice, this list of conditions and the following disclaimer in the
10 .\" documentation and/or other materials provided with the distribution.
11 .\" 3. Berkeley Software Design Inc's name may not be used to endorse or
12 .\" promote products derived from this software without specific prior
13 .\" written permission.
15 .\" THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .Nd run detached from the controlling terminal
38 .Op Fl p Ar child_pidfile
39 .Op Fl P Ar supervisor_pidfile
42 .Op Fl m Ar output_mask
43 .Op Fl o Ar output_file
44 .Op Fl s Ar syslog_priority
45 .Op Fl T Ar syslog_tag
46 .Op Fl l Ar syslog_facility
47 .Ar command arguments ...
51 utility detaches itself from the controlling terminal and
52 executes the program specified by its arguments.
53 Privileges may be lowered to the specified user.
54 The output of the daemonized process may be redirected to syslog and to a
57 The options are as follows:
58 .Bl -tag -width indent
60 Change the current working directory to the root
63 Redirect standard input, standard output and standard error to
67 This is implicitly applied if other syslog parameters are provided.
68 The default values are daemon, notice, and daemon for facility, priority, and
70 .It Fl o Ar output_file
71 Append output from the daemonized process to
73 If the file does not exist, it is created with permissions 0600.
74 .It Fl m Ar output_mask
75 Redirect output from the child process stdout (1), stderr (2), or both (3).
76 This value specifies what is sent to syslog and the log file.
78 .It Fl p Ar child_pidfile
79 Write the ID of the created process into the
84 The program is executed in a spawned child process while the
86 waits until it terminates to keep the
88 locked and removes it after the process exits.
91 owner is the user who runs the
93 regardless of whether the
95 option is used or not.
96 .It Fl P Ar supervisor_pidfile
100 .Ar supervisor_pidfile
104 The program is executed in a spawned child process while the
106 waits until it terminates to keep the
107 .Ar supervisor_pidfile
108 locked and removes it after the process exits.
110 .Ar supervisor_pidfile
111 owner is the user who runs the
113 regardless of whether the
115 option is used or not.
117 Supervise and restart the program if it has been terminated.
119 Set the title for the daemon process.
120 The default is the daemonized invocation.
122 Login name of the user to execute the program under.
123 Requires adequate superuser privileges.
124 .It Fl s Ar syslog_priority
125 These priorities are accepted: emerg, alert, crit, err, warning,
126 notice, info, and debug.
128 .It Fl l Ar syslog_facility
129 These facilities are accepted: auth, authpriv, console, cron, daemon,
130 ftp, kern, lpr, mail, news, ntp, security, syslog, user, uucp, and
132 The default is daemon.
133 .It Fl T Ar syslog_tag
134 Set the tag which is appended to all syslog messages.
135 The default is daemon.
138 If any of the options
149 are specified, the program is executed in a spawned child process.
152 waits until it terminates to keep the pid file(s) locked and removes them
153 after the process exits or restarts the program.
154 In this case if the monitoring
156 receives software termination signal (SIGTERM) it forwards it to the
158 Normally it will cause the child to exit, remove the pidfile(s)
161 If neither file or syslog output are selected, all output is redirected to the
163 process and written to stdout.
166 option may be used to suppress the stdout output completely.
170 option is useful combined with the
173 .Ar supervisor_pidfile
174 contains the ID of the supervisor
176 This is especially important if you use
178 in an rc script as the
180 option will give you the child's ID to signal when you attempt to
181 stop the service, causing
183 to restart the child.
187 utility exits 1 if an error is returned by the
189 library routine, 2 if
192 .Ar supervisor_pidfile
193 is requested, but cannot be opened, 3 if process is already running (pidfile
194 exists and is locked), 4 if
196 is not accepted, 5 if
198 is not accepted, 6 if
200 is not within the accepted range, 7 if
202 cannot be opened for appending, and otherwise 0.
204 If the command cannot be executed, an error message is printed to
206 The exact behavior depends on the logging parameters and the
220 utility first appeared in