From c923fa7c61baa874b43fa6ffd0e4565d38aced20 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@justemail.net>
Date: Fri, 20 Jun 2014 15:56:31 +0000
Subject: [PATCH] History logging is no longer dependent upon nanorc support,
plus many other documentation tweaks.
git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@4997 35c25a1d-7b9e-4130-9fde-d3aeb78583b8
---
ChangeLog | 2 ++
doc/man/nano.1 | 24 ++++++++++++------------
doc/man/nanorc.5 | 2 +-
doc/texinfo/nano.texi | 38 ++++++++++++++++++++++----------------
4 files changed, 37 insertions(+), 29 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 1b8e1acf..db0d1067 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -5,6 +5,8 @@
the name that is not a directory.
* src/*: Miscellaneous whitespace adjustments and comment tweaks.
* src/files.c: Fix compilation with --enable-tiny --enable-browser.
+ * doc/man/nano.1, doc/texinfo/nano.texi: History logging no longer
+ depends upon nanorc support, plus many other tweaks.
2014-06-19 Benno Schulenberg <bensberg@justemail.net>
* src/nano.c (window_init): Rename 'no_more_space()' to 'more_space()'
diff --git a/doc/man/nano.1 b/doc/man/nano.1
index 0e93cb76..8ea9bde5 100644
--- a/doc/man/nano.1
+++ b/doc/man/nano.1
@@ -75,11 +75,10 @@ Enable vim-style file locking when editing files.
.TP
.B \-H (\-\-historylog)
Log search and replace strings to \fI~/.nano/search_history\fP, so they can be
-retrieved in later sessions (if \fInanorc\fP support has been compiled in).
+retrieved in later sessions.
.TP
.B \-I (\-\-ignorercfiles)
-Don't look at the system's \fBnanorc\fP nor at \fB~/.nanorc\fP
-(if \fInanorc\fP support has been compiled in).
+Don't look at the system's \fBnanorc\fP nor at \fB~/.nanorc\fP.
.TP
.B \-K (\-\-rebindkeypad)
Interpret the numeric keypad keys so that they all work properly. You
@@ -107,10 +106,11 @@ Tab.
.TP
.B \-R (\-\-restricted)
Restricted mode: don't read or write to any file not specified on the
-command line; don't read any \fInanorc\fP files; don't allow suspending;
+command line; don't read any \fInanorc\fP files nor history files;
+don't allow suspending nor spell checking;
don't allow a file to be appended to, prepended to, or saved under a
-different name if it already has one; don't use backup files nor spell
-checking. This restricted mode is also accessible by invoking \fBnano\fP
+different name if it already has one; and don't use backup files.
+This restricted mode is also accessible by invoking \fBnano\fP
with any name beginning with 'r' (e.g. "rnano").
.TP
.B \-S (\-\-smooth)
@@ -132,9 +132,9 @@ Show the current version number and exit.
Detect word boundaries more accurately by treating punctuation
characters as part of a word.
.TP
-.B \-Y \fIstr\fP (\-\-syntax=\fIstr\fP)
-Specify a specific syntax highlighting from the \fInanorc\fP to use, if
-available.
+.B \-Y \fIname\fP (\-\-syntax=\fIname\fP)
+Specify the name of the syntax highlighting to use from among the ones
+defined in the \fInanorc\fP files.
.TP
.B \-c (\-\-const)
Constantly show the cursor position. Note that this overrides \fB\-U\fP.
@@ -175,15 +175,15 @@ and will write to the pipe when the user saves the "file". This way
\fBgpg\fR without having to write sensitive data to disk first.
.TP
.B \-o \fIdir\fP (\-\-operatingdir=\fIdir\fP)
-Set operating directory. Makes \fBnano\fP set up something similar to a
-chroot.
+Set the operating directory. This makes \fBnano\fP set up something
+similar to a chroot.
.TP
.B \-p (\-\-preserve)
Preserve the XON and XOFF sequences (^Q and ^S) so they will be caught
by the terminal.
.TP
.B \-q (\-\-quiet)
-Do not report errors in the \fInanorc\fP file nor ask them to be
+Do not report errors in the \fInanorc\fP files nor ask them to be
acknowledged by pressing Enter at startup.
.TP
.B \-r \fInumber\fP (\-\-fill=\fInumber\fP)
diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5
index 16cc0149..ee604ce7 100644
--- a/doc/man/nanorc.5
+++ b/doc/man/nanorc.5
@@ -169,7 +169,7 @@ keystroke instead of 25.
.TP
.B set/unset quiet
\fBnano\fP will not report errors in the \fInanorc\fP file nor ask them
-to be acknowledged by pressing Enter at startup. If this is used it
+to be acknowledged by pressing Enter at startup. If this is used, it
should be placed at the top of the file to be fully effective.
.TP
.B set quotestr "\fIstring\fP"
diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi
index 91c1f849..0a1f5551 100644
--- a/doc/texinfo/nano.texi
+++ b/doc/texinfo/nano.texi
@@ -155,11 +155,10 @@ Enable vim-style file locking when editing files.
@item -H, --historylog
Log search and replace strings to ~/.nano/search_history, so they can be
-retrieved in later sessions (if nanorc support has been compiled in).
+retrieved in later sessions.
@item -I, --ignorercfiles
-Don't look at the system's nanorc file nor at the user's ~/.nanorc
-(if nanorc support has been compiled in).
+Don't look at the system's nanorc file nor at the user's ~/.nanorc.
@item -K, --rebindkeypad
Interpret the numeric keypad keys so that they all work properly. You
@@ -176,8 +175,8 @@ Disable automatic conversion of files from DOS/Mac format.
Use the blank line below the titlebar as extra editing space.
@item -P, --poslog
-Log and later read back the location of the cursor and place it
-there again.
+Log for each file the last location of the cursor, and read it
+back upon reopening the file and place it there again.
@item -Q <str>, --quotestr=<str>
Set the quoting string for justifying. The default value is
@@ -191,9 +190,10 @@ Note that @code{\t} above stands for a literal Tab character.
@item -R, --restricted
Restricted mode: don't read or write to any file not specified on the
-command line; don't read any nanorc files; don't allow suspending; don't
+command line; don't read any nanorc files nor history files; don't allow
+suspending nor spell checking; don't
allow a file to be appended to, prepended to, or saved under a different
-name if it already has one; don't use backup files nor spell checking.
+name if it already has one; and don't use backup files.
This restricted mode is also accessible by invoking @code{nano} with
any name beginning with 'r' (e.g. "rnano").
@@ -216,9 +216,9 @@ Show the current version number and exit.
Detect word boundaries more accurately by treating punctuation
characters as parts of words.
-@item -Y <str>, --syntax=<str>
-Specify a specific syntax from the nanorc to use for highlighting, if
-available. See @xref{Syntax Highlighting}, for more info.
+@item -Y <name>, --syntax=<name>
+Specify a specific syntax from the nanorc files to use for highlighting.
+See @xref{Syntax Highlighting}, for more info.
@item -c, --const
Constantly display the cursor position and line number on the statusbar.
@@ -491,8 +491,8 @@ toggles the -N (@code{--noconvert}) command line option.
toggles the -O (@code{--morespace}) command line option.
@item Whitespace Display Toggle (Meta-P)
-toggles whitespace display mode if you have a "whitespace" option in
-your nanorc. See @xref{Whitespace}, for more info.
+toggles whitespace-display mode.
+See @xref{Whitespace}, for more info.
@item Tabs to Spaces Toggle (Meta-Q)
toggles the -E (@code{--tabstospaces}) command line option.
@@ -1267,7 +1267,8 @@ The possible options to @code{./configure} are:
Disable the mini file browser when reading or writing files.
@item --disable-color
-Disable support for syntax coloring of files using the nanorc file.
+Disable support for the syntax coloring of files. This also eliminates
+the -Y command-line option, which chooses a specific syntax.
@item --disable-extra
Disable extra features. At the moment, this is just easter-egg-type
@@ -1297,13 +1298,16 @@ command-line option, which enables the mouse functionality.
@item --disable-multibuffer
Disable support for opening multiple files at a time and switching
-between them on the fly.
+between them on the fly. This also eliminates the -F command-line
+option, which switches the use of multiple file buffers on.
@item --disable-nanorc
Disable support for reading the nanorc files at startup. With such
support, you can store custom settings in a system-wide and a per-user
nanorc file rather than having to pass command-line options to get
the desired behavior. See @xref{Nanorc Files}, for more info.
+This also eliminates the -I command-line option, which inhibits the
+reading of these nanorcfiles.
@item --disable-operatingdir
Disable setting the operating directory. This also eliminates the -o
@@ -1323,14 +1327,16 @@ command-line option, which enables long-line wrapping.
@item --enable-tiny
This option disables all the above. It also disables some of the larger
internals of the editor, like the marking code and the cut-to-end-of-line
-code. It also disables the function toggles.
+code. It also disables the function toggles. By using the enabling
+counterpart of the above options together with --enable-tiny, specific
+features can be switched back on.
@item --enable-debug
Enable support for runtime debug output. This can get pretty messy, so
chances are you only want this feature when you're working on the nano source.
@item --disable-nls
-Disables Native Language support. This will disable use of the
+Disables Native Language support. This will disable the use of any
available GNU @code{nano} translations.
@item --disable-wrapping-as-root
--
GitLab