summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpgen <p.gen.progs@gmail.com>2018-02-23 09:15:21 +0100
committerpgen <p.gen.progs@gmail.com>2018-03-01 00:07:14 +0100
commit79d2f544ddd0601ee5b39727ff5ca2c7ecd2a40b (patch)
treec356ba1102556c9b52e7c919b38f5d392aaaa653
parent4c005f8731d54a520590d6a07495fdebb1df6363 (diff)
Fix and improve the manual
-rw-r--r--smenu.127
1 files changed, 14 insertions, 13 deletions
diff --git a/smenu.1 b/smenu.1
index 553d4d8..48cf361 100644
--- a/smenu.1
+++ b/smenu.1
@@ -102,21 +102,21 @@ used to initiate a search by prefix among the words (possibly altered
by \fB-S\fP/\fB-I\fP/\fB-E\fP) located after the cursor.
.PP
After that, the cursor attributes are modified and all the characters
-entered up to 7s after this change are put in a search buffer and the cursor
-moves immediately to the next word matching this prefix.
+entered up to a default of 6s after this change are put in a search buffer
+and the cursor moves immediately to the next word matching this prefix.
.PP
-Any character entered before a 5s timeout after this action completes
-this buffer and resets the 5s timer and advances the cursor again if
-another word matches the new buffer.
+Any character entered before a default of 6s timeout after this action
+completes this buffer and resets the the 6s timer and advances the cursor
+again if another word matches the new buffer.
.PP
-As soon as the timer ends, the search mode is ended and the cursor
+As soon as the timer expires, the search mode is ended and the cursor
regains its initial appearance.
.PP
The search buffer is persistent as long as the cursor is on a matching
word when a new search is initialized.
.PP
If the cursor is moved in this mode, the timer will expire immediately
-As if \fBENTER\fP or \fBESC\fP was pressed.
+As if \fBENTER\fP or \fBESC\fP was pressed and the move is attempted.
.PP
Pressing \fBENTER\fP or \fBESC\fP immediately exits this mode.
.PP
@@ -203,6 +203,8 @@ The values read, if valid, override the default hard-coded ones.
If a value is invalid an error message is shown and the program terminates.
+The values of the timers must be given in units of \fB1/10\fP of a second.
+
Here is an example giving the syntax and the names of the keywords
allowed:
.PP
@@ -756,16 +758,15 @@ Three types of timeout are possible:
.RS
.TP 10
current:
-On timeout, the current cursor position determines the selection as
-if the \fBENTER\fP has been pressed
+At the timeout, the word under the cursor and/or the tagged words are
+sent to the standard output if the \fBENTER\fP key has been pressed
.TP 10
quit:
-On timeout, nothing is selected as if the \fBq\fP key has been pressed
+At the timeout, nothing is selected as if the \fBq\fP key has been pressed
.TP 10
word:
-On timeout, the word given after the type is selected.
-Note that this word doesn't need to be part of the words coming from
-the standard input.
+At the timeout, the word given after the type is selected. Note that this
+word doesn't need to be part of the words coming from the standard input.
.PP
Each type can be be shortened as a prefix of the full name ("cur" for
"current" of "q" for "quit" per example).