home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / UTILS / ELVIS / README.3A < prev    next >
Encoding:
Text File  |  1995-08-21  |  7.1 KB  |  159 lines
  1.                 ELVIS for the Psion 3a and Compatibles
  2.                 ======================================
  3.                            15th August 1995
  4.                     Psion 3a version - 4th release
  5.         
  6.         INTRODUCTION
  7.         ~~~~~~~~~~~~
  8.         This information is intended to provide information
  9.         that is specific to the Psion 3a implementation of ELVIS.
  10.  
  11.         ELVIS was ported to the Psion 3a by Keith and Dave Walker.
  12.         The port is based on the ELVIS v1.8 patch level 3 source.
  13.         The key features of this port are:
  14.  
  15.           -  Full command level compatibility with the Unix "vi"
  16.              program so that users of "vi" will instantly be able
  17.              to use the ELVIS program.
  18.  
  19.           -  The ability to edit larger files than arem possible
  20.              with the Text Editor built into the Psion 3a.  The
  21.              file size is limited only by the size of the RAM
  22.              disk that you can give to ELVIS to create its
  23.              temporary files on.
  24.  
  25.         The port was done to provide us with an alternative text
  26.         editor to that built into the Psion 3a that was more
  27.         suitable to editing and amending source code files. This
  28.         was done as part of developing a complete C development
  29.         system hosted on the Psion 3a.  We intend to release this
  30.         C development system shortly under the name of CPOC (which
  31.         is a play on EPOC as the name of the Psion operating system
  32.         and "C in your POCket" as a description of the capability).
  33.  
  34.  
  35.         INSTALLATION AND RUNNING
  36.         ~~~~~~~~~~~~~~~~~~~~~~~~
  37.         The files provided are as follows:
  38.  
  39.             README              The original ELVIS README file
  40.             README.3a           Psion 3a specific information
  41.             ELVIS.APP           The ELVIS program itself
  42.             ELVIS.INI           Sample initialisation file
  43.  
  44.         The ELVIS.APP file can be installed in any directory that
  45.         you like.   We would recommend that you put it into either
  46.         the "\APP\" directory or the "\CPOC\" directory on any drive.
  47.         If it is placed in this location it will automatically be
  48.         integrated into the CPOC system when it becomes available.
  49.  
  50.         You can install ELVIS using the standard Psion-I sequence.
  51.         As supplied, ELVIS will look for files in the \TXT directory
  52.         on any drive that have a .TXT extension.  By making use of
  53.         list facility you can specify alternative file locations and
  54.         file extensions.  This is mentioned in section 16 of the
  55.         User Guide manual (the chapter called "The System Screen").
  56.  
  57.         If you have a command line processor (such as the CMDP package
  58.         released by Psion) then you can also start ELVIS (or one of
  59.         its aliases) from the command line.  You will need to specify
  60.         the full path name if you do not want to use the default one.
  61.  
  62.         Finally, if you have already loaded ELVIS you can use one of the
  63.         built in ELVIS commands (such as the "r" or "e" commands) to load
  64.         the required file.
  65.  
  66.  
  67.         TEMPORARY FILE
  68.         ~~~~~~~~~~~~~~
  69.         While ELVIS is editing a file, it uses a temporary file to
  70.         keep track of all the changes that you are making.  The
  71.         location of this temporary file is decided as follows:
  72.  
  73.           -  If the ELVIS initialisation file exists (see below) and
  74.              it contains a line such for the form
  75.                  set directory=A:\TMP\
  76.              then this is used as the location of temporary files.
  77.  
  78.           -  If the ELVIS initialisation file does not exist and
  79.              if the "TMP" or "TEMP" environment variables are set
  80.              then the directory that they point to is used for the
  81.              ELVIS temporary files.
  82.  
  83.           -  If none of the above are true then ELVIS will assume the
  84.              location "\"  (i.e. the root directory of the default
  85.              drive) is to be used for temporary files.
  86.  
  87.         It is the users responsibility to ensure that the relevant
  88.         directory for temporary files does in fact exist.  If it does
  89.         not, then ELVIS will fail while loading.
  90.  
  91.  
  92.         INITIALISATION FILE
  93.         ~~~~~~~~~~~~~~~~~~~
  94.         The normal "vi" editor when running on a Unix system allows
  95.         you to set up a file called ".exrc" that holds start up
  96.         configuration details.   The Psion 3a port of ELVIS uses
  97.         a file called "ELVIS.INI" instead.   This file (if present)
  98.         is expected to be a text file that is held in the same
  99.         directory as the ELVIS.APP file.
  100.  
  101.         This file is normally the easiest way to specify the location
  102.         for the ELVIS temporary files.   You can create an initial
  103.         ELVIS.INI file by loading the WORD application built into the
  104.         Psion 3a and saving the resulting file as file of type "TEXT".
  105.         Subsequently you can use ELVIS itself to edit the ELVIS.INI
  106.         file.
  107.  
  108.         To make it easier for you, we have provided a sample ELVIS.INI
  109.         file.  You can use this as a starting point, and tailor it to
  110.         suit you particular system and preferences.
  111.  
  112.  
  113.         DOCUMENTATION
  114.         ~~~~~~~~~~~~~
  115.         The author of ELVIS provides a full manual on its use and
  116.         facilities (about 120 pages).  This manual is provided in
  117.         the Unix ROFF format.  If you want the raw ROFF format
  118.         version of the documentation, then it is widely avaiable on
  119.         one of the many Internet sites that hold ELVIS source.  A
  120.         good site in the UK is "ic.ac.uk" (Imperial College).
  121.  
  122.         For Psion users, we have processed the ROFF format documentation
  123.         files to produce a single formatted text file  (about 200Kb
  124.         in size).  As we expect many of the typical users of ELVIS
  125.         to already be familiar with the "vi" program, we have not
  126.         included this documentation in the same package as the main
  127.         ELVIS application program, but instead made it a separate file
  128.         that you only need to download if you want it.
  129.  
  130.  
  131.         LIMITATIONS
  132.         ~~~~~~~~~~~
  133.         At this release we have not ported to the 3a the ancilliary
  134.         programs that can be used in conjunction with ELVIS.  These
  135.         include programs such as "FORMAT" and "TAGS".  Therefore
  136.         any command which depend on the presence of such ancilliary
  137.         programs will not work.  Also the Psion 3a does not have a
  138.         command shell, so the colon mode "!" command will not work.
  139.  
  140.  
  141.         CHANGE HISTORY
  142.         ~~~~~~~~~~~~~~
  143.         20 July 1995    Initial release for the Psion 3a
  144.  
  145.         13 Aug 1995   - ELVIS program now a file based ".APP" file.
  146.                       - Faster screen updating.
  147.                       - The Temporary directory changed to default to
  148.                         the root directory of the current default drive.
  149.  
  150.     15 Aug 1995   - After a :e, :n or :f command the file being edited
  151.             is updated on the system screen.
  152.  
  153.     20 Aug 1995   - Fixed the X p N and , commands (porting problem).
  154.             Updated :version command with Psion release info.
  155.             Moved messages into a resource file - frees
  156.             about 5K in data area.
  157.             :sh command now actualy runs contents of shell
  158.             variable (but :!command still doesn't work)
  159.