lib/libc/gen/daemon.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)daemon.3    8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/gen/daemon.3,v 1.6.2.4 2001/12/14 18:33:50 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/daemon.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt DAEMON 3
  38 .Os
  39 .Sh NAME
  40 .Nm daemon
  41 .Nd run in the background
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdlib.h
  46 .Ft int
  47 .Fn daemon "int nochdir" "int noclose"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn daemon
  51 function is for programs wishing to detach themselves from the
  52 controlling terminal and run in the background as system daemons.
  53 .Pp
  54 Unless the argument
  55 .Fa nochdir
  56 is non-zero,
  57 .Fn daemon
  58 changes the current working directory to the root (``/'').
  59 .Pp
  60 Unless the argument
  61 .Fa noclose
  62 is non-zero,
  63 .Fn daemon
  64 will redirect standard input, standard output and standard error
  65 to ``/dev/null''.
  66 .Sh ERRORS
  67 If an error occurs,
  68 .Fn daemon
  69 returns -1 and sets the global variable
  70 .Va errno
  71 to any of the errors specified for the library functions
  72 .Xr fork 2
  73 and
  74 .Xr setsid 2 .
  75 .Sh SEE ALSO
  76 .Xr fork 2 ,
  77 .Xr setsid 2
  78 .Sh HISTORY
  79 The
  80 .Fn daemon
  81 function first appeared in
  82 .Bx 4.4 .