summaryrefslogtreecommitdiff
path: root/share/man/man3/sysexits.3
diff options
context:
space:
mode:
authorTed Unangst <tedu@cvs.openbsd.org>2015-12-30 16:41:53 +0000
committerTed Unangst <tedu@cvs.openbsd.org>2015-12-30 16:41:53 +0000
commit8090479813134a9b2c438273e5d80ca8518646a6 (patch)
treec4fecfcc7b22cad587796f154171e64fc4c77b02 /share/man/man3/sysexits.3
parentb633d108bf505c859cbd07382200049f3fab5d81 (diff)
sysexits only caught on for mail programs. it is not actually recommended
for general use, so tone down the language. ok deraadt
Diffstat (limited to 'share/man/man3/sysexits.3')
-rw-r--r--share/man/man3/sysexits.317
1 files changed, 7 insertions, 10 deletions
diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3
index 1cac495cf72..c14df27cc1f 100644
--- a/share/man/man3/sysexits.3
+++ b/share/man/man3/sysexits.3
@@ -25,25 +25,22 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $OpenBSD: sysexits.3,v 1.11 2014/09/16 16:17:49 jmc Exp $
+.\" $OpenBSD: sysexits.3,v 1.12 2015/12/30 16:41:52 tedu Exp $
.\" $FreeBSD: src/share/man/man3/sysexits.3,v 1.4.2.1 1999/08/29 16:45:41 peter Exp $
.\"
-.Dd $Mdocdate: September 16 2014 $
+.Dd $Mdocdate: December 30 2015 $
.Dt SYSEXITS 3
.Os
.Sh NAME
.Nm sysexits
-.Nd preferable exit codes for programs
+.Nd exit codes for programs
.Sh SYNOPSIS
.In sysexits.h
.Sh DESCRIPTION
-It is not good practice to call
-.Xr exit 3
-with arbitrary values to indicate a failure condition when ending a program.
-Instead, the pre-defined exit codes from
-.Nm
-should be used, so the caller of the process can get a rough
-estimation about the failure class without looking up the source code.
+Some programs use defined error codes to distinguish between possible errors.
+However, most programs in
+.Ox
+do not.
.Pp
The successful exit is always indicated by a status of 0, or
.Dv EX_OK .