Documenting the interface colours settings.

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@4835 35c25a1d-7b9e-4130-9fde-d3aeb78583b8

diff --git a/ChangeLog b/ChangeLog
index 1c95e0de8164f1cedf8a7d2874a0826c7a09c600..e866c315db15ecb7000ff2bba71c875a796796ab 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,8 @@
        * src/winio.c (statusbar): Elide a variable.
        * src/*: Rename the variable 'reverse_attr' to 'hilite_attribute',
        and remove an unneeded call of wattroff().
+       * doc/man/nanorc.5, doc/texinfo/nano.tex: Document the settings
+       of titlecolor, statuscolor, keycolor and functioncolor.
 
 2014-05-03  Benno Schulenberg  <bensberg@justemail.net>
        * src/*.h, src/*.c: Add the ability to colour four elements of

diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5
index 9775e81e7ab5a600cc1c319f2a17b489f44a28a5..df9673aa81d4c179526beb0ecf2efaa1cc627581 100644 (file)
--- a/doc/man/nanorc.5
+++ b/doc/man/nanorc.5
@@ -19,7 +19,7 @@
 .\"   <http://www.gnu.org/licenses/>.
 .\"
 .\" $Id$
-.TH NANORC 5 "version 2.3.3" "March 2014"
+.TH NANORC 5 "version 2.3.3" "May 2014"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .SH NAME
@@ -98,10 +98,20 @@ Hard-wrap lines at column number \fIn\fP.  If \fIn\fP is 0 or less, the
 maximum line length will be the screen width less \fIn\fP columns.  The
 default value is \-8.
 .TP
+.B set functioncolor \fIfgcolor\fR,\fIbgcolor\fR
+Specify the color combination to use for the function descriptions
+in the two help lines at the bottom of the screen.
+See \fBset titlecolor\fR for more details.
+.TP
 .B set/unset historylog
 Enable \fI~/.nano_history\fP for saving and reading search/replace
 strings.
 .TP
+.B set keycolor \fIfgcolor\fR,\fIbgcolor\fR
+Specify the color combination to use for the shortcut key combos
+in the two help lines at the bottom of the screen.
+See \fBset titlecolor\fR for more details.
+.TP
 .B set/unset locking
 Enable vim-style lock-files for when editing files.
 .TP
@@ -203,6 +213,10 @@ Enable soft line wrapping for easier viewing of very long lines.
 Use spelling checker \fIspellprog\fP instead of the built-in one, which
 calls \fIspell\fP.
 .TP
+.B set statuscolor \fIfgcolor\fR,\fIbgcolor\fR
+Specify the color combination to use for the statusbar.
+See \fBset titlecolor\fR for more details.
+.TP
 .B set/unset suspend
 Allow \fBnano\fP to be suspended.
 .TP
@@ -216,6 +230,12 @@ Convert typed tabs to spaces.
 .B set/unset tempfile
 Save automatically on exit, don't prompt.
 .TP
+.B set titlecolor \fIfgcolor\fR,\fIbgcolor\fR
+Specify the color combination to use for the titlebar.
+Valid color names for foreground and background are:
+.BR white , \ black , \ red , \ blue , \ green , \ yellow , \ magenta ", and " cyan .
+And either "\fIfgcolor\fR" or ",\fIbgcolor\fR" may be left out.
+.TP
 .B set/unset undo
 Enable experimental generic-purpose undo code.
 .TP
@@ -258,9 +278,9 @@ system and will be silently ignored otherwise.
 For the currently defined syntax, display all expressions matching
 the extended regular expression \fIregex\fP with foreground color
 \fIfgcolor\fP and background color \fIbgcolor\fP, at least one of which
-must be specified.  Legal colors for foreground and background color
+must be specified.  Valid colors for foreground and background
 are: white, black, red, blue, green, yellow, magenta, and cyan.  You may
-use the prefix "bright" to force a stronger color highlight for the
+use the prefix "bright" to get a stronger color highlight for the
 foreground.  If your terminal supports transparency, not specifying a
 \fIbgcolor\fP tells \fBnano\fP to attempt to use a transparent
 background.

diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi
index a0b7171c0db455bbabdf9a52a7e03c5d1bd21d5d..274275057c8bbc631b1d8560f6a43534e3d88795 100644 (file)
--- a/doc/texinfo/nano.texi
+++ b/doc/texinfo/nano.texi
@@ -9,7 +9,7 @@
 @smallbook
 @set EDITION 0.1
 @set VERSION 2.3.3
-@set UPDATED April 2014
+@set UPDATED May 2014
 
 @dircategory Editors
 @direntry
@@ -313,8 +313,8 @@ Enable 'soft wrapping'.  This will make @code{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
 '$' 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 -$').
+this option last when using other options (e.g. @code{nano -wS$}) or pass it
+separately (e.g. @code{nano -wS -$}).
 
 @item -a, -b, -e, -f, -g, -j
 Ignored, for compatibility with Pico.
@@ -561,10 +561,20 @@ Hard-wrap lines at column number "n".  If "n" is 0 or less, the maximum line
 length will be the screen width less "n" columns.  The default value is
 -8.
 
+@item set functioncolor fgcolor,bgcolor
+Specify the color (combination) to use for the function descriptions
+in the two help lines at the bottom of the screen.
+See "set titlecolor" for more details.
+
 @item set/unset historylog
 Enable ~/.nano_history for saving and reading search/replace strings.
 
-@ item set/unset locking
+@item set keycolor fgcolor,bgcolor
+Specify the color (combination) to use for the shortcut key combos
+in the two help lines at the bottom of the screen.
+See "set titlecolor" for more details.
+
+@item set/unset locking
 Enable vim-style lock-files for when editing files.
 
 @item set matchbrackets "string"
@@ -671,6 +681,10 @@ Enable soft line wrapping for easier viewing of very long lines.
 Use spelling checker "spellprog" instead of the built-in one, which
 calls "spell".
 
+@item set statuscolor fgcolor,bgcolor
+Specify the color (combination) to use for the statusbar.
+See "set titlecolor" for more details.
+
 @item set/unset suspend
 Allow @code{nano} to be suspended.
 
@@ -684,6 +698,12 @@ Convert typed tabs to spaces.
 @item set/unset tempfile
 Save automatically on exit, don't prompt.
 
+@item set titlecolor fgcolor,bgcolor
+Specify the color (combination) to use for the titlebar.
+Valid color names for foreground and background are:
+white, black, red, blue, green, yellow, magenta, and cyan.
+And either "fgcolor" or ",bgcolor" may be left out.
+
 @item set/unset undo
 Enable experimental generic-purpose undo code.
 
@@ -724,10 +744,10 @@ when libmagic is installed on the system and will be silently ignored otherwise.
 For the currently defined syntax, display all expressions matching the
 extended regular expression "regex" with foreground color "fgcolor" and
 background color "bgcolor", at least one of which must be specified.
-Legal colors for foreground and background color are: white, black, red,
+Valid colors for foreground and background are: white, black, red,
 blue, green, yellow, magenta, and cyan.  You may use the prefix "bright"
-to force a stronger color highlight for the foreground.  If your
-terminal supports transparency, not specifying a "bgcolor" tells "nano"
+to get a stronger color highlight for the foreground.  If your
+terminal supports transparency, not specifying a "bgcolor" tells @code{nano}
 to attempt to use a transparent background.
 
 @item icolor fgcolor,bgcolor "regex" @dots{}