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