home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / txttools / elvis645.lha / ReadMe < prev    next >
Text File  |  1992-04-26  |  5KB  |  138 lines
  1. To:    The Amiga public.
  2. From:    Mike Rieser    (riesermc@mentor.cc.purdue.edu)
  3.  
  4. I would like to express my thanks and appreciation for the fine work
  5. Steve Kirkendall has done on the Elvis program.  Any thanks for it's
  6. many working features should be expressed to him first.
  7.  
  8. Thanks Steve!
  9.  
  10. Sincerely,
  11. Mike Rieser
  12.  
  13. Compiling The Amiga version of Elvis was done using Manx Aztec C 5.2b.
  14.  
  15. For the port to AmigaDOS 2.04, I tried to use as many Native AmigaDOS
  16. calls as I could.  This should increase Elvis's chances at being
  17. compiled with other compilers.  DICE seems to have a different default
  18. char type.  You may need to use the UCHAR() macro in tio.c.
  19.  
  20. For the port to AmigaDOS 1.3, I tried to make sure the program was at
  21. least usable.  Many features are missing, most notably running commands
  22. in subshells.  Also, what I could get working, I used Aztec functions to
  23. support them, so this part is a little more compiler dependent.
  24.  
  25. Aztec is compatible with the SAS libcall #pragma.  I personally prefer
  26. using the includes that come from Commodore over the ones supplied with
  27. Aztec, but for people with a straight Aztec installation, I went with
  28. the default names for the Aztec pragmas.
  29.  
  30. One include you'll need is <sys/types.h> its a common include when
  31. porting software just make yourself one.  Its a two line file that saves
  32. a lot of hassle especially in the elvis source.  So, make a directory
  33. where your includes are located called `sys' and in a file below that
  34. type:
  35.      /* sys/types.h */
  36.      #include <exec/types.h>
  37.  
  38. When setting environment variables (either local or global) for
  39. variables that specify a directory, make sure the variable ends in `:'
  40. or `/'.  This saved from having to change much of the way elvis works.
  41. The default if TEMP and TMP aren't specified is "T:".  The default if
  42. HOME is not specified is "S:".
  43.  
  44. Under AmigaDOS 2.04 I have been able to support all documented features
  45. of Elvis.  Under AmigaDOS 1.3 Elvis works, but is missing some of the
  46. more sophisticated features.
  47.  
  48. Under both version of AmigaDOS the following features are supported:
  49.  
  50.     Elvis is clean of Enforcer hits.
  51.  
  52.     Elvis supports Global environment variables.
  53.  
  54.     Elvis works as a line editor and can read script files when
  55.     named ex. (Needs testing.)
  56.  
  57.     Elvis supports most vi .exrc definitions, put them in elvis.rc
  58.     in either s: or your HOME directory
  59.  
  60.     Elvis READONLY works for -r--d files, and when Elvis is named
  61.     view.
  62.  
  63.     Elvis uses an internal TERMCAP entry by default.
  64.  
  65.     Elvis supports user defined TERM and TERMCAP environment
  66.     variables.
  67.  
  68.     Elvis supports window resizing.
  69.  
  70.     Elvis works over an AUX: port, and has an internal TERM vt100-80
  71.     for this purpose.
  72.  
  73.     Elvis supports Function keys and Arrow keys.
  74.  
  75.     Elvis supports shifted Arrow Keys, and shifted Function keys
  76.     too.
  77.  
  78.     Elvis can be told where to put its temp files via TMP or TEMP
  79.     environment variables.
  80.  
  81.     Elvis can use any user defined shell. (csh, ksh, conman, etc)
  82.  
  83.     Elvis makes writes of no larger than 256 bytes to the
  84.     console.device to prevent problems accompanying large writes.
  85.  
  86.     Elvis also turns off the cursor to speed output.
  87.  
  88.  
  89. Under AmigaDOS 2.04 the following features are supported:
  90.  
  91.     Elvis can be run. (ex.  Run Elvis s:startup-sequence)
  92.  
  93.     Elvis supports filters via PIPE:.  Elvis multitasks and runs
  94.     programs Asynch.
  95.  
  96.     Elvis supports Local environment variables.
  97.  
  98.     Elvis supports tag lookup using an external tag program called ref.
  99.  
  100.     Elvis command line supports AmigaDOS regular expression and `*'
  101.     wildcards via calls to MatchFirst, MatchNext.
  102.  
  103.     Elvis preserves file protection bits (eg s-rw--).
  104.  
  105.     Elvis will support 101 key keyboards.
  106.  
  107. Elvis requires more than the standard 4000 byte stack.  A stack of
  108. 10,000 bytes should be adequate.
  109.  
  110. Elvis has two support programs that notice and recover files from its
  111. temporary files: elvprsv and elvrec.  By default Elvis uses T: for its
  112. temporary file, but most people have T:  assigned to RAM:T.  Not very
  113. useful if the system reboots, since files in this area are not
  114. recoverable after a system crash.  And if you assign this to a hard
  115. drive, you run the risk of corrupting your drive if the system resets
  116. during a write operation.  Based on this, you may want to change the
  117. $TEMP variable to use a recoverable area such as RAD: or VD0:.  There
  118. is no problem with using RAM:T other than you won't be able to recover
  119. changes to a file. Remember Elvis doesn't rewrite or delete the
  120. original file until you tell it.  So, even if a crash occurs all you
  121. should lose are the in memory changes, not the original file.
  122.  
  123. All this talk of system crashes is not to be taken that Elvis is
  124. buggy.  Only, that since it is an editor it is prone to being used by
  125. developers who do occasionly crash their machine while debugging
  126. programs.
  127.  
  128. Sincerely,
  129. Mike Rieser
  130.  
  131. PS I hope you enjoy using Elvis, and if any bugs are found peculiar to
  132. the AmigaDOS port, please notify me via e-mail.
  133.  
  134. riesermc@mentor.cc.purdue.edu 
  135. or
  136. 2410 Happy Hollow Rd, Apt D-10
  137. West Lafayette, IN 47906-1722
  138.