blob: 9d9541aed78a6e0db67fe850fae1636968f9ea60 [file] [log] [blame]
Jordi Mallachd7ad75a2000-12-03 02:46:02 +00001.\" Hey, EMACS: -*- nroff -*-
2.\" nano.1 is copyright 1999-2000 by
3.\" Chris Allegretta <chrisa@asty.org>
4.\"
5.\" This is free documentation, see the latest version of the GNU General
6.\" Public License for copying conditions. There is NO warranty.
7.\"
Chris Allegrettaa2ea1932000-06-06 05:53:49 +00008.\" First parameter, NAME, should be all caps
9.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
10.\" other parameters are allowed: see man(7), man(1)
Jordi Mallachd7ad75a2000-12-03 02:46:02 +000011.TH NANO 1 "December 2, 2000"
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000012.\" Please adjust this date whenever revising the manpage.
13.\"
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000014.SH NAME
15nano \- Nano's ANOther editor, an enhanced free Pico Clone
16.SH SYNOPSIS
17.B nano
18.RI [options]\ [+LINE] " file"
19.br
20.SH DESCRIPTION
21This manual page documents briefly the
22.B nano
23command.
24.PP
25.\" TeX users may be more comfortable with the \fB<whatever>\fP and
26.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
27.\" respectively.
Jordi Mallachd7ad75a2000-12-03 02:46:02 +000028\fBnano\fP is a small, free and friendly editor which aims to replace
29Pico, the default editor included in the non-free Pine package. Rather
30than just copying Pico's look and feel,
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000031.B nano
Jordi Mallachd7ad75a2000-12-03 02:46:02 +000032also implements some missing (or disabled by default) features in Pico,
33such as "search and replace" and "goto line number".
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000034.SH OPTIONS
35.TP
Chris Allegretta4da1fc62000-06-21 03:00:43 +000036.B \-T (\-\-tabsize)
Chris Allegrettabbd96ea2000-08-04 02:05:44 +000037Set the size (width) of a tab.
Chris Allegretta4da1fc62000-06-21 03:00:43 +000038.TP
Chris Allegretta9fc8d432000-07-07 01:49:52 +000039.B \-R (\-\-regexp)
40Enable regular expression matching for search strings, as well as
Chris Allegrettaa408edd2000-07-07 04:20:09 +000041\\n subexpression replacement for replace strings, if available.
Chris Allegretta9fc8d432000-07-07 01:49:52 +000042.TP
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000043.B \-V (\-\-version)
44Show the current version number and author.
45.TP
46.B \-h (\-\-help)
47Display a summary of commandline options.
48.TP
49.B \-c (\-\-const)
50Constantly show the cursor position.
51.TP
Jordi Mallach3206ab42000-07-28 16:55:47 +000052.B \-k (\-\-cut)
Chris Allegretta84ff4792000-07-28 17:29:22 +000053Enable cut from cursor to end of line with ^K.
Jordi Mallach3206ab42000-07-28 16:55:47 +000054.TP
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000055.B \-i (\-\-autoindent)
56Indent new lines to the previous line's indentation. Useful when editing
57source code.
58.TP
59.B \-l (\-\-nofollow)
60If the file being edited is a symbolic link, replace the link with a
61a new file, do not follow it. Good for editing files in /tmp perhaps?
62.TP
63.B \-m (\-\-mouse)
64Enable mouse support (if available for your system).
65.TP
66.B \-p (\-\-pico)
Chris Allegretta51b3eec2000-12-18 02:23:50 +000067Emulate Pico as closely as possible. This affects both the "shortcut list"
68at the bottom of the screen, as well as the display and entry of previous
69search and replace strings.
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000070.TP
71.B \-s (\-\-speller)
72Enable alternative spell checker command.
73.TP
74.B \-t (\-\-tempfile)
75Always save changed buffer without prompting. Same as Pico -t option.
76.TP
77.B \-v (\-\-view)
78View file (read only) mode.
79.TP
80.B \-w (\-\-nowrap)
81Disable wrapping of long lines.
82.TP
83.B \-x (\-\-nohelp)
84Disable help screen at bottom of editor.
85.TP
86.B \-z (\-\-suspend)
87Enable suspend ability.
88.TP
Chris Allegretta51b3eec2000-12-18 02:23:50 +000089.B \-b, \-e, \-f
90Ignored, for compatibility with Pico.
91.TP
Chris Allegrettaa2ea1932000-06-06 05:53:49 +000092.B \+LINE
93Places cursor at LINE on startup.
Jordi Mallachd7ad75a2000-12-03 02:46:02 +000094.SH NOTES
95Nano will try to dump the buffer into an emergency file in some cases.
96Mainly, this will happen if Nano recieves a SIGHUP or runs out of
97memory, when it will write the buffer into a file named "nano.save" if the
98buffer didn't have a name already, or will add a ".save" suffix to the
Jordi Mallachd87b3412000-12-03 03:15:19 +000099current finename. Nano will \fBnot\fP write this file if a previous one
100exists in the current directory.
Chris Allegrettaa2ea1932000-06-06 05:53:49 +0000101.SH BUGS
102Please send any comments or bug reports to
Jordi Mallachd7ad75a2000-12-03 02:46:02 +0000103.br
Chris Allegretta66989d62000-09-27 03:16:11 +0000104.B nano@nano-editor.org.
Jordi Mallachd7ad75a2000-12-03 02:46:02 +0000105.br
Chris Allegrettaa2ea1932000-06-06 05:53:49 +0000106The nano mailing list is available from
Jordi Mallachd7ad75a2000-12-03 02:46:02 +0000107.br
Chris Allegrettaa2ea1932000-06-06 05:53:49 +0000108.B nano-devel@lists.sourceforge.net.
109To subscribe, email to nano-devel-request@lists.sourceforge.net with a
110subject of "subscribe".
111.SH HOMEPAGE
Chris Allegretta66989d62000-09-27 03:16:11 +0000112http://www.nano-editor.org
Chris Allegrettaa2ea1932000-06-06 05:53:49 +0000113.SH AUTHOR
Jordi Mallachd7ad75a2000-12-03 02:46:02 +0000114Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS for details).
115This manual page was originally written by Jordi Mallach
116<jordi@sindominio.net>, for the Debian GNU/Linux system (but may be
117used by others).