summaryrefslogtreecommitdiffstats
path: root/smenu.1
diff options
context:
space:
mode:
authorpgen <p.gen.progs@gmail.com>2018-03-27 21:27:48 +0200
committerpgen <p.gen.progs@gmail.com>2018-03-27 21:43:03 +0200
commit890e7bf2026ff1ec3e877e445b1105d81f74d4a7 (patch)
tree3f665f04041ee16c67b600f750d1fff5829bc9f7 /smenu.1
parente6ab41f9bd7070a69908023772f2c434b72e04b6 (diff)
Improve the documentation and make sure it matches the code
Diffstat (limited to 'smenu.1')
-rw-r--r--smenu.177
1 files changed, 39 insertions, 38 deletions
diff --git a/smenu.1 b/smenu.1
index fe3e30a..9ace463 100644
--- a/smenu.1
+++ b/smenu.1
@@ -18,7 +18,7 @@ and outputs the selection to stdout.
[\fB-I\fP \fI/regex/string/\fP[\fIg\fP][\fIv\fP][\fIs\fP][\fIi\fP]] \\
[\fB-E\fP \fI/regex/string/\fP[\fIg\fP][\fIv\fP][\fIs\fP][\fIi\fP]] \\
[\fB-A\fP \fIregex\fP] [\fB-Z\fP \fIregex\fP] \\
- [\fB-N\fP \fIregex\fP] [\fB-U\fP \fIregex\fP] [\fB-F\fP] \
+ [\fB-N\fP [\fIregex\fP]] [\fB-U\fP [\fIregex\fP]] [\fB-F\fP] \
[\fB-D\fP \fIsub-option\fP...] \\
[\fB-1\fP \fIregex\fP [\fIATTR\fP]] \
[\fB-2\fP \fIregex\fP [\fIATTR\fP]] ... \
@@ -662,56 +662,56 @@ This option allows to change the default behaviour or the \fB-N\fP,
Its optional parameters are called sub-options and must respect the
format \fBx\fP:\fBy\fP where \fBx\fP can be:
-
-- '\f(CBl\fP' (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
-.br
-where \fBy\fP is the UTF-8 character (in native or \fI\\u\fP form)
+.RS
+.TP
+\f(CBl\fP (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
+Here \fBy\fP is the UTF-8 character (in native or \fI\\u\fP form)
to print before the number. The default is a single space.
-
-- '\f(CBr\fP' (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
-.br
-where \fBy\fP is the UTF-8 character (in native or \fI\\u\fP form)
+.
+.TP
+\f(CBr\fP (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
+Here \fBy\fP is the UTF-8 character (in native or \fI\\u\fP form)
to print after the number. The default is \f(CB)\fP.
-
-- '\f(CBa\fP' (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
-.br
-where \fBy\fP is '\f(CBleft\fP' (or one of its prefixes) if the number
+.
+.TP
+\f(CBa\fP (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
+Here \fBy\fP is '\f(CBleft\fP' (or one of its prefixes) if the number
must be \fIleft\fP aligned, or '\f(CBright\fP' (or one of its prefixes)
if it must be \fIright\fP aligned. The default is \f(CBright\fP.
-
-- '\f(CBp\fP' (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
-.br
-where \fBy\fP is '\f(CBincluded\fP' (or one of its prefixes)
+.
+.TP
+\f(CBp\fP (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
+Here \fBy\fP is '\f(CBincluded\fP' (or one of its prefixes)
or '\f(CBall\fP' (or one of its prefixes) for the initial \fIp\fPadding of
the non numbered words. '\f(CBincluded\fP' means that only \fIincluded\fP
word will be padded while '\f(CBall\fP' means pad \fIall\fP words. The
default is \f(CBall\fP.
-
-- '\f(CBw\fP' (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
-.br
-where \fBy\fP is the \fIw\fPidth of the number between 1 and 5 included.
-
-- '\f(CBf\fP' (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
-.br
-where \fBy\fP controls if the numbering must \fIf\fPollow the last
+.
+.TP
+\f(CBw\fP (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
+Here \fBy\fP is the \fIw\fPidth of the number between 1 and 5 included.
+.
+.TP
+\f(CBf\fP (\fB-F\fP, \fB-N\fP and \fB-U\fP options)
+Here \fBy\fP controls if the numbering must \fIf\fPollow the last
extracted number (defaults to \f(CByes\fP) or if it must remain
independant.
-
-- '\f(CBo\fP' (\fB-F\fP option)
-.br
-where \fBy\fP is the \fIo\fPffset of the first multibyte character of
+.
+.TP
+\f(CBo\fP (\fB-F\fP option)
+Here \fBy\fP is the \fIo\fPffset of the first multibyte character of
the number to extract from the word (defaults to \f(CB0\fP).
-
-- '\f(CBn\fP' (\fB-F\fP option)
-.br
-where \fBy\fP is the \fIn\fPumber of multibyte characters to extract
+.
+.TP
+\f(CBn\fP (\fB-F\fP option)
+Here \fBy\fP is the \fIn\fPumber of multibyte characters to extract
from the word starting at the offset given by the \f(CBo\fP sub-option.
-
-- '\f(CBi\fP' (\fB-F\fP option)
-.br
-where \fBy\fP is number of multibyte characters to \fIi\fPgnore after
+.
+.TP
+\f(CBi\fP (\fB-F\fP option)
+Here \fBy\fP is number of multibyte characters to \fIi\fPgnore after
the extracted number
-
+.P
Example: \f(CWr:\\> l:\\< a:l\fP
To number all words with the default parameters, use the
@@ -724,6 +724,7 @@ added in front of excluded words or not to improve compactness.
When the \f(CBw\fP sub-option is not given the width of the numbers is
determined automatically but if \fB-F\fP is set and the value of the
\f(CBn\fP sub-option is given then this value is used.
+.RE
.IP "\fB-1\fP ... \fB-5\fP \fIregex\fP [\fIATTR\fP]"
Allows to give up to 5 classes of words specified by regular expressions
a special display color.