144 lines
4.6 KiB
Groff
144 lines
4.6 KiB
Groff
.\" Hey, EMACS: -*- nroff -*-
|
|
.\" nanorc.5 is Copyright (C) 1999, 2000, 2001, 2002, 2003
|
|
.\" Free Software Foundation, Inc.
|
|
.\"
|
|
.\" This is free documentation, see the latest version of the GNU General
|
|
.\" Public License for copying conditions. There is NO warranty.
|
|
.\"
|
|
.\" $Id$
|
|
.TH NANORC 5 "February 9, 2003"
|
|
.\" Please adjust this date whenever revising the manpage.
|
|
.\"
|
|
.SH NAME
|
|
nanorc \- GNU nano's rcfile
|
|
.SH SYNOPSIS
|
|
.B /etc/nanorc
|
|
.B $HOME/.nanorc
|
|
.br
|
|
.SH DESCRIPTION
|
|
This manual page documents GNU \fBnano\fP's rcfile.
|
|
.PP
|
|
\fBnano\fP 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, \fBnano\fP also implements some
|
|
missing (or disabled by default) features in Pico, such as "search and
|
|
replace" and "go to line number".
|
|
|
|
.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" 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:
|
|
|
|
.TP 3
|
|
\fBset/unset autoindent\fP
|
|
Use auto-indentation.
|
|
.TP
|
|
\fBset/unset backup\fP
|
|
Create backup files in filename~.
|
|
.TP
|
|
\fBset/unset const\fP
|
|
Constantly update the cursor position.
|
|
.TP
|
|
\fBset/unset cut\fP
|
|
Use cut to end of line with ^K by default.
|
|
.TP
|
|
\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 inserting files into their own buffers.
|
|
.TP
|
|
\fBset/unset noconvert\fP
|
|
Don't convert files from DOS/Mac format.
|
|
.TP
|
|
\fBset/unset nofollow\fP
|
|
Don't follow symlinks when writing files.
|
|
.TP
|
|
\fBset/unset nohelp\fP
|
|
Don't display the help lists at the bottom of the screen.
|
|
.TP
|
|
\fBset/unset nowrap\fP
|
|
Don't wrap text at all.
|
|
.TP
|
|
\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 "\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,
|
|
otherwise set quotestr "> ".
|
|
.TP
|
|
\fBset/unset regexp\fP
|
|
Do regular expression searches by default.
|
|
.TP
|
|
\fBset/unset smooth\fP
|
|
Use smooth scrolling by default.
|
|
.TP
|
|
\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 \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.
|
|
.TP
|
|
\fBset/unset historylog\fP
|
|
Enable ~/.nano_history for saving and reading search/replace strings.
|
|
.TP
|
|
\fBset/unset view\fP
|
|
Disallow file modification.
|
|
.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 SEE ALSO
|
|
.PD 0
|
|
.TP
|
|
\fBnano\fP(1)
|
|
.PP
|
|
\fI/usr/share/doc/nano/examples/nanorc.sample\fP (or equivalent on your system)
|
|
.SH 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>.
|