| Server IP : 162.241.126.129 / Your IP : 18.222.179.96 Web Server : Apache System : Linux 162-241-126-129.cprapid.com 4.18.0-477.27.2.el8_8.x86_64 #1 SMP Fri Sep 29 08:21:01 EDT 2023 x86_64 User : rvway5nu4 ( 1018) PHP Version : 7.4.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/nano/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>nano</title>
<meta name="description" content="nano">
<meta name="keywords" content="nano">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="#Top" rel="start" title="Top">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="dir.html#Top" rel="up" title="(dir)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<h1 class="settitle" align="center">nano</h1>
<a name="Top"></a>
<a name="SEC_Top"></a>
<p>This manual documents the GNU <code>nano</code> editor, version 2.9.8.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Introduction" accesskey="1">Introduction</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Invoking" accesskey="2">Invoking</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Command_002dline-Options" accesskey="3">Command-line Options</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Editor-Basics" accesskey="4">Editor Basics</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Built_002din-Help" accesskey="5">Built-in Help</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Feature-Toggles" accesskey="6">Feature Toggles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Nanorc-Files" accesskey="7">Nanorc Files</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#The-File-Browser" accesskey="8">The File Browser</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Pico-Compatibility" accesskey="9">Pico Compatibility</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Building-and-Configure-Options">Building and Configure Options</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Introduction"></a>
<a name="Introduction-1"></a>
<h2 class="chapter">1 Introduction</h2>
<p>GNU <code>nano</code> is a small and friendly text editor. Besides basic text
editing, <code>nano</code> offers many extra features, such as an interactive
search-and-replace, undo/redo, syntax coloring, smooth scrolling,
auto-indentation, go-to-line-and-column-number, feature toggles,
file locking, backup files, and internationalization support.
</p>
<p>The original goal for <code>nano</code> was to be a complete bug-for-bug
emulation of Pico. But currently the goal is to be as compatible
as possible while offering a superset of Pico’s functionality.
See <a href="#Pico-Compatibility">Pico Compatibility</a> for more details on how <code>nano</code> and
Pico differ.
</p>
<p>Please report bugs via <a href="https://savannah.gnu.org/bugs/?group=nano">https://savannah.gnu.org/bugs/?group=nano</a>.
</p>
<hr>
<a name="Invoking"></a>
<a name="Invoking-1"></a>
<h2 class="chapter">2 Invoking</h2>
<p>The usual way to invoke <code>nano</code> is:
</p>
<div class="example">
<pre class="example"><code>nano [FILE]</code>
</pre></div>
<p>But it is also possible to specify one or more options (see the next
section), and to edit several files in a row. Additionally, the cursor
can be put on a specific line of a file by adding the line number
with a plus sign before the filename, and even in a specific column by
adding it with a comma. So a more complete command synopsis is:
</p>
<div class="example">
<pre class="example"><code>nano [OPTION]… [[+LINE[,COLUMN]|+,COLUMN] FILE]…</code>
</pre></div>
<p>Normally, however, you set your preferred options in a <samp>nanorc</samp>
file (see <a href="#Nanorc-Files">Nanorc Files</a>). And when using <code>set positionlog</code>
(making <code>nano</code> remember the cursor position when you close a file),
you will rarely need to specify a line number.
</p>
<p>As a special case: when instead of a filename a dash is given, <code>nano</code>
will read data from standard input. This means you can pipe the output of
a command straight into a buffer, and then edit it.
</p>
<hr>
<a name="Command_002dline-Options"></a>
<a name="Command_002dline-Options-1"></a>
<h2 class="chapter">3 Command-line Options</h2>
<p><code>nano</code> takes the following options from the command line:
</p>
<dl compact="compact">
<dt><samp>-A</samp></dt>
<dt><samp>--smarthome</samp></dt>
<dd><p>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.
</p>
</dd>
<dt><samp>-B</samp></dt>
<dt><samp>--backup</samp></dt>
<dd><p>When saving a file, back up the previous version of it, using the current
filename suffixed with a tilde (<code>~</code>).
</p>
</dd>
<dt><samp>-C <var>directory</var></samp></dt>
<dt><samp>--backupdir=<var>directory</var></samp></dt>
<dd><p>Make and keep not just one backup file, but make and keep a uniquely
numbered one every time a file is saved — when backups are enabled.
The uniquely numbered files are stored in the specified directory.
</p>
</dd>
<dt><samp>-D</samp></dt>
<dt><samp>--boldtext</samp></dt>
<dd><p>Use bold text instead of reverse video text.
</p>
</dd>
<dt><samp>-E</samp></dt>
<dt><samp>--tabstospaces</samp></dt>
<dd><p>Convert typed tabs to spaces.
</p>
</dd>
<dt><samp>-F</samp></dt>
<dt><samp>--multibuffer</samp></dt>
<dd><p>Read a file into a new buffer by default.
</p>
</dd>
<dt><samp>-G</samp></dt>
<dt><samp>--locking</samp></dt>
<dd><p>Enable vim-style file locking when editing files.
</p>
</dd>
<dt><samp>-H</samp></dt>
<dt><samp>--historylog</samp></dt>
<dd><p>Save the last hundred search strings and replacement strings and
executed commands, so they can be easily reused in later sessions.
</p>
</dd>
<dt><samp>-I</samp></dt>
<dt><samp>--ignorercfiles</samp></dt>
<dd><p>Don’t look at the system’s nanorc file nor at the user’s nanorc.
</p>
</dd>
<dt><samp>-K</samp></dt>
<dt><samp>--rebindkeypad</samp></dt>
<dd><p>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.
</p>
</dd>
<dt><samp>-L</samp></dt>
<dt><samp>--nonewlines</samp></dt>
<dd><p>Don’t automatically add a newline when a file does not end with one.
</p>
</dd>
<dt><samp>-M</samp></dt>
<dt><samp>--trimblanks</samp></dt>
<dd><p>Snip trailing whitespace from the wrapped line when automatic
hard-wrapping occurs or when text is justified.
</p>
</dd>
<dt><samp>-N</samp></dt>
<dt><samp>--noconvert</samp></dt>
<dd><p>Disable automatic conversion of files from DOS/Mac format.
</p>
</dd>
<dt><samp>-O</samp></dt>
<dt><samp>--morespace</samp></dt>
<dd><p>Use the blank line below the title bar as extra editing space.
</p>
</dd>
<dt><samp>-P</samp></dt>
<dt><samp>--positionlog</samp></dt>
<dd><p>For the 200 most recent files, log the last position of the cursor,
and place it at that position again upon reopening such a file.
</p>
</dd>
<dt><samp>-Q "<var>regex</var>"</samp></dt>
<dt><samp>--quotestr="<var>regex</var>"</samp></dt>
<dd><p>Set the regular expression for matching the quoting part of a line, used
when justifying. The default value is <tt>"^([ <!-- /@w -->\t]*([#:>|}]|//))+"</tt>.
Note that <code>\t</code> stands for a literal Tab character.
</p>
</dd>
<dt><samp>-R</samp></dt>
<dt><samp>--restricted</samp></dt>
<dd><p>Restricted mode: don’t read or write to any file not specified on the
command line; don’t read any nanorc files nor history files; don’t allow
suspending nor spell checking; don’t
allow a file to be appended to, prepended to, or saved under a different
name if it already has one; and don’t use backup files.
This restricted mode is also accessible by invoking <code>nano</code> with
any name beginning with <code>r</code> (e.g. <code>rnano</code>).
</p>
</dd>
<dt><samp>-S</samp></dt>
<dt><samp>--smooth</samp></dt>
<dd><p>Enable smooth scrolling. Text will scroll line-by-line, instead of the
usual chunk-by-chunk behavior.
</p>
</dd>
<dt><samp>-T <var>number</var></samp></dt>
<dt><samp>--tabsize=<var>number</var></samp></dt>
<dd><p>Set the displayed tab length to <var>number</var> columns. The value of
<var>number</var> must be greater than 0. The default value is <tt>8</tt>.
</p>
</dd>
<dt><samp>-U</samp></dt>
<dt><samp>--quickblank</samp></dt>
<dd><p>Do quick status-bar blanking: status-bar messages will disappear after 1
keystroke instead of 25. Note that option <samp>-c</samp>
(<samp>--constantshow</samp>) overrides this.
</p>
</dd>
<dt><samp>-V</samp></dt>
<dt><samp>--version</samp></dt>
<dd><p>Show the current version number and exit.
</p>
</dd>
<dt><samp>-W</samp></dt>
<dt><samp>--wordbounds</samp></dt>
<dd><p>Detect word boundaries differently by treating punctuation
characters as parts of words.
</p>
</dd>
<dt><samp>-X "<var>characters</var>"</samp></dt>
<dt><samp>--wordchars="<var>characters</var>"</samp></dt>
<dd><p>Specify which other characters (besides the normal alphanumeric ones)
should be considered as parts of words. This overrides option
<samp>-W</samp> (<samp>--wordbounds</samp>).
</p>
</dd>
<dt><samp>-Y <var>name</var></samp></dt>
<dt><samp>--syntax=<var>name</var></samp></dt>
<dd><p>Specify the syntax to be used for highlighting.
See <a href="#Syntax-Highlighting">Syntax Highlighting</a> for more info.
</p>
</dd>
<dt><samp>-a</samp></dt>
<dt><samp>--atblanks</samp></dt>
<dd><p>When doing soft line wrapping, wrap lines at whitespace
instead of always at the edge of the screen.
</p>
</dd>
<dt><samp>-c</samp></dt>
<dt><samp>--constantshow</samp></dt>
<dd><p>Constantly display the cursor position (line number, column number,
and character number) on the status bar.
Note that this overrides option <samp>-U</samp> (<samp>--quickblank</samp>).
</p>
</dd>
<dt><samp>-d</samp></dt>
<dt><samp>--rebinddelete</samp></dt>
<dd><p>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.
</p>
</dd>
<dt><samp>-g</samp></dt>
<dt><samp>--showcursor</samp></dt>
<dd><p>Make the cursor visible in the file browser, putting it on the
highlighted item. Useful for braille users.
</p>
</dd>
<dt><samp>-h</samp></dt>
<dt><samp>--help</samp></dt>
<dd><p>Show a summary of command-line options and exit.
</p>
</dd>
<dt><samp>-i</samp></dt>
<dt><samp>--autoindent</samp></dt>
<dd><p>Automatically indent a newly created line to the same number of tabs
and/or spaces as the previous line (or as the next line if the previous
line is the beginning of a paragraph).
</p>
</dd>
<dt><samp>-k</samp></dt>
<dt><samp>--cutfromcursor</samp></dt>
<dd><p>Make the ’Cut Text’ command (normally <kbd>^K</kbd>) cut from the current cursor
position to the end of the line, instead of cutting the entire line.
</p>
</dd>
<dt><samp>-l</samp></dt>
<dt><samp>--linenumbers</samp></dt>
<dd><p>Display line numbers to the left of the text area.
</p>
</dd>
<dt><samp>-m</samp></dt>
<dt><samp>--mouse</samp></dt>
<dd><p>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. Text can still be
selected through dragging by holding down the Shift key.
</p>
</dd>
<dt><samp>-n</samp></dt>
<dt><samp>--noread</samp></dt>
<dd><p>Treat any name given on the command line as a new file. This allows
<code>nano</code> 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</code> can be used as an editor in combination with for instance
<code>gpg</code> without having to write sensitive data to disk first.
</p>
</dd>
<dt><samp>-o <var>directory</var></samp></dt>
<dt><samp>--operatingdir=<var>directory</var></samp></dt>
<dd><p>Set the operating directory. This makes <code>nano</code> set up something
similar to a chroot.
</p>
</dd>
<dt><samp>-p</samp></dt>
<dt><samp>--preserve</samp></dt>
<dd><p>Preserve the <kbd>^Q</kbd> (XON) and <kbd>^S</kbd> (XOFF) sequences so data being
sent to the editor can be stopped and started.
</p>
</dd>
<dt><samp>-q</samp></dt>
<dt><samp>--quiet</samp></dt>
<dd><p>Obsolete option. Recognized but ignored.
</p>
</dd>
<dt><samp>-r <var>number</var></samp></dt>
<dt><samp>--fill=<var>number</var></samp></dt>
<dd><p>Hard-wrap lines at column <var>number</var> (by inserting a newline character).
If the given value is 0 or less, wrapping will occur at the width of
the screen minus the given amount, allowing the wrapping width to
vary along with the width of the screen if and when it is resized.
The default value is <tt>-8</tt>. This option conflicts with <samp>-w</samp>
(<samp>--nowrap</samp>); the last one given takes effect.
</p>
<a name="g_t_002d_002dspeller"></a></dd>
<dt><samp>-s <var>program</var></samp></dt>
<dt><samp>--speller=<var>program</var></samp></dt>
<dd><p>Use the given program to do spell checking and correcting. By default,
<code>nano</code> uses the command specified in the <code>SPELL</code> environment
variable. If <code>SPELL</code> is not set, and <samp>--speller</samp> is
not specified either, then <code>nano</code> uses its own interactive spell
corrector, which requires the GNU <code>spell</code> program to be installed.
</p>
</dd>
<dt><samp>-t</samp></dt>
<dt><samp>--tempfile</samp></dt>
<dd><p>Don’t ask whether to save a modified buffer when exiting with <kbd>^X</kbd>, but
assume yes. This option is useful when <code>nano</code> is used as the
composer of a mailer program.
</p>
</dd>
<dt><samp>-u</samp></dt>
<dt><samp>--unix</samp></dt>
<dd><p>Save a file by default in Unix format. This overrides nano’s
default behavior of saving a file in the format that it had.
(This option has no effect when you also use <samp>--noconvert</samp>.)
</p>
</dd>
<dt><samp>-v</samp></dt>
<dt><samp>--view</samp></dt>
<dd><p>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.
</p>
</dd>
<dt><samp>-w</samp></dt>
<dt><samp>--nowrap</samp></dt>
<dd><p>Don’t hard-wrap long lines at any length. This option conflicts with
<samp>-r</samp> (<samp>--fill</samp>); the last one given takes effect.
</p>
<a name="Expert-Mode"></a></dd>
<dt><samp>-x</samp></dt>
<dt><samp>--nohelp</samp></dt>
<dd><p>Expert Mode: don’t show the Shortcut List at the bottom of the screen.
This affects the location of the status bar as well, as in Expert Mode it
is located at the very bottom of the editor.
</p>
<p>Note: When accessing the help system, Expert Mode is temporarily
disabled to display the help-system navigation keys.
</p>
</dd>
<dt><samp>-y</samp></dt>
<dt><samp>--afterends</samp></dt>
<dd><p>Make Ctrl+Right stop at word ends instead of beginnings.
</p>
</dd>
<dt><samp>-z</samp></dt>
<dt><samp>--suspend</samp></dt>
<dd><p>Enable the ability to suspend <code>nano</code> using the system’s suspend
keystroke (usually <kbd>^Z</kbd>).
</p>
</dd>
<dt><samp>-$</samp></dt>
<dt><samp>--softwrap</samp></dt>
<dd><p>Enable ’soft wrapping’. This will make <code>nano</code> attempt to display the
entire contents of any line, even if it is longer than the screen width, by
continuing it over multiple screen lines. Since
<code>$</code> normally refers to a variable in the Unix shell, you should specify
this option last when using other options (e.g. <code>nano -wS$</code>) or pass it
separately (e.g. <code>nano -wS -$</code>).
</p>
</dd>
<dt><samp>-b</samp></dt>
<dt><samp>-e</samp></dt>
<dt><samp>-f</samp></dt>
<dt><samp>-j</samp></dt>
<dd><p>Ignored, for compatibility with Pico.
</p>
</dd>
</dl>
<hr>
<a name="Editor-Basics"></a>
<a name="Editor-Basics-1"></a>
<h2 class="chapter">4 Editor Basics</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Entering-Text" accesskey="1">Entering Text</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Commands" accesskey="2">Commands</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#The-Cutbuffer" accesskey="3">The Cutbuffer</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#The-Mark" accesskey="4">The Mark</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Screen-Layout" accesskey="5">Screen Layout</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Search-and-Replace" accesskey="6">Search and Replace</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Using-the-Mouse" accesskey="7">Using the Mouse</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Limitations" accesskey="8">Limitations</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Entering-Text"></a>
<a name="Entering-Text-1"></a>
<h3 class="section">4.1 Entering Text</h3>
<p><code>nano</code> is a "modeless" editor. This means that all keystrokes,
with the exception of Control and Meta sequences, enter text into the
file being edited.
</p>
<p>Characters not present on the keyboard can be entered in two ways:
</p>
<ul>
<li> For characters with a single-byte code,
pressing the Esc key twice and then typing a three-digit decimal number
(from <kbd>000</kbd> to <kbd>255</kbd>) will make <code>nano</code> behave as if you
typed the key with that value.
</li><li> For any possible character, pressing <kbd>M-V</kbd> (Alt+V) and then typing a
six-digit hexadecimal number (starting with <kbd>0</kbd> or <kbd>1</kbd>) will enter the
corresponding Unicode character into the buffer.
</li></ul>
<p>For example, typing <kbd>Esc Esc 2 3 4</kbd> will enter the character "ê" —
useful when writing about a French party. Typing <kbd>M-V 0 0 2 2 c 4</kbd>
will enter the symbol "⋄", a little diamond.
</p>
<hr>
<a name="Commands"></a>
<a name="Commands-1"></a>
<h3 class="section">4.2 Commands</h3>
<p>Commands are given by using the Control key (Ctrl, shown as <kbd>^</kbd>)
or the Meta key (Alt or Cmd, shown as <kbd>M-</kbd>).
</p>
<ul>
<li> A control-key sequence is entered by holding down the Ctrl key and
pressing the desired key.
</li><li> A meta-key sequence is entered by holding down the Meta key (normally
the Alt key) and pressing the desired key.
</li></ul>
<p>If for some reason on your system the combinations with Ctrl or Alt do
not work, you can generate them by using the Esc key. A control-key
sequence is generated by pressing the Esc key twice and then pressing
the desired key, and a meta-key sequence by pressing the Esc key once
and then pressing the desired key.
</p>
<hr>
<a name="The-Cutbuffer"></a>
<a name="The-Cutbuffer-1"></a>
<h3 class="section">4.3 The Cutbuffer</h3>
<p>Text can be cut from a file, a whole line at a time, by using the ’Cut Text’
command (default key binding: <kbd>^K</kbd>). The cut line is stored in
the cutbuffer. Consecutive strokes of <kbd>^K</kbd> will add each cut line
to this buffer, but a <kbd>^K</kbd>
after any other keystroke will overwrite the entire cutbuffer.
</p>
<p>The contents of the cutbuffer can be pasted back into the file with the
’Uncut Text’ command (default key binding: <kbd>^U</kbd>).
</p>
<p>A line of text can be copied into the cutbuffer (without cutting it) with
the ’Copy Text’ command (default key binding: <kbd>M-6</kbd>).
</p>
<hr>
<a name="The-Mark"></a>
<a name="The-Mark-1"></a>
<h3 class="section">4.4 The Mark</h3>
<p>Text can be selected by first ’setting the Mark’ (default key bindings:
<kbd>^6</kbd> and <kbd>M-A</kbd>) and then moving the cursor to the other end of the portion
to be selected. The selected portion of text will be highlighted.
This selection can now be cut or copied in its entirety with a single
<kbd>^K</kbd> or <kbd>M-6</kbd>. Or the selection can be used to limit the scope of
a search-and-replace (<kbd>^\</kbd>) or spell-checking session (<kbd>^T</kbd>).
</p>
<p>On some terminals, it is also possible to select text by holding down
<kbd>Shift</kbd> together with the cursor keys. Such a selection is cancelled
upon any cursor movement where <kbd>Shift</kbd> isn’t held.
</p>
<p>Cutting or copying selected text will toggle the mark off automatically.
If necessary, it can be toggled off manually with another <kbd>^6</kbd> or <kbd>M-A</kbd>.
</p>
<hr>
<a name="Screen-Layout"></a>
<a name="Screen-Layout-1"></a>
<h3 class="section">4.5 Screen Layout</h3>
<p>The default screen of nano consists of five areas. From top to bottom
these are: the title bar, a blank line, the edit window, the status bar,
and two help lines.
</p>
<p>The title bar consists of
three sections: left, center and right. The section on the left
displays the version of <code>nano</code> being used. The center section
displays the current filename, or "New Buffer" if the file has not yet
been named. The section on the right displays "Modified" if the
file has been modified since it was last saved or opened.
</p>
<p>The status bar is the third line from the bottom of the screen. It
shows important and informational messages. Any error messages that
occur from using the editor will appear on the status bar. Any questions
that are asked of the user will be asked on the status bar, and any user
input (search strings, filenames, etc.) will be input on the status bar.
</p>
<p>The two help lines at the bottom of the screen show some of the most
essential functions of the editor. These two lines are called the
Shortcut List.
</p>
<hr>
<a name="Search-and-Replace"></a>
<a name="Search-and-Replace-1"></a>
<h3 class="section">4.6 Search and Replace</h3>
<p>One can search the current buffer for the occurrence of any string
with the Search command (default key binding: <kbd>^W</kbd>). The default search
mode is forward, case-insensitive, and for literal strings. But one
can search backwards by pressing <kbd>M-B</kbd>, search case sensitively with <kbd>M-C</kbd>,
and interpret regular expressions in the search string with <kbd>M-R</kbd>.
</p>
<p>A regular expression in a search string always covers just one line;
it cannot span multiple lines. And when replacing (with <kbd>^\</kbd> or <kbd>M-R</kbd>)
the replacement string cannot contain a newline (LF).
</p>
<hr>
<a name="Using-the-Mouse"></a>
<a name="Using-the-Mouse-1"></a>
<h3 class="section">4.7 Using the Mouse</h3>
<p>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
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.
</p>
<p>The mouse will work in the X Window System, and on the console when gpm
is running.
</p>
<hr>
<a name="Limitations"></a>
<a name="Limitations-1"></a>
<h3 class="section">4.8 Limitations</h3>
<p>Justifications (<kbd>^J</kbd>)
are not yet covered by the general undo system. So after a justification
that is not immediately undone, earlier edits
cannot be undone any more. The workaround is, of course, to exit without
saving.
</p>
<p>The recording and playback of keyboard macros works correctly only on a
terminal emulator, not on a Linux console (VT), because the latter does
not by default distinguish modified from unmodified arrow keys.
</p>
<hr>
<a name="Built_002din-Help"></a>
<a name="Built_002din-Help-1"></a>
<h2 class="chapter">5 Built-in Help</h2>
<p>The built-in help system in <code>nano</code> is available by pressing <kbd>^G</kbd>.
It is fairly self-explanatory. It documents the various parts of the
editor and the available keystrokes. Navigation is via the <kbd>^Y</kbd> (Page Up)
and <kbd>^V</kbd> (Page Down) keys. <kbd>^X</kbd> exits from the help system.
</p>
<hr>
<a name="Feature-Toggles"></a>
<a name="Feature-Toggles-1"></a>
<h2 class="chapter">6 Feature Toggles</h2>
<p>Toggles allow you to change on-the-fly certain aspects of the editor
which would normally be specified via command-line options. They are
invoked via Meta-key sequences (see <a href="#Commands">Commands</a> for more info).
The following global toggles are available:
</p>
<dl compact="compact">
<dt><code>Backup Files</code></dt>
<dd><p><kbd>Meta-B</kbd> toggles the <samp>-B</samp> (<samp>--backup</samp>) command-line option.
</p>
</dd>
<dt><code>Constant Cursor Position Display</code></dt>
<dd><p><kbd>Meta-C</kbd> toggles the <samp>-c</samp> (<samp>--constantshow</samp>) command-line option.
</p>
</dd>
<dt><code>Multiple File Buffers</code></dt>
<dd><p><kbd>Meta-F</kbd> toggles the <samp>-F</samp> (<samp>--multibuffer</samp>) command-line option.
</p>
</dd>
<dt><code>Smart Home Key</code></dt>
<dd><p><kbd>Meta-H</kbd> toggles the <samp>-A</samp> (<samp>--smarthome</samp>) command-line option.
</p>
</dd>
<dt><code>Auto Indent</code></dt>
<dd><p><kbd>Meta-I</kbd> toggles the <samp>-i</samp> (<samp>--autoindent</samp>) command-line option.
</p>
</dd>
<dt><code>Cut From Cursor To End-of-Line</code></dt>
<dd><p><kbd>Meta-K</kbd> toggles the <samp>-k</samp> (<samp>--cutfromcursor</samp>) command-line option.
</p>
</dd>
<dt><code>Long-Line Wrapping</code></dt>
<dd><p><kbd>Meta-L</kbd> toggles the <samp>-w</samp> (<samp>--nowrap</samp>) command-line option.
</p>
</dd>
<dt><code>Mouse Support</code></dt>
<dd><p><kbd>Meta-M</kbd> toggles the <samp>-m</samp> (<samp>--mouse</samp>) command-line option.
</p>
</dd>
<dt><code>No Conversion From DOS/Mac Format</code></dt>
<dd><p><kbd>Meta-N</kbd> toggles the <samp>-N</samp> (<samp>--noconvert</samp>) command-line option.
</p>
</dd>
<dt><code>More Space For Editing</code></dt>
<dd><p><kbd>Meta-O</kbd> toggles the <samp>-O</samp> (<samp>--morespace</samp>) command-line option.
</p>
</dd>
<dt><code>Whitespace Display</code></dt>
<dd><p><kbd>Meta-P</kbd> toggles the displaying of whitespace (see <a href="#Whitespace">Whitespace</a>).
</p>
</dd>
<dt><code>Tabs To Spaces</code></dt>
<dd><p><kbd>Meta-Q</kbd> toggles the <samp>-E</samp> (<samp>--tabstospaces</samp>) command-line option.
</p>
</dd>
<dt><code>Smooth Scrolling</code></dt>
<dd><p><kbd>Meta-S</kbd> toggles the <samp>-S</samp> (<samp>--smooth</samp>) command-line option.
</p>
</dd>
<dt><code>Expert/No Help</code></dt>
<dd><p><kbd>Meta-X</kbd> toggles the <samp>-x</samp> (<samp>--nohelp</samp>) command-line option.
</p>
</dd>
<dt><code>Color Syntax Highlighting</code></dt>
<dd><p><kbd>Meta-Y</kbd> toggles color syntax highlighting (if your nanorc defines syntaxes
— see <a href="#Syntax-Highlighting">Syntax Highlighting</a>).
</p>
</dd>
<dt><code>Suspension</code></dt>
<dd><p><kbd>Meta-Z</kbd> toggles the <samp>-z</samp> (<samp>--suspend</samp>) command-line option.
</p>
</dd>
<dt><code>Line Numbers</code></dt>
<dd><p><kbd>Meta-#</kbd> toggles the <samp>-l</samp> (<samp>--linenumbers</samp>) command-line option.
</p>
</dd>
<dt><code>Soft Wrapping</code></dt>
<dd><p><kbd>Meta-$</kbd> toggles the <samp>-$</samp> (<samp>--softwrap</samp>) command-line option.
</p>
</dd>
</dl>
<hr>
<a name="Nanorc-Files"></a>
<a name="Nanorc-Files-1"></a>
<h2 class="chapter">7 Nanorc Files</h2>
<p>The nanorc files contain the default settings for <code>nano</code>. They
should be in Unix format, not in DOS or Mac format. During startup,
<code>nano</code> will first read the system-wide settings, from /etc/nanorc
(the exact path might be different), and then the user-specific settings,
either from <samp>~/.nanorc</samp> or from <samp>$XDG_CONFIG_HOME/nano/nanorc</samp>
or from <samp>.config/nano/nanorc</samp>, whichever exists first.
</p>
<p>A nanorc file accepts a series of "set" and "unset" commands, which can
be used to configure <code>nano</code> on startup without using command-line
options. Additionally, there are some commands to define syntax highlighting
and to rebind keys — see <a href="#Syntax-Highlighting">Syntax Highlighting</a> and <a href="#Rebinding-Keys">Rebinding Keys</a>.
<code>nano</code> will read one command per line.
</p>
<p>Options in nanorc files take precedence over <code>nano</code>’s defaults, and
command-line options override nanorc settings. Also, options that do not
take an argument are unset by default. So using the <code>unset</code> command
is only needed when wanting to override a setting of the system’s nanorc
file in your own nanorc. Options that take an argument cannot be unset.
</p>
<p>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 <code>brackets</code> option, <tt>""')>]}"</tt> will match
<code>"</code>, <code>'</code>, <code>)</code>, <code>></code>, <code>]</code>, and <code>}</code>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Settings" accesskey="1">Settings</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Syntax-Highlighting" accesskey="2">Syntax Highlighting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Rebinding-Keys" accesskey="3">Rebinding Keys</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Settings"></a>
<a name="Settings-1"></a>
<h3 class="section">7.1 Settings</h3>
<p>The supported settings in a nanorc file are:
</p>
<dl compact="compact">
<dt><code>set afterends</code></dt>
<dd><p>Make Ctrl+Right stop at word ends instead of beginnings.
</p>
</dd>
<dt><code>set allow_insecure_backup</code></dt>
<dd><p>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.
</p>
</dd>
<dt><code>set atblanks</code></dt>
<dd><p>When soft line wrapping is enabled, make it wrap lines at blank characters
(tabs and spaces) instead of always at the edge of the screen.
</p>
</dd>
<dt><code>set autoindent</code></dt>
<dd><p>Automatically indent a newly created line to the same number of tabs
and/or spaces as the previous line (or as the next line if the previous
line is the beginning of a paragraph).
</p>
</dd>
<dt><code>set backup</code></dt>
<dd><p>When saving a file, back up the previous version of it, using the current
filename suffixed with a tilde (<code>~</code>).
</p>
</dd>
<dt><code>set backupdir "<var>directory</var>"</code></dt>
<dd><p>Make and keep not just one backup file, but make and keep a uniquely
numbered one every time a file is saved — when backups are enabled
with <code>set backup</code> or <samp>--backup</samp> or <samp>-B</samp>.
The uniquely numbered files are stored in the specified directory.
</p>
</dd>
<dt><code>set backwards</code></dt>
<dd><p>Obsolete option. Recognized but ignored. <code>^Q</code> is available to
start a backward search.
</p>
</dd>
<dt><code>set boldtext</code></dt>
<dd><p>Use bold instead of reverse video for the title bar, status bar, key combos,
function tags, line numbers, and selected text. This can be overridden by
setting the options <code>titlecolor</code>, <code>statuscolor</code>, <code>keycolor</code>,
<code>functioncolor</code>, <code>numbercolor</code>, and <code>selectedcolor</code>.
</p>
</dd>
<dt><code>set brackets "<var>string</var>"</code></dt>
<dd><p>Set the characters treated as closing brackets when justifying
paragraphs. This may not include blank characters. Only closing
punctuation (see <code>set punct</code>), optionally followed by the specified
closing brackets, can end sentences. The default value is
<tt>""')>]}"</tt>.
</p>
</dd>
<dt><code>set casesensitive</code></dt>
<dd><p>Do case-sensitive searches by default.
</p>
</dd>
<dt><code>set constantshow</code></dt>
<dd><p>Constantly display the cursor position on the status bar.
Note that this overrides <samp>quickblank</samp>.
</p>
</dd>
<dt><code>set cutfromcursor</code></dt>
<dd><p>Use cut-from-cursor-to-end-of-line by default, instead of cutting the whole line.
(The old form of this option, <code>set cut</code>, is deprecated.)
</p>
</dd>
<dt><code>set errorcolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for the status bar when an error message is displayed.
See <a href="#set-functioncolor"><code>set functioncolor</code></a> for valid color names.
</p>
</dd>
<dt><code>set fill <var>number</var></code></dt>
<dd><p>Hard-wrap lines at column number <var>number</var>. If <var>number</var> is 0 or less,
the maximum line length will be the screen width less <var>number</var> columns.
The default value is <tt>-8</tt>. This option conflicts with
<samp>nowrap</samp>; the last one given takes effect.
</p>
<a name="set-functioncolor"></a></dd>
<dt><code>set functioncolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for the concise function descriptions
in the two help lines at the bottom of the screen.
Valid names for foreground and background color are:
<code>white</code>, <code>black</code>, <code>blue</code>, <code>green</code>,
<code>red</code>, <code>cyan</code>, <code>yellow</code>, <code>magenta</code>, and <code>normal</code>
— where <code>normal</code> means the default foreground or background color.
The name of the foreground color may be prefixed with <code>bright</code>.
And either <var>fgcolor</var> or ,<var>bgcolor</var> may be left out.
</p>
</dd>
<dt><code>set historylog</code></dt>
<dd><p>Save the last hundred search strings and replacement strings and
executed commands, so they can be easily reused in later sessions.
</p>
</dd>
<dt><code>set keycolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for the shortcut key combos
in the two help lines at the bottom of the screen.
See <a href="#set-functioncolor"><code>set functioncolor</code></a> for valid color names.
</p>
</dd>
<dt><code>set linenumbers</code></dt>
<dd><p>Display line numbers to the left of the text area.
</p>
</dd>
<dt><code>set locking</code></dt>
<dd><p>Enable vim-style lock-files for when editing files.
</p>
</dd>
<dt><code>set matchbrackets "<var>string</var>"</code></dt>
<dd><p>Set the opening and closing brackets that can be found by bracket
searches. This may not include blank characters. The opening set must
come before the closing set, and the two sets must be in the same order.
The default value is <tt>"(<[{)>]}"</tt>.
</p>
</dd>
<dt><code>set morespace</code></dt>
<dd><p>Use the blank line below the title bar as extra editing space.
</p>
</dd>
<dt><code>set mouse</code></dt>
<dd><p>Enable mouse support, so that mouse clicks can be used to place the
cursor, set the mark (with a double click), or execute shortcuts.
</p>
</dd>
<dt><code>set multibuffer</code></dt>
<dd><p>When reading in a file with <kbd>^R</kbd>, insert it into a new buffer by default.
</p>
</dd>
<dt><code>set noconvert</code></dt>
<dd><p>Don’t convert files from DOS/Mac format.
</p>
</dd>
<dt><code>set nohelp</code></dt>
<dd><p>Don’t display the help lists at the bottom of the screen.
</p>
</dd>
<dt><code>set nonewlines</code></dt>
<dd><p>When a file does not end with a newline, don’t automatically add one.
</p>
</dd>
<dt><code>set nopauses</code></dt>
<dd><p>Don’t pause between warnings at startup. This means that only
the last one will be visible (when there are multiple ones).
</p>
</dd>
<dt><code>set nowrap</code></dt>
<dd><p>Don’t hard-wrap text at all. This option conflicts with
<samp>fill</samp>; the last one given takes effect.
</p>
</dd>
<dt><code>set numbercolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for line numbers.
See <a href="#set-functioncolor"><code>set functioncolor</code></a> for valid color names.
</p>
</dd>
<dt><code>set operatingdir "<var>directory</var>"</code></dt>
<dd><p><code>nano</code> will only read and write files inside "directory" and its
subdirectories. Also, the current directory is changed to here, so
files are inserted from this directory. By default, the operating
directory feature is turned off.
</p>
</dd>
<dt><code>set positionlog</code></dt>
<dd><p>Save the cursor position of files between editing sessions.
The cursor position is remembered for the 200 most-recently edited files.
</p>
</dd>
<dt><code>set preserve</code></dt>
<dd><p>Preserve the XON and XOFF keys (<kbd>^Q</kbd> and <kbd>^S</kbd>).
</p>
</dd>
<dt><code>set punct "<var>string</var>"</code></dt>
<dd><p>Set the characters treated as closing punctuation when justifying
paragraphs. This may not include blank characters. Only the
specified closing punctuation, optionally followed by closing brackets
(see <code>set brackets</code>), can end sentences.
The default value is <tt>"!.?"</tt>.
</p>
</dd>
<dt><code>set quickblank</code></dt>
<dd><p>Do quick status-bar blanking: status-bar messages will disappear after 1
keystroke instead of 25. Note that <samp>constantshow</samp> overrides this.
</p>
</dd>
<dt><code>set quiet</code></dt>
<dd><p>Obsolete option. Recognized but ignored.
</p>
</dd>
<dt><code>set quotestr "<var>regex</var>"</code></dt>
<dd><p>The email-quote string, used to justify email-quoted paragraphs. This
is an extended regular expression. The default value is
<tt>"^([ <!-- /@w -->\t]*([#:>|}]|//))+"</tt>.
Note that <code>\t</code> stands for a literal Tab character.
</p>
</dd>
<dt><code>set rebinddelete</code></dt>
<dd><p>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.
</p>
</dd>
<dt><code>set rebindkeypad</code></dt>
<dd><p>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.
</p>
</dd>
<dt><code>set regexp</code></dt>
<dd><p>Do extended regular expression searches by default.
</p>
</dd>
<dt><code>set selectedcolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for selected text.
See <a href="#set-functioncolor"><code>set functioncolor</code></a> for valid color names.
</p>
</dd>
<dt><code>set showcursor</code></dt>
<dd><p>Put the cursor on the highlighted item in the file browser, to aid
braille users.
</p>
</dd>
<dt><code>set smarthome</code></dt>
<dd><p>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.
</p>
</dd>
<dt><code>set smooth</code></dt>
<dd><p>Use smooth scrolling by default.
</p>
</dd>
<dt><code>set softwrap</code></dt>
<dd><p>Enable soft line wrapping for easier viewing of very long lines.
</p>
</dd>
<dt><code>set speller "<var>program</var>"</code></dt>
<dd><p>Use the given program to do spell checking and correcting.
See <a href="#g_t_002d_002dspeller"><samp>--speller</samp></a> for details.
</p>
</dd>
<dt><code>set statuscolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for the status bar.
See <a href="#set-functioncolor"><code>set functioncolor</code></a> for valid color names.
</p>
</dd>
<dt><code>set suspend</code></dt>
<dd><p>Allow <code>nano</code> to be suspended.
</p>
</dd>
<dt><code>set tabsize <var>number</var></code></dt>
<dd><p>Use a tab size of <var>number</var> columns. The value of <var>number</var> must be
greater than 0. The default value is <tt>8</tt>.
</p>
</dd>
<dt><code>set tabstospaces</code></dt>
<dd><p>Convert typed tabs to spaces.
</p>
</dd>
<dt><code>set tempfile</code></dt>
<dd><p>Save automatically on exit, don’t prompt.
</p>
</dd>
<dt><code>set titlecolor <var>fgcolor</var>,<var>bgcolor</var></code></dt>
<dd><p>Use this color combination for the title bar.
See <a href="#set-functioncolor"><code>set functioncolor</code></a> for valid color names.
</p>
</dd>
<dt><code>set trimblanks</code></dt>
<dd><p>Remove trailing whitespace from wrapped lines when automatic
hard-wrapping occurs or when text is justified.
(The old form of this option, <code>set justifytrim</code>, is deprecated.)
</p>
</dd>
<dt><code>set unix</code></dt>
<dd><p>Save a file by default in Unix format. This overrides nano’s
default behavior of saving a file in the format that it had.
(This option has no effect when you also use <code>set noconvert</code>.)
</p>
</dd>
<dt><code>set view</code></dt>
<dd><p>Disallow file modification.
</p>
<a name="Whitespace"></a></dd>
<dt><code>set whitespace "<var>string</var>"</code></dt>
<dd><p>Set the two characters used to indicate the presence of tabs and
spaces. They must be single-column characters. The default pair
for a UTF-8 locale is <tt>"»·"</tt>, and for other locales <tt>">."</tt>.
</p>
</dd>
<dt><code>set wordbounds</code></dt>
<dd><p>Detect word boundaries differently by treating punctuation
characters as part of a word.
</p>
</dd>
<dt><code>set wordchars "<var>string</var>"</code></dt>
<dd><p>Specify which other characters (besides the normal alphanumeric ones)
should be considered as parts of words. This overrides the option
<code>wordbounds</code>.
</p>
</dd>
</dl>
<hr>
<a name="Syntax-Highlighting"></a>
<a name="Syntax-Highlighting-1"></a>
<h3 class="section">7.2 Syntax Highlighting</h3>
<p>Coloring the different syntactic elements of a file
is done via regular expressions (see the <code>color</code> command below).
This is inherently imperfect, because regular expressions are not
powerful enough to fully parse a file. Nevertheless, regular
expressions can do a lot and are easy to make, so they are a
good fit for a small editor like <code>nano</code>.
</p>
<p>A separate syntax can be defined for each kind of file
via the following commands in a nanorc file:
</p>
<dl compact="compact">
<dt><code>syntax <var>name</var> ["<var>fileregex</var>" …]</code></dt>
<dd><p>Start the definition of a syntax with this <var>name</var>.
All subsequent <code>color</code> and other such commands
will be added to this syntax, until a new <code>syntax</code>
command is encountered.
</p>
<p>When <code>nano</code> is run, this syntax will be automatically
activated if the current filename matches the extended regular
expression <var>fileregex</var>. Or the syntax can be explicitly
activated by using the <samp>-Y</samp> or <samp>--syntax</samp>
command-line option followed by the <var>name</var>.
</p>
<p>The <code>default</code> syntax is special: it takes no <var>fileregex</var>,
and applies to files that don’t match any syntax’s <var>fileregex</var>.
The <code>none</code> syntax is reserved; specifying it on the
command line is the same as not having a syntax at all.
</p>
</dd>
<dt><code>header "<var>regex</var>" …</code></dt>
<dd><p>If from all defined syntaxes no <var>fileregex</var> matched, then compare
this <var>regex</var> (or regexes) against the first line of the current file,
to determine whether this syntax should be used for it.
</p>
</dd>
<dt><code>magic "<var>regex</var>" …</code></dt>
<dd><p>If no <var>fileregex</var> matched and no <code>header</code> regex matched
either, then compare this <var>regex</var> (or regexes) against the
result of querying the <code>magic</code> database about the current
file, to determine whether this syntax should be used for it.
(This functionality only works when <code>libmagic</code> is installed
on the system and will be silently ignored otherwise.)
</p>
</dd>
<dt><code>linter <var>program</var> [<var>arg</var> …]</code></dt>
<dd><p>Use the given <var>program</var> to do a syntax check on the current buffer.
(This overrides the speller function.)
</p>
</dd>
<dt><code>formatter <var>program</var> [<var>arg</var> …]</code></dt>
<dd><p>Use the given <var>program</var> to automatically reformat the text in
the current buffer — useful for a programming language like Go.
(This overrides the speller and linter functions.)
</p>
</dd>
<dt><code>comment "<var>string</var>"</code></dt>
<dd><p>Use the given string for commenting and uncommenting lines.
If the string contains a vertical bar or pipe character (<tt>|</tt>),
this designates bracket-style comments; for example, <tt>"/*|*/"</tt> for
CSS files. The characters before the pipe are prepended to the line and the
characters after the pipe are appended at the end of the line. If no pipe
character is present, the full string is prepended; for example, <tt>"#"</tt> for
Python files. If empty double quotes are specified, the comment/uncomment
functions are disabled; for example, <tt>""</tt> for JSON.
The default value is <tt>"#"</tt>.
</p>
</dd>
<dt><code>color <var>fgcolor</var>,<var>bgcolor</var> "<var>regex</var>" …</code></dt>
<dd><p>Display all pieces of text that match the
extended regular expression "regex" with foreground color "fgcolor" and
background color "bgcolor", at least one of which must be specified.
Valid colors for foreground and background are: white, black, red,
blue, green, yellow, magenta, and cyan. You may use the prefix "bright"
to get a stronger color highlight for the foreground. If your
terminal supports transparency, not specifying a "bgcolor" tells <code>nano</code>
to attempt to use a transparent background.
</p>
</dd>
<dt><code>icolor <var>fgcolor</var>,<var>bgcolor</var> "<var>regex</var>" …</code></dt>
<dd><p>Same as above, except that the matching is case insensitive.
</p>
</dd>
<dt><code>color <var>fgcolor</var>,<var>bgcolor</var> start="<var>fromrx</var>" end="<var>torx</var>"</code></dt>
<dd><p>Display all pieces of text whose start matches extended regular expression
"fromrx" and whose end matches extended regular expression "torx" with
foreground color "fgcolor" and background color "bgcolor", at least one of
which must be specified. This means that, after an initial instance of
"fromrx", all text until the first instance of "torx" will be colored.
This allows syntax highlighting to span multiple lines.
</p>
</dd>
<dt><code>icolor <var>fgcolor</var>,<var>bgcolor</var> start="<var>fromrx</var>" end="<var>torx</var>"</code></dt>
<dd><p>Same as above, except that the matching is case insensitive.
</p>
</dd>
<dt><code>include "<var>syntaxfile</var>"</code></dt>
<dd><p>Read in self-contained color syntaxes from "syntaxfile". Note that
"syntaxfile" may contain only the above commands, from <code>syntax</code>
to <code>icolor</code>.
</p>
</dd>
<dt><code>extendsyntax <var>name</var> <var>command</var> [<var>arg</var> …]</code></dt>
<dd><p>Extend the syntax previously defined as "<var>name</var>" with another <var>command</var>.
This allows you to add a new <code>color</code>, <code>icolor</code>, <code>header</code>,
<code>magic</code>, <code>comment</code>, <code>linter</code>, or <code>formatter</code> command
to an already
defined syntax — useful when you want to slightly improve a syntax defined
in one of the system-installed files (which normally are not writable).
</p>
</dd>
</dl>
<hr>
<a name="Rebinding-Keys"></a>
<a name="Rebinding-Keys-1"></a>
<h3 class="section">7.3 Rebinding Keys</h3>
<p>Key bindings can be changed via the following three commands in a
nanorc file:
</p>
<dl compact="compact">
<dt><code>bind key function menu</code></dt>
<dd><p>Rebinds <code>key</code> to <code>function</code> in the context of <code>menu</code>
(or in all menus where the function exists by using <code>all</code>).
</p>
</dd>
<dt><code>bind key "string" menu</code></dt>
<dd><p>Makes <code>key</code> produce <code>string</code> in the context of <code>menu</code>
(or in all menus where the key exists when <code>all</code> is used).
The <code>string</code> can consist of text or commands or a mix of them.
(To enter a command into the <code>string</code>, precede its keystroke
with <kbd>M-V</kbd>.)
</p>
</dd>
<dt><code>unbind key menu</code></dt>
<dd><p>Unbinds <code>key</code> from <code>menu</code>
(or from all menus where it exists by using <code>all</code>).
</p>
</dd>
</dl>
<br>
<p>The format of <code>key</code> should be one of:
</p>
<ul class="no-bullet">
<li><!-- /@w --> <code>^</code> followed by an ASCII character or the word "Space".
Example: <code>^C</code>.
</li><li><!-- /@w --> <code>M-</code> followed by a ASCII character or the word "Space".
Example: <code>M-C</code>.
</li><li><!-- /@w --> <code>F</code> followed by a numeric value from 1 to 16.
Example: <code>F10</code>.
</li></ul>
<br>
<p>Valid names for the <code>function</code> to be bound are:
</p>
<dl compact="compact">
<dt><code>help</code></dt>
<dd><p>Invokes the help viewer.
</p>
</dd>
<dt><code>cancel</code></dt>
<dd><p>Cancels the current command.
</p>
</dd>
<dt><code>exit</code></dt>
<dd><p>Exits from the program (or from the help viewer or the file browser).
</p>
</dd>
<dt><code>writeout</code></dt>
<dd><p>Writes the current buffer to disk, asking for a name.
</p>
</dd>
<dt><code>savefile</code></dt>
<dd><p>Writes the current file to disk without prompting.
</p>
</dd>
<dt><code>insert</code></dt>
<dd><p>Inserts a file into the current buffer (at the current cursor position),
or into a new buffer when option <code>multibuffer</code> is set.
</p>
</dd>
<dt><code>whereis</code></dt>
<dd><p>Starts a forward search for text in the current buffer — or for filenames
matching a string in the current list in the file browser.
</p>
</dd>
<dt><code>wherewas</code></dt>
<dd><p>Starts a backward search for text in the current buffer.
</p>
</dd>
<dt><code>searchagain</code></dt>
<dd><p>Repeats the last search command without prompting.
</p>
</dd>
<dt><code>findprevious</code></dt>
<dd><p>As <code>searchagain</code>, but always in the backward direction.
</p>
</dd>
<dt><code>findnext</code></dt>
<dd><p>As <code>searchagain</code>, but always in the forward direction.
</p>
</dd>
<dt><code>replace</code></dt>
<dd><p>Interactively replaces text within the current buffer.
</p>
</dd>
<dt><code>cut</code></dt>
<dd><p>Cuts and stores the current line (or the marked region).
</p>
</dd>
<dt><code>copytext</code></dt>
<dd><p>Copies the current line (or the marked region) without deleting it.
</p>
</dd>
<dt><code>uncut</code></dt>
<dd><p>Copies the currently stored text into the current buffer at the
current cursor position.
</p>
</dd>
<dt><code>mark</code></dt>
<dd><p>Sets the mark at the current position, to start selecting text.
</p>
</dd>
<dt><code>cutwordleft</code></dt>
<dd><p>Cuts from the cursor position to the beginning of the preceding word.
</p>
</dd>
<dt><code>cutwordright</code></dt>
<dd><p>Cuts from the cursor position to the beginning of the next word.
</p>
</dd>
<dt><code>cutrestoffile</code></dt>
<dd><p>Cuts all text from the cursor position till the end of the buffer.
</p>
</dd>
<dt><code>curpos</code></dt>
<dd><p>Shows the current cursor position: the line, column, and character positions.
</p>
</dd>
<dt><code>wordcount</code></dt>
<dd><p>Counts the number of words, lines and characters in the current buffer.
</p>
</dd>
<dt><code>speller</code></dt>
<dd><p>Invokes a spell-checking program (or linting program, or formatter program,
if the active syntax defines such a thing).
</p>
</dd>
<dt><code>justify</code></dt>
<dd><p>Justifies the current paragraph. A paragraph is a group of contiguous lines
that, apart from possibly the first line, all have the same indentation. The
beginning of a paragraph is detected by either this lone line with a differing
indentation or by a preceding blank line.
</p>
</dd>
<dt><code>fulljustify</code></dt>
<dd><p>Justifies the entire current buffer.
</p>
</dd>
<dt><code>indent</code></dt>
<dd><p>Indents (shifts to the right) the currently marked text.
</p>
</dd>
<dt><code>unindent</code></dt>
<dd><p>Unindents (shifts to the left) the currently marked text.
</p>
</dd>
<dt><code>comment</code></dt>
<dd><p>Comments or uncomments the current line or marked lines, using the comment
style specified in the active syntax.
</p>
</dd>
<dt><code>complete</code></dt>
<dd><p>Completes the fragment before the cursor to a full word found elsewhere
in the current buffer.
</p>
</dd>
<dt><code>left</code></dt>
<dd><p>Goes left one position (in the editor or browser).
</p>
</dd>
<dt><code>right</code></dt>
<dd><p>Goes right one position (in the editor or browser).
</p>
</dd>
<dt><code>up</code></dt>
<dd><p>Goes one line up (in the editor or browser).
</p>
</dd>
<dt><code>down</code></dt>
<dd><p>Goes one line down (in the editor or browser).
</p>
</dd>
<dt><code>scrollup</code></dt>
<dd><p>Scrolls the viewport up one row (meaning that the text slides down)
while keeping the cursor in the same text position, if possible.
</p>
</dd>
<dt><code>scrolldown</code></dt>
<dd><p>Scrolls the viewport down one row (meaning that the text slides up)
while keeping the cursor in the same text position, if possible.
</p>
</dd>
<dt><code>prevword</code></dt>
<dd><p>Moves the cursor to the beginning of the previous word.
</p>
</dd>
<dt><code>nextword</code></dt>
<dd><p>Moves the cursor to the beginning of the next word.
</p>
</dd>
<dt><code>home</code></dt>
<dd><p>Moves the cursor to the beginning of the current line.
</p>
</dd>
<dt><code>end</code></dt>
<dd><p>Moves the cursor to the end of the current line.
</p>
</dd>
<dt><code>beginpara</code></dt>
<dd><p>Moves the cursor to the beginning of the current paragraph.
</p>
</dd>
<dt><code>endpara</code></dt>
<dd><p>Moves the cursor to the end of the current paragraph.
</p>
</dd>
<dt><code>prevblock</code></dt>
<dd><p>Moves the cursor to the beginning of the current or preceding block of text.
(Blocks are separated by one or more blank lines.)
</p>
</dd>
<dt><code>nextblock</code></dt>
<dd><p>Moves the cursor to the beginning of the next block of text.
</p>
</dd>
<dt><code>pageup</code></dt>
<dd><p>Goes up one screenful.
</p>
</dd>
<dt><code>pagedown</code></dt>
<dd><p>Goes down one screenful.
</p>
</dd>
<dt><code>firstline</code></dt>
<dd><p>Goes to the first line of the file.
</p>
</dd>
<dt><code>lastline</code></dt>
<dd><p>Goes to the last line of the file.
</p>
</dd>
<dt><code>gotoline</code></dt>
<dd><p>Goes to a specific line (and column if specified). Negative numbers count
from the end of the file (and end of the line).
</p>
</dd>
<dt><code>findbracket</code></dt>
<dd><p>Moves the cursor to the bracket (brace, parenthesis, etc.) that matches
(pairs) with the one under the cursor.
</p>
</dd>
<dt><code>prevbuf</code></dt>
<dd><p>Switches to editing/viewing the previous buffer when multiple buffers are open.
</p>
</dd>
<dt><code>nextbuf</code></dt>
<dd><p>Switches to editing/viewing the next buffer when multiple buffers are open.
</p>
</dd>
<dt><code>verbatim</code></dt>
<dd><p>Inserts the next keystroke verbatim into the file.
</p>
</dd>
<dt><code>tab</code></dt>
<dd><p>Inserts a tab at the current cursor location.
</p>
</dd>
<dt><code>enter</code></dt>
<dd><p>Inserts a new line below the current one.
</p>
</dd>
<dt><code>delete</code></dt>
<dd><p>Deletes the character under the cursor.
</p>
</dd>
<dt><code>backspace</code></dt>
<dd><p>Deletes the character before the cursor.
</p>
</dd>
<dt><code>recordmacro</code></dt>
<dd><p>Starts the recording of keystrokes — the keystrokes are stored
as a macro. When already recording, the recording is stopped.
</p>
</dd>
<dt><code>runmacro</code></dt>
<dd><p>Replays the keystrokes of the last recorded macro.
</p>
</dd>
<dt><code>undo</code></dt>
<dd><p>Undoes the last performed text action (add text, delete text, etc).
</p>
</dd>
<dt><code>redo</code></dt>
<dd><p>Redoes the last undone action (i.e., it undoes an undo).
</p>
</dd>
<dt><code>refresh</code></dt>
<dd><p>Refreshes the screen.
</p>
</dd>
<dt><code>suspend</code></dt>
<dd><p>Suspends the editor (if the suspending function is enabled, see the
"suspendenable" entry below).
</p>
</dd>
<dt><code>casesens</code></dt>
<dd><p>Toggles case sensitivity in searching (search/replace menus only).
</p>
</dd>
<dt><code>regexp</code></dt>
<dd><p>Toggles whether searching/replacing is based on literal strings or regular expressions.
</p>
</dd>
<dt><code>backwards</code></dt>
<dd><p>Toggles whether searching/replacing goes forward or backward.
</p>
</dd>
<dt><code>prevhistory</code></dt>
<dd><p>Shows the previous history entry in the prompt menus (e.g. search).
</p>
</dd>
<dt><code>nexthistory</code></dt>
<dd><p>Shows the next history entry in the prompt menus (e.g. search).
</p>
</dd>
<dt><code>flipreplace</code></dt>
<dd><p>Toggles between searching for something and replacing something.
</p>
</dd>
<dt><code>flipgoto</code></dt>
<dd><p>Toggles between searching for text and targeting a line number.
(The form <code>gototext</code> is deprecated.)
</p>
</dd>
<dt><code>flipexecute</code></dt>
<dd><p>Toggles between inserting a file and executing a command.
</p>
</dd>
<dt><code>flippipe</code></dt>
<dd><p>When executing a command, toggles whether the current buffer (or marked
region) is piped to the command.
</p>
</dd>
<dt><code>flipnewbuffer</code></dt>
<dd><p>Toggles between inserting into the current buffer and into a new
empty buffer.
</p>
</dd>
<dt><code>dosformat</code></dt>
<dd><p>When writing a file, switches to writing a DOS format (CR/LF).
</p>
</dd>
<dt><code>macformat</code></dt>
<dd><p>When writing a file, switches to writing a Mac format.
</p>
</dd>
<dt><code>append</code></dt>
<dd><p>When writing a file, appends to the end instead of overwriting.
</p>
</dd>
<dt><code>prepend</code></dt>
<dd><p>When writing a file, ’prepends’ (writes at the beginning) instead of overwriting.
</p>
</dd>
<dt><code>backup</code></dt>
<dd><p>When writing a file, creates a backup of the current file.
</p>
</dd>
<dt><code>discardbuffer</code></dt>
<dd><p>When about to write a file, discard the current buffer without saving.
(This function is bound by default only when option <samp>--tempfile</samp>
is in effect.)
</p>
</dd>
<dt><code>browser</code></dt>
<dd><p>Starts the file browser, allowing to select a file from a list.
</p>
</dd>
<dt><code>gotodir</code></dt>
<dd><p>Goes to a directory to be specified, allowing to browse anywhere
in the filesystem.
</p>
</dd>
<dt><code>firstfile</code></dt>
<dd><p>Goes to the first file when using the file browser (reading or writing files).
</p>
</dd>
<dt><code>lastfile</code></dt>
<dd><p>Goes to the last file when using the file browser (reading or writing files).
</p>
</dd>
<dt><code>nohelp</code></dt>
<dd><p>Toggles the presence of the two-line list of key bindings at the bottom of the screen.
</p>
</dd>
<dt><code>constantshow</code></dt>
<dd><p>Toggles the constant display of the current line, column, and character positions.
(The form <code>constupdate</code> is deprecated.)
</p>
</dd>
<dt><code>morespace</code></dt>
<dd><p>Toggles the presence of the blank line that ’separates’ the title bar from the file text.
</p>
</dd>
<dt><code>smoothscroll</code></dt>
<dd><p>Toggles smooth scrolling (when moving around with the arrow keys).
</p>
</dd>
<dt><code>softwrap</code></dt>
<dd><p>Toggles the displaying of overlong lines on multiple screen lines.
</p>
</dd>
<dt><code>linenumbers</code></dt>
<dd><p>Toggles the display of line numbers in front of the text.
</p>
</dd>
<dt><code>whitespacedisplay</code></dt>
<dd><p>Toggles the showing of whitespace.
</p>
</dd>
<dt><code>nosyntax</code></dt>
<dd><p>Toggles syntax highlighting.
</p>
</dd>
<dt><code>smarthome</code></dt>
<dd><p>Toggles the smartness of the Home key.
</p>
</dd>
<dt><code>autoindent</code></dt>
<dd><p>Toggles whether a newly created line will contain the same amount of leading
whitespace as the preceding line — or as the next line if the preceding line
is the beginning of a paragraph.
</p>
</dd>
<dt><code>cutfromcursor</code></dt>
<dd><p>Toggles whether cutting text will cut the whole line or just from the current cursor
position to the end of the line.
(The form <code>cuttoend</code> is deprecated.)
</p>
</dd>
<dt><code>nowrap</code></dt>
<dd><p>Toggles whether long lines will be hard-wrapped to the next line.
</p>
</dd>
<dt><code>tabstospaces</code></dt>
<dd><p>Toggles whether typed tabs will be converted to spaces.
</p>
</dd>
<dt><code>backupfile</code></dt>
<dd><p>Toggles whether a backup will be made of the file to be edited.
</p>
</dd>
<dt><code>multibuffer</code></dt>
<dd><p>Toggles whether a file is inserted into the current buffer
or read into a new buffer.
</p>
</dd>
<dt><code>mouse</code></dt>
<dd><p>Toggles mouse support.
</p>
</dd>
<dt><code>noconvert</code></dt>
<dd><p>Toggles automatic conversion of files from DOS/Mac format.
</p>
</dd>
<dt><code>suspendenable</code></dt>
<dd><p>Toggles whether the suspend shortcut (normally <kbd>^Z</kbd>) will suspend the editor.
</p>
</dd>
</dl>
<br>
<p>Valid names for <code>menu</code> are:
</p>
<dl compact="compact">
<dt><code>main</code></dt>
<dd><p>The main editor window where text is entered and edited.
</p>
</dd>
<dt><code>search</code></dt>
<dd><p>The search menu (AKA whereis).
</p>
</dd>
<dt><code>replace</code></dt>
<dd><p>The ’search to replace’ menu.
</p>
</dd>
<dt><code>replacewith</code></dt>
<dd><p>The ’replace with’ menu, which comes up after ’search to replace’.
</p>
</dd>
<dt><code>gotoline</code></dt>
<dd><p>The ’goto line (and column)’ menu.
</p>
</dd>
<dt><code>writeout</code></dt>
<dd><p>The ’write file’ menu.
</p>
</dd>
<dt><code>insert</code></dt>
<dd><p>The ’insert file’ menu.
</p>
</dd>
<dt><code>extcmd</code></dt>
<dd><p>The menu for inserting output from an external command, reached from the insert menu.
</p>
</dd>
<dt><code>help</code></dt>
<dd><p>The help-viewer menu.
</p>
</dd>
<dt><code>spell</code></dt>
<dd><p>The interactive spell checker Yes/no menu.
</p>
</dd>
<dt><code>linter</code></dt>
<dd><p>The linter menu.
</p>
</dd>
<dt><code>browser</code></dt>
<dd><p>The file browser, for choosing a file to read from or write to.
</p>
</dd>
<dt><code>whereisfile</code></dt>
<dd><p>The ’search for a file’ menu in the file browser.
</p>
</dd>
<dt><code>gotodir</code></dt>
<dd><p>The ’go to directory’ menu in the file browser.
</p>
</dd>
<dt><code>all</code></dt>
<dd><p>A special name that encompasses all menus. For <code>bind</code> it means
all menus where the specified <code>function</code> exists; for <code>unbind</code>
it means all menus where the specified <code>key</code> exists.
</p>
</dd>
</dl>
<hr>
<a name="The-File-Browser"></a>
<a name="The-File-Browser-1"></a>
<h2 class="chapter">8 The File Browser</h2>
<p>When in the Read-File (<kbd>^R</kbd>) or Write-Out menu (<kbd>^O</kbd>),
pressing <kbd>^T</kbd> will invoke the file browser.
Here, one can navigate directories in a graphical manner in order to
find the desired file.
</p>
<p>Basic movement in the file browser is accomplished with the arrow and
other cursor-movement keys. More targeted movement is accomplished by
searching, via <kbd>^W</kbd> or <kbd>w</kbd>, or by changing directory, via
<kbd>^_</kbd> or <kbd>g</kbd>. The behavior of the <kbd>Enter</kbd> key (or <kbd>s</kbd>)
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 status bar, and the file
browser exits.
</p>
<hr>
<a name="Pico-Compatibility"></a>
<a name="Pico-Compatibility-1"></a>
<h2 class="chapter">9 Pico Compatibility</h2>
<p><code>nano</code> attempts to emulate Pico as closely as possible, but there
are some differences between the editors:
</p>
<dl compact="compact">
<dt><code>Interactive Replace</code></dt>
<dd><p>Instead of allowing you to replace either just one occurrence of a search
string or all of them, <code>nano</code>’s replace function is interactive: it
will pause at each found search string and query whether to replace this
instance. You can then choose Yes, or No (skip this one), or All (don’t
ask any more), or Cancel (stop with replacing).
</p>
</dd>
<dt><code>Search and Replace History</code></dt>
<dd><p>When the option <samp>-H</samp> or <samp>--historylog</samp> is given (or set in
the a nanorc file), text entered as search or replace strings is stored.
These strings can be accessed with the up/down arrow keys, or you can
type the first few characters and then use <kbd>Tab</kbd> to cycle through the
matching strings. A retrieved string can subsequently be edited.
</p>
</dd>
<dt><code>Position History</code></dt>
<dd><p>When the option <samp>-P</samp> or <samp>--positionlog</samp> is given (or set in
a nanorc file), <code>nano</code> will store the position of the cursor
when you close a file, and will place the cursor in that position
again when you later reopen the file.
</p>
</dd>
<dt><code>Current Cursor Position</code></dt>
<dd><p>The output of the "Display Cursor Position" command (<kbd>^C</kbd>) displays
not only the current line and character position of the cursor,
but also (between the two) the current column position.
</p>
</dd>
<dt><code>Hard-Wrapping</code></dt>
<dd><p>By default, <code>nano</code> hard-wraps lines at screen width minus eight
columns, whereas Pico does it at screen width minus six columns. You can
make <code>nano</code> do the same as Pico by using <samp>--fill=-6</samp>.
</p>
</dd>
<dt><code>Spell Checking</code></dt>
<dd><p>In the internal spell checker misspelled words are sorted alphabetically
and trimmed for uniqueness, such that the words ’apple’ and ’Apple’ will
be prompted for correction separately.
</p>
</dd>
<dt><code>Writing Selected Text to Files</code></dt>
<dd><p>When using the Write-Out key (<kbd>^O</kbd>), text that has been selected using the
marking key (<kbd>^^</kbd>) can not just be written out to a new (or existing) file,
it can also be appended or prepended to an existing file.
</p>
</dd>
<dt><code>Reading Text from a Command</code></dt>
<dd><p>When using the Read-File key (<kbd>^R</kbd>), <code>nano</code> can not just read a file,
it can also read the output of a command to be run (<kbd>^X</kbd>).
</p>
</dd>
<dt><code>Reading from Working Directory</code></dt>
<dd><p>By default, Pico will read files from the user’s home directory (when
using <kbd>^R</kbd>), but it will write files to the current working directory
(when using <kbd>^O</kbd>). <code>nano</code> makes this symmetrical: always reading
from and writing to the current working directory — the directory
that <code>nano</code> was started in.
</p>
</dd>
<dt><code>File Browser</code></dt>
<dd><p>In the file browser, <code>nano</code> does not implement the Add, Copy,
Rename, and Delete commands that Pico provides. In <code>nano</code> the
browser is just a file browser, not a file manager.
</p>
</dd>
<dt><code>Toggles</code></dt>
<dd><p>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 on or off.
See <a href="#Feature-Toggles">Feature Toggles</a> for a list of options that can be toggled.
Or see the list at the end of the main internal help text (<kbd>^G</kbd>) instead.
</p>
</dd>
</dl>
<hr>
<a name="Building-and-Configure-Options"></a>
<a name="Building-and-Configure-Options-1"></a>
<h2 class="chapter">10 Building and Configure Options</h2>
<p>Building <code>nano</code> from source is fairly straightforward if you are
familiar with compiling programs with autoconf support:
</p>
<div class="example">
<pre class="example"> tar xvzf nano-x.y.z.tar.gz
cd nano-x.y.z
./configure
make
make install
</pre></div>
<p>The possible options to <code>./configure</code> are:
</p>
<dl compact="compact">
<dt><code>--disable-browser</code></dt>
<dd><p>Disable the mini file browser that can be called with <kbd>^T</kbd> when reading
or writing files.
</p>
</dd>
<dt><code>--disable-color</code></dt>
<dd><p>Disable support for the syntax coloring of files. This also eliminates
the <samp>-Y</samp> command-line option, which chooses a specific syntax.
</p>
</dd>
<dt><code>--disable-comment</code></dt>
<dd><p>Disable the single-keystroke comment/uncomment function (<kbd>M-3</kbd>).
</p>
</dd>
<dt><code>--disable-extra</code></dt>
<dd><p>Disable the Easter egg: a crawl of major contributors.
</p>
</dd>
<dt><code>--disable-help</code></dt>
<dd><p>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.
</p>
</dd>
<dt><code>--disable-histories</code></dt>
<dd><p>Disable the code for the handling of the history files: the search and
replace strings that were used, and the cursor position at which each
file was closed. This also eliminates the <samp>-H</samp> and <samp>-P</samp>
command-line options, which switch on the logging of search/replace
strings and cursor positions.
</p>
</dd>
<dt><code>--disable-justify</code></dt>
<dd><p>Disable the justify and unjustify functions.
</p>
</dd>
<dt><code>--disable-libmagic</code></dt>
<dd><p>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).
</p>
</dd>
<dt><code>--disable-linenumbers</code></dt>
<dd><p>Disable the line-numbering function (<kbd>M-#</kbd>). This also eliminates the
<samp>-l</samp> command-line option, which turns line numbering on.
</p>
</dd>
<dt><code>--disable-mouse</code></dt>
<dd><p>Disable all mouse functionality. This also eliminates the <samp>-m</samp>
command-line option, which enables the mouse functionality.
</p>
</dd>
<dt><code>--disable-multibuffer</code></dt>
<dd><p>Disable support for opening multiple files at a time and switching
between them on the fly. This also eliminates the <samp>-F</samp> command-line
option, which causes a file to be read into a separate buffer by default.
</p>
</dd>
<dt><code>--disable-nanorc</code></dt>
<dd><p>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 <a href="#Nanorc-Files">Nanorc Files</a> for more info.
Disabling this also eliminates the <samp>-I</samp> command-line option,
which inhibits the reading of nanorc files.
</p>
</dd>
<dt><code>--disable-operatingdir</code></dt>
<dd><p>Disable setting the operating directory. This also eliminates the <samp>-o</samp>
command-line option, which sets the operating directory.
</p>
</dd>
<dt><code>--disable-speller</code></dt>
<dd><p>Disable use of the spell checker. This also eliminates the <samp>-s</samp>
command-line option, which allows specifying an alternate spell checker.
</p>
</dd>
<dt><code>--disable-tabcomp</code></dt>
<dd><p>Disable tab completion (when nano asks for a filename or a search string).
</p>
</dd>
<dt><code>--disable-wordcomp</code></dt>
<dd><p>Disable word completion (<kbd>^]</kbd>).
</p>
</dd>
<dt><code>--disable-wrapping</code></dt>
<dd><p>Disable all hard-wrapping of overlong lines. This also eliminates the
<samp>-w</samp> command-line option, which switches long-line wrapping off.
</p>
</dd>
<dt><code>--enable-tiny</code></dt>
<dd><p>This option implies all of the above. It also disables some other
internals of the editor, like the marking code, the cut-to-end-of-line
code, and the function toggles. By using the enabling
counterpart of the above options together with <samp>--enable-tiny</samp>,
specific features can be switched back on — but a few cannot.
</p>
</dd>
<dt><code>--enable-debug</code></dt>
<dd><p>Enable support for runtime debug output. This can get pretty messy, so
chances are you only want this feature when you’re working on the nano source.
</p>
</dd>
<dt><code>--disable-nls</code></dt>
<dd><p>Disables Native Language support. This will disable the use of any
available GNU <code>nano</code> translations.
</p>
</dd>
<dt><code>--disable-wrapping-as-root</code></dt>
<dd><p>Disable hard-wrapping of overlong lines by default when <code>nano</code>
is run as root.
</p>
</dd>
<dt><code>--enable-utf8</code></dt>
<dd><p>Enable support for reading and writing Unicode files. This will require
either a wide version of curses, or a UTF-8-enabled version of Slang.
</p>
</dd>
<dt><code>--disable-utf8</code></dt>
<dd><p>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.
</p>
</dd>
<dt><code>--enable-altrcname=<var>name</var></code></dt>
<dd><p>Use the file with the given <var>name</var> (in the user’s home directory)
as nano’s settings file, instead of the default <code>.nanorc</code>.
</p>
</dd>
<dt><code>--with-slang</code></dt>
<dd><p>Compile <code>nano</code> against Slang instead of against ncurses or other
curses libraries.
</p>
</dd>
</dl>
<hr>
<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a name="toc-Introduction-1" href="#Introduction">1 Introduction</a></li>
<li><a name="toc-Invoking-1" href="#Invoking">2 Invoking</a></li>
<li><a name="toc-Command_002dline-Options-1" href="#Command_002dline-Options">3 Command-line Options</a></li>
<li><a name="toc-Editor-Basics-1" href="#Editor-Basics">4 Editor Basics</a>
<ul class="no-bullet">
<li><a name="toc-Entering-Text-1" href="#Entering-Text">4.1 Entering Text</a></li>
<li><a name="toc-Commands-1" href="#Commands">4.2 Commands</a></li>
<li><a name="toc-The-Cutbuffer-1" href="#The-Cutbuffer">4.3 The Cutbuffer</a></li>
<li><a name="toc-The-Mark-1" href="#The-Mark">4.4 The Mark</a></li>
<li><a name="toc-Screen-Layout-1" href="#Screen-Layout">4.5 Screen Layout</a></li>
<li><a name="toc-Search-and-Replace-1" href="#Search-and-Replace">4.6 Search and Replace</a></li>
<li><a name="toc-Using-the-Mouse-1" href="#Using-the-Mouse">4.7 Using the Mouse</a></li>
<li><a name="toc-Limitations-1" href="#Limitations">4.8 Limitations</a></li>
</ul></li>
<li><a name="toc-Built_002din-Help-1" href="#Built_002din-Help">5 Built-in Help</a></li>
<li><a name="toc-Feature-Toggles-1" href="#Feature-Toggles">6 Feature Toggles</a></li>
<li><a name="toc-Nanorc-Files-1" href="#Nanorc-Files">7 Nanorc Files</a>
<ul class="no-bullet">
<li><a name="toc-Settings-1" href="#Settings">7.1 Settings</a></li>
<li><a name="toc-Syntax-Highlighting-1" href="#Syntax-Highlighting">7.2 Syntax Highlighting</a></li>
<li><a name="toc-Rebinding-Keys-1" href="#Rebinding-Keys">7.3 Rebinding Keys</a></li>
</ul></li>
<li><a name="toc-The-File-Browser-1" href="#The-File-Browser">8 The File Browser</a></li>
<li><a name="toc-Pico-Compatibility-1" href="#Pico-Compatibility">9 Pico Compatibility</a></li>
<li><a name="toc-Building-and-Configure-Options-1" href="#Building-and-Configure-Options">10 Building and Configure Options</a></li>
</ul>
</div>
<hr>
</body>
</html>