From 546a27e2f2b3f516886dfd6b2d6cf21b946c59ad Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Sat, 14 Dec 2024 05:41:08 -0500 Subject: document all options (including unimplemented ones). --- uxd.rst | 45 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) (limited to 'uxd.rst') diff --git a/uxd.rst b/uxd.rst index 26cab62..0ffcd28 100644 --- a/uxd.rst +++ b/uxd.rst @@ -42,8 +42,26 @@ to a pager, try **less -R**. OPTIONS ======= --r - Highlight multi-byte sequences in reverse video, in the hex output. +These options can be used on the command line, and/or in the +**UXD_OPTS** environment variable. The command line takes precedence +over the environment. + +-b + Bold output. This may be more or less readable, depending on your + terminal and its color settings. Ignored if **-m** given. + NOT IMPLEMENTED YET. + +-c nnnn + Set the colors to use. Must be 2 to 4 digits, from 0 to 7. These are + standard ANSI colors. The first 2 are the alternating colors for + normal characters, the 3rd digit (optional) is the color for non-printable + and space characters, and the 4th (optional) is for invalid UTF-8 + sequences. Default: **2351**. This option also disables a prior **-m** + option. + NOT IMPLEMENTED YET. + +-h, --help + Print built-in usage message and exit. -m Monochrome mode. Uses underline, bold, reverse video instead of color. @@ -56,6 +74,10 @@ OPTIONS if you can think of a reason to want it to be. Can be given in decimal, hex (with *0x* prefix), or octal (with *0* prefix). +-r + Highlight multi-byte sequences in reverse video, in the hex + output. Ignored if **-m** given. + -s position Seek in input before starting to dump. Positive *position* means seek from the start of the input. Negative *position* only works @@ -65,9 +87,6 @@ OPTIONS -u Use uppercase hex digits A-F. Default is lowercase. --h, --help - Print built-in usage message and exit. - -v, --version Print version number and exit. @@ -205,9 +224,19 @@ any files other than standard output. There's no config file. ENVIRONMENT =========== -**uxd** doesn't read anything from the environment. It's *not* necessary to -have a UTF-8 locale set in e.g. **LANG** or **LC_ALL**. Also, the **TERM** -variable is not used. +**UXD_OPTS** + If this is set, its value is treated as a set of options, which + get applied before any command-line options. + NOT IMPLEMENTED YET. + +**NO_COLOR** + If this is set (to any value), **uxd** runs in monochrome mode, just + as though the **-m** option were given. This variable is also + respected by **xxd**. + NOT IMPLEMENTED YET. + +It's *not* necessary to have a UTF-8 locale set in e.g. **LANG** or +**LC_ALL**. Also, the **TERM** variable is not used. EXIT STATUS =========== -- cgit v1.2.3