From: David Lawrence Ramsey Date: Wed, 5 Apr 2006 13:40:56 +0000 (+0000) Subject: various documentation updates X-Git-Tag: v1.3.12~330 X-Git-Url: https://git.wh0rd.org/?a=commitdiff_plain;h=6d3485e040c33dd7a7d75cd34177599793a845ea;p=nano.git various documentation updates git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@3348 35c25a1d-7b9e-4130-9fde-d3aeb78583b8 --- diff --git a/ChangeLog b/ChangeLog index ad58bad2..3bcbcb70 100644 --- a/ChangeLog +++ b/ChangeLog @@ -13,6 +13,9 @@ CVS code - message. (DLR, found by Bill Marcum) - doc/nano.1, doc/nanorc.5, doc/rnano.1, doc/nano.texi: - Update the copyright years to include 2006. (DLR) + - Explicitly mention that all regexes should be extended regular + expressions. (DLR, suggested by John M. Gabriele) + - Miscellaneous minor fixes. (DLR) - doc/nanorc.sample: - Tweak the "c-file" regex for characters to accept '"' again, as it's apparently valid, and simplify it. (DLR) @@ -28,6 +31,10 @@ CVS code - - Add sample regexes for Python. (singular on the Gentoo forums, http://forums.gentoo.org/viewtopic.php?t=86562; minor tweaks by DLR, suggested by John M. Gabriele) + - Explicitly mention that all regexes should be extended regular + expressions. (DLR, suggested by John M. Gabriele) +- UPGRADE: + - Miscellaneous minor fixes. (DLR) GNU nano 1.3.11 - 2006.03.30 - General: diff --git a/UPGRADE b/UPGRADE index 4c9b774a..f191e271 100644 --- a/UPGRADE +++ b/UPGRADE @@ -8,10 +8,10 @@ Visible changes since 1.0 something else, see below). - nanorc support (see nanorc.sample included in sources). - Smooth scrolling (-S). - - Searching of matching brace/bracket/etc. + - Support for searching for matching braces, brackets, etc. - Help for all editor features. - Color syntax highlighting support. - - Quote string support, useful for mail agents, etc (-Q). + - Quote string support, useful for mail agents, etc. (-Q). - Insertion of output of external commands. - Optional enabling of XON and XOFF control characters (-p). - Tons of bugfixes/enhancements for already existing features. diff --git a/doc/man/nano.1 b/doc/man/nano.1 index 2ae7f7c1..c5b03096 100644 --- a/doc/man/nano.1 +++ b/doc/man/nano.1 @@ -7,7 +7,7 @@ .\" warranty. .\" .\" $Id$ -.TH NANO 1 "version 1.3.11" "March 30, 2006" +.TH NANO 1 "version 1.3.11" "April 4, 2006" .\" Please adjust this date whenever revising the manpage. .\" @@ -85,7 +85,7 @@ Use the blank line below the titlebar as extra editing space. .TP .B \-Q \fIstr\fP (\-\-quotestr=\fIstr\fP) Set the quoting string for justifying. The default is -"\fI^([\ \\t]*[#:>\\|}])+\fP" if regular expression support is +"\fI^([\ \\t]*[#:>\\|}])+\fP" if extended regular expression support is available, or "\fI>\ \fP" otherwise. .TP .B \-R (\-\-restricted) diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index 97d7fbc1..58f606c9 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -7,7 +7,7 @@ .\" warranty. .\" .\" $Id$ -.TH NANORC 5 "version 1.3.11" "March 30, 2006" +.TH NANORC 5 "version 1.3.11" "April 4, 2006" .\" Please adjust this date whenever revising the manpage. .\" .SH NAME @@ -27,11 +27,11 @@ During startup, \fBnano\fP will first read its system-wide settings from \fI~/.nanorc\fP. .SH OPTIONS -The configuration file accepts a series of "set" and "unset" commands, -which can be used to configure nano on startup without using the -command-line options. Additionally, the "syntax", "color", and "icolor" -keywords are used to define syntax highlighting rules for different text -patterns. GNU nano will read one command per line. +The configuration file accepts a series of \fBset\fP and \fBunset\fP +commands, which can be used to configure nano on startup without using +the command line options. Additionally, the \fBsyntax\fP, \fBcolor\fP, +and \fBicolor\fP keywords are used to define syntax highlighting rules +for different text patterns. GNU nano will read one command per line. Options in rcfiles take precedence over nano's defaults, and command line options override rcfile settings. @@ -134,10 +134,11 @@ keystroke instead of 25. .TP .B set quotestr "\fIstring\fP" The email-quote string, used to justify email-quoted paragraphs. This -is an "extended regular expression" if your system supports them, +is an extended regular expression if your system supports them, otherwise a literal string. The default value is -"\fI^([\ \\t]*[#:>\\|}])+\fP" if you have regexps, or "\fI>\ \fP" -otherwise. Note that '\\t' stands for a literal Tab character. +"\fI^([\ \\t]*[#:>\\|}])+\fP" if you have extended regular expression +support, or "\fI>\ \fP" otherwise. Note that '\\t' stands for a literal +Tab character. .TP .B set/unset rebinddelete Interpret the Delete key differently so that both Backspace and Delete @@ -150,7 +151,7 @@ should only need to use this option if they don't, as mouse support won't work properly with this option enabled. .TP .B set/unset regexp -Do regular expression searches by default. +Do extended regular expression searches by default. .TP .B set/unset smarthome Make the Home key smarter. When Home is pressed anywhere but at the @@ -193,8 +194,9 @@ characters as part of a word. .B syntax "\fIstr\fP" ["\fIfileregex\fP" ... ] Defines a syntax named \fIstr\fP which can be activated via the \fB-Y\fP flag, or will be automatically activated if the current filename matches -\fIfileregex\fP. All following \fBcolor\fP and \fBicolor\fP statements -will apply to \fIsyntax\fP until a new syntax is defined. +the extended regular expression \fIfileregex\fP. All following +\fBcolor\fP and \fBicolor\fP statements will apply to \fIsyntax\fP until +a new syntax is defined. The \fInone\fP syntax is reserved; specifying it on the command line is the same as not having a syntax at all. The \fIdefault\fP syntax is @@ -203,20 +205,22 @@ match any other syntax's \fIfileregex\fP. .TP .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 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. +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 +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 icolor \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... Same as above, except that the expression matching is case insensitive. .TP .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 background color \fIbgcolor\fP, +Display expressions which start with the extended regular expression +\fIsr\fP and end with the extended regular expression \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 diff --git a/doc/nanorc.sample b/doc/nanorc.sample index 62578d5b..2dca1b32 100644 --- a/doc/nanorc.sample +++ b/doc/nanorc.sample @@ -110,7 +110,7 @@ ## This is an extended regular expression if your system supports them, ## otherwise a literal string. Default: # set quotestr "^([ ]*[#:>\|}])+" -## if you have regexps, otherwise: +## if you have extended regular expression support, otherwise: # set quotestr "> " ## Fix Backspace/Delete confusion problem. @@ -190,6 +190,8 @@ ## color will use a transparent color. If you don't want this, be sure ## to set the background color to black or white. ## +## All regexes should be extended regular expressions. +## # syntax "c-file" "\.(c|C|cc|cpp|cxx|h|H|hh|hpp|hxx)$" # color brightred "\<[A-Z_][A-Z_0-9]+\>" # color green "\<(float|double|bool|char|int|short|long|sizeof|enum|void|static|const|struct|union|typedef|extern|signed|unsigned|inline)\>" diff --git a/doc/texinfo/nano.texi b/doc/texinfo/nano.texi index 216a30ef..3f75af18 100644 --- a/doc/texinfo/nano.texi +++ b/doc/texinfo/nano.texi @@ -9,7 +9,7 @@ @smallbook @set EDITION 0.1 @set VERSION 1.3.10 -@set UPDATED 30 Mar 2006 +@set UPDATED 4 Apr 2006 @dircategory Editors @direntry @@ -157,8 +157,9 @@ Set the quoting string for justifying. The default is @code{^([ \t]*[|>:@}#])+} @end quotation -if regular expression support is available, or ``> '' otherwise. Note -that @code{\t} above stands for a literal Tab character. +if extended regular expression support is available, or ``> '' +otherwise. 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 @@ -327,13 +328,11 @@ section will display the current directory instead of the filename. @section The Statusbar The statusbar is located three lines from the bottom of the screen (or -the bottom line in Expert Mode. @xref{Expert Mode}, for more info). - -The Statusbar shows important and informational messages. Any error -messages that occur from using the editor will appear on the statusbar. -Any questions that are asked of the user will be asked on the statusbar, -and any user input (search strings, file names, etc) will be input on -the statusbar. +the bottom line in Expert Mode. @xref{Expert Mode}, for more info). It +shows important and informational messages. Any error messages that +occur from using the editor will appear on the statusbar. Any questions +that are asked of the user will be asked on the statusbar, and any user +input (search strings, file names, etc.) will be input on the statusbar. @node Shortcut Lists, , The Statusbar, Editor Basics @section Shortcut Lists