From 32ee39e44acf3db42b3e7836a6a81fafc61e6d97 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Wed, 27 May 2020 11:10:04 +0200 Subject: [PATCH] docs: document the --indicator (-q) and 'set indicator' options --- doc/nano.1 | 5 +++++ doc/nano.texi | 11 +++++++++++ doc/nanorc.5 | 5 +++++ doc/sample.nanorc.in | 3 +++ syntax/nanorc.nanorc | 2 +- 5 files changed, 25 insertions(+), 1 deletion(-) diff --git a/doc/nano.1 b/doc/nano.1 index f88d6754..aa7d519c 100644 --- a/doc/nano.1 +++ b/doc/nano.1 @@ -280,6 +280,11 @@ similar to a chroot. Preserve the XON and XOFF sequences (\fB^Q\fR and \fB^S\fR) so they will be caught by the terminal. .TP +.BR \-q ", " \-\-indicator +Display a "scrollbar" on the righthand side of the edit window. +It shows the position of the viewport in the buffer +and how much of the buffer is covered by the viewport. +.TP .BR \-r\ \fInumber ", " \-\-fill= \fInumber Set the target width for justifying and automatic hard-wrapping at this \fInumber\fR of columns. If the value is 0 or less, wrapping will occur diff --git a/doc/nano.texi b/doc/nano.texi index 2e6b647e..cadfa92a 100644 --- a/doc/nano.texi +++ b/doc/nano.texi @@ -392,6 +392,12 @@ similar to a chroot. Preserve the @kbd{^Q} (XON) and @kbd{^S} (XOFF) sequences so data being sent to the editor can be stopped and started. +@item -q +@itemx --indicator +Display a "scrollbar" on the righthand side of the edit window. +It shows the position of the viewport in the buffer +and how much of the buffer is covered by the viewport. + @item -r @var{number} @itemx --fill=@var{number} Set the target width for justifying and automatic hard-wrapping at this @@ -881,6 +887,11 @@ The cursor position is remembered for the 200 most-recently edited files. @item set preserve Preserve the XON and XOFF keys (@kbd{^Q} and @kbd{^S}). +@item set indicator +Display a "scrollbar" on the righthand side of the edit window. +It shows the position of the viewport in the buffer +and how much of the buffer is covered by the viewport. + @item set punct "@var{characters}" Set the characters treated as closing punctuation when justifying paragraphs. This may not include blank characters. Only the diff --git a/doc/nanorc.5 b/doc/nanorc.5 index 59a6d838..f938796b 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -147,6 +147,11 @@ text. (The color of the stripe can be changed with \fBset stripecolor\fR.) Save the last hundred search strings and replacement strings and executed commands, so they can be easily reused in later sessions. .TP +.B set indicator +Display a "scrollbar" on the righthand side of the edit window. +It shows the position of the viewport in the buffer +and how much of the buffer is covered by the viewport. +.TP .B set jumpyscrolling Scroll the buffer contents per half-screen instead of per line. .TP diff --git a/doc/sample.nanorc.in b/doc/sample.nanorc.in index 5b570a19..1007711b 100644 --- a/doc/sample.nanorc.in +++ b/doc/sample.nanorc.in @@ -59,6 +59,9 @@ ## Remember the used search/replace strings for the next session. # set historylog +## Display a "scrollbar" on the righthand side of the edit window. +# set indicator + ## Scroll the buffer contents per half-screen instead of per line. # set jumpyscrolling diff --git a/syntax/nanorc.nanorc b/syntax/nanorc.nanorc index 01a679b0..b6482540 100644 --- a/syntax/nanorc.nanorc +++ b/syntax/nanorc.nanorc @@ -7,7 +7,7 @@ comment "#" color brightred ".*" # Keywords -color brightgreen "^[[:space:]]*(set|unset)[[:space:]]+(afterends|allow_insecure_backup|atblanks|autoindent|backup|backwards|boldtext|breaklonglines|casesensitive|constantshow|cutfromcursor|emptyline|finalnewline|historylog|jumpyscrolling|linenumbers|locking|morespace|mouse|multibuffer|noconvert|nohelp|nopauses|nonewlines|nowrap|positionlog|preserve|quickblank|quiet|rawsequences|rebinddelete|regexp|saveonexit|showcursor|smarthome|smooth|softwrap|suspendable|tabstospaces|trimblanks|unix|view|wordbounds|zap)\>" +color brightgreen "^[[:space:]]*(set|unset)[[:space:]]+(afterends|allow_insecure_backup|atblanks|autoindent|backup|backwards|boldtext|breaklonglines|casesensitive|constantshow|cutfromcursor|emptyline|finalnewline|historylog|indicator|jumpyscrolling|linenumbers|locking|morespace|mouse|multibuffer|noconvert|nohelp|nopauses|nonewlines|nowrap|positionlog|preserve|quickblank|quiet|rawsequences|rebinddelete|regexp|saveonexit|showcursor|smarthome|smooth|softwrap|suspendable|tabstospaces|trimblanks|unix|view|wordbounds|zap)\>" color yellow "^[[:space:]]*set[[:space:]]+((error|function|key|number|selected|status|stripe|title)color)[[:space:]]+(bright)?(white|black|red|blue|green|yellow|magenta|cyan|normal)?(,(white|black|red|blue|green|yellow|magenta|cyan|normal))?\>" color brightgreen "^[[:space:]]*set[[:space:]]+(backupdir|brackets|errorcolor|functioncolor|keycolor|matchbrackets|numbercolor|operatingdir|punct|quotestr|selectedcolor|speller|statuscolor|stripecolor|titlecolor|whitespace|wordchars)[[:space:]]+" color brightgreen "^[[:space:]]*set[[:space:]]+(fill[[:space:]]+-?[[:digit:]]+|(guidestripe|tabsize)[[:space:]]+[1-9][0-9]*)\>"