home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / mshell.zip / README < prev    next >
Text File  |  1994-01-20  |  6KB  |  213 lines
  1. MSHELL: Mini PM Shell for OS/2                    MONTE COPELAND
  2.  
  3. (c) Copyright International Business Machines Corporation 1992.
  4. All rights Reserved.
  5.  
  6.  
  7. REVISION HISTORY:
  8. --------------------------
  9. 20OCT94: IBM Employee Written Software release
  10. 16OCT93: memorize icon place
  11. 09OCT93: fix bug that started everything in the background
  12. 21SEP93: revised readme; rebundle startdos
  13. 27AUG93: startdos its own pkg; mshell.exe with new default INI
  14. 06MAY93: new startdos.exe; mshell.exe the same
  15. 20JAN93: included separate startdos.exe utility which lets users
  16.          specify dos settings prior to dosstartsession
  17. 14JAN93: debug code out; illustrate use of & and CMD.EXE;
  18.          creates a default INI if none present.
  19. 14SEP92: 32-bit; WinShutdownSystem; visual interface to the spooler;
  20.          task list; debug code left in.
  21. 26JUN92: auto-starting of programs
  22. 14MAY92: same function; clean up source; setfocus to listbox; remove
  23.          debug assertion code.
  24. 27MAR92: initial placement on os2tools
  25.  
  26.  
  27.  
  28. INTRODUCTION:
  29. -------------
  30.  
  31. MShell is an alternative, simple, mini shell for OS/2 2.X that
  32. uses the replaceable shell architecture of the Workplace Shell.
  33. With this architecture and their own EXE, programmers can easily
  34. make OS/2 a turnkey platform.
  35.  
  36. MShell is a program launcher. MShell provides one list of
  37. programs to start; you configure these programs by editing a
  38. plain text file called MSHELL.INI. In addition to starting
  39. programs, MShell can save the desktop, interact with the spooler,
  40. and do a system shutdown.
  41.  
  42. Because MShell has limited function, you have to install OS/2 PM
  43. printer drivers when Workplace Shell is booted. Once installed,
  44. MShell can manipulate print queues. To boot one shell or the
  45. other, change the RUNWORKPLACE line in CONFIG.SYS and reboot.
  46.  
  47. MShell is IBM Employee Written Software. Please read the "as-is"
  48. license agreement from IBM. Essentially, you use this program "as
  49. is," and IBM makes no warranty about the correctness of this
  50. program or its suitability to any purpose.
  51.  
  52. MShell is a sample program. MShell is written in IBM C Set/2, and
  53. source code is available on Developer Connection for OS/2 CD
  54. Volume 3.
  55.  
  56. Monte Copeland, IBM Boca Raton.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63. MSHELL INSTALLATION:
  64. --------------------------
  65.  
  66. 1) MShell requires OS/2 2.0 or later.
  67.  
  68. 2) Copy MSHELL.EXE into the root directory of the boot drive.
  69.  
  70. 3) Edit CONFIG.SYS and modify the SET for RUNWORKPLACE to name
  71.    MSHELL.EXE. Example:
  72.  
  73.    SET RUNWORKPLACE=C:\MSHELL.EXE
  74.  
  75.    If you boot OS/2 from a drive other than C:, modify RUNWORKPLACE
  76.    accordingly. When MSHELL.EXE runs, it looks for MSHELL.INI in the
  77.    root directory of the boot drive. If there is no MSHELL.INI,
  78.    MShell will create one for you.
  79.  
  80. 4) Reboot.
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87. CUSTOMIZING MSHELL:
  88. --------------------------
  89.  
  90. MSHELL.INI contains program-start information.  MShell reads the INI
  91. file, displays the program information in a listbox, and starts those
  92. programs at the user's request.  Unlike most INI files, MSHELL.INI is
  93. plain text.  Use a text editor when changing MSHELL.INI.
  94.  
  95. There are two parts to an MSHELL.INI line:
  96.  
  97.   1) the program title to display
  98.  
  99.   2) a START command acceptable to OS/2's command processor CMD.EXE.
  100.  
  101. Separate these two parts with a single semi-colon (;). Here is an
  102. example MSHELL.INI line to start the Klondike Solitaire program:
  103.  
  104.       Solitaire ;  start /f "Solitaire" klondike.exe
  105.  
  106. Lines in the INI that begin with exclamation mark (!) will be
  107. automatically started by MShell when the system boots. For example:
  108.  
  109.       !Clock ;  start pmclock
  110.  
  111. To start programs from other than the root directory, use the
  112. command concatenator of CMD.EXE, the ampersand (&). Example INI
  113. line:
  114.  
  115.    Save Changed Files;  d: & cd \wp & xcopy *.* a: /m
  116.  
  117. Comment lines in MSHELL.INI begin with an asterisk (*).
  118.  
  119. MShell can start up to 50 programs or batch files.  This is an MShell
  120. limit, not OS/2.
  121.  
  122.  
  123.  
  124.  
  125. MSHELL OPTIONS:
  126. ----------------------
  127.  
  128. There are five options that appear in the Options pull-down:
  129.  
  130. Print spooler:  presents a dialog which allows interaction with the
  131. OS/2 spooler.  Pause, resume, and delete jobs.  Pause and resume print
  132. queues.
  133.  
  134. Save desktop:  will broadcast a posted WM_SAVEAPPLICATION to all
  135. children of HWND_DESKTOP, the desktop window.  Most PM applications
  136. will then save their current settings to the INI file.
  137.  
  138. Refresh programs in INI:  allows you to re-load MSHELL.INI at any
  139. time.  This is good for testing your modifications to MSHELL.INI
  140. without having to reboot.
  141.  
  142. Command prompt:  starts a windowed OS/2 command prompt (CMD.EXE)
  143. session.
  144.  
  145. Shutdown system: prompts the user to confirm the shutdown.
  146. Respond Yes, wait until the "safe" message, then turn off or
  147. reboot the computer.
  148.  
  149.  
  150.  
  151.  
  152. STARTDOS AND DOS SETTINGS:
  153. ------------------------------
  154.  
  155. Certain DOS settings can only be specified prior to DOS session
  156. start. Since the Workplace Shell DOS settings dialog is not
  157. available under MShell, one needs a way to start these
  158. special DOS sessions.
  159.  
  160. StartDos is an OS/2 program that programmatically starts DOS
  161. sessions with settings. StartDos accomplishes this using Rexx.
  162. StartDos has a built-in readme. Enter one of these commands:
  163.  
  164.       STARTDOS >README
  165.       STARTDOS | MORE
  166.  
  167. Obtain the STARTDOS package from OS2TOOLS or STARTD.ZIP from
  168. OS2USER Library 17.
  169.  
  170.  
  171.  
  172.  
  173. KNOWN BUGS:
  174. ----------------------
  175.  
  176. On OS/2 2.1, MShell's shutdown does not write the cached INI file
  177. to disk before shutdown is complete. On reboot, recently saved
  178. settings are gone. Workaround: do a Save Desktop, wait 60 seconds
  179. (until the disk light flashes), then shutdown.
  180.  
  181.  
  182.  
  183.  
  184. SPOOLER NOTES:
  185. ---------------------
  186.  
  187. MShell, or any RUNWORKPLACE executable, must start the spooler.
  188. MShell will initialize the spooler and provide a rudimentary
  189. visual interface to the spooler.
  190.  
  191. To initialize the spooler, 32-bit MShell calls the OEM API
  192. Spl32QmInitialize. The function prototype is
  193.  
  194.   VOID APIENTRY Spl32QmInitialize( PULONG );
  195.  
  196. An example of calling is
  197.  
  198.   Spl32QmInitialize( &ulrc );
  199.  
  200. On success, expect ulrc to be zero.  MShell imports this API with
  201. this IMPORTS statement in its DEF file.
  202.  
  203.   IMPORTS
  204.     SPL32QMINITIALIZE  =  PMSPL.SPL32QMINITIALIZE
  205.  
  206.  
  207.  
  208.  
  209.  
  210. LICENSE INFORMATION:
  211. ----------------------
  212. Please read the file LICENSE.TXT for IBM licensing information.
  213.