This manual documents GNU nano
, a small and friendly text
editor.
GNU nano
is a small and friendly text editor. Besides basic text
editing, nano
offers many extra features like an interactive
search and replace, goto line number, auto-indentation, feature toggles,
internationalization support, and filename tab completion.
nano
+LINE,COLUMN [GNU long option] [option] [ file ... ]
The original goal for nano
was a complete bug-for-bug compatible
emulation of Pico, but nano
's main goal is to be as compatible as
possible while offering a superset of Pico's functionality. Also see
See Pico Compatibility, for other differences.
Email bug reports to nano@nano-editor.org.
nano
takes the following options from the command line:
+LINE,COLUMN
-?
-h, --help
.
-A, --smarthome
-B, --backup
-C, --backupdir=[dir]
nano
puts unique backup files if file
backups are enabled.
-E, --tabstospaces
-F, --multibuffer
-I, --ignorercfiles
-K, --rebindkeypad
-L, --nonewlines
-N, --noconvert
-Q [str], --quotestr [str]
^([ \t]*[|>:}#])+
if regular expression support is available, or “> ” otherwise. Note
that \t
above stands for a literal Tab character.
-R, --restricted
nano
with any name
beginning with 'r' (e.g. "rnano").
-S, --smooth
-T [num], --tabsize=[#cols]
-U, --quickblank
-V, --version
-W, --wordbounds
-Y, --syntax=[str]
-c, --const
-d, --rebinddelete
-h, --help
-i, --autoindent
-k, --cut
-l, --nofollow
-m, --mouse
-o [dir], --operatingdir=[dir]
nano
set up something similar to
a chroot.
-p, --preserve
-r [#cols], --fill=[#cols].
-s [prog], --speller=[prog]
nano
uses the
command specified in the SPELL environment variable, or, if SPELL is not
set, its own interactive spell checker that requires the spell
program to be installed on your system.
-t, --tempfile
nano
as the
composer of a mailer program.
-x, --nohelp
Note: When accessing the help system, Expert Mode is temporarily
disabled to display the help system navigation keys.
-v, --view
-w, --nowrap
-z, --suspend
nano
's suspend ability using the system's suspend
keystroke (usually ^Z).
-a, -b, -e, -f, -g, -j
All key sequences in nano
are entered using the keyboard.
nano
is a “modeless” editor. All keys with the exception of
Control and Meta key sequences will enter text into the file being
edited.
Special functions use the Control key (displayed in the help and shortcut lists as ^), the Meta key (displayed as M), or the Esc key.
The titlebar is the line displayed at the top of the editor. There are
three sections: left, center and right. The section on the left
displays the version of nano
being used. The center section
displays the current file name, or “New Buffer” if the file has not
yet been named. The section on the right will display “Modified” if
the file has been modified since it was last saved or opened.
Special modes: When nano
is in “File browser” mode, the center
section will display the current directory instead of the filename.
See The File Browser.
The statusbar is located three lines from the bottom of the screen (or the bottom line in Expert Mode. See Expert Mode, for more info).
The Statusbar shows important and informational messages. Any error messages that occur from using the editor will appear on the statusbar. Any questions that are asked of the user will be asked on the statusbar, and any user input (search strings, file names, etc) will be input on the statusbar.
The Shortcut Lists are the two lines at the bottom of the screen which show some of the more commonly used functions in the editor.
The online help system in nano
is available by pressing ^G.
It is fairly self explanatory, documenting the various parts of the
editor and available keystrokes. Navigation is via the ^Y (Page Up)
and ^V (Page Down) keys. ^X exits the help system.
Toggles allow you to change certain aspects of the editor that would normally be done via command line options. They are invoked via certain Meta key sequences. See Special Functions, for more info. The following global toggles are available:
Backup Files Toggle (Meta-B)
--backup
) command line option.
Constant Cursor Position Display Toggle (Meta-C)
--const
) command line option.
Multiple File Buffers Toggle (Meta-F)
--multibuffer
) command line option.
Smart Home Key Toggle (Meta-H)
--smarthome
) command line option.
Auto Indent Toggle (Meta-I)
--autoindent
) command line option.
Cut To End Toggle (Meta-K)
--cut
) command line option.
Long Line Wrapping Toggle (Meta-L)
--nowrap
) command line option.
Mouse Support Toggle (Meta-M)
--mouse
) command line option.
No Conversion From DOS/Mac Format Toggle (Meta-N)
--noconvert
) command line option.
More Space For Editing Toggle (Meta-O)
--morespace
) command line option.
Whitespace Display Toggle (Meta-P)
Tabs to Spaces Toggle (Meta-Q)
--tabstospaces
) command line option.
Smooth Scrolling Toggle (Meta-S)
--smooth
) command line option.
Expert/No Help Toggle (Meta-X)
--nohelp
) command line option.
Color Syntax Highlighting Toggle (Meta-Y)
Suspend Toggle (Meta-Z)
--suspend
) command line option.
When reading or writing files, pressing ^T will invoke the file browser. Here, one can navigate directories in a graphical manner in order to find the desired file.
Basic movement in the file browser is accomplished with the arrow keys and page up/down. The behavior of the enter (or `s') key varies by what is currently selected. If the currently selected object is a directory, the file browser will enter and display the contents of the directory. If the object is a file, this filename and path are copied to the statusbar and the file browser is exited.
nano
attempts to emulate Pico as closely as possible, but there
are certain differences between the editors:
Search and Replace History
nano
, text entered as search or
replace strings will be stored and can be accessed with the up/down
arrow keys. Previously, nano
offered a more consistent, but
incompatible with Pico, method for entering search and replace strings.
In the old method, previous entries would be displayed by default as
editable text in front of the cursor, as opposed to being bracketed and
uneditable as it is in Pico. The old behavior could be made compatible
with Pico via the -p
option, but recent versions of Pico use the
-p
option to preserve the XON and XOFF sequences within the
editor. Since with the new method search and replace strings can still
be edited by simply hitting the up arrow key once, the old method was
removed completely.
Writing or Appending Selected Text to Files
Toggles
nano
. Also
see See Feature Toggles, though this may be out of date.
Cursor Position Display
nano
displays
the given column position, as well as the row and total character
position of the cursor.
Interactive Replace and Spell Checker
nano
replace function is interactive,
i.e, it does not stop after one search string is found and automatically
replace it. The nano
implementation will stop at each search
string found and query whether to replace this instance or not. The
internal spell checker operates similarly. Note that these is no way to
force these functions to behave in the Pico fashion. As of version
1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in
the internal spell checker such that the words 'apple' and 'Apple' will
be prompted for correction separately.
Building nano
from source is fairly straightforward if you are
familiar with compiling programs with autoconf support:
nano
)
--disable-browser
--disable-help
--disable-justify
--disable-mouse
--disable-operatingdir
--disable-speller
--disable-tabcomp
--disable-wrapping
--enable-tiny
--enable-debug
--enable-extra
--enable-color
--enable-multibuffer
--enable-nanorc
--enable-all
--disable-nls
nano
translations.
--disable-wrapping-as-root
--enable-utf8
--disable-utf8
--with-slang
nano
with Slang is supported, and will make the binary
notably smaller than if compiled with ncurses or other curses libraries.