]> git.wh0rd.org Git - nano.git/commitdiff
- Moved nano.1 color and syntax sections to nanorc, pointed nano.1 to nanorc.5 for...
authorChris Allegretta <chrisa@asty.org>
Thu, 13 Feb 2003 04:01:49 +0000 (04:01 +0000)
committerChris Allegretta <chrisa@asty.org>
Thu, 13 Feb 2003 04:01:49 +0000 (04:01 +0000)
git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@1461 35c25a1d-7b9e-4130-9fde-d3aeb78583b8

ChangeLog
Makefile.am
nano.1
nano.1.html
nanorc.5
nanorc.5.html [new file with mode: 0644]

index c70403d99a503bfa6ee6118e31a90d4ac21c6d18..595066a9ae0a5a1703f1a4ed14a64c1af25f1900 100644 (file)
--- 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).
index ce295e5656f99f68a8f0a6d0d408e3c1ce65c751..21431d22e996fb845fc638ba43d045bded778324 100644 (file)
@@ -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 c5d92b317c9c1e1ccf5ec56e4f5a921f3b9ae0f1..f8e5d9f318a181384ceccd109d6c4335f0832669 100644 (file)
--- 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
index 429f1fe259c0810c739c45084ca72c5e26a2bd20..82ac1f027bcb64e3e6c244765588013737bb34fb 100644 (file)
@@ -3,15 +3,17 @@ Content-type: text/html
 <HTML><HEAD><TITLE>Manpage of NANO</TITLE>
 </HEAD><BODY>
 <H1>NANO</H1>
-Section: User Commands  (1)<BR>Updated: November 1, 2002<BR><A HREF="#index">Index</A>
+Section: User Commands  (1)<BR>Updated: February 9, 2003<BR><A HREF="#index">Index</A>
 <A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
 
 
 
+<P>
 <A NAME="lbAB">&nbsp;</A>
 <H2>NAME</H2>
 
 nano - Nano's ANOther editor, an enhanced free Pico clone
+<P>
 <A NAME="lbAC">&nbsp;</A>
 <H2>SYNOPSIS</H2>
 
@@ -21,6 +23,7 @@ nano - Nano's ANOther editor, an enhanced free Pico clone
 
 <BR>
 
+<P>
 <A NAME="lbAD">&nbsp;</A>
 <H2>DESCRIPTION</H2>
 
@@ -35,6 +38,7 @@ Pico, the default editor included in the non-free Pine package. Rather
 than just copying Pico's look and feel, <B>nano</B> also implements some
 missing (or disabled by default) features in Pico, such as &quot;search and
 replace&quot; and &quot;go to line number&quot;.
+<P>
 <A NAME="lbAE">&nbsp;</A>
 <H2>OPTIONS</H2>
 
@@ -180,61 +184,17 @@ Enable suspend ability.
 
 <DD>
 Ignored, for compatibility with Pico.
+<P>
 </DL>
 <A NAME="lbAF">&nbsp;</A>
 <H2>INITIALIZATION FILE</H2>
 
 <B>nano</B> will read initialization files in the following 
-order: $SYSCONFDIR/nanorc, then ~/.nanorc.  Please see the example 
-file <B>nanorc.sample</B> which should be provided with <B>nano</B>.
-All lines beginning with a hash symbol (
-#
-) are considered comments 
-and will be ignored.  The following commands are understood in the 
-initialization file:
-<DL COMPACT>
-<DT><B>[un]set </B><I>option</I> [<I>value</I>]
-
-<DD>
-Set (or unset) the flag <I>option</I>.  Any long option listed above can 
-be set or unset by removing the leading dashes (e.g. &quot;set nowrap&quot;).  If 
-the option takes an argument it will be set to <I>value</I>.
-</DL>
-<P>
-
-<B>COLOR SYNTAX HIGHLIGHTING</B> (if supported by your curses library)
+order: $SYSCONFDIR/nanorc, then ~/.nanorc.  Please see <A HREF="http://localhost/cgi-bin/man/man2html?5+nanorc">nanorc</A>(5) and 
+the example file <B>nanorc.sample</B> which should be provided with 
+<B>nano</B>. 
 <P>
-
-<DL COMPACT>
-<DT><B>syntax </B><I>str</I> [<I>fileregex</I> ... ]
-
-<DD>
-Defines a syntax named <I>str</I> which can be activated via the 
-<B>-Y</B> flag, or will be automatically activated if the current 
-filename matches <I>fileregex</I>.  All following <B>color</B> statements 
-will apply to <I>syntax</I> until a new syntax is defined.
-<DT><B>color </B><I>fgcolor</I>[,<I>bgcolor</I>] <I>regex</I> ...
-
-<DD>
-For the currently defined syntax, display all expressions matching 
-<I>regex</I> with foreground color <I>fgcolor</I> and optional background 
-color <I>bgcolor</I>. Legal colors for foreground and background color are: 
-white, black, red, blue, green, yellow, magenta, and cyan.  You may use 
-the prefix &quot;bright&quot; to force a stronger color highlight.  If your 
-terminal supports transparency, not specifying a <I>bgcolor</I> tells 
-<B>nano</B> to attempt to use a transparent background.
-<DT><B>color </B><I>fgcolor</I>[,<I>bgcolor</I>] start=<I>sr</I> end=<I>er</I>
-
-<DD>
-Display expressions which start with <I>sr</I> and end with <I>er</I> 
-with foreground color <I>fgcolor</I> and optional 
-background color <I>bgcolor</I>.  This allows syntax highlighting to span 
-multiple lines.  Note that all subsequent instances of <I>sr</I> after 
-an initial <I>sr</I> is found will be highlighted until the first 
-instance of <I>er</I>.
-<I>
-</DL>
-</I><A NAME="lbAG">&nbsp;</A>
+<A NAME="lbAG">&nbsp;</A>
 <H2>NOTES</H2>
 
 <B>nano</B> will try to dump the buffer into an emergency file in some
@@ -246,6 +206,7 @@ name already exists in the current directory, &quot;.save&quot; and a number (e.
 &quot;.save.1&quot;) will be suffixed to the current filename in order to make it
 unique. In multibuffer mode, <B>nano</B> will write all the open buffers
 to the respective emergency files.
+<P>
 <A NAME="lbAH">&nbsp;</A>
 <H2>BUGS</H2>
 
@@ -263,11 +224,24 @@ The <B>nano</B> mailing list is available from
 
 To subscribe, email to <A HREF="mailto:nano-devel-request@gnu.org">nano-devel-request@gnu.org</A> with a
 subject of &quot;subscribe&quot;.
+<P>
 <A NAME="lbAI">&nbsp;</A>
 <H2>HOMEPAGE</H2>
 
-<A HREF="http://www.nano-editor.org">http://www.nano-editor.org</A>
+<A HREF="http://www.nano-editor.org/">http://www.nano-editor.org/</A>
+<P>
 <A NAME="lbAJ">&nbsp;</A>
+<H2>SEE ALSO</H2>
+
+
+<DL COMPACT>
+<DT><B><A HREF="http://localhost/cgi-bin/man/man2html?5+nanorc">nanorc</A></B>(5)<DD>
+</DL>
+<P>
+
+<I>/usr/share/doc/nano/</I> (or equivalent on your system)
+<P>
+<A NAME="lbAK">&nbsp;</A>
 <H2>AUTHOR</H2>
 
 Chris Allegretta &lt;<A HREF="mailto:chrisa@asty.org">chrisa@asty.org</A>&gt;, et al (see AUTHORS and THANKS for
@@ -288,12 +262,13 @@ used by others).
 <DT><A HREF="#lbAG">NOTES</A><DD>
 <DT><A HREF="#lbAH">BUGS</A><DD>
 <DT><A HREF="#lbAI">HOMEPAGE</A><DD>
-<DT><A HREF="#lbAJ">AUTHOR</A><DD>
+<DT><A HREF="#lbAJ">SEE ALSO</A><DD>
+<DT><A HREF="#lbAK">AUTHOR</A><DD>
 </DL>
 <HR>
 This document was created by
 <A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
 using the manual pages.<BR>
-Time: 14:15:34 GMT, February 04, 2003
+Time: 04:08:28 GMT, February 13, 2003
 </BODY>
 </HTML>
index e2a7ac2f83f2cf2a2dc5898b717da5591c0d0c08..35eb4d49bb2e42afa873f435c832bac73f565a60 100644 (file)
--- 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.
-.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.
-.TP
-Every "syntax" command must be followed by one or more "color" rules.
+.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
 
 .SH SEE ALSO
 .PD 0
diff --git a/nanorc.5.html b/nanorc.5.html
new file mode 100644 (file)
index 0000000..78c6306
--- /dev/null
@@ -0,0 +1,162 @@
+Content-type: text/html
+
+<HTML><HEAD><TITLE>Manpage of NANORC</TITLE>
+</HEAD><BODY>
+<H1>NANORC</H1>
+Section: File Formats (5)<BR>Updated: February 9, 2003<BR><A HREF="#index">Index</A>
+<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
+
+
+
+<A NAME="lbAB">&nbsp;</A>
+<H2>NAME</H2>
+
+nanorc - GNU nano's rcfile
+<A NAME="lbAC">&nbsp;</A>
+<H2>SYNOPSIS</H2>
+
+<B>/etc/nanorc</B>
+
+<B>$HOME/.nanorc</B>
+
+<BR>
+
+<A NAME="lbAD">&nbsp;</A>
+<H2>DESCRIPTION</H2>
+
+This manual page documents GNU <B>nano</B>'s rcfile.
+<P>
+
+<B>nano</B> 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, <B>nano</B> also implements some
+missing (or disabled by default) features in Pico, such as &quot;search and
+replace&quot; and &quot;go to line number&quot;.
+<P>
+<A NAME="lbAE">&nbsp;</A>
+<H2>OPTIONS</H2>
+
+The configuration file accepts a series of &quot;set&quot; and &quot;unset&quot; commands,
+which can be used to configure nano on startup without using the
+command-line options. Additionally, the &quot;syntax&quot; and &quot;color&quot; keywords
+are used to define syntax highlighting rules for different text patterns.
+GNU nano will read one command per line.
+<P>
+Options in rcfiles take precedence over nano's defaults, and command line
+options override rcfile settings.
+<P>
+The supported commands and arguments are:
+<P>
+<DL COMPACT>
+<DT><B>set/unset autoindent</B><DD>
+Use auto-indentation.
+<DT><B>set/unset backup</B><DD>
+Create backup files in filename~.
+<DT><B>set/unset const</B><DD>
+Constantly update the cursor position.
+<DT><B>set/unset cut</B><DD>
+Use cut to end of line with ^K by default.
+<DT><B>set fill </B><I>n</I><DD>
+Set the column where lines will be wrapped at to <I>n</I>.
+<DT><B>set/unset keypad</B><DD>
+Use alternate keypad routines.
+<DT><B>set/unset multibuffer</B><DD>
+Allow inserting files into their own buffers.
+<DT><B>set/unset noconvert</B><DD>
+Don't convert files from DOS/Mac format.
+<DT><B>set/unset nofollow</B><DD>
+Don't follow symlinks when writing files.
+<DT><B>set/unset nohelp</B><DD>
+Don't display the help lists at the bottom of the screen.
+<DT><B>set/unset nowrap</B><DD>
+Don't wrap text at all.
+<DT><B>set operatingdir &quot;</B><I>directory</I>&quot;<DD>
+Set operating directory (chroots the user to <I>directory</I> and below).
+<DT><B>set/unset preserve</B><DD>
+Preserve the XON and XOFF keys (^Q and ^S).
+<DT><B>set quotestr &quot;</B><I>string</I>&quot;<DD>
+The email-quote string.  This is a &quot;regular expression&quot; if your
+system supports them, otherwise a literal string.
+Default value is set quotestr &quot;^([        ]*[|&gt;:}#])+&quot; if you have regexps,
+otherwise set quotestr &quot;&gt; &quot;.
+<DT><B>set/unset regexp</B><DD>
+Do regular expression searches by default.
+<DT><B>set/unset smooth</B><DD>
+Use smooth scrolling by default.
+<DT><B>set speller </B><I>spellprog</I><DD>
+Use spelling checker <I>spellprog</I> instead of the default (spell).
+<DT><B>set/unset suspend</B><DD>
+Allow nano to be suspended with ^Z.
+<DT><B>set tabsize </B><I>n</I><DD>
+Use a tab size of <I>n</I> instead of the default (8); must be greater 
+than 0.
+<DT><B>set/unset tempfile</B><DD>
+Save automatically on exit, don't prompt.
+<DT><B>set/unset historylog</B><DD>
+Enable ~/.nano_history for saving and reading search/replace strings.
+<DT><B>set/unset view</B><DD>
+Disallow file modification.
+<DT><B>syntax </B><I>str</I> [<I>fileregex</I> ... ]
+
+<DD>
+Defines a syntax named <I>str</I> which can be activated via the 
+<B>-Y</B> flag, or will be automatically activated if the current 
+filename matches <I>fileregex</I>.  All following <B>color</B> statements 
+will apply to <I>syntax</I> until a new syntax is defined.
+<DT><B>color </B><I>fgcolor</I>[,<I>bgcolor</I>] <I>regex</I> ...
+
+<DD>
+For the currently defined syntax, display all expressions matching 
+<I>regex</I> with foreground color <I>fgcolor</I> and optional background 
+color <I>bgcolor</I>. Legal colors for foreground and background color are: 
+white, black, red, blue, green, yellow, magenta, and cyan.  You may use 
+the prefix &quot;bright&quot; to force a stronger color highlight.  If your 
+terminal supports transparency, not specifying a <I>bgcolor</I> tells 
+<B>nano</B> to attempt to use a transparent background.
+<DT><B>color </B><I>fgcolor</I>[,<I>bgcolor</I>] start=<I>sr</I> end=<I>er</I>
+
+<DD>
+Display expressions which start with <I>sr</I> and end with <I>er</I> 
+with foreground color <I>fgcolor</I> and optional 
+background color <I>bgcolor</I>.  This allows syntax highlighting to span 
+multiple lines.  Note that all subsequent instances of <I>sr</I> after 
+an initial <I>sr</I> is found will be highlighted until the first 
+instance of <I>er</I>.
+<I>
+<P>
+</DL>
+</I><A NAME="lbAF">&nbsp;</A>
+<H2>SEE ALSO</H2>
+
+
+<DL COMPACT>
+<DT><B><A HREF="http://localhost/cgi-bin/man/man2html?1+nano">nano</A></B>(1)<DD>
+</DL>
+<P>
+
+<I>/usr/share/doc/nano/examples/nanorc.sample</I> (or equivalent on your system)
+<A NAME="lbAG">&nbsp;</A>
+<H2>AUTHOR</H2>
+
+Chris Allegretta &lt;<A HREF="mailto:chrisa@asty.org">chrisa@asty.org</A>&gt;, et al (see AUTHORS and THANKS for
+details).
+This manual page was written by Jordi Mallach &lt;<A HREF="mailto:jordi@gnu.org">jordi@gnu.org</A>&gt;.
+<P>
+
+<HR>
+<A NAME="index">&nbsp;</A><H2>Index</H2>
+<DL>
+<DT><A HREF="#lbAB">NAME</A><DD>
+<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
+<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
+<DT><A HREF="#lbAE">OPTIONS</A><DD>
+<DT><A HREF="#lbAF">SEE ALSO</A><DD>
+<DT><A HREF="#lbAG">AUTHOR</A><DD>
+</DL>
+<HR>
+This document was created by
+<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
+using the manual pages.<BR>
+Time: 04:08:33 GMT, February 13, 2003
+</BODY>
+</HTML>