Module Name: src
Committed By: wiz
Date: Fri Jul 6 09:05:26 UTC 2012
Modified Files:
src/usr.bin/hexdump: od.1
Log Message:
>From Bug Hunting:
- correct / improve macro usage;
- (re-)add an actual description in `DESCRIPTION' section;
- synchronize argument name to `-j' option;
- improve wording;
- bump date.
To generate a diff of this commit:
cvs rdiff -u -r1.26 -r1.27 src/usr.bin/hexdump/od.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/hexdump/od.1
diff -u src/usr.bin/hexdump/od.1:1.26 src/usr.bin/hexdump/od.1:1.27
--- src/usr.bin/hexdump/od.1:1.26 Sun Apr 8 22:00:38 2012
+++ src/usr.bin/hexdump/od.1 Fri Jul 6 09:05:26 2012
@@ -1,4 +1,4 @@
-.\" $NetBSD: od.1,v 1.26 2012/04/08 22:00:38 wiz Exp $
+.\" $NetBSD: od.1,v 1.27 2012/07/06 09:05:26 wiz Exp $
.\"
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -27,7 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"/
-.Dd February 9, 2010
+.Dd June 24, 2012
.Dt OD 1
.Os
.Sh NAME
@@ -48,8 +48,17 @@
.Op Cm Bb
.Sm on
.Oc
-.Ar file ...
+.Op Ar
.Sh DESCRIPTION
+The
+.Nm
+utility is a filter which displays each specified
+.Ar file ,
+or the standard input if no
+.Ar file
+arguments are specified, in a user specified
+format.
+.Pp
The options are as follows:
.Bl -tag -width Fl
.It Fl A Ar base
@@ -125,22 +134,22 @@ decimal, per line.
Display the input offset in octal, followed by eight space-separated,
six column, space filled, two-byte units of input data, in decimal,
per line.
-.It Fl j Ar offset
+.It Fl j Ar skip
Skip
-.Ar offset
+.Ar skip
bytes from the beginning of the input.
By default,
-.Ar offset
+.Ar skip
is interpreted as a decimal number.
With a leading
.Cm 0x
or
.Cm 0X ,
-.Ar offset
-is interpreted as a hexadecimal number,
+.Ar skip
+is interpreted as a hexadecimal number;
otherwise, with a leading
.Cm 0 ,
-.Ar offset
+.Ar skip
is interpreted as an octal number.
Appending the character
.Cm b ,
@@ -148,7 +157,7 @@ Appending the character
or
.Cm m
to
-.Ar offset
+.Ar skip
causes it to be interpreted as a multiple of
.Li 512 ,
.Li 1024 ,
@@ -188,13 +197,15 @@ selects US-ASCII output, with control ch
names instead of as C escape sequences.
See also the
.Cm _u
-conversion provided by hexdump(1).
+conversion provided by
+.Xr hexdump 1 .
.Pp
.Cm c
selects a standard character based conversion.
See also the
.Cm _c
-conversion provided by hexdump(1).
+conversion provided by
+.Xr hexdump 1 .
.Pp
.Cm f
selects the floating point output format.
@@ -210,7 +221,8 @@ to specify eight byte floating point out
The default output format is eight byte floats.
See also the
.Cm e
-conversion provided by hexdump(1).
+conversion provided by
+.Xr hexdump 1 .
.Pp
.Cm d ,
.Cm o ,
@@ -250,7 +262,8 @@ See also the
.Cm u ,
and
.Cm x
-conversions provided by hexdump(1).
+conversions provided by
+.Xr hexdump 1 .
.\"(a|c|f[FLD]?|[doux][C1S2I4L8]?)*
.It Fl v
The
@@ -263,7 +276,8 @@ Without the
option, any number of groups of output lines, which would be
identical to the immediately preceding group of output lines (except
for the input offsets), are replaced with a line comprised of a
-single asterisk.
+single asterisk
+.Pq Sq \&* .
.It Fl X
Same as
.Fl H .
@@ -280,18 +294,19 @@ If no options are specified, the
default display is equivalent to specifying the
.Fl o
option.
-.Pp
-.Nm
-exits 0 on success and \*[Gt]0 if an error occurred.
+.Sh EXIT STATUS
+.Ex -std
.Sh SEE ALSO
.Xr hexdump 1 ,
.Xr strings 1
.Sh HISTORY
-A
+An
.Nm
-command appears in
+command appeared in
.At v1 .
.Pp
-This man page was written in February 2001 by Andrew Brown, shortly
-after he augmented the deprecated od syntax to include things he felt
+This man page was initially written in February 2001 by Andrew Brown, shortly
+after he augmented the deprecated
+.Nm
+syntax to include things he felt
had been missing for a long time.
