diff options
Diffstat (limited to 'doc/man/nano.1.html')
| -rw-r--r-- | doc/man/nano.1.html | 352 |
1 files changed, 183 insertions, 169 deletions
diff --git a/doc/man/nano.1.html b/doc/man/nano.1.html index cb1101e..bd7b43f 100644 --- a/doc/man/nano.1.html +++ b/doc/man/nano.1.html @@ -1,5 +1,5 @@ -<!-- Creator : groff version 1.20.1 --> -<!-- CreationDate: Tue Aug 10 22:44:00 2010 --> +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Sun Mar 22 23:46:10 2015 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -48,22 +48,20 @@ Nano’s ANOther editor, an enhanced free Pico clone</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> -<i>[OPTIONS] [[+LINE,COLUMN] FILE]...</i></p> +[<i>options</i>] +[[+<i>line</i>,<i>column</i>] <i>file</i>]...</p> <h2>DESCRIPTION <a name="DESCRIPTION"></a> </h2> -<p style="margin-left:11%; margin-top: 1em">This manual -page briefly documents the <b>nano</b> command.</p> - <p style="margin-left:11%; margin-top: 1em"><b>nano</b> is a small, free and friendly editor which aims to replace Pico, the default editor included in the non-free Pine -package. Rather than just copying Pico’s look and -feel, <b>nano</b> also implements some missing (or disabled -by default) features in Pico, such as "search and +package. On top of copying Pico’s look and feel, +<b>nano</b> also implements some missing (or disabled by +default) features in Pico, such as "search and replace" and "go to line and column number".</p> @@ -73,32 +71,15 @@ number".</p> -<p style="margin-left:11%; margin-top: 1em"><b>+</b><i>LINE</i><b>,</b><i>COLUMN</i></p> - -<p style="margin-left:22%;">Places cursor at line number -<i>LINE</i> and column number <i>COLUMN</i> (at least one of -which must be specified) on startup, instead of the default -of line 1, column 1.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−?</b></p></td> -<td width="8%"></td> -<td width="30%"> +<p style="margin-left:11%; margin-top: 1em"><b>+</b><i>line</i><b>,</b><i>column</i></p> +<p style="margin-left:22%;">Places the cursor on line +number <i>line</i> and at column number <i>column</i> (at +least one of which must be specified) on startup, instead of +the default line 1, column 1.</p> -<p>Same as <b>-h (−−help)</b>.</p></td> -<td width="48%"> -</td></tr> -</table> - -<p style="margin-left:11%;"><b>−A -(−−smarthome)</b></p> +<p style="margin-left:11%;"><b>−A</b>, +<b>−−smarthome</b></p> <p style="margin-left:22%;">Make the Home key smarter. When Home is pressed anywhere but at the very beginning of @@ -107,277 +88,309 @@ that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line.</p> -<p style="margin-left:11%;"><b>−B -(−−backup)</b></p> +<p style="margin-left:11%;"><b>−B</b>, +<b>−−backup</b></p> <p style="margin-left:22%;">When saving a file, back up the previous version of it to the current filename suffixed with -a ~.</p> +a tilde (<b>~</b>).</p> + -<p style="margin-left:11%;"><b>−C</b> <i>dir</i> -<b>(−−backupdir=</b><i>dir</i><b>)</b></p> +<p style="margin-left:11%;"><b>−C </b><i>directory</i>, +<b>−−backupdir=</b><i>directory</i></p> <p style="margin-left:22%;">Set the directory where -<b>nano</b> puts unique backup files if file backups are +<b>nano</b> puts unique backup files, if file backups are enabled.</p> -<p style="margin-left:11%;"><b>−D -(−−boldtext)</b></p> +<p style="margin-left:11%;"><b>−D</b>, +<b>−−boldtext</b></p> <p style="margin-left:22%;">Use bold text instead of reverse video text.</p> -<p style="margin-left:11%;"><b>−E -(−−tabstospaces)</b></p> +<p style="margin-left:11%;"><b>−E</b>, +<b>−−tabstospaces</b></p> <p style="margin-left:22%;">Convert typed tabs to spaces.</p> -<p style="margin-left:11%;"><b>−F -(−−multibuffer)</b></p> +<p style="margin-left:11%;"><b>−F</b>, +<b>−−multibuffer</b></p> + +<p style="margin-left:22%;">Enable multiple file buffers +(if support for them has been compiled in).</p> -<p style="margin-left:22%;">Enable multiple file buffers, -if available.</p> +<p style="margin-left:11%;"><b>−G</b>, +<b>−−locking</b></p> -<p style="margin-left:11%;"><b>−H -(−−historylog)</b></p> +<p style="margin-left:22%;">Enable vim-style file locking +when editing files.</p> + +<p style="margin-left:11%;"><b>−H</b>, +<b>−−historylog</b></p> <p style="margin-left:22%;">Log search and replace strings -to <i>~/.nano_history</i>, so they can be retrieved in later -sessions, if <i>nanorc</i> support is available.</p> +to <i>~/.nano/search_history</i>, so they can be retrieved +in later sessions.</p> -<p style="margin-left:11%;"><b>−I -(−−ignorercfiles)</b></p> +<p style="margin-left:11%;"><b>−I</b>, +<b>−−ignorercfiles</b></p> -<p style="margin-left:22%;">Don’t look at -<i>SYSCONFDIR/nanorc</i> or <i>~/.nanorc</i>, if -<i>nanorc</i> support is available.</p> +<p style="margin-left:22%;">Don’t look at the +system’s <b>nanorc</b> nor at <b>~/.nanorc</b>.</p> -<p style="margin-left:11%;"><b>−K -(−−rebindkeypad)</b></p> +<p style="margin-left:11%;"><b>−K</b>, +<b>−−rebindkeypad</b></p> <p style="margin-left:22%;">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> -<p style="margin-left:11%;"><b>−L -(−−nonewlines)</b></p> +<p style="margin-left:11%;"><b>−L</b>, +<b>−−nonewlines</b></p> <p style="margin-left:22%;">Don’t add newlines to the ends of files.</p> -<p style="margin-left:11%;"><b>−N -(−−noconvert)</b></p> +<p style="margin-left:11%;"><b>−N</b>, +<b>−−noconvert</b></p> <p style="margin-left:22%;">Disable automatic conversion of files from DOS/Mac format.</p> -<p style="margin-left:11%;"><b>−O -(−−morespace)</b></p> +<p style="margin-left:11%;"><b>−O</b>, +<b>−−morespace</b></p> <p style="margin-left:22%;">Use the blank line below the titlebar as extra editing space.</p> -<p style="margin-left:11%;"><b>−Q</b> <i>str</i> -<b>(−−quotestr=</b><i>str</i><b>)</b></p> +<p style="margin-left:11%;"><b>−P</b>, +<b>−−poslog</b></p> + +<p style="margin-left:22%;">Log and later read back the +location of the cursor and place it there again.</p> + +<p style="margin-left:11%;"><b>−Q +"</b><i>characters</i><b>"</b>, +<b>−−quotestr="</b><i>characters</i><b>"</b></p> <p style="margin-left:22%;">Set the quoting string for justifying. The default is -"<i>^([ \t]*[#:>\|}])+</i>" if extended +<b>"^([ \t]*[#:>\|}])+"</b> if extended regular expression support is available, or -"<i>> </i>" otherwise. Note that <i>\t</i> +<b>"> "</b> otherwise. Note that <b>\t</b> stands for a Tab.</p> -<p style="margin-left:11%;"><b>−R -(−−restricted)</b></p> +<p style="margin-left:11%;"><b>−R</b>, +<b>−−restricted</b></p> <p style="margin-left:22%;">Restricted mode: don’t read or write to any file not specified on the command line; -read any <i>nanorc</i> 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 <b>nano</b> with any -name beginning with ’r’ (e.g. -"rnano").</p> +don’t read any <i>nanorc</i> 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 <b>nano</b> with any name beginning with +’r’ (e.g. "rnano").</p> -<p style="margin-left:11%;"><b>−S -(−−smooth)</b></p> +<p style="margin-left:11%;"><b>−S</b>, +<b>−−smooth</b></p> <p style="margin-left:22%;">Enable smooth scrolling. Text will scroll line-by-line, instead of the usual chunk-by-chunk behavior.</p> -<p style="margin-left:11%;"><b>−T</b> <i>cols</i> -<b>(−−tabsize=</b><i>cols</i><b>)</b></p> + +<p style="margin-left:11%;"><b>−T </b><i>number</i>, +<b>−−tabsize=</b><i>number</i></p> <p style="margin-left:22%;">Set the size (width) of a tab -to <i>cols</i> columns. The value of <i>cols</i> must be +to <i>number</i> columns. The value of <i>number</i> must be greater than 0. The default value is 8.</p> -<p style="margin-left:11%;"><b>−U -(−−quickblank)</b></p> +<p style="margin-left:11%;"><b>−U</b>, +<b>−−quickblank</b></p> <p style="margin-left:22%;">Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead -of 25. Note that <b>-c</b> overrides this.</p> +of 25. Note that <b>−c</b> overrides this.</p> -<p style="margin-left:11%;"><b>−V -(−−version)</b></p> +<p style="margin-left:11%;"><b>−V</b>, +<b>−−version</b></p> <p style="margin-left:22%;">Show the current version number and exit.</p> -<p style="margin-left:11%;"><b>−W -(−−wordbounds)</b></p> +<p style="margin-left:11%;"><b>−W</b>, +<b>−−wordbounds</b></p> <p style="margin-left:22%;">Detect word boundaries more accurately by treating punctuation characters as part of a word.</p> -<p style="margin-left:11%;"><b>−Y</b> <i>str</i> -<b>(−−syntax=</b><i>str</i><b>)</b></p> -<p style="margin-left:22%;">Specify a specific syntax -highlighting from the <i>nanorc</i> to use, if -available.</p> +<p style="margin-left:11%;"><b>−Y </b><i>name</i>, +<b>−−syntax=</b><i>name</i></p> + +<p style="margin-left:22%;">Specify the name of the syntax +highlighting to use from among the ones defined in the +<i>nanorc</i> files.</p> -<p style="margin-left:11%;"><b>−c -(−−const)</b></p> +<p style="margin-left:11%;"><b>−c</b>, +<b>−−const</b></p> <p style="margin-left:22%;">Constantly show the cursor -position. Note that this overrides <b>-U</b>.</p> +position. Note that this overrides <b>−U</b>.</p> -<p style="margin-left:11%;"><b>−d -(−−rebinddelete)</b></p> +<p style="margin-left:11%;"><b>−d</b>, +<b>−−rebinddelete</b></p> <p style="margin-left:22%;">Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system.</p> -<p style="margin-left:11%;"><b>−h -(−−help)</b></p> +<p style="margin-left:11%;"><b>−h</b>, +<b>−−help</b></p> -<p style="margin-left:22%;">Show a summary of command line -options and exit.</p> +<p style="margin-left:22%;">Show a summary of the available +command-line options and exit.</p> -<p style="margin-left:11%;"><b>−i -(−−autoindent)</b></p> +<p style="margin-left:11%;"><b>−i</b>, +<b>−−autoindent</b></p> <p style="margin-left:22%;">Indent new lines to the previous line’s indentation. Useful when editing source code.</p> -<p style="margin-left:11%;"><b>−k -(−−cut)</b></p> +<p style="margin-left:11%;"><b>−k</b>, +<b>−−cut</b></p> -<p style="margin-left:22%;">Enable cut from cursor to end -of line.</p> +<p style="margin-left:22%;">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> -<p style="margin-left:11%;"><b>−l -(−−nofollow)</b></p> +<p style="margin-left:11%;"><b>−l</b>, +<b>−−nofollow</b></p> <p style="margin-left:22%;">If the file being edited is a symbolic link, replace the link with a new file instead of following it. Good for editing files in <i>/tmp</i>, perhaps?</p> -<p style="margin-left:11%;"><b>−m -(−−mouse)</b></p> +<p style="margin-left:11%;"><b>−m</b>, +<b>−−mouse</b></p> <p style="margin-left:22%;">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.</p> +Window System, and on the console when gpm is running. Text +can still be selected through dragging by holding down the +Shift key.</p> + +<p style="margin-left:11%;"><b>−n</b>, +<b>−−noread</b></p> + +<p style="margin-left:22%;">Treat any name given on the +command line as a new file. This allows <b>nano</b> 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 <b>nano</b> can be used as an editor in combination +with for instance <b>gpg</b> without having to write +sensitive data to disk first.</p> -<p style="margin-left:11%;"><b>−o</b> <i>dir</i> -<b>(−−operatingdir=</b><i>dir</i><b>)</b></p> -<p style="margin-left:22%;">Set operating directory. Makes -<b>nano</b> set up something similar to a chroot.</p> +<p style="margin-left:11%;"><b>−o </b><i>directory</i>, +<b>−−operatingdir=</b><i>directory</i></p> -<p style="margin-left:11%;"><b>−p -(−−preserve)</b></p> +<p style="margin-left:22%;">Set the operating directory. +This makes <b>nano</b> set up something similar to a +chroot.</p> + +<p style="margin-left:11%;"><b>−p</b>, +<b>−−preserve</b></p> <p style="margin-left:22%;">Preserve the XON and XOFF sequences (^Q and ^S) so they will be caught by the terminal.</p> -<p style="margin-left:11%;"><b>−q -(−−quiet)</b></p> +<p style="margin-left:11%;"><b>−q</b>, +<b>−−quiet</b></p> <p style="margin-left:22%;">Do not report errors in the -<i>nanorc</i> file and ask them to be acknowledged by +<i>nanorc</i> files nor ask them to be acknowledged by pressing Enter at startup.</p> -<p style="margin-left:11%;"><b>−r</b> <i>cols</i> -<b>(−−fill=</b><i>cols</i><b>)</b></p> -<p style="margin-left:22%;">Wrap lines at column -<i>cols</i>. If this value is 0 or less, wrapping will occur -at the width of the screen less <i>cols</i> columns, +<p style="margin-left:11%;"><b>−r </b><i>number</i>, +<b>−−fill=</b><i>number</i></p> + +<p style="margin-left:22%;">Hard-wrap lines at column +<i>number</i>. If this value is 0 or less, wrapping will +occur at the width of the screen less <i>number</i> columns, allowing the wrap point to vary along with the width of the screen if the screen is resized. The default value is -−8.</p> +−8. This option conflicts with <b>−w</b> -- the +last one given takes effect.</p> + -<p style="margin-left:11%;"><b>−s</b> <i>prog</i> -<b>(−−speller=</b><i>prog</i><b>)</b></p> +<p style="margin-left:11%;"><b>−s </b><i>program</i>, +<b>−−speller=</b><i>program</i></p> -<p style="margin-left:22%;">Enable alternative spell +<p style="margin-left:22%;">Use this alternative spell checker command.</p> -<p style="margin-left:11%;"><b>−t -(−−tempfile)</b></p> +<p style="margin-left:11%;"><b>−t</b>, +<b>−−tempfile</b></p> -<p style="margin-left:22%;">Always save changed buffer -without prompting. Same as Pico’s <b>-t</b> +<p style="margin-left:22%;">Always save a changed buffer +without prompting. Same as Pico’s <b>−t</b> option.</p> -<p style="margin-left:11%;"><b>−u -(−−undo)</b></p> - -<p style="margin-left:22%;">Enable experimental -generic-purpose undo code. By default, the undo and redo -shortcuts are Meta-U and Meta-E, respectively.</p> - -<p style="margin-left:11%;"><b>−v -(−−view)</b></p> +<p style="margin-left:11%;"><b>−v</b>, +<b>−−view</b></p> -<p style="margin-left:22%;">View file (read only) mode.</p> +<p style="margin-left:22%;">View-file (read-only) mode.</p> -<p style="margin-left:11%;"><b>−w -(−−nowrap)</b></p> +<p style="margin-left:11%;"><b>−w</b>, +<b>−−nowrap</b></p> -<p style="margin-left:22%;">Disable wrapping of long -lines.</p> +<p style="margin-left:22%;">Disable the hard-wrapping of +long lines. This option conflicts with <b>−r</b> -- +the last one given takes effect.</p> -<p style="margin-left:11%;"><b>−x -(−−nohelp)</b></p> +<p style="margin-left:11%;"><b>−x</b>, +<b>−−nohelp</b></p> -<p style="margin-left:22%;">Disable help screen at bottom -of editor.</p> +<p style="margin-left:22%;">Don’t show the two help +lines at the bottom of the screen.</p> -<p style="margin-left:11%;"><b>−z -(−−suspend)</b></p> +<p style="margin-left:11%;"><b>−z</b>, +<b>−−suspend</b></p> -<p style="margin-left:22%;">Enable suspend ability.</p> +<p style="margin-left:22%;">Enable the suspend ability.</p> -<p style="margin-left:11%;"><b>−$ -(−−softwrap)</b></p> +<p style="margin-left:11%;"><b>−$</b>, +<b>−−softwrap</b></p> <p style="margin-left:22%;">Enable ’soft -wrapping’. <b>nano</b> will attempt to display the -entire contents of a line, even if it is longer than the -screen width. Since ’$’ normally refers to a +wrapping’. This will make <b>nano</b> 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 ’$’ 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 −$’).</p> -<p style="margin-left:11%;"><b>−a, −b, -−e, −f, −g, −j</b></p> +<p style="margin-left:11%;"><b>−a</b>, +<b>−b</b>, <b>−e</b>, <b>−f</b>, +<b>−g</b>, <b>−j</b></p> <p style="margin-left:22%;">Ignored, for compatibility with Pico.</p> @@ -388,10 +401,11 @@ Pico.</p> <p style="margin-left:11%; margin-top: 1em"><b>nano</b> -will read initialization files in the following order: -<i>SYSCONFDIR/nanorc</i>, then <i>~/.nanorc</i>. Please see -<b>nanorc(5)</b> and the example file <b>nanorc.sample</b>, -both of which should be provided with <b>nano</b>.</p> +will read initialization files in the following order: the +system’s <b>nanorc</b> (if it exists), and then the +user’s <b>~/.nanorc</b> (if it exists). Please see +<b>nanorc</b>(5) for more information on the possible +contents of those files.</p> <h2>NOTES <a name="NOTES"></a> @@ -400,7 +414,7 @@ both of which should be provided with <b>nano</b>.</p> <p style="margin-left:11%; margin-top: 1em">If no alternative spell checker command is specified on the -command line or in one of the <i>nanorc</i> files, +command line nor in one of the <i>nanorc</i> files, <b>nano</b> will check the <b>SPELL</b> environment variable for one.</p> @@ -458,7 +472,7 @@ email to <b>nano-devel-request@gnu.org</b> with a subject of <p style="margin-left:11%; margin-top: 1em">Chris -Allegretta <chrisa@asty.org>, et al (see +Allegretta <chrisa@asty.org>, et al (see the files <i>AUTHORS</i> and <i>THANKS</i> for details). This manual page was originally written by Jordi Mallach <jordi@gnu.org>, for the Debian system (but may be |