home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 1 / ARM_CLUB_CD.iso / contents / apps / program / d / elvis / Docs / options < prev    next >
Encoding:
Text File  |  1990-04-14  |  10.3 KB  |  252 lines
  1. name        abbr    type    default        description
  2. ---------------+-------+-------+---------------+-------------------------------
  3. autoindent    as    Bool    FALSE        autoindent during input?
  4. autowrite    aw    Bool    FALSE        write file for :n command?
  5. charattr    ca    Bool    FALSE        display bold & underline chars?
  6. columns        co    Number    80        width of screen, in characters
  7. exrefresh    er    Bool    TRUE        EX mode calls write() often?
  8. ignorecase    ic    Bool    FALSE        searches: upper/lowercase OK?
  9. keytime        kt    Number    1        allow slow receipt of ESC seq?
  10. keywordprg    kp    String    "/usr/bin/ref"    program to run for shift-K
  11. lines        li    Number    25        height of screen, in lines
  12. magic        ma    Bool    TRUE        searches: allow metacharacters?
  13. paragraphs    pa    String    "PPppPApa"    paragraphs start with .PP, etc.
  14. readonly    ro    Bool    FALSE        no file should be written back?
  15. report        re    Number    5        report changes to X lines?
  16. scroll        sc    Number    12        default #lines for ^U and ^D
  17. sections    se    String    "SEseSHsh"    sections start with .SE, etc.
  18. shell        sh    String    "/bin/sh"    shell program, from environment
  19. shiftwidth    sw    Number    8        width of < or > commands
  20. sidescroll    ss    Number    8        #chars to scroll sideways by
  21. tabstop        ts    Number    8        width of a tab character
  22. term        te    String    "?"        terminal type, from environment
  23. vbell        vb    Bool    TRUE        use visible bell if possible?
  24. wrapmargin    wm    Number    0        insert newline after which col?
  25. wrapscan    ws    Bool    TRUE        searches: wrap at EOF?
  26. colourfor    cf    Number    2        foreground colour (ARC only)
  27. colourbak    cb    Number    0        Background colour (ARC only)
  28.  
  29. autoindent
  30.     During input mode, the autoindent option will cause each added line
  31.     to begin with the same amount of leading whitespace as the line above
  32.     it.  Without autoindent, added lines are initially empty.
  33.  
  34. autowrite
  35.     When you're editing one file and decide to switch to another --
  36.     via the :tag command, or :next command, perhaps -- if your current
  37.     file has been modified, then Elvis will normally print an error
  38.     message and refuse to switch.
  39.  
  40.     However, if the autowrite option is on, then Elvis will write the
  41.     modified version of the current file and successfully switch to the
  42.     new file.
  43.  
  44. charattr
  45.     Many text formatting programs allow you to designate portions of
  46.     your text to be underlined, italicized, or boldface by embedding
  47.     the special strings \fU, \fI, and \fB in your text.  The special
  48.     string \fR marks the end of underlined or boldface text.
  49.  
  50.     Elvis normally treats those special strings just like any other
  51.     text.
  52.  
  53.     However, if the charattr option is on, then Elvis will interpret
  54.     those special strings correctly, to display underlined or boldface
  55.     text on the screen.  (This only works, of course, if your terminal
  56.     can display underlined and boldface, and if the TERMCAP entry says
  57.     how to do it.)
  58.  
  59. columns
  60.     This is a "read only" option.  You can't change its value, but you
  61.     can have Elvis print it.  It shows how wide your screen is.
  62.  
  63. exrefresh
  64.     The EX mode of Elvis writes many lines to the screen.  You can make
  65.     Elvis either write each line to the screen separately, or save up
  66.     many lines and write them all at once.
  67.  
  68.     The exrefresh option is normally on, so each line is written to the
  69.     screen separately.
  70.  
  71.     You may wish to turn the exrefresh option off (:se noer) if the
  72.     "write" system call is costly on your machine, or if you're using a
  73.     windowing environment.  (Windowing environments scroll text a lot
  74.     faster when you write many lines at once.)
  75.  
  76.     This option has no effect in VI mode.
  77.  
  78. ignorecase
  79.     Normally, when Elvis searches for text, it treats uppercase letters
  80.     as being different for lowercase letters.
  81.  
  82.     When the ignorecase option is on, uppercase and lowercase are treated
  83.     as equal.
  84.  
  85. keytime
  86.     The arrow keys of most terminals send a multi-character sequence.
  87.     It takes a measurable amount of time for these sequences to be
  88.     transmitted.  The keytime option allows you to control the maximum
  89.     amount of time to allow for an arrow key (or other mapped key) to
  90.     be received in full.
  91.  
  92.     The default keytime value is 2.  Because of the way UNIX timekeeping
  93.     works, the actual amount of time allowed will vary slightly, but it
  94.     will always be between 1 and 2 seconds.
  95.  
  96.     If you set keytime to 1, then the actual amount of time allowed will
  97.     be between 0 and 1 second.  This will generally make the keyboard's
  98.     response be a little faster (mostly for the ESC key), but on those
  99.     occasions where the time allowed happens to be closer to 0 than 1
  100.     second, Elvis may fail to allow enough time for an arrow key's
  101.     sequence to be received fully.  Ugh.
  102.  
  103.     As a special case, you can set keytime to 0 to disable this time
  104.     limit stuff altogether.  The big problem here is:  If your arrow
  105.     keys' sequences start with an ESC, then every time you hit your ESC
  106.     key Elvis will wait... and wait... to see if maybe that ESC was
  107.     part of an arrow key's sequence.
  108.  
  109.     NOTE: this option is a generalization of the timeout option of the
  110.     real vi.
  111.  
  112. keywordprg
  113.     Elvis has a special keyword lookup feature.  You move the cursor
  114.     onto a word, and hit shift-K, and Elvis uses another program to
  115.     look up the word and display information about it.
  116.  
  117.     This option says which program gets run.  It should contain the full
  118.     pathname of the program; your whole execution path is *not* checked.
  119.  
  120.     The default value of this option is "/usr/bin/ref", which is a
  121.     program that looks up the definition of a function in C.  It looks
  122.     up the function name in a file called "refs" which is created by
  123.     ctags.
  124.  
  125.     You can subtitute other programs, such as an English dictionary
  126.     program or the online manual.  Elvis runs the program, using the
  127.     keyword as its only argument.  The program should write information
  128.     to stdout.  The program's exit status should be 0, unless you want
  129.     Elvis to print "<<< failed >>>".
  130.  
  131. lines
  132.     This "read only" option shows how many lines you screen has.
  133.  
  134. magic
  135.     The search mechanism in Elvis can accept "regular expressions" --
  136.     strings in which certain characters have special meaning.
  137.  
  138.     The magic option is normally on, which causes these characters to
  139.     be treated specially.
  140.  
  141.     If you turn the magic option off (:se noma), then all characters
  142.     except ^ and $ are treated literally.   ^ and $ retain their special
  143.     meanings regardless of the setting of magic.
  144.  
  145. paragraphs
  146.     The { and } commands move the cursor forward or backword in increments
  147.     of one paragraph.  Paragraphs may be separated by blank lines, or by
  148.     a "dot" command of a text formatter.  Different text formatters use
  149.     different "dot" commands.  This option allows you to configure Elvis
  150.     to work with your text formatter.
  151.  
  152.     It is assumed that your formatter uses commands that start with a
  153.     "." character at the front of a line, and then have a one- or
  154.     two-character command name.
  155.  
  156.     The value of the paragraphs option is a string in which each pair
  157.     of characters is one possible form of your text formatter's paragraph
  158.     command.
  159.  
  160. readonly
  161.     Normally, Elvis will let you write back any file to which you have
  162.     write permission.  If you don't have write permission, then you
  163.     can only write the changed version of the file to a *different*
  164.     file.
  165.  
  166.     If you set the readonly option, then Elvis will pretend you don't
  167.     have write permission to *ANY* file you edit.  It is useful when
  168.     you really only mean to use Elvis to look at a file, not to change
  169.     it.  This way you can't change it accidentally.
  170.  
  171.     This option is normally off, unless you use the "view" alias of Elvis.
  172.     "View" is like "vi" except that the readonly option is on.
  173.  
  174. report
  175.     Commands in Elvis may affect many lines.  For commands that affect
  176.     a lot of lines, Elvis will output a message saying what was done and
  177.     how many lines were affected.  This option allows you to define
  178.     what "a lot of lines" means.  The default is 5, so any command which
  179.     affects 5 or more lines will cause a message to be shown.
  180.  
  181. scroll
  182.     The control-U and control-D keys normally scroll backward or forward
  183.     by half a screenful, but this is adjustable.  The value of this option
  184.     says how many lines those keys should scroll by.
  185.  
  186. sections
  187.     The [[ and ]] commands move the cursor backward or forward in
  188.     increment of 1 section.  Sections may be delimited by a { character
  189.     in column 1 (which is useful for C source code) or by means of
  190.     a text formatter's "dot" commands.
  191.  
  192.     This option allows you to configure Elvis to work with your text
  193.     formatter's "section" command, in exectly the same way that the
  194.     paragraphs option makes it work with the formatter's "paragraphs"
  195.     command.
  196.  
  197. shell
  198.     When Elvis forks a shell (perhaps for the :! or :shell commands)
  199.     this is the program that is uses as a shell.  This is "/bin/sh"
  200.     by default, unless you have set the SHELL environment variable,
  201.     it which case the default value is copied from the environment.
  202.  
  203. shiftwidth
  204.     The < and > commands shift text left or right by some uniform number
  205.     of columns.  The shiftwidth option defines that "uniform number".
  206.     The default is 8.
  207.  
  208. sidescroll
  209.     For long lines, Elvis scrolls sideways.  (This is different from
  210.     the real vi, which wraps a single long line onto several rows of
  211.     the screen.)
  212.  
  213.     To minimize the number of scrolls needed, Elvis moves the screen
  214.     sideways by several characters at a time.  The value of this option
  215.     says how many characters' widths to scroll at a time.
  216.  
  217.     Generally, the faster your screen can be redrawn, the lower the value
  218.     you will want in this option.
  219.  
  220. tabstop
  221.     Tab characters are normally 8 characters wide, but you can change
  222.     their widths by means of this option.
  223.  
  224. term
  225.     This "read only" option shows the name of the termcap entry that
  226.     Elvis is using for your terminal.
  227.  
  228. vbell
  229.     If your termcap entry describes a visible alternative to ringing
  230.     your terminal's bell, then this option will say whether the visible
  231.     version gets used or not.  Normally it will be.
  232.  
  233.     If your termcap does NOT include a visible bell capability, then
  234.     the vbell option will be off, and you can't turn it on.
  235.  
  236. wrapmargin
  237.     Normally (with wrapmargin=0) Elvis will let you type in extremely long
  238.     lines, if you wish.
  239.  
  240.     However, with warpmargin set to something other that 0 (wrapmargin=65
  241.     is nice), Elvis will automatically cause long lines to be "wrapped"
  242.     on a word break for lines longer than wrapmargin's setting.
  243.  
  244. wrapscan
  245.     Normally, when you search for something, Elvis will find it no matter
  246.     where it is in the file.  Elvis starts at the cursor position, and
  247.     searches forward.  If Elvis hits EOF without finding what you're
  248.     looking for, then it wraps around to continue searching from line 1.
  249.  
  250.     If you turn off the wrapscan option (:se nows), then when Elvis hits
  251.     EOF during a search, it will stop and say so.
  252.