wipefs: add --lock and LOCK_BLOCK_DEVICE

[thirdparty/util-linux.git] / text-utils / hexdump.1

diff --git a/text-utils/hexdump.1 b/text-utils/hexdump.1
index 8f11103011ee2f40e58d1cb24af119219550e740..f5728f939d3f39c4138737aac11cdb22340f78a1 100644 (file)
--- a/text-utils/hexdump.1
+++ b/text-utils/hexdump.1
@@ -29,11 +29,11 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"    from: @(#)hexdump.1     8.2 (Berkeley) 4/18/94
+.\"    @(#)hexdump.1   8.2 (Berkeley) 4/18/94
 .\"
 .TH HEXDUMP "1" "April 2013" "util-linux" "User Commands"
 .SH NAME
-hexdump \- display file contents in ascii, decimal, hexadecimal, or octal
+hexdump \- display file contents in hexadecimal, decimal, octal, or ascii
 .SH SYNOPSIS
 .B hexdump
 .RI [options] " file" ...
@@ -46,7 +46,7 @@ format.
 .SH OPTIONS
 Below, the \fIlength\fR and \fIoffset\fR arguments may be followed by the multiplicative
 suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB
-(the "iB" is optional, e.g. "K" has the same meaning as "KiB"), or the suffixes
+(the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes
 KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
 .TP
 \fB\-b\fR, \fB\-\-one\-byte\-octal\fR
@@ -82,9 +82,11 @@ Empty lines and lines whose first non-blank character is a hash mark (\&#)
 are ignored.
 .TP
 \fB\-L\fR, \fB\-\-color\fR[=\fIwhen\fR]
-Accept color units for the output (enabled by default).  The optional argument \fIwhen\fP
+Accept color units for the output.  The optional argument \fIwhen\fP
 can be \fBauto\fR, \fBnever\fR or \fBalways\fR.  If the \fIwhen\fR argument is omitted,
-then it defaults to \fBauto\fR.
+it defaults to \fBauto\fR.  The colors can be disabled; for the current built-in default
+see the \fB\-\-help\fR output.  See also the \fBColors\fR subsection and
+the \fBCOLORS\fR section below.
 .TP
 \fB\-n\fR, \fB\-\-length\fR \fIlength\fR
 Interpret only
@@ -116,6 +118,12 @@ are replaced with a line comprised of a single asterisk.
 \fITwo-byte hexadecimal display\fR.  Display the input offset in hexadecimal,
 followed by eight space-separated, four-column, zero-filled, two-byte
 quantities of input data, in hexadecimal, per line.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .PP
 For each input file,
 .B hexdump
@@ -217,13 +225,13 @@ conversion string except that it is only performed once, when all of the
 input data has been processed.
 .TP
 .B \&_c
-Output characters in the default character set.  Nonprinting characters are
+Output characters in the default character set.  Non-printing characters are
 displayed in three-character, zero-padded octal, except for those
 representable by standard escape notation (see above), which are displayed as
 two-character strings.
 .TP
 .B \&_p
-Output characters in the default character set.  Nonprinting characters are
+Output characters in the default character set.  Non-printing characters are
 displayed as a single
 .RB ' \&. '.
 .TP
@@ -234,7 +242,7 @@ displayed using the following, lower-case, names.  Characters greater than
 .RS 10
 .TS
 tab(|);
-left l l l l l.
+l l l l l l.
 000 nul|001 soh|002 stx|003 etx|004 eot|005 enq
 006 ack|007 bel|008 bs|009 ht|00A lf|00B vt
 00C ff|00D cr|00E so|00F si|010 dle|011 dc1
@@ -242,6 +250,7 @@ left l l l l l.
 018 can|019 em|01A sub|01B esc|01C fs|01D gs
 01E rs|01F us|0FF del
 .TE
+.RE
 .SS Colors
 When put at the end of a format specifier, hexdump highlights the
 respective string with the color specified.  Conditions, if present, are
@@ -259,7 +268,7 @@ unit if both a value/\:string and an offset are specified.  In that case
 the respective output string will be highlighted if and only if the
 value/\:string does not match the one at the offset.
 .TP
-.BR COLOR
+.B COLOR
 One of the 8 basic shell colors.
 .TP
 .B VALUE
@@ -314,7 +323,7 @@ If, as a result of the specification of the
 .B \-n
 option or end-of-file being reached, input data only partially satisfies a
 format string, the input block is zero-padded sufficiently to display all
-available data (i.e. any format units overlapping the end of data will
+available data (i.e., any format units overlapping the end of data will
 display some number of the zero bytes).
 .PP
 Further output by such format strings is replaced by an equivalent number of
@@ -328,14 +337,17 @@ conversion character or conversion string but with any
 .RB ' \&# '
 conversion flag characters removed, and referencing a NULL string.
 .PP
-If no format strings are specified, the default display is equivalent
-to specifying the
-.B \-x
-option.
-.SH "EXIT STATUS"
+If no format strings are specified, the default display is very similar to
+the \fB\-x\fR output format (the \fB\-x\fR option causes more space to be
+used between format units than in the default output).
+.SH EXIT STATUS
 .B hexdump
 exits 0 on success and >0 if an error occurred.
-.SH EXAMPLES
+.SH CONFORMING TO
+The
+.B hexdump
+utility is expected to be IEEE Std 1003.2 ("POSIX.2") compatible.
+.SH EXAMPLE
 Display the input in perusal format:
 .nf
    "%06.6_ao "  12/1 "%3_u "
@@ -361,12 +373,8 @@ Implicit coloring can be disabled by an empty file \fI/etc/terminal-colors.d/hex
 See
 .BR terminal-colors.d (5)
 for more details about colorization configuration.
-.SH STANDARDS
-The
-.B hexdump
-utility is expected to be IEEE Std 1003.2 ("POSIX.2") compatible.
 .SH AVAILABILITY
 The hexdump command is part of the util-linux package and is available from
-.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 Linux Kernel Archive
 .UE .