From ee9dc9c595e436cef6782aa03b527bfec0b667b1 Mon Sep 17 00:00:00 2001
From: Dima Dorfman
Date: Tue, 23 Oct 2001 00:46:13 +0000
Subject: [PATCH] Explain a little about sysexits(3) so that regular users can
take advantage of the fact that some programs care to explain why they
failed.
PR: 31415
---
share/man/man1/intro.1 | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/share/man/man1/intro.1 b/share/man/man1/intro.1
index e17807dfd8b4..f0102198ef76 100644
--- a/share/man/man1/intro.1
+++ b/share/man/man1/intro.1
@@ -32,7 +32,7 @@
.\" @(#)intro.1 8.2 (Berkeley) 12/30/93
.\" $FreeBSD$
.\"
-.Dd December 30, 1993
+.Dd October 21, 2001
.Dt INTRO 1
.Os
.Sh NAME
@@ -55,14 +55,18 @@ and line printer commands.
.Pp
All commands set a status value upon exit which may be tested
to see if the command completed normally.
-The exit values and their meanings are explained in the individual
-manuals. Traditionally, the value 0 signifies successful
-completion of the command.
+Traditionally, the value 0 signifies successful
+completion of the command, while a value >0 indicates an error.
+Some commands attempt to describe the nature of the failure by using
+errors codes as defined in
+.Xr sysexits 3 ,
+while others simply set the status to an arbitrary value >0 (typically 1).
.Sh SEE ALSO
.Xr apropos 1 ,
.Xr man 1 ,
.Xr intro 2 ,
.Xr intro 3 ,
+.Xr sysexits 3 ,
.Xr intro 4 ,
.Xr intro 5 ,
.Xr intro 6 ,