nano.1 3.66 KB
Newer Older
Jordi Mallach's avatar
   
Jordi Mallach committed
1
2
3
4
5
6
7
.\" Hey, EMACS: -*- nroff -*-
.\" nano.1 is copyright 1999-2000 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.
.\"
Chris Allegretta's avatar
Chris Allegretta committed
8
9
10
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
11
.TH NANO 1 "April 30, 2001"
Chris Allegretta's avatar
Chris Allegretta committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
nano \- Nano's ANOther editor, an enhanced free Pico Clone
.SH SYNOPSIS
.B nano
.RI [options]\ [+LINE] " file"
.br
.SH DESCRIPTION
This manual page documents briefly the
.B nano
command.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
26
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, 
Chris Allegretta's avatar
Chris Allegretta committed
27
.\" respectively.
Jordi Mallach's avatar
   
Jordi Mallach committed
28
29
30
\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,
Chris Allegretta's avatar
Chris Allegretta committed
31
.B nano
Jordi Mallach's avatar
   
Jordi Mallach committed
32
33
also implements some missing (or disabled by default) features in Pico,
such as "search and replace" and "goto line number".
Chris Allegretta's avatar
Chris Allegretta committed
34
35
.SH OPTIONS
.TP
Chris Allegretta's avatar
Chris Allegretta committed
36
.B \-T (\-\-tabsize)
37
Set the size (width) of a tab.
Chris Allegretta's avatar
Chris Allegretta committed
38
.TP
39
40
.B \-R (\-\-regexp)
Enable regular expression matching for search strings, as well as
41
\\n subexpression replacement for replace strings, if available.
42
.TP
Chris Allegretta's avatar
Chris Allegretta committed
43
44
45
46
.B \-V (\-\-version)
Show the current version number and author.
.TP
.B \-h (\-\-help)
47
Display a summary of command line options.
Chris Allegretta's avatar
Chris Allegretta committed
48
49
50
51
52
53
54
55
.TP
.B \-c (\-\-const)
Constantly show the cursor position.
.TP
.B \-i (\-\-autoindent)
Indent new lines to the previous line's indentation. Useful when editing
source code.
.TP
56
57
58
.B \-k (\-\-cut)
Enable cut from cursor to end of line with ^K.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
59
60
.B \-l (\-\-nofollow)
If the file being edited is a symbolic link, replace the link with a 
61
a new file, do not follow it.  Good for editing files in /tmp, perhaps?
Chris Allegretta's avatar
Chris Allegretta committed
62
63
64
65
66
.TP
.B \-m (\-\-mouse)
Enable mouse support (if available for your system).
.TP
.B \-p (\-\-pico)
67
68
69
Emulate Pico as closely as possible.  This affects both the "shortcut list"
at the bottom of the screen, as well as the display and entry of previous
search and replace strings.
Chris Allegretta's avatar
Chris Allegretta committed
70
.TP
71
.B \-r (\-\-fill)
72
Wrap lines at column #cols.  By default, this is the width of the screen,
73
74
less eight.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
75
76
77
78
.B \-s (\-\-speller)
Enable alternative spell checker command.
.TP
.B \-t (\-\-tempfile)
79
Always save changed buffer without prompting.  Same as Pico -t option.
Chris Allegretta's avatar
Chris Allegretta committed
80
81
82
83
84
85
86
87
88
89
90
91
92
.TP
.B \-v (\-\-view)
View file (read only) mode.
.TP
.B \-w (\-\-nowrap)
Disable wrapping of long lines.
.TP
.B \-x (\-\-nohelp)
Disable help screen at bottom of editor.
.TP
.B \-z (\-\-suspend)
Enable suspend ability.
.TP
93
94
95
.B \-b, \-e, \-f
Ignored, for compatibility with Pico.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
96
97
.B \+LINE
Places cursor at LINE on startup.
Jordi Mallach's avatar
   
Jordi Mallach committed
98
99
.SH NOTES
Nano will try to dump the buffer into an emergency file in some cases.
100
Mainly, this will happen if Nano receives a SIGHUP or runs out of
Jordi Mallach's avatar
   
Jordi Mallach committed
101
102
memory, when it will write the buffer into a file named "nano.save" if the
buffer didn't have a name already, or will add a ".save" suffix to the
103
current filename. Nano will \fBnot\fP write this file if a previous one
Jordi Mallach's avatar
   
Jordi Mallach committed
104
exists in the current directory.
Chris Allegretta's avatar
Chris Allegretta committed
105
106
.SH BUGS
Please send any comments or bug reports to
Jordi Mallach's avatar
   
Jordi Mallach committed
107
.br
Chris Allegretta's avatar
Chris Allegretta committed
108
.B nano@nano-editor.org.
Jordi Mallach's avatar
   
Jordi Mallach committed
109
.br
Chris Allegretta's avatar
Chris Allegretta committed
110
The nano mailing list is available from
Jordi Mallach's avatar
   
Jordi Mallach committed
111
.br
Chris Allegretta's avatar
Chris Allegretta committed
112
113
114
115
.B nano-devel@lists.sourceforge.net.
To subscribe, email to nano-devel-request@lists.sourceforge.net with a
subject of "subscribe".
.SH HOMEPAGE
Chris Allegretta's avatar
Chris Allegretta committed
116
http://www.nano-editor.org
Chris Allegretta's avatar
Chris Allegretta committed
117
.SH AUTHOR
Jordi Mallach's avatar
   
Jordi Mallach committed
118
119
120
121
Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS for details).
This manual page was originally written by Jordi Mallach
<jordi@sindominio.net>, for the Debian GNU/Linux system (but may be
used by others).