diff options
Diffstat (limited to 'doc/texinfo/nano.html')
| -rw-r--r-- | doc/texinfo/nano.html | 2322 |
1 files changed, 1659 insertions, 663 deletions
diff --git a/doc/texinfo/nano.html b/doc/texinfo/nano.html index b673557..0568413 100644 --- a/doc/texinfo/nano.html +++ b/doc/texinfo/nano.html @@ -1,363 +1,583 @@ -<html lang="en"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ --> <head> <title>nano Command Manual</title> -<meta http-equiv="Content-Type" content="text/html"> + <meta name="description" content="nano Command Manual"> -<meta name="generator" content="makeinfo 4.13"> -<link title="Top" rel="top" href="#Top"> -<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> -<meta http-equiv="Content-Style-Type" content="text/css"> -<style type="text/css"><!-- - pre.display { font-family:inherit } - pre.format { font-family:inherit } - pre.smalldisplay { font-family:inherit; font-size:smaller } - pre.smallformat { font-family:inherit; font-size:smaller } - pre.smallexample { font-size:smaller } - pre.smalllisp { font-size:smaller } - span.sc { font-variant:small-caps } - span.roman { font-family:serif; font-weight:normal; } - span.sansserif { font-family:sans-serif; font-weight:normal; } ---></style> +<meta name="keywords" content="nano Command Manual"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<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.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.indentedblock {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smallindentedblock {margin-left: 3.2em; font-size: smaller} +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.nocodebreak {white-space:nowrap} +span.nolinebreak {white-space:nowrap} +span.roman {font-family:serif; font-weight:normal} +span.sansserif {font-family:sans-serif; font-weight:normal} +ul.no-bullet {list-style: none} +--> +</style> + + </head> -<body> -<h1 class="settitle">nano Command Manual</h1> -<div class="node"> -<a name="Top"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Introduction">Introduction</a>, -Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, -Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> -</div> +<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> +<h1 class="settitle" align="center">nano Command Manual</h1> - <p>This manual documents GNU <code>nano</code>, a small and friendly text -editor. -<ul class="menu"> -<li><a accesskey="1" href="#Introduction">Introduction</a> -<li><a accesskey="2" href="#Editor-Basics">Editor Basics</a> -<li><a accesskey="3" href="#Online-Help">Online Help</a> -<li><a accesskey="4" href="#Feature-Toggles">Feature Toggles</a> -<li><a accesskey="5" href="#Nanorc-Files">Nanorc Files</a> -<li><a accesskey="6" href="#The-File-Browser">The File Browser</a> -<li><a accesskey="7" href="#Pico-Compatibility">Pico Compatibility</a> -<li><a accesskey="8" href="#Building-and-Configure-Options">Building and Configure Options</a> -</ul> -<div class="node"> -<a name="Introduction"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Editor-Basics">Editor Basics</a>, -Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> + + +<a name="Top"></a> +<div class="header"> +<p> +Next: <a href="#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> +<a name="SEC_Top"></a> +<p>This manual documents GNU <code>nano</code>, a small and friendly text +editor. +</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="#Editor-Basics" accesskey="2">Editor Basics</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Online-Help" accesskey="3">Online Help</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Feature-Toggles" accesskey="4">Feature Toggles</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Nanorc-Files" accesskey="5">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="6">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="7">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" accesskey="8">Building and Configure Options</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + + +<hr> +<a name="Introduction"></a> +<div class="header"> +<p> +Next: <a href="#Editor-Basics" accesskey="n" rel="next">Editor Basics</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<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 like an interactive -search and replace, go to line and column number, auto-indentation, +editing, <code>nano</code> offers many extra features, like an interactive +search-and-replace, go-to-line-and-column-number, auto-indentation, feature toggles, internationalization support, and filename tab completion. - -<ul class="menu"> -<li><a accesskey="1" href="#Overview">Overview</a> -<li><a accesskey="2" href="#Command-Line-Options">Command Line Options</a> -</ul> - -<div class="node"> +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#Overview" accesskey="1">Overview</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Command-Line-Options" accesskey="2">Command Line Options</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> <a name="Overview"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Command-Line-Options">Command Line Options</a>, -Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>, -Up: <a rel="up" accesskey="u" href="#Introduction">Introduction</a> - +<div class="header"> +<p> +Next: <a href="#Command-Line-Options" accesskey="n" rel="next">Command Line Options</a>, Up: <a href="#Introduction" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Overview-1"></a> <h3 class="section">1.1 Overview</h3> <p>The original goal for <code>nano</code> was a complete bug-for-bug compatible -emulation of Pico, but <code>nano</code>'s current goal is to be as compatible -as possible while offering a superset of Pico's functionality. See +emulation of Pico, but <code>nano</code>’s current goal is to be as compatible +as possible while offering a superset of Pico’s functionality. See See <a href="#Pico-Compatibility">Pico Compatibility</a>, for more info. - - <p>The usual way to invoke <code>nano</code> is: - - <blockquote> -<code>nano [OPTION]... [FILE]</code> -</blockquote> - - <p>But it is also possible to edit several files in a row. Additionally, +</p> +<p>The usual way to invoke <code>nano</code> is: +</p> +<blockquote> +<p><code>nano [OPTION]… [FILE]</code> +</p></blockquote> + +<p>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 with a plus sign before any filename, and even in a desired column by adding it with a comma. So the complete synopsis is: - - <blockquote> -<code>nano [OPTION]... [[+LINE] FILE]...</code> - - <p><code>nano [OPTION]... [[+,COLUMN] FILE]...</code> - - <p><code>nano [OPTION]... [[+LINE,COLUMN] FILE]...</code> -</blockquote> - - <p>Email bug reports to <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a>. - -<div class="node"> +</p> +<blockquote> +<p><code>nano [OPTION]… [[+LINE] FILE]…</code> +</p> +<p><code>nano [OPTION]… [[+,COLUMN] FILE]…</code> +</p> +<p><code>nano [OPTION]… [[+LINE,COLUMN] FILE]…</code> +</p></blockquote> + +<p>Email bug reports to <a href="mailto:nano@nano-editor.org">nano@nano-editor.org</a>. +</p> +<hr> <a name="Command-Line-Options"></a> -<p><hr> -Previous: <a rel="previous" accesskey="p" href="#Overview">Overview</a>, -Up: <a rel="up" accesskey="u" href="#Introduction">Introduction</a> - +<div class="header"> +<p> +Previous: <a href="#Overview" accesskey="p" rel="prev">Overview</a>, Up: <a href="#Introduction" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Command-Line-Options-1"></a> <h3 class="section">1.2 Command Line Options</h3> <p><code>nano</code> takes the following options from the command line: - - <dl> -<dt><code>+LINE,COLUMN</code><dd>Start at line number LINE and column number COLUMN (at least one of +</p> +<dl compact="compact"> +<dt><samp>+<var>line</var>,<var>column</var></samp></dt> +<dd><p>Start at line number <var>line</var> and column number <var>column</var> (at least one of which must be specified) instead of the default of line 1, column 1. - - <br><dt><code>-?</code><dd>Same as <code>-h, --help</code>. - - <br><dt><code>-A, --smarthome</code><dd>Make the Home key smarter. When Home is pressed anywhere but at the +</p> +</dd> +<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. - - <br><dt><code>-B, --backup</code><dd>When saving a file, back up the previous version of it to the current -filename suffixed with a ~. - - <br><dt><code>-C <dir>, --backupdir=<dir></code><dd>Set the directory where <code>nano</code> puts unique backup files if file +</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 to the current +filename suffixed with a ‘<samp>~</samp>’. +</p> +</dd> +<dt><samp>-C <var>directory</var></samp></dt> +<dt><samp>--backupdir=<var>directory</var></samp></dt> +<dd><p>Set the directory where <code>nano</code> puts unique backup files if file backups are enabled. - - <br><dt><code>-D, --boldtext</code><dd>Use bold text instead of reverse video text. - - <br><dt><code>-E, --tabstospaces</code><dd>Convert typed tabs to spaces. - - <br><dt><code>-F, --multibuffer</code><dd>Enable multiple file buffers, if available. - - <br><dt><code>-H, --historylog</code><dd>Log search and replace strings to ~/.nano_history, so they can be -retrieved in later sessions, if nanorc support is available. - - <br><dt><code>-I, --ignorercfiles</code><dd>Don't look at SYSCONFDIR/nanorc or ~/.nanorc, if nanorc support is -available. - - <br><dt><code>-K, --rebindkeypad</code><dd>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. - - <br><dt><code>-L, --nonewlines</code><dd>Don't add newlines to the ends of files. - - <br><dt><code>-N, --noconvert</code><dd>Don't convert files from DOS/Mac format. - - <br><dt><code>-O, --morespace</code><dd>Use the blank line below the titlebar as extra editing space. - - <br><dt><code>-Q <str>, --quotestr=<str></code><dd>Set the quoting string for justifying. The default value is - - <blockquote> -<code>^([ \t]*[|>:}#])+</code> -</blockquote> - - <p>if extended regular expression support is available, or "> " otherwise. +</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>Enable multiple file buffers (if support for them has been compiled in). +</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>Log search and replace strings to <samp>~/.nano/search_history</samp>, +so they can be retrieved 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 <samp>~/.nanorc</samp>. +</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 add newlines to the ends of files. +</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 titlebar as extra editing space. +</p> +</dd> +<dt><samp>-P</samp></dt> +<dt><samp>--poslog</samp></dt> +<dd><p>Log for each file the last location of the cursor, and read it +back upon reopening the file and place it there again. +</p> +</dd> +<dt><samp>-Q "<var>characters</var>"</samp></dt> +<dt><samp>--quotestr="<var>characters</var>"</samp></dt> +<dd><p>Set the quoting string for justifying. The default value is +</p> +<blockquote> +<p>"^([ \t]*[|>:}#])+" +</p></blockquote> + +<p>if extended regular expression support is available, or <code>> </code> otherwise. Note that <code>\t</code> above stands for a literal Tab character. - - <br><dt><code>-R, --restricted</code><dd>Restricted mode: don't read or write to any file not specified on the -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</code> with any name beginning with 'r' (e.g. "rnano"). - - <br><dt><code>-S, --smooth</code><dd>Enable smooth scrolling. Text will scroll line-by-line, instead of the +</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 ‘<samp>r</samp>’ (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. - - <br><dt><code>-T <#cols>, --tabsize=<#cols></code><dd>Set the displayed tab length to #cols columns. The value of #cols must -be greater than 0. The default value is 8. - - <br><dt><code>-U, --quickblank</code><dd>Do quick statusbar blanking. Statusbar messages will disappear after 1 -keystroke instead of 25. Note that -c overrides this. - - <br><dt><code>-V, --version</code><dd>Show the current version number and exit. - - <br><dt><code>-W, --wordbounds</code><dd>Detect word boundaries more accurately by treating punctuation +</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 ‘<samp>8</samp>’. +</p> +</dd> +<dt><samp>-U</samp></dt> +<dt><samp>--quickblank</samp></dt> +<dd><p>Do quick statusbar blanking. Statusbar messages will disappear after 1 +keystroke instead of 25. Note that <samp>-c</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 more accurately by treating punctuation characters as parts of words. - - <br><dt><code>-Y <str>, --syntax=<str></code><dd>Specify a specific syntax highlighting from the nanorc to use, if -available. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. - - <br><dt><code>-c, --const</code><dd>Constantly display the cursor position and line number on the statusbar. -Note that this overrides -U. - - <br><dt><code>-d, --rebinddelete</code><dd>Interpret the Delete key differently so that both Backspace and Delete +</p> +</dd> +<dt><samp>-Y <var>name</var></samp></dt> +<dt><samp>--syntax=<var>name</var></samp></dt> +<dd><p>Specify a specific syntax from the nanorc files to use for highlighting. +See See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, for more info. +</p> +</dd> +<dt><samp>-c</samp></dt> +<dt><samp>--const</samp></dt> +<dd><p>Constantly display the cursor position and line number on the statusbar. +Note that this overrides <samp>-U</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. - - <br><dt><code>-h, --help</code><dd>Show a summary of command line options and exit. - - <br><dt><code>-i, --autoindent</code><dd>Automatically indent new lines to the same number of spaces and tabs as +</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 new lines to the same number of spaces and tabs as the previous line. - - <br><dt><code>-k, --cut</code><dd>Cut from the current cursor position to the end of the current line. - - <br><dt><code>-l, --nofollow</code><dd>When writing files, if the given file is a symbolic link, it is removed +</p> +</dd> +<dt><samp>-k</samp></dt> +<dt><samp>--cut</samp></dt> +<dd><p>Make the ’Cut Text’ command (normally ^K) 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>--nofollow</samp></dt> +<dd><p>When writing files, if the given file is a symbolic link, it is removed and a new file is created. - - <br><dt><code>-m, --mouse</code><dd>Enable mouse support, if available for your system. When enabled, mouse +</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. - - <br><dt><code>-o <dir>, --operatingdir=<dir></code><dd>Set operating directory. Makes <code>nano</code> set up something similar to -a chroot. - - <br><dt><code>-p, --preserve</code><dd>Preserve the ^Q (XON) and ^S (XOFF) sequences so data being sent to the -editor can be can be stopped and started. - - <br><dt><code>-q, --quiet</code><dd>Do not report errors in the nanorc file and ask them to be acknowledged +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 ^Q (XON) and ^S (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>Do not report errors in the nanorc file nor ask them to be acknowledged by pressing Enter at startup. - - <br><dt><code>-r <#cols>, --fill=<#cols></code><dd>Wrap lines at column #cols. If this value is 0 or less, wrapping will -occur at the width of the screen less #cols, allowing it to vary along -with the width of the screen if the screen is resized. The default -value is -8. - - <br><dt><code>-s <prog>, --speller=<prog></code><dd>Invoke the given program as the spell checker. By default, <code>nano</code> -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</code> program to be installed on your system. - - <br><dt><code>-t, --tempfile</code><dd>Don't ask whether or not to save the current contents of the file when +</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 ‘<samp>-8</samp>’. This option conflicts with <samp>-w</samp> +– the last one given takes effect. +</p> +</dd> +<dt><samp>-s <var>program</var></samp></dt> +<dt><samp>--speller=<var>program</var></samp></dt> +<dd><p>Invoke the given program as the spell checker. By default, <code>nano</code> +uses the command specified in the <code>SPELL</code> environment variable, or, +if <code>SPELL</code> is not set, its own interactive spell checker that requires +the <code>spell</code> program to be installed on your system. +</p> +</dd> +<dt><samp>-t</samp></dt> +<dt><samp>--tempfile</samp></dt> +<dd><p>Don’t ask whether or not to save the current contents of the file when exiting, assume yes. This is most useful when using <code>nano</code> as the composer of a mailer program. - - <br><dt><code>-u, --undo</code><dd>Enable experimental generic-purpose undo code. By default, the undo and -redo shortcuts are Meta-U and Meta-E, respectively. - - <br><dt><code>-v, --view</code><dd>Don't allow the contents of the file to be altered. Note that this +</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. - - <br><dt><code>-w, --nowrap</code><dd>Don't wrap long lines at any length. This option overrides any value -for -r. - - <p><a name="Expert-Mode"></a><br><dt><code>-x, --nohelp</code><dd>Expert Mode: don't show the Shortcut Lists at the bottom of the screen. +</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> – 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 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. - - <p>Note: When accessing the help system, Expert Mode is temporarily -disabled to display the help system navigation keys. - - <br><dt><code>-z, --suspend</code><dd>Enable <code>nano</code>'s suspend ability using the system's suspend +</p> +<p>Note: When accessing the help system, Expert Mode is temporarily +disabled to display the help-system navigation keys. +</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 ^Z). - - <br><dt><code>-$, --softwrap</code><dd>Enable 'soft wrapping'. <code>nano</code> 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 -$'). - - <br><dt><code>-a, -b, -e, -f, -g, -j</code><dd>Ignored, for compatibility with Pico. +</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 +‘<samp>$</samp>’ 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>-a</samp></dt> +<dt><samp>-b</samp></dt> +<dt><samp>-e</samp></dt> +<dt><samp>-f</samp></dt> +<dt><samp>-g</samp></dt> +<dt><samp>-j</samp></dt> +<dd><p>Ignored, for compatibility with Pico. +</p></dd> </dl> -<div class="node"> -<a name="Editor-Basics"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Online-Help">Online Help</a>, -Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> +<hr> +<a name="Editor-Basics"></a> +<div class="header"> +<p> +Next: <a href="#Online-Help" accesskey="n" rel="next">Online Help</a>, Previous: <a href="#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Editor-Basics-1"></a> <h2 class="chapter">2 Editor Basics</h2> -<ul class="menu"> -<li><a accesskey="1" href="#Entering-Text">Entering Text</a> -<li><a accesskey="2" href="#Special-Functions">Special Functions</a> -<li><a accesskey="3" href="#The-Titlebar">The Titlebar</a> -<li><a accesskey="4" href="#The-Statusbar">The Statusbar</a> -<li><a accesskey="5" href="#Shortcut-Lists">Shortcut Lists</a> -<li><a accesskey="6" href="#Using-the-Mouse">Using the Mouse</a> -</ul> - -<div class="node"> +<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="#Special-Functions" accesskey="2">Special Functions</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="#The-Titlebar" accesskey="5">The Titlebar</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#The-Statusbar" accesskey="6">The Statusbar</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Shortcut-Lists" accesskey="7">Shortcut Lists</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#Using-the-Mouse" accesskey="8">Using the Mouse</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> <a name="Entering-Text"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Special-Functions">Special Functions</a>, -Previous: <a rel="previous" accesskey="p" href="#Editor-Basics">Editor Basics</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +Next: <a href="#Special-Functions" accesskey="n" rel="next">Special Functions</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Entering-Text-1"></a> <h3 class="section">2.1 Entering Text</h3> -<p>All key sequences in <code>nano</code> are entered using the keyboard. -<code>nano</code> is a "modeless" editor. All keys, with the exception of -Control and Meta key sequences, will enter text into the file being -edited. - -<div class="node"> +<p><code>nano</code> is a "modeless" editor. All keystrokes, with the exception +of Control and Meta key sequences, enter text into the file being edited. +All key sequences in <code>nano</code> are entered using the keyboard. +</p> +<hr> <a name="Special-Functions"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#The-Titlebar">The Titlebar</a>, -Previous: <a rel="previous" accesskey="p" href="#Entering-Text">Entering Text</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +Next: <a href="#The-Cutbuffer" accesskey="n" rel="next">The Cutbuffer</a>, Previous: <a href="#Entering-Text" accesskey="p" rel="prev">Entering Text</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Special-Functions-1"></a> <h3 class="section">2.2 Special Functions</h3> -<p>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. - - <ul> -<li>Control key sequences are entered by holding down the Ctrl key and -pressing the desired key, or by pressing the Esc key twice and pressing -the desired key. -<li>Pressing Esc twice and then typing a three-digit number from 000 to 255 -will enter the character with the corresponding value. -<li>Meta key sequences are entered by holding down the Meta key (normally +<p>Special functions use the Control key (Ctrl), displayed in the help and +shortcut lists as ^; the Meta key (Alt or Cmd), displayed as M-; or the +Escape key (Esc). +</p> +<ul> +<li> Control key sequences are entered by holding down the Ctrl key and +pressing the desired key, or by pressing the Esc key twice and then +pressing the desired key. +</li><li> Pressing the Esc key twice and then typing a three-digit number from +000 to 255 will enter the character with the corresponding value. +</li><li> 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" +once and then pressing the desired key. Certain operating systems "swallow" the Alt key so that it never reaches the application; if your operating system does this, you should use the Esc key to generate Meta key -sequences. -</ul> +sequences. +</li></ul> -<div class="node"> +<hr> +<a name="The-Cutbuffer"></a> +<div class="header"> +<p> +Next: <a href="#The-Mark" accesskey="n" rel="next">The Mark</a>, Previous: <a href="#Special-Functions" accesskey="p" rel="prev">Special Functions</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<a name="The-Cutbuffer-1"></a> +<h3 class="section">2.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: ^K). The cut line is stored in the cutbuffer. +Consecutive strokes of ^K will add each cut line to this buffer, but a ^K +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: ^U). +</p> +<p>A line of text can be copied into the cutbuffer (without cutting it) with +the ’Copy Text’ command (default key binding: M-6). +</p> +<hr> +<a name="The-Mark"></a> +<div class="header"> +<p> +Next: <a href="#The-Titlebar" accesskey="n" rel="next">The Titlebar</a>, Previous: <a href="#The-Cutbuffer" accesskey="p" rel="prev">The Cutbuffer</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<a name="The-Mark-1"></a> +<h3 class="section">2.4 The Mark</h3> + +<p>Text can be selected by first ’setting the Mark’ (default key bindings: +^6 and M-A) and then moving the cursor to the other end of the portion +to be selected. The selected portion of text will be highlighted in +reverse video (or in bold if you set the boldtext option). +This selection can now be cut or copied in its entirety with a single +^K or M-6. Or the selection can be used to limit the scope of a +search-and-replace (^\) or spell-checking session (^T). +</p> +<p>Cutting or copying selected text will toggle the mark off automatically. +If necessary, it can be toggled off manually with another ^6 or M-A. +</p> +<hr> <a name="The-Titlebar"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#The-Statusbar">The Statusbar</a>, -Previous: <a rel="previous" accesskey="p" href="#Special-Functions">Special Functions</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +Next: <a href="#The-Statusbar" accesskey="n" rel="next">The Statusbar</a>, Previous: <a href="#The-Mark" accesskey="p" rel="prev">The Mark</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - -<h3 class="section">2.3 The Titlebar</h3> +<a name="The-Titlebar-1"></a> +<h3 class="section">2.5 The Titlebar</h3> <p>The titlebar is the line displayed at the top of the editor. There are three sections: left, center and right. The section on the left displays the version of <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 will display "Modified" if the +displays the current filename, or "New Buffer" if the file has not yet +been named. The section on the right will display "Modified" if the file has been modified since it was last saved or opened. - - <p>Special modes: When <code>nano</code> is in "File browser" mode, the center +</p> +<p>Special modes: When <code>nano</code> is in "File browser" mode, the center section will display the current directory instead of the filename. See See <a href="#The-File-Browser">The File Browser</a>, for more info. - -<div class="node"> +</p> +<hr> <a name="The-Statusbar"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Shortcut-Lists">Shortcut Lists</a>, -Previous: <a rel="previous" accesskey="p" href="#The-Titlebar">The Titlebar</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +Next: <a href="#Shortcut-Lists" accesskey="n" rel="next">Shortcut Lists</a>, Previous: <a href="#The-Titlebar" accesskey="p" rel="prev">The Titlebar</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - -<h3 class="section">2.4 The Statusbar</h3> +<a name="The-Statusbar-1"></a> +<h3 class="section">2.6 The Statusbar</h3> <p>The statusbar is the third line from the bottom of the screen, or the bottom line in Expert Mode. See See <a href="#Expert-Mode">Expert Mode</a>, for more info. It @@ -365,358 +585,1052 @@ shows important and informational messages. Any error messages that occur from using the editor will appear on the statusbar. Any questions that are asked of the user will be asked on the statusbar, and any user input (search strings, filenames, etc.) will be input on the statusbar. - -<div class="node"> +</p> +<hr> <a name="Shortcut-Lists"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Using-the-Mouse">Using the Mouse</a>, -Previous: <a rel="previous" accesskey="p" href="#The-Statusbar">The Statusbar</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +Next: <a href="#Using-the-Mouse" accesskey="n" rel="next">Using the Mouse</a>, Previous: <a href="#The-Statusbar" accesskey="p" rel="prev">The Statusbar</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - -<h3 class="section">2.5 Shortcut Lists</h3> +<a name="Shortcut-Lists-1"></a> +<h3 class="section">2.7 Shortcut Lists</h3> <p>The Shortcut Lists are the two lines at the bottom of the screen which show some of the more commonly used functions in the editor. - -<div class="node"> +</p> +<hr> <a name="Using-the-Mouse"></a> -<p><hr> -Previous: <a rel="previous" accesskey="p" href="#Shortcut-Lists">Shortcut Lists</a>, -Up: <a rel="up" accesskey="u" href="#Editor-Basics">Editor Basics</a> - +<div class="header"> +<p> +Previous: <a href="#Shortcut-Lists" accesskey="p" rel="prev">Shortcut Lists</a>, Up: <a href="#Editor-Basics" accesskey="u" rel="up">Editor Basics</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - -<h3 class="section">2.6 Using the Mouse</h3> +<a name="Using-the-Mouse-1"></a> +<h3 class="section">2.8 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. - - <p>The mouse will work in the X Window System, and on the console when gpm +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> -<div class="node"> +<hr> <a name="Online-Help"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Feature-Toggles">Feature Toggles</a>, -Previous: <a rel="previous" accesskey="p" href="#Editor-Basics">Editor Basics</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +Next: <a href="#Feature-Toggles" accesskey="n" rel="next">Feature Toggles</a>, Previous: <a href="#Editor-Basics" accesskey="p" rel="prev">Editor Basics</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Online-Help-1"></a> <h2 class="chapter">3 Online Help</h2> -<p>The online help system in <code>nano</code> is available by pressing ^G. -It is fairly self explanatory, documenting the various parts of the +<p>The online help system in <code>nano</code> is available by pressing ^G. +It is fairly self-explanatory, documenting the various parts of the editor and available keystrokes. Navigation is via the ^Y (Page Up) and ^V (Page Down) keys. ^X exits the help system. +</p> -<div class="node"> +<hr> <a name="Feature-Toggles"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Nanorc-Files">Nanorc Files</a>, -Previous: <a rel="previous" accesskey="p" href="#Online-Help">Online Help</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +Next: <a href="#Nanorc-Files" accesskey="n" rel="next">Nanorc Files</a>, Previous: <a href="#Online-Help" accesskey="p" rel="prev">Online Help</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Feature-Toggles-1"></a> <h2 class="chapter">4 Feature Toggles</h2> <p>Toggles allow you to change certain aspects of the editor that would -normally be done via command line options. They are invoked via Meta +normally be done via command-line options. They are invoked via Meta key sequences. See See <a href="#Special-Functions">Special Functions</a>, for more info. The following global toggles are available: +</p> +<dl compact="compact"> +<dt><code>Backup Files Toggle (Meta-B)</code></dt> +<dd><p>toggles the -B (<code>--backup</code>) command line option. +</p> +</dd> +<dt><code>Constant Cursor Position Display Toggle (Meta-C)</code></dt> +<dd><p>toggles the -c (<code>--const</code>) command line option. +</p> +</dd> +<dt><code>Multiple File Buffers Toggle (Meta-F)</code></dt> +<dd><p>toggles the -F (<code>--multibuffer</code>) command line option. +</p> +</dd> +<dt><code>Smart Home Key Toggle (Meta-H)</code></dt> +<dd><p>toggles the -A (<code>--smarthome</code>) command line option. +</p> +</dd> +<dt><code>Auto Indent Toggle (Meta-I)</code></dt> +<dd><p>toggles the -i (<code>--autoindent</code>) command line option. +</p> +</dd> +<dt><code>Cut To End Toggle (Meta-K)</code></dt> +<dd><p>toggles the -k (<code>--cut</code>) command line option. +</p> +</dd> +<dt><code>Long Line Wrapping Toggle (Meta-L)</code></dt> +<dd><p>toggles the -w (<code>--nowrap</code>) command line option. +</p> +</dd> +<dt><code>Mouse Support Toggle (Meta-M)</code></dt> +<dd><p>toggles the -m (<code>--mouse</code>) command line option. +</p> +</dd> +<dt><code>No Conversion From DOS/Mac Format Toggle (Meta-N)</code></dt> +<dd><p>toggles the -N (<code>--noconvert</code>) command line option. +</p> +</dd> +<dt><code>More Space For Editing Toggle (Meta-O)</code></dt> +<dd><p>toggles the -O (<code>--morespace</code>) command line option. +</p> +</dd> +<dt><code>Whitespace Display Toggle (Meta-P)</code></dt> +<dd><p>toggles whitespace-display mode. +See See <a href="#Whitespace">Whitespace</a>, for more info. +</p> +</dd> +<dt><code>Tabs to Spaces Toggle (Meta-Q)</code></dt> +<dd><p>toggles the -E (<code>--tabstospaces</code>) command line option. +</p> +</dd> +<dt><code>Smooth Scrolling Toggle (Meta-S)</code></dt> +<dd><p>toggles the -S (<code>--smooth</code>) command line option. +</p> +</dd> +<dt><code>Expert/No Help Toggle (Meta-X)</code></dt> +<dd><p>toggles the -x (<code>--nohelp</code>) command line option. +</p> +</dd> +<dt><code>Color Syntax Highlighting Toggle (Meta-Y)</code></dt> +<dd><p>toggles color syntax highlighting if you have color syntaxes in your +nanorc. See See <a href="#Syntax-Highlighting">Syntax Highlighting</a>, for more info. +</p> +</dd> +<dt><code>Suspend Toggle (Meta-Z)</code></dt> +<dd><p>toggles the -z (<code>--suspend</code>) command line option. +</p> +</dd> +<dt><code>Soft Wrapping Toggle (Meta-$)</code></dt> +<dd><p>toggles the -$ (<code>--softwrap</code>) command line option. +</p> +</dd> +</dl> - <dl> -<dt><code>Backup Files Toggle (Meta-B)</code><dd>toggles the -B (<code>--backup</code>) command line option. - - <br><dt><code>Constant Cursor Position Display Toggle (Meta-C)</code><dd>toggles the -c (<code>--const</code>) command line option. - - <br><dt><code>Multiple File Buffers Toggle (Meta-F)</code><dd>toggles the -F (<code>--multibuffer</code>) command line option. - - <br><dt><code>Smart Home Key Toggle (Meta-H)</code><dd>toggles the -A (<code>--smarthome</code>) command line option. - - <br><dt><code>Auto Indent Toggle (Meta-I)</code><dd>toggles the -i (<code>--autoindent</code>) command line option. - - <br><dt><code>Cut To End Toggle (Meta-K)</code><dd>toggles the -k (<code>--cut</code>) command line option. - - <br><dt><code>Long Line Wrapping Toggle (Meta-L)</code><dd>toggles the -w (<code>--nowrap</code>) command line option. - - <br><dt><code>Mouse Support Toggle (Meta-M)</code><dd>toggles the -m (<code>--mouse</code>) command line option. - - <br><dt><code>No Conversion From DOS/Mac Format Toggle (Meta-N)</code><dd>toggles the -N (<code>--noconvert</code>) command line option. - - <br><dt><code>More Space For Editing Toggle (Meta-O)</code><dd>toggles the -O (<code>--morespace</code>) command line option. - - <br><dt><code>Whitespace Display Toggle (Meta-P)</code><dd>toggles whitespace display mode if you have a "whitespace" option in -your nanorc. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. - - <br><dt><code>Tabs to Spaces Toggle (Meta-Q)</code><dd>toggles the -E (<code>--tabstospaces</code>) command line option. - - <br><dt><code>Smooth Scrolling Toggle (Meta-S)</code><dd>toggles the -S (<code>--smooth</code>) command line option. - - <br><dt><code>Expert/No Help Toggle (Meta-X)</code><dd>toggles the -x (<code>--nohelp</code>) command line option. - - <br><dt><code>Color Syntax Highlighting Toggle (Meta-Y)</code><dd>toggles color syntax highlighting if you have color syntaxes in your -nanorc. See See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. - - <br><dt><code>Suspend Toggle (Meta-Z)</code><dd>toggles the -z (<code>--suspend</code>) command line option. - - <br><dt><code>Soft Wrapping Toggle (Meta-$)</code><dd>toggles the -$ (<code>--softwrap</code>) command line option. - - </dl> -<div class="node"> +<hr> <a name="Nanorc-Files"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#The-File-Browser">The File Browser</a>, -Previous: <a rel="previous" accesskey="p" href="#Feature-Toggles">Feature Toggles</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +Next: <a href="#The-File-Browser" accesskey="n" rel="next">The File Browser</a>, Previous: <a href="#Feature-Toggles" accesskey="p" rel="prev">Feature Toggles</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Nanorc-Files-1"></a> <h2 class="chapter">5 Nanorc Files</h2> <p>The nanorc files contain the default settings for <code>nano</code>. They -should not be in DOS or Mac format. During startup, <code>nano</code> will -first read its system-wide settings from SYSCONFDIR/nanorc, and then -user-specific settings from ~/.nanorc. - - <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 the command -line options. Additionally, the "syntax", "color", and "icolor" -keywords are used to define syntax highlighting rules for different text -patterns. <code>nano</code> will read one command per line. - - <p>Options in nanorc files take precedence over <code>nano</code>'s defaults, and -command line options override nanorc settings. Options are also unset -by default, except for those that take arguments. - - <p>Quotes inside string parameters don't have to be escaped with +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, +from ~/.nanorc. +</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 See <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 <samp>~/.nanorc</samp>. 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 "brackets" option, - - <blockquote> -<code>""')>]}"</code> -</blockquote> - - <p>will match <code>"</code>, <code>'</code>, <code>)</code>, <code>></code>, <code>]</code>, and -<code>}</code>. - - <p>The supported commands and arguments are: - - <dl> -<dt><code>set/unset autoindent</code><dd>Use auto-indentation. - - <br><dt><code>set/unset backup</code><dd>Create backup files in "filename~". - - <br><dt><code>set backupdir "directory"</code><dd>Set the directory where <code>nano</code> puts unique backup files if file +end. For example, for the "brackets" option, <code>""')>]}"</code> 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> +<div class="header"> +<p> +Next: <a href="#Syntax-Highlighting" accesskey="n" rel="next">Syntax Highlighting</a>, Up: <a href="#Nanorc-Files" accesskey="u" rel="up">Nanorc Files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<a name="Settings-1"></a> +<h3 class="section">5.1 Settings</h3> + +<p>The supported settings in a nanorc file are: +</p> +<dl compact="compact"> +<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 autoindent</code></dt> +<dd><p>Use auto-indentation. +</p> +</dd> +<dt><code>set backup</code></dt> +<dd><p>When saving a file, back up the previous version of it to the current +filename suffixed with a tilde (<code>~</code>). +</p> +</dd> +<dt><code>set backupdir "directory"</code></dt> +<dd><p>Set the directory where <code>nano</code> puts unique backup files, if file backups are enabled. - - <br><dt><code>set/unset backwards</code><dd>Do backwards searches by default. - - <br><dt><code>set/unset boldtext</code><dd>Use bold text instead of reverse video text. - - <br><dt><code>set brackets "string"</code><dd>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. +</p> +</dd> +<dt><code>set backwards</code></dt> +<dd><p>Do backwards searches by default. +</p> +</dd> +<dt><code>set boldtext</code></dt> +<dd><p>Use bold instead of reverse video for the titlebar, statusbar, key combos, +and selected text. This can be overridden for the first three by setting +the options "titlecolor", "statuscolor", and "keycolor". +</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 "punct"), optionally followed by the specified +closing brackets, can end sentences. The default value is +</p> +<blockquote> +<p>""’)>]}" +</p></blockquote> + +</dd> +<dt><code>set casesensitive</code></dt> +<dd><p>Do case-sensitive searches by default. +</p> +</dd> +<dt><code>set const</code></dt> +<dd><p>Constantly display the cursor position in the status bar. +</p> +</dd> +<dt><code>set cut</code></dt> +<dd><p>Use cut-to-end-of-line by default, instead of cutting the whole line. +</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 -8. +</p> +</dd> +<dt><code>set functioncolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the function descriptions +in the two help lines at the bottom of the screen. +See <code>set titlecolor</code> for more details. +</p> +</dd> +<dt><code>set historylog</code></dt> +<dd><p>Enable the use of <samp>~/.nano/search_history</samp> for saving and reading +search/replace strings. +</p> +</dd> +<dt><code>set keycolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the shortcut key combos +in the two help lines at the bottom of the screen. +See <code>set titlecolor</code> for more details. +</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 - - <blockquote> -<code>""')>]}"</code> -</blockquote> - - <br><dt><code>set/unset casesensitive</code><dd>Do case sensitive searches by default. - - <br><dt><code>set/unset const</code><dd>Constantly display the cursor position in the status bar. - - <br><dt><code>set/unset cut</code><dd>Use cut to end of line by default, instead of cutting the whole line. - - <br><dt><code>set fill "n"</code><dd>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. - - <br><dt><code>set/unset historylog</code><dd>Enable ~/.nano_history for saving and reading search/replace strings. - - <br><dt><code>set matchbrackets "string"</code><dd>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 - - <blockquote> -<code>"(<[{)>]}"</code> -</blockquote> - - <br><dt><code>set/unset morespace</code><dd>Use the blank line below the titlebar as extra editing space. - - <br><dt><code>set/unset mouse</code><dd>Enable mouse support, so that mouse clicks can be used to place the +</p> +<blockquote> +<p>"(<[{)>]}" +</p></blockquote> + +</dd> +<dt><code>set morespace</code></dt> +<dd><p>Use the blank line below the titlebar 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. - - <br><dt><code>set/unset multibuffer</code><dd>Allow inserting files into their own buffers. - - <br><dt><code>set/unset noconvert</code><dd>Don't convert files from DOS/Mac format. - - <br><dt><code>set/unset nofollow</code><dd>Don't follow symlinks when writing files. - - <br><dt><code>set/unset nohelp</code><dd>Don't display the help lists at the bottom of the screen. - - <br><dt><code>set/unset nonewlines</code><dd>Don't add newlines to the ends of files. - - <br><dt><code>set/unset nowrap</code><dd>Don't wrap text at all. - - <br><dt><code>set operatingdir "directory"</code><dd><code>nano</code> will only read and write files inside "directory" and its +</p> +</dd> +<dt><code>set multibuffer</code></dt> +<dd><p>Allow inserting files into their own buffers. +</p> +</dd> +<dt><code>set noconvert</code></dt> +<dd><p>Don’t convert files from DOS/Mac format. +</p> +</dd> +<dt><code>set nofollow</code></dt> +<dd><p>Don’t follow symlinks when writing files. +</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>Don’t add newlines to the ends of files. +</p> +</dd> +<dt><code>set nowrap</code></dt> +<dd><p>Don’t hard-wrap text at all. +</p> +</dd> +<dt><code>set operatingdir "directory"</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. - - <br><dt><code>set/unset preserve</code><dd>Preserve the XON and XOFF keys (^Q and ^S). - - <br><dt><code>set punct "string"</code><dd>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>"!.?"</code>. - - <br><dt><code>set/unset quickblank</code><dd>Do quick statusbar blanking. Statusbar messages will disappear after 1 +</p> +</dd> +<dt><code>set poslog</code></dt> +<dd><p>Save the cursor position of files between editing sessions. +</p> +</dd> +<dt><code>set preserve</code></dt> +<dd><p>Preserve the XON and XOFF keys (^Q and ^S). +</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 "brackets"), can end sentences. The default value is "!.?". +</p> +</dd> +<dt><code>set quickblank</code></dt> +<dd><p>Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. - - <br><dt><code>set quotestr "string"</code><dd>The email-quote string, used to justify email-quoted paragraphs. This +</p> +</dd> +<dt><code>set quiet</code></dt> +<dd><p>When set, <code>nano</code> 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. +</p> +</dd> +<dt><code>set quotestr "<var>string</var>"</code></dt> +<dd><p>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 - - <blockquote> -<code>"^([ \\t]*[#:>\\|}])+"</code> -</blockquote> - - <p>if you have extended regular expression support, or "> " otherwise. -Note that '\\t' stands for a literal Tab character. - - <br><dt><code>set/unset rebinddelete</code><dd>Interpret the Delete key differently so that both Backspace and Delete +</p> +<blockquote> +<p>"^([ \\t]*[#:>\\|}])+" +</p></blockquote> + +<p>if you have extended regular expression support, and "> " otherwise. +Note that ’\\t’ 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. - - <br><dt><code>set/unset rebindkeypad</code><dd>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. - - <br><dt><code>set/unset regexp</code><dd>Do extended regular expression searches by default. - - <br><dt><code>set/unset smarthome</code><dd>Make the Home key smarter. When Home is pressed anywhere but at the +</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 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. - - <br><dt><code>set/unset smooth</code><dd>Use smooth scrolling by default. - - <br><dt><code>set/unset softwrap</code><dd>Use soft wrapping by default. - - <br><dt><code>set speller "spellprog"</code><dd>Use spelling checker "spellprog" instead of the built-in one, which -calls "spell". - - <br><dt><code>set/unset suspend</code><dd>Allow <code>nano</code> to be suspended. - - <br><dt><code>set/unset suspendenable</code><dd>If <code>nano</code> is allowed to be suspended, allow the suspend key -(usually ^Z) to actually suspend it. - - <br><dt><code>set tabsize "n"</code><dd>Use a tab size of "n" columns. The value of "n" must be greater than 0. -The default value is 8. - - <br><dt><code>set/unset tabstospaces</code><dd>Convert typed tabs to spaces. - - <br><dt><code>set/unset tempfile</code><dd>Save automatically on exit, don't prompt. - - <br><dt><code>set/unset undo</code><dd>Enable experimental generic-purpose undo code. - - <br><dt><code>set/unset view</code><dd>Disallow file modification. - - <br><dt><code>set whitespace "string"</code><dd>Set the two characters used to display the first characters of tabs and -spaces. They must be single-column characters. - - <br><dt><code>set/unset wordbounds</code><dd>Detect word boundaries more accurately by treating punctuation +</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 "spellprog"</code></dt> +<dd><p>Use spelling checker "spellprog" instead of the built-in one, which +calls "spell". +</p> +</dd> +<dt><code>set statuscolor <var>fgcolor</var>,<var>bgcolor</var></code></dt> +<dd><p>Specify the color combination to use for the statusbar. +See <code>set titlecolor</code> for more details. +</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 8. +</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>Specify the color combination to use for the titlebar. +Valid color names for foreground and background are: +white, black, red, blue, green, yellow, magenta, and cyan. +And either <var>fgcolor</var> or <var>,bgcolor</var> may be left out. +</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 "»·", and for other locales ">.". +</p> +</dd> +<dt><code>set wordbounds</code></dt> +<dd><p>Detect word boundaries more accurately by treating punctuation characters as part of a word. +</p> +</dd> +</dl> - <br><dt><code>syntax "str" ["fileregex" ... ]</code><dd>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. - - <p>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". - - <br><dt><code>color fgcolor,bgcolor "regex" ...</code><dd>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" +<hr> +<a name="Syntax-Highlighting"></a> +<div class="header"> +<p> +Next: <a href="#Rebinding-Keys" accesskey="n" rel="next">Rebinding Keys</a>, Previous: <a href="#Settings" accesskey="p" rel="prev">Settings</a>, Up: <a href="#Nanorc-Files" accesskey="u" rel="up">Nanorc Files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<a name="Syntax-Highlighting-1"></a> +<h3 class="section">5.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 "str" ["fileregex" …]</code></dt> +<dd><p>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 this "str" +syntax until a new syntax is defined. +</p> +<p>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". +</p> +</dd> +<dt><code>linter program [arg …]</code></dt> +<dd><p>For the currently defined syntax, use the given program to invoke the +linter (this overrides the speller function when defined). +</p> +</dd> +<dt><code>formatter program [arg …]</code></dt> +<dd><p>For the currently defined syntax, use the given program to automatically +reformat text. Useful in certain programming languages (e.g. go). +</p> +</dd> +<dt><code>header "regex" …</code></dt> +<dd><p>For the currently defined syntax, add one or more regexes which will +be compared against the very first line of the file to be edited, +to determine whether this syntax should be used for that file. +</p> +</dd> +<dt><code>magic "regex" …</code></dt> +<dd><p>For the currently defined syntax, add one or more regexes which will be +compared against the result of querying the magic database about the file +to be edited, to determine whether this syntax should be used for that +file. This functionality only works when libmagic is installed on the +system and will be silently ignored otherwise. +</p> +</dd> +<dt><code>color fgcolor,bgcolor "regex" …</code></dt> +<dd><p>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. +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 fgcolor,bgcolor "regex" …</code></dt> +<dd><p>Same as above, except that the expression matching is case insensitive. +</p> +</dd> +<dt><code>color fgcolor,bgcolor start="sr" end="er"</code></dt> +<dd><p>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". +</p> +</dd> +<dt><code>icolor fgcolor,bgcolor start="sr" end="er"</code></dt> +<dd><p>Same as above, except that the expression matching is case insensitive. +</p> +</dd> +<dt><code>include "syntaxfile"</code></dt> +<dd><p>Read in self-contained color syntaxes from "syntaxfile". Note that +"syntaxfile" can only contain the above commands, from "syntax" to +"icolor". +</p> +</dd> +<dt><code>extendsyntax str directive [arg …]</code></dt> +<dd><p>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). +</p> +</dd> +</dl> - <br><dt><code>icolor fgcolor,bgcolor "regex" ...</code><dd>Same as above, except that the expression matching is case insensitive. +<hr> +<a name="Rebinding-Keys"></a> +<div class="header"> +<p> +Previous: <a href="#Syntax-Highlighting" accesskey="p" rel="prev">Syntax Highlighting</a>, Up: <a href="#Nanorc-Files" accesskey="u" rel="up">Nanorc Files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<a name="Rebinding-Keys-1"></a> +<h3 class="section">5.3 Rebinding Keys</h3> + +<p>Key bindings may be reassigned via the following two 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>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><dt><code>color fgcolor,bgcolor start="sr" end="er"</code><dd>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". +<p>The format of <code>key</code> should be one of: +</p> +<dl compact="compact"> +<dt><code>^</code></dt> +<dd><p>followed by an alpha character or the word "Space". +Example: <code>^C</code> +</p> +</dd> +<dt><code>M-</code></dt> +<dd><p>followed by a printable character or the word "Space". +Example: <code>M-C</code> +</p> +</dd> +<dt><code>F</code></dt> +<dd><p>followed by a numeric value from 1 to 16. +Example: <code>F10</code> +</p> +</dd> +</dl> - <br><dt><code>icolor fgcolor,bgcolor start="sr" end="er"</code><dd>Same as above, except that the expression matching is case insensitive. +<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. +</p> +</dd> +<dt><code>insert</code></dt> +<dd><p>Inserts a file into the current buffer (or into a new buffer when multibuffer +is enabled). +</p> +</dd> +<dt><code>whereis</code></dt> +<dd><p>Searches for text in the current buffer – or for filenames matching +a string in the current list in the file browser +</p> +</dd> +<dt><code>searchagain</code></dt> +<dd><p>Repeats the last search command. +</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>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 a linting program, if the current +syntax highlighting defines one). +</p> +</dd> +<dt><code>justify</code></dt> +<dd><p>Justifies the current paragraph. +</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>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 up one line of text from the current position. +</p> +</dd> +<dt><code>scrolldown</code></dt> +<dd><p>Scrolls down one line of text from the current position. +</p> +</dd> +<dt><code>nextword</code></dt> +<dd><p>Moves the cursor to the beginning of the next word. +</p> +</dd> +<dt><code>prevword</code></dt> +<dd><p>Moves the cursor to the beginning of the previous 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>prevpage</code></dt> +<dd><p>Goes up one screenful. +</p> +</dd> +<dt><code>nextpage</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). +</p> +</dd> +<dt><code>gototext</code></dt> +<dd><p>Switches from targeting a line number to searching for text. +</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 using multibuffer mode. +</p> +</dd> +<dt><code>nextbuf</code></dt> +<dd><p>Switches to editing/viewing the next buffer when using multibuffer mode. +</p> +</dd> +<dt><code>verbatim</code></dt> +<dd><p>Inserts the next character 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>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>flipexecute</code></dt> +<dd><p>Toggles between inserting a file and executing a 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>tofiles</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>constupdate</code></dt> +<dd><p>Toggles the constant display of the current line, column, and character positions. +</p> +</dd> +<dt><code>morespace</code></dt> +<dd><p>Toggles the presence of the blank line which ’separates’ the titlebar 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>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 new lines will contain the same amount of whitespace as the preceding line. +</p> +</dd> +<dt><code>cuttoend</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. +</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 the use of multiple file buffers (if available). +</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 sequence (normally ^Z) will suspend the editor window. +</p> +</dd> +</dl> - <br><dt><code>include "syntaxfile"</code><dd>Read in self-contained color syntaxes from "syntaxfile". Note that -"syntaxfile" can only contain "syntax", "color", and "icolor" commands. +<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 inserting or writing a file. +</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> - </dl> -<div class="node"> +<hr> <a name="The-File-Browser"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Pico-Compatibility">Pico Compatibility</a>, -Previous: <a rel="previous" accesskey="p" href="#Nanorc-Files">Nanorc Files</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +Next: <a href="#Pico-Compatibility" accesskey="n" rel="next">Pico Compatibility</a>, Previous: <a href="#Nanorc-Files" accesskey="p" rel="prev">Nanorc Files</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="The-File-Browser-1"></a> <h2 class="chapter">6 The File Browser</h2> -<p>When reading or writing files, pressing ^T will invoke the file browser. +<p>When reading or writing files, pressing ^T will invoke the file browser. Here, one can navigate directories in a graphical manner in order to find the desired file. - - <p>Basic movement in the file browser is accomplished with the arrow keys, +</p> +<p>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. +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. +</p> -<div class="node"> +<hr> <a name="Pico-Compatibility"></a> -<p><hr> -Next: <a rel="next" accesskey="n" href="#Building-and-Configure-Options">Building and Configure Options</a>, -Previous: <a rel="previous" accesskey="p" href="#The-File-Browser">The File Browser</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> - +<div class="header"> +<p> +Next: <a href="#Building-and-Configure-Options" accesskey="n" rel="next">Building and Configure Options</a>, Previous: <a href="#The-File-Browser" accesskey="p" rel="prev">The File Browser</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Pico-Compatibility-1"></a> <h2 class="chapter">7 Pico Compatibility</h2> <p><code>nano</code> attempts to emulate Pico as closely as possible, but there are certain differences between the editors: - - <dl> -<dt><code>Search and Replace History</code><dd>As of version 1.1.99pre1 of <code>nano</code>, text entered as search or +</p> +<dl compact="compact"> +<dt><code>Search and Replace History</code></dt> +<dd><p>As of version 1.1.99pre1 of <code>nano</code>, text entered as search or replace strings will be stored and can be accessed with the up/down arrow keys. Previously, <code>nano</code> offered a more consistent, but -incompatible with Pico, method for entering search and replace strings. +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 @@ -725,143 +1639,225 @@ with Pico via the <code>-p</code> option, but recent versions of Pico use the editor. Since, with the new method, search and replace strings can still be edited by simply hitting the up arrow key once, the old method was removed completely. +</p> - <br><dt><code>Writing, Appending, or Prepending Selected Text to Files</code><dd>Text selected using the marking key (^^) can be written out, appended, +</dd> +<dt><code>Writing, Appending, or Prepending Selected Text to Files</code></dt> +<dd><p>Text selected using the marking key (^^) can be written out, appended, or prepended to a new or existing file using the WriteOut key (^O). - - <br><dt><code>Toggles</code><dd>Many options which alter the functionality of the program can be -"toggled" on or off using Meta key sequences, meaning the program does +</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 of the editor on or off. Please see the internal help function (^G) for a list of what functions can be toggled for a particular version of <code>nano</code>. See See <a href="#Feature-Toggles">Feature Toggles</a>, for more info. - - <br><dt><code>Cursor Position Display</code><dd>The output of the "Display Cursor Position" in <code>nano</code> displays -the given column position, as well as the row and total character -position of the cursor. - - <br><dt><code>Interactive Replace and Spell Checker</code><dd>It is worth noting that <code>nano</code>'s replace function is interactive, -i.e. it does not stop after one search string is found and automatically -replace it. The <code>nano</code> implementation will pause at each search -string found and query whether to replace this instance or not. The +</p> +</dd> +<dt><code>Cursor Position Display</code></dt> +<dd><p>The output of the "Display Cursor Position" in <code>nano</code> displays +the current line position of the cursor, as well as the column and +total character position. +</p> +</dd> +<dt><code>Interactive Replace and Spell Checker</code></dt> +<dd><p>It is worth noting that <code>nano</code>’s replace function is interactive, +i.e. it does not stop after one search string was found and automatically +replaced. The <code>nano</code> implementation will pause at each found +search string and query whether to replace this instance or not. The internal spell checker operates similarly. Note that there is no way to force these functions to behave in the Pico fashion. As of version 1.1.99pre1, misspelled words are sorted and trimmed for uniqueness in -the internal spell checker such that the words 'apple' and 'Apple' will -be prompted for correction separately. +the internal spell checker such that the words ’apple’ and ’Apple’ will +be prompted for correction separately. +</p></dd> </dl> -<div class="node"> -<a name="Building-and-Configure-Options"></a> -<p><hr> -Previous: <a rel="previous" accesskey="p" href="#Pico-Compatibility">Pico Compatibility</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> +<hr> +<a name="Building-and-Configure-Options"></a> +<div class="header"> +<p> +Previous: <a href="#Pico-Compatibility" accesskey="p" rel="prev">Pico Compatibility</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> - +<a name="Building-and-Configure-Options-1"></a> <h2 class="chapter">8 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: - - <ul> -<li>tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of +</p> +<ul> +<li> tar xvfz nano-x.y.z.tar.gz (where x.y.z is the version of <code>nano</code>) -<li>cd nano-x.y.z/ -<li>./configure -<li>make -<li>make install -</ul> - - <p>The possible options to <code>./configure</code> are: - - <dl> -<dt><code>--disable-browser</code><dd>Disable the mini file browser when reading or writing files. +</li><li> cd nano-x.y.z/ +</li><li> ./configure +</li><li> make +</li><li> make install +</li></ul> - <br><dt><code>--disable-help</code><dd>Disable the help function. Doing this makes the binary much smaller, +<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 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 -Y command-line option, which chooses a specific syntax. +</p> +</dd> +<dt><code>--disable-extra</code></dt> +<dd><p>Disable extra features. At the moment, this is just easter-egg-type +stuff. +</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. - - <br><dt><code>--disable-justify</code><dd>Disable the justify and unjustify functions. - - <br><dt><code>--disable-mouse</code><dd>Disable all mouse functionality. This also disables the -m command line -option, which enables the mouse functionality. - - <br><dt><code>--disable-operatingdir</code><dd>Disable setting the operating directory. This also disables the -o -command line option, which sets the operating directory. - - <br><dt><code>--disable-speller</code><dd>Disable use of the spell checker. This also disables the -s command -line option, which allows specifying an alternate spell checker. - - <br><dt><code>--disable-tabcomp</code><dd>Disable the tab completion code when reading or writing files. - - <br><dt><code>--disable-wrapping</code><dd>Disable all long line wrapping. This also eliminates the -w command -line option, which enables long line wrapping. - - <br><dt><code>--enable-tiny</code><dd>This option disables all the above. It also disables some of the larger -internals of the editor, like the marking code and the cut to end of -line code. It also disables the function toggles. - - <br><dt><code>--enable-debug</code><dd>Enable support for runtime debug output. This can get pretty messy, so -chances are you only want this feature to work on the nano source. - - <br><dt><code>--enable-extra</code><dd>Enable extra features. At the moment, this is just easter egg-type -stuff. - - <br><dt><code>--enable-color</code><dd>Enable support for syntax coloring of files using the nanorc file. This -enables nanorc support as well. - - <br><dt><code>--enable-multibuffer</code><dd>Enable support for opening multiple files at a time and switching -between them on the fly. - - <br><dt><code>--enable-nanorc</code><dd>Enable support for reading the nanorc file at startup. You can store -custom settings in the nanorc file rather than having to pass command -line options to get desired behavior. See See <a href="#Nanorc-Files">Nanorc Files</a>, for -more info. - - <br><dt><code>--enable-all</code><dd>Shortcut for enabling the above four features (extra, color, -multibuffer, and nanorc). - - <br><dt><code>--disable-nls</code><dd>Disables Native Language support. This will disable use of the +</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 -H and -P 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-mouse</code></dt> +<dd><p>Disable all mouse functionality. This also eliminates the -m +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 -F command-line +option, which switches the use of multiple file buffers on. +</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 See <a href="#Nanorc-Files">Nanorc Files</a>, for more info. +Disabling this also eliminates the -I and -q command-line options; +the first inhibits the reading of nanorcfiles, and the second +suppresses warnings about errors in those files. +</p> +</dd> +<dt><code>--disable-operatingdir</code></dt> +<dd><p>Disable setting the operating directory. This also eliminates the -o +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 -s +command-line option, which allows specifying an alternate spell checker. +</p> +</dd> +<dt><code>--disable-tabcomp</code></dt> +<dd><p>Disable the tab completion code when reading or writing files. +</p> +</dd> +<dt><code>--disable-wrapping</code></dt> +<dd><p>Disable hard-wrapping of overlong lines. This also eliminates the -w +command-line option, which enables long-line wrapping. +</p> +</dd> +<dt><code>--enable-tiny</code></dt> +<dd><p>This option disables all the above. It also disables some of the larger +internals of the editor, like the marking code and the cut-to-end-of-line +code. It also disables the function toggles. By using the enabling +counterpart of the above options together with –enable-tiny, specific +features can be switched back on. +</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. - - <br><dt><code>--disable-wrapping-as-root</code><dd>Disable long line wrapping by default when nano is run as root. - - <br><dt><code>--enable-utf8</code><dd>Enable support for reading and writing Unicode files. This will require +</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>--with-slang</code></dt> +<dd><p>Compile <code>nano</code> against Slang instead of against ncurses or other +curses libraries. +</p> +</dd> +</dl> - <br><dt><code>--disable-utf8</code><dd>Disable support for reading and writing Unicode files. - - <br><dt><code>--with-slang</code><dd>Compiling <code>nano</code> with Slang is supported, and will make the binary -notably smaller than if compiled with ncurses or other curses libraries. +<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> + <ul class="no-bullet"> + <li><a name="toc-Overview-1" href="#Overview">1.1 Overview</a></li> + <li><a name="toc-Command-Line-Options-1" href="#Command-Line-Options">1.2 Command Line Options</a></li> + </ul></li> + <li><a name="toc-Editor-Basics-1" href="#Editor-Basics">2 Editor Basics</a> + <ul class="no-bullet"> + <li><a name="toc-Entering-Text-1" href="#Entering-Text">2.1 Entering Text</a></li> + <li><a name="toc-Special-Functions-1" href="#Special-Functions">2.2 Special Functions</a></li> + <li><a name="toc-The-Cutbuffer-1" href="#The-Cutbuffer">2.3 The Cutbuffer</a></li> + <li><a name="toc-The-Mark-1" href="#The-Mark">2.4 The Mark</a></li> + <li><a name="toc-The-Titlebar-1" href="#The-Titlebar">2.5 The Titlebar</a></li> + <li><a name="toc-The-Statusbar-1" href="#The-Statusbar">2.6 The Statusbar</a></li> + <li><a name="toc-Shortcut-Lists-1" href="#Shortcut-Lists">2.7 Shortcut Lists</a></li> + <li><a name="toc-Using-the-Mouse-1" href="#Using-the-Mouse">2.8 Using the Mouse</a></li> + </ul></li> + <li><a name="toc-Online-Help-1" href="#Online-Help">3 Online Help</a></li> + <li><a name="toc-Feature-Toggles-1" href="#Feature-Toggles">4 Feature Toggles</a></li> + <li><a name="toc-Nanorc-Files-1" href="#Nanorc-Files">5 Nanorc Files</a> + <ul class="no-bullet"> + <li><a name="toc-Settings-1" href="#Settings">5.1 Settings</a></li> + <li><a name="toc-Syntax-Highlighting-1" href="#Syntax-Highlighting">5.2 Syntax Highlighting</a></li> + <li><a name="toc-Rebinding-Keys-1" href="#Rebinding-Keys">5.3 Rebinding Keys</a></li> + </ul></li> + <li><a name="toc-The-File-Browser-1" href="#The-File-Browser">6 The File Browser</a></li> + <li><a name="toc-Pico-Compatibility-1" href="#Pico-Compatibility">7 Pico Compatibility</a></li> + <li><a name="toc-Building-and-Configure-Options-1" href="#Building-and-Configure-Options">8 Building and Configure Options</a></li> +</ul> +</div> - </dl> +<hr> - <div class="contents"> -<h2>Table of Contents</h2> -<ul> -<li><a name="toc_Introduction" href="#Introduction">1 Introduction</a> -<ul> -<li><a href="#Overview">1.1 Overview</a> -<li><a href="#Command-Line-Options">1.2 Command Line Options</a> -</li></ul> -<li><a name="toc_Editor-Basics" href="#Editor-Basics">2 Editor Basics</a> -<ul> -<li><a href="#Entering-Text">2.1 Entering Text</a> -<li><a href="#Special-Functions">2.2 Special Functions</a> -<li><a href="#The-Titlebar">2.3 The Titlebar</a> -<li><a href="#The-Statusbar">2.4 The Statusbar</a> -<li><a href="#Shortcut-Lists">2.5 Shortcut Lists</a> -<li><a href="#Using-the-Mouse">2.6 Using the Mouse</a> -</li></ul> -<li><a name="toc_Online-Help" href="#Online-Help">3 Online Help</a> -<li><a name="toc_Feature-Toggles" href="#Feature-Toggles">4 Feature Toggles</a> -<li><a name="toc_Nanorc-Files" href="#Nanorc-Files">5 Nanorc Files</a> -<li><a name="toc_The-File-Browser" href="#The-File-Browser">6 The File Browser</a> -<li><a name="toc_Pico-Compatibility" href="#Pico-Compatibility">7 Pico Compatibility</a> -<li><a name="toc_Building-and-Configure-Options" href="#Building-and-Configure-Options">8 Building and Configure Options</a> -</li></ul> -</div> -</body></html> +</body> +</html> |