git.sur5r.net Git - openldap/blob - include/sysexits-compat.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.  A copy of this license is available at
   9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
  10  * top-level directory of the distribution.
  11  */
  12 /* Portions
  13  * Copyright (c) 1987 Regents of the University of California.
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms are permitted
  17  * provided that the above copyright notice and this paragraph are
  18  * duplicated in all such forms and that any documentation,
  19  * advertising materials, and other materials related to such
  20  * distribution and use acknowledge that the software was developed
  21  * by the University of California, Berkeley.  The name of the
  22  * University may not be used to endorse or promote products derived
  23  * from this software without specific prior written permission.
  24  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  26  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  27  *
  28  *      @(#)sysexits.h  4.5 (Berkeley) 7/6/88
  29  */
  30
  31 /*
  32 **  SYSEXITS.H -- Exit status codes for system programs.
  33 **
  34 **      This include file attempts to categorize possible error
  35 **      exit statuses for system programs, notably delivermail
  36 **      and the Berkeley network.
  37 **
  38 **      Error numbers begin at EX__BASE to reduce the possibility of
  39 **      clashing with other exit statuses that random programs may
  40 **      already return.  The meaning of the codes is approximately
  41 **      as follows:
  42 **
  43 **      EX_USAGE -- The command was used incorrectly, e.g., with
  44 **              the wrong number of arguments, a bad flag, a bad
  45 **              syntax in a parameter, or whatever.
  46 **      EX_DATAERR -- The input data was incorrect in some way.
  47 **              This should only be used for user's data & not
  48 **              system files.
  49 **      EX_NOINPUT -- An input file (not a system file) did not
  50 **              exist or was not readable.  This could also include
  51 **              errors like "No message" to a mailer (if it cared
  52 **              to catch it).
  53 **      EX_NOUSER -- The user specified did not exist.  This might
  54 **              be used for mail addresses or remote logins.
  55 **      EX_NOHOST -- The host specified did not exist.  This is used
  56 **              in mail addresses or network requests.
  57 **      EX_UNAVAILABLE -- A service is unavailable.  This can occur
  58 **              if a support program or file does not exist.  This
  59 **              can also be used as a catchall message when something
  60 **              you wanted to do doesn't work, but you don't know
  61 **              why.
  62 **      EX_SOFTWARE -- An internal software error has been detected.
  63 **              This should be limited to non-operating system related
  64 **              errors as possible.
  65 **      EX_OSERR -- An operating system error has been detected.
  66 **              This is intended to be used for such things as "cannot
  67 **              fork", "cannot create pipe", or the like.  It includes
  68 **              things like getuid returning a user that does not
  69 **              exist in the passwd file.
  70 **      EX_OSFILE -- Some system file (e.g., /etc/passwd, /etc/utmp,
  71 **              etc.) does not exist, cannot be opened, or has some
  72 **              sort of error (e.g., syntax error).
  73 **      EX_CANTCREAT -- A (user specified) output file cannot be
  74 **              created.
  75 **      EX_IOERR -- An error occurred while doing I/O on some file.
  76 **      EX_TEMPFAIL -- temporary failure, indicating something that
  77 **              is not really an error.  In sendmail, this means
  78 **              that a mailer (e.g.) could not create a connection,
  79 **              and the request should be reattempted later.
  80 **      EX_PROTOCOL -- the remote system returned something that
  81 **              was "not possible" during a protocol exchange.
  82 **      EX_NOPERM -- You did not have sufficient permission to
  83 **              perform the operation.  This is not intended for
  84 **              file system problems, which should use NOINPUT or
  85 **              CANTCREAT, but rather for higher level permissions.
  86 **              For example, kre uses this to restrict who students
  87 **              can send mail to.
  88 **
  89 **      Maintained by Eric Allman (eric@berkeley, ucbvax!eric) --
  90 **              please mail changes to me.
  91 **
  92 **                      @(#)sysexits.h  4.5             7/6/88
  93 */
  94
  95 # define EX_OK          0       /* successful termination */
  96
  97 # define EX__BASE       64      /* base value for error messages */
  98
  99 # define EX_USAGE       64      /* command line usage error */
 100 # define EX_DATAERR     65      /* data format error */
 101 # define EX_NOINPUT     66      /* cannot open input */
 102 # define EX_NOUSER      67      /* addressee unknown */
 103 # define EX_NOHOST      68      /* host name unknown */
 104 # define EX_UNAVAILABLE 69      /* service unavailable */
 105 # define EX_SOFTWARE    70      /* internal software error */
 106 # define EX_OSERR       71      /* system error (e.g., can't fork) */
 107 # define EX_OSFILE      72      /* critical OS file missing */
 108 # define EX_CANTCREAT   73      /* can't create (user) output file */
 109 # define EX_IOERR       74      /* input/output error */
 110 # define EX_TEMPFAIL    75      /* temp failure; user is invited to retry */
 111 # define EX_PROTOCOL    76      /* remote error in protocol */
 112 # define EX_NOPERM      77      /* permission denied */
 113 # define EX_CONFIG      78      /* configuration error */