NANORC(5) NANORC(5)

NAME
       nanorc - GNU nano's rcfile

DESCRIPTION
       This manual page documents GNU nnaannoo's rcfile.

       nnaannoo  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, nnaannoo also implements some missing
       (or disabled by default) features in Pico, such as "search and replace"
       and "go to line number".

       The  nanorc  file  contains  the  default  settings  for  nnaannoo.  During
       startup,  nnaannoo  will  first  read   its   system-wide   settings   from
       $SYSCONFDIR/nanorc, and then user-specific settings from ~/.nanorc.


OOPPTTIIOONNSS
       The  configuration file accepts a series of "set" and "unset" commands,
       which can be used to configure nano on startup without using  the  com-
       mand-line  options. Additionally, the "syntax" and "color" keywords are
       used to define syntax highlighting rules for different  text  patterns.
       GNU nano will read one command per line.

       Options  in  rcfiles  take precedence over nano's defaults, and command
       line options override rcfile settings.

       Options are unset by default, except for options that take an argument.

       The supported commands and arguments are:


       sseett//uunnsseett aauuttooiinnddeenntt
          Use auto-indentation.

       sseett//uunnsseett bbaacckkuupp
          Create backup files in filename~.

       sseett//uunnsseett ccoonnsstt
          Constantly display the cursor position in the status bar.

       sseett//uunnsseett ccuutt
          Use cut to end of line with ^K by default.

       sseett ffiillll n
          Wrap  lines  at column number n.  If n is 0 or less, the line length
          will be the screen width less n.  The default value is -8.

       sseett//uunnsseett hhiissttoorryylloogg
          Enable  ~/.nanohistory  for  saving  and   reading   search/replace
          strings.

       sseett//uunnsseett kkeeyyppaadd
          Use alternate keypad routines.

       sseett//uunnsseett mmuullttiibbuuffffeerr
          Allow inserting files into their own buffers.

       sseett//uunnsseett nnooccoonnvveerrtt
          Don't convert files from DOS/Mac format.

       sseett//uunnsseett nnooffoollllooww
          Don't follow symlinks when writing files.

       sseett//uunnsseett nnoohheellpp
          Don't display the help lists at the bottom of the screen.

       sseett//uunnsseett nnoowwrraapp
          Don't wrap text at all.

       sseett ooppeerraattiinnggddiirr ""directory""
          nnaannoo  will only read and write files inside directory and its subdi-
          rectories.  Also, the current directory is changed to here, so files
          are inserted from this dir.  By default the operating directory fea-
          ture is turned off.

       sseett//uunnsseett pprreesseerrvvee
          Preserve the XON and XOFF keys (^Q and ^S).

       sseett qquuootteessttrr ""string""
          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

               set quotestr "^([ \t]*[|>:}#])+"

          if you have regexps, otherwise set quotestr "> ".   Note  that  '\t'
          above stands for a literal Tab character.

       sseett//uunnsseett rreeggeexxpp
          Do regular expression searches by default.

       sseett//uunnsseett ssmmooootthh
          Use smooth scrolling by default.

       sseett ssppeelllleerr spellprog
          Use  spelling  checker  spellprog instead of the built-in one, which
          calls spell.

       sseett//uunnsseett ssuussppeenndd
          Allow nano to be suspended with ^Z.

       sseett ttaabbssiizzee n
          Use a tab size of n instead of the default (8); must be greater than
          0.

       sseett//uunnsseett tteemmppffiillee
          Save automatically on exit, don't prompt.

       sseett//uunnsseett vviieeww
          Disallow file modification.

       ssyynnttaaxx str [[""fileregex"" ...... ]]
          Defines  a  syntax named str which can be activated via the -YY flag,
          or will be automatically activated if the current  filename  matches
          fileregex.   All  following  ccoolloorr  statements  will apply to syntax
          until a new syntax is defined.

       ccoolloorr fgcolor[[,,bgcolor]] regex ......
          For the currently defined syntax, display all  expressions  matching
          regex  with  foreground  color fgcolor and optional background color
          bgcolor. 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.   If
          your  terminal supports transparency, not specifying a bgcolor tells
          nnaannoo to attempt to use a transparent background.

       ccoolloorr fgcolor[[,,bgcolor]] ssttaarrtt==""sr"" eenndd==""er""
          Display expressions which start with sr and end with er  with  fore-
          ground  color  fgcolor  and optional background color bgcolor.  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.


FILES
       $SYSCONFDIR/nanorc
              System-wide configuration file

       ~/.nanorc
              Per-user configuration file

SEE ALSO
       nnaannoo(1)
       /usr/share/doc/nano/examples/nanorc.sample (or equivalent on your  sys-
       tem)
AUTHOR       Chris  Allegretta  , et al (see AUTHORS and THANKS for
       details).   This   manual   page   was   written   by   Jordi   Mallach
       .



                                 June 19, 2003                       NANORC(5)