xref: /netbsd-src/external/bsd/openldap/dist/include/sysexits-compat.h (revision 549b59ed3ccf0d36d3097190a0db27b770f3a839)
1 /*	$NetBSD: sysexits-compat.h,v 1.3 2021/08/14 16:14:55 christos Exp $	*/
2 
3 /* $OpenLDAP$ */
4 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5  *
6  * Copyright 1998-2021 The OpenLDAP Foundation.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted only as authorized by the OpenLDAP
11  * Public License.
12  *
13  * A copy of this license is available in file LICENSE in the
14  * top-level directory of the distribution or, alternatively, at
15  * <http://www.OpenLDAP.org/license.html>.
16  */
17 /* Portions Copyright (c) 1987 Regents of the University of California.
18  * All rights reserved.
19  *
20  * Redistribution and use in source and binary forms are permitted
21  * provided that the above copyright notice and this paragraph are
22  * duplicated in all such forms and that any documentation,
23  * advertising materials, and other materials related to such
24  * distribution and use acknowledge that the software was developed
25  * by the University of California, Berkeley.  The name of the
26  * University may not be used to endorse or promote products derived
27  * from this software without specific prior written permission.
28  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
29  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
30  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
31  *
32  *	@(#)sysexits.h	4.5 (Berkeley) 7/6/88
33  */
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, /etc/utmp,
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 **		For example, kre uses this to restrict who students
91 **		can send mail to.
92 **
93 **	Maintained by Eric Allman (eric@berkeley, ucbvax!eric) --
94 **		please mail changes to me.
95 **
96 **			@(#)sysexits.h	4.5		7/6/88
97 */
98 
99 # define EX_OK		0	/* successful termination */
100 
101 # define EX__BASE	64	/* base value for error messages */
102 
103 # define EX_USAGE	64	/* command line usage error */
104 # define EX_DATAERR	65	/* data format error */
105 # define EX_NOINPUT	66	/* cannot open input */
106 # define EX_NOUSER	67	/* addressee unknown */
107 # define EX_NOHOST	68	/* host name unknown */
108 # define EX_UNAVAILABLE	69	/* service unavailable */
109 # define EX_SOFTWARE	70	/* internal software error */
110 # define EX_OSERR	71	/* system error (e.g., can't fork) */
111 # define EX_OSFILE	72	/* critical OS file missing */
112 # define EX_CANTCREAT	73	/* can't create (user) output file */
113 # define EX_IOERR	74	/* input/output error */
114 # define EX_TEMPFAIL	75	/* temp failure; user is invited to retry */
115 # define EX_PROTOCOL	76	/* remote error in protocol */
116 # define EX_NOPERM	77	/* permission denied */
117 # define EX_CONFIG	78	/* configuration error */
118