commit 6fe132194c08910819261bad448e03ab29cb48c0
parent 0ea434b00637e4978d5cc5f8523399227bc29b51
Author: Benno Schulenberg <bensberg@telfort.nl>
Date: Wed, 30 May 2018 10:19:57 +0200
docs: improve the description of the --autoindent option
Diffstat:
4 files changed, 21 insertions(+), 9 deletions(-)
diff --git a/doc/nano.1 b/doc/nano.1
@@ -187,8 +187,9 @@ highlighted item. Useful for braille users.
Show a summary of the available command-line options and exit.
.TP
.BR \-i ", " \-\-autoindent
-Indent new lines to the previous line's indentation. Useful when
-editing source code.
+Automatically indent a newly created line to the same number of tabs
+and/or spaces as the previous line (or as the next line if the previous
+line is the beginning of a paragraph).
.TP
.BR \-k ", " \-\-cutfromcursor
Make the 'Cut Text' command (normally \fB^K\fR) cut from the current cursor
diff --git a/doc/nano.texi b/doc/nano.texi
@@ -298,8 +298,9 @@ Show a summary of command-line options and exit.
@item -i
@itemx --autoindent
-Automatically indent new lines to the same number of spaces and tabs as
-the previous line.
+Automatically indent a newly created line to the same number of tabs
+and/or spaces as the previous line (or as the next line if the previous
+line is the beginning of a paragraph).
@item -k
@itemx --cutfromcursor
@@ -705,7 +706,9 @@ When soft line wrapping is enabled, make it wrap lines at blank characters
(tabs and spaces) instead of always at the edge of the screen.
@item set autoindent
-Use auto-indentation.
+Automatically indent a newly created line to the same number of tabs
+and/or spaces as the previous line (or as the next line if the previous
+line is the beginning of a paragraph).
@item set backup
When saving a file, back up the previous version of it, using the current
@@ -1382,7 +1385,9 @@ Toggles syntax highlighting.
Toggles the smartness of the Home key.
@item autoindent
-Toggles whether new lines will contain the same amount of whitespace as the preceding line.
+Toggles whether a newly created line will contain the same amount of leading
+whitespace as the preceding line --- or as the next line if the preceding line
+is the beginning of a paragraph.
@item cutfromcursor
Toggles whether cutting text will cut the whole line or just from the current cursor
diff --git a/doc/nanorc.5 b/doc/nanorc.5
@@ -66,7 +66,9 @@ When soft line wrapping is enabled, make it wrap lines at blank characters
(tabs and spaces) instead of always at the edge of the screen.
.TP
.B set autoindent
-Use auto-indentation.
+Automatically indent a newly created line to the same number of tabs
+and/or spaces as the previous line (or as the next line if the previous
+line is the beginning of a paragraph).
.TP
.B set backup
When saving a file, create a backup file by adding a tilde (\fB~\fP) to
@@ -735,7 +737,9 @@ Toggles syntax highlighting.
Toggles the smartness of the Home key.
.TP
.B autoindent
-Toggles whether new lines will contain the same amount of whitespace as the preceding line.
+Toggles whether a newly created line will contain the same amount of leading
+whitespace as the preceding line -- or as the next line if the preceding line
+is the beginning of a paragraph.
.TP
.B cutfromcursor
Toggles whether cutting text will cut the whole line or just from the current cursor
diff --git a/doc/sample.nanorc.in b/doc/sample.nanorc.in
@@ -23,7 +23,9 @@
## (tabs and spaces) instead of always at the edge of the screen.
# set atblanks
-## Use auto-indentation.
+## Automatically indent a newly created line to the same number of
+## tabs and/or spaces as the preceding line -- or as the next line
+## if the preceding line is the beginning of a paragraph.
# set autoindent
## Back up files to the current filename plus a tilde.
