lib/libc/stdlib/exit.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)exit.3      8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/stdlib/exit.3,v 1.6.2.4 2001/12/14 18:33:58 ru Exp $
  38 .\" $DragonFly: src/lib/libc/stdlib/exit.3,v 1.3 2007/06/15 19:36:33 swildner Exp $
  39 .\"
  40 .Dd June 15, 2007
  41 .Dt EXIT 3
  42 .Os
  43 .Sh NAME
  44 .Nm exit ,
  45 .Nm _Exit
  46 .Nd perform normal program termination
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdlib.h
  51 .Ft void
  52 .Fn exit "int status"
  53 .Ft void
  54 .Fn _Exit "int status"
  55 .Sh DESCRIPTION
  56 The
  57 .Fn exit
  58 and
  59 .Fn _Exit
  60 functions terminate a process.
  61 .Pp
  62 Before termination,
  63 .Fn exit
  64 performs the following functions in the order listed:
  65 .Bl -enum -offset indent
  66 .It
  67 Call the functions registered with the
  68 .Xr atexit 3
  69 function, in the reverse order of their registration.
  70 .It
  71 Flush all open output streams.
  72 .It
  73 Close all open streams.
  74 .It
  75 Unlink all files created with the
  76 .Xr tmpfile 3
  77 function.
  78 .El
  79 .Pp
  80 The C99 function
  81 .Fn _Exit
  82 terminates without calling the functions registered with
  83 .Xr atexit 3
  84 by just calling
  85 .Xr _exit 2 .
  86 Code intended to be portable should always use
  87 .Xr _exit 2
  88 directly as it is defined by
  89 .St -susv2
  90 as well.
  91 .Pp
  92 Passing arbitrary values back to the environment as
  93 .Ar status
  94 is considered bad style;
  95 you should use the values
  96 .Dv EXIT_SUCCESS
  97 and
  98 .Dv EXIT_FAILURE .
  99 If portability is not a concern, you may
 100 use the values described in
 101 .Xr sysexits 3 .
 102 .Sh RETURN VALUES
 103 The
 104 .Fn exit
 105 and
 106 .Fn _Exit
 107 functions never return.
 108 .Sh SEE ALSO
 109 .Xr _exit 2 ,
 110 .Xr atexit 3 ,
 111 .Xr intro 3 ,
 112 .Xr sysexits 3 ,
 113 .Xr tmpfile 3
 114 .Sh STANDARDS
 115 The
 116 .Fn exit
 117 and
 118 .Fn _Exit
 119 functions conform to
 120 .St -isoC-99 .