Date: 28 Mar 2002 17:25:07 -0800 From: "Gary W. Swearingen" <swear@blarg.net> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/36448: intro(8) manual is missing command status explanation Message-ID: <m4r8m4go7g.8m4@localhost.localdomain>
next in thread | raw e-mail | index | archive | help
>Number: 36448 >Category: docs >Synopsis: intro(8) manual is missing command status explanation >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Thu Mar 28 17:30:01 PST 2002 >Closed-Date: >Last-Modified: >Originator: Gary W. Swearingen >Release: FreeBSD 4.5-STABLE i386 >Organization: none >Environment: n/a ================ >Description: The "Description" section of the intro(8) manual should have a new second paragraph which is a (near) copy of the command status explanation from the intro(1) manual. ================ >How-To-Repeat: n/a ================ >Fix: Either add this exact copy from intro(1): - - - - - - .Pp All commands set a status value upon exit which may be tested to see if the command completed normally. 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). - - - - - - Or, better yet, add this new-and-improved version: - - - - - - .Pp All commands set an exit status. Its value may be tested to see if the command completed normally. Unless otherwise noted (rare), 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 defined in .Xr sysexits 3 , or set the status to arbitrary values >0 (typically 1), but many such values are not described in the manuals. >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?m4r8m4go7g.8m4>