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