.B \-N (\-\-noconvert)
Disable automatic conversion of files from DOS/Mac format.
.TP
-.B \-Q \fI[str]\fP (\-\-quotestr=\fI[str]\fP)
+.B \-Q \fIstr\fP (\-\-quotestr=\fIstr\fP)
Set the quoting string for justifying. The default is
"^([ \\t]*[|>:}#])+" if regular expression support is available, or
"> " otherwise.
Enable smooth scrolling. Text will scroll line-by-line, instead of the
usual chunk-by-chunk behavior.
.TP
-.B \-T \fI[num]\fP (\-\-tabsize=\fI[num]\fP)
+.B \-T \fInum\fP (\-\-tabsize=\fInum\fP)
Set the size (width) of a tab.
.TP
.B \-V (\-\-version)
Show the current version number and author.
.TP
-.B \-Y \fI[str]\fP (\-\-syntax=\fI[str]\fP)
+.B \-Y \fIstr\fP (\-\-syntax=\fIstr\fP)
Specify a specific syntax highlighting from the .nanorc to use, if
available.
.TP
.B \-m (\-\-mouse)
Enable mouse support (if available for your system).
.TP
-.B \-o \fI[dir]\fP (\-\-operatingdir=\fI[dir]\fP)
+.B \-o \fIdir\fP (\-\-operatingdir=\fIdir\fP)
Set operating directory. Makes nano set up something similar to a
chroot.
.TP
Preserve the XON and XOFF sequences (^Q and ^S) so they will be
caught by the terminal.
.TP
-.B \-r \fI[#cols]\fP (\-\-fill=\fI[#cols]\fP)
-Wrap lines at column #cols. By default, this is the width of the
+.B \-r \fIcols\fP (\-\-fill=\fIcols\fP)
+Wrap lines at column \fIcols\fP. By default, this is the width of the
screen, less eight. If this value is negative, wrapping will occur at
-#cols from the right of the screen, allowing it to vary along with the
-screen width if the screen is resized.
+\fIcols\fP columns from the right of the screen, allowing the wrap point
+to vary along with the screen width if resized.
.TP
-.B \-s \fI[prog]\fP (\-\-speller=\fI[prog]\fP)
+.B \-s \fIprog\fP (\-\-speller=\fIprog\fP)
Enable alternative spell checker command.
.TP
.B \-t (\-\-tempfile)
.TP
.B \-a, \-b, \-e, \-f, \-g, \-j
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
.SH NOTES
\fBnano\fP will try to dump the buffer into an emergency file in some
cases. Mainly, this will happen if \fBnano\fP receives a SIGHUP or
<DD>
Disable automatic conversion of files from DOS/Mac format.
-<DT><B>-Q </B><I>[str]</I> (--quotestr=<I>[str]</I>)
+<DT><B>-Q </B><I>str</I> (--quotestr=<I>str</I>)
<DD>
Set the quoting string for justifying. The default is
<DD>
Enable smooth scrolling. Text will scroll line-by-line, instead of the
usual chunk-by-chunk behavior.
-<DT><B>-T </B><I>[num]</I> (--tabsize=<I>[num]</I>)
+<DT><B>-T </B><I>num</I> (--tabsize=<I>num</I>)
<DD>
Set the size (width) of a tab.
<DD>
Show the current version number and author.
-<DT><B>-Y </B><I>[str]</I> (--syntax=<I>[str]</I>)
+<DT><B>-Y </B><I>str</I> (--syntax=<I>str</I>)
<DD>
Specify a specific syntax highlighting from the .nanorc to use, if
<DD>
Enable mouse support (if available for your system).
-<DT><B>-o </B><I>[dir]</I> (--operatingdir=<I>[dir]</I>)
+<DT><B>-o </B><I>dir</I> (--operatingdir=<I>dir</I>)
<DD>
Set operating directory. Makes nano set up something similar to a
<DD>
Preserve the XON and XOFF sequences (^Q and ^S) so they will be
caught by the terminal.
-<DT><B>-r </B><I>[#cols]</I> (--fill=<I>[#cols]</I>)
+<DT><B>-r </B><I>cols</I> (--fill=<I>cols</I>)
<DD>
-Wrap lines at column #cols. By default, this is the width of the
+Wrap lines at column <I>cols</I>. By default, this is the width of the
screen, less eight. If this value is negative, wrapping will occur at
-#cols from the right of the screen, allowing it to vary along with the
-screen width if the screen is resized.
-<DT><B>-s </B><I>[prog]</I> (--speller=<I>[prog]</I>)
+<I>cols</I> columns from the right of the screen, allowing the wrap point
+to vary along with the screen width if resized.
+<DT><B>-s </B><I>prog</I> (--speller=<I>prog</I>)
<DD>
Enable alternative spell checker command.
Ignored, for compatibility with Pico.
</DL>
<A NAME="lbAF"> </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. "set nowrap"). 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)
+<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 "bright" 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"> </A>
<H2>NOTES</H2>
<B>nano</B> will try to dump the buffer into an emergency file in some
".save.1") 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.
-<A NAME="lbAG"> </A>
+<A NAME="lbAH"> </A>
<H2>BUGS</H2>
Please send any comments or bug reports to
To subscribe, email to <A HREF="mailto:nano-devel-request@gnu.org">nano-devel-request@gnu.org</A> with a
subject of "subscribe".
-<A NAME="lbAH"> </A>
+<A NAME="lbAI"> </A>
<H2>HOMEPAGE</H2>
<A HREF="http://www.nano-editor.org">http://www.nano-editor.org</A>
-<A NAME="lbAI"> </A>
+<A NAME="lbAJ"> </A>
<H2>AUTHOR</H2>
Chris Allegretta <<A HREF="mailto:chrisa@asty.org">chrisa@asty.org</A>>, et al (see AUTHORS and THANKS for
<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">NOTES</A><DD>
-<DT><A HREF="#lbAG">BUGS</A><DD>
-<DT><A HREF="#lbAH">HOMEPAGE</A><DD>
-<DT><A HREF="#lbAI">AUTHOR</A><DD>
+<DT><A HREF="#lbAF">INITIALIZATION FILE</A><DD>
+<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>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
-Time: 03:06:20 GMT, January 17, 2003
+Time: 14:15:34 GMT, February 04, 2003
</BODY>
</HTML>
projects / nano.git / commitdiff