summaryrefslogtreecommitdiff
path: root/usr.bin
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2010-07-22 07:38:57 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2010-07-22 07:38:57 +0000
commit6328cea558e703dc83c211da35d1a1cd89cf4937 (patch)
tree2a3e80c4881e0330c57ea931fa555b0ce2974cfa /usr.bin
parent13ad5010c3b02973a1e3c53a272da8b0cde479cd (diff)
document exit returns; from daniel dickman
Diffstat (limited to 'usr.bin')
-rw-r--r--usr.bin/cal/cal.16
-rw-r--r--usr.bin/compress/compress.125
-rw-r--r--usr.bin/expand/expand.16
-rw-r--r--usr.bin/head/head.16
-rw-r--r--usr.bin/ipcrm/ipcrm.16
-rw-r--r--usr.bin/ipcs/ipcs.16
-rw-r--r--usr.bin/man/man.16
-rw-r--r--usr.bin/split/split.16
-rw-r--r--usr.bin/strings/strings.16
-rw-r--r--usr.bin/uname/uname.16
-rw-r--r--usr.bin/uuencode/uuencode.110
11 files changed, 65 insertions, 24 deletions
diff --git a/usr.bin/cal/cal.1 b/usr.bin/cal/cal.1
index e699b7f33b8..350daf16309 100644
--- a/usr.bin/cal/cal.1
+++ b/usr.bin/cal/cal.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: cal.1,v 1.22 2009/02/10 19:24:17 jmc Exp $
+.\" $OpenBSD: cal.1,v 1.23 2010/07/22 07:38:56 jmc Exp $
.\" $NetBSD: cal.1,v 1.6 1995/09/02 05:34:20 jtc Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
@@ -33,7 +33,7 @@
.\"
.\" @(#)cal.1 8.2 (Berkeley) 4/28/95
.\"
-.Dd $Mdocdate: February 10 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt CAL 1
.Os
.Sh NAME
@@ -103,6 +103,8 @@ By this time, most countries had recognized the reformation (although a
few did not recognize it until the early 1900's).
Eleven days following that date were eliminated by the reformation, so the
calendar for that month is a bit unusual.
+.Pp
+.Ex -std cal
.Sh SEE ALSO
.Xr calendar 1
.Sh STANDARDS
diff --git a/usr.bin/compress/compress.1 b/usr.bin/compress/compress.1
index 33be7aabb25..addc8baa7a7 100644
--- a/usr.bin/compress/compress.1
+++ b/usr.bin/compress/compress.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: compress.1,v 1.43 2009/04/18 18:21:54 naddy Exp $
+.\" $OpenBSD: compress.1,v 1.44 2010/07/22 07:38:56 jmc Exp $
.\" $NetBSD: compress.1,v 1.5 1995/03/26 09:44:34 glass Exp $
.\"
.\" Copyright (c) 1986, 1990, 1993
@@ -34,7 +34,7 @@
.\"
.\" @(#)compress.1 8.2 (Berkeley) 4/18/94
.\"
-.Dd $Mdocdate: April 18 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt COMPRESS 1
.Os
.Sh NAME
@@ -309,8 +309,25 @@ coding (as used in the historical command compact), and takes less
time to compute.
.Pp
The
-.Nm compress ,
-.Nm uncompress ,
+.Nm compress
+utility exits with one of the following values:
+.Pp
+.Bl -tag -width Ds -compact
+.It 0
+Success.
+.It 1
+An error occurred.
+.It 2
+At least one of the specified files was not compressed since
+.Fl f
+was not specified and compression would have resulted in a size
+increase.
+.It \*(Gt2
+An error occurred.
+.El
+.Pp
+The
+.Nm uncompress
and
.Nm zcat
utilities exit with 0 on success; 1 if an error occurred;
diff --git a/usr.bin/expand/expand.1 b/usr.bin/expand/expand.1
index 2c9983d8097..11536772c3f 100644
--- a/usr.bin/expand/expand.1
+++ b/usr.bin/expand/expand.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: expand.1,v 1.14 2009/02/08 17:15:09 jmc Exp $
+.\" $OpenBSD: expand.1,v 1.15 2010/07/22 07:38:56 jmc Exp $
.\" $NetBSD: expand.1,v 1.3 1995/09/02 06:19:45 jtc Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)expand.1 8.1 (Berkeley) 6/9/93
.\"
-.Dd $Mdocdate: February 8 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt EXPAND 1
.Os
.Sh NAME
@@ -110,6 +110,8 @@ flag, by prefixing
with a dash
.Pq - .
.El
+.Pp
+.Ex -std expand
.Sh SEE ALSO
.Xr fold 1
.Sh STANDARDS
diff --git a/usr.bin/head/head.1 b/usr.bin/head/head.1
index 7fef3feab8b..c5797729c20 100644
--- a/usr.bin/head/head.1
+++ b/usr.bin/head/head.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: head.1,v 1.15 2009/02/08 17:15:10 jmc Exp $
+.\" $OpenBSD: head.1,v 1.16 2010/07/22 07:38:56 jmc Exp $
.\"
.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" from: @(#)head.1 6.6 (Berkeley) 7/24/91
.\"
-.Dd $Mdocdate: February 8 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt HEAD 1
.Os
.Sh NAME
@@ -75,6 +75,8 @@ precedes the output of each file with the following, in order to distinguish
the head of each file:
.Pp
.Dl ==> Ar file No <==
+.Pp
+.Ex -std head
.Sh EXAMPLES
To display the first 500 lines of the file
.Ar foo :
diff --git a/usr.bin/ipcrm/ipcrm.1 b/usr.bin/ipcrm/ipcrm.1
index a94a82260cf..86ee4363e4b 100644
--- a/usr.bin/ipcrm/ipcrm.1
+++ b/usr.bin/ipcrm/ipcrm.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ipcrm.1,v 1.13 2007/05/31 19:20:11 jmc Exp $
+.\" $OpenBSD: ipcrm.1,v 1.14 2010/07/22 07:38:56 jmc Exp $
.\"
.\" Copyright (c) 1994 Adam Glass
.\" All rights reserved.
@@ -24,7 +24,7 @@
.\" SUCH DAMAGE.
.\"
.\""
-.Dd $Mdocdate: May 31 2007 $
+.Dd $Mdocdate: July 22 2010 $
.Dt IPCRM 1
.Os
.Sh NAME
@@ -82,6 +82,8 @@ from the system.
The identifiers and keys associated with these System V IPC objects can be
determined by using
.Xr ipcs 1 .
+.Pp
+.Ex -std ipcrm
.Sh SEE ALSO
.Xr ipcs 1
.Sh STANDARDS
diff --git a/usr.bin/ipcs/ipcs.1 b/usr.bin/ipcs/ipcs.1
index 9ef9b12e7cd..2e89a78a2ea 100644
--- a/usr.bin/ipcs/ipcs.1
+++ b/usr.bin/ipcs/ipcs.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ipcs.1,v 1.19 2007/05/31 19:20:11 jmc Exp $
+.\" $OpenBSD: ipcs.1,v 1.20 2010/07/22 07:38:56 jmc Exp $
.\"
.\" Copyright (c) 1994 SigmaSoft, Th. Lockert
.\" All rights reserved.
@@ -23,7 +23,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: May 31 2007 $
+.Dd $Mdocdate: July 22 2010 $
.Dt IPCS 1
.Os
.Sh NAME
@@ -120,6 +120,8 @@ or
.Fl s
options are specified, information about all active IPC facilities is
listed.
+.Pp
+.Ex -std ipcs
.Sh RESTRICTIONS
System data structures may change while
.Nm
diff --git a/usr.bin/man/man.1 b/usr.bin/man/man.1
index 036273ca69b..857823b2ab5 100644
--- a/usr.bin/man/man.1
+++ b/usr.bin/man/man.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: man.1,v 1.43 2009/06/04 13:30:07 jmc Exp $
+.\" $OpenBSD: man.1,v 1.44 2010/07/22 07:38:56 jmc Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" @(#)man.1 8.2 (Berkeley) 1/2/94
.\"
-.Dd $Mdocdate: June 4 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt MAN 1
.Os
.Sh NAME
@@ -260,6 +260,8 @@ man pages can be found in
.Xr mdoc 7 .
A full tutorial for writing man pages is provided in
.Xr mdoc.samples 7 .
+.Pp
+.Ex -std man
.Sh ENVIRONMENT
.Bl -tag -width MANPATHX
.It Ev MACHINE
diff --git a/usr.bin/split/split.1 b/usr.bin/split/split.1
index ab99ed574c8..4090d1c80b3 100644
--- a/usr.bin/split/split.1
+++ b/usr.bin/split/split.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: split.1,v 1.18 2009/02/08 17:15:10 jmc Exp $
+.\" $OpenBSD: split.1,v 1.19 2010/07/22 07:38:56 jmc Exp $
.\" $NetBSD: split.1,v 1.5 1994/12/21 08:20:35 jtc Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993, 1994
@@ -30,7 +30,7 @@
.\"
.\" @(#)split.1 8.3 (Berkeley) 4/16/94
.\"
-.Dd $Mdocdate: February 8 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt SPLIT 1
.Os
.Sh NAME
@@ -122,6 +122,8 @@ files named with the prefixes
.Sq y ,
and
.Sq z .
+.Pp
+.Ex -std split
.Sh SEE ALSO
.Xr csplit 1 ,
.Xr re_format 7
diff --git a/usr.bin/strings/strings.1 b/usr.bin/strings/strings.1
index 2f5d4071988..da498dce7fe 100644
--- a/usr.bin/strings/strings.1
+++ b/usr.bin/strings/strings.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: strings.1,v 1.14 2009/08/16 09:41:08 sobrado Exp $
+.\" $OpenBSD: strings.1,v 1.15 2010/07/22 07:38:56 jmc Exp $
.\" $NetBSD: strings.1,v 1.4 1994/12/10 11:54:28 jtc Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)strings.1 8.1 (Berkeley) 6/6/93
.\"
-.Dd $Mdocdate: August 16 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt STRINGS 1
.Os
.Sh NAME
@@ -89,6 +89,8 @@ for hexadecimal.
.Pp
.Nm
is useful for identifying random binaries, among other things.
+.Pp
+.Ex -std strings
.Sh SEE ALSO
.Xr hexdump 1 ,
.Xr od 1
diff --git a/usr.bin/uname/uname.1 b/usr.bin/uname/uname.1
index dde22119714..affe9edaa40 100644
--- a/usr.bin/uname/uname.1
+++ b/usr.bin/uname/uname.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: uname.1,v 1.14 2009/02/08 17:15:10 jmc Exp $
+.\" $OpenBSD: uname.1,v 1.15 2010/07/22 07:38:56 jmc Exp $
.\"
.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" from: @(#)du.1 6.13 (Berkeley) 6/20/91
.\"
-.Dd $Mdocdate: February 8 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt UNAME 1
.Os
.Sh NAME
@@ -71,6 +71,8 @@ If no options are specified,
prints the operating system name as if the
.Fl s
option had been specified.
+.Pp
+.Ex -std uname
.Sh SEE ALSO
.Xr hostname 1 ,
.Xr machine 1 ,
diff --git a/usr.bin/uuencode/uuencode.1 b/usr.bin/uuencode/uuencode.1
index 52694d7f0e4..7bcfdfbb825 100644
--- a/usr.bin/uuencode/uuencode.1
+++ b/usr.bin/uuencode/uuencode.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: uuencode.1,v 1.21 2009/02/08 17:15:10 jmc Exp $
+.\" $OpenBSD: uuencode.1,v 1.22 2010/07/22 07:38:56 jmc Exp $
.\" $FreeBSD: uuencode.1,v 1.26 2003/03/18 14:24:47 fanf Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
@@ -31,7 +31,7 @@
.\" @(#)uuencode.1 8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
-.Dd $Mdocdate: February 8 2009 $
+.Dd $Mdocdate: July 22 2010 $
.Dt UUENCODE 1
.Os
.Sh NAME
@@ -172,6 +172,12 @@ By default
deletes any prefix ending with the last slash '/' for security
reasons.
.El
+.Pp
+The
+.Nm uuencode
+and
+.Nm uudecode
+utilities exit with 0 on success; 1 if an error occurred.
.Sh EXAMPLES
The following example packages up a source tree, compresses it,
uuencodes it and mails it to a user on another system.