
     ORIGAMI FOLDING EDITOR, v2.0 
     for Linux on i386 processors  


     Vedat Demiralp     
     S.V.Demiralp@ukc.ac.uk

LINUX INSTALLATION ( a very crude way )
------------------

1) Place the shell script file 'origami' and the binary executable
   'origami2' in a directory in your access path.

2) Place the files 'vt220.key' and 'vt220.hlp' to a directory of your choice

3) Edit the file 'origami' 
  a)  to set 'ORIGAMIHOME' to the directory pathname where you have
      placed the files 'vt220.key' and 'vt220.hlp'.
  b)  to enter the pathname of origami2 (if it is not in your access path) 

4) Place all the files in the tutorial directory to a personal directory. 

5) The current version of origami is hardwired for vt220 terminal capabilities.
   Search for vt220 capabilities in the file '/etc/termcap'.
   If there is no vt220 capabilities specified then login as the super-user
   to edit '/etc/termcap'.  As a quick way of adding vt220 capabilities,
   find the entry line for vt320 and insert vt220 as in the example below.
   If no 'bs' ( backspace ) capability is specified for vt220|vt320 then
   insert it as in the example below

original lines:
   vt320|vt300|dec vt320 7 bit terminal
        :am:es:hs:mi:ms:xn:\

modified lines:
   vt220|vt320|vt300|dec vt320 7 bit terminal
        :am:bs:es:hs:mi:ms:xn:\
 
6) The postscript file 'orifunc.ps' contains an A4 size picture of
   the current function keymap and a brief description of each function.
   It may be useful to have a printed copy of it around at the beginning.

USING ORIGAMI
-------------

Start origami editor:

   origami [filenames]

To display the function keymap press the ENTER key on the numeric keypad
anytime when you are working with origami. Most of the origami functions
in described in 'vt220.key' bundled in this distribution are mapped
on the numeric keypad.
***** NOTE: On some PC keyboards you have to turn NUM LOCK on when 
            working with origami.

To become familiar with the editor features change to the directory
where you have placed the tutorial files and run

   origami tutor.origami

Note that you may alter the file 'tutor.origami' during the training.
Make sure that you have copied the files 'tutor.origami' and '*.txt'
to a directory where you have write permission.

BUGS
----

We have been using this version quite happily for a while.
Once the installation is complete and it starts working it makes
editing really enjoyable. But...

Avoid 'SAVE AS' function, which should save the buffer under a different
filename. This feature currently crashes origami (the only known crash).
There is 'SAVE & RESUME' function, and copy the saved file to another
with the Linux 'cp' command.

Please report any bugs or other irritants to me at:

   S.V.Demiralp@ukc.ac.uk

IMPORTANT TIPS:
---------------

1) Origami takes automatic backup of the current edit file each time 
  a certain amount of changes have occured( a small amount).
  The temporary backup files are named using the original filename
  between # signs, e.g.  '#myfile#' for the edit file 'myfile'.

  Currently the temporary files are not erased when you quit origami.
  It is up to you to remove them. Under bash shell # character at the
  beginning of a word wildly expands to everything. 
  Therefore the following can make you cry by deleting everything
  in your directory:

      rm #myfile#       -->   works as  'rm *'

  The following are OK, nevertheless it is always safe to use 
  a harmless 'ls' command before executing a deadly 'rm' to see how
  the wild characters expand:
    rm *#        rm \#*        rm *myfile#      rm \#myfile# 
  
2) When you save a file disk, origami keeps the original copy of file
   with the same name appended with ~ sign, e.g.  myfile~

3) If you want to customise the function keymap, edit the file 'vt220.key'
   and use the description format there, i.e.

  function_number = [keycode sequence]      //  comments

  Decide on the new key for a function. Find the code sequence the
  key generates when pressed. 

  In the file 'vt220.key' the keycode sequence inside the square brackets
  may be entered in hex or decimal format.

  You can map a particular function to more than one key.
  Origami refuses to start when it notices a particular keycode sequence
  cannot uniquely identify a function, i.e. either the same keycode
  sequence defines more than one function or it matches the header of
  another keycode sequence.

  At the moment the '.key' file should be named 'vt220.key' irrespective
  of your terminal type because of the hard wiring defined in the software.
 
----- 

