[unix-history] / usr / src / include / sysexits.h

/*
 * Copyright (c) 1987 Regents of the University of California.
 * All rights reserved.
 *
 * %sccs.include.redist.c%
 *
 *	@(#)sysexits.h	4.8 (Berkeley) %G%
 */

#ifndef	_SYSEXITS_H_
#define	_SYSEXIST_H_

/*
 *  SYSEXITS.H -- Exit status codes for system programs.
 *
 *	This include file attempts to categorize possible error
 *	exit statuses for system programs, notably delivermail
 *	and the Berkeley network.
 *
 *	Error numbers begin at EX__BASE to reduce the possibility of
 *	clashing with other exit statuses that random programs may
 *	already return.  The meaning of the codes is approximately
 *	as follows:
 *
 *	EX_USAGE -- The command was used incorrectly, e.g., with
 *		the wrong number of arguments, a bad flag, a bad
 *		syntax in a parameter, or whatever.
 *	EX_DATAERR -- The input data was incorrect in some way.
 *		This should only be used for user's data & not
 *		system files.
 *	EX_NOINPUT -- An input file (not a system file) did not
 *		exist or was not readable.  This could also include
 *		errors like "No message" to a mailer (if it cared
 *		to catch it).
 *	EX_NOUSER -- The user specified did not exist.  This might
 *		be used for mail addresses or remote logins.
 *	EX_NOHOST -- The host specified did not exist.  This is used
 *		in mail addresses or network requests.
 *	EX_UNAVAILABLE -- A service is unavailable.  This can occur
 *		if a support program or file does not exist.  This
 *		can also be used as a catchall message when something
 *		you wanted to do doesn't work, but you don't know
 *		why.
 *	EX_SOFTWARE -- An internal software error has been detected.
 *		This should be limited to non-operating system related
 *		errors as possible.
 *	EX_OSERR -- An operating system error has been detected.
 *		This is intended to be used for such things as "cannot
 *		fork", "cannot create pipe", or the like.  It includes
 *		things like getuid returning a user that does not
 *		exist in the passwd file.
 *	EX_OSFILE -- Some system file (e.g., /etc/passwd, /etc/utmp,
 *		etc.) does not exist, cannot be opened, or has some
 *		sort of error (e.g., syntax error).
 *	EX_CANTCREAT -- A (user specified) output file cannot be
 *		created.
 *	EX_IOERR -- An error occurred while doing I/O on some file.
 *	EX_TEMPFAIL -- temporary failure, indicating something that
 *		is not really an error.  In sendmail, this means
 *		that a mailer (e.g.) could not create a connection,
 *		and the request should be reattempted later.
 *	EX_PROTOCOL -- the remote system returned something that
 *		was "not possible" during a protocol exchange.
 *	EX_NOPERM -- You did not have sufficient permission to
 *		perform the operation.  This is not intended for
 *		file system problems, which should use NOINPUT or
 *		CANTCREAT, but rather for higher level permissions.
 */

#define EX_OK		0	/* successful termination */

#define EX__BASE	64	/* base value for error messages */

#define EX_USAGE	64	/* command line usage error */
#define EX_DATAERR	65	/* data format error */
#define EX_NOINPUT	66	/* cannot open input */
#define EX_NOUSER	67	/* addressee unknown */
#define EX_NOHOST	68	/* host name unknown */
#define EX_UNAVAILABLE	69	/* service unavailable */
#define EX_SOFTWARE	70	/* internal software error */
#define EX_OSERR	71	/* system error (e.g., can't fork) */
#define EX_OSFILE	72	/* critical OS file missing */
#define EX_CANTCREAT	73	/* can't create (user) output file */
#define EX_IOERR	74	/* input/output error */
#define EX_TEMPFAIL	75	/* temp failure; user is invited to retry */
#define EX_PROTOCOL	76	/* remote error in protocol */
#define EX_NOPERM	77	/* permission denied */
#define EX_CONFIG	78	/* configuration error */

#define EX__MAX	78	/* maximum listed value */

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