include/sysexits.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1987, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)sysexits.h  8.1 (Berkeley) 6/2/93
  55  */
  56
  57 #ifndef _SYSEXITS_H_
  58 #define _SYSEXITS_H_
  59
  60 /*
  61  *  SYSEXITS.H -- Exit status codes for system programs.
  62  *
  63  *      This include file attempts to categorize possible error
  64  *      exit statuses for system programs, notably delivermail
  65  *      and the Berkeley network.
  66  *
  67  *      Error numbers begin at EX__BASE to reduce the possibility of
  68  *      clashing with other exit statuses that random programs may
  69  *      already return.  The meaning of the codes is approximately
  70  *      as follows:
  71  *
  72  *      EX_USAGE -- The command was used incorrectly, e.g., with
  73  *              the wrong number of arguments, a bad flag, a bad
  74  *              syntax in a parameter, or whatever.
  75  *      EX_DATAERR -- The input data was incorrect in some way.
  76  *              This should only be used for user's data & not
  77  *              system files.
  78  *      EX_NOINPUT -- An input file (not a system file) did not
  79  *              exist or was not readable.  This could also include
  80  *              errors like "No message" to a mailer (if it cared
  81  *              to catch it).
  82  *      EX_NOUSER -- The user specified did not exist.  This might
  83  *              be used for mail addresses or remote logins.
  84  *      EX_NOHOST -- The host specified did not exist.  This is used
  85  *              in mail addresses or network requests.
  86  *      EX_UNAVAILABLE -- A service is unavailable.  This can occur
  87  *              if a support program or file does not exist.  This
  88  *              can also be used as a catchall message when something
  89  *              you wanted to do doesn't work, but you don't know
  90  *              why.
  91  *      EX_SOFTWARE -- An internal software error has been detected.
  92  *              This should be limited to non-operating system related
  93  *              errors as possible.
  94  *      EX_OSERR -- An operating system error has been detected.
  95  *              This is intended to be used for such things as "cannot
  96  *              fork", "cannot create pipe", or the like.  It includes
  97  *              things like getuid returning a user that does not
  98  *              exist in the passwd file.
  99  *      EX_OSFILE -- Some system file (e.g., /etc/passwd, /etc/utmp,
 100  *              etc.) does not exist, cannot be opened, or has some
 101  *              sort of error (e.g., syntax error).
 102  *      EX_CANTCREAT -- A (user specified) output file cannot be
 103  *              created.
 104  *      EX_IOERR -- An error occurred while doing I/O on some file.
 105  *      EX_TEMPFAIL -- temporary failure, indicating something that
 106  *              is not really an error.  In sendmail, this means
 107  *              that a mailer (e.g.) could not create a connection,
 108  *              and the request should be reattempted later.
 109  *      EX_PROTOCOL -- the remote system returned something that
 110  *              was "not possible" during a protocol exchange.
 111  *      EX_NOPERM -- You did not have sufficient permission to
 112  *              perform the operation.  This is not intended for
 113  *              file system problems, which should use NOINPUT or
 114  *              CANTCREAT, but rather for higher level permissions.
 115  */
 116
 117 #define EX_OK           0       /* successful termination */
 118
 119 #define EX__BASE        64      /* base value for error messages */
 120
 121 #define EX_USAGE        64      /* command line usage error */
 122 #define EX_DATAERR      65      /* data format error */
 123 #define EX_NOINPUT      66      /* cannot open input */
 124 #define EX_NOUSER       67      /* addressee unknown */
 125 #define EX_NOHOST       68      /* host name unknown */
 126 #define EX_UNAVAILABLE  69      /* service unavailable */
 127 #define EX_SOFTWARE     70      /* internal software error */
 128 #define EX_OSERR        71      /* system error (e.g., can't fork) */
 129 #define EX_OSFILE       72      /* critical OS file missing */
 130 #define EX_CANTCREAT    73      /* can't create (user) output file */
 131 #define EX_IOERR        74      /* input/output error */
 132 #define EX_TEMPFAIL     75      /* temp failure; user is invited to retry */
 133 #define EX_PROTOCOL     76      /* remote error in protocol */
 134 #define EX_NOPERM       77      /* permission denied */
 135 #define EX_CONFIG       78      /* configuration error */
 136
 137 #define EX__MAX 78      /* maximum listed value */
 138
 139 #endif /* !_SYSEXITS_H_ */