nano.1.html 7.02 KB
Newer Older
Chris Allegretta's avatar
Chris Allegretta committed
1
2
3
<HTML><HEAD><TITLE>Manpage of NANO</TITLE>
</HEAD><BODY>
<H1>NANO</H1>
4
Section: User Commands  (1)<BR>Updated: February 9, 2003<BR><A HREF="#index">Index</A>
Chris Allegretta's avatar
Chris Allegretta committed
5
6
7
8
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>



9
<P>
Chris Allegretta's avatar
Chris Allegretta committed
10
11
12
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

13
nano - Nano's ANOther editor, an enhanced free Pico clone
14
<P>
Chris Allegretta's avatar
Chris Allegretta committed
15
16
17
18
19
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>nano</B>

Chris Allegretta's avatar
Chris Allegretta committed
20
<I>[+LINE]&nbsp;[options]&nbsp;[file]</I>
Chris Allegretta's avatar
Chris Allegretta committed
21
22
23

<BR>

24
<P>
Chris Allegretta's avatar
Chris Allegretta committed
25
26
27
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

Chris Allegretta's avatar
Chris Allegretta committed
28
This manual page documents briefly the <B>nano</B> command.
Chris Allegretta's avatar
Chris Allegretta committed
29
30
31
32
33
<P>




34
35
<B>nano</B> 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
36
37
38
than just copying Pico's look and feel, <B>nano</B> also implements some
missing (or disabled by default) features in Pico, such as &quot;search and
replace&quot; and &quot;go to line number&quot;.
39
<P>
Chris Allegretta's avatar
Chris Allegretta committed
40
41
42
43
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>

<DL COMPACT>
Chris Allegretta's avatar
Chris Allegretta committed
44
45
46
47
<DT><B>+</B><I>LINE</I>

<DD>
Places cursor at <I>LINE</I> on startup.
48
49
50
51
52
<DT><B>-B (--backup)</B>

<DD>
When saving a file, back up the previous version of it to the current
filename suffixed with a ~.
Chris Allegretta's avatar
Chris Allegretta committed
53
54
55
56
<DT><B>-D (--dos)</B>

<DD>
Write file in DOS format.
Chris Allegretta's avatar
Chris Allegretta committed
57
58
59
<DT><B>-F (--multibuffer)</B>

<DD>
60
Enable multiple file buffers, if available.
61
62
63
64
65
<DT><B>-H (--historylog)</B>

<DD>
Log search and replace strings to ~/.nano_history so they may be
stored for later editing, if nanorc support is configured.
Chris Allegretta's avatar
Chris Allegretta committed
66
67
68
<DT><B>-I (--ignorercfiles)</B>

<DD>
David Lawrence Ramsey's avatar
David Lawrence Ramsey committed
69
70
Don't look at $SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is
available.
71
72
73
<DT><B>-K (--keypad)</B>

<DD>
David Lawrence Ramsey's avatar
David Lawrence Ramsey committed
74
75
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
76
under nano.
Chris Allegretta's avatar
Chris Allegretta committed
77
<DT><B>-M (--mac)</B>
Chris Allegretta's avatar
Chris Allegretta committed
78
79

<DD>
Chris Allegretta's avatar
Chris Allegretta committed
80
Write file in Mac format.
Chris Allegretta's avatar
Chris Allegretta committed
81
82
83
84
<DT><B>-N (--noconvert)</B>

<DD>
Disable automatic conversion of files from DOS/Mac format.
85
<DT><B>-Q </B><I>str</I> (--quotestr=<I>str</I>)
Chris Allegretta's avatar
Chris Allegretta committed
86
87

<DD>
David Lawrence Ramsey's avatar
David Lawrence Ramsey committed
88
89
90
Set the quoting string for justifying.  The default is
&quot;^([ \t]*[|&gt;:}#])+&quot; if regular expression support is available, or
&quot;&gt; &quot; otherwise.
91
92
93
94
95
<DT><B>-R (--regexp)</B>

<DD>
Enable regular expression matching for search strings, as well as
\n subexpression replacement for replace strings, if available.
Chris Allegretta's avatar
Chris Allegretta committed
96
<DT><B>-S (--smooth)</B>
Chris Allegretta's avatar
Chris Allegretta committed
97
98

<DD>
Chris Allegretta's avatar
Chris Allegretta committed
99
Enable smooth scrolling. Text will scroll line-by-line, instead of the
Chris Allegretta's avatar
Chris Allegretta committed
100
usual chunk-by-chunk behavior.
101
<DT><B>-T </B><I>num</I> (--tabsize=<I>num</I>)
Chris Allegretta's avatar
Chris Allegretta committed
102
103

<DD>
Chris Allegretta's avatar
Chris Allegretta committed
104
105
106
107
108
Set the size (width) of a tab.
<DT><B>-V (--version)</B>

<DD>
Show the current version number and author.
109
<DT><B>-Y </B><I>str</I> (--syntax=<I>str</I>)
Chris Allegretta's avatar
Chris Allegretta committed
110
111

<DD>
112
113
Specify a specific syntax highlighting from the .nanorc to use, if
available.
Chris Allegretta's avatar
Chris Allegretta committed
114
115
116
117
<DT><B>-c (--const)</B>

<DD>
Constantly show the cursor position.
Chris Allegretta's avatar
Chris Allegretta committed
118
119
120
121
<DT><B>-h (--help)</B>

<DD>
Display a summary of command line options.
Chris Allegretta's avatar
Chris Allegretta committed
122
123
124
125
126
<DT><B>-i (--autoindent)</B>

<DD>
Indent new lines to the previous line's indentation. Useful when editing
source code.
Chris Allegretta's avatar
Chris Allegretta committed
127
128
129
130
<DT><B>-k (--cut)</B>

<DD>
Enable cut from cursor to end of line with ^K.
Chris Allegretta's avatar
Chris Allegretta committed
131
132
133
<DT><B>-l (--nofollow)</B>

<DD>
Chris Allegretta's avatar
Chris Allegretta committed
134
If the file being edited is a symbolic link, replace the link with
135
a new file, do not follow it.  Good for editing files in /tmp, perhaps?
Chris Allegretta's avatar
Chris Allegretta committed
136
137
138
139
<DT><B>-m (--mouse)</B>

<DD>
Enable mouse support (if available for your system).
140
<DT><B>-o </B><I>dir</I> (--operatingdir=<I>dir</I>)
Chris Allegretta's avatar
Chris Allegretta committed
141
142

<DD>
143
144
Set operating directory. Makes nano set up something similar to a
chroot.
145
<DT><B>-p (--preserve)</B>
Chris Allegretta's avatar
Chris Allegretta committed
146
147

<DD>
148
149
Preserve the XON and XOFF sequences (^Q and ^S) so they will be 
caught by the terminal.
150
<DT><B>-r </B><I>cols</I> (--fill=<I>cols</I>)
Chris Allegretta's avatar
Chris Allegretta committed
151
152

<DD>
153
Wrap lines at column <I>cols</I>.  By default, this is the width of the
154
screen, less eight.  If this value is negative, wrapping will occur at
155
156
157
<I>cols</I> columns from the right of the screen, allowing the wrap point 
to vary along with the screen width if resized.
<DT><B>-s </B><I>prog</I> (--speller=<I>prog</I>)
Chris Allegretta's avatar
Chris Allegretta committed
158
159
160
161
162
163

<DD>
Enable alternative spell checker command.
<DT><B>-t (--tempfile)</B>

<DD>
164
Always save changed buffer without prompting.  Same as Pico -t option.
Chris Allegretta's avatar
Chris Allegretta committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<DT><B>-v (--view)</B>

<DD>
View file (read only) mode.
<DT><B>-w (--nowrap)</B>

<DD>
Disable wrapping of long lines.
<DT><B>-x (--nohelp)</B>

<DD>
Disable help screen at bottom of editor.
<DT><B>-z (--suspend)</B>

<DD>
Enable suspend ability.
Chris Allegretta's avatar
Chris Allegretta committed
181
<DT><B>-a, -b, -e, -f, -g, -j</B>
182
183
184

<DD>
Ignored, for compatibility with Pico.
185
<P>
Chris Allegretta's avatar
Chris Allegretta committed
186
187
</DL>
<A NAME="lbAF">&nbsp;</A>
188
189
190
<H2>INITIALIZATION FILE</H2>

<B>nano</B> will read initialization files in the following 
191
192
193
order: $SYSCONFDIR/nanorc, then ~/.nanorc.  Please see <A HREF="http://localhost/cgi-bin/man/man2html?5+nanorc">nanorc</A>(5) and 
the example file <B>nanorc.sample</B> which should be provided with 
<B>nano</B>. 
194
<P>
195
<A NAME="lbAG">&nbsp;</A>
196
197
<H2>NOTES</H2>

Chris Allegretta's avatar
Chris Allegretta committed
198
<B>nano</B> will try to dump the buffer into an emergency file in some
199
200
201
202
cases.  Mainly, this will happen if <B>nano</B> receives a SIGHUP or
SIGTERM or runs out of memory, when it will write the buffer into a file
named &quot;nano.save&quot; if the buffer didn't have a name already, or will add
a &quot;.save&quot; suffix to the current filename. If an emergency file with that
Chris Allegretta's avatar
Chris Allegretta committed
203
204
205
206
name already exists in the current directory, &quot;.save&quot; and a number (e.g.
&quot;.save.1&quot;) will be suffixed to the current filename in order to make it
unique. In multibuffer mode, <B>nano</B> will write all the open buffers
to the respective emergency files.
207
<P>
208
<A NAME="lbAH">&nbsp;</A>
Chris Allegretta's avatar
Chris Allegretta committed
209
210
211
<H2>BUGS</H2>

Please send any comments or bug reports to
212
213
<BR>

Chris Allegretta's avatar
Chris Allegretta committed
214
<B><A HREF="mailto:nano@nano-editor.org">nano@nano-editor.org</A>.</B>
Chris Allegretta's avatar
Chris Allegretta committed
215

216
217
<BR>

Chris Allegretta's avatar
Chris Allegretta committed
218
The <B>nano</B> mailing list is available from
219
220
<BR>

221
<B><A HREF="mailto:nano-devel@gnu.org">nano-devel@gnu.org</A>.</B>
Chris Allegretta's avatar
Chris Allegretta committed
222

223
To subscribe, email to <A HREF="mailto:nano-devel-request@gnu.org">nano-devel-request@gnu.org</A> with a
Chris Allegretta's avatar
Chris Allegretta committed
224
subject of &quot;subscribe&quot;.
225
<P>
226
<A NAME="lbAI">&nbsp;</A>
Chris Allegretta's avatar
Chris Allegretta committed
227
228
<H2>HOMEPAGE</H2>

229
230
<A HREF="http://www.nano-editor.org/">http://www.nano-editor.org/</A>
<P>
231
<A NAME="lbAJ">&nbsp;</A>
232
233
234
235
236
237
238
239
240
241
242
<H2>SEE ALSO</H2>


<DL COMPACT>
<DT><B><A HREF="http://localhost/cgi-bin/man/man2html?5+nanorc">nanorc</A></B>(5)<DD>
</DL>
<P>

<I>/usr/share/doc/nano/</I> (or equivalent on your system)
<P>
<A NAME="lbAK">&nbsp;</A>
Chris Allegretta's avatar
Chris Allegretta committed
243
244
<H2>AUTHOR</H2>

Chris Allegretta's avatar
Chris Allegretta committed
245
246
Chris Allegretta &lt;<A HREF="mailto:chrisa@asty.org">chrisa@asty.org</A>&gt;, et al (see AUTHORS and THANKS for
details).
247
This manual page was originally written by Jordi Mallach
Chris Allegretta's avatar
Chris Allegretta committed
248
&lt;<A HREF="mailto:jordi@sindominio.net">jordi@sindominio.net</A>&gt;, for the Debian GNU system (but may be
249
used by others).
Chris Allegretta's avatar
Chris Allegretta committed
250
251
252
253
254
255
256
257
258
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
259
260
261
262
<DT><A HREF="#lbAF">INITIALIZATION FILE</A><DD>
<DT><A HREF="#lbAG">NOTES</A><DD>
<DT><A HREF="#lbAH">BUGS</A><DD>
<DT><A HREF="#lbAI">HOMEPAGE</A><DD>
263
264
<DT><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT><A HREF="#lbAK">AUTHOR</A><DD>
Chris Allegretta's avatar
Chris Allegretta committed
265
266
267
268
269
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
270
Time: 04:08:28 GMT, February 13, 2003
Chris Allegretta's avatar
Chris Allegretta committed
271
272
</BODY>
</HTML>