nano.1 5.17 KB
Newer Older
Jordi Mallach's avatar
   
Jordi Mallach committed
1
.\" Hey, EMACS: -*- nroff -*-
2
.\" nano.1 is copyright 1999-2002 by
Jordi Mallach's avatar
   
Jordi Mallach committed
3
4
5
6
7
.\" 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.
.\"
8
.\" $Id$
David Lawrence Ramsey's avatar
David Lawrence Ramsey committed
9
.TH NANO 1 "July 30, 2002"
Chris Allegretta's avatar
Chris Allegretta committed
10
11
12
13
14
15
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
nano \- Nano's ANOther editor, an enhanced free Pico Clone
.SH SYNOPSIS
.B nano
Chris Allegretta's avatar
Chris Allegretta committed
16
.I [\+LINE]\ [options]\ [file]
Chris Allegretta's avatar
Chris Allegretta committed
17
18
.br
.SH DESCRIPTION
Chris Allegretta's avatar
Chris Allegretta committed
19
This manual page documents briefly the \fBnano\fP command.
Chris Allegretta's avatar
Chris Allegretta committed
20
21
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
22
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, 
Chris Allegretta's avatar
Chris Allegretta committed
23
.\" respectively.
Jordi Mallach's avatar
   
Jordi Mallach committed
24
25
\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
Chris Allegretta's avatar
Chris Allegretta committed
26
27
28
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".
Chris Allegretta's avatar
Chris Allegretta committed
29
30
.SH OPTIONS
.TP
Chris Allegretta's avatar
Chris Allegretta committed
31
32
33
.B \+\fILINE\fP
Places cursor at \fILINE\fP on startup.
.TP
34
35
36
37
.B \-B (\-\-backup)
When saving a file, back up the previous version of it to the current
filename suffixed with a ~.
.TP
38
39
40
.B \-D (\-\-dos)
Write file in DOS format.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
41
.B \-F (\-\-multibuffer)
42
Enable multiple file buffers, if available.
Chris Allegretta's avatar
Chris Allegretta committed
43
.TP
Chris Allegretta's avatar
Chris Allegretta committed
44
45
46
.B \-I (\-\-ignorercfiles)
Don't look at /etc/nanorc or ~/.nanorc, if nanorc support is available.
.TP
47
48
49
50
51
.B \-K (\-\-keypad)
Do not use the ncurses keypad() call unless necessary.  Try this flag if 
you find that the arrow keys on the numeric keypad do not work for you 
under nano.
.TP
52
53
.B \-M (\-\-mac)
Write file in Mac format.
Chris Allegretta's avatar
Chris Allegretta committed
54
.TP
55
56
57
.B \-N (\-\-noconvert)
Disable automatic conversion of files from DOS/Mac format.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
58
.B \-Q \fI[str]\fP (\-\-quotestr=\fI[str]\fP)
David Lawrence Ramsey's avatar
David Lawrence Ramsey committed
59
60
61
Set the quoting string for justifying.  The default is
"^([ \\t]*[|>:}#])+" if regular expression support is available, or
"> " otherwise.
Chris Allegretta's avatar
Chris Allegretta committed
62
.TP
63
64
.B \-R (\-\-regexp)
Enable regular expression matching for search strings, as well as
65
\\n subexpression replacement for replace strings, if available.
66
.TP
67
68
.B \-S (\-\-smooth)
Enable smooth scrolling. Text will scroll line-by-line, instead of the
Chris Allegretta's avatar
Chris Allegretta committed
69
usual chunk-by-chunk behavior.
70
.TP
Chris Allegretta's avatar
Chris Allegretta committed
71
.B \-T \fI[num]\fP (\-\-tabsize=\fI[num]\fP)
72
73
Set the size (width) of a tab.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
74
75
76
.B \-V (\-\-version)
Show the current version number and author.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
77
.B \-Y \fI[str]\fP (\-\-syntax=\fI[str]\fP)
78
79
Specify a specific syntax highlighting from the .nanorc to use, if
available.
80
.TP
Chris Allegretta's avatar
Chris Allegretta committed
81
82
83
.B \-c (\-\-const)
Constantly show the cursor position.
.TP
84
85
86
.B \-h (\-\-help)
Display a summary of command line options.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
87
88
89
90
.B \-i (\-\-autoindent)
Indent new lines to the previous line's indentation. Useful when editing
source code.
.TP
91
92
93
.B \-k (\-\-cut)
Enable cut from cursor to end of line with ^K.
.TP
Chris Allegretta's avatar
Chris Allegretta committed
94
.B \-l (\-\-nofollow)
Chris Allegretta's avatar
Chris Allegretta committed
95
If the file being edited is a symbolic link, replace the link with
96
a new file, do not follow it.  Good for editing files in /tmp, perhaps?
Chris Allegretta's avatar
Chris Allegretta committed
97
98
99
100
.TP
.B \-m (\-\-mouse)
Enable mouse support (if available for your system).
.TP
Chris Allegretta's avatar
Chris Allegretta committed
101
.B \-o \fI[dir]\fP (\-\-operatingdir=\fI[dir]\fP)
102
103
Set operating directory. Makes nano set up something similar to a
chroot.
104
.TP
Chris Allegretta's avatar
Chris Allegretta committed
105
.B \-p (\-\-pico)
106
107
108
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
109
.TP
Chris Allegretta's avatar
Chris Allegretta committed
110
.B \-r \fI[#cols]\fP (\-\-fill=\fI[#cols]\fP)
111
112
113
114
Wrap lines at column #cols.  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.
115
.TP
Chris Allegretta's avatar
Chris Allegretta committed
116
.B \-s \fI[prog]\fP (\-\-speller=\fI[prog]\fP)
Chris Allegretta's avatar
Chris Allegretta committed
117
118
119
Enable alternative spell checker command.
.TP
.B \-t (\-\-tempfile)
120
Always save changed buffer without prompting.  Same as Pico -t option.
Chris Allegretta's avatar
Chris Allegretta committed
121
122
123
124
125
126
127
128
129
130
131
132
133
.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
134
.B \-a, \-b, \-e, \-f, \-g, \-j
135
Ignored, for compatibility with Pico.
Jordi Mallach's avatar
   
Jordi Mallach committed
136
.SH NOTES
Chris Allegretta's avatar
Chris Allegretta committed
137
\fBnano\fP will try to dump the buffer into an emergency file in some
138
139
140
141
cases.  Mainly, this will happen if \fBnano\fP receives a SIGHUP or
SIGTERM or runs out of 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 current filename. If an emergency file with that
Chris Allegretta's avatar
Chris Allegretta committed
142
143
144
145
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.
Chris Allegretta's avatar
Chris Allegretta committed
146
147
.SH BUGS
Please send any comments or bug reports to
Jordi Mallach's avatar
   
Jordi Mallach committed
148
.br
Chris Allegretta's avatar
Chris Allegretta committed
149
.B nano@nano-editor.org.
Jordi Mallach's avatar
   
Jordi Mallach committed
150
.br
Chris Allegretta's avatar
Chris Allegretta committed
151
The \fBnano\fP mailing list is available from
Jordi Mallach's avatar
   
Jordi Mallach committed
152
.br
153
154
.B nano-devel@gnu.org.
To subscribe, email to nano-devel-request@gnu.org with a
Chris Allegretta's avatar
Chris Allegretta committed
155
156
subject of "subscribe".
.SH HOMEPAGE
Chris Allegretta's avatar
Chris Allegretta committed
157
http://www.nano-editor.org
Chris Allegretta's avatar
Chris Allegretta committed
158
.SH AUTHOR
159
160
Chris Allegretta <chrisa@asty.org>, et al (see AUTHORS and THANKS for
details).
Jordi Mallach's avatar
   
Jordi Mallach committed
161
This manual page was originally written by Jordi Mallach
162
<jordi@sindominio.net>, for the Debian GNU system (but may be
Jordi Mallach's avatar
   
Jordi Mallach committed
163
used by others).