Add nanorc.5 manpage.

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@1437 35c25a1d-7b9e-4130-9fde-d3aeb78583b8

diff --git a/ChangeLog b/ChangeLog
index 853f53df82ef5c8ae85bc8157be6cfe52389c91a..20459b2b0ed9985f70e511cdedf04af9d239c1ba 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -27,6 +27,10 @@ CVS code
        - Add initialization file comments, change some options from 
          bracketed to underlined to emphasize that they are not 
          optional.
+       - Add SEE ALSO section (Jordi).
+- nanorc.5:
+       - Add nanorc manpage, with descriptions of all available commands
+         (Jordi).
 - nanorc.sample:
        - Make nanorc entry less tolerant of invalid colors.
 - nano.spec.in:

diff --git a/Makefile.am b/Makefile.am
index a253e46c1550a1cd3ce30424758ea59235c00366..ce295e5656f99f68a8f0a6d0d408e3c1ce65c751 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,7 +17,7 @@ nano_SOURCES =        color.c \
                utils.c \
                winio.c 
 
-man_MANS = nano.1
+man_MANS = nano.1 nanorc.5
 nano_LDADD = @GLIB_LIBS@ @LIBINTL@
 
 info_TEXINFOS = nano.texi
@@ -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 nano.1.html faq.html nanorc.sample \
-               nano.spec
+               mkinstalldirs nano.1.html faq.html nanorc.sample nano.spec \
+               $(man_MANS)
 
 SUBDIRS = po m4
 

diff --git a/nano.1 b/nano.1
index 75347475f17af632991bf91d21fe896d39edc52f..c5d92b317c9c1e1ccf5ec56e4f5a921f3b9ae0f1 100644 (file)
--- a/nano.1
+++ b/nano.1
@@ -1,20 +1,23 @@
 .\" Hey, EMACS: -*- nroff -*-
-.\" nano.1 is copyright 1999-2002 by
+.\" nano.1 is copyright (C) 1999, 2000, 2001, 2002, 2003 by
 .\" Chris Allegretta <chrisa@asty.org>
 .\"
 .\" This is free documentation, see the latest version of the GNU General
 .\" Public License for copying conditions. There is NO warranty.
 .\"
 .\" $Id$
-.TH NANO 1 "November 1, 2002"
+.TH NANO 1 "February 9, 2003"
 .\" Please adjust this date whenever revising the manpage.
 .\"
+
 .SH NAME
 nano \- Nano's ANOther editor, an enhanced free Pico clone
+
 .SH SYNOPSIS
 .B nano
 .I [\+LINE]\ [options]\ [file]
 .br
+
 .SH DESCRIPTION
 This manual page documents briefly the \fBnano\fP command.
 .PP
@@ -26,6 +29,7 @@ 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
 .TP
 .B \+\fILINE\fP
@@ -137,6 +141,7 @@ Enable suspend ability.
 .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 
@@ -178,6 +183,7 @@ 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
@@ -188,6 +194,7 @@ name already exists in the current directory, ".save" and a number (e.g.
 ".save.1") will be suffixed to the current filename in order to make it
 unique. In multibuffer mode, \fBnano\fP will write all the open buffers
 to the respective emergency files.
+
 .SH BUGS
 Please send any comments or bug reports to
 .br
@@ -198,8 +205,17 @@ The \fBnano\fP mailing list is available from
 .B nano-devel@gnu.org.
 To subscribe, email to nano-devel-request@gnu.org with a
 subject of "subscribe".
+
 .SH HOMEPAGE
-http://www.nano-editor.org
+http://www.nano-editor.org/
+
+.SH SEE ALSO
+.PD 0
+.TP
+\fBnanorc\fP(5)
+.PP
+\fI/usr/share/doc/nano/\fP (or equivalent on your system)
+
 .SH AUTHOR
 Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS and THANKS for
 details).

diff --git a/nanorc.5 b/nanorc.5
new file mode 100644 (file)
index 0000000..e2a7ac2
--- /dev/null
+++ b/nanorc.5
@@ -0,0 +1,127 @@
+.\" 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 n\fP
+Set fill cols to n.
+.TP
+\fBset/unset keypad\fP
+Use alternate keypad routines.
+.TP
+\fBset/unset multibuffer\fP
+Allow multiple file 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 "directory"\fP
+Set operating directory (chroots the user to "directory" and below).
+.TP
+\fBset/unset preserve\fP
+Preserve the XON and XOFF keys (^Q and ^S).
+.TP
+\fBset quotestr "string"\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 aspell\fP
+Use this spelling checker 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.
+.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
+\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.
+
+.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>.