diff options
Diffstat (limited to 'doc/man/nanorc.5')
| -rw-r--r-- | doc/man/nanorc.5 | 603 |
1 files changed, 368 insertions, 235 deletions
diff --git a/doc/man/nanorc.5 b/doc/man/nanorc.5 index 3c69209..c2c802d 100644 --- a/doc/man/nanorc.5 +++ b/doc/man/nanorc.5 @@ -1,6 +1,8 @@ .\" Hey, EMACS: -*- nroff -*- -.\" Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 -.\" Free Software Foundation, Inc. +.\" $Id: nanorc.5 5135 2015-03-08 15:59:15Z bens $ +.\" +.\" Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, +.\" 2013, 2014, 2015 Free Software Foundation, Inc. .\" .\" This document is dual-licensed. You may distribute and/or modify it .\" under the terms of either of the following licenses: @@ -18,242 +20,296 @@ .\" Documentation License along with this program. If not, see .\" <http://www.gnu.org/licenses/>. .\" -.\" $Id: nanorc.5 4508 2010-06-21 03:10:10Z astyanax $ -.TH NANORC 5 "version 2.0.0" "August 23, 2007" +.TH NANORC 5 "version 2.4.0" "March 2015" .\" Please adjust this date whenever revising the manpage. .\" .SH NAME nanorc \- GNU nano's rcfile .SH DESCRIPTION -This manual page briefly documents GNU \fBnano\fP's rcfile. -.PP -\fBnano\fP 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, \fBnano\fP also implements some -missing (or disabled by default) features in Pico, such as "search and -replace" and "go to line and column number". -.PP -The \fInanorc\fP file contains the default settings for \fBnano\fP. It -should not be in DOS or Mac format. During startup, \fBnano\fP will -first read its system-wide settings from \fISYSCONFDIR/nanorc\fP, and -then user-specific settings from \fI~/.nanorc\fP. +The \fInanorc\fP file contains the default settings for \fBnano\fP, a +small and friendly editor. The file should be in Unix format, not in +DOS or Mac format. During startup, \fBnano\fP will first read the +system-wide settings, from \fB/etc/nanorc\fP (the exact path might be +different), and then the user-specific settings, from \fB~/.nanorc\fP. .SH OPTIONS The configuration file accepts a series of \fBset\fP and \fBunset\fP commands, which can be used to configure nano on startup without using -the command line options. Additionally, the \fBsyntax\fP, \fBcolor\fP, -and \fBicolor\fP keywords are used to define syntax highlighting rules -for different text patterns. \fBnano\fP will read one command per line. - +command-line options. Additionally, there are some commands to define +syntax highlighting and to rebind keys -- see the two separate sections +on those. \fBnano\fP reads one command per line. +.PP Options in \fInanorc\fP files take precedence over nano's defaults, and -command line options override \fInanorc\fP settings. Also, options are -unset by default, except for those that take arguments. - -Quotes inside string parameters don't have to be escaped with +command-line options override \fInanorc\fP settings. Also, options that +do not take an argument are unset by default. So using the \fBunset\fR +command is only needed when wanting to override a setting of the system's +\fInanorc\fR file in your own \fB~/.nanorc\fR. Options that take an +argument cannot be unset. +.PP +Below, the \fIstring\fR parameters need to be enclosed in double quotes. +Quotes inside these 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 \fBbrackets\fP option, "\fI"')>]}\fP" will -match \fI"\fP, \fI'\fP, \fI)\fP, \fI>\fP, \fI]\fP, and \fI}\fP. - +end. For example, for the \fBbrackets\fP option, "\fB"')>]}\fP" will +match \fB"\fP, \fB'\fP, \fB)\fP, \fB>\fP, \fB]\fP, and \fB}\fP. +.PP The supported commands and arguments are: .TP 3 -.B set/unset allow_insecure_backup +.B set allow_insecure_backup When backing up files, allow the backup to succeed even if its permissions -can't be (re)set due to special OS considerations. You should +can't be (re)set due to special OS considerations. You should NOT enable this option unless you are sure you need it. .TP -.B set/unset autoindent +.B set autoindent Use auto-indentation. .TP -.B set/unset backup -Create backup files in \fIfilename~\fP. +.B set backup +Create backup files by adding a tilde (\fB~\fP) to each file's name. .TP .B set backupdir "\fIdirectory\fP" -Set the directory where \fBnano\fP puts unique backup files if file +Set the directory where \fBnano\fP puts unique backup files, if file backups are enabled. .TP -.B set/unset backwards +.B set backwards Do backwards searches by default. .TP -.B set/unset boldtext -Use bold text instead of reverse video text. +.B set boldtext +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 \fBtitlecolor\fP, \fBstatuscolor\fP, and \fBkeycolor\fP. .TP .B set brackets "\fIstring\fP" Set the characters treated as closing brackets when justifying -paragraphs. They cannot contain blank characters. Only closing -punctuation, optionally followed by closing brackets, can end sentences. -The default value is "\fI"')>]}\fP". +paragraphs. This may not include blank characters. Only closing +punctuation (see \fBpunct\fP), optionally followed by the specified +closing brackets, can end sentences. The default value is "\fB"')>]}\fP". .TP -.B set/unset casesensitive -Do case sensitive searches by default. +.B set casesensitive +Do case-sensitive searches by default. .TP -.B set/unset const +.B set const Constantly display the cursor position in the status bar. .TP -.B set/unset cut -Use cut to end of line by default. +.B set cut +Use cut-to-end-of-line by default, instead of cutting the whole line. +.TP +.B set fill \fInumber\fR +Hard-wrap lines at column number \fInumber\fR. If \fInumber\fR is 0 or less, +the maximum line length will be the screen width less \fInumber\fP columns. +The default value is \fB\-8\fR. .TP -.B set fill \fIn\fP -Wrap lines at column number \fIn\fP. If \fIn\fP is 0 or less, the -maximum line length will be the screen width less \fIn\fP columns. The -default value is \-8. +.B set functioncolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the function descriptions +in the two help lines at the bottom of the screen. +See \fBset titlecolor\fR for more details. .TP -.B set/unset historylog -Enable \fI~/.nano_history\fP for saving and reading search/replace -strings. +.B set historylog +Enable the use of \fB~/.nano/search_history\fP for saving and reading +search/replace strings. +.TP +.B set keycolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the shortcut key combos +in the two help lines at the bottom of the screen. +See \fBset titlecolor\fR for more details. +.TP +.B set locking +Enable vim-style lock-files for when editing files. .TP .B set matchbrackets "\fIstring\fP" 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 "\fI(<[{)>]}\fP". +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 "\fB(<[{)>]}\fP". .TP -.B set/unset morespace +.B set morespace Use the blank line below the titlebar as extra editing space. .TP -.B set/unset mouse +.B set mouse 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. +System, and on the console when gpm is running. Text can still be +selected through dragging by holding down the Shift key. .TP -.B set/unset multibuffer +.B set multibuffer Allow inserting files into their own buffers. .TP -.B set/unset noconvert +.B set noconvert Don't convert files from DOS/Mac format. .TP -.B set/unset nofollow +.B set nofollow Don't follow symlinks when writing files. .TP -.B set/unset nohelp -Don't display the help lists at the bottom of the screen. +.B set nohelp +Don't display the two help lines at the bottom of the screen. .TP -.B set/unset nonewlines -Don't add newlines to the ends of files. +.B set nonewlines +Don't automatically add a newline to the ends of files. .TP -.B set/unset nowrap -Don't wrap text at all. +.B set nowrap +Don't hard-wrap text at all. .TP .B set operatingdir "\fIdirectory\fP" \fBnano\fP will only read and write files inside \fIdirectory\fP and its subdirectories. Also, the current directory is changed to here, so -files are inserted from this diractory. By default, the operating +files are inserted from this directory. By default, the operating directory feature is turned off. .TP -.B set/unset preserve +.B set poslog +Save the cursor position of files between editing sessions. +.TP +.B set preserve Preserve the XON and XOFF keys (^Q and ^S). .TP .B set punct "\fIstring\fP" 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 "\fI!.?\fP". +paragraphs. This may not include blank characters. Only the +specfified closing punctuation, optionally followed by closing brackets +(see \fBbrackets\fP), can end sentences. The default value is "\fB!.?\fP". .TP -.B set/unset quiet -\fBnano\fP will not report errors in the \fInanorc\fP file and ask them -to be acknowledged by pressing enter at startup. If this is used it -should be placed at the top of the file to be fully effective. -.TP -.B set/unset quickblank +.B set quickblank Do quick statusbar blanking. Statusbar messages will disappear after 1 keystroke instead of 25. .TP +.B set quiet +\fBnano\fP will not report errors in the \fInanorc\fP file nor ask them +to be acknowledged by pressing Enter at startup. If this is used, it +should be placed at the top of the file to be fully effective. +.TP .B set quotestr "\fIstring\fP" 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 -"\fI^([\ \\t]*[#:>\\|}])+\fP" if you have extended regular expression -support, or "\fI>\ \fP" otherwise. Note that '\\t' stands for a literal +"\fB^([\ \\t]*[#:>\\|}])+\fP" if you have extended regular expression +support, and "\fB>\ \fP" otherwise. Note that '\\t' stands for a literal Tab character. .TP -.B set/unset rebinddelete +.B set rebinddelete Interpret the Delete key differently so that both Backspace and Delete work properly. You should only need to use this option if Backspace acts like Delete on your system. .TP -.B set/unset rebindkeypad +.B set rebindkeypad Interpret the numeric keypad keys so that they all work properly. You should only need to use this option if they don't, as mouse support won't work properly with this option enabled. .TP -.B set/unset regexp +.B set regexp Do extended regular expression searches by default. .TP -.B set/unset smarthome +.B set smarthome Make the Home key smarter. When Home is pressed anywhere but at the very beginning of non-whitespace characters on a line, the cursor will jump to that beginning (either forwards or backwards). If the cursor is already at that position, it will jump to the true beginning of the line. .TP -.B set/unset smooth +.B set smooth Use smooth scrolling by default. .TP -.B set/unset softwrap -Enable soft line wrapping for easier viewing of very long lones. +.B set softwrap +Enable soft line wrapping for easier viewing of very long lines. .TP .B set speller "\fIspellprog\fP" Use spelling checker \fIspellprog\fP instead of the built-in one, which calls \fIspell\fP. .TP -.B set/unset suspend +.B set statuscolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the statusbar. +See \fBset titlecolor\fR for more details. +.TP +.B set suspend Allow \fBnano\fP to be suspended. .TP -.B set tabsize \fIn\fP -Use a tab size of \fIn\fP columns. The value of \fIn\fP must be greater -than 0. The default value is 8. +.B set tabsize \fInumber\fR +Use a tab size of \fInumber\fR columns. The value of \fInumber\fP must be +greater than 0. The default value is \fB8\fR. .TP -.B set/unset tabstospaces +.B set tabstospaces Convert typed tabs to spaces. .TP -.B set/unset tempfile +.B set tempfile Save automatically on exit, don't prompt. .TP -.B set/unset undo -Enable experimental generic-purpose undo code. +.B set titlecolor \fIfgcolor\fR,\fIbgcolor\fR +Specify the color combination to use for the titlebar. +Valid color names for foreground and background are: +.BR white , \ black , \ red , \ blue , \ green , \ yellow , \ magenta ", and " cyan . +And either "\fIfgcolor\fR" or ",\fIbgcolor\fR" may be left out. .TP -.B set/unset view +.B set view Disallow file modification. .TP -.B set/unset softwrap -Enable soft line wrapping for easier viewing of very long lones. -.TP .B set whitespace "\fIstring\fP" -Set the two characters used to display the first characters of tabs and +Set the two characters used to indicate the presence of tabs and spaces. They must be single-column characters. .TP -.B set/unset wordbounds +.B set wordbounds Detect word boundaries more accurately by treating punctuation characters as parts of words. -.TP -.B syntax "\fIstr\fP" ["\fIfileregex\fP" ... ] + +.SH SYNTAX HIGHLIGHTING +Coloring the different syntactic elements of a file +is done via regular expressions (see the \fBcolor\fR 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 \fBnano\fR. +.sp +A separate syntax can be defined for each kind of file +via the following commands: +.TP +.BR syntax " ""\fIstr\fR"" [""\fIfileregex\fR"" ...]" Defines a syntax named \fIstr\fP which can be activated via the -\-Y/\-\-syntax command line option, or will be automatically activated if +.BR \-Y / \-\-syntax +command-line option, or will be automatically activated if the current filename matches the extended regular expression \fIfileregex\fP. All following \fBcolor\fP and \fBicolor\fP statements -will apply to \fIsyntax\fP until a new syntax is defined. +will apply to this \fIstr\fP syntax until a new syntax is defined. -The \fInone\fP syntax is reserved; specifying it on the command line is -the same as not having a syntax at all. The \fIdefault\fP syntax is +The \fBnone\fP syntax is reserved; specifying it on the command line is +the same as not having a syntax at all. The \fBdefault\fP syntax is special: it takes no \fIfileregex\fP, and applies to files that don't match any other syntax's \fIfileregex\fP. .TP -.B color \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... +.BI linter " program " \fR[ "arg " \fR...] +For the currently defined syntax, use the given \fIprogram\fR +to invoke the linter (this overrides the speller function when +defined). +.TP +.BI formatter " program " \fR[ "arg " \fR...] +For the currently defined syntax, use the given \fIprogram\fR +to automatically reformat text. Useful in certain programming +languages (e.g. go). +.TP +.BR header " \fIregex\fR " ... +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. +.TP +.BR magic " \fIregex\fR " ... +For the currently defined syntax, add one or more regexes which +will be compared against the result of querying the \fBmagic\fP +database about the file to be edited, to determine whether this +syntax should be used for that file. This +functionality only works when \fBlibmagic\fP is installed on the +system and will be silently ignored otherwise. +.TP +.B color \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... For the currently defined syntax, display all expressions matching the extended regular expression \fIregex\fP with foreground color \fIfgcolor\fP and background color \fIbgcolor\fP, at least one of which -must be specified. Legal colors for foreground and background color +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 force a stronger color highlight for the +use the prefix "bright" to get a stronger color highlight for the foreground. If your terminal supports transparency, not specifying a \fIbgcolor\fP tells \fBnano\fP to attempt to use a transparent background. .TP -.B icolor \fIfgcolor\fP,\fIbgcolor\fP "\fIregex\fP" ... +.B icolor \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... Same as above, except that the expression matching is case insensitive. .TP -.B color \fIfgcolor\fP,\fIbgcolor\fP start="\fIsr\fP" end="\fIer\fP" +.BR color " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIsr\fR"" " end= """\fIer\fR"" Display expressions which start with the extended regular expression \fIsr\fP and end with the extended regular expression \fIer\fP with foreground color \fIfgcolor\fP and background color \fIbgcolor\fP, @@ -262,244 +318,322 @@ highlighting to span multiple lines. Note that all subsequent instances of \fIsr\fP after an initial \fIsr\fP is found will be highlighted until the first instance of \fIer\fP. .TP -.B icolor \fIfgcolor\fP,\fIbgcolor\fP start="\fIsr\fP" end="\fIer\fP" +.BR icolor " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIsr\fR"" " end= """\fIer\fR"" Same as above, except that the expression matching is case insensitive. .TP -.B include "\fIsyntaxfile\fP" +.BR include " ""\fIsyntaxfile\fR""" Read in self-contained color syntaxes from \fIsyntaxfile\fP. Note that -\fIsyntaxfile\fP can only contain \fBsyntax\fP, \fBcolor\fP, and -\fBicolor\fP commands. -.SH KEY BINDINGS +\fIsyntaxfile\fP can only contain the above commands, from \fBsyntax\fP +to \fBicolor\fP. +.TP +.BI extendsyntax " str directive " \fR[ "arg " \fR...] +Extend the syntax previously defined as \fIstr\fP to include +new information. This allows you to add a new \fIcolor\fP, \fIicolor\fP, +\fImagic\fP, \fIheader\fP, or \fIlinter\fP 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). + +.SH REBINDING KEYS Key bindings may be reassigned via the following commands: .TP -.B bind \fIkey\fP \fIfunction\fP \fImenu\fP +.BI bind " key function menu" Rebinds the key \fIkey\fP to a new function named \fIfunction\fP in the -context of menu \fImenu\fP. The format of \fIkey\fP should be one of: +context of menu \fImenu\fP (or in all menus where the function exists +by using \fBall\fP). .TP -.B ^ +.BI unbind " key menu" +Unbinds the key \fIkey\fP from the menu named \fImenu\fP (or from all +menus where it exists by using \fBall\fP). + +.TP +The format of \fIkey\fP should be one of: +.RS 3 +.TP 3 +.B ^ followed by an alpha character or the word "Space". Example: ^C .TP -.B M- +.B M- followed by a printable character or the word "Space". Example: M-C .TP -.B F +.B F followed by a numeric value from 1 to 16. Example: F10 +.RE + .TP -Valid function names to be bound include: -.TP 3 +Valid \fIfunction\fP names to be bound include: +.RS 3 +.TP 2 .B help -Invoke the help menu. +Invokes the help viewer. .TP .B cancel -Cancel the current command. +Cancels the current command. .TP .B exit -Exit from the program. +Exits from the program (or from the help viewer or the file browser). .TP .B writeout -Write the current buffer to disk. -.TP -.B justify -Justify the current text. +Writes the current buffer to disk. .TP .B insert -Insert a file into the current buffer (or into a new buffer when multibuffer +Inserts a file into the current buffer (or into a new buffer when multibuffer is enabled). .TP .B whereis -Search for text in the current buffer. +Searches for text in the current buffer -- or for filenames matching +a string in the current list in the file browser. .TP .B searchagain -Repeat the last search command. +Repeats the last search command. .TP -.B up -Move up in the editor or browser. -.TP -.B down -Move down in the editor or browser. -.TP -.B left -Move left in the editor or browser. -.TP -.B right -Move right in the editor or browser. +.B replace +Interactively replaces text within the current buffer. .TP .B cut -Cut the current line of text and store it. +Cuts and stores the current line (or the marked region). +.TP +.B copytext +Copies the current line (or the marked region) without deleting it. .TP .B uncut -Copy the currently stored text into the current buffer position. +Copies the currently stored text into the current buffer at the +current cursor position. .TP -.B curpos -Show the current line, column, word positions in the file. +.B mark +Sets the mark at the current position, to start selecting text. .TP -.B firstline -Move to the first line of the file. +.B cutrestoffile +Cuts all text from the cursor position till the end of the buffer. .TP -.B lastline -Move to the last line of the file. +.B curpos +Shows the current cursor position: the line, column, and character positions. .TP -.B gotoline -Move to a specific line (and column if specified). +.B wordcount +Counts the number of words, lines and characters in the current buffer. .TP -.B replace -Interactively replace text within the current buffer. +.B speller +Invokes a spell-checking program (or a linting program, if the current +syntax highlighting defines one). .TP -.B mark -Begin selecting text for cutting or pasting at the current position. +.B justify +Justifies the current paragraph. .TP -.B copytext -Copy the currently marked text without deleting it. +.B fulljustify +Justifies the entire current buffer. .TP .B indent -Indent the currently marked text (shift to the right). +Indents (shifts to the right) the currently marked text. .TP .B unindent -Un-indent the currently marked text (shift to the left). +Unindents (shifts to the left) the currently marked text. +.TP +.B left +Goes left one position (in the editor or browser). +.TP +.B right +Goes right one position (in the editor or browser). +.TP +.B up +Goes one line up (in the editor or browser). +.TP +.B down +Goes one line down (in the editor or browser). +.TP +.B scrollup +Scrolls up one line of text from the current position. +.TP +.B scrolldown +Scrolls down one line of text from the current position. .TP .B nextword -Move the cursor to the beginning of the next word. +Moves the cursor to the beginning of the next word. .TP .B prevword -Move the cursor to the beginning of the previous word. +Moves the cursor to the beginning of the previous word. .TP .B home -Move the cursor to the beginning of the current line. +Moves the cursor to the beginning of the current line. .TP .B end -Move the cursor to the end of the current line. +Moves the cursor to the end of the current line. .TP .B beginpara -Move the cursor to the beginning of the current paragraph. +Moves the cursor to the beginning of the current paragraph. .TP .B endpara -Move the cursor to the end of the current paragraph. +Moves the cursor to the end of the current paragraph. .TP -.B findbracket -Move the cursor to the matching bracket (brace, parenthesis, etc.) of the one -under the cursor. +.B prevpage +Goes up one screenful. .TP -.B scrollup -Scroll up one line of text from the current position. +.B nextpage +Goes down one screenful. .TP -.B scrolldown -Scroll down one line of text from the current position. +.B firstline +Goes to the first line of the file. +.TP +.B lastline +Goes to the last line of the file. +.TP +.B gotoline +Goes to a specific line (and column if specified). +.TP +.B gototext +Switches from targeting a line number to searching for text. +.TP +.B findbracket +Moves the cursor to the bracket (brace, parenthesis, etc.) that matches +(pairs) with the one under the cursor. .TP .B prevbuf -Switch to editing/viewing the previous buffer when using multibuffer mode. +Switches to editing/viewing the previous buffer when using multibuffer mode. .TP .B nextbuf -Switch to editing/viewing the next buffer when using multibuffer mode. +Switches to editing/viewing the next buffer when using multibuffer mode. .TP .B verbatim -Insert the next character verbatim into the file. +Inserts the next character verbatim into the file. .TP .B tab -Insert a tab at the current cursor location. +Inserts a tab at the current cursor location. .TP .B enter -Insert a new line below the current one. +Inserts a new line below the current one. .TP .B delete -Delete the character under the cursor. +Deletes the character under the cursor. .TP -.B fulljustify -Justify the entire current file. -.TP -.B wordcount -Count the number of words in the current buffer. -.TP -.B refresh -Refresh the screen. +.B backspace +Deletes the character before the cursor. .TP .B undo -Undo the text action peformed (add text, delete text, etc). +Undoes the last performed text action (add text, delete text, etc). .TP .B redo -Redo the last undone action (i.e., undo an undo). +Redoes the last undone action (i.e., it undoes an undo). +.TP +.B refresh +Refreshes the screen. .TP .B suspend -Suspend the editor (if the suspend function is enabled, see the +Suspends the editor (if the suspending function is enabled, see the "suspendenable" entry below). .TP .B casesens -Toggle case sensitivity in searching (search/replace menus only). +Toggles case sensitivity in searching (search/replace menus only). .TP .B regexp -Toggle whether searching/replacing is based on literal strings or regular expressions. +Toggles whether searching/replacing is based on literal strings or regular expressions. +.TP +.B backwards +Toggles whether searching/replacing goes forward or backward. .TP .B prevhistory -Show the previous history entry in the prompt menus (e.g. search). +Shows the previous history entry in the prompt menus (e.g. search). .TP .B nexthistory -Show the next history entry in the prompt menus (e.g. search). +Shows the next history entry in the prompt menus (e.g. search). .TP -.B dontreplace -Switch back to searching instead of replacing. +.B flipreplace +Toggles between searching for something and replacing something. .TP -.B gototext -Search for files matching a string in the file browser (reading or writing files). +.B flipexecute +Toggles between inserting a file and executing a command. +.TP +.B flipnewbuffer +Toggles between inserting into the current buffer and into a new +empty buffer. +.TP +.B tofiles +Starts the file browser, allowing to select a file from a list. +.TP +.B gotodir +Goes to a directory to be specified, allowing to browse anywhere +in the filesystem. .TP .B dosformat -When writing a file, switch to writing a DOS format (CR/LF). +When writing a file, switches to writing a DOS format (CR/LF). .TP .B macformat -When writing a file, switch to writing a Mac format. +When writing a file, switches to writing a Mac format. .TP .B append -When writing a file, append to the end instead of overwriting. +When writing a file, appends to the end instead of overwriting. .TP .B prepend -When writing a file, 'prepend' (write at the beginning) instead of overwriting. +When writing a file, 'prepends' (writes at the beginning) instead of overwriting. .TP .B backup -When writing a file, create a backup of the current file. +When writing a file, creates a backup of the current file. .TP .B firstfile -Move to the first file when using the file browser (reading or writing files). +Goes to the first file when using the file browser (reading or writing files). .TP .B lastfile -Move to the last file when using the file browser (reading or writing files). +Goes to the last file when using the file browser (reading or writing files). .TP .B nohelp -Toggle showing/hiding the two-line list of key bindings at the bottom of the screen. +Toggles the presence of the two-line list of key bindings at the bottom of the screen. .TP .B constupdate -Constantly display the current line, column, word positions. +Toggles the constant display of the current line, column, and character positions. .TP .B morespace -Toggle showing/hiding the blank line which 'separates' the 'title' from the file text. +Toggles the presence of the blank line which 'separates' the titlebar from the file text. .TP .B smoothscroll -Toggle smooth scrolling when moving via the arrow keys. +Toggles smooth scrolling (when moving around with the arrow keys). +.TP +.B softwrap +Toggles the displaying of overlong lines on multiple screen lines. .TP .B whitespacedisplay -Toggle whether whitespace is shown. +Toggles the showing of whitespace. +.TP +.B nosyntax +Toggles syntax highlighting. .TP .B smarthome -Toggle whether the smart home key function is enabled. +Toggles the smartness of the Home key. .TP .B autoindent -Toggle whether new lines will contain the same amount of whitespace as the line above. +Toggles whether new lines will contain the same amount of whitespace as the preceding line. .TP .B cuttoend -Toggle whether cutting text will cut the whole line or just from the current cursor +Toggles whether cutting text will cut the whole line or just from the current cursor position to the end of the line. .TP .B nowrap -Toggle whether long lines will be wrapped to the next line. +Toggles whether long lines will be hard-wrapped to the next line. .TP -.B suspendenable -Toggle whether the suspend sequence (normally ^Z) will suspend the editor window. +.B tabstospaces +Toggles whether typed tabs will be converted to spaces. +.TP +.B backupfile +Toggles whether a backup will be made of the file to be edited. +.TP +.B multibuffer +Toggles the use of multiple file buffers (if support for them has been compiled in). .TP +.B mouse +Toggles mouse support. +.TP +.B noconvert +Toggles automatic conversion of files from DOS/Mac format. +.TP +.B suspendenable +Toggles whether the suspend sequence (normally ^Z) will suspend the editor window. +.RE -Valid menu sections are: .TP +Valid \fImenu\fP sections are: +.RS 3 +.TP 2 .B main -The main editor window where text is entered. +The main editor window where text is entered and edited. .TP .B search The search menu (AKA whereis). @@ -520,14 +654,17 @@ The 'write file' menu. The 'insert file' menu. .TP .B extcmd -The menu for inserting output from an external comman, reached from the insert menu. +The menu for inserting output from an external command, reached from the insert menu. .TP .B help -The help menu. +The help-viewer menu. .TP .B spell The interactive spell checker Yes/no menu. .TP +.B linter +The linter menu. +.TP .B browser The file browser for inserting or writing a file. .TP @@ -535,26 +672,22 @@ The file browser for inserting or writing a file. The 'search for a file' menu in the file browser. .TP .B gotodir -The 'go to directory' menu. +The 'go to directory' menu in the file browser. .TP .B all -A special name meaning: apply to all menus where this function exists. +A special name that encompasses all menus. +For \fBbind\fR it means all menus where the specified \fIfunction\fR exists; +for \fBunbind\fR it means all menus where the specified \fIkey\fR exists. +.RE -.TP -.B unbind \fIkey\fP \fImenu\fP -Unbind the key \fIkey\fP from the menu named \fImenu\fP or from all -menus by using \fIall\fP. Same key syntax as for binding. -Rebinds the key \fIkey\fP to a new function named \fIfunction\fP in the -context of menu \fImenu\fP. The format of \fIkey\fP should be one of: .SH FILES .TP -.I SYSCONFDIR/nanorc -System-wide configuration file +.B /etc/nanorc +System-wide configuration file. .TP -.I ~/.nanorc -Per-user configuration file +.B ~/.nanorc +Per-user configuration file. .SH SEE ALSO -.PD 0 .TP \fBnano\fP(1) .PP |