lib/libc/stdlib/quick_exit.3

   1 .\"     $NetBSD: quick_exit.3,v 1.3 2015/07/26 17:03:06 christos Exp $
   2 .\"  Copyright (c) 2011 David Chisnall
   3 .\"  All rights reserved.
   4 .\"
   5 .\"  Redistribution and use in source and binary forms, with or without
   6 .\"  modification, are permitted provided that the following conditions
   7 .\"  are met:
   8 .\"  1. Redistributions of source code must retain the above copyright
   9 .\"     notice, this list of conditions and the following disclaimer.
  10 .\"  2. Redistributions in binary form must reproduce the above copyright
  11 .\"     notice, this list of conditions and the following disclaimer in the
  12 .\"     documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\"  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\"  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\"  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\"  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\"  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\"  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\"  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\"  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\"  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\"  SUCH DAMAGE.
  25 .\"
  26 .\"  $FreeBSD: src/lib/libc/stdlib/quick_exit.3,v 1.4 2012/11/17 01:49:41 svnexp Exp $
  27 .\"
  28 .Dd July 26, 2015
  29 .Dt QUICK_EXIT 3
  30 .Os
  31 .Sh NAME
  32 .Nm quick_exit
  33 .Nd exits a program quickly, running minimal cleanup
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In stdlib.h
  38 .Ft _Noreturn void
  39 .Fn quick_exit "int status"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn quick_exit
  43 function exits the program quickly calling any cleanup functions registered
  44 with
  45 .Xr at_quick_exit 3
  46 but not any C++ destructors or cleanup code registered with
  47 .Xr atexit 3 .
  48 .Pp
  49 The
  50 .Fa status
  51 values
  52 .Dv EXIT_SUCCESS
  53 and
  54 .Dv EXIT_FAILURE
  55 can be used to indicate successful and unsuccessful
  56 termination, respectively.
  57 .Sh RETURN VALUES
  58 The
  59 .Fn quick_exit
  60 function does not return.
  61 .Sh SEE ALSO
  62 .Xr at_quick_exit 3 ,
  63 .Xr exit 3
  64 .Sh STANDARDS
  65 The
  66 .Fn quick_exit
  67 function conforms to
  68 .St -isoC-2011 .