xref: /illumos-gate/usr/src/cmd/sendmail/src/sysexits.h (revision 7c478bd9)
1*7c478bd9Sstevel@tonic-gate /*
2*7c478bd9Sstevel@tonic-gate  * Copyright (c) 1987, 1993
3*7c478bd9Sstevel@tonic-gate  *	The Regents of the University of California.  All rights reserved.
4*7c478bd9Sstevel@tonic-gate  *
5*7c478bd9Sstevel@tonic-gate  * By using this file, you agree to the terms and conditions set
6*7c478bd9Sstevel@tonic-gate  * forth in the LICENSE file which can be found at the top level of
7*7c478bd9Sstevel@tonic-gate  * the sendmail distribution.
8*7c478bd9Sstevel@tonic-gate  *
9*7c478bd9Sstevel@tonic-gate  *	$Id: sysexits.h,v 8.5 2000/11/26 02:13:20 ca Exp $
10*7c478bd9Sstevel@tonic-gate  *	@(#)sysexits.h	8.1 (Berkeley) 6/2/93
11*7c478bd9Sstevel@tonic-gate  */
12*7c478bd9Sstevel@tonic-gate 
13*7c478bd9Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
14*7c478bd9Sstevel@tonic-gate 
15*7c478bd9Sstevel@tonic-gate #ifndef _SYSEXITS_H_
16*7c478bd9Sstevel@tonic-gate # define _SYSEXITS_H_
17*7c478bd9Sstevel@tonic-gate 
18*7c478bd9Sstevel@tonic-gate /*
19*7c478bd9Sstevel@tonic-gate **  SYSEXITS.H -- Exit status codes for system programs.
20*7c478bd9Sstevel@tonic-gate **
21*7c478bd9Sstevel@tonic-gate **	This include file attempts to categorize possible error
22*7c478bd9Sstevel@tonic-gate **	exit statuses for system programs, notably delivermail
23*7c478bd9Sstevel@tonic-gate **	and the Berkeley network.
24*7c478bd9Sstevel@tonic-gate **
25*7c478bd9Sstevel@tonic-gate **	Error numbers begin at EX__BASE to reduce the possibility of
26*7c478bd9Sstevel@tonic-gate **	clashing with other exit statuses that random programs may
27*7c478bd9Sstevel@tonic-gate **	already return.  The meaning of the codes is approximately
28*7c478bd9Sstevel@tonic-gate **	as follows:
29*7c478bd9Sstevel@tonic-gate **
30*7c478bd9Sstevel@tonic-gate **	EX_USAGE -- The command was used incorrectly, e.g., with
31*7c478bd9Sstevel@tonic-gate **		the wrong number of arguments, a bad flag, a bad
32*7c478bd9Sstevel@tonic-gate **		syntax in a parameter, or whatever.
33*7c478bd9Sstevel@tonic-gate **	EX_DATAERR -- The input data was incorrect in some way.
34*7c478bd9Sstevel@tonic-gate **		This should only be used for user's data & not
35*7c478bd9Sstevel@tonic-gate **		system files.
36*7c478bd9Sstevel@tonic-gate **	EX_NOINPUT -- An input file (not a system file) did not
37*7c478bd9Sstevel@tonic-gate **		exist or was not readable.  This could also include
38*7c478bd9Sstevel@tonic-gate **		errors like "No message" to a mailer (if it cared
39*7c478bd9Sstevel@tonic-gate **		to catch it).
40*7c478bd9Sstevel@tonic-gate **	EX_NOUSER -- The user specified did not exist.  This might
41*7c478bd9Sstevel@tonic-gate **		be used for mail addresses or remote logins.
42*7c478bd9Sstevel@tonic-gate **	EX_NOHOST -- The host specified did not exist.  This is used
43*7c478bd9Sstevel@tonic-gate **		in mail addresses or network requests.
44*7c478bd9Sstevel@tonic-gate **	EX_UNAVAILABLE -- A service is unavailable.  This can occur
45*7c478bd9Sstevel@tonic-gate **		if a support program or file does not exist.  This
46*7c478bd9Sstevel@tonic-gate **		can also be used as a catchall message when something
47*7c478bd9Sstevel@tonic-gate **		you wanted to do doesn't work, but you don't know
48*7c478bd9Sstevel@tonic-gate **		why.
49*7c478bd9Sstevel@tonic-gate **	EX_SOFTWARE -- An internal software error has been detected.
50*7c478bd9Sstevel@tonic-gate **		This should be limited to non-operating system related
51*7c478bd9Sstevel@tonic-gate **		errors as possible.
52*7c478bd9Sstevel@tonic-gate **	EX_OSERR -- An operating system error has been detected.
53*7c478bd9Sstevel@tonic-gate **		This is intended to be used for such things as "cannot
54*7c478bd9Sstevel@tonic-gate **		fork", "cannot create pipe", or the like.  It includes
55*7c478bd9Sstevel@tonic-gate **		things like getuid returning a user that does not
56*7c478bd9Sstevel@tonic-gate **		exist in the passwd file.
57*7c478bd9Sstevel@tonic-gate **	EX_OSFILE -- Some system file (e.g., /etc/passwd, /etc/utmp,
58*7c478bd9Sstevel@tonic-gate **		etc.) does not exist, cannot be opened, or has some
59*7c478bd9Sstevel@tonic-gate **		sort of error (e.g., syntax error).
60*7c478bd9Sstevel@tonic-gate **	EX_CANTCREAT -- A (user specified) output file cannot be
61*7c478bd9Sstevel@tonic-gate **		created.
62*7c478bd9Sstevel@tonic-gate **	EX_IOERR -- An error occurred while doing I/O on some file.
63*7c478bd9Sstevel@tonic-gate **	EX_TEMPFAIL -- temporary failure, indicating something that
64*7c478bd9Sstevel@tonic-gate **		is not really an error.  In sendmail, this means
65*7c478bd9Sstevel@tonic-gate **		that a mailer (e.g.) could not create a connection,
66*7c478bd9Sstevel@tonic-gate **		and the request should be reattempted later.
67*7c478bd9Sstevel@tonic-gate **	EX_PROTOCOL -- the remote system returned something that
68*7c478bd9Sstevel@tonic-gate **		was "not possible" during a protocol exchange.
69*7c478bd9Sstevel@tonic-gate **	EX_NOPERM -- You did not have sufficient permission to
70*7c478bd9Sstevel@tonic-gate **		perform the operation.  This is not intended for
71*7c478bd9Sstevel@tonic-gate **		file system problems, which should use NOINPUT or
72*7c478bd9Sstevel@tonic-gate **		CANTCREAT, but rather for higher level permissions.
73*7c478bd9Sstevel@tonic-gate */
74*7c478bd9Sstevel@tonic-gate 
75*7c478bd9Sstevel@tonic-gate # define EX_OK		0	/* successful termination */
76*7c478bd9Sstevel@tonic-gate 
77*7c478bd9Sstevel@tonic-gate # define EX__BASE	64	/* base value for error messages */
78*7c478bd9Sstevel@tonic-gate 
79*7c478bd9Sstevel@tonic-gate # define EX_USAGE	64	/* command line usage error */
80*7c478bd9Sstevel@tonic-gate # define EX_DATAERR	65	/* data format error */
81*7c478bd9Sstevel@tonic-gate # define EX_NOINPUT	66	/* cannot open input */
82*7c478bd9Sstevel@tonic-gate # define EX_NOUSER	67	/* addressee unknown */
83*7c478bd9Sstevel@tonic-gate # define EX_NOHOST	68	/* host name unknown */
84*7c478bd9Sstevel@tonic-gate # define EX_UNAVAILABLE	69	/* service unavailable */
85*7c478bd9Sstevel@tonic-gate # define EX_SOFTWARE	70	/* internal software error */
86*7c478bd9Sstevel@tonic-gate # define EX_OSERR	71	/* system error (e.g., can't fork) */
87*7c478bd9Sstevel@tonic-gate # define EX_OSFILE	72	/* critical OS file missing */
88*7c478bd9Sstevel@tonic-gate # define EX_CANTCREAT	73	/* can't create (user) output file */
89*7c478bd9Sstevel@tonic-gate # define EX_IOERR	74	/* input/output error */
90*7c478bd9Sstevel@tonic-gate # define EX_TEMPFAIL	75	/* temp failure; user is invited to retry */
91*7c478bd9Sstevel@tonic-gate # define EX_PROTOCOL	76	/* remote error in protocol */
92*7c478bd9Sstevel@tonic-gate # define EX_NOPERM	77	/* permission denied */
93*7c478bd9Sstevel@tonic-gate # define EX_CONFIG	78	/* configuration error */
94*7c478bd9Sstevel@tonic-gate 
95*7c478bd9Sstevel@tonic-gate # define EX__MAX	78	/* maximum listed value */
96*7c478bd9Sstevel@tonic-gate 
97*7c478bd9Sstevel@tonic-gate #endif /* ! _SYSEXITS_H_ */
98