From 98e1f63634ab9b117258a176e0727c23126bb762 Mon Sep 17 00:00:00 2001 From: tjr Date: Fri, 17 May 2002 07:14:55 +0000 Subject: Overhaul hexdump's od syntax code to handle the -s -A -j -N -t options that SUSv3 requires and give od a proper manual page. PR: 36783 --- usr.bin/hexdump/od.1 | 195 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 175 insertions(+), 20 deletions(-) (limited to 'usr.bin/hexdump/od.1') diff --git a/usr.bin/hexdump/od.1 b/usr.bin/hexdump/od.1 index ac46aab..f135469 100644 --- a/usr.bin/hexdump/od.1 +++ b/usr.bin/hexdump/od.1 @@ -32,7 +32,7 @@ .\" @(#)od.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" -.Dd May 27, 1994 +.Dd April 17, 2002 .Os .Dt OD 1 .Sh NAME @@ -40,7 +40,11 @@ .Nd octal, decimal, hex, ASCII dump .Sh SYNOPSIS .Nm -.Op Fl aBbcDdeFfHhIiLlOovXx +.Op Fl aBbcDdeFfHhIiLlOosvXx +.Op Fl A Ar base +.Op Fl j Ar skip +.Op Fl N Ar length +.Op Fl t Ar type .Sm off .Oo .Op Cm \&+ @@ -49,32 +53,183 @@ .Op Cm Bb .Oc .Sm on -.Ar file +.Op Ar .Sh DESCRIPTION The -.Nm hexdump -utility, if called as -.Nm , -provides compatibility for the options listed above. +.Nm +utility is a filter which displays the specified files, or standard +input if no files are specified, in a user specified format. .Pp -It does not provide compatibility for the -.Fl s -option (see -.Xr strings 1 ) -or the -.Fl P , -.Fl p , +The options are as follows: +.Bl -tag -width Fl +.It Fl A Ar base +Specify the input address base. +.Ar base +may be one of +.Ql d , +.Ql o , +.Ql x +or +.Ql n , +which specify decimal, octal, hexadecimal +addresses or no address, respectively. +.It Fl a +Output named characters. +Equivalent to +.Fl t Ar a . +.It Fl B , Fl o +Output octal shorts. +Equivalent to +.Fl t Ar o2 . +.It Fl b +Output octal bytes. +Equivalent to +.Fl t Ar o1 . +.It Fl c +Output C-style escaped characters. +Equivalent to +.Fl t Ar c . +.It Fl D +Output unsigned decimal ints. +Equivalent to +.Fl t Ar u4 . +.It Fl e , Fl F +Output double-precision floating point numbers. +Equivalent to +.Fl t Ar fD . +.It Fl f +Output single-precision floating point numbers. +Equivalent to +.Fl t Ar fF . +.It Fl H , Fl X +Output hexadecimal ints. +Equivalent to +.Fl t Ar x4 . +.It Fl h , Fl x +Output hexadecimal shorts. +Equivalent to +.Fl t Ar x2 . +.It Fl I , Fl L , Fl l +Output signed decimal longs. +Equivalent to +.Fl t Ar dL . +.It Fl i +Output signed decimal ints. +Equivalent to +.Fl t Ar dI . +.It Fl j Ar skip +Skip +.Ar skip +bytes of the combined input before dumping. The number may be followed by one +of +.Ql b , +.Ql k or -.Fl w -options, nor is compatibility provided for the ``label'' component -of the offset syntax. +.Ql m +which specify the units of the number as blocks (512 bytes), kilobytes and +megabytes, respectively. +.It Fl N Ar length +Dump at most +.Ar length +bytes of input. +.It Fl O +Output octal ints. +Equivalent to +.Fl t Ar o4 . +.It Fl s +Output signed decimal shorts. +Equivalent to +.Fl t Ar d2 . +.It Fl t Ar type +Specify the output format. +.Ar type +is a string containing one or more of the following kinds of type specifiers: +.Bl -tag -width indent +.It Cm a +Named characters +.Pq Sq ASCII . +Control characters are displayed using the following names: +.Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo +.It "\&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq +.It "\&006\ ack\t007\ bel\t008\ bs\t009\ ht\t00A\ nl\t00B\ vt +.It "\&00C\ ff\t00D\ cr\t00E\ so\t00F\ si\t010\ dle\t011\ dc1 +.It "\&012\ dc2\t013\ dc3\t014\ dc4\t015\ nak\t016\ syn\t017\ etb +.It "\&018\ can\t019\ em\t01A\ sub\t01B\ esc\t01C\ fs\t01D\ gs +.It "\&01E\ rs\t01F\ us\t020\ sp\t0FF\ del +.El +.It Cm c +Characters in the default character set. Non-printing characters are +represented as 3-digit octal character codes, except the following +characters, which are represented as C escapes: +.Bl -column carriage-return \er +.It NUL Ta \e0 +.It alert Ta \ea +.It backspace Ta \eb +.It newline Ta \en +.It carriage-return Ta \er +.It tab Ta \et +.It vertical tab Ta \ev +.El +.It Cm [d|o|u|x][C|S|I|L| Ns Ar n Ns ] +Signed decimal +.Pq Ql d , +octal +.Pq Ql o , +unsigned decimal +.Pq Ql u +or +hexadecimal +.Pq Ql x . +Followed by an optional size specifier, which may be either +.Ql C +.Pq "char" , +.Ql S +.Pq "short" , +.Ql I +.Pq "int" , +.Ql L +.Pq "long" , +or a byte count as a decimal integer. +.It Cm f[F|D|L| Ns Ar n Ns ] +Floating-point number. +Followed by an optional size specifier, which may be either +.Ql F +.Pq "float" , +.Ql D +.Pq "double" +or +.Ql L +.Pq "long double" . +.El +.It Fl v +Write all input data, instead of replacing lines of duplicate values with a +.Ql * . +.El +.Pp +Multiple options that specify output format may be used; the output will +contain one line for each format. +.Pp +If no output format is specified, +.Fl t Ar oS +is assumed. +.Sh DIAGNOSTICS +.Ex -std +.Sh COMPATIBILITY +The traditional +.Fl s +option to extract string constants is not supported; consider using +.Xr strings 1 +instead. .Sh SEE ALSO .Xr hexdump 1 , .Xr strings 1 -.Sh BUGS -Quite a few. +.Sh STANDARDS +The +.Nm +utility conforms to +.St -p1003.1-2001 . .Sh HISTORY -A +An .Nm command appeared in .At v1 . -- cgit v1.1