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