From a644af58a35d30e88b20cd29696f0225abbd9884 Mon Sep 17 00:00:00 2001 From: David Lawrence Ramsey Date: Wed, 8 Jun 2005 21:30:50 +0000 Subject: [PATCH] update documentation for the "color" regex git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@2619 35c25a1d-7b9e-4130-9fde-d3aeb78583b8 --- ChangeLog | 2 ++ doc/man/nanorc.5 | 28 +++++++++++++++------------- doc/nanorc.sample | 10 +++++----- 3 files changed, 22 insertions(+), 18 deletions(-) diff --git a/ChangeLog b/ChangeLog index d742efa8..de22f2c4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -192,6 +192,8 @@ CVS code - and put it back so that it isn't lost. This is especially needed if the keystroke is part of a multibyte character. (DLR) +- nanorc.5: + - Update the description of how the "color" regex works. (DLR) - configure.ac: - Minor tweaks to some of the test blocks to avoid XSI:isms. (DLR, adapted from a Debian patch for GNU ed by David diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index 3f537c06..db9cde9f 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -6,7 +6,7 @@ .\" Public License for copying conditions. There is NO warranty. .\" .\" $Id$ -.TH NANORC 5 "version 1.3.8" "June 3, 2005" +.TH NANORC 5 "version 1.3.8" "June 8, 2005" .\" Please adjust this date whenever revising the manpage. .\" .SH NAME @@ -159,21 +159,23 @@ flag, or will be automatically activated if the current filename matches \fIfileregex\fP. All following \fBcolor\fP statements will apply to \fIsyntax\fP until a new syntax is defined. .TP -.B color \fIfgcolor\fP[,\fIbgcolor\fP] "\fIregex\fP" ... +.B color \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... For the currently defined syntax, display all expressions matching -\fIregex\fP with foreground color \fIfgcolor\fP and optional background -color \fIbgcolor\fP. Legal colors for foreground and background color -are: white, black, red, blue, green, yellow, magenta, and cyan. You may -use the prefix "bright" to force a stronger color highlight. If your -terminal supports transparency, not specifying a \fIbgcolor\fP tells -\fBnano\fP to attempt to use a transparent background. +\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 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 \fIbgcolor\fP tells \fBnano\fP to attempt +to use a transparent background. .TP -.B color \fIfgcolor\fP[,\fIbgcolor\fP] start="\fIsr\fP" end="\fIer\fP" +.B color \fIfgcolor\fP,\fIbgcolor\fP start="\fIsr\fP" end="\fIer\fP" Display expressions which start with \fIsr\fP and end with \fIer\fP -with foreground color \fIfgcolor\fP and optional background color -\fIbgcolor\fP. This allows syntax highlighting to span multiple lines. -Note that all subsequent instances of \fIsr\fP after an initial \fIsr\fP -is found will be highlighted until the first instance of \fIer\fP. +with foreground color \fIfgcolor\fP and background color \fIbgcolor\fP, +at least one of which must be specified. This allows syntax +highlighting to span multiple lines. Note that all subsequent instances +of \fIsr\fP after an initial \fIsr\fP is found will be highlighted until +the first instance of \fIer\fP. \fI .SH FILES diff --git a/doc/nanorc.sample b/doc/nanorc.sample index de77e5cf..3e290448 100644 --- a/doc/nanorc.sample +++ b/doc/nanorc.sample @@ -129,14 +129,14 @@ ## color foreground,background "regex" ["regex"...] ## ## Legal colors: white, black, red, blue, green, yellow, magenta, cyan. -## You may use the prefix "bright" to mean a stronger color highlight. +## You may use the prefix "bright" to mean a stronger color highlight +## for the foreground. ## ## To use multi-line regexes use the start="regex" end="regex" format. ## -## Not specifying a foreground color will use the default foreground -## color. If your system supports transparency, not specifying a -## background color will use a transparent color. If you don't want the -## latter, be sure to set the background color to black or white. +## If your system supports transparency, not specifying a background +## color will use a transparent color. If you don't want this, be sure +## to set the background color to black or white. ## # syntax "c-file" "\.(c|C|cc|cpp|h|H|hh|hpp)$" # color red "\<[A-Z_]{2,}\>"