commit 39ed8650438bf1f955d80136f65556f3654be3a4
parent 0de4700002e610c9498797e8b7f1724bb2d701f9
Author: Benno Schulenberg <bensberg@telfort.nl>
Date: Thu, 19 Mar 2020 13:10:28 +0100
docs: improve the descriptions of --softwrap and 'set softwrap'
Diffstat:
4 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/doc/nano.1 b/doc/nano.1
@@ -324,9 +324,10 @@ Make Ctrl+Right stop at word ends instead of beginnings.
Allow the user to suspend the editor (with \fB^Z\fR by default).
.TP
.BR \-$ ", " \-\-softwrap
-Enable 'soft wrapping'. This will make \fBnano\fP attempt to display the
-entire contents of any line, even if it is longer than the screen width, by
-continuing it over multiple screen lines. Since
+Display lines that exceed the screen's width over multiple screen lines.
+(You can make this soft-wrapping occur at whitespace instead of rudely at
+the screen's edge, by using also \fB\-\-atblanks\fR.)
+Since
\&'$' normally refers to a variable in the Unix shell, you should specify
this option last when using other options (e.g.\& 'nano \-wS$') or pass it
separately (e.g.\& 'nano \-wS \-$').
diff --git a/doc/nano.texi b/doc/nano.texi
@@ -462,9 +462,10 @@ keystroke (usually @kbd{^Z}).
@item -$
@itemx --softwrap
-Enable 'soft wrapping'. This will make @command{nano} attempt to display the
-entire contents of any line, even if it is longer than the screen width, by
-continuing it over multiple screen lines. Since
+Display lines that exceed the screen's width over multiple screen lines.
+(You can make this soft-wrapping occur at whitespace instead of rudely at
+the screen's edge, by using also @code{--atblanks}.)
+Since
@code{$} normally refers to a variable in the Unix shell, you should specify
this option last when using other options (e.g.@: @code{nano -wS$}) or pass it
separately (e.g.@: @code{nano -wS -$}).
@@ -934,7 +935,9 @@ Deprecated option since it has become the default setting.
When needed, use @code{unset jumpyscrolling} instead.
@item set softwrap
-Enable soft line wrapping for easier viewing of very long lines.
+Display lines that exceed the screen's width over multiple screen lines.
+(You can make this soft-wrapping occur at whitespace instead of rudely at
+the screen's edge, by using also @code{set atblanks}.)
@item set speller "@var{program} [@var{argument} @dots{}]"
Use the given program to do spell checking and correcting.
diff --git a/doc/nanorc.5 b/doc/nanorc.5
@@ -267,7 +267,9 @@ Deprecated option since it has become the default setting.
When needed, use \fBunset jumpyscrolling\fR instead.
.TP
.B set softwrap
-Enable soft line wrapping for easier viewing of very long lines.
+Display lines that exceed the screen's width over multiple screen lines.
+(You can make this soft-wrapping occur at whitespace instead of rudely at
+the screen's edge, by using also \fBset atblanks\fR.)
.TP
.B set speller """\fIprogram\fR [\fIargument \fR...]\fB"""
Use the given \fIprogram\fR to do spell checking and correcting, instead of
diff --git a/doc/sample.nanorc.in b/doc/sample.nanorc.in
@@ -142,7 +142,7 @@
## beginning of the line.
# set smarthome
-## Enable soft line wrapping (AKA full-line display).
+## Spread overlong lines over multiple screen lines.
# set softwrap
## Use this spelling checker instead of the internal one. This option
