home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / Replacements / ASyncRun_37_8.lha / ASyncRun / Man / ASyncRun.man
Encoding:
Text File  |  1995-05-05  |  5.3 KB  |  181 lines
  1. ****** ASyncRun.man ************************************************************
  2. *
  3. *   ASyncRun  --  A `RunBack' clone for AmigaOS 2.04+  (v37.8 / 05-May-1995)
  4. *
  5. ********************************************************************************
  6.  
  7. :ts=8
  8.  
  9.  
  10.     SYNOPSIS
  11.     Command/A,Args/M,Pri/K/N,Stack/K/N,CD/K,WaitForPort/K,Sync/S,WB/S,DoIO/S
  12.  
  13.  
  14.     DESCRIPTION
  15.     ASyncRun creates a distinct independant background process using the
  16.     information you provide, thus allowing you to EndShell the shell from
  17.     which ASyncRun was launched.
  18.  
  19.  
  20.     OPTIONS
  21.     - Command
  22.         Name of the program you wish to ASyncRun. This variable
  23.         must be a valid pathname or resident programname.
  24.  
  25.     - Args
  26.         The argument(s) you wish to pass to the program. This
  27.         may be null.
  28.  
  29.     - Pri
  30.         The priority you wish to run <Command> at. MUST be in the
  31.             range from -128 to 127, but generally you should be careful
  32.             in using priorities outside of, say, +/- 5.
  33.  
  34.     - Stack
  35.             Stacksize for the child process. Defaults to 4096 bytes.
  36.  
  37.     - CD (v37.7+)
  38.         Current dir for child. Defaults to parent's dir.
  39.  
  40.     - WaitForPort (v37.4+)
  41.         Port to wait for before releasing the prompt. Please note
  42.         that port names are case sensitive! ASyncRun will wait for
  43.         up to 10 secs for this port name to appear on the public
  44.         port list.
  45.  
  46.         NB: WaitForPort replaces the Delay switch in previous
  47.             versions of ASyncRun!!!
  48.  
  49.     - SyncRun (v37.5+)
  50.         Don't return until child process finishes.
  51.  
  52.     - WBRun (v37.6+)
  53.         Run program in Workbench mode using `WBStart-Handler'.
  54.  
  55.     - DoIO (***¡NEW!***)
  56.         Use current Input() and Output() filehandles instead of
  57.         running program in the background. Only in `Sync' mode.
  58.         Requested by Timo Vehmaa <tive@alpha.hut.fi>.
  59.  
  60.     The SyncRun and WBRun options are mutually exclusive.
  61.  
  62.  
  63.     ENVIRONMENT VARIABLES
  64.     ASyncRun supports a few environment variables to make life a bit
  65.     easier, should you not be satisfied with the default values:
  66.  
  67.     - def_CD (v37.7+)
  68.         Sets default current dir. If not defined, the default is
  69.         parent's dir (i.e. current directory of shell).
  70.  
  71.     - def_Pri (v37.6+)
  72.         Default priority. If not defined, default is 0.
  73.  
  74.     - def_Stack (v37.6+)
  75.         Default stack size. If not defined, ASyncRun uses a value
  76.         of 4 kbytes.
  77.  
  78.     - CustomShell (v37.4+)
  79.         Name of custom shell (e.g. `WShell'). Don't use this one
  80.         unless you know what you're doing.
  81.  
  82.     - CopyVars (v37.7+)
  83.         Boolean (y/n) to copy local vars (default: `yes'). Any
  84.         value starting with 'n' will prevent copying of local
  85.         vars, all other values equals `yes'.
  86.  
  87.     - NoLF (v37.6+)
  88.         Dave Dustin <dave@eclipsnz.manawatu.gen.nz> seemed to have
  89.         problems with the LF that ASyncRun puts at the end of the
  90.         command line before spawning the child. Setting $NoLF to
  91.         `yes' (i.e. anything that starts with 'y') will prevent
  92.         ASyncRun from using this linefeed.
  93.  
  94.     The environment variables are searched for first as local, then as
  95.     global vars; and first in dir ASyncRun/, then `alone'. Thus the
  96.     search priority is:
  97.  
  98.         $ASyncRun/varName (local var)
  99.         $varName (local var)
  100.         $ASyncRun/varName (global var)
  101.         $varName (global var)
  102.  
  103.  
  104.     NOTES
  105.     Default settings and environment variables are overridden by command
  106.     line arguments!
  107.  
  108.     If you happen to miss this manual, most of the important things are
  109.     included in the extended help in ASyncRun (i.e. by feeding ASyncRun
  110.     with two ?'s).
  111.  
  112.     ASyncRun is `pure' and can be made resident.
  113.  
  114.  
  115.     BUGS
  116.     Looses 56 bytes per asynchronous call. This bug has been there from
  117.     the earliest version, and I have tried to track it without success.
  118.     It seems to be a `feature' of the SystemTagList() call.
  119.  
  120.  
  121.     REQUIREMENTS
  122.     dos.library v37+
  123.     utility.library v37+
  124.  
  125.     If the Null: device is present it will be used instead of the
  126.     Nil: `device'.
  127.  
  128.  
  129.     ACKS
  130.     Thanks to Steffen Salzmann <2:249/125.2@fidonet> for his suggestions
  131.         and comments during early development. Where are you now, Fenzan?
  132.  
  133.     Thanks also to Brian Munk Jacobsen <brj@boble.ping.dk> for support.
  134.  
  135.     Thanks to Dave Dustin <dave@eclipsnz.manawatu.gen.nz> for bug
  136.     reports (the `LF-bug' that happened to be a typo in the taglist for
  137.     the SystemTagList() command).
  138.  
  139.     Thanks to Stefan Becker <stefanb@yello.ping.de> for letting me
  140.     distribute his WBStart-Handler.
  141.  
  142.     Thanks to Gunnar Nordmark for the original Null-Handler (1988).
  143.  
  144.  
  145.     HISTORY
  146.     37.4    (12-Feb-93)    ·  First public release, I think.
  147.  
  148.     37.5    (17-Apr-95)    ·  Rewritten from scratch.
  149.                 ·  Support for NULL:.
  150.                 ·  SyncRun switch added.
  151.  
  152.     37.6    (28-Apr-95)    ·  $def_Pri/$def_Stack/$NoLF env-vars added.
  153.                 ·  WBRun switch added.
  154.  
  155.     37.7    (30-Apr-95)    ·  Invisible SystemTagList() bug (AKA typo),
  156.                    that would only let you use a certain
  157.                    custom shell, fixed.
  158.                 ·  $CopyVars env-var added.
  159.                 ·  CD keyword and $def_CD env-var added.
  160.                 
  161.     37.8    (05-May-95)    ·  DoIO switch Added.
  162.  
  163.  
  164.     COPYRIGHT ETC.
  165.     ASyncRun is Copyright © 1992-95 Magnetic Ink, but freely distribut-
  166.     able as long as this text is left intact and goes along with *ANY*
  167.     distribution.
  168.  
  169.     Please send comments or bug-reports by e-mail to:
  170.  
  171.  
  172. ······: Klaus :·······································: kas@mink.ping.dk :······
  173. ··············: Magnetic Ink :··················································
  174. ····································: Soli Deo Gloria :·························
  175.  
  176. -- 
  177.  
  178.     »Let us hear the conclusion of the whole matter: Fear God, and keep his
  179.      commandments, for this is the whole duty of man.«
  180.                                                        (Ecclesiastes 12:13)
  181.