lib/libutil/pidfile.3

   1 .\"     $NetBSD: pidfile.3,v 1.12 2010/05/05 22:05:31 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Jason R. Thorpe.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd May 4, 2010
  31 .Dt PIDFILE 3
  32 .Os
  33 .Sh NAME
  34 .Nm pidfile
  35 .Nd write a daemon pid file
  36 .Sh LIBRARY
  37 .Lb libutil
  38 .Sh SYNOPSIS
  39 .In util.h
  40 .Ft int
  41 .Fn pidfile "const char *basename"
  42 .Sh DESCRIPTION
  43 .Fn pidfile
  44 writes a file containing the process ID of the program to the
  45 .Pa /var/run
  46 directory.
  47 The file name has the form
  48 .Pa /var/run/basename.pid .
  49 If the
  50 .Ar basename
  51 argument is
  52 .Dv NULL ,
  53 .Fn pidfile
  54 will determine the program name and use that instead.
  55 .Pp
  56 The pid file can be used as a quick reference if
  57 the process needs to be sent a signal.
  58 When the program exits, the pid file will be removed automatically, unless
  59 the program receives a fatal signal.
  60 .Pp
  61 Note that only the first invocation of
  62 .Fn pidfile
  63 causes a pid file to be written; subsequent invocations have no effect
  64 unless a new
  65 .Ar basename
  66 is supplied.
  67 If called with a new
  68 .Ar basename ,
  69 .Fn pidfile
  70 will remove the old pid file and write the new one.
  71 .Sh RETURN VALUES
  72 .Fn pidfile
  73 returns 0 on success and -1 on failure.
  74 .Sh SEE ALSO
  75 .Xr atexit 3
  76 .Sh HISTORY
  77 The
  78 .Fn pidfile
  79 function call appeared in
  80 .Nx 1.5 .
  81 .Sh BUGS
  82 .Fn pidfile
  83 uses
  84 .Xr atexit 3
  85 to ensure the pidfile is unlinked at program exit.
  86 However, programs that use the
  87 .Xr _exit 2
  88 function (for example, in signal handlers)
  89 will not trigger this behaviour.