Annotation of coherent/d/usr/bin/elvis/doc/versions.doc, revision 1.1

1.1     ! root        1: 
        !             2:      Elvis 1.4                    VERSIONS                     Page 12-1
        !             3: 
        !             4: 
        !             5: E12.  VERSIONSF
        !             6: 
        !             7:         Elvis  currently  works  under BSD UNIX, AT&T System-V UNIX, SCO
        !             8:      XENIX, Minix, Coherent, MS-DOS,  Atari  TOS,  and  OS9/68k.    This
        !             9:      section  of the manual provides special information that applies to
        !            10:      each particular version of Elvis.  
        !            11: 
        !            12:         For all versions except MS-DOS, the file  "Makefile.mix"  should
        !            13:      be  copied to "Makefile", and then edited to select the correct set
        !            14:      of options for your system.  There is more information  about  this
        !            15:      embedded in the file itself.  
        !            16: 
        !            17: 
        !            18:    E12.1  BSD UNIXF
        !            19: 
        !            20:         Temporary files are stored in /tmp.  
        !            21: 
        !            22:         Elvis doesn't  have  an  "expreserve" program yet.  Instead, you
        !            23:      should modify /etc/rc so that the temp files are not  deleted  when
        !            24:      the system is rebooted.  Find a line in /etc/rc which reads 
        !            25: 
        !            26:             rm -rf /tmp/*
        !            27: 
        !            28:         or something like that, and change it to read 
        !            29: 
        !            30:             rm -rf /tmp/[^e]* /tmp/e[^l]* /tmp/el[^v]* /tmp/elv_*
        !            31: 
        !            32:         If  you  do not have permission to modify /etc/rc, then it would
        !            33:      be unsafe for you to have Elvis store any temp files in /tmp.    In
        !            34:      this  case,  I  suggest  you  make  a  "tmp" directory in your home
        !            35:      directory and add "set directory=/your/home/directory/tmp" to  your
        !            36:      .exrc file or $EXINIT variable.  
        !            37: 
        !            38:         Both  Elvis  and the real Vi read initialization commands from a
        !            39:      file called ".exrc", but the commands in that file  might  work  on
        !            40:      one but     not     the     other.          For    example,    "set
        !            41:      keywordprg=/usr/myself/bin/ref" will work for Elvis,  but  Vi  will
        !            42:      complain because  it  doesn't  have  a "keywordprg" option.  If the
        !            43:      warning messages annoy you, then you can edit the config.h file  to
        !            44:      change  the  name  of  the initialization file ".exrc" to something
        !            45:      else, such as ".elvisrc".  
        !            46: 
        !            47:         If you use X windows, you  may  wish  to  add  "-DCS_LATIN1"  to
        !            48:      CFLAGS.   This will cause the digraph table and the flipcase option
        !            49:      to have  default  values  that  are  appropriate  for  the  LATIN-1
        !            50:      character set.  That's the standard character set for X.  
        !            51: 
        !            52: 
        !            53:    E12.2  System-V UNIXF
        !            54: 
        !            55:         If  your  system uses terminfo instead of termcap, then you will
        !            56:      have to edit the LIBS setting in the Makefile.  Currently  it  says
        !            57:      "LIBS=-ltermcap",    but   you   may   have   to   change   it   to
        !            58:      "LIBS=-lterminfo" or "LIBS=-lterm" or something like that.  
        !            59: 
        !            60: 
        !            61: 
        !            62: 
        !            63: 
        !            64: 
        !            65: 
        !            66: 
        !            67: 
        !            68:      Elvis 1.4                    VERSIONS                     Page 12-2
        !            69: 
        !            70: 
        !            71:         The /etc/rc file  should  be  modified,  as  described  for  BSD
        !            72:      systems above.   The potential trouble with ".exrc" described above
        !            73:      for BSD UNIX applies to System-V UNIX as well.  
        !            74: 
        !            75:         Elvis uses control-C as the interrupt key, not Delete.  
        !            76: 
        !            77: 
        !            78:    E12.3  SCO XenixF
        !            79: 
        !            80:         For Xenix-386, you can use the generic System-V settings.    You
        !            81:      may  wish  to add "-DCS_IBMPC" to CFLAGS, to have the digraph table
        !            82:      and flipcase option start up in a mode that is appropriate for  the
        !            83:      console.  
        !            84:      There is  a  separate group of settings for use with Xenix-286.  It
        !            85:      already has "-DCS_IBMPC" in CFLAGS.  
        !            86: 
        !            87:         Because Xenix is so  similar  to  System-V,  everything  I  said
        !            88:      earlier about System-V applies to the Xenix version too.  
        !            89: 
        !            90: 
        !            91:    E12.4  MinixF
        !            92: 
        !            93:         There  are  separate  settings  in Makefile.mix for Minix-PC and
        !            94:      Minix-ST.  The differences  between  these  two  are  that  the  ST
        !            95:      version  uses  ".o"  for  the  object  file  extension where the PC
        !            96:      version uses ".s", and the PC  version  has  some  extra  flags  in
        !            97:      CFLAGS to  reduce  the  size  of  Elvis.   The PC version also uses
        !            98:      tinytcap (instead of the full termcap) to make it smaller.  
        !            99: 
        !           100:         Minix-PC users should read the CFLAGS  section  of  this  manual
        !           101:      very carefully.  
        !           102: 
        !           103:         The temporary  files  are  stored  in  /usr/tmp.    The /usr/tmp
        !           104:      directory  must  exist  before  you  run  Elvis,  and  it  must  be
        !           105:      readable/writable by  everybody.    We use /usr/tmp instead of /tmp
        !           106:      because after a system crash or power failure, you can recover  the
        !           107:      altered version  of a file from the temporary file in /usr/tmp.  If
        !           108:      it was stored in /tmp, though, then it would be lost  because  /tmp
        !           109:      is probably located on the RAM disk.  
        !           110: 
        !           111:         Elvis uses control-C as the interrupt key, not Delete.  
        !           112: 
        !           113: 
        !           114:    E12.5  CoherentF
        !           115: 
        !           116:         Elvis was ported to Coherent by Esa Ahola.  
        !           117: 
        !           118:         Elvis  is  too  large to run under Coherent unless you eliminate
        !           119:      some features via the CFLAGS setting.  The recommended settings, in 
        !           120:      Makefile.mix, produce a working version of elvis which emulates  Vi
        !           121:      faithfully, but  lacks most of the extensions.  You should read the
        !           122:      CFLAGS section of this manual carefully.  
        !           123: 
        !           124:         You can probably reduce the size of Elvis  by  using  tinytcap.c
        !           125:      instead of  -lterm.   This would allow you to keep most features of
        !           126:      Elvis, at the expense of terminal independence.    (Tinytcap.c  has
        !           127:      ANSI escape sequences hard-coded into it.) 
        !           128: 
        !           129: 
        !           130: 
        !           131: 
        !           132: 
        !           133: 
        !           134:      Elvis 1.4                    VERSIONS                     Page 12-3
        !           135: 
        !           136: 
        !           137:         The temporary  files are stored in /tmp.  You should modify your
        !           138:      /etc/rc file as described for BSD earlier.  
        !           139: 
        !           140: 
        !           141:    E12.6  MS-DOSF
        !           142: 
        !           143:         Elvis was ported to MS-DOS by Guntram Blohm and Martin Patzel.  
        !           144: 
        !           145:         There are  two  different  Makefiles  for  Elvis  under  MS-DOS.
        !           146:      "Elvis.prj"  should be used with Turbo-C, and "Elvis.mak" should be
        !           147:      used with MSC and Microsoft MAKE.  The "Elvis.mak"  file  may  work
        !           148:      with MS Quick-C 
        !           149: 
        !           150:         Elvis stores  its  temporary  files  in  C:\tmp.  If this is not
        !           151:      satisfactory, then you should edit the CFLAGS line of your Makefile 
        !           152:      to change TMPDIR to something else before compiling.  You can  also
        !           153:      control  the name of the temp directory via an environment variable
        !           154:      named TMP or TEMP.  The directory must exist  before  you  can  run
        !           155:      Elvis.  
        !           156: 
        !           157:         Normally,  the  TERM  environment variable should not be set, or
        !           158:      else it should be set to "pcbios".  This way, Elvis will make calls 
        !           159:      to BIOS to update the screen.  (If you don't like the  colors  that
        !           160:      the BIOS interface uses, then edit the attr[] table in pc.c.) 
        !           161: 
        !           162:         You  may  prefer  to  use  a  device  driver such as ANSI.SYS or
        !           163:      NNANSI.SYS, for speed; or you may NEED to use a device  driver  for
        !           164:      compatibility.   If  so, you should install one of these drivers by
        !           165:      adding "driver = ansi.sys" to your CONFIG.SYS file, and then define 
        !           166:      TERM to be either "ansi" or "nansi" by adding a line such  as  "set
        !           167:      TERM=ansi" to  your  AUTOEXEC.BAT  file.   You must then reboot for
        !           168:      these changes to take effect.  After that, Elvis  will  notice  the
        !           169:      "TERM" setting and use the driver.  
        !           170: 
        !           171:         Under  MS-DOS,  Elvis has an extra ":set" option called "pcbios"
        !           172:      which indicates whether the BIOS is being used directly.  This is a 
        !           173:      "read only" option; you can't use it to switch your interface style 
        !           174:      in the middle of an edit session.  
        !           175: 
        !           176:         An extra program, called "wildcard", is needed for MS-DOS.    It
        !           177:      expands wildcard characters in file names.  
        !           178: 
        !           179: 
        !           180:    E12.7  Atari TOSF
        !           181: 
        !           182:         Elvis  was  ported  to  Atari  TOS  by  Guntram Blohm and Martin
        !           183:      Patzel.  It is very similar to the MS-DOS version.  
        !           184: 
        !           185:         It has only been tested with the Mark Williams C compiler.  
        !           186: 
        !           187:         The TERM environment variable is ignored;  the  ST  port  always
        !           188:      assumes that  TERM=vt52.   The SHELL (not COMSPEC!) variable should
        !           189:      be set to the name of a line-oriented shell.  
        !           190: 
        !           191:         A simple shell in  included  with  elvis.    Its  source  is  in
        !           192:      "shell.c", and the name of the executable is "shell.ttp".  This was 
        !           193:      necessary because the standard Atari software doesn't offer any way 
        !           194:      to set environment variables.  The file "profile.sh" should contain 
        !           195: 
        !           196: 
        !           197: 
        !           198: 
        !           199: 
        !           200:      Elvis 1.4                    VERSIONS                     Page 12-4
        !           201: 
        !           202: 
        !           203:      a  set  of  instructions to be executed when the shell first starts
        !           204:      up.  An example of this file  is  included,  but  you  will  almost
        !           205:      certainly want to edit it right away to match your configuration.  
        !           206: 
        !           207:         If  you  already have a command-line shell, then you'll probably
        !           208:      want to continue using it.  The shell that comes with elvis is very 
        !           209:      limited.  
        !           210: 
        !           211:         Currently, character  attributes  cannot  be  displayed  on  the
        !           212:      screen.   In  other  words, the "charattr" option doesn't work very
        !           213:      well.  Its ironic -- the only system that always  has  a  bitmapped
        !           214:      display is the only system that doesn't support multiple fonts!  
        !           215: 
        !           216: 
        !           217:    E12.8  OS9/68kF
        !           218: 
        !           219:         Elvis was ported to OS9/68k by Peter Reinig.  
        !           220: 
        !           221:         The  Makefile  is  currently configured to install elvis and the
        !           222:      related programs in /dd/usr/cmds If this this is unacceptable, then 
        !           223:      you  should  change  the  BIN  setting  to  some  other  directory.
        !           224:      Similarly,    it   expects   the   source   code   to   reside   in
        !           225:      /dd/usr/src/elvis; the ODIR setting is used to control this.  
        !           226: 
        !           227:         Temporary files are stored  in  the  /dd/tmp  directory.    Your
        !           228:      /dd/startup  file  may  need  to  be  modified  to  prevent it from
        !           229:      deleting Elvis' temporary files.  
        !           230: 
        !           231:         The program in alias.c is linked repeatedly to produce the "vi", 
        !           232:      "view", and "input" aliases for elvis.  Sadly, the  "ex"  alias  is
        !           233:      impossible to implement under OS9, because the shell has a built-in 
        !           234:      command by that name.  
        !           235: 
        !           236:         For  some  purposes,  you  must  give  `make'  the  "-b" option.
        !           237:      Specifically, you need this  for  "make  -b  clean"  and  "make  -b
        !           238:      install".  
        !           239: 
        !           240: 
        !           241: 
        !           242: 
        !           243: 
        !           244: 
        !           245: 
        !           246: 
        !           247: 
        !           248: 
        !           249: 
        !           250: 
        !           251: 
        !           252: 
        !           253: 
        !           254: 
        !           255: 
        !           256: 
        !           257: 
        !           258: 
        !           259: 
        !           260: 
        !           261: 
        !           262: 
        !           263: 
        !           264: 

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.