Blame doc/sample.nanorc.in

Packit Service c30d13
## Sample initialization file for GNU nano.
Packit Service c30d13
##
Packit Service c30d13
## Please note that you must have configured nano with --enable-nanorc
Packit Service c30d13
## for this file to be read!  Also note that this file should not be in
Packit Service c30d13
## DOS or Mac format, and that characters specially interpreted by the
Packit Service c30d13
## shell should not be escaped here.
Packit Service c30d13
##
Packit Service c30d13
## To make sure an option is disabled, use "unset <option>".
Packit Service c30d13
##
Packit Service c30d13
## For the options that take parameters, the default value is given.
Packit Service c30d13
## Other options are unset by default.
Packit Service c30d13
##
Packit Service c30d13
## Quotes inside string parameters don't have to be escaped with
Packit Service c30d13
## backslashes.  The last double quote in the string will be treated as
Packit Service c30d13
## its end.  For example, for the "brackets" option, ""')>]}" will match
Packit Service c30d13
## ", ', ), >, ], and }.
Packit Service c30d13
Packit Service c30d13
## Make the 'nextword' function (Ctrl+Right) stop at word ends
Packit Service c30d13
## instead of at beginnings.
Packit Service c30d13
# set afterends
Packit Service c30d13
Packit Service c30d13
## When soft line wrapping is enabled, make it wrap lines at blanks
Packit Service c30d13
## (tabs and spaces) instead of always at the edge of the screen.
Packit Service c30d13
# set atblanks
Packit Service c30d13
Packit Service c30d13
## Automatically indent a newly created line to the same number of
Packit Service c30d13
## tabs and/or spaces as the preceding line -- or as the next line
Packit Service c30d13
## if the preceding line is the beginning of a paragraph.
Packit Service c30d13
# set autoindent
Packit Service c30d13
Packit Service c30d13
## Back up files to the current filename plus a tilde.
Packit Service c30d13
# set backup
Packit Service c30d13
Packit Service c30d13
## The directory to put unique backup files in.
Packit Service c30d13
# set backupdir ""
Packit Service c30d13
Packit Service c30d13
## Use bold text instead of reverse video text.
Packit Service c30d13
# set boldtext
Packit Service c30d13
Packit Service c30d13
## The characters treated as closing brackets when justifying paragraphs.
Packit Service c30d13
## This may not include any blank characters.  Only closing punctuation,
Packit Service c30d13
## optionally followed by these closing brackets, can end sentences.
Packit Service c30d13
# set brackets ""')>]}"
Packit Service c30d13
Packit Service c30d13
## Do case-sensitive searches by default.
Packit Service c30d13
# set casesensitive
Packit Service c30d13
Packit Service c30d13
## Constantly display the cursor position in the status bar.  Note that
Packit Service c30d13
## this overrides "quickblank".
Packit Service c30d13
# set constantshow
Packit Service c30d13
Packit Service c30d13
## Use cut-from-cursor-to-end-of-line by default.
Packit Service c30d13
# set cutfromcursor
Packit Service c30d13
## (The old form, 'cut', is deprecated.)
Packit Service c30d13
Packit Service c30d13
## Set the line length for wrapping text and justifying paragraphs.
Packit Service c30d13
## If the value is 0 or less, the wrapping point will be the screen
Packit Service c30d13
## width less this number.
Packit Service c30d13
# set fill -8
Packit Service c30d13
Packit Service c30d13
## Remember the used search/replace strings for the next session.
Packit Service c30d13
# set historylog
Packit Service c30d13
Packit Service c30d13
## Display line numbers to the left of the text.
Packit Service c30d13
# set linenumbers
Packit Service c30d13
Packit Service c30d13
## Enable vim-style lock-files.  This is just to let a vim user know you
Packit Service c30d13
## are editing a file [s]he is trying to edit and vice versa.  There are
Packit Service c30d13
## no plans to implement vim-style undo state in these files.
Packit Service c30d13
# set locking
Packit Service c30d13
Packit Service c30d13
## The opening and closing brackets that can be found by bracket
Packit Service c30d13
## searches.  They cannot contain blank characters.  The former set must
Packit Service c30d13
## come before the latter set, and both must be in the same order.
Packit Service c30d13
# set matchbrackets "(<[{)>]}"
Packit Service c30d13
Packit Service c30d13
## Use the blank line below the title bar as extra editing space.
Packit Service c30d13
# set morespace
Packit Service c30d13
Packit Service c30d13
## Enable mouse support, if available for your system.  When enabled,
Packit Service c30d13
## mouse clicks can be used to place the cursor, set the mark (with a
Packit Service c30d13
## double click), and execute shortcuts.  The mouse will work in the X
Packit Service c30d13
## Window System, and on the console when gpm is running.
Packit Service c30d13
# set mouse
Packit Service c30d13
Packit Service c30d13
## Switch on multiple file buffers (inserting a file will put it into
Packit Service c30d13
## a separate buffer).
Packit Service c30d13
# set multibuffer
Packit Service c30d13
Packit Service c30d13
## Don't convert files from DOS/Mac format.
Packit Service c30d13
# set noconvert
Packit Service c30d13
Packit Service c30d13
## Don't display the helpful shortcut lists at the bottom of the screen.
Packit Service c30d13
# set nohelp
Packit Service c30d13
Packit Service c30d13
## Don't automatically add a newline when a file does not end with one.
Packit Service c30d13
# set nonewlines
Packit Service c30d13
Packit Service c30d13
## Don't pause between warnings at startup.  Which means that only the
Packit Service c30d13
## last one will be readable (when there are multiple ones).
Packit Service c30d13
# set nopauses
Packit Service c30d13
Packit Service c30d13
## Don't wrap text at all.
Packit Service c30d13
# set nowrap
Packit Service c30d13
Packit Service c30d13
## Set operating directory.  nano will not read or write files outside
Packit Service c30d13
## this directory and its subdirectories.  Also, the current directory
Packit Service c30d13
## is changed to here, so any files are inserted from this dir.  A blank
Packit Service c30d13
## string means the operating-directory feature is turned off.
Packit Service c30d13
# set operatingdir ""
Packit Service c30d13
Packit Service c30d13
## Remember the cursor position in each file for the next editing session.
Packit Service c30d13
# set positionlog
Packit Service c30d13
Packit Service c30d13
## Preserve the XON and XOFF keys (^Q and ^S).
Packit Service c30d13
# set preserve
Packit Service c30d13
Packit Service c30d13
## The characters treated as closing punctuation when justifying
Packit Service c30d13
## paragraphs.  They cannot contain blank characters.  Only closing
Packit Service c30d13
## punctuation, optionally followed by closing brackets, can end
Packit Service c30d13
## sentences.
Packit Service c30d13
# set punct "!.?"
Packit Service c30d13
Packit Service c30d13
## Do quick status-bar blanking.  Status-bar messages will disappear after
Packit Service c30d13
## 1 keystroke instead of 26.  Note that "constantshow" overrides this.
Packit Service c30d13
# set quickblank
Packit Service c30d13
Packit Service c30d13
## The email-quote string, used to justify email-quoted paragraphs.
Packit Service c30d13
## This is an extended regular expression.  The default is:
Packit Service c30d13
# set quotestr "^([ 	]*([#:>|}]|//))+"
Packit Service c30d13
Packit Service c30d13
## Fix Backspace/Delete confusion problem.
Packit Service c30d13
# set rebinddelete
Packit Service c30d13
Packit Service c30d13
## Fix numeric keypad key confusion problem.
Packit Service c30d13
# set rebindkeypad
Packit Service c30d13
Packit Service c30d13
## Do extended regular expression searches by default.
Packit Service c30d13
# set regexp
Packit Service c30d13
Packit Service c30d13
## Put the cursor on the highlighted item in the file browser;
Packit Service c30d13
## useful for people who use a braille display.
Packit Service c30d13
# set showcursor
Packit Service c30d13
Packit Service c30d13
## Make the Home key smarter.  When Home is pressed anywhere but at the
Packit Service c30d13
## very beginning of non-whitespace characters on a line, the cursor
Packit Service c30d13
## will jump to that beginning (either forwards or backwards).  If the
Packit Service c30d13
## cursor is already at that position, it will jump to the true
Packit Service c30d13
## beginning of the line.
Packit Service c30d13
# set smarthome
Packit Service c30d13
Packit Service c30d13
## Use smooth scrolling as the default.
Packit Service c30d13
# set smooth
Packit Service c30d13
Packit Service c30d13
## Enable soft line wrapping (AKA full-line display).
Packit Service c30d13
# set softwrap
Packit Service c30d13
Packit Service c30d13
## Use this spelling checker instead of the internal one.  This option
Packit Service c30d13
## does not have a default value.
Packit Service c30d13
# set speller "aspell -x -c"
Packit Service c30d13
Packit Service c30d13
## Allow nano to be suspended.
Packit Service c30d13
# set suspend
Packit Service c30d13
Packit Service c30d13
## Use this tab size instead of the default; it must be greater than 0.
Packit Service c30d13
# set tabsize 8
Packit Service c30d13
Packit Service c30d13
## Convert typed tabs to spaces.
Packit Service c30d13
# set tabstospaces
Packit Service c30d13
Packit Service c30d13
## Save automatically on exit; don't prompt.
Packit Service c30d13
# set tempfile
Packit Service c30d13
Packit Service c30d13
## Snip whitespace at the end of lines when justifying or hard-wrapping.
Packit Service c30d13
# set trimblanks
Packit Service c30d13
## (The old form, 'justifytrim', is deprecated.)
Packit Service c30d13
Packit Service c30d13
## Disallow file modification.  Why would you want this in an rcfile? ;)
Packit Service c30d13
# set view
Packit Service c30d13
Packit Service c30d13
## The two single-column characters used to display the first characters
Packit Service c30d13
## of tabs and spaces.  187 in ISO 8859-1 (0000BB in Unicode) and 183 in
Packit Service c30d13
## ISO-8859-1 (0000B7 in Unicode) seem to be good values for these.
Packit Service c30d13
## The default when in a UTF-8 locale:
Packit Service c30d13
# set whitespace "»·"
Packit Service c30d13
## The default otherwise:
Packit Service c30d13
# set whitespace ">."
Packit Service c30d13
Packit Service c30d13
## Detect word boundaries differently by treating punctuation
Packit Service c30d13
## characters as parts of words.
Packit Service c30d13
# set wordbounds
Packit Service c30d13
Packit Service c30d13
## The characters (besides alphanumeric ones) that should be considered
Packit Service c30d13
## as parts of words.  This option does not have a default value.  When
Packit Service c30d13
## set, it overrides option 'set wordbounds'.
Packit Service c30d13
# set wordchars "<_>."
Packit Service c30d13
Packit Service c30d13
Packit Service c30d13
## Paint the interface elements of nano.  These are examples;
Packit Service c30d13
## by default there are no colors, except for errorcolor.
Packit Service c30d13
# set titlecolor brightwhite,blue
Packit Service c30d13
# set statuscolor brightwhite,green
Packit Service c30d13
# set errorcolor brightwhite,red
Packit Service c30d13
# set selectedcolor brightwhite,magenta
Packit Service c30d13
# set numbercolor cyan
Packit Service c30d13
# set keycolor cyan
Packit Service c30d13
# set functioncolor green
Packit Service c30d13
## In root's .nanorc you might want to use:
Packit Service c30d13
# set titlecolor brightwhite,magenta
Packit Service c30d13
# set statuscolor brightwhite,magenta
Packit Service c30d13
# set errorcolor brightwhite,red
Packit Service c30d13
# set selectedcolor brightwhite,cyan
Packit Service c30d13
# set numbercolor magenta
Packit Service c30d13
# set keycolor brightmagenta
Packit Service c30d13
# set functioncolor magenta
Packit Service c30d13
Packit Service c30d13
Packit Service c30d13
## Setup of syntax coloring.
Packit Service c30d13
##
Packit Service c30d13
## Format:
Packit Service c30d13
##
Packit Service c30d13
## syntax "short description" ["filename regex" ...]
Packit Service c30d13
##
Packit Service c30d13
## The "none" syntax is reserved; specifying it on the command line is
Packit Service c30d13
## the same as not having a syntax at all.  The "default" syntax is
Packit Service c30d13
## special: it takes no filename regexes, and applies to files that
Packit Service c30d13
## don't match any other syntax's filename regexes.
Packit Service c30d13
##
Packit Service c30d13
## color foreground,background "regex" ["regex"...]
Packit Service c30d13
## or
Packit Service c30d13
## icolor foreground,background "regex" ["regex"...]
Packit Service c30d13
##
Packit Service c30d13
## "color" will do case-sensitive matches, while "icolor" will do
Packit Service c30d13
## case-insensitive matches.
Packit Service c30d13
##
Packit Service c30d13
## Valid colors: white, black, red, blue, green, yellow, magenta, cyan.
Packit Service c30d13
## For foreground colors, you may use the prefix "bright" to get a
Packit Service c30d13
## stronger highlight.
Packit Service c30d13
##
Packit Service c30d13
## To use multi-line regexes, use the start="regex" end="regex"
Packit Service c30d13
## [start="regex" end="regex"...] format.
Packit Service c30d13
##
Packit Service c30d13
## If your system supports transparency, not specifying a background
Packit Service c30d13
## color will use a transparent color.  If you don't want this, be sure
Packit Service c30d13
## to set the background color to black or white.
Packit Service c30d13
##
Packit Service c30d13
## All regexes should be extended regular expressions.
Packit Service c30d13
##
Packit Service c30d13
## If you wish, you may put your syntax definitions in separate files.
Packit Service c30d13
## You can make use of such files as follows:
Packit Service c30d13
##
Packit Service c30d13
## include "/path/to/syntax_file.nanorc"
Packit Service c30d13
##
Packit Service c30d13
## Unless otherwise noted, the name of the syntax file (without the
Packit Service c30d13
## ".nanorc" extension) should be the same as the "short description"
Packit Service c30d13
## name inside that file.  These names are kept fairly short to make
Packit Service c30d13
## them easier to remember and faster to type using nano's -Y option.
Packit Service c30d13
##
Packit Service c30d13
## To include all existing syntax definitions, you can do:
Packit Service c30d13
# include "@PKGDATADIR@/*.nanorc"
Packit Service c30d13
Packit Service c30d13
Packit Service c30d13
## Key bindings.
Packit Service c30d13
## See nanorc(5) (section REBINDING KEYS) for more details on this.
Packit Service c30d13
##
Packit Service c30d13
## The following two functions are not bound to any key by default.
Packit Service c30d13
## You may wish to choose other keys than the ones suggested here.
Packit Service c30d13
# bind M-B cutwordleft main
Packit Service c30d13
# bind M-N cutwordright main
Packit Service c30d13
Packit Service c30d13
## Set this if your Backspace key sends Del most of the time.
Packit Service c30d13
# bind Del backspace all