xref: /freebsd/usr.sbin/daemon/daemon.8 (revision b7c60aadbbd5c846a250c05791fe7406d6d78bf4)
1.\" Copyright (c) 1999 Berkeley Software Design, Inc. All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
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.
14.\"
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
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd March 19, 2007
30.Dt DAEMON 8
31.Os
32.Sh NAME
33.Nm daemon
34.Nd run detached from the controlling terminal
35.Sh SYNOPSIS
36.Nm
37.Op Fl cf
38.Op Fl p Ar pidfile
39.Op Fl u Ar user
40.Ar command arguments ...
41.Sh DESCRIPTION
42The
43.Nm
44utility detaches itself from the controlling terminal and
45executes the program specified by its arguments.
46Privileges may be lowered to the specified user.
47.Pp
48The options are as follows:
49.Bl -tag -width indent
50.It Fl c
51Change the current working directory to the root
52.Pq Dq Pa / .
53.It Fl f
54Redirect standard input, standard output and standard error to
55.Pa /dev/null .
56.It Fl p Ar file
57Write the ID of the created process into the
58.Ar file
59using the
60.Xr pidfile 3
61functionality.
62If the
63.Fl u
64option is used, either the pidfile needs to have been pre-created
65with appropriate ownership and permissions, or the directory to contain
66the pidfile must be writable by the specified user.
67Note, that the file will be created shortly before the process is
68actually executed, and will remain after the process exits (although
69it will be removed if the execution fails).
70.It Fl u Ar user
71Login name of the user to execute the program under.
72Requires adequate superuser privileges.
73.El
74.Sh EXIT STATUS
75The
76.Nm
77utility exits 1 if an error is returned by the
78.Xr daemon 3
79library routine, 2 if the
80.Ar pidfile
81is requested, but cannot be opened, 3 if process is already running (pidfile
82exists and is locked),
83otherwise 0.
84.Sh DIAGNOSTICS
85If the command cannot be executed, an error message is displayed on
86standard error unless the
87.Fl f
88flag is specified.
89.Sh SEE ALSO
90.Xr setregid 2 ,
91.Xr setreuid 2 ,
92.Xr daemon 3 ,
93.Xr exec 3 ,
94.Xr pidfile 3 ,
95.Xr termios 4 ,
96.Xr tty 4
97.Sh HISTORY
98The
99.Nm
100utility first appeared in
101.Fx 4.7 .
102