commit 2eb1960523a622caecf814ae209e42b7da8608d5
parent 4bf650f02127146fcd684b91ac8f65aca405e170
Author: Benno Schulenberg <bensberg@telfort.nl>
Date: Wed, 23 Jan 2019 19:57:17 +0100
docs: mention that 'quotestr' enables the rewrapping of comment blocks
Inspired-by: David Griffith <dave@661.org>
Diffstat:
4 files changed, 20 insertions(+), 15 deletions(-)
diff --git a/doc/nano.1 b/doc/nano.1
@@ -126,9 +126,10 @@ and place it at that position again upon reopening such a file.
.TP
.BR "\-Q ""\fIregex\fB""" ", " "\-\-quotestr=""" \fIregex """
Set the regular expression for matching the quoting part of a line.
-This is used when justifying.
The default value is \fB"^([\ \\t]*([!#%:;>|}]|//|--))+"\fP.
-Note that \fB\\t\fP stands for an actual Tab.
+(Note that \fB\\t\fP stands for an actual Tab.)
+This makes it possible to rejustify blocks of quoted text when composing
+email, and to rewrap blocks of line comments when writing source code.
.TP
.BR \-R ", " \-\-restricted
Restricted mode: don't read or write to any file not specified on the
diff --git a/doc/nano.texi b/doc/nano.texi
@@ -221,9 +221,11 @@ and place it at that position again upon reopening such a file.
@item -Q "@var{regex}"
@itemx --quotestr="@var{regex}"
-Set the regular expression for matching the quoting part of a line, used
-when justifying. The default value is @t{"^([@w{ }\t]*([!#%:;>|@}]|//|--))+"}.
-Note that @code{\t} stands for a literal Tab character.
+Set the regular expression for matching the quoting part of a line.
+The default value is @t{"^([@w{ }\t]*([!#%:;>|@}]|//|--))+"}.
+(Note that @code{\t} stands for a literal Tab character.)
+This makes it possible to rejustify blocks of quoted text when composing
+email, and to rewrap blocks of line comments when writing source code.
@item -R
@itemx --restricted
@@ -830,10 +832,11 @@ Do quick status-bar blanking: status-bar messages will disappear after 1
keystroke instead of 25. Note that @option{constantshow} overrides this.
@item set quotestr "@var{regex}"
-The email-quote string, used to justify email-quoted paragraphs. This
-is an extended regular expression. The default value is
-@t{"^([@w{ }\t]*([!#%:;>|@}]|//|--))+"}.
-Note that @code{\t} stands for a literal Tab character.
+Set the regular expression for matching the quoting part of a line.
+The default value is @t{"^([@w{ }\t]*([!#%:;>|@}]|//|--))+"}.
+(Note that @code{\t} stands for a literal Tab character.)
+This makes it possible to rejustify blocks of quoted text when composing
+email, and to rewrap blocks of line comments when writing source code.
@item set rawsequences
Interpret escape sequences directly (instead of asking @code{ncurses} to
diff --git a/doc/nanorc.5 b/doc/nanorc.5
@@ -196,10 +196,11 @@ Do quick status-bar blanking: status-bar messages will disappear after 1
keystroke instead of 25. The option \fBconstantshow\fR overrides this.
.TP
.B set quotestr "\fIregex\fP"
-The email-quote string, used to justify email-quoted paragraphs. This
-is an extended regular expression. The default value is
-"\fB^([\ \\t]*([!#%:;>|}]|//|--))+\fP". Note that \fB\\t\fR stands for an actual
-Tab character.
+Set the regular expression for matching the quoting part of a line.
+The default value is "\fB^([\ \\t]*([!#%:;>|}]|//|--))+\fP".
+(Note that \fB\\t\fR stands for an actual Tab character.)
+This makes it possible to rejustify blocks of quoted text when composing
+email, and to rewrap blocks of line comments when writing source code.
.TP
.B set rawsequences
Interpret escape sequences directly (instead of asking \fBncurses\fR to
diff --git a/doc/sample.nanorc.in b/doc/sample.nanorc.in
@@ -122,8 +122,8 @@
## 1 keystroke instead of 26. Note that "constantshow" overrides this.
# set quickblank
-## The email-quote string, used to justify email-quoted paragraphs.
-## This is an extended regular expression. The default is:
+## The regular expression that matches quoting characters in email
+## or line-comment introducers in source code. The default is:
# set quotestr "^([ ]*([!#%:;>|}]|//|--))+"
## Try to work around a mismatching terminfo terminal description.
