From ae74a806a23ecb54945d6b71a538aa8925538641 Mon Sep 17 00:00:00 2001 From: jmc Date: Thu, 22 Jul 2010 08:09:29 +0000 Subject: [PATCH] move exit returns blurb out of DIAGNOSTICS; from daniel dickman --- bin/date/date.1 | 12 +++++++----- bin/ed/ed.1 | 6 ++++-- bin/expr/expr.1 | 34 +++++++++++++++++----------------- bin/pax/cpio.1 | 26 ++++++++++++++------------ bin/pax/pax.1 | 24 +++++++++++++----------- bin/pax/tar.1 | 26 ++++++++++++++------------ bin/sleep/sleep.1 | 10 +++++----- 7 files changed, 74 insertions(+), 64 deletions(-) diff --git a/bin/date/date.1 b/bin/date/date.1 index 1a37515b5cc..5baf54307f6 100644 --- a/bin/date/date.1 +++ b/bin/date/date.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: date.1,v 1.51 2010/04/01 06:23:33 jmc Exp $ +.\" $OpenBSD: date.1,v 1.52 2010/07/22 08:09:29 jmc Exp $ .\" $NetBSD: date.1,v 1.12 1996/03/12 04:32:37 phil Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -33,7 +33,7 @@ .\" .\" @(#)date.1 8.3 (Berkeley) 4/28/95 .\" -.Dd $Mdocdate: April 1 2010 $ +.Dd $Mdocdate: July 22 2010 $ .Dt DATE 1 .Os .Sh NAME @@ -155,6 +155,11 @@ Everything but the minute is optional. .Pp Time changes for Daylight Saving Time, standard time, leap seconds, and leap years are handled automatically. +.Pp +The +.Nm +utility exits 0 on success, 1 if unable to set the date, +and 2 if able to set the local date, but unable to set it globally. .Sh ENVIRONMENT .Bl -tag -width Ds .It Ev TZ @@ -196,9 +201,6 @@ without modifying the date: .Pp .Dl # date 1432 .Sh DIAGNOSTICS -Exit status is 0 on success, 1 if unable to set the date, and 2 -if able to set the local date, but unable to set it globally. -.Pp Occasionally, when .Xr timed 8 synchronizes the time on many hosts, the setting of a new time value may diff --git a/bin/ed/ed.1 b/bin/ed/ed.1 index debe6c7489e..e9ecb8d9d49 100644 --- a/bin/ed/ed.1 +++ b/bin/ed/ed.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ed.1,v 1.54 2010/01/10 10:53:33 jmc Exp $ +.\" $OpenBSD: ed.1,v 1.55 2010/07/22 08:09:29 jmc Exp $ .\" .\" Copyright (c) 1993 Andrew Moore, Talke Studio. .\" All rights reserved. @@ -24,7 +24,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd $Mdocdate: January 10 2010 $ +.Dd $Mdocdate: July 22 2010 $ .Dt ED 1 .Os .Sh NAME @@ -168,6 +168,8 @@ The default filename is set to .Ar file only if it is not prefixed with a bang. .El +.Pp +.Ex -std ed .Ss LINE ADDRESSING An address represents the number of a line in the buffer. .Nm diff --git a/bin/expr/expr.1 b/bin/expr/expr.1 index bfe462a5d89..c049a730213 100644 --- a/bin/expr/expr.1 +++ b/bin/expr/expr.1 @@ -1,10 +1,10 @@ -.\" $OpenBSD: expr.1,v 1.18 2009/02/08 17:15:09 jmc Exp $ +.\" $OpenBSD: expr.1,v 1.19 2010/07/22 08:09:29 jmc Exp $ .\" $NetBSD: expr.1,v 1.9 1995/04/28 23:27:13 jtc Exp $ .\" .\" Written by J.T. Conklin . .\" Public domain. .\" -.Dd $Mdocdate: February 8 2009 $ +.Dd $Mdocdate: July 22 2010 $ .Dt EXPR 1 .Os .Sh NAME @@ -90,6 +90,21 @@ expr X'' : 'X$' .El .Pp Parentheses are used for grouping in the usual manner. +.Pp +The +.Nm +utility exits with one of the following values: +.Pp +.Bl -tag -width Ds -compact +.It 0 +The expression is neither an empty string nor 0. +.It 1 +The expression is an empty string or 0. +.It 2 +The expression is invalid. +.It \*(Gt2 +An error occurred (such as memory allocation failure). +.El .Sh EXAMPLES .Li $ a=`expr $a + 1` .Pp @@ -109,21 +124,6 @@ characters act to eliminate ambiguity with the division operator. .Pp Return the number of characters in variable .Va a . -.Sh DIAGNOSTICS -The -.Nm -utility exits with one of the following values: -.Pp -.Bl -tag -width Ds -compact -.It 0 -The expression is neither an empty string nor 0. -.It 1 -The expression is an empty string or 0. -.It 2 -The expression is invalid. -.It >2 -An error occurred (such as memory allocation failure). -.El .Sh SEE ALSO .Xr test 1 , .Xr re_format 7 diff --git a/bin/pax/cpio.1 b/bin/pax/cpio.1 index 6ee5fadb5ad..a8d4eeeba6e 100644 --- a/bin/pax/cpio.1 +++ b/bin/pax/cpio.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cpio.1,v 1.28 2008/06/11 07:42:50 jmc Exp $ +.\" $OpenBSD: cpio.1,v 1.29 2010/07/22 08:09:29 jmc Exp $ .\" .\" Copyright (c) 1997 SigmaSoft, Th. Lockert .\" All rights reserved. @@ -23,9 +23,9 @@ .\" (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: cpio.1,v 1.28 2008/06/11 07:42:50 jmc Exp $ +.\" $OpenBSD: cpio.1,v 1.29 2010/07/22 08:09:29 jmc Exp $ .\" -.Dd $Mdocdate: June 11 2008 $ +.Dd $Mdocdate: July 22 2010 $ .Dt CPIO 1 .Os .Sh NAME @@ -240,21 +240,23 @@ Be verbose about operations. List filenames as they are copied. .El .El -.Sh ENVIRONMENT -.Bl -tag -width Fl -.It Ev TMPDIR -Path in which to store temporary files. -.El -.Sh ERRORS +.Pp +The .Nm -will exit with one of the following values: -.Bl -tag -width 2n +utility exits with one of the following values: +.Pp +.Bl -tag -width Ds -compact .It 0 All files were processed successfully. .It 1 An error occurred. .El -.Pp +.Sh ENVIRONMENT +.Bl -tag -width Fl +.It Ev TMPDIR +Path in which to store temporary files. +.El +.Sh DIAGNOSTICS Whenever .Nm cannot create a file or a link when extracting an archive or cannot diff --git a/bin/pax/pax.1 b/bin/pax/pax.1 index 0eafae69aee..4f7e0b37d7e 100644 --- a/bin/pax/pax.1 +++ b/bin/pax/pax.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pax.1,v 1.58 2009/08/16 09:41:08 sobrado Exp $ +.\" $OpenBSD: pax.1,v 1.59 2010/07/22 08:09:29 jmc Exp $ .\" $NetBSD: pax.1,v 1.3 1995/03/21 09:07:37 cgd Exp $ .\" .\" Copyright (c) 1992 Keith Muller. @@ -34,7 +34,7 @@ .\" .\" @(#)pax.1 8.4 (Berkeley) 4/18/94 .\" -.Dd $Mdocdate: August 16 2009 $ +.Dd $Mdocdate: July 22 2010 $ .Dt PAX 1 .Os .Sh NAME @@ -1033,6 +1033,17 @@ options are specified along with the .Fl n option, a file is not considered selected unless it is newer than the file to which it is compared. +.Pp +The +.Nm +utility exits with one of the following values: +.Pp +.Bl -tag -width 2n -offset indent -compact +.It 0 +All files were processed successfully. +.It 1 +An error occurred. +.El .Sh ENVIRONMENT .Bl -tag -width Fl .It Ev TMPDIR @@ -1092,15 +1103,6 @@ files with the same name found in the source file tree .Pp .Dl "$ pax -r -w -v -Y -Z home /backup" .Sh DIAGNOSTICS -.Nm -will exit with one of the following values: -.Bl -tag -width 2n -offset indent -.It 0 -All files were processed successfully. -.It 1 -An error occurred. -.El -.Pp Whenever .Nm cannot create a file or a link when reading an archive or cannot diff --git a/bin/pax/tar.1 b/bin/pax/tar.1 index 21656023dfe..843692c59e0 100644 --- a/bin/pax/tar.1 +++ b/bin/pax/tar.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tar.1,v 1.51 2008/12/27 13:35:34 sobrado Exp $ +.\" $OpenBSD: tar.1,v 1.52 2010/07/22 08:09:29 jmc Exp $ .\" .\" Copyright (c) 1996 SigmaSoft, Th. Lockert .\" All rights reserved. @@ -23,9 +23,9 @@ .\" (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: tar.1,v 1.51 2008/12/27 13:35:34 sobrado Exp $ +.\" $OpenBSD: tar.1,v 1.52 2010/07/22 08:09:29 jmc Exp $ .\" -.Dd $Mdocdate: December 27 2008 $ +.Dd $Mdocdate: July 22 2010 $ .Dt TAR 1 .Os .Sh NAME @@ -280,6 +280,17 @@ The options .Op Fl 014578 can be used to select one of the compiled-in backup devices, .Pa /dev/rstN . +.Pp +The +.Nm +utility exits with one of the following values: +.Pp +.Bl -tag -width 2n -offset indent -compact +.It 0 +All files were processed successfully. +.It 1 +An error occurred. +.El .Sh ENVIRONMENT .Bl -tag -width Fl .It Ev TMPDIR @@ -332,15 +343,6 @@ Note that the glob pattern has been quoted to avoid expansion by the shell: For more detailed examples, see .Xr pax 1 . .Sh DIAGNOSTICS -.Nm -will exit with one of the following values: -.Bl -tag -width 2n -offset indent -.It 0 -All files were processed successfully. -.It 1 -An error occurred. -.El -.Pp Whenever .Nm cannot create a file or a link when extracting an archive or cannot diff --git a/bin/sleep/sleep.1 b/bin/sleep/sleep.1 index 51ee21c956a..4174f32bd18 100644 --- a/bin/sleep/sleep.1 +++ b/bin/sleep/sleep.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sleep.1,v 1.17 2009/02/08 17:15:09 jmc Exp $ +.\" $OpenBSD: sleep.1,v 1.18 2010/07/22 08:09:29 jmc Exp $ .\" $NetBSD: sleep.1,v 1.9 1995/07/25 19:37:43 jtc Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -33,7 +33,7 @@ .\" .\" @(#)sleep.1 8.3 (Berkeley) 4/18/94 .\" -.Dd $Mdocdate: February 8 2009 $ +.Dd $Mdocdate: July 22 2010 $ .Dt SLEEP 1 .Os .Sh NAME @@ -92,17 +92,17 @@ while true; do sleep 5 done .Ed -.Sh DIAGNOSTICS +.Pp The .Nm utility exits with one of the following values: .Pp .Bl -tag -width flag -compact -.It Li \&0 +.It 0 On successful completion, or if the signal .Dv SIGALRM was received. -.It Li \&>\&0 +.It \*(Gt0 An error occurred. .El .Sh SEE ALSO -- 2.20.1