Home | History | Annotate | Download | only in Include
      1 /** @file contains exit code definitions for exiting systems applications.
      2 
      3   These exit codes are an extension beyond the two values specified by
      4   ISO/IEC 9899:199409 and defined in <stdlib.h>.
      5 
      6  * Copyright (c) 1987, 1993
      7  *  The Regents of the University of California.  All rights reserved.
      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  * 3. All advertising materials mentioning features or use of this software
     18  *    must display the following acknowledgement:
     19  *  This product includes software developed by the University of
     20  *  California, Berkeley and its contributors.
     21  * 4. Neither the name of the University nor the names of its contributors
     22  *    may be used to endorse or promote products derived from this software
     23  *    without specific prior written permission.
     24  *
     25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     35  * SUCH DAMAGE.
     36  *
     37  *  @(#)sysexits.h  8.1 (Berkeley) 6/2/93
     38  */
     39 
     40 #ifndef _SYSEXITS_H_
     41 #define _SYSEXITS_H_
     42 
     43 /*
     44  *  SYSEXITS.H -- Exit status codes for system programs.
     45  *
     46  *  This include file attempts to categorize possible error
     47  *  exit statuses for system programs, notably delivermail
     48  *  and the Berkeley network.
     49  *
     50  *  Error numbers begin at EX__BASE to reduce the possibility of
     51  *  clashing with other exit statuses that random programs may
     52  *  already return.  The meaning of the codes is approximately
     53  *  as follows:
     54  *
     55  *  EX_USAGE -- The command was used incorrectly, e.g., with
     56  *    the wrong number of arguments, a bad flag, a bad
     57  *    syntax in a parameter, or whatever.
     58  *  EX_DATAERR -- The input data was incorrect in some way.
     59  *    This should only be used for user's data & not
     60  *    system files.
     61  *  EX_NOINPUT -- An input file (not a system file) did not
     62  *    exist or was not readable.  This could also include
     63  *    errors like "No message" to a mailer (if it cared
     64  *    to catch it).
     65  *  EX_NOUSER -- The user specified did not exist.  This might
     66  *    be used for mail addresses or remote logins.
     67  *  EX_NOHOST -- The host specified did not exist.  This is used
     68  *    in mail addresses or network requests.
     69  *  EX_UNAVAILABLE -- A service is unavailable.  This can occur
     70  *    if a support program or file does not exist.  This
     71  *    can also be used as a catchall message when something
     72  *    you wanted to do doesn't work, but you don't know
     73  *    why.
     74  *  EX_SOFTWARE -- An internal software error has been detected.
     75  *    This should be limited to non-operating system related
     76  *    errors as possible.
     77  *  EX_OSERR -- An operating system error has been detected.
     78  *    This is intended to be used for such things as "cannot
     79  *    fork", "cannot create pipe", or the like.  It includes
     80  *    things like getuid returning a user that does not
     81  *    exist in the passwd file.
     82  *  EX_OSFILE -- Some system file (e.g., /etc/passwd, /etc/utmp,
     83  *    etc.) does not exist, cannot be opened, or has some
     84  *    sort of error (e.g., syntax error).
     85  *  EX_CANTCREAT -- A (user specified) output file cannot be
     86  *    created.
     87  *  EX_IOERR -- An error occurred while doing I/O on some file.
     88  *  EX_TEMPFAIL -- temporary failure, indicating something that
     89  *    is not really an error.  In sendmail, this means
     90  *    that a mailer (e.g.) could not create a connection,
     91  *    and the request should be reattempted later.
     92  *  EX_PROTOCOL -- the remote system returned something that
     93  *    was "not possible" during a protocol exchange.
     94  *  EX_NOPERM -- You did not have sufficient permission to
     95  *    perform the operation.  This is not intended for
     96  *    file system problems, which should use NOINPUT or
     97  *    CANTCREAT, but rather for higher level permissions.
     98  */
     99 
    100 #define EX_OK   0 /* successful termination */
    101 
    102 #define EX__BASE  64  /* base value for error messages */
    103 
    104 #define EX_USAGE  64  /* command line usage error */
    105 #define EX_DATAERR  65  /* data format error */
    106 #define EX_NOINPUT  66  /* cannot open input */
    107 #define EX_NOUSER 67  /* addressee unknown */
    108 #define EX_NOHOST 68  /* host name unknown */
    109 #define EX_UNAVAILABLE  69  /* service unavailable */
    110 #define EX_SOFTWARE 70  /* internal software error */
    111 #define EX_OSERR  71  /* system error (e.g., can't fork) */
    112 #define EX_OSFILE 72  /* critical OS file missing */
    113 #define EX_CANTCREAT  73  /* can't create (user) output file */
    114 #define EX_IOERR  74  /* input/output error */
    115 #define EX_TEMPFAIL 75  /* temp failure; user is invited to retry */
    116 #define EX_PROTOCOL 76  /* remote error in protocol */
    117 #define EX_NOPERM 77  /* permission denied */
    118 #define EX_CONFIG 78  /* configuration error */
    119 
    120 #define EX__MAX 78  /* maximum listed value */
    121 
    122 #endif /* !_SYSEXITS_H_ */
    123