[src/trunk]: src/usr.bin/hexdump new man page from @@@

[christos <christos%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/e6ce10baa5f8
branches:  trunk
changeset: 503586:e6ce10baa5f8
user:      christos <christos%NetBSD.org@localhost>
date:      Fri Feb 09 17:50:44 2001 +0000

description:
new man page from @@@

diffstat:

 usr.bin/hexdump/od.1 |  241 ++++++++++++++++++++++++++++++++++++++++++++------
 1 files changed, 211 insertions(+), 30 deletions(-)

diffs (287 lines):

diff -r d02e97527854 -r e6ce10baa5f8 usr.bin/hexdump/od.1
--- a/usr.bin/hexdump/od.1      Fri Feb 09 17:48:01 2001 +0000
+++ b/usr.bin/hexdump/od.1      Fri Feb 09 17:50:44 2001 +0000
@@ -1,7 +1,10 @@
-.\"    $NetBSD: od.1,v 1.9 2001/02/07 18:31:07 christos Exp $
+.\"  $NetBSD: od.1,v 1.10 2001/02/09 17:50:44 christos Exp $
 .\"
-.\" Copyright (c) 1990, 1993
-.\"    The Regents of the University of California.  All rights reserved.
+.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Andrew Brown.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
@@ -13,57 +16,54 @@
 .\"    documentation and/or other materials provided with the distribution.
 .\" 3. All advertising materials mentioning features or use of this software
 .\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
-.\" 4. Neither the name of the University nor the names of its contributors
-.\"    may be used to endorse or promote products derived from this software
-.\"    without specific prior written permission.
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
 .\"
-.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\"    $NetBSD: od.1,v 1.9 2001/02/07 18:31:07 christos Exp $
-.\"    from: @(#)od.1  8.1 (Berkeley) 6/6/93
-.\"
-.Dd June 8, 1998
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (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 February 9, 2001
+.Dt OD 1
 .Os
-.Dt OD 1
 .Sh NAME
 .Nm od
 .Nd octal, decimal, hex, ascii dump
 .Sh SYNOPSIS
 .Nm ""
 .Op Fl aBbcDdeFfHhIiLlOovXx
-.Sm off
 .Bk -words
 .Op Fl t Ar type_string
 .Ek
+.Sm off
 .Oo
 .Op Cm \&+
 .Li offset
 .Op Cm \&.
 .Op Cm Bb
+.Sm on
 .Oc
-.Ar file
+.Ar file ...
 .Sh DESCRIPTION
 .Nm
 has been deprecated in favor of
 .Xr hexdump 1 .
 .Pp
-.Xr Hexdump ,
+.Xr Hexdump 1 ,
 if called as
 .Nm "" ,
-provides compatibility for the options listed above.
-.Pp
+provides compatibility for the options described below.
 It does not provide compatibility for the
 .Fl s
 option (see
@@ -75,6 +75,187 @@
 .Fl w
 options, nor is compatibility provided for the ``label'' component
 of the offset syntax.
+.Pp
+The options are as follows:
+.Bl -tag -width Fl
+.It Fl a
+.Em One-byte character display .
+Display the input offset in octal, followed by sixteen
+space-separated, three column, space-filled, characters of input data
+per line.  Control characters are printed as their names instead of as
+c style escapes.
+.It Fl B
+Same as
+.Fl o .
+.It Fl b
+.Em One-byte octal display .
+Display the input offset in octal, followed by sixteen
+space-separated, three column, zero-filled, bytes of input data, in
+octal, per line.  This is the default output style if no other is
+selected.
+.It Fl c
+.Em One-byte character display .
+Display the input offset in octal, followed by sixteen
+space-separated, three column, space-filled, characters of input data
+per line.  Control characters are printed at c style escapes, or as
+three octal digits, if no c escape exists for the character.
+.It Fl d
+.Em Two-byte decimal display .
+Display the input offset in octal, followed by eight
+space-separated, five column, zero-filled, two-byte units
+of input data, in unsigned decimal, per line.
+.It Fl e
+.Em Eight-byte floating point display .
+Display the input offset in octal, followed by two space-separated,
+twenty-one column, space filled, eight byte units of input data, in
+floating point, per line.
+.It Fl F
+Same as
+.Fl e .
+.It Fl f
+.Em Four-byte floating point display .
+Display the input offset in octal, followed by four space-separated,
+14 column, space filled, four byte units of input data, in floating
+point, per line.
+.It Fl H
+.Em Four-byte hex display .
+Display the input offset in octal, followed by four space-separated,
+eight column, zero filled, four byte units of input data, in hex,
+per line.
+.It Fl h
+.Em Two-byte hex display .
+Display the input offset in octal, followed by eight space-separated,
+four column, zero filled, two byte units of input data, in hex,
+per line.
+.It Fl I
+.Em Four-byte decimal display .
+Display the input offset in octal, followed by four space-separated,
+eleven column, space filled, four byte units of input data, in
+decimal, per line.
+.It Fl i
+.Em Two-byte decimal display .
+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 L
+Same as
+.Fl I .
+.It Fl l
+Same as
+.Fl I .
+.It Fl O
+.Em Four-byte octal display .
+Display the input offset in octal, followed by four
+space-separated, eleven column, zero-filled, four-byte units
+of input data, in octal, per line.
+.It Fl o
+.Em Two-byte octal display .
+Display the input offset in octal, followed by eight
+space-separated, six column, zero-filled, two-byte units
+of input data, in octal, per line.
+.It Fl t Ar type_string
+Specify one or more output types.  The
+.Em type_string
+option-argument must be a string specifying the types to be used when
+writing the input data.  The string must consist of the type
+specification characters:
+.Pp
+.Cm a
+selects US-ASCII output, with control characters replaced with their
+names instead of as c escape sequences.  See also the
+.Cm _u
+conversion provided by hexdump(1).
+.Pp
+.Cm c
+selects a standard character based conversion.  See also the
+.Cm _c
+conversion provided by hexdump(1).
+.Pp
+.Cm f
+selects the floating point output format.  This type character can be
+optionally followed by the characters
+.Cm 4
+or
+.Cm F
+to specify four byte floating point output, or
+.Cm 8
+or
+.Cm L
+to specify eight byte floating point output.  The default output
+format is eight byte floats.  See also the
+.Cm e
+conversion provided by hexdump(1).
+.Pp
+.Cm d ,
+.Cm o ,
+.Cm u ,
+or
+.Cm x
+select decimal, octal, unsigned decimal, or hex output respectively.
+These types can optionally be followed by
+.Cm C
+or
+.Cm 1
+to specify one byte output,
+.Cm S
+or
+.Cm 2
+to specify two byte output,
+.Cm I
+or
+.Cm 4
+to specify four byte output, or
+.Cm L
+or
+.Cm 8
+to specify eight byte output.  The default output format is in four
+byte quantities.  See also the
+.Cm d ,
+.Cm o ,
+.Cm u ,
+and
+.Cm x
+conversions provided by hexdump(1).
+.\"(a|c|f[FLD]?|[doux][C1S2I4L8]?)*
+.It Fl v
+The
+.Fl v
+option causes
+.Nm
+to display all input data.
+Without the
+.Fl v
+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.
+.It Fl X
+Same as
+.Fl H .
+.It Fl x
+Same as
+.Fl h .
+.El
+.Pp
+For each input file,
+.Nm
+sequentially copies the input to standard output, transforming the
+data according to the options given.  If no options are specified, the
+default display is equivalent to specifying the
+.Fl o
+option.
+.Pp
+.Nm
+exits 0 on success and >0 if an error occurred.
 .Sh SEE ALSO
 .Xr hexdump 1 ,
 .Xr strings 1
+.Sh HISTORY
+A
+.Nm
+command appears 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 me felt
+had been missing for a long.