home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / vdms_110.zip / VDMSERVE.DOC < prev    next >
Text File  |  1994-01-11  |  10KB  |  255 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                   VDMSERVE, DOSCMD
  10.  
  11.                       VDM Server Utility, version 1.10 Manual
  12.  
  13.            Copyright 1993, 1994 by David G. Fisher.  All rights reserved.
  14.  
  15.  
  16.  
  17.  
  18.           Introduction
  19.                What is VDMSERVE?.....................................3
  20.                Disclaimer............................................4
  21.  
  22.           Using VDMSERVE
  23.                The Basic Philosophy..................................5
  24.                Description of Syntax.................................6
  25.                Examples..............................................8
  26.  
  27.  
  28.  
  29.      VDMSERVE Users Manual                                            Page 3
  30.      --------------------------------------------------------------------------
  31.  
  32.      What is VDMSERVE?
  33.  
  34.      VDMSERVE is a program which will continuously run in a background session
  35.      and execute DOS (VDM) commands when requested.  Why?  Because as of the
  36.      writing of this program (for OS/2 2.1), it is not possible to run a DOS
  37.      session/program under OS/2 in a "detached" background state.  The DOS
  38.      program must be invoked from a session which has associated with it a
  39.      screen (i.e., STDIN/STDOUT) group.
  40.  
  41.      This presented a problem since I still use a couple of DOS programs with
  42.      my BBS.  All of my mail processing is "detached" and executed in the
  43.      background.  This is fine until I try to invoke a DOS program from this
  44.      detached batch file.  The DOS session simply does not execute.  OS/2 does
  45.      not even report a problem--it simply does not create the VDM session to
  46.      execute the DOS program.
  47.  
  48.      Thus, I wrote this server to create VDM sessions in which to execute DOS
  49.      programs.  It is in this way that a detached batch file can request the
  50.      VDM server to execute a DOS program and, since the VDM server is a wholly
  51.      independent session of it's own, has the full ability to create a VDM
  52.      session (or multiple ones simultaneously if the server receives many
  53.      requests at the same time).
  54.  
  55.      PLEASE NOTE!  This program is being sent out into the public domain "as
  56.      is".  I will probably not be able to make modifications to the program due
  57.      to lack of time, although you are welcome to send bug reports none-the-
  58.      less.  I am making it available with this minimal documentation primarily
  59.      at the request of a couple of people who desired to use it.
  60.  
  61.  
  62.  
  63.      VDMSERVE Users Manual                                            Page 4
  64.      --------------------------------------------------------------------------
  65.  
  66.      Disclaimer
  67.  
  68.      This program is shareware.  There is absolutely no warranty for this
  69.      program or guarantee it will work.  The user of this program assumes all
  70.      risk.  While I feel confident this program will not harm your system in
  71.      any way, by using this program, you agree to assume full responsibility
  72.      for any adverse effect to your system.
  73.  
  74.      Where applicable, all trademarks referred to here are the property of
  75.      their owners.
  76.  
  77.  
  78.  
  79.      VDMSERVE Users Manual                                            Page 5
  80.      --------------------------------------------------------------------------
  81.  
  82.      The Basic Philosophy
  83.  
  84.      Starting and using VDMSERVE is easy.  There are two .CMD files included
  85.      with VDMSERVE which control the initiation of VDMSERVE and communication
  86.      to VDMSERVE once it is running.
  87.  
  88.      RUNSERVE.CMD
  89.  
  90.           This batch file initiates VDMSERVE.  I have the following line in
  91.           my REXX STARTUP.CMD file:
  92.  
  93.                call RunServe
  94.  
  95.           Or, if you are simply testing VDMSERVE, you can execute RunServe
  96.           from a Full Screen OS/2 session.
  97.  
  98.      RUNDOS.CMD
  99.  
  100.           This batch file will request VDMSERVE to execute the indicated DOS
  101.           command.
  102.  
  103.      That's it!
  104.  
  105.  
  106.  
  107.      VDMSERVE Users Manual                                            Page 6
  108.      --------------------------------------------------------------------------
  109.  
  110.      Description of Syntax
  111.  
  112.      VDMSERVE
  113.           /Config = <path+file name>          default: None
  114.           /[no]Log                            default: NoLog
  115.           /LogFile = <path+file name>         default: None
  116.           /LogLevel = <1..4>                  default: 4
  117.           /[no]Quiet                          default: NoQuiet
  118.           /Debug=<0..5>                       default: 0 (no debug)
  119.  
  120.      DOSCMD ["DOS command line"]
  121.           /[no]Log                            default: NoLog
  122.           /LogFile = <path+file name>         default: None
  123.           /LogLevel = <1..4>                  default: 4
  124.           /[no]Quiet                          default: NoQuiet
  125.           /Debug=<0..5>                       default: 0 (no debug)
  126.           /KillServer                         default: NoKillServer
  127.           /WaitMode                           default: NoWaitMode
  128.           /WaitTimeout = <1..n>               default: 120 seconds
  129.           /Title="Task List Title"            default: None
  130.  
  131.      Notes on the syntax:
  132.  
  133.           Qualifiers can appear in any order, in any case, and are only
  134.           significant to four characters.  /TossLogFile, for instance, is
  135.           the same as /toss.
  136.  
  137.      Qualifiers
  138.  
  139.      /Config = <path+file name>
  140.  
  141.           This is the name of the configuration file.  The default is
  142.           VDMSERVE.CFG in the current directory.  If you prefer, you can
  143.           define an environment variable using the DOS SET command instead,
  144.           with the following syntax:
  145.  
  146.           Set VDMSERVE_CONFIG=<path+filename>
  147.  
  148.      /[no]Log
  149.  
  150.           This qualifier will turn the logging function on and off.  Default
  151.           is NoLog.
  152.  
  153.      /LogFile = <path+file name>
  154.  
  155.           This qualifier defines the name of the log file.
  156.  
  157.      /LogLevel = <1..4>
  158.  
  159.           This qualifier defines the level of log file detail.  Level 1 is
  160.           the least detailed, while Level 4 is the most verbose.  The levels
  161.           indicate the 'importance' of a message, where Level 1 is the most
  162.           important (usually error messages).
  163.  
  164.      /[no]Quiet
  165.  
  166.           This qualifier controls whether the program should print detailed
  167.           output to the "standard output device", which is normally the
  168.           screen.  Set it to /Quiet and all you see are the program
  169.           copyright line and any error messages.  The default is /NoQuiet.
  170.  
  171.  
  172.  
  173.      VDMSERVE Users Manual                                            Page 7
  174.      --------------------------------------------------------------------------
  175.  
  176.  
  177.      /Debug=<0..5>
  178.  
  179.           This qualifier will instruct the program to print internal
  180.           processing information to STDOUT.  This qualifier is useful when
  181.           submitting bug reports, or trying to solve a problem in the
  182.           configuration.  At the highest debug level (5), quite a bit of
  183.           information will displayed.
  184.  
  185.      /KillServer
  186.           This qualifier is for DOSCMD only.  When used with the EXIT
  187.           command (explained below), it will destroy the actual OS/2 session
  188.           which the server was running in.
  189.  
  190.      /WaitMode
  191.           This qualifier is for DOSCMD only.  This instructs DOSCMD to wait
  192.           for confirmation from the server that the DOS command is finished
  193.           executing.
  194.  
  195.      /WaitTimeout = <1..n>
  196.           This qualifier is for DOSCMD only.  This tells DOSCMD how long to
  197.           wait before "giving up" on waiting for a "DOS command completion
  198.           response" from the server.
  199.  
  200.      /Title="Task List Title"
  201.           This qualifier is for DOSCMD only.  When the DOS command is
  202.           executing, it will appear in the Task List on the OS/2 Desktop
  203.           (i.e., Alt-Esc).  Normally, this will simply be "DOS Session"
  204.           unless you use this qualifier to specify differently.
  205.  
  206.      "DOS command line"
  207.           This parameter is for DOSCMD only.  It is the actual DOS command
  208.           which would normally be typed in at a DOS prompt.  There are two
  209.           special commands which will be interpreted by VDMSERVE, and NOT
  210.           executed as DOS commands:
  211.  
  212.           EXIT
  213.  
  214.           This command will cause VDMSERVE to terminate gracefully.  If
  215.           combined with /KillServer, then the actual OS/2 session which was
  216.           running the server will also be destroyed.
  217.  
  218.           REFRESHLOG
  219.  
  220.           This command will cause VDMSERVE to close it's log file, rename it
  221.           to <filename>.BAK, and open a new log file.  This is to facilitate
  222.           easy back up of the log file.
  223.  
  224.      PLEASE NOTE!  There are some monitoring qualifiers that I have purposely
  225.      left out of the documentation, but which are mentioned in VDMSERVE.CFG and
  226.      the help screen from DOSCMD (when DOSCMD is entered without any
  227.      parameters).  These routines may not work on your machine (or cause your
  228.      machine to hang!), or later versions of OS/2.
  229.  
  230.  
  231.  
  232.      VDMSERVE Users Manual                                            Page 8
  233.      --------------------------------------------------------------------------
  234.  
  235.      Examples
  236.  
  237.      The following examples are pulled directly from REXX .CMD files on my BBS.
  238.  
  239.           call RunDOS RefreshLog '/Wait /WaitTimeout=10'
  240.  
  241.           call RunDOS 'runseal.bat' '/Wait /WaitTimeout=120'
  242.  
  243.      where RUNSEAL.BAT contains several DOS commands:
  244.  
  245.           rem    Scan netmail area for remote requests
  246.  
  247.           SEAL SCAN -cc:\bbs\squish\squish.cfg
  248.  
  249.           rem    Scan bad message area to check for newly created areas
  250.  
  251.           SEAL BAD -cc:\bbs\squish\squish.cfg
  252.  
  253.           rem    Add any descriptions for newly added areas, if necessary
  254.  
  255.           SEAL DESCRIBE ECHO FIDONET.LST -cc:\bbs\squish\squish.cfg