home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d09xx / d0924.lha / S-Omni / S-Omni.doc < prev    next >
Text File  |  1993-10-07  |  8KB  |  240 lines
  1.  
  2.  
  3.                              S - OMNI  V1.1
  4.  
  5.  
  6.    A number of the S- series of programs to produce self-executing files have
  7.   now been released:
  8.  
  9.    o   Texts                S-Text
  10.    o   ILBM pictures        S-Pic
  11.    o   Anim5 animations     S-Anim5
  12.    o   Command files        S-Exec
  13.  
  14.    It would be possible to carry on in this vein to S-Anim6, S-Gif and so on,
  15.   but a totally omniverous programme to wrap up the series is offered instead
  16.   - S-OMNI.   S-Omni has three modes of operation:
  17.  
  18.    Mode 1:    S-Omni will take any normal command-line - as it might be typed
  19.            at a CLI - and bundle it together with any supporting files needed
  20.            into a single compressed self-executing file.
  21.  
  22.    Mode 2:    S-Omni will take a Script(batch) file and bundle it together with
  23.            any supporting files needed into a single compressed self-executing
  24.            file.
  25.  
  26.    Mode 3:    S-Omni will take a series of files and bundle them into a
  27.            single compressed self-decompressing archive.
  28.  
  29.    In each case all the files used are recoverable in their original
  30.   uncompressed state.
  31.  
  32.    Use mode 1 to fill all the gaps in the current S-series, producing
  33.   executable files out of virtually any combination of tool and data file.
  34.  
  35.    Mode 2 has a vast range of applications. For example
  36.  
  37.       Instead of mode 1 where conditions must be preset - stack increased -
  38.       font changed - private libraries copied to LIBS: (the libraries can be
  39.       inluded in the S-Omni file).
  40.  
  41.       Installation scripts.
  42.  
  43.       Demonstrations, tutorials, sales pitches.  The normal degree of
  44.       interaction through the `IFWARN' command is available, and this can
  45.       be extended by the use of ARexx or programs such as "AskReq" by Hans
  46.       -Peter Guenther.
  47.  
  48.       Eliminating the need for IconX or Xicon texts.
  49.  
  50.    Mode 3 will produce simple self-decompressing archive files.
  51.  
  52.  
  53.    One point to bear in mind is that after running an S-Omni file the user
  54.   will find in ram: uncompressed copies of all the files used.  Think twice
  55.   before including any commercial programmes which are not freely
  56.   distributable.
  57.  
  58.  
  59.  
  60.  
  61.                            INSTRUCTIONS 
  62.  
  63.  
  64.                            FILE CREATION 
  65.  
  66.  
  67.    In all modes the S-Omni can be called from a cli or from WorkBench.
  68.  
  69.       CLI:        call S-Omni or Run S-Omni.
  70.  
  71.       WorkBench:  click the S-Omni icon.
  72.  
  73.    In both cases a requester will appear; at the top are three buttons for
  74.   the three possible modes:
  75.  
  76.      SCRIPT = Mode 2,  COMMAND = Mode 1,  FILES = Mode 3.
  77.  
  78.    Below the three mode buttons are four string gadgets.  When a mode button
  79.   is clicked  any string gadgets not required in that mode will be ghosted.
  80.  
  81.  MODE 1
  82.  
  83.    In mode 1 you will need to enter data on the "Command Line", "Output File"
  84.   and "Include Files" lines:
  85.  
  86.      Command Line:  Enter your Command exactly as it would be entered at a CLI,
  87.                    EXCEPT that any files that you are going to provide (as
  88.                    "Include Files") must show only the file-NAME, and no paths.
  89.                    Press `RETURN' at the end of the line. 
  90.  
  91.      Output File:   Click the button to get a FileRequester (ASL or ARP) or
  92.                    enter file name directly (and press `RETURN').  Include any
  93.                    necessary path.
  94.  
  95.      Include Files: Enter here any files which you want to provide to the user
  96.                    so that the command line can be executed.  In the Command
  97.                    Line only the filename for these was shown; here the full
  98.                    path must be given so that S-Omni can find them.  The file
  99.                    requester button can be used to enter files sequentially, or
  100.                    files can be entered by hand, leaving at least one space
  101.                    between each - do not neglect to press `RETURN' at the end
  102.                    of the line.  The buffer is 512 characters long.
  103.  
  104.  
  105.  MODE 2
  106.  
  107.    In mode 2 (scripts) data is entered on lines "Script", "Output File", and
  108.   "Include Files" lines.
  109.  
  110.      Script:  Enter the full path and name of your Script file.  You can get a
  111.               requester or enter the file directly.   See the paragraph on the
  112.               preparation of scripts below.
  113.  
  114.      Output File:  As for mode 1.
  115.  
  116.      Include Files:  As for mode 1.
  117.  
  118.  
  119.  MODE 3
  120.  
  121.     In mode 3 (files) only the "Output File" and "Include Files" lines are
  122.   used:
  123.  
  124.      Output File:  As for mode 1.
  125.  
  126.      Include Files:  As for mode 1.
  127.  
  128.     When all necessary lines have been completed press OK to create the Omni
  129.   file (or cancel to clear all entries).
  130.  
  131.     When the programme exits you will find a file "filelist" in RAM, 
  132.   containing a list of all the files included in the omni .se file.  This is
  133.   provided so that you can check that the omni-file is complete.
  134.  
  135.  
  136.  SCRIPTS
  137.  
  138.    Any normal script file should be acceptable to S-Omni (there are so many
  139.   variations that it has not been possible to test them all!).  The file
  140.   "script" in this drawer is a straightforward example and uses a total of
  141.   nine commands and files:
  142.  
  143.      echo,if,endif,wait and ask are standard DOS commands; they will normally be
  144.     available in the user's Shell, and hence there should be no need to
  145.     provide "include files" for them.
  146.  
  147.      P-Reader, Readme and Chinchilla  - include files must be provided.
  148.     The script itself must quote ONLY the file-NAMES, no paths.  Paths should be
  149.     included on the "IncludeFiles" line.
  150.  
  151.    So for this script the following entries might be made:
  152.  
  153.      Script:         S-Omni:script
  154.  
  155.      Command Line:   Blank
  156.  
  157.      Output File:    Ram:script.se
  158.  
  159.      Include Files:  Dh0:Reader/P-Reader Dh0:Text/Readme Dh1:Pics/Chinchilla
  160.  
  161.    There is no provision in V1.1 for passing arguments to scripts with the
  162.   .KEY keyword.  It is hoped to deal with this in a future version.
  163.  
  164.  
  165.  REXX
  166.    Rexx `scripts' can be used but must be called as Rexx commands.
  167.  
  168.    Rexx scripts can be an extremely useful way of getting numeric or string
  169.   responses, however there is a difficulty in getting AREXX to look at the
  170.   right cli when getting the response (similar to the difficulty met if
  171.   you try to call "RUN RX <script>.rexx" at a cli).  One way of dealing
  172.   with this is shown in the file shell.rexx which ultimately will call
  173.   the rexx script "age.rexx" (which is the file that gets a user response)
  174.   directly from a con: window.  There may be simpler ways - I am sadly
  175.   lacking in experience with REXX.  The Omni entries for this would have a
  176.   command line "RX shell.rexx" and shell.rexx, age.rexx and REXXMAST (to be
  177.   safe) are "Include files". 
  178.  
  179.    If the resulting .se file will not run properly from a WorkBench icon,
  180.   try copying the command RX from the rexxc drawer to the C drawer.
  181.  
  182.  
  183.                               USE 
  184.  
  185.      
  186.    To run the file treat it like any other executable:
  187.  
  188.      At a CLI type the name, use RUN if you wish.
  189.      From Workbench double-click the icon.
  190.  
  191.    Files included in the Omni-file are decompressed and copied to a new
  192.   drawer "Omni" which is opened in ram.  Ram:omni is made the Current
  193.   Directory; any Command Line included is then run or script file executed.
  194.  
  195.    When the programme finally exits the script file (if any) and the `include'
  196.   files will be found in ram:omni.   
  197.  
  198.    Type the command "EndCLI" in any cli window remaining open to close it.
  199.  
  200.   
  201.            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  202.  
  203.  
  204.    S-Omni is Freeware.  It may be copied and distributed freely and used
  205.   without charge for non-commercial purposes.  Authority for commercial
  206.   use should be obtained from the author below.
  207.  
  208.    No responsibility can be accepted for any loss occasioned by use of the
  209.   programme.
  210.  
  211.    It would be over-optimistic to imagine that this initial version of
  212.   S-Omni will cope with all the possible variations of command lines and
  213.   scripts.  If you find something it will not handle correctly please let
  214.   me know so that the next version can be improved.
  215.  
  216.   Chas A. Wyndham,
  217.   1265 Canning Mills Road,
  218.   Roleystone,
  219.   WA 6111.
  220.   Australia 
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.