home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 6 / Sonderheft_6-96.iso / pd / libraries / wbstart / wbstart.txt < prev    next >
Text File  |  1996-11-03  |  9KB  |  240 lines
  1. Documentation for WBStart V2.2                                18-Sep-1996
  2.  
  3.  
  4.    Permission is granted to make and distribute verbatim copies  of  this
  5. manual provided the copyright  notice  and  this  permission  notice  are
  6. preserved on all copies.
  7.  
  8. COPYRIGHT
  9.  
  10.    Copyright (C) 1991-96 Stefan Becker
  11.  
  12.    No program, document, data file or  source  code  from  this  software
  13. package, neither in whole nor in part, may be included or used  in  other
  14. software packages unless it is authorized by a  written  permission  from
  15. the author.
  16.  
  17.  
  18. NO WARRANTY
  19.  
  20.    There is no warranty for this software package.  Although  the  author
  21. has tried to prevent errors he can't guarantee that the software  package
  22. described in this document is 100% reliable. You are therefore using this
  23. material at your own risk. The author cannot be made responsible for  any
  24. damage which is caused by using this software package.
  25.  
  26.  
  27. DISTRIBUTION
  28.  
  29.    This software package is freely distributable. It may be transfered to
  30. any media which is used for the distribution of free software like Public
  31. Domain disk collections, CDROMs, FTP servers or bulletin board systems.
  32.  
  33.    In order to ensure the integrity of this software package distributors
  34. should use the original archive file WBStart2_2.lha (file name on Aminet:
  35. WBStart.lha). The author cannot be  made  responsible  if  this  software
  36. package has become unusable due to modifications of the archive  contents
  37. or of the archive file itself.
  38.  
  39.    There is no limit on the fee taken by distributors, e.g. for the media
  40. costs of floppy disks, streamer tapes or compact discs, or the process of
  41. duplicating. Such limits have proven to be harmful to the idea of  freely
  42. distributable software, e.g. the software package was removed instead  of
  43. reducing the price of a floppy disk below the limit.
  44.  
  45.    Although the author does not impose any limit on these fees  he  would
  46. like to express his personal opinions on this matter:
  47.  
  48.    * This software package should be made available to everyone  free  of
  49.      charge whenever this is possible.
  50.  
  51.    * If you have purchased this software package under normal  conditions
  52.      from a Public Domain dealer on a floppy disk and have paid more than
  53.      5DM or US $5 then you have definitely paid too  much.  Please  don't
  54.      support this improper profit making  any  longer  and  switch  to  a
  55.      cheaper source as soon as possible.
  56.  
  57.  
  58. USAGE RESTRICTIONS
  59.  
  60.    No program, document, data file or  source  code  from  this  software
  61. package, neither in whole nor in part, may be used on any  machine  which
  62. is used
  63.  
  64.    * for the research, development, construction, testing  or  production
  65.      of weapons or other military applications. This  also  includes  any
  66.      machine which is  used  in  the  education  for  any  of  the  above
  67.      mentioned purposes.
  68.  
  69.    * by people who accept, support or use violence against other  people,
  70.      e.g. citizens from foreign countries.
  71.  
  72.  
  73.  
  74. I. What is the purpose of this software package?
  75. ================================================
  76.  
  77. WBStart is a package  to  emulate  the  Workbenchs'  method  of  starting
  78. programs. Emulating this method seems to  be  easy  on  the  first  look,
  79. because you only have to load a program, create a process and then send a
  80. Workbench startup message to it.
  81.  
  82. But complications arise from this startup message. It  contains  pointers
  83. to memory and directory locks owned by your process and it  will  not  be
  84. returned until the newly created Workbench process exits. So your process
  85. can't quit until ALL Workbench processes which have been started by  your
  86. process are finished. If you don't wait the replied messages will go into
  87. nowhere land and the man from India will visit you.
  88.  
  89. WBStart solves this problem by using a handler process, which  loads  the
  90. program, creates the process, sends the message and then  waits  for  the
  91. reply. You just supply all  needed  information  like  program  name  and
  92. arguments in a library call. The handler copies this information so  your
  93. program can free its resources and exit.
  94.  
  95.  
  96.  
  97. II. Installation
  98. ================
  99.  
  100. Just copy the files libs/wbstart.library  and  libs/dospath.library  into
  101. your LIBS: directory.
  102.  
  103. The file WBStarter in dev/c/examples is an example program how to use the
  104. library. It has the following syntax:
  105.  
  106.    WBStarter <command> [<command> ...]
  107.  
  108. WBStarter tries to  start  each  command  as  Workbench  process  without
  109. parameters.
  110.  
  111.  
  112.  
  113. III. Caveats
  114. ============
  115.  
  116.  - Use always path names in the Default Tool field in project  icons.  If
  117.    you use only the program name then the wbstart.library has to scan the
  118.    path list of the Workbench to locate the program.  In  this  case  the
  119.    program may not be able to locate  its  icon,  because  most  programs
  120.    look only into the current directory for the icon and do not look into
  121.    PROGDIR: as a backup solution. As a result the program can't find  its
  122.    tool types and might work incorrectly.
  123.  
  124.    NOTE: The same problem also occurs with the Workbench.
  125.  
  126.  
  127.  
  128. IV. Contents of this software package
  129. =====================================
  130.  
  131. dev/         Autodoc, FD, Assembler, C and Oberon support files  for  the
  132.              wbstart.library. It also contains the C source code for  the
  133.              WBStarter example and the DICE link libraries.
  134.  
  135. libs/        wbstart.library and dospath.library.
  136.              Copy these files to LIBS:
  137.  
  138. src/         Source code for the wbstart.library. It has been written for
  139.              DICE 3.0 and is included for educational purposes only.  Use
  140.              the command "DMake" to compile it.
  141.  
  142. WBStart.txt  This documentation.
  143.  
  144.  
  145.  
  146. V. Credits
  147. ==========
  148.  
  149. I would like to thank:
  150.  
  151.  - Allan Odgaard <Duff@DK-Online.DK> for the Assembler support files.
  152.  
  153.  - Thomas Igracki <T.Igracki@bamp.berlinet.de> for the Oberon support files.
  154.  
  155.  
  156.  
  157. VI. History
  158. ===========
  159.  
  160. 2.2 (18-Sep-1996)
  161.  
  162.    - Added "Caveats" and "Credits" section.
  163.    - Added Assembler and Oberon support files.
  164.    - Clarified directory lock usage in AutoDoc entry for WBStartTagList().
  165.    - Fixed problems with softlinks and project icons introduced in 2.1.
  166.    - Now uses dospath.library for AmigaDOS path list handling.
  167.  
  168. 2.1 (07-Jun-1996)
  169.  
  170.    - Now handles file names correctly which  contain  a  path  part  that
  171.      points to a multiple assign.
  172.  
  173. 2.0 (13-Mar-1996)
  174.    - The code has been rewritten from scratch.
  175.    - The handler has been integrated into a shared  library.  This  means
  176.      that you don't have to start the handler by hand anymore. It will be
  177.      started automagically when you try to start a  WB  program  using  a
  178.      library call. This also means an end to all these "I can't start  WB
  179.      programs" error reports resulting from a missing e-Flag on the  file
  180.      L:WBStart-Handler :-)
  181.  
  182.      NOTE: The old interface is not supported anymore!
  183.            You have to rewrite your applications.
  184.  
  185.    - Requires OS 3.0 (V39) or better.
  186.    - Now uses memory pools to reduce memory fragmenting.
  187.    - Improved WB starter code. It should be almost 100% compatible to the
  188.      real Workbench now.
  189.  
  190.      NOTE: This may result in some incompatibilities to the  old  WBStart
  191.            package, so you  might  have  to  change  some  of  the  input
  192.            parameters, e.g. in ToolManager Exec objects.
  193.  
  194.    - Fixed the problem with variables and aliases.
  195.    - Fixed the problem with project icons whose default tool had no icon.
  196.  
  197. 1.4 (03-Oct-1993)
  198.    - If the handler can't duplicate the lock of an argument, it now looks
  199.      if the argument  name  ends  with  a  ':'.  This  type  of  argument
  200.      specifies a device and is produced by the Workbench, e.g. if you put
  201.      an unformatted disk into a drive and use the device icon as argument
  202.      to the program SYS:System/Format.
  203.  
  204. 1.3 (27-Jun-1993)
  205.    - The handler now copies the path from the WB process. This solves the
  206.      problems with programs which use WB2CLI() or similiar  functions  to
  207.      get the WB path list, e.g. SYS:System/CLI. My apologies  to  Michael
  208.      Sinz, Michael B. Smith and the GRn beta testers.
  209.    - The handler now scans the path list when it tries to load a program.
  210.    - The handler now uses NewLoadSeg() instead of LoadSeg().
  211.    - Major source cleanup.
  212.  
  213. 1.2 (21-Sep-1992)
  214.    - Corrected version string.
  215.  
  216. 1.1 (13-Sep-1992)
  217.    - Fixed weird return bug in WBStart.
  218.    - Fixed "Insert volume PROGDIR:..." bug.
  219.  
  220. 1.0 (24-Nov-1991)
  221.    - Initial release
  222.  
  223.  
  224.  
  225. VI. Contact addresses
  226. =====================
  227.  
  228. Send comments, suggestions or bug reports to:
  229.  
  230.  Postal address:
  231.  
  232.                   Stefan Becker
  233.                   Bonner Ring 68
  234.           D-50374 Erftstadt
  235.                   GERMANY
  236.  
  237.  EMail:           stefanb@yello.ping.de
  238.  
  239.  World Wide Web:  http://www.ping.de/sites/yello/
  240.