From owner-freebsd-doc Thu Mar 28 17:30:17 2002 Delivered-To: freebsd-doc@hub.freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21]) by hub.freebsd.org (Postfix) with ESMTP id BF19537B41A for ; Thu, 28 Mar 2002 17:30:01 -0800 (PST) Received: (from gnats@localhost) by freefall.freebsd.org (8.11.6/8.11.6) id g2T1U1J53662; Thu, 28 Mar 2002 17:30:01 -0800 (PST) (envelope-from gnats) Received: from lists.blarg.net (lists.blarg.net [206.124.128.17]) by hub.freebsd.org (Postfix) with ESMTP id E047237B417 for ; Thu, 28 Mar 2002 17:26:33 -0800 (PST) Received: from thig.blarg.net (thig.blarg.net [206.124.128.18]) by lists.blarg.net (Postfix) with ESMTP id 9CB09BD60 for ; Thu, 28 Mar 2002 17:26:33 -0800 (PST) Received: from localhost.localdomain ([206.124.139.115]) by thig.blarg.net (8.9.3/8.9.3) with ESMTP id RAA12020 for ; Thu, 28 Mar 2002 17:26:32 -0800 Received: (from jojo@localhost) by localhost.localdomain (8.11.6/8.11.3) id g2T1P7f96276; Thu, 28 Mar 2002 17:25:07 -0800 (PST) (envelope-from swear@blarg.net) Message-Id: Date: 28 Mar 2002 17:25:07 -0800 From: "Gary W. Swearingen" Reply-To: swear@blarg.net To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/36448: intro(8) manual is missing command status explanation Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org >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