From b14fbf719f74d0bd8de55ee06d1a2b757769a1d0 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Fri, 20 Jun 2014 18:40:34 +0000 Subject: [PATCH] Explaining better what "all" means when rebinding keys. This is a soft fix for Savannah bug #42552. git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@5002 35c25a1d-7b9e-4130-9fde-d3aeb78583b8 --- ChangeLog | 2 ++ doc/man/nanorc.5 | 23 ++++++++++++----------- doc/texinfo/nano.texi | 12 ++++++++---- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/ChangeLog b/ChangeLog index e1b531eb..a23fdb68 100644 --- a/ChangeLog +++ b/ChangeLog @@ -13,6 +13,8 @@ * src/files.c (do_insertfile): Fix compilation with --enable-tiny --enable-histories --enable-multibuffer. * src/nano.c: Fix compilation with --enable-tiny --enable-mouse. + * doc/man/nanorc.5, doc/texinfo/nano.texi: Explain better what "all" + means when rebinding keys. This is a fix for Savannah bug #42552. 2014-06-19 Benno Schulenberg * src/nano.c (window_init): Rename 'no_more_space()' to 'more_space()' diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index ee604ce7..ffc36398 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -53,7 +53,7 @@ The supported commands and arguments are: .TP 3 .B set/unset allow_insecure_backup When backing up files, allow the backup to succeed even if its permissions -can't be (re)set due to special OS considerations. You should +can't be (re)set due to special OS considerations. You should NOT enable this option unless you are sure you need it. .TP .B set/unset autoindent @@ -219,7 +219,7 @@ Allow \fBnano\fP to be suspended. .TP .B set tabsize \fIn\fP Use a tab size of \fIn\fP columns. The value of \fIn\fP must be greater -than 0. The default value is 8. +than 0. The default value is 8. .TP .B set/unset tabstospaces Convert typed tabs to spaces. @@ -272,11 +272,11 @@ be compared against the very first line of the file to be edited, to determine whether this syntax should be used for that file. .TP .BR magic " [""\fIregex\fR"" ...] -For the currently defined syntax, add one or more regexes which +For the currently defined syntax, add one or more regexes which will be compared against the result of querying the \fBmagic\fP database about the file to be edited, to determine whether this syntax should be used for that file. This -functionality only works when \fBlibmagic\fP is installed on the +functionality only works when \fBlibmagic\fP is installed on the system and will be silently ignored otherwise. .TP .B color \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... @@ -322,25 +322,24 @@ Key bindings may be reassigned via the following commands: .TP .BI bind " key function menu" Rebinds the key \fIkey\fP to a new function named \fIfunction\fP in the -context of menu \fImenu\fP (or in all menus where the function exists -by using \fBall\fP). +context of menu \fImenu\fP (or in all menus by using \fBall\fP). .TP .BI unbind " key menu" -Unbinds the key \fIkey\fP from the menu named \fImenu\fP (or from all +Unbinds the key \fIkey\fP from the menu named \fImenu\fP (or from all menus where it exists by using \fBall\fP). .TP The format of \fIkey\fP should be one of: .TP -.B ^ +.B ^ followed by an alpha character or the word "Space". Example: ^C .TP -.B M- +.B M- followed by a printable character or the word "Space". Example: M-C .TP -.B F +.B F followed by a numeric value from 1 to 16. Example: F10 .TP @@ -644,7 +643,9 @@ The 'search for a file' menu in the file browser. The 'go to directory' menu in the file browser. .TP .B all -A special name meaning: apply to all menus where this function exists. +A special name that encompasses all menus. For rebinding keys, it really +means all menus (which may have unobvious effects, so use it carefully); +for unbinding keys, it just means all the menus where the key exists. .SH FILES .TP diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi index 0a1f5551..40fc42fc 100644 --- a/doc/texinfo/nano.texi +++ b/doc/texinfo/nano.texi @@ -843,10 +843,10 @@ nanorc file: @item bind key function menu Rebinds @code{key} to @code{function} in the context of @code{menu} -(or in all menus where the function exists by using @code{all}). +(or in all menus by using @code{all}). @item unbind key menu -Unbinds @code{key} from the specified @code{menu} +Unbinds @code{key} from @code{menu} (or from all menus where it exists by using @code{all}). @end table @@ -1171,7 +1171,9 @@ The 'search for a file' menu in the file browser. The 'go to directory' menu in the file browser. @item all -A special name meaning: apply to all menus where this function exists. +A special name that encompasses all menus. For rebinding keys, it really +means all menus (which may have unobvious effects, so use it carefully); +for unbinding keys, it just means all the menus where the key exists. @end table @@ -1282,7 +1284,9 @@ things about using the editor. @item --disable-histories Disable the code for the handling of the history files: the search and replace strings that were used, and the cursor position at which each -file was closed. +file was closed. This also eliminates the -H and -P command-line +options, which switch on the logging of search/replace strings and +cursor positions. @item --disable-justify Disable the justify and unjustify functions.