lib/libc/stdlib/exit.3

   1 .\" $NetBSD: exit.3,v 1.16 2013/04/26 18:29:55 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the American National Standards Committee X3, on Information
   8 .\" Processing Systems.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     from: @(#)exit.3        8.1 (Berkeley) 6/4/93
  35 .\"
  36 .Dd January 2, 2012
  37 .Dt EXIT 3
  38 .Os
  39 .Sh NAME
  40 .Nm exit
  41 .Nd perform normal program termination
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdlib.h
  46 .Ft void
  47 .Fn exit "int status"
  48 .Sh DESCRIPTION
  49 .Fn exit
  50 terminates a process.
  51 The
  52 .Fa status
  53 values
  54 .Dv EXIT_SUCCESS
  55 and
  56 .Dv EXIT_FAILURE
  57 can be used to indicate successful and unsuccessful
  58 termination, respectively.
  59 .Pp
  60 Before termination it performs the following functions in the
  61 order listed:
  62 .Bl -enum -offset indent
  63 .It
  64 Call the functions registered with the
  65 .Xr atexit 3
  66 function, in the reverse order of their registration.
  67 .It
  68 Flush all open output streams.
  69 .It
  70 Close all open streams.
  71 .It
  72 Unlink all files created with the
  73 .Xr tmpfile 3
  74 function.
  75 .El
  76 .Pp
  77 Following this,
  78 .Fn exit
  79 calls
  80 .Xr _exit 2 .
  81 .Sh RESTRICTIONS
  82 Standard C guarantees only that the values zero,
  83 .Dv EXIT_SUCCESS ,
  84 and
  85 .Dv EXIT_FAILURE
  86 produce meaningful results.
  87 POSIX extends this to guarantee that the
  88 least significant 8 bits of
  89 .Fa status
  90 are preserved and returned to the parent via
  91 .Xr wait 2 .
  92 Values outside the supported range 0-255 are bitwise-truncated; therefore,
  93 negative values should not be used.
  94 .Sh RETURN VALUES
  95 The
  96 .Fn exit
  97 function
  98 never returns.
  99 .Sh SEE ALSO
 100 .Xr _exit 2 ,
 101 .Xr at_quick_exit 3 ,
 102 .Xr atexit 3 ,
 103 .Xr intro 3 ,
 104 .Xr quick_exit 3 ,
 105 .Xr tmpfile 3
 106 .Sh STANDARDS
 107 The
 108 .Fn exit
 109 function
 110 conforms to
 111 .St -ansiC .