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