diff options
Diffstat (limited to 'doc/nanorc.sample.in')
| -rw-r--r-- | doc/nanorc.sample.in | 173 |
1 files changed, 54 insertions, 119 deletions
diff --git a/doc/nanorc.sample.in b/doc/nanorc.sample.in index f164c26..911f2b9 100644 --- a/doc/nanorc.sample.in +++ b/doc/nanorc.sample.in @@ -5,7 +5,7 @@ ## DOS or Mac format, and that characters specially interpreted by the ## shell should not be escaped here. ## -## To make sure a value is disabled, use "unset <option>". +## To make sure an option is disabled, use "unset <option>". ## ## For the options that take parameters, the default value is given. ## Other options are unset by default. @@ -15,10 +15,15 @@ ## its end. For example, for the "brackets" option, ""')>]}" will match ## ", ', ), >, ], and }. +## Silently ignore problems with unknown directives in the nanorc file. +## Useful when your nanorc file might be read on systems with multiple +## versions of nano installed (e.g. your home directory is on NFS). +# set quiet + ## Use auto-indentation. # set autoindent -## Backup files to filename~. +## Back up files to the current filename plus a tilde. # set backup ## The directory to put unique backup files in. @@ -34,32 +39,34 @@ ## paragraphs. They cannot contain blank characters. Only closing ## punctuation, optionally followed by closing brackets, can end ## sentences. -## # set brackets ""')>]}" -## Do case sensitive searches by default. +## Do case-sensitive searches by default. # set casesensitive ## Constantly display the cursor position in the statusbar. Note that ## this overrides "quickblank". # set const -## Use cut to end of line by default. +## Use cut-to-end-of-line by default. # set cut ## Set the line length for wrapping text and justifying paragraphs. -## If fill is 0 or less, the line length will be the screen width less -## this number. -## +## If the value is 0 or less, the wrapping point will be the screen +## width less this number. # set fill -8 ## Enable ~/.nano_history for saving and reading search/replace strings. # set historylog +## Enable vim-style lock-files. This is just to let a vim user know you +## are editing a file [s]he is trying to edit and vice versa. There are +## no plans to implement vim-style undo state in these files. +# set locking + ## 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. -## # set matchbrackets "(<[{)>]}" ## Use the blank line below the titlebar as extra editing space. @@ -69,13 +76,10 @@ ## 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. -## # set mouse -## Allow multiple file buffers (inserting a file will put it into a -## separate buffer). You must have configured with --enable-multibuffer -## for this to work. -## +## Switch on multiple file buffers (inserting a file will put it into +## a separate buffer). # set multibuffer ## Don't convert files from DOS/Mac format. @@ -96,10 +100,12 @@ ## Set operating directory. nano will not read or write files outside ## this directory and its subdirectories. Also, the current directory ## is changed to here, so any files are inserted from this dir. A blank -## string means the operating directory feature is turned off. -## +## string means the operating-directory feature is turned off. # set operatingdir "" +## Remember the cursor position in each file for the next editing session. +# set poslog + ## Preserve the XON and XOFF keys (^Q and ^S). # set preserve @@ -107,19 +113,18 @@ ## paragraphs. They cannot contain blank characters. Only closing ## punctuation, optionally followed by closing brackets, can end ## sentences. -## # set punct "!.?" ## Do quick statusbar blanking. Statusbar messages will disappear after ## 1 keystroke instead of 26. Note that "const" overrides this. -## # set quickblank ## 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. Default: +## otherwise a literal string. +## If you have extended regular expression support, the default is: # set quotestr "^([ ]*[#:>\|}])+" -## if you have extended regular expression support, otherwise: +## Otherwise: # set quotestr "> " ## Fix Backspace/Delete confusion problem. @@ -141,12 +146,11 @@ ## Use smooth scrolling as the default. # set smooth -## Enable soft line wrapping (AKA full line display). +## Enable soft line wrapping (AKA full-line display). # set softwrap ## Use this spelling checker instead of the internal one. This option ## does not properly have a default value. -## # set speller "aspell -x -c" ## Allow nano to be suspended. @@ -158,27 +162,34 @@ ## Convert typed tabs to spaces. # set tabstospaces -## Save automatically on exit, don't prompt. +## Save automatically on exit; don't prompt. # set tempfile -## Enable the new (EXPERIMENTAL) generic undo code, not just for line -## cuts. -# set undo - ## Disallow file modification. Why would you want this in an rcfile? ;) # set view ## The two single-column characters used to display the first characters ## of tabs and spaces. 187 in ISO 8859-1 (0000BB in Unicode) and 183 in ## ISO-8859-1 (0000B7 in Unicode) seem to be good values for these. -# set whitespace " " +## The default when in a UTF-8 locale: +# set whitespace "»·" +## The default otherwise: +# set whitespace ">." ## Detect word boundaries more accurately by treating punctuation ## characters as parts of words. # set wordbounds -## Color setup +## Paint the interface elements of nano. +## This is an example; by default there are no colors. +# set titlecolor brightwhite,blue +# set statuscolor brightwhite,green +# set keycolor green +# set functioncolor yellow + + +## Setup of syntax coloring. ## ## Format: ## @@ -193,8 +204,8 @@ ## or ## icolor foreground,background "regex" ["regex"...] ## -## "color" will do case sensitive matches, while "icolor" will do case -## insensitive matches. +## "color" will do case-sensitive matches, while "icolor" will do +## case-insensitive matches. ## ## Valid colors: white, black, red, blue, green, yellow, magenta, cyan. ## For foreground colors, you may use the prefix "bright" to get a @@ -207,9 +218,10 @@ ## color will use a transparent color. If you don't want this, be sure ## to set the background color to black or white. ## -## If you wish, you may put your syntaxes in separate files. You can -## make use of such files (which can only include "syntax", "color", and -## "icolor" commands) as follows: +## All regexes should be extended regular expressions. +## +## If you wish, you may put your syntax definitions in separate files. +## You can make use of such files as follows: ## ## include "/path/to/syntax_file.nanorc" ## @@ -218,95 +230,18 @@ ## name inside that file. These names are kept fairly short to make ## them easier to remember and faster to type using nano's -Y option. ## -## All regexes should be extended regular expressions. +## To include all existing syntax definitions, you can do: +# include "@PKGDATADIR@/*.nanorc" -## Key bindings -## Please see nanorc(5) for more details on this + +## Key bindings. +## See nanorc(5) for more details on this. ## -## Here are some samples to get you going +## Here are a few samples to get you going. ## # bind M-W nowrap main # bind M-A casesens search # bind ^S research main -## Set this if your backspace key sends delete most of the time (2.1.3+) -# bind kdel backspace all - - -## Nanorc files -# include "@PKGDATADIR@/nanorc.nanorc" - -## C/C++ -# include "@PKGDATADIR@/c.nanorc" - -## Makefiles -# include "@PKGDATADIR@/makefile.nanorc" - -## Cascading Style Sheets -# include "@PKGDATADIR@/css.nanorc" - -## Debian files -# include "@PKGDATADIR@/debian.nanorc" - -## Gentoo files -# include "@PKGDATADIR@/gentoo.nanorc" - -## HTML -# include "@PKGDATADIR@/html.nanorc" - -## PHP -# include "@PKGDATADIR@/php.nanorc" - -## TCL -# include "@PKGDATADIR@/tcl.nanorc" - -## TeX -# include "@PKGDATADIR@/tex.nanorc" - -## Quoted emails (under e.g. mutt) -# include "@PKGDATADIR@/mutt.nanorc" - -## Patch files -# include "@PKGDATADIR@/patch.nanorc" - -## Manpages -# include "@PKGDATADIR@/man.nanorc" - -## Groff -# include "@PKGDATADIR@/groff.nanorc" - -## Perl -# include "@PKGDATADIR@/perl.nanorc" - -## Python -# include "@PKGDATADIR@/python.nanorc" - -## Ruby -# include "@PKGDATADIR@/ruby.nanorc" - -## Java -# include "@PKGDATADIR@/java.nanorc" - -## Fortran -# include "@PKGDATADIR@/fortran.nanorc" - -## Objective-C -# include "@PKGDATADIR@/objc.nanorc" - -## OCaml -# include "@PKGDATADIR@/ocaml.nanorc" - -## AWK -# include "@PKGDATADIR@/awk.nanorc" - -## Assembler -# include "@PKGDATADIR@/asm.nanorc" - -## Bourne shell scripts -# include "@PKGDATADIR@/sh.nanorc" - -## POV-Ray -# include "@PKGDATADIR@/pov.nanorc" - -## XML-type files -# include "@PKGDATADIR@/xml.nanorc" +## Set this if your backspace key sends Del most of the time. +# bind Del backspace all |