From 4f989faa6e4c95a61b78890c826640a240bcef8b Mon Sep 17 00:00:00 2001 From: Chris Allegretta Date: Thu, 13 Feb 2003 04:01:49 +0000 Subject: [PATCH] - Moved nano.1 color and syntax sections to nanorc, pointed nano.1 to nanorc.5 for initialization file. Changed nanorc.5 variables to be italics to match nano.1. Added nanorc.5.html to CVS tree git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@1461 35c25a1d-7b9e-4130-9fde-d3aeb78583b8 --- ChangeLog | 4 ++ Makefile.am | 4 +- nano.1 | 42 +------------ nano.1.html | 81 +++++++++---------------- nanorc.5 | 48 ++++++++++----- nanorc.5.html | 162 ++++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 231 insertions(+), 110 deletions(-) create mode 100644 nanorc.5.html diff --git a/ChangeLog b/ChangeLog index c70403d9..595066a9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -87,6 +87,10 @@ CVS code bracketed to underlined to emphasize that they are not optional. - Add SEE ALSO section (Jordi). + - Moved nano.1 color and syntax sections to nanorc, pointed + nano.1 to nanorc.5 for initialization file. Changed + nanorc.5 variables to be italics to match nano.1. Added + nanorc.5.html to CVS tree. - nanorc.5: - Add nanorc manpage, with descriptions of all available commands (Jordi). diff --git a/Makefile.am b/Makefile.am index ce295e56..21431d22 100644 --- a/Makefile.am +++ b/Makefile.am @@ -25,8 +25,8 @@ MAKEINFO = makeinfo --no-split EXTRA_DIST = ABOUT-NLS AUTHORS BUGS COPYING ChangeLog INSTALL NEWS \ README THANKS TODO config.rpath install-sh missing \ - mkinstalldirs nano.1.html faq.html nanorc.sample nano.spec \ - $(man_MANS) + mkinstalldirs nano.1.html nanorc.5.html faq.html \ + nanorc.sample nano.spec $(man_MANS) SUBDIRS = po m4 diff --git a/nano.1 b/nano.1 index c5d92b31..f8e5d9f3 100644 --- a/nano.1 +++ b/nano.1 @@ -144,45 +144,9 @@ Ignored, for compatibility with Pico. .SH INITIALIZATION FILE \fBnano\fP will read initialization files in the following -order: $SYSCONFDIR/nanorc, then ~/.nanorc. Please see the example -file \fBnanorc.sample\fP which should be provided with \fBnano\fP. -All lines beginning with a hash symbol ( -# -) are considered comments -and will be ignored. The following commands are understood in the -initialization file: -.TP -.B [un]set \fIoption\fP [\fIvalue\fP] -Set (or unset) the flag \fIoption\fP. Any long option listed above can -be set or unset by removing the leading dashes (e.g. "set nowrap"). If -the option takes an argument it will be set to \fIvalue\fP. -.PP -\fBCOLOR SYNTAX HIGHLIGHTING\fP (if supported by your curses library) -.PP -.TP -.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 statements -will apply to \fIsyntax\fP until a new syntax is defined. -.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 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. -.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 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. -\fI +order: $SYSCONFDIR/nanorc, then ~/.nanorc. Please see nanorc(5) and +the example file \fBnanorc.sample\fP which should be provided with +\fBnano\fP. .SH NOTES \fBnano\fP will try to dump the buffer into an emergency file in some diff --git a/nano.1.html b/nano.1.html index 429f1fe2..82ac1f02 100644 --- a/nano.1.html +++ b/nano.1.html @@ -3,15 +3,17 @@ Content-type: text/html Manpage of NANO

NANO

-Section: User Commands (1)
Updated: November 1, 2002
Index +Section: User Commands (1)
Updated: February 9, 2003
Index Return to Main Contents
+

 

NAME

nano - Nano's ANOther editor, an enhanced free Pico clone +

 

SYNOPSIS

@@ -21,6 +23,7 @@ nano - Nano's ANOther editor, an enhanced free Pico clone
+

 

DESCRIPTION

@@ -35,6 +38,7 @@ Pico, the default editor included in the non-free Pine package. Rather than just copying Pico's look and feel, nano also implements some missing (or disabled by default) features in Pico, such as "search and replace" and "go to line number". +

 

OPTIONS

@@ -180,61 +184,17 @@ Enable suspend ability.
Ignored, for compatibility with Pico. +

 

INITIALIZATION FILE

nano will read initialization files in the following -order: $SYSCONFDIR/nanorc, then ~/.nanorc. Please see the example -file nanorc.sample which should be provided with nano. -All lines beginning with a hash symbol ( -# -) are considered comments -and will be ignored. The following commands are understood in the -initialization file: -
-
[un]set option [value] - -
-Set (or unset) the flag option. Any long option listed above can -be set or unset by removing the leading dashes (e.g. "set nowrap"). If -the option takes an argument it will be set to value. -
+order: $SYSCONFDIR/nanorc, then ~/.nanorc. Please see nanorc(5) and +the example file nanorc.sample which should be provided with +nano.

- -COLOR SYNTAX HIGHLIGHTING (if supported by your curses library) -

- -

-
syntax str [fileregex ... ] - -
-Defines a syntax named str which can be activated via the --Y flag, or will be automatically activated if the current -filename matches fileregex. All following color statements -will apply to syntax until a new syntax is defined. -
color fgcolor[,bgcolor] regex ... - -
-For the currently defined syntax, display all expressions matching -regex with foreground color fgcolor and optional background -color bgcolor. 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 bgcolor tells -nano to attempt to use a transparent background. -
color fgcolor[,bgcolor] start=sr end=er - -
-Display expressions which start with sr and end with er -with foreground color fgcolor and optional -background color bgcolor. This allows syntax highlighting to span -multiple lines. Note that all subsequent instances of sr after -an initial sr is found will be highlighted until the first -instance of er. - -
-  + 

NOTES

nano will try to dump the buffer into an emergency file in some @@ -246,6 +206,7 @@ name already exists in the current directory, ".save" and a number (e. ".save.1") will be suffixed to the current filename in order to make it unique. In multibuffer mode, nano will write all the open buffers to the respective emergency files. +

 

BUGS

@@ -263,11 +224,24 @@ The nano mailing list is available from To subscribe, email to nano-devel-request@gnu.org with a subject of "subscribe". +

 

HOMEPAGE

-http://www.nano-editor.org +http://www.nano-editor.org/ +

  +

SEE ALSO

+ + +
+
nanorc(5)
+
+

+ +/usr/share/doc/nano/ (or equivalent on your system) +

+ 

AUTHOR

Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS and THANKS for @@ -288,12 +262,13 @@ used by others).
NOTES
BUGS
HOMEPAGE
-
AUTHOR
+
SEE ALSO
+
AUTHOR
This document was created by man2html, using the manual pages.
-Time: 14:15:34 GMT, February 04, 2003 +Time: 04:08:28 GMT, February 13, 2003 diff --git a/nanorc.5 b/nanorc.5 index e2a7ac2f..35eb4d49 100644 --- a/nanorc.5 +++ b/nanorc.5 @@ -49,14 +49,14 @@ Constantly update the cursor position. \fBset/unset cut\fP Use cut to end of line with ^K by default. .TP -\fBset fill n\fP -Set fill cols to n. +\fBset fill \fIn\fP\fP +Set the column where lines will be wrapped at to \fIn\fP. .TP \fBset/unset keypad\fP Use alternate keypad routines. .TP \fBset/unset multibuffer\fP -Allow multiple file buffers. +Allow inserting files into their own buffers. .TP \fBset/unset noconvert\fP Don't convert files from DOS/Mac format. @@ -70,13 +70,13 @@ Don't display the help lists at the bottom of the screen. \fBset/unset nowrap\fP Don't wrap text at all. .TP -\fBset operatingdir "directory"\fP -Set operating directory (chroots the user to "directory" and below). +\fBset operatingdir "\fIdirectory\fP"\fP +Set operating directory (chroots the user to \fIdirectory\fP and below). .TP \fBset/unset preserve\fP Preserve the XON and XOFF keys (^Q and ^S). .TP -\fBset quotestr "string"\fP +\fBset quotestr "\fIstring\fP"\fP The email-quote string. This is a "regular expression" if your system supports them, otherwise a literal string. Default value is set quotestr "^([ \t]*[|>:}#])+" if you have regexps, @@ -88,14 +88,15 @@ Do regular expression searches by default. \fBset/unset smooth\fP Use smooth scrolling by default. .TP -\fBset speller aspell\fP -Use this spelling checker instead of the default (spell). +\fBset speller \fIspellprog\fP\fP +Use spelling checker \fIspellprog\fP instead of the default (spell). .TP \fBset/unset suspend\fP Allow nano to be suspended with ^Z. .TP -\fBset tabsize n\fP -Use a tab size of n instead of the default (8); must be greater than 0. +\fBset tabsize \fIn\fP\fP +Use a tab size of \fIn\fP instead of the default (8); must be greater +than 0. .TP \fBset/unset tempfile\fP Save automatically on exit, don't prompt. @@ -106,14 +107,29 @@ Enable ~/.nano_history for saving and reading search/replace strings. \fBset/unset view\fP Disallow file modification. .TP -\fBsyntax "short description" "regexp"\fP -Define a color syntax name and a regexp to associate files to it. +.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 statements +will apply to \fIsyntax\fP until a new syntax is defined. .TP -\fBcolor "foreground" "[background]" "regexp" ["regexp"...]\fP -Define color rules for different strings. Specifying background is optional, -and you can define multiple regexps to a color rule. +.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. .TP -Every "syntax" command must be followed by one or more "color" rules. +.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. +\fI .SH SEE ALSO .PD 0 diff --git a/nanorc.5.html b/nanorc.5.html new file mode 100644 index 00000000..78c63060 --- /dev/null +++ b/nanorc.5.html @@ -0,0 +1,162 @@ +Content-type: text/html + +Manpage of NANORC + +

NANORC

+Section: File Formats (5)
Updated: February 9, 2003
Index +Return to Main Contents
+ + + +  +

NAME

+ +nanorc - GNU nano's rcfile +  +

SYNOPSIS

+ +/etc/nanorc + +$HOME/.nanorc + +
+ +  +

DESCRIPTION

+ +This manual page documents GNU nano's rcfile. +

+ +nano is a small, free and friendly editor which aims to replace +Pico, the default editor included in the non-free Pine package. Rather +than just copying Pico's look and feel, nano also implements some +missing (or disabled by default) features in Pico, such as "search and +replace" and "go to line number". +

+  +

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" and "color" 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. +

+The supported commands and arguments are: +

+

+
set/unset autoindent
+Use auto-indentation. +
set/unset backup
+Create backup files in filename~. +
set/unset const
+Constantly update the cursor position. +
set/unset cut
+Use cut to end of line with ^K by default. +
set fill n
+Set the column where lines will be wrapped at to n. +
set/unset keypad
+Use alternate keypad routines. +
set/unset multibuffer
+Allow inserting files into their own buffers. +
set/unset noconvert
+Don't convert files from DOS/Mac format. +
set/unset nofollow
+Don't follow symlinks when writing files. +
set/unset nohelp
+Don't display the help lists at the bottom of the screen. +
set/unset nowrap
+Don't wrap text at all. +
set operatingdir "directory"
+Set operating directory (chroots the user to directory and below). +
set/unset preserve
+Preserve the XON and XOFF keys (^Q and ^S). +
set quotestr "string"
+The email-quote string. This is a "regular expression" if your +system supports them, otherwise a literal string. +Default value is set quotestr "^([ ]*[|>:}#])+" if you have regexps, +otherwise set quotestr "> ". +
set/unset regexp
+Do regular expression searches by default. +
set/unset smooth
+Use smooth scrolling by default. +
set speller spellprog
+Use spelling checker spellprog instead of the default (spell). +
set/unset suspend
+Allow nano to be suspended with ^Z. +
set tabsize n
+Use a tab size of n instead of the default (8); must be greater +than 0. +
set/unset tempfile
+Save automatically on exit, don't prompt. +
set/unset historylog
+Enable ~/.nano_history for saving and reading search/replace strings. +
set/unset view
+Disallow file modification. +
syntax str [fileregex ... ] + +
+Defines a syntax named str which can be activated via the +-Y flag, or will be automatically activated if the current +filename matches fileregex. All following color statements +will apply to syntax until a new syntax is defined. +
color fgcolor[,bgcolor] regex ... + +
+For the currently defined syntax, display all expressions matching +regex with foreground color fgcolor and optional background +color bgcolor. 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 bgcolor tells +nano to attempt to use a transparent background. +
color fgcolor[,bgcolor] start=sr end=er + +
+Display expressions which start with sr and end with er +with foreground color fgcolor and optional +background color bgcolor. This allows syntax highlighting to span +multiple lines. Note that all subsequent instances of sr after +an initial sr is found will be highlighted until the first +instance of er. + +

+

+  +

SEE ALSO

+ + +
+
nano(1)
+
+

+ +/usr/share/doc/nano/examples/nanorc.sample (or equivalent on your system) +  +

AUTHOR

+ +Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS and THANKS for +details). +This manual page was written by Jordi Mallach <jordi@gnu.org>. +

+ +

+ 

Index

+
+
NAME
+
SYNOPSIS
+
DESCRIPTION
+
OPTIONS
+
SEE ALSO
+
AUTHOR
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 04:08:33 GMT, February 13, 2003 + +