commit 52d4b9663946d60ed21e31eca4b1fca325fb0b84
parent 83f94a88df276b712a553c95bde1fd2a43c15dc3
Author: Benno Schulenberg <bensberg@telfort.nl>
Date: Sun, 31 Oct 2021 10:41:28 +0100
docs: mark options -z, --suspendable, and 'set suspendable' as obsolete
Diffstat:
5 files changed, 9 insertions(+), 27 deletions(-)
diff --git a/doc/nano.1 b/doc/nano.1
@@ -328,7 +328,7 @@ Don't show the two help lines at the bottom of the screen.
Make Ctrl+Right and Ctrl+Delete stop at word ends instead of beginnings.
.TP
.BR \-z ", " \-\-suspendable
-Allow the user to suspend the editor (with \fB^Z\fR by default).
+Obsolete option. Ignored. Suspension is enabled by default.
.TP
.BR \-% ", " \-\-stateflags
Use the top-right corner of the screen for showing some state flags:
diff --git a/doc/nano.texi b/doc/nano.texi
@@ -671,8 +671,7 @@ instead of beginnings.
@item -z
@itemx --suspendable
-Enable the ability to suspend @command{nano} using the system's suspend
-keystroke (usually @kbd{^Z}).
+Obsolete option. Ignored. Suspension is enabled by default.
@item -%
@itemx --stateflags
@@ -757,9 +756,6 @@ for more details). The following global toggles are available:
@kbd{M-Y} toggles color syntax highlighting, when your nanorc defines syntaxes
(@pxref{Syntax Highlighting}).
-@item Suspension
-@kbd{M-Z} toggles the @option{-z} (@option{--suspendable}) command-line option.
-
@end table
@@ -1097,7 +1093,7 @@ Use this color combination for the vertical guiding stripe.
@xref{@code{set keycolor}} for valid color names.
@item set suspendable
-Allow @command{nano} to be suspended (with @kbd{^Z} by default).
+Obsolete option. Ignored. Suspension is enabled by default.
@item set tabsize @var{number}
Use a tab size of @var{number} columns. The value of @var{number} must be
@@ -1584,8 +1580,8 @@ Redoes the last undone action (i.e., it undoes an undo).
Refreshes the screen.
@item suspend
-Suspends the editor (if the suspending function is enabled, see the
-@code{suspendable} toggle item below).
+Suspends the editor and returns control to the shell
+(until you tell the process to resume execution with @kbd{fg}).
@item casesens
Toggles whether searching/replacing ignores or respects the case of
@@ -1700,11 +1696,6 @@ Toggles whether typed tabs will be converted to spaces.
@item mouse
Toggles mouse support.
-@item suspendable
-Toggles whether the suspend keystroke (@kbd{^Z} by default)
-will actually suspend the editor.
-(The old name of this function, 'suspendenable', is deprecated.)
-
@end table
@sp 1
diff --git a/doc/nanorc.5 b/doc/nanorc.5
@@ -339,7 +339,7 @@ Use this color combination for the vertical guiding stripe.
See \fBset titlecolor\fR for more details.
.TP
.B set suspendable
-Allow \fBnano\fP to be suspended (with \fB^Z\fR by default).
+Obsolete option. Ignored. Suspension is enabled by default.
.TP
.B set tabsize \fInumber\fR
Use a tab size of \fInumber\fR columns. The value of \fInumber\fP must be
@@ -819,8 +819,8 @@ Redoes the last undone action (i.e., it undoes an undo).
Refreshes the screen.
.TP
.B suspend
-Suspends the editor (if the suspending function is enabled, see the
-\fBsuspendable\fR toggle item below).
+Suspends the editor and returns control to the shell
+(until you tell the process to resume execution with \fBfg\fR).
.TP
.B casesens
Toggles whether searching/replacing ignores or respects the case of
@@ -934,11 +934,6 @@ Toggles whether typed tabs will be converted to spaces.
.TP
.B mouse
Toggles mouse support.
-.TP
-.B suspendable
-Toggles whether the suspend keystroke (\fB^Z\fR by default)
-will actually suspend the editor.
-(The old name of this function, 'suspendenable', is deprecated.)
.RE
.TP
diff --git a/doc/sample.nanorc.in b/doc/sample.nanorc.in
@@ -167,10 +167,6 @@
## M = mark, L = hard-wrapping long lines, R = recording, S = soft-wrapping.
# set stateflags
-## Allow nano to be suspended (with ^Z by default).
-# set suspendable
-## (The old form of this option, 'set suspend', is deprecated.)
-
## Use this tab size instead of the default; it must be greater than 0.
# set tabsize 8
diff --git a/syntax/nanorc.nanorc b/syntax/nanorc.nanorc
@@ -10,7 +10,7 @@ color brightred ".*"
color yellow "^[[:blank:]]*(i?color|set[[:blank:]]+((error|function|key|mini|number|prompt|scroller|selected|spotlight|status|stripe|title)color))[[:blank:]]+(bold,)?(italic,)?(((bright|light)?(white|black|red|blue|green|yellow|magenta|cyan))|normal|pink|purple|mauve|lagoon|mint|lime|peach|orange|latte|grey|gray)?(,(((light)?(white|black|red|blue|green|yellow|magenta|cyan))|normal|pink|purple|mauve|lagoon|mint|lime|peach|orange|latte|grey|gray))?\>"
# Keywords
-color brightgreen "^[[:blank:]]*(set|unset)[[:blank:]]+(afterends|allow_insecure_backup|atblanks|autoindent|backup|boldtext|bookstyle|breaklonglines|casesensitive|constantshow|cutfromcursor|emptyline|historylog|indicator|jumpyscrolling|linenumbers|locking|magic|minibar|mouse|multibuffer|noconvert|nohelp|nonewlines|positionlog|preserve|quickblank|rawsequences|rebinddelete|regexp|saveonexit|showcursor|smarthome|softwrap|stateflags|suspendable|tabstospaces|trimblanks|unix|wordbounds|zap)\>"
+color brightgreen "^[[:blank:]]*(set|unset)[[:blank:]]+(afterends|allow_insecure_backup|atblanks|autoindent|backup|boldtext|bookstyle|breaklonglines|casesensitive|constantshow|cutfromcursor|emptyline|historylog|indicator|jumpyscrolling|linenumbers|locking|magic|minibar|mouse|multibuffer|noconvert|nohelp|nonewlines|positionlog|preserve|quickblank|rawsequences|rebinddelete|regexp|saveonexit|showcursor|smarthome|softwrap|stateflags|tabstospaces|trimblanks|unix|wordbounds|zap)\>"
color brightgreen "^[[:blank:]]*set[[:blank:]]+(backupdir|brackets|errorcolor|functioncolor|keycolor|matchbrackets|minicolor|numbercolor|operatingdir|promptcolor|punct|quotestr|scrollercolor|selectedcolor|speller|spotlightcolor|statuscolor|stripecolor|titlecolor|whitespace|wordchars)[[:blank:]]+"
color brightgreen "^[[:blank:]]*set[[:blank:]]+(fill[[:blank:]]+-?[[:digit:]]+|(guidestripe|tabsize)[[:blank:]]+[1-9][0-9]*)\>"
color brightgreen "^[[:blank:]]*bind[[:blank:]]+((\^([A-Za-z]|[]/@\^_`-]|Space)|([Ss][Hh]-)?[Mm]-[A-Za-z]|[Mm]-([][!"#$%&'()*+,./0-9:;<=>?@\^_`{|}~-]|Space))|F([1-9]|1[0-9]|2[0-4])|Ins|Del)[[:blank:]]+([a-z]+|".*")[[:blank:]]+(main|help|search|replace(with)?|yesno|gotoline|writeout|insert|browser|whereisfile|gotodir|execute|spell|linter|all)([[:blank:]]+#|[[:blank:]]*$)"