2001-02-12 06:48:53 +03:00
|
|
|
\input texinfo @c -*-texinfo-*-
|
|
|
|
@c %**start of header
|
|
|
|
@setfilename nano.info
|
|
|
|
@settitle nano Command Manual
|
|
|
|
@c %**end of header
|
|
|
|
|
|
|
|
@c This file has the new style title page commands.
|
2006-04-20 20:09:32 +04:00
|
|
|
@c Run 'makeinfo' rather than 'texinfo-format-buffer'.
|
2001-02-12 06:48:53 +03:00
|
|
|
@smallbook
|
|
|
|
@set EDITION 0.1
|
2014-04-08 23:40:37 +04:00
|
|
|
@set VERSION 2.3.3
|
|
|
|
@set UPDATED April 2014
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2001-03-23 02:12:22 +03:00
|
|
|
@dircategory Editors
|
|
|
|
@direntry
|
2002-07-19 05:08:59 +04:00
|
|
|
* nano: (nano). Small and friendly text editor.
|
2001-03-23 02:12:22 +03:00
|
|
|
@end direntry
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@c tex
|
|
|
|
@c \overfullrule=0pt
|
|
|
|
@c end tex
|
|
|
|
|
|
|
|
@titlepage
|
2001-02-15 03:25:17 +03:00
|
|
|
@title GNU @code{nano}
|
2001-02-12 06:48:53 +03:00
|
|
|
@subtitle a small and friendly text editor.
|
2009-12-02 06:36:22 +03:00
|
|
|
@subtitle version 2.2.0
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@author Chris Allegretta
|
|
|
|
@page
|
|
|
|
|
2001-02-15 03:25:17 +03:00
|
|
|
This manual documents GNU @code{nano}, a small and friendly text
|
|
|
|
editor.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2001-02-15 03:25:17 +03:00
|
|
|
This manual is part of the GNU @code{nano} distribution.@*
|
2014-01-03 06:11:04 +04:00
|
|
|
@sp 4
|
2009-12-02 06:36:22 +03:00
|
|
|
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
|
|
|
|
2008, 2009 Free Software Foundation, Inc.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2007-08-23 08:34:35 +04:00
|
|
|
This document is dual-licensed. You may distribute and/or modify it
|
|
|
|
under the terms of either of the following licenses:
|
|
|
|
|
|
|
|
* The GNU General Public License, as published by the Free Software
|
|
|
|
Foundation, version 3 or (at your option) any later version. You
|
|
|
|
should have received a copy of the GNU General Public License along
|
|
|
|
with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
* The GNU Free Documentation License, as published by the Free Software
|
|
|
|
Foundation, version 1.2 or (at your option) any later version, with no
|
|
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
|
|
|
You should have received a copy of the GNU Free Documentation License
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2002-11-04 19:05:42 +03:00
|
|
|
You may contact the author by
|
2001-02-12 06:48:53 +03:00
|
|
|
e-mail: @email{chrisa@@asty.org}@*
|
|
|
|
@end titlepage
|
|
|
|
|
|
|
|
@node Top, Introduction, (dir), (dir)
|
|
|
|
|
2002-07-19 05:08:59 +04:00
|
|
|
This manual documents GNU @code{nano}, a small and friendly text
|
|
|
|
editor.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@menu
|
|
|
|
* Introduction::
|
|
|
|
* Editor Basics::
|
|
|
|
* Online Help::
|
|
|
|
* Feature Toggles::
|
2006-04-27 22:52:50 +04:00
|
|
|
* Nanorc Files::
|
2001-02-12 06:48:53 +03:00
|
|
|
* The File Browser::
|
|
|
|
* Pico Compatibility::
|
|
|
|
* Building and Configure Options::
|
|
|
|
@end menu
|
|
|
|
|
|
|
|
@node Introduction, Editor Basics, Top, Top
|
|
|
|
@chapter Introduction
|
|
|
|
|
2002-07-19 05:08:59 +04:00
|
|
|
GNU @code{nano} is a small and friendly text editor. Besides basic text
|
|
|
|
editing, @code{nano} offers many extra features like an interactive
|
2006-10-27 06:57:35 +04:00
|
|
|
search and replace, go to line and column number, auto-indentation,
|
|
|
|
feature toggles, internationalization support, and filename tab
|
|
|
|
completion.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@menu
|
|
|
|
* Overview::
|
|
|
|
* Command Line Options::
|
|
|
|
@end menu
|
|
|
|
|
|
|
|
@node Overview, Command Line Options, Introduction, Introduction
|
|
|
|
@section Overview
|
|
|
|
|
2001-02-15 03:25:17 +03:00
|
|
|
The original goal for @code{nano} was a complete bug-for-bug compatible
|
2006-05-01 17:43:02 +04:00
|
|
|
emulation of Pico, but @code{nano}'s current goal is to be as compatible
|
|
|
|
as possible while offering a superset of Pico's functionality. See
|
2006-04-17 00:40:29 +04:00
|
|
|
@xref{Pico Compatibility}, for more info.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-01 17:43:02 +04:00
|
|
|
The usual way to invoke @code{nano} is:
|
|
|
|
|
|
|
|
@quotation
|
|
|
|
@code{nano [OPTION]@dots{} [FILE]}
|
|
|
|
@end quotation
|
|
|
|
|
|
|
|
But it is also possible to edit several files in a row. Additionally,
|
|
|
|
the cursor can be put on a desired line number by adding this number
|
2006-05-22 01:32:13 +04:00
|
|
|
with a plus sign before any filename, and even in a desired column by
|
|
|
|
adding it with a comma. So the complete synopsis is:
|
2006-05-01 17:43:02 +04:00
|
|
|
|
|
|
|
@quotation
|
2006-05-14 19:19:38 +04:00
|
|
|
@code{nano [OPTION]@dots{} [[+LINE] FILE]@dots{}}
|
2006-05-01 17:43:02 +04:00
|
|
|
|
2006-06-26 08:39:31 +04:00
|
|
|
@code{nano [OPTION]@dots{} [[+,COLUMN] FILE]@dots{}}
|
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@code{nano [OPTION]@dots{} [[+LINE,COLUMN] FILE]@dots{}}
|
2006-05-01 17:43:02 +04:00
|
|
|
@end quotation
|
|
|
|
|
2003-08-31 20:44:10 +04:00
|
|
|
Email bug reports to @email{nano@@nano-editor.org}.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@node Command Line Options, , Overview, Introduction
|
|
|
|
@section Command Line Options
|
|
|
|
|
2001-02-15 03:25:17 +03:00
|
|
|
@code{nano} takes the following options from the command line:
|
2002-06-29 02:45:14 +04:00
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@table @code
|
2006-06-26 08:39:31 +04:00
|
|
|
@item +LINE,COLUMN
|
|
|
|
Start at line number LINE and column number COLUMN (at least one of
|
|
|
|
which must be specified) instead of the default of line 1, column 1.
|
2005-03-27 03:15:51 +04:00
|
|
|
|
|
|
|
@item -?
|
|
|
|
Same as @code{-h, --help}.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2004-05-23 00:15:20 +04:00
|
|
|
@item -A, --smarthome
|
|
|
|
Make the Home key smarter. When Home is pressed anywhere but at the
|
|
|
|
very beginning of non-whitespace characters on a line, the cursor will
|
|
|
|
jump to that beginning (either forwards or backwards). If the cursor is
|
|
|
|
already at that position, it will jump to the true beginning of the
|
|
|
|
line.
|
|
|
|
|
2002-06-29 02:45:14 +04:00
|
|
|
@item -B, --backup
|
|
|
|
When saving a file, back up the previous version of it to the current
|
|
|
|
filename suffixed with a ~.
|
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -C <dir>, --backupdir=<dir>
|
2005-05-30 06:09:21 +04:00
|
|
|
Set the directory where @code{nano} puts unique backup files if file
|
2004-02-28 19:24:31 +03:00
|
|
|
backups are enabled.
|
|
|
|
|
2006-04-12 19:27:40 +04:00
|
|
|
@item -D, --boldtext
|
|
|
|
Use bold text instead of reverse video text.
|
|
|
|
|
2005-06-16 03:20:56 +04:00
|
|
|
@item -E, --tabstospaces
|
|
|
|
Convert typed tabs to spaces.
|
|
|
|
|
2001-10-03 16:45:22 +04:00
|
|
|
@item -F, --multibuffer
|
2002-06-29 02:45:14 +04:00
|
|
|
Enable multiple file buffers, if available.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -H, --historylog
|
|
|
|
Log search and replace strings to ~/.nano_history, so they can be
|
|
|
|
retrieved in later sessions, if nanorc support is available.
|
|
|
|
|
2002-07-20 17:57:41 +04:00
|
|
|
@item -I, --ignorercfiles
|
2003-08-31 20:44:10 +04:00
|
|
|
Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is
|
2002-11-04 19:05:42 +03:00
|
|
|
available.
|
2002-07-20 17:57:41 +04:00
|
|
|
|
2005-08-11 03:32:08 +04:00
|
|
|
@item -K, --rebindkeypad
|
|
|
|
Interpret the numeric keypad keys so that they all work properly. You
|
|
|
|
should only need to use this option if they don't, as mouse support
|
|
|
|
won't work properly with this option enabled.
|
|
|
|
|
2005-11-05 20:35:44 +03:00
|
|
|
@item -L, --nonewlines
|
|
|
|
Don't add newlines to the ends of files.
|
|
|
|
|
2002-03-04 20:35:44 +03:00
|
|
|
@item -N, --noconvert
|
2005-11-04 09:43:02 +03:00
|
|
|
Don't convert files from DOS/Mac format.
|
2002-03-04 20:35:44 +03:00
|
|
|
|
2006-07-31 03:18:15 +04:00
|
|
|
@item -O, --morespace
|
|
|
|
Use the blank line below the titlebar as extra editing space.
|
|
|
|
|
2014-04-09 00:01:17 +04:00
|
|
|
@item -P, --poslog
|
|
|
|
Log and later read back the location of the cursor and place it
|
|
|
|
there again.
|
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -Q <str>, --quotestr=<str>
|
2006-04-27 22:52:50 +04:00
|
|
|
Set the quoting string for justifying. The default value is
|
2002-08-21 20:10:37 +04:00
|
|
|
|
2002-11-04 19:05:42 +03:00
|
|
|
@quotation
|
|
|
|
@code{^([ \t]*[|>:@}#])+}
|
|
|
|
@end quotation
|
|
|
|
|
2006-04-20 18:33:36 +04:00
|
|
|
if extended regular expression support is available, or "> " otherwise.
|
|
|
|
Note that @code{\t} above stands for a literal Tab character.
|
2002-03-04 20:35:44 +03:00
|
|
|
|
2005-06-18 02:53:41 +04:00
|
|
|
@item -R, --restricted
|
2006-05-01 17:22:47 +04:00
|
|
|
Restricted mode: don't read or write to any file not specified on the
|
2006-04-17 02:39:15 +04:00
|
|
|
command line; read any nanorc files; allow suspending; allow a file to
|
|
|
|
be appended to, prepended to, or saved under a different name if it
|
|
|
|
already has one; or use backup files or spell checking. Also accessible
|
|
|
|
by invoking @code{nano} with any name beginning with 'r' (e.g. "rnano").
|
2005-06-18 02:53:41 +04:00
|
|
|
|
2001-10-03 16:45:22 +04:00
|
|
|
@item -S, --smooth
|
2006-05-01 17:22:47 +04:00
|
|
|
Enable smooth scrolling. Text will scroll line-by-line, instead of the
|
|
|
|
usual chunk-by-chunk behavior.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -T <#cols>, --tabsize=<#cols>
|
2005-06-27 09:01:32 +04:00
|
|
|
Set the displayed tab length to #cols columns. The value of #cols must
|
|
|
|
be greater than 0. The default value is 8.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2005-06-18 02:11:43 +04:00
|
|
|
@item -U, --quickblank
|
|
|
|
Do quick statusbar blanking. Statusbar messages will disappear after 1
|
2006-06-08 06:45:38 +04:00
|
|
|
keystroke instead of 25. Note that -c overrides this.
|
2005-06-18 02:11:43 +04:00
|
|
|
|
2003-08-31 20:44:10 +04:00
|
|
|
@item -V, --version
|
2006-05-01 17:22:47 +04:00
|
|
|
Show the current version number and exit.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2005-08-11 03:32:08 +04:00
|
|
|
@item -W, --wordbounds
|
|
|
|
Detect word boundaries more accurately by treating punctuation
|
2006-06-26 08:39:31 +04:00
|
|
|
characters as parts of words.
|
2005-08-11 03:32:08 +04:00
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -Y <str>, --syntax=<str>
|
2005-11-12 10:23:39 +03:00
|
|
|
Specify a specific syntax highlighting from the nanorc to use, if
|
2006-04-27 22:52:50 +04:00
|
|
|
available. See @xref{Nanorc Files}, for more info.
|
2002-06-29 02:45:14 +04:00
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@item -c, --const
|
2001-05-05 21:45:54 +04:00
|
|
|
Constantly display the cursor position and line number on the statusbar.
|
2006-06-08 06:45:38 +04:00
|
|
|
Note that this overrides -U.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2003-08-31 20:44:10 +04:00
|
|
|
@item -d, --rebinddelete
|
|
|
|
Interpret the Delete key differently so that both Backspace and Delete
|
|
|
|
work properly. You should only need to use this option if Backspace
|
|
|
|
acts like Delete on your system.
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@item -h, --help
|
2006-05-01 17:22:47 +04:00
|
|
|
Show a summary of command line options and exit.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item -i, --autoindent
|
|
|
|
Automatically indent new lines to the same number of spaces and tabs as
|
|
|
|
the previous line.
|
|
|
|
|
|
|
|
@item -k, --cut
|
2005-03-11 23:22:48 +03:00
|
|
|
Cut from the current cursor position to the end of the current line.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item -l, --nofollow
|
2005-03-11 23:22:48 +03:00
|
|
|
When writing files, if the given file is a symbolic link, it is removed
|
2001-02-12 06:48:53 +03:00
|
|
|
and a new file is created.
|
|
|
|
|
|
|
|
@item -m, --mouse
|
2006-05-25 00:55:44 +04:00
|
|
|
Enable mouse support, if available for your system. When enabled, mouse
|
|
|
|
clicks can be used to place the cursor, set the mark (with a double
|
|
|
|
click), and execute shortcuts. The mouse will work in the X Window
|
|
|
|
System, and on the console when gpm is running.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2014-04-08 23:40:37 +04:00
|
|
|
@item -n, --noread
|
|
|
|
Treat any name given on the command line as a new file. This allows
|
|
|
|
@code{nano} to write to named pipes: it will start with a blank buffer,
|
|
|
|
and will write to the pipe when the user saves the "file". This way
|
|
|
|
@code{nano} can be used as an editor in combination with for instance
|
|
|
|
@code{gpg} without having to write sensitive data to disk first.
|
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -o <dir>, --operatingdir=<dir>
|
2003-08-31 20:44:10 +04:00
|
|
|
Set operating directory. Makes @code{nano} set up something similar to
|
|
|
|
a chroot.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2003-01-13 05:56:29 +03:00
|
|
|
@item -p, --preserve
|
2003-08-31 20:44:10 +04:00
|
|
|
Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the
|
|
|
|
editor can be can be stopped and started.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2009-12-02 06:36:22 +03:00
|
|
|
@item -q, --quiet
|
|
|
|
Do not report errors in the nanorc file and ask them to be acknowledged
|
|
|
|
by pressing Enter at startup.
|
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -r <#cols>, --fill=<#cols>
|
2005-06-27 09:01:32 +04:00
|
|
|
Wrap lines at column #cols. If this value is 0 or less, wrapping will
|
2006-05-01 17:22:47 +04:00
|
|
|
occur at the width of the screen less #cols, allowing it to vary along
|
2005-06-27 09:01:32 +04:00
|
|
|
with the width of the screen if the screen is resized. The default
|
|
|
|
value is -8.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@item -s <prog>, --speller=<prog>
|
|
|
|
Invoke the given program as the spell checker. By default, @code{nano}
|
|
|
|
uses the command specified in the SPELL environment variable, or, if
|
|
|
|
SPELL is not set, its own interactive spell checker that requires the
|
|
|
|
@code{spell} program to be installed on your system.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item -t, --tempfile
|
2005-11-04 09:43:02 +03:00
|
|
|
Don't ask whether or not to save the current contents of the file when
|
2001-02-15 03:25:17 +03:00
|
|
|
exiting, assume yes. This is most useful when using @code{nano} as the
|
2001-02-12 06:48:53 +03:00
|
|
|
composer of a mailer program.
|
|
|
|
|
2009-12-02 06:36:22 +03:00
|
|
|
@item -u, --undo
|
|
|
|
Enable experimental generic-purpose undo code. By default, the undo and
|
|
|
|
redo shortcuts are Meta-U and Meta-E, respectively.
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@item -v, --view
|
2005-11-11 20:04:17 +03:00
|
|
|
Don't allow the contents of the file to be altered. Note that this
|
|
|
|
option should NOT be used in place of correct file permissions to
|
|
|
|
implement a read-only file.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item -w, --nowrap
|
2005-11-04 09:43:02 +03:00
|
|
|
Don't wrap long lines at any length. This option overrides any value
|
2003-08-31 20:44:10 +04:00
|
|
|
for -r.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-14 19:19:38 +04:00
|
|
|
@anchor{Expert Mode}
|
|
|
|
@item -x, --nohelp
|
|
|
|
Expert Mode: don't show the Shortcut Lists at the bottom of the screen.
|
|
|
|
This affects the location of the statusbar as well, as in Expert Mode it
|
|
|
|
is located at the very bottom of the editor.
|
|
|
|
|
|
|
|
Note: When accessing the help system, Expert Mode is temporarily
|
|
|
|
disabled to display the help system navigation keys.
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@item -z, --suspend
|
2005-11-11 20:04:17 +03:00
|
|
|
Enable @code{nano}'s suspend ability using the system's suspend
|
2001-02-12 06:48:53 +03:00
|
|
|
keystroke (usually ^Z).
|
|
|
|
|
2009-12-02 06:36:22 +03:00
|
|
|
@item -$, --softwrap
|
|
|
|
Enable 'soft wrapping'. @code{nano} will attempt to display the entire
|
|
|
|
contents of a line, even if it is longer than the screen width. Since
|
|
|
|
'$' normally refers to a variable in the Unix shell, you should specify
|
|
|
|
this option last when using other options (e.g. 'nano -wS$') or pass it
|
|
|
|
separately (e.g. 'nano -wS -$').
|
|
|
|
|
2001-10-03 19:53:25 +04:00
|
|
|
@item -a, -b, -e, -f, -g, -j
|
2001-10-03 16:45:22 +04:00
|
|
|
Ignored, for compatibility with Pico.
|
2001-02-12 06:48:53 +03:00
|
|
|
@end table
|
|
|
|
|
2006-05-25 00:55:44 +04:00
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@node Editor Basics, Online Help, Introduction, Top
|
|
|
|
@chapter Editor Basics
|
|
|
|
@menu
|
|
|
|
* Entering Text::
|
|
|
|
* Special Functions::
|
|
|
|
* The Titlebar::
|
|
|
|
* The Statusbar::
|
|
|
|
* Shortcut Lists::
|
2006-05-25 00:55:44 +04:00
|
|
|
* Using the Mouse::
|
2001-02-12 06:48:53 +03:00
|
|
|
@end menu
|
|
|
|
|
|
|
|
@node Entering Text, Special Functions, Editor Basics, Editor Basics
|
|
|
|
@section Entering Text
|
|
|
|
|
2001-02-15 03:25:17 +03:00
|
|
|
All key sequences in @code{nano} are entered using the keyboard.
|
2006-04-20 18:33:36 +04:00
|
|
|
@code{nano} is a "modeless" editor. All keys, with the exception of
|
|
|
|
Control and Meta key sequences, will enter text into the file being
|
2003-08-31 20:44:10 +04:00
|
|
|
edited.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@node Special Functions, The Titlebar, Entering Text, Editor Basics
|
|
|
|
@section Special Functions
|
|
|
|
|
2006-04-20 18:33:36 +04:00
|
|
|
Special functions use the Control (Ctrl) key, displayed in the help and
|
|
|
|
shortcut lists as ^; the Meta key, displayed as M; or the Escape (Esc)
|
|
|
|
key.
|
2003-08-31 20:44:10 +04:00
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@itemize @bullet
|
|
|
|
@item
|
2006-04-20 18:33:36 +04:00
|
|
|
Control key sequences are entered by holding down the Ctrl key and
|
2003-08-31 20:44:10 +04:00
|
|
|
pressing the desired key, or by pressing the Esc key twice and pressing
|
|
|
|
the desired key.
|
|
|
|
@item
|
|
|
|
Pressing Esc twice and then typing a three-digit number from 000 to 255
|
2006-04-20 18:33:36 +04:00
|
|
|
will enter the character with the corresponding value.
|
2001-02-12 06:48:53 +03:00
|
|
|
@item
|
2006-05-01 17:22:47 +04:00
|
|
|
Meta key sequences are entered by holding down the Meta key (normally
|
|
|
|
the Alt key) and pressing the desired key, or by pressing the Esc key
|
|
|
|
once and pressing the desired key. Certain operating systems "swallow"
|
|
|
|
the Alt key so that it never reaches the application; if your operating
|
2006-04-20 18:33:36 +04:00
|
|
|
system does this, you should use the Esc key to generate Meta key
|
|
|
|
sequences.
|
2001-02-12 06:48:53 +03:00
|
|
|
@end itemize
|
|
|
|
|
|
|
|
@node The Titlebar, The Statusbar, Special Functions, Editor Basics
|
|
|
|
@section The Titlebar
|
|
|
|
|
|
|
|
The titlebar is the line displayed at the top of the editor. There are
|
2003-08-31 20:44:10 +04:00
|
|
|
three sections: left, center and right. The section on the left
|
|
|
|
displays the version of @code{nano} being used. The center section
|
2006-05-22 01:32:13 +04:00
|
|
|
displays the current filename, or "New Buffer" if the file has not yet
|
2006-04-20 18:33:36 +04:00
|
|
|
been named. The section on the right will display "Modified" if the
|
|
|
|
file has been modified since it was last saved or opened.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-04-20 18:33:36 +04:00
|
|
|
Special modes: When @code{nano} is in "File browser" mode, the center
|
2006-04-17 00:40:29 +04:00
|
|
|
section will display the current directory instead of the filename. See
|
|
|
|
@xref{The File Browser}, for more info.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@node The Statusbar, Shortcut Lists, The Titlebar, Editor Basics
|
|
|
|
@section The Statusbar
|
|
|
|
|
2006-05-01 17:22:47 +04:00
|
|
|
The statusbar is the third line from the bottom of the screen, or the
|
|
|
|
bottom line in Expert Mode. See @xref{Expert Mode}, for more info. It
|
|
|
|
shows important and informational messages. Any error messages that
|
2006-04-05 17:40:56 +04:00
|
|
|
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
|
2006-05-22 01:32:13 +04:00
|
|
|
input (search strings, filenames, etc.) will be input on the statusbar.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-25 00:55:44 +04:00
|
|
|
@node Shortcut Lists, Using the Mouse, The Statusbar, Editor Basics
|
2001-02-12 06:48:53 +03:00
|
|
|
@section Shortcut Lists
|
|
|
|
|
2002-06-29 02:45:14 +04:00
|
|
|
The Shortcut Lists are the two lines at the bottom of the screen which
|
2003-08-31 20:44:10 +04:00
|
|
|
show some of the more commonly used functions in the editor.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-25 00:55:44 +04:00
|
|
|
@node Using the Mouse, , Shortcut Lists, Editor Basics
|
|
|
|
@section Using the Mouse
|
|
|
|
|
|
|
|
When mouse support has been configured and enabled, a single mouse click
|
|
|
|
places the cursor at the indicated position. Clicking a second time in
|
|
|
|
the same position toggles the mark. Clicking in the shortcut list
|
2014-03-26 17:12:52 +04:00
|
|
|
executes the selected shortcut. To be able to select text with the
|
|
|
|
left button, or paste text with the middle button, hold down the
|
|
|
|
Shift key during those actions.
|
2006-05-25 00:55:44 +04:00
|
|
|
|
|
|
|
The mouse will work in the X Window System, and on the console when gpm
|
|
|
|
is running.
|
|
|
|
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@node Online Help, Feature Toggles, Editor Basics, Top
|
|
|
|
@chapter Online Help
|
|
|
|
|
2001-02-15 03:25:17 +03:00
|
|
|
The online help system in @code{nano} is available by pressing ^G.
|
2003-08-31 20:44:10 +04:00
|
|
|
It is fairly self explanatory, documenting the various parts of the
|
2001-02-12 06:48:53 +03:00
|
|
|
editor and available keystrokes. Navigation is via the ^Y (Page Up)
|
|
|
|
and ^V (Page Down) keys. ^X exits the help system.
|
|
|
|
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@node Feature Toggles, Nanorc Files, Online Help, Top
|
2001-02-12 06:48:53 +03:00
|
|
|
@chapter Feature Toggles
|
|
|
|
|
2006-05-01 17:22:47 +04:00
|
|
|
Toggles allow you to change certain aspects of the editor that would
|
|
|
|
normally be done via command line options. They are invoked via Meta
|
|
|
|
key sequences. See @xref{Special Functions}, for more info. The
|
|
|
|
following global toggles are available:
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@table @code
|
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Backup Files Toggle (Meta-B)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -B (@code{--backup}) command line option.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Constant Cursor Position Display Toggle (Meta-C)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -c (@code{--const}) command line option.
|
2005-06-20 02:22:01 +04:00
|
|
|
|
2005-01-17 08:24:26 +03:00
|
|
|
@item Multiple File Buffers Toggle (Meta-F)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -F (@code{--multibuffer}) command line option.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Smart Home Key Toggle (Meta-H)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -A (@code{--smarthome}) command line option.
|
2004-05-23 00:15:20 +04:00
|
|
|
|
2005-01-17 08:24:26 +03:00
|
|
|
@item Auto Indent Toggle (Meta-I)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -i (@code{--autoindent}) command line option.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item Cut To End Toggle (Meta-K)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -k (@code{--cut}) command line option.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Long Line Wrapping Toggle (Meta-L)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -w (@code{--nowrap}) command line option.
|
2004-04-20 23:19:21 +04:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Mouse Support Toggle (Meta-M)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -m (@code{--mouse}) command line option.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item No Conversion From DOS/Mac Format Toggle (Meta-N)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -N (@code{--noconvert}) command line option.
|
2005-06-20 02:22:01 +04:00
|
|
|
|
|
|
|
@item More Space For Editing Toggle (Meta-O)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -O (@code{--morespace}) command line option.
|
2005-01-17 08:24:26 +03:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Whitespace Display Toggle (Meta-P)
|
|
|
|
toggles whitespace display mode if you have a "whitespace" option in
|
2006-04-27 22:52:50 +04:00
|
|
|
your nanorc. See @xref{Nanorc Files}, for more info.
|
2005-06-20 02:22:01 +04:00
|
|
|
|
2005-06-21 21:44:01 +04:00
|
|
|
@item Tabs to Spaces Toggle (Meta-Q)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -E (@code{--tabstospaces}) command line option.
|
2005-06-21 21:44:01 +04:00
|
|
|
|
2001-10-03 16:45:22 +04:00
|
|
|
@item Smooth Scrolling Toggle (Meta-S)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -S (@code{--smooth}) command line option.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Expert/No Help Toggle (Meta-X)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -x (@code{--nohelp}) command line option.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2005-06-20 02:22:01 +04:00
|
|
|
@item Color Syntax Highlighting Toggle (Meta-Y)
|
|
|
|
toggles color syntax highlighting if you have color syntaxes in your
|
2006-04-27 22:52:50 +04:00
|
|
|
nanorc. See @xref{Nanorc Files}, for more info.
|
2005-06-20 02:22:01 +04:00
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@item Suspend Toggle (Meta-Z)
|
2005-11-11 20:04:17 +03:00
|
|
|
toggles the -z (@code{--suspend}) command line option.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2009-12-02 06:36:22 +03:00
|
|
|
@item Soft Wrapping Toggle (Meta-$)
|
|
|
|
toggles the -$ (@code{--softwrap}) command line option.
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@end table
|
|
|
|
|
2002-11-04 19:05:42 +03:00
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@node Nanorc Files, The File Browser, Feature Toggles, Top
|
|
|
|
@chapter Nanorc Files
|
|
|
|
|
|
|
|
The nanorc files contain the default settings for @code{nano}. They
|
|
|
|
should not be in DOS or Mac format. During startup, @code{nano} will
|
|
|
|
first read its system-wide settings from SYSCONFDIR/nanorc, and then
|
|
|
|
user-specific settings from ~/.nanorc.
|
|
|
|
|
|
|
|
A nanorc file accepts a series of "set" and "unset" commands, which can
|
|
|
|
be used to configure @code{nano} on startup without using the command
|
|
|
|
line options. Additionally, the "syntax", "color", and "icolor"
|
|
|
|
keywords are used to define syntax highlighting rules for different text
|
|
|
|
patterns. @code{nano} will read one command per line.
|
|
|
|
|
|
|
|
Options in nanorc files take precedence over @code{nano}'s defaults, and
|
|
|
|
command line options override nanorc settings. Options are also unset
|
|
|
|
by default, except for those that take arguments.
|
|
|
|
|
|
|
|
Quotes inside string parameters don't have to be escaped with
|
|
|
|
backslashes. The last double quote in the string will be treated as its
|
|
|
|
end. For example, for the "brackets" option,
|
|
|
|
|
|
|
|
@quotation
|
|
|
|
@code{""')>]@}"}
|
|
|
|
@end quotation
|
|
|
|
|
|
|
|
will match @code{"}, @code{'}, @code{)}, @code{>}, @code{]}, and
|
|
|
|
@code{@}}.
|
|
|
|
|
|
|
|
The supported commands and arguments are:
|
|
|
|
|
|
|
|
@table @code
|
|
|
|
|
2014-03-03 22:49:52 +04:00
|
|
|
@item set/unset allow_insecure_backup
|
|
|
|
When backing up files, allow the backup to succeed even if its
|
|
|
|
permissions can't be (re)set due to special OS considerations.
|
|
|
|
You should NOT enable this option unless you are sure you need it.
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@item set/unset autoindent
|
|
|
|
Use auto-indentation.
|
|
|
|
|
|
|
|
@item set/unset backup
|
|
|
|
Create backup files in "filename~".
|
|
|
|
|
|
|
|
@item set backupdir "directory"
|
|
|
|
Set the directory where @code{nano} puts unique backup files if file
|
|
|
|
backups are enabled.
|
|
|
|
|
|
|
|
@item set/unset backwards
|
|
|
|
Do backwards searches by default.
|
|
|
|
|
|
|
|
@item set/unset boldtext
|
|
|
|
Use bold text instead of reverse video text.
|
|
|
|
|
|
|
|
@item set brackets "string"
|
2006-05-23 20:23:10 +04:00
|
|
|
Set the characters treated as closing brackets when justifying
|
|
|
|
paragraphs. They cannot contain blank characters. Only closing
|
|
|
|
punctuation, optionally followed by closing brackets, can end sentences.
|
|
|
|
The default value is
|
2006-04-27 22:52:50 +04:00
|
|
|
|
|
|
|
@quotation
|
|
|
|
@code{""')>]@}"}
|
|
|
|
@end quotation
|
|
|
|
|
|
|
|
@item set/unset casesensitive
|
|
|
|
Do case sensitive searches by default.
|
|
|
|
|
|
|
|
@item set/unset const
|
|
|
|
Constantly display the cursor position in the status bar.
|
|
|
|
|
|
|
|
@item set/unset cut
|
2006-05-01 17:22:47 +04:00
|
|
|
Use cut to end of line by default, instead of cutting the whole line.
|
2006-04-27 22:52:50 +04:00
|
|
|
|
|
|
|
@item set fill "n"
|
|
|
|
Wrap lines at column number "n". If "n" is 0 or less, the maximum line
|
|
|
|
length will be the screen width less "n" columns. The default value is
|
|
|
|
-8.
|
|
|
|
|
|
|
|
@item set/unset historylog
|
|
|
|
Enable ~/.nano_history for saving and reading search/replace strings.
|
|
|
|
|
2014-03-03 22:49:52 +04:00
|
|
|
@ item set/unset locking
|
|
|
|
Enable vim-style lock-files for when editing files.
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@item set matchbrackets "string"
|
|
|
|
Set the opening and closing brackets that can be found by bracket
|
|
|
|
searches. They cannot contain blank characters. The former set must
|
|
|
|
come before the latter set, and both must be in the same order. The
|
|
|
|
default value is
|
|
|
|
|
|
|
|
@quotation
|
|
|
|
@code{"(<[@{)>]@}"}
|
|
|
|
@end quotation
|
|
|
|
|
|
|
|
@item set/unset morespace
|
2006-07-31 03:26:18 +04:00
|
|
|
Use the blank line below the titlebar as extra editing space.
|
2006-04-27 22:52:50 +04:00
|
|
|
|
|
|
|
@item set/unset mouse
|
2006-05-01 17:22:47 +04:00
|
|
|
Enable mouse support, so that mouse clicks can be used to place the
|
|
|
|
cursor, set the mark (with a double click), or execute shortcuts.
|
2006-04-27 22:52:50 +04:00
|
|
|
|
|
|
|
@item set/unset multibuffer
|
|
|
|
Allow inserting files into their own buffers.
|
|
|
|
|
|
|
|
@item set/unset noconvert
|
|
|
|
Don't convert files from DOS/Mac format.
|
|
|
|
|
|
|
|
@item set/unset nofollow
|
|
|
|
Don't follow symlinks when writing files.
|
|
|
|
|
|
|
|
@item set/unset nohelp
|
|
|
|
Don't display the help lists at the bottom of the screen.
|
|
|
|
|
|
|
|
@item set/unset nonewlines
|
|
|
|
Don't add newlines to the ends of files.
|
|
|
|
|
|
|
|
@item set/unset nowrap
|
|
|
|
Don't wrap text at all.
|
|
|
|
|
|
|
|
@item set operatingdir "directory"
|
|
|
|
@code{nano} will only read and write files inside "directory" and its
|
|
|
|
subdirectories. Also, the current directory is changed to here, so
|
2006-05-01 17:22:47 +04:00
|
|
|
files are inserted from this directory. By default, the operating
|
2006-04-27 22:52:50 +04:00
|
|
|
directory feature is turned off.
|
|
|
|
|
2014-03-03 22:49:52 +04:00
|
|
|
@item set/unset poslog
|
|
|
|
Save the cursor position of files between editing sessions.
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@item set/unset preserve
|
|
|
|
Preserve the XON and XOFF keys (^Q and ^S).
|
|
|
|
|
|
|
|
@item set punct "string"
|
2006-05-23 20:23:10 +04:00
|
|
|
Set the characters treated as closing punctuation when justifying
|
|
|
|
paragraphs. They cannot contain blank characters. Only closing
|
|
|
|
punctuation, optionally followed by closing brackets, can end sentences.
|
|
|
|
The default value is @code{"!.?"}.
|
2006-04-27 22:52:50 +04:00
|
|
|
|
|
|
|
@item set/unset quickblank
|
|
|
|
Do quick statusbar blanking. Statusbar messages will disappear after 1
|
|
|
|
keystroke instead of 25.
|
|
|
|
|
2014-03-03 22:49:52 +04:00
|
|
|
@item set/unset quiet
|
|
|
|
When set, @code{nano} will not report errors in the nanorc file nor ask them
|
|
|
|
to be acknowledged by pressing Enter at startup. If this option is used, it
|
|
|
|
should be placed at the top of the file to be fully effective.
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@item set quotestr "string"
|
|
|
|
The email-quote string, used to justify email-quoted paragraphs. This
|
|
|
|
is an extended regular expression if your system supports them,
|
|
|
|
otherwise a literal string. The default value is
|
|
|
|
|
|
|
|
@quotation
|
|
|
|
@code{"^([ \\t]*[#:>\\|@}])+"}
|
|
|
|
@end quotation
|
|
|
|
|
|
|
|
if you have extended regular expression support, or "> " otherwise.
|
|
|
|
Note that '\\t' stands for a literal Tab character.
|
|
|
|
|
|
|
|
@item set/unset rebinddelete
|
|
|
|
Interpret the Delete key differently so that both Backspace and Delete
|
|
|
|
work properly. You should only need to use this option if Backspace
|
|
|
|
acts like Delete on your system.
|
|
|
|
|
|
|
|
@item set/unset rebindkeypad
|
|
|
|
Interpret the numeric keypad keys so that they all work properly. You
|
|
|
|
should only need to use this option if they don't, as mouse support
|
|
|
|
won't work properly with this option enabled.
|
|
|
|
|
|
|
|
@item set/unset regexp
|
|
|
|
Do extended regular expression searches by default.
|
|
|
|
|
|
|
|
@item set/unset smarthome
|
|
|
|
Make the Home key smarter. When Home is pressed anywhere but at the
|
|
|
|
very beginning of non-whitespace characters on a line, the cursor will
|
|
|
|
jump to that beginning (either forwards or backwards). If the cursor is
|
|
|
|
already at that position, it will jump to the true beginning of the
|
|
|
|
line.
|
|
|
|
|
|
|
|
@item set/unset smooth
|
|
|
|
Use smooth scrolling by default.
|
|
|
|
|
2009-12-02 06:36:22 +03:00
|
|
|
@item set/unset softwrap
|
2014-03-03 22:49:52 +04:00
|
|
|
Enable soft line wrapping for easier viewing of very long lines.
|
2009-12-02 06:36:22 +03:00
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@item set speller "spellprog"
|
|
|
|
Use spelling checker "spellprog" instead of the built-in one, which
|
|
|
|
calls "spell".
|
|
|
|
|
|
|
|
@item set/unset suspend
|
|
|
|
Allow @code{nano} to be suspended.
|
|
|
|
|
|
|
|
@item set tabsize "n"
|
|
|
|
Use a tab size of "n" columns. The value of "n" must be greater than 0.
|
2006-05-14 19:38:54 +04:00
|
|
|
The default value is 8.
|
2006-04-27 22:52:50 +04:00
|
|
|
|
|
|
|
@item set/unset tabstospaces
|
|
|
|
Convert typed tabs to spaces.
|
|
|
|
|
|
|
|
@item set/unset tempfile
|
|
|
|
Save automatically on exit, don't prompt.
|
|
|
|
|
2009-12-02 06:36:22 +03:00
|
|
|
@item set/unset undo
|
|
|
|
Enable experimental generic-purpose undo code.
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@item set/unset view
|
|
|
|
Disallow file modification.
|
|
|
|
|
|
|
|
@item set whitespace "string"
|
|
|
|
Set the two characters used to display the first characters of tabs and
|
|
|
|
spaces. They must be single-column characters.
|
|
|
|
|
|
|
|
@item set/unset wordbounds
|
|
|
|
Detect word boundaries more accurately by treating punctuation
|
|
|
|
characters as part of a word.
|
|
|
|
|
2006-05-01 17:43:02 +04:00
|
|
|
@item syntax "str" ["fileregex" @dots{} ]
|
2006-04-27 22:52:50 +04:00
|
|
|
Defines a syntax named "str" which can be activated via the -Y/--syntax
|
|
|
|
command line option, or will be automatically activated if the current
|
|
|
|
filename matches the extended regular expression "fileregex". All
|
|
|
|
following "color" and "icolor" statements will apply to "syntax" until a
|
|
|
|
new syntax is defined.
|
|
|
|
|
|
|
|
The "none" syntax is reserved; specifying it on the command line is the
|
|
|
|
same as not having a syntax at all. The "default" syntax is special: it
|
|
|
|
takes no "fileregex", and applies to files that don't match any other
|
|
|
|
syntax's "fileregex".
|
|
|
|
|
2014-03-03 22:49:52 +04:00
|
|
|
@item linter program [arg @dots{} ]
|
|
|
|
For the currently defined syntax, use the given program to invoke the
|
|
|
|
linter (this overrides the speller function when defined).
|
|
|
|
|
|
|
|
@item magic ["regex" @dots{} ]
|
|
|
|
For the currently defined syntax, add one or more regexes which will be
|
|
|
|
compared against the magic database when attempting to determine which
|
|
|
|
highlighting rules to use for a given file. This functionality only works
|
|
|
|
when libmagic is installed on the system and will be silently ignored otherwise.
|
|
|
|
|
2006-05-01 17:43:02 +04:00
|
|
|
@item color fgcolor,bgcolor "regex" @dots{}
|
2006-04-27 22:52:50 +04:00
|
|
|
For the currently defined syntax, display all expressions matching the
|
|
|
|
extended regular expression "regex" with foreground color "fgcolor" and
|
|
|
|
background color "bgcolor", at least one of which must be specified.
|
|
|
|
Legal colors for foreground and background color are: white, black, red,
|
|
|
|
blue, green, yellow, magenta, and cyan. You may use the prefix "bright"
|
|
|
|
to force a stronger color highlight for the foreground. If your
|
|
|
|
terminal supports transparency, not specifying a "bgcolor" tells "nano"
|
|
|
|
to attempt to use a transparent background.
|
|
|
|
|
2006-05-01 17:43:02 +04:00
|
|
|
@item icolor fgcolor,bgcolor "regex" @dots{}
|
2006-04-27 22:52:50 +04:00
|
|
|
Same as above, except that the expression matching is case insensitive.
|
|
|
|
|
|
|
|
@item color fgcolor,bgcolor start="sr" end="er"
|
|
|
|
Display expressions which start with the extended regular expression
|
|
|
|
"sr" and end with the extended regular expression "er" with foreground
|
|
|
|
color "fgcolor" and background color "bgcolor", at least one of which
|
|
|
|
must be specified. This allows syntax highlighting to span multiple
|
|
|
|
lines. Note that all subsequent instances of "sr" after an initial "sr"
|
|
|
|
is found will be highlighted until the first instance of "er".
|
|
|
|
|
|
|
|
@item icolor fgcolor,bgcolor start="sr" end="er"
|
|
|
|
Same as above, except that the expression matching is case insensitive.
|
|
|
|
|
|
|
|
@item include "syntaxfile"
|
|
|
|
Read in self-contained color syntaxes from "syntaxfile". Note that
|
|
|
|
"syntaxfile" can only contain "syntax", "color", and "icolor" commands.
|
|
|
|
|
2014-03-03 22:49:52 +04:00
|
|
|
@item extendsyntax str directive [arg @dots{} ]
|
|
|
|
Extend the syntax previously defined as str to include new information.
|
|
|
|
Allows you to add a new color, icolor, magic, header, or linter directive
|
|
|
|
to an already defined syntax. Useful when you want to add to definitions
|
|
|
|
from the system-installed syntax definitions (which are normally not writable).
|
|
|
|
|
2006-04-27 22:52:50 +04:00
|
|
|
@end table
|
|
|
|
|
|
|
|
|
|
|
|
@node The File Browser, Pico Compatibility, Nanorc Files, Top
|
2001-02-12 06:48:53 +03:00
|
|
|
@chapter The File Browser
|
|
|
|
|
2001-05-05 21:45:54 +04:00
|
|
|
When reading or writing files, pressing ^T will invoke the file browser.
|
2002-06-29 02:45:14 +04:00
|
|
|
Here, one can navigate directories in a graphical manner in order to
|
|
|
|
find the desired file.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-04-20 19:45:24 +04:00
|
|
|
Basic movement in the file browser is accomplished with the arrow keys,
|
|
|
|
page up, and page down. More advanced movement is accomplished by
|
|
|
|
searching via ^W (or 'w') and changing directories via ^_ (or 'g'). 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 exits.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@node Pico Compatibility, Building and Configure Options, The File Browser, Top
|
|
|
|
@chapter Pico Compatibility
|
|
|
|
|
2003-01-13 05:56:29 +03:00
|
|
|
@code{nano} attempts to emulate Pico as closely as possible, but there
|
|
|
|
are certain differences between the editors:
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@table @code
|
2003-01-13 05:56:29 +03:00
|
|
|
@item Search and Replace History
|
2004-05-07 22:00:20 +04:00
|
|
|
As of version 1.1.99pre1 of @code{nano}, text entered as search or
|
|
|
|
replace strings will be stored and can be accessed with the up/down
|
|
|
|
arrow keys. Previously, @code{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
|
2005-11-11 20:04:17 +03:00
|
|
|
with Pico via the @code{-p} option, but recent versions of Pico use the
|
|
|
|
@code{-p} option to preserve the XON and XOFF sequences within the
|
2006-04-15 22:02:06 +04:00
|
|
|
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.
|
2003-01-13 05:56:29 +03:00
|
|
|
|
|
|
|
|
2006-04-15 22:02:06 +04:00
|
|
|
@item Writing, Appending, or Prepending Selected Text to Files
|
2006-04-20 18:33:36 +04:00
|
|
|
Text selected using the marking key (^^) can be written out, appended,
|
|
|
|
or prepended to a new or existing file using the WriteOut key (^O).
|
2003-01-13 05:56:29 +03:00
|
|
|
|
|
|
|
@item Toggles
|
2003-08-31 20:44:10 +04:00
|
|
|
Many options which alter the functionality of the program can be
|
|
|
|
"toggled" on or off using Meta key sequences, meaning the program does
|
|
|
|
not have to be restarted to turn a particular feature of the editor on
|
|
|
|
or off. Please see the internal help function (^G) for a list of what
|
2006-04-17 00:40:29 +04:00
|
|
|
functions can be toggled for a particular version of @code{nano}. See
|
|
|
|
@xref{Feature Toggles}, for more info.
|
2003-01-13 05:56:29 +03:00
|
|
|
|
|
|
|
@item Cursor Position Display
|
|
|
|
The output of the "Display Cursor Position" in @code{nano} displays
|
|
|
|
the given column position, as well as the row and total character
|
|
|
|
position of the cursor.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item Interactive Replace and Spell Checker
|
2006-05-01 17:22:47 +04:00
|
|
|
It is worth noting that @code{nano}'s replace function is interactive,
|
2006-10-27 07:07:49 +04:00
|
|
|
i.e. it does not stop after one search string is found and automatically
|
2006-05-01 17:22:47 +04:00
|
|
|
replace it. The @code{nano} implementation will pause at each search
|
2003-08-31 20:44:10 +04:00
|
|
|
string found and query whether to replace this instance or not. The
|
2006-05-01 17:22:47 +04:00
|
|
|
internal spell checker operates similarly. Note that there is no way to
|
2003-08-31 20:44:10 +04:00
|
|
|
force these functions to behave in the Pico fashion. As of version
|
2004-05-07 22:00:20 +04:00
|
|
|
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.
|
2001-02-12 06:48:53 +03:00
|
|
|
@end table
|
|
|
|
|
|
|
|
@node Building and Configure Options, , Pico Compatibility, Top
|
|
|
|
@chapter Building and Configure Options
|
|
|
|
|
2003-08-31 20:44:10 +04:00
|
|
|
Building @code{nano} from source is fairly straightforward if you are
|
|
|
|
familiar with compiling programs with autoconf support:
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2002-11-04 19:05:42 +03:00
|
|
|
@itemize @bullet
|
2005-03-27 08:30:33 +04:00
|
|
|
@item tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of
|
|
|
|
@code{nano})
|
2002-11-04 19:05:42 +03:00
|
|
|
@item cd nano-x.y.z/
|
|
|
|
@item ./configure
|
|
|
|
@item make
|
|
|
|
@item make install
|
|
|
|
@end itemize
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-01 17:22:47 +04:00
|
|
|
The possible options to @code{./configure} are:
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2006-05-01 17:22:47 +04:00
|
|
|
@table @code
|
2005-11-11 19:42:45 +03:00
|
|
|
|
2005-11-11 20:04:17 +03:00
|
|
|
@item --disable-browser
|
|
|
|
Disable the mini file browser when reading or writing files.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2014-04-06 00:56:10 +04:00
|
|
|
@item --disable-color
|
|
|
|
Disable support for syntax coloring of files using the nanorc file.
|
|
|
|
|
|
|
|
@item --disable-extra
|
|
|
|
Disable extra features. At the moment, this is just easter-egg-type
|
|
|
|
stuff.
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@item --disable-help
|
2005-11-11 20:04:17 +03:00
|
|
|
Disable the help function. Doing this makes the binary much smaller,
|
|
|
|
but makes it difficult for new users to learn more than very basic
|
|
|
|
things about using the editor.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
2005-11-11 20:04:17 +03:00
|
|
|
@item --disable-justify
|
|
|
|
Disable the justify and unjustify functions.
|
2002-11-04 19:05:42 +03:00
|
|
|
|
2014-04-13 23:44:30 +04:00
|
|
|
@item --disable-libmagic
|
|
|
|
Disable the use of the library of magic-number tests (for determining
|
|
|
|
the file type and thus which syntax to use for colouring -- often the
|
|
|
|
tests on filename extension and header line will be enough).
|
|
|
|
|
2002-11-04 19:05:42 +03:00
|
|
|
@item --disable-mouse
|
2014-04-06 00:56:10 +04:00
|
|
|
Disable all mouse functionality. This also eliminates the -m
|
|
|
|
command-line option, which enables the mouse functionality.
|
|
|
|
|
|
|
|
@item --disable-multibuffer
|
|
|
|
Disable support for opening multiple files at a time and switching
|
|
|
|
between them on the fly.
|
2005-11-11 20:04:17 +03:00
|
|
|
|
2014-04-14 00:50:20 +04:00
|
|
|
@item --disable-nanorc
|
|
|
|
Disable support for reading the nanorc files at startup. With such
|
|
|
|
support, you can store custom settings in a system-wide and a per-user
|
|
|
|
nanorc file rather than having to pass command-line options to get
|
|
|
|
the desired behavior. See @xref{Nanorc Files}, for more info.
|
|
|
|
|
2005-11-29 07:25:57 +03:00
|
|
|
@item --disable-operatingdir
|
2014-04-06 00:56:10 +04:00
|
|
|
Disable setting the operating directory. This also eliminates the -o
|
|
|
|
command-line option, which sets the operating directory.
|
2005-11-29 07:25:57 +03:00
|
|
|
|
2005-11-11 20:04:17 +03:00
|
|
|
@item --disable-speller
|
2014-04-06 00:56:10 +04:00
|
|
|
Disable use of the spell checker. This also eliminates the -s
|
|
|
|
command-line option, which allows specifying an alternate spell checker.
|
2005-11-11 20:04:17 +03:00
|
|
|
|
|
|
|
@item --disable-tabcomp
|
|
|
|
Disable the tab completion code when reading or writing files.
|
2002-11-04 19:05:42 +03:00
|
|
|
|
2005-11-29 07:25:57 +03:00
|
|
|
@item --disable-wrapping
|
2014-04-06 00:56:10 +04:00
|
|
|
Disable all long-line wrapping. This also eliminates the -w
|
|
|
|
command-line option, which enables long-line wrapping.
|
2001-02-12 06:48:53 +03:00
|
|
|
|
|
|
|
@item --enable-tiny
|
2002-11-04 19:05:42 +03:00
|
|
|
This option disables all the above. It also disables some of the larger
|
2014-04-06 00:56:10 +04:00
|
|
|
internals of the editor, like the marking code and the cut-to-end-of-line
|
|
|
|
code. It also disables the function toggles.
|
2005-11-11 20:04:17 +03:00
|
|
|
|
|
|
|
@item --enable-debug
|
|
|
|
Enable support for runtime debug output. This can get pretty messy, so
|
2014-04-06 00:56:10 +04:00
|
|
|
chances are you only want this feature when you're working on the nano source.
|
2005-11-11 19:42:45 +03:00
|
|
|
|
2005-11-11 20:04:17 +03:00
|
|
|
@item --disable-nls
|
|
|
|
Disables Native Language support. This will disable use of the
|
|
|
|
available GNU @code{nano} translations.
|
2005-11-11 19:42:45 +03:00
|
|
|
|
|
|
|
@item --disable-wrapping-as-root
|
2014-03-03 22:49:52 +04:00
|
|
|
Disable long-line wrapping by default when @code{nano} is run as root.
|
2001-10-03 16:45:22 +04:00
|
|
|
|
2005-11-11 19:42:45 +03:00
|
|
|
@item --enable-utf8
|
|
|
|
Enable support for reading and writing Unicode files. This will require
|
2007-12-18 18:55:48 +03:00
|
|
|
either a wide version of curses, or a UTF-8-enabled version of Slang.
|
2005-11-11 19:42:45 +03:00
|
|
|
|
2005-11-11 20:04:17 +03:00
|
|
|
@item --disable-utf8
|
2014-04-06 00:56:10 +04:00
|
|
|
Disable support for reading and writing Unicode files. Normally the
|
|
|
|
configure script auto-detects whether to enable UTF-8 support or not.
|
|
|
|
You can use this or the previous option to override that detection.
|
2005-11-11 20:04:17 +03:00
|
|
|
|
2007-12-18 18:55:48 +03:00
|
|
|
@item --with-slang
|
|
|
|
Compiling @code{nano} with Slang is supported, and will make the binary
|
|
|
|
notably smaller than if compiled with ncurses or other curses libraries.
|
|
|
|
|
2001-02-12 06:48:53 +03:00
|
|
|
@end table
|
|
|
|
|
|
|
|
@contents
|
|
|
|
@bye
|