From 8994b9d28ebe5b6c3c90330a32d8317cd7299d9b Mon Sep 17 00:00:00 2001
From: "B. Watson" <urchlay@slackware.uk>
Date: Mon, 16 Dec 2024 06:22:56 -0500
Subject: add options to --help message.

---
 uxd.rst | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

(limited to 'uxd.rst')

diff --git a/uxd.rst b/uxd.rst
index b0645e8..3e5e702 100644
--- a/uxd.rst
+++ b/uxd.rst
@@ -50,10 +50,14 @@ Options can be bundled: **-ubc1234** is the same as **-u** **-n** **-c
 1234**. The one exception is the **-n** option, which should appear
 by itself.
 
+.. the comments are turned into the --help message by mkusage.pl.
+
 -b
   Bold output. This may be more or less readable, depending on your
   terminal and its color settings. Ignored if **-m** given.
 
+.. bold color output.
+
 -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
@@ -62,38 +66,54 @@ by itself.
   sequences. Default: **2351**. This option also disables a prior **-m**
   option.
 
+.. colors (2 to 4 digits, 0 to 7).
+
 -h, --help
   Print built-in usage message and exit.
 
+.. print this help message.
+
 -i
   After dumping, print information about the input: number of bytes,
   characters, ASCII (one-byte) characters, multi-byte characters, and
   bad sequences.
 
+.. print number of bytes/chars/ascii/multibyte/bad sequences.
+
 -l length
   Stop dumping after *length* bytes (not characters). If the limit is
   reached in the middle of a multibyte character, the entire character
   will be dumped.
 
+.. stop dumping after <length> bytes (not characters).
+
 -m
   Monochrome mode. Uses underline, bold, reverse video instead of color.
   Use this if you have trouble distinguishing the colors, or if they
   look too much like angry fruit salad. Disables prior **-b**, **-c**
   options.
 
+.. monochrome mode.
+
 -n
   Ignore **UXD_OPTS** environment variable. This option should not be
   bundled with other options (e.g. use **-n -u**, not **-nu**).
 
+.. ignore UXD_OPTS environment variable.
+
 -o offset
   Add this amount to the hex offsets (left column). May be negative,
   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).
 
+.. added to hex offsets (decimal, 0x hex, 0 octal).
+
 -r
   Highlight multi-byte sequences in reverse video, in the hex
   output. Ignored if **-m** given.
 
+.. highlight multi-byte chars in reverse video.
+
 -s pos
   Seek in input before starting to dump. *pos* is bytes, not
   characters. Positive *pos* means seek from the start of the
@@ -101,17 +121,25 @@ by itself.
   it means seek backward from EOF. Can be given in decimal, hex (with
   *0x* prefix), or octal (with *0* prefix).
 
+.. seek in input before dumping (-pos = seek back from EOF).
+
 -S pos
   Same as **-s**, but file offsets start at 0 rather than the
   position after seeking. **-S 100** is the same as **-s 100 -o -100**.
   Works with negative *pos*, too.
 
+.. like -s, but also sets -o so addresses start at 0.
+
 -u
   Use uppercase hex digits *A-F*. Default is lowercase.
 
+.. uppercase hex digits.
+
 -v, --version
   Print version number and exit.
 
+.. print version of uxd.
+
 OUTPUT FORMAT
 =============
 
@@ -211,8 +239,8 @@ The author's testing is done primarily with **urxvt**\(1). Other
 terminals aren't tested as often. Some terminals may need UTF-8
 enabled, if it's not on by default (e.g. xterm).
 
-Known to work: urxvt, xterm, st, xfce4-terminal, gnome-terminal, kitty, the Linux console (but
-see **FONTS**, below).
+Known to work: urxvt, xterm, st, xfce4-terminal, gnome-terminal,
+kitty, konsole, the Linux console (but see **FONTS**, below).
 
 Known **not** to work: rxvt (doesn't support Unicode at all), and its
 derivatives such as aterm.
-- 
cgit v1.2.3