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