From f38c800bec843edecc592747bf2b196b0aba743a Mon Sep 17 00:00:00 2001 From: jmc Date: Wed, 21 Jul 2010 20:02:29 +0000 Subject: [PATCH] document exit values; from daniel dickman --- usr.bin/ar/ar.1 | 8 +++----- usr.bin/at/at.1 | 15 +++++++++++++-- usr.bin/du/du.1 | 6 ++++-- usr.bin/tsort/tsort.1 | 6 ++++-- usr.bin/who/who.1 | 6 ++++-- 5 files changed, 28 insertions(+), 13 deletions(-) diff --git a/usr.bin/ar/ar.1 b/usr.bin/ar/ar.1 index a3a9a887657..2396ae9113d 100644 --- a/usr.bin/ar/ar.1 +++ b/usr.bin/ar/ar.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ar.1,v 1.16 2009/08/16 09:41:08 sobrado Exp $ +.\" $OpenBSD: ar.1,v 1.17 2010/07/21 20:02:29 jmc Exp $ .\" $NetBSD: ar.1,v 1.7 1995/08/18 15:05:11 pk Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -33,7 +33,7 @@ .\" .\" @(#)ar.1 8.1 (Berkeley) 6/29/93 .\" -.Dd $Mdocdate: August 16 2009 $ +.Dd $Mdocdate: July 21 2010 $ .Dt AR 1 .Os .Sh NAME @@ -297,9 +297,7 @@ into the archive; this will fail if the user is not the owner of the extracted file or the superuser. .El .Pp -The -.Nm -utility exits 0 on success or >0 if an error occurred. +.Ex -std ar .Sh ENVIRONMENT .Bl -tag -width indent -compact .It Ev TMPDIR diff --git a/usr.bin/at/at.1 b/usr.bin/at/at.1 index d5960373515..30bce22b43e 100644 --- a/usr.bin/at/at.1 +++ b/usr.bin/at/at.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: at.1,v 1.40 2010/07/02 23:40:09 krw Exp $ +.\" $OpenBSD: at.1,v 1.41 2010/07/21 20:02:29 jmc Exp $ .\" .\" Copyright (C) 1993, 1994 Thomas Koenig .\" Copyright (C) 1993 David Parsons @@ -24,7 +24,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 2 2010 $ +.Dd $Mdocdate: July 21 2010 $ .Dt AT 1 .Os .Sh NAME @@ -297,6 +297,17 @@ An empty .Pa /var/cron/at.deny means that every user is allowed to use these commands. This is the default configuration. +.Pp +The +.Nm +utility exits with one of the following values: +.Pp +.Bl -tag -width Ds -compact -offset indent +.It 0 +Jobs were successfully submitted, removed, or listed. +.It \*(Gt0 +An error occurred. +.El .Sh FILES .Bl -tag -width /var/cron/at.allow -compact .It Pa /var/cron/atjobs diff --git a/usr.bin/du/du.1 b/usr.bin/du/du.1 index 4c03ab8bea9..4007c63fbf6 100644 --- a/usr.bin/du/du.1 +++ b/usr.bin/du/du.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: du.1,v 1.26 2009/08/16 09:41:08 sobrado Exp $ +.\" $OpenBSD: du.1,v 1.27 2010/07/21 20:02:29 jmc Exp $ .\" $NetBSD: du.1,v 1.6 1996/10/18 07:20:31 thorpej Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)du.1 8.2 (Berkeley) 4/1/94 .\" -.Dd $Mdocdate: August 16 2009 $ +.Dd $Mdocdate: July 21 2010 $ .Dt DU 1 .Os .Sh NAME @@ -121,6 +121,8 @@ Files having multiple hard links are counted (and displayed) a single time per .Nm execution. +.Pp +.Ex -std du .Sh ENVIRONMENT .Bl -tag -width BLOCKSIZE .It Ev BLOCKSIZE diff --git a/usr.bin/tsort/tsort.1 b/usr.bin/tsort/tsort.1 index 08451228087..cfe8770c46d 100644 --- a/usr.bin/tsort/tsort.1 +++ b/usr.bin/tsort/tsort.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tsort.1,v 1.20 2009/02/08 17:33:02 jmc Exp $ +.\" $OpenBSD: tsort.1,v 1.21 2010/07/21 20:02:29 jmc Exp $ .\" $NetBSD: tsort.1,v 1.6 1996/01/17 20:37:49 mycroft Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -33,7 +33,7 @@ .\" .\" @(#)tsort.1 8.3 (Berkeley) 4/1/94 .\" -.Dd $Mdocdate: February 8 2009 $ +.Dd $Mdocdate: July 21 2010 $ .Dt TSORT 1 .Os .Sh NAME @@ -95,6 +95,8 @@ Exit with exit code the number of cycles .Nm had to break. .El +.Pp +.Ex -std tsort .Sh EXAMPLES Faced with the input: .Bd -literal -offset indent diff --git a/usr.bin/who/who.1 b/usr.bin/who/who.1 index 6047053b11e..d4f42f1cb92 100644 --- a/usr.bin/who/who.1 +++ b/usr.bin/who/who.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: who.1,v 1.22 2009/02/08 17:15:10 jmc Exp $ +.\" $OpenBSD: who.1,v 1.23 2010/07/21 20:02:29 jmc Exp $ .\" $NetBSD: who.1,v 1.5 1994/12/07 04:28:47 jtc Exp $ .\" .\" Copyright (c) 1986, 1991, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)who.1 8.2 (Berkeley) 12/30/93 .\" -.Dd $Mdocdate: February 8 2009 $ +.Dd $Mdocdate: July 21 2010 $ .Dt WHO 1 .Os .Sh NAME @@ -115,6 +115,8 @@ and Logouts produce an output line without any user name. For more information on the special characters, see .Xr utmp 5 . +.Pp +.Ex -std who .Sh FILES .Bl -tag -width /var/log/wtmp.[0-6] -compact .It Pa /var/run/utmp -- 2.20.1