home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / elvis-1.7 / doc / elvis.doc < prev    next >
Encoding:
Text File  |  1993-01-05  |  8.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4.           ELVIS                                                       ELVIS
  5.  
  6.  
  7.  
  8.  
  9.           NAME
  10.                elvis, ex, vi, view, input - The editor
  11.  
  12.           SYNOPSIS
  13.                elvis [flags] [+cmd] [files...]
  14.  
  15.           DESCRIPTION
  16.                Elvis is a text editor which emulates vi/ex.
  17.  
  18.                On systems which pass  the program name as an argument, such
  19.                as  Unix and  Minix, you  may also  install elvis  under the
  20.                names "ex",  "vi", "view",  and "input".  These  extra names
  21.                would  normally  be  links  to  elvis;  see the  "ln"  shell
  22.                command.
  23.  
  24.                When elvis is invoked  as "vi", it behaves exactly as though
  25.                it was invoked as  "elvis".  However, if you invoke elvis as
  26.                "view", then  the readonly option  is set as  though you had
  27.                given it  the "-R" flag.  If you invoke  elvis as "ex", then
  28.                elvis will start up in the colon command mode instead of the
  29.                visual command  mode, as  though you  had given it  the "-e"
  30.                flag.  If you invoke  elvis as "input" or "edit", then elvis
  31.                will start  up in  input mode, as  though the "-i"  flag was
  32.                given.
  33.  
  34.           OPTIONS
  35.                -r   To the  real vi, this  flag means that  a previous edit
  36.                     should  be recovered.   Elvis, though,  has  a separate
  37.                     program, called elvrec(1),  for recovering files.  When
  38.                     you invoke  elvis with -r,  elvis will tell  you to run
  39.                     elvrec.
  40.  
  41.                -R   This   sets  the  "readonly"   option,  so   you  won't
  42.                     accidentally overwrite a file.
  43.  
  44.                -t tag
  45.                     This causes elvis to start editing at the given tag.
  46.  
  47.                -m [file]
  48.                     Elvis will search through file for something that looks
  49.                     like an  error message from  a compiler.  It  will then
  50.                     begin editing  the source  file that caused  the error,
  51.                     with the cursor sitting on the line where the error was
  52.                     detected.  If  you don't  explicitly name a  file, then
  53.                     "errlist" is assumed.
  54.  
  55.                -e   Elvis will start up in colon command mode.
  56.  
  57.                -v   Elvis will start up in visual command mode.
  58.  
  59.                -i   Elvis will start up in input mode.
  60.  
  61.  
  62.  
  63.  
  64.           Command Reference               1                          Page 1
  65.  
  66.  
  67.  
  68.  
  69.  
  70.           ELVIS                                                       ELVIS
  71.  
  72.  
  73.  
  74.                -w winsize
  75.                     Sets the "window" option's value to winsize.
  76.  
  77.                +command or -c command
  78.                     If you use the +command parameter, then after the first
  79.                     file is loaded command is executed as an EX command.  A
  80.                     typical example would  be "elvis +237 foo", which would
  81.                     cause elvis to start editing foo and then move directly
  82.                     to line  237.  The "-c  command" variant was  added for
  83.                     UNIX SysV compatibility.
  84.  
  85.           FILES
  86.                /tmp/elv*
  87.                     During editing, elvis  stores text in a temporary file.
  88.                     For UNIX, this file  will usually be stored in the /tmp
  89.                     directory,  and  the  first  three characters  will  be
  90.                     "elv".  For  other systems, the temporary  files may be
  91.                     stored someplace else; see the version-specific section
  92.                     of the documentation.
  93.  
  94.                tags This is the database  used by the :tags command and the
  95.                     -t  option.   It is  usually  created  by the  ctags(1)
  96.                     program.
  97.  
  98.                .exrc or elvis.rc
  99.                     On  UNIX-like systems,  a file  called ".exrc"  in your
  100.                     home directory is  executed as a series of ex commands.
  101.                     A file by the same  name may be executed in the current
  102.                     directory,  too.   On   non-UNIX  systems,  ".exrc"  is
  103.                     usually an invalid file name; there, the initialization
  104.                     file is called "elvis.rc" instead.
  105.  
  106.           ENVIRONMENT
  107.                TERM This  is  the  name of  your  terminal's  entry in  the
  108.                     termcap or terminfo database.  The list of legal values
  109.                     varies from one system to another.
  110.  
  111.                TERMCAP
  112.                     Optional.  If your system uses termcap, and the TERMCAP
  113.                     variable is unset, then
  114.                      will    read   your    terminal's   definition    from
  115.                     /etc/termcap.  If  TERMCAP is set to  the full pathname
  116.                     of a file (starting with  a '/') then  will look in the
  117.                     named file instead  of /etc/termcap.  If TERMCAP is set
  118.                     to a  value which  doesn't start  with a '/',  then its
  119.                     value is assumed to  be the full termcap entry for your
  120.                     terminal.
  121.  
  122.                TERMINFO
  123.                     Optional.   If  your  system  uses  terminfo,  and  the
  124.                     TERMINFO variable is unset, then
  125.                      will read your terminal's definition from the database
  126.                     in the /usr/lib/terminfo database.  If TERMINFO is set,
  127.                     then  its value  is used  as the  database name  to use
  128.  
  129.  
  130.           Command Reference               1                          Page 2
  131.  
  132.  
  133.  
  134.  
  135.  
  136.           ELVIS                                                       ELVIS
  137.  
  138.  
  139.  
  140.                     instead of /usr/lib/terminfo.
  141.  
  142.                LINES, COLUMNS
  143.                     Optional.  These  variables, if set,  will override the
  144.                     screen  size values given  in the  termcap/terminfo for
  145.                     your terminal.   On windowing  systems such as  X,  has
  146.                     other  ways  of determining  the  screen  size, so  you
  147.                     should probably leave these variables unset.
  148.  
  149.                EXINIT
  150.                     Optional.   This variable  can hold  EX  commands which
  151.                     will be executed before any .exrc files.
  152.  
  153.                SHELL
  154.                     Optional.   The SHELL variable  sets the  default value
  155.                     for  the "shell" option,  which determines  which shell
  156.                     program is  used to perform wildcard  expansion in file
  157.                     names,  and also  which is used  to execute  filters or
  158.                     external programs.   The default value  on UNIX systems
  159.                     is "/bin/sh".
  160.  
  161.                          Note:  Under  MS-DOS,   this  variable  is  called
  162.                     COMSPEC instead of SHELL.
  163.  
  164.                HOME This variable  should be set  to the name  of your home
  165.                     directory.
  166.                      looks for  its initialization  file there; if  HOME is
  167.                     unset  then   the  initialization  file   will  not  be
  168.                     executed.
  169.  
  170.                TAGPATH
  171.                     Optional.  This variable  is used by the "ref" program,
  172.                     which is  invoked by  the shift-K, control-],  and :tag
  173.                     commands.  See "ref" for more information.
  174.  
  175.                TMP, TEMP
  176.                     These optional  environment variables are  only used in
  177.                     non-UNIX  versions of  .  They  allow  you to  supply a
  178.                     directory name to be used for storing temporary files.
  179.  
  180.           SEE ALSO
  181.                ctags(1), ref(1), virec(1)
  182.  
  183.                Elvis - A Clone of Vi/Ex, the complete elvis documentation.
  184.  
  185.           BUGS
  186.                There  is  no  LISP  support.   Certain other  features  are
  187.                missing, too.
  188.  
  189.                Auto-indent mode  is not quite compatible  with the real vi.
  190.                Among  other things,  0^D and  ^^D don't  do what  you might
  191.                expect.
  192.  
  193.  
  194.  
  195.  
  196.           Command Reference               1                          Page 3
  197.  
  198.  
  199.  
  200.  
  201.  
  202.           ELVIS                                                       ELVIS
  203.  
  204.  
  205.  
  206.                Long  lines are  displayed differently.   The real  vi wraps
  207.                long  lines onto  multiple  rows of  the  screen, but  elvis
  208.                scrolls sideways.
  209.  
  210.           AUTHOR
  211.                Steve Kirkendall
  212.                kirkenda@cs.pdx.edu
  213.  
  214.                Many  other people  have  worked to  port  elvis to  various
  215.                operating  systems.  To  see  who deserves  credit, run  the
  216.                :version command  from within elvis, or  look in the system-
  217.                specific section of the complete documentation.
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.           Command Reference               1                          Page 4
  263.  
  264.  
  265.