home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / dosqu25a.zip / DOSQUE.DOC next >
Text File  |  1994-08-20  |  21KB  |  509 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                     DOSque
  15.                                     ══════
  16.  
  17.                  DOS/Network Command/Program Execution Queue
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                       ▄▄▄▄▄▄▄▄▄▄▄
  33.                       █  ▄▄▄▄▄  █  (C)Copyright 1994
  34.                       █  █   █  █
  35.                       █  ▀▀▀▀▀  ▀  Bremer Corporation
  36.                       █  ▄▄▄▄▄  ▄  Austin, Texas
  37.                       █  █   █  █
  38.                       █  ▀▀▀▀▀  █  All rights reserved
  39.                       ▀▀▀▀▀▀▀▀▀▀▀
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                                  Version 2.5a
  46.  
  47.                                  August 1994
  48.                               TABLE OF CONTENTS
  49. ══════════════════════════════════════════════════════════════════════════════
  50.  
  51.      Topic                                                        Page
  52.  
  53.      Introduction  . . . . . . . . . . . . . . . . . . . . . . . .  3
  54.  
  55.      Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . .  4
  56.           Requirements
  57.           Limits
  58.           Start-Up Options
  59.           Renaming DOSque
  60.           Required Files
  61.  
  62.      Quick Start . . . . . . . . . . . . . . . . . . . . . . . . .  5
  63.  
  64.      Start-Up Batch File . . . . . . . . . . . . . . . . . . . . .  6
  65.  
  66.      Commands  . . . . . . . . . . . . . . . . . . . . . . . . . .  7
  67.  
  68.      Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . .  8
  69.  
  70.      Types of Jobs . . . . . . . . . . . . . . . . . . . . . . . .  9
  71.  
  72.      Editing Jobs  . . . . . . . . . . . . . . . . . . . . . . . . 10
  73.  
  74.      DOSque Screen . . . . . . . . . . . . . . . . . . . . . . . . 11
  75.  
  76.      Temporary Batch File  . . . . . . . . . . . . . . . . . . . . 12
  77.  
  78.      Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
  79.  
  80.      Shareware . . . . . . . . . . . . . . . . . . . . . . . . . . 14
  81.           Evaluation Copy
  82.           Distribution
  83.           Registration
  84.           Disclaimer
  85.                                  INTRODUCTION
  86. ══════════════════════════════════════════════════════════════════════════════
  87.  
  88. DOSque was designed as a simple yet effective queue system for both network
  89. and DOS stand-alone environments.  We work in an environment that demands an
  90. easily changeable, concise queue system to help us provide proper support for
  91. a large Netware 386 (tm) wide area network domain spanning Texas.  We need a
  92. DOS command queue to help us perform necessary network activities during
  93. non-production periods.  Because we could not find one that offers the
  94. flexibility we required, we wrote our own.  We hope it helps you as much as it
  95. has helped us in controlling our environment.  Please use DOSque as you see
  96. fit, but if you continue to use it, please abide with the Shareware section of
  97. this documentation.
  98.  
  99. Here is a quick overview of DOSque:
  100.  
  101. o    Small executable.
  102.  
  103. o    Near unlimited number of queue items.
  104.  
  105. o    No memory taken by the queue system when running commands.
  106.  
  107. o    Run anything from the queue system including Terminate and Stay Resident
  108.      programs (TSRs).
  109.  
  110. o    No unnecessary restrictions like queue jobs being scheduled too close
  111.      together, etc.
  112.  
  113.  
  114. DOSque was written in Turbo Pascal 7.0 (real mode) with assembly extensions.
  115.                                 MISCELLANEOUS
  116. ══════════════════════════════════════════════════════════════════════════════
  117.  
  118. Requirements
  119. ────────────
  120. DOSque's only two known requirement is that it must run under DOS 3.1 or
  121. higher and it obviously requires a dedicated workstation when actively
  122. queuing.  It also runs fine from a Windows DOS session and from DOS shells.
  123.  
  124. Limits
  125. ──────
  126. Maximum queue items: 400
  127. Maximum length of queue commands: 58
  128. Maximum length of queue descriptions: 58
  129.  
  130. Start-Up Options
  131. ────────────────
  132. DOSque must started with the command DOSque in a batch file except for the
  133. first time when it is started with the /MAKE option.  See the Start-Up Batch
  134. File Setup section for complete information on this subject.
  135.  
  136. Required Files
  137. ──────────────
  138. The following files are necessary to run DOSque:
  139.  
  140. DOSQUE.EXE     The DOSque program.
  141.  
  142. DOSQUE.INI     The DOSque file that holds the optional encrypted password.
  143.  
  144. DOSQUE.DAT     The DOSque data file that holds all queue jobs and their
  145.                specific information.  You should not edit this file.
  146.  
  147. DOSQUE.LOG     The log file maintained by DOSque.
  148.  
  149. QUE.BAT        The start-up batch file made the first time you run DOSque.
  150.                This file may be called any name you wish and should be placed
  151.                in your path.
  152.                                  QUICK START
  153. ══════════════════════════════════════════════════════════════════════════════
  154.  
  155. To quickly get the queue system up and running, do the following (check the
  156. documentation later for specifics):
  157.  
  158. o    Place DOSQUE.EXE in the directory you wish to run it from.
  159.  
  160. o    Run DOSQUE.EXE /MAKE once.
  161.  
  162. o    Edit/rename the resulting QUE.BAT as necessary.
  163.  
  164. o    Place QUE.BAT in your path.
  165.  
  166. o    Run QUE.BAT (or whatever you renamed it to).
  167.  
  168. o    Add jobs as required.
  169.                              START-UP BATCH FILE
  170. ══════════════════════════════════════════════════════════════════════════════
  171.  
  172. As part of the initial setup performed by running DOSQUE.EXE /MAKE once, the
  173. file QUE.BAT will be made in DOSque's home directory.  You should place
  174. DOSQUE.EXE in the directory you wish to run it from before running it for the
  175. first time because the home directory information is used in creating this
  176. batch file.  If you have already run it once and wish to move DOSQUE.EXE, then
  177. you may either run DOSQUE.EXE again with a /MAKE parameter (creating a new
  178. QUE.BAT) or simply edit the existing QUE.BAT.
  179.  
  180. QUE.BAT should be in your path for easier loading, but DOSQUE.EXE does not
  181. need to be there.  DOSQUE.INI and DOSQUE.DAT will always be in the same
  182. directory as DOSQUE.EXE.
  183.  
  184. Here is a commented queue.BAT:
  185.  
  186. @echo off                          ;Cosmetics
  187. f:                                 ;Change to home drive and directory
  188. cd \login
  189. ::previous run file exists?
  190. if exist dq$run.bat del dq$run.bat ;Delete previous run file
  191. dosque /batch %1                   ;Run DOSque
  192. ::no command?
  193. if not exist dq$run.bat goto END   ;Did we quit?
  194. ::run temporary batch file
  195. call dq$run                        ;Run batch file made by DOSque
  196. f:                                 ;Change to home again
  197. cd \login
  198. ::do it again                      ;Keep running the batch file (and the queue)
  199. f:                                 ;Change to home drive and directory
  200. cd \login
  201. que /rerun
  202. :END                               ;Place to go to when quitting
  203.  
  204. QUE.BAT changes to its home directory only to make it easier for you to manage
  205. a queue environment.  By keep the various batch file commands that DOSque may
  206. call to perform your jobs in one location, it is easier to manage the entire
  207. queue situation.  Of course, directly called DOS commands have no need to be
  208. in this directory.
  209.                                    COMMANDS
  210. ══════════════════════════════════════════════════════════════════════════════
  211.  
  212. DOSque has very few commands.  They are listed below along with an
  213. explanation of their activities.
  214.  
  215. F1   HELP      DOSque contains context sensitive help.  Press it anytime.
  216.  
  217. F2   ADD       This key will add new job definitions to the queue.  See the
  218.                Editing Jobs section for more.
  219.  
  220. F3   LOG       This key will view the END of the DOSQUE.LOG file, thereby
  221.                showing you the most recent queue activity.  When viewing the
  222.                log, the DEL key will delete it.  You should do this when the
  223.                log becomes so large that it takes noticeable time for DOSque to
  224.                find the end of it for viewing.  Although writing to it never
  225.                slows down no matter how large it is, reading can become slow
  226.                because DOSque reads sequentially through the file to find the
  227.                end of it for viewing.
  228.  
  229. F4   CHANGE    This key will allow you to change the highlighted job's
  230.                definition.  See the Editing Jobs section for more.
  231.  
  232. F5   COPY      This key will let you copy the highlighted job so that the new
  233.                job can then be more easily defined when editing it.  See the
  234.                Editing Jobs section for more.
  235.  
  236. F6   SHOW      This key toggles the Next Run/Last Run column's information.
  237.                Next Run shows in order the jobs as they will run data and time
  238.                wise.  Last Run shows the history of the last jobs run, also in
  239.                order.
  240.  
  241. F7   STATUS    This key toggles the highlighted job's status from Ready to
  242.                Hold.  When a job is ready, it will run at its queue data and
  243.                time.  When on hold, it will not.  If you take a job off hold
  244.                during the same day (date) that it was supposed to run, it will
  245.                run immediately, else it will automatically cycle to its next
  246.                run date.  When taking a job like this off hold, you will be
  247.                prompted if the job is going to run immediately.  The same
  248.                holds true when re-starting DOSque or returning from the DOS
  249.                shell option:  if there are any jobs ready to go, you will be
  250.                prompted with an option to temporarily place them on hold so
  251.                you can evaluate the queue situation first.
  252.  
  253. F8   DELETE    This key will let you delete the highlighted job from the
  254.                queue.  Once deleted, you can not undo it.
  255.  
  256. F9   RUN       This key will let you run the highlighted job, even though its
  257.                queue activation time has not arrived.  This does not change
  258.                its next queue time.
  259.  
  260. F10  QUIT      This key quits DOSque.  If a password has been made, then this
  261.                option requires the password.
  262.  
  263. ÆF1  DOS       This key allows you to open a temporary DOS session.  If a
  264.                password has been made, then this option requires a password.
  265.  
  266. ÆF10 PASSWORD  This key allows you to define or remove the optional system
  267.                password.  Among other times discussed above, the password will
  268.                be required when attempting to interrupt the screen saver
  269.                function.  This, of course, is not true if DOSque itself is
  270.                interrupting the screen saver to accomplish a queue job.
  271.  
  272. ESC  PREVIOUS  This key backs you out of prompts, if necessary.
  273.                                     SETUP
  274. ══════════════════════════════════════════════════════════════════════════════
  275.  
  276. To set up DOSque, place DOSQUE.EXE in the directory from which you would like
  277. it to run.  This directory does not have to be in your path.  From this
  278. directory, run DOSQUE /MAKE.  This command will make the sample start-up batch
  279. file, QUE.BAT.  You should then edit this batch file if needed and then placed
  280. it somewhere in your path.  That is all there is to it.  You are now ready to
  281. run QUE.BAT which will activate your queue system.
  282.                                 TYPES OF JOBS
  283. ══════════════════════════════════════════════════════════════════════════════
  284.  
  285. There are basically two types of queue jobs that can be set up and run with
  286. DOSque:  weekly and date specific.
  287.  
  288. Weekly jobs are defined as follows:
  289.  
  290. o    runs at a specific time on the same day or days every week.
  291.  
  292. o    runs at a specific time every day.
  293.  
  294. Date Specific jobs are defined as follows:
  295.  
  296. o    runs at a specific time once in a lifetime.
  297.  
  298. o    runs at a specific time once each month.
  299.  
  300. o    runs at a specific time each year.
  301.  
  302.  
  303. See the Editing Jobs section for a complete breakdown on how to set up these
  304. types of jobs.
  305.                                  EDITING JOBS
  306. ══════════════════════════════════════════════════════════════════════════════
  307.  
  308. Jobs are set up and edited by pressing F2 ADD or F4 EDIT from the main queue
  309. screen.  A pop-up editing window appears asking the following questions.
  310.  
  311. DOS Command:  This is the actual DOS command that will be placed in the
  312. temporary batch file for running when this job meets its next queue time.  The
  313. command can be any valid DOS command, including Terminate and Stay Resident
  314. (TSR) programs.  If you have more than one DOS command required, then place
  315. them into a batch file and place the path (if required) and the name as the
  316. answer to this question.
  317.  
  318. Description:  The optional screen description for this job.
  319.  
  320. Hour:  This is the hour of the day that this job will run.  It is always
  321. required and must be issued in 24 hour time.
  322.  
  323. Minute:  This is the minute of the hour of the day that this job will run.  It
  324. is always required.
  325.  
  326. Weekly/Date Specific:  Enter a W for weekly or a D for date specific.  Note
  327. that this item can always be changed later.  In fact, you can enter the below
  328. information for both weekly and date specific for this job and both will be
  329. remembered.  Then you may later switch between the two as desired by editing
  330. this job.  The answer you give here will dictate the next questions that are
  331. asked of you while editing the job.
  332.  
  333. If weekly...
  334.  
  335. Su Mo Tu We Th Fr Sa:  Place a Y in each day that you wish this job to run at
  336. the specified time.  The job will run on those days forever unless you kill
  337. the job or place it on hold (or you, of course, quit DOSque).
  338.  
  339. If date specific...
  340.  
  341. Day of month:  Enter the day between 1 and 31 of the month that you wish the
  342. job to run.  This is a required field for date specific jobs.  If you do not
  343. fill in the following month and year fields, then this job will run every
  344. month on this day at the specified time forever, else it can run on specific
  345. months (and/or years) on this month day.
  346.  
  347. Month:  Enter the month for this job to run on the month day.  If nothing is
  348. entered, then it will run every month.
  349.  
  350. Year:  Enter the year that this job should run on the month and day specified.
  351. If nothing is entered here, then it will run on the specified month and day
  352. every year.  If a year is given, then this becomes a once in a lifetime job.
  353.                                 DOSQUE SCREEN
  354. ══════════════════════════════════════════════════════════════════════════════
  355.  
  356. The header at the top of the DOSque screen looks something like this:
  357.  
  358.                         |-------Days----------|or|--Date--|  |Next Run|
  359. DOS Command      HH:MM  Su Mo Tu We Th Fr Sa Su  Da Mo Year  MM-DD-YYYY  Status
  360. or                                                           |Last Run|
  361.  
  362. DOS Command: The actual command to be run for this job.
  363.  
  364. HH:MM: The job time.
  365.  
  366. Su Mo Tu We Th Fr Sa Su:  The days this job will run ONLY if this is a
  367. "weekly" job.
  368.  
  369. Da Mo Year:  The month day and optionally the month and optionally the year
  370. that this job will run ONLY if this is a "date specific" job.
  371.  
  372. Next Run:  This shows, in sorted order, the next date and time each job will
  373. run.
  374.  
  375. Last Run:  This shows, in sorted order, the last time each job ran.
  376.  
  377. Status:  One of the following:
  378.  
  379.      Ready  - Job is set up properly and will run at its next queue time.
  380.      Hold   - Job is on hold and can not run again until taken off hold with
  381.               the F7 key.  If a job is taken off hold on the same day on which
  382.               it is now late for its run, you will be asked to confirm as the
  383.               job will run immediately.
  384.      Bad    - Job is not set up properly; probably an incomplete date specific
  385.               edit resulting in no feasible run date.
  386.      Overdue- Job is ready but could not yet run.  This is probably resulting
  387.               from a job previous to this job that is still running and has
  388.               made this job go past its run time.  As soon as the other job
  389.               finishes, and DOSque returns to its main screen, this job will
  390.               become Ready and will run immediately - ONLY if the day is still
  391.               the same as that on which the job was queued to run.  If the day
  392.               has become the next calendar day, then this job's next run date
  393.               will cycle to the next allowable run time for this job.
  394.               Therefore, be careful when grouping jobs around the bewitching
  395.               hour (12:00 midnight)!
  396.                              TEMPORARY BATCH FILE
  397. ══════════════════════════════════════════════════════════════════════════════
  398.  
  399. When a job runs, DOSque makes a temporary batch file containing '@echo off'
  400. and the actual job DOS command.  The name of this batch file is DQ$RUN.BAT and
  401. it will be located in DOSque's home directory.
  402.  
  403. Example
  404. ───────
  405. If a queue item's DOS command was this:
  406.  
  407.   copy thisfile f:\there
  408.  
  409. then the corresponding batch file would look like this:
  410.  
  411. @echo off
  412. copy thisfile f:\there
  413.                                    CREDITS
  414. ══════════════════════════════════════════════════════════════════════════════
  415.  
  416. Turbo Pascal is a trademark of Borland International.
  417.  
  418. MS-DOS is a trademark of Microsoft Corporation.
  419.  
  420. Netware and Novell are registered trademarks of Novell, Inc.
  421.  
  422. Windows is a registered trademark of Microsoft Corporation.
  423.  
  424. Trademarks of other companies or products mentioned in this file are the
  425. property of their respective companies.
  426.                                   SHAREWARE
  427. ══════════════════════════════════════════════════════════════════════════════
  428.  
  429. Evaluation Copy
  430. ───────────────
  431. THIS IS NOT FREE SOFTWARE!  You may evaluate and use this product, but if you
  432. decide to make use of it on a regular basis, you must register your copy.
  433.  
  434. Note:  Businesses, government agencies and institutions are required to
  435. register this software package before extended use.
  436.  
  437. We offer several inducements to you for registering.  First of all, you will
  438. receive the most up-to-date copy of the program -- and we update the program
  439. on a regular basis.  Second, you will never see the shareware message again.
  440. Make no mistake, however -- this is a fully functional version of DOSque that
  441. is not "crippled" in any way.
  442.  
  443. Distribution
  444. ────────────
  445. This is "user-supported" software.  You are hereby granted permission to
  446. distribute this evaluation copy of DOSque and its documentation, subject to
  447. the following conditions:
  448.  
  449. 1.  Shareware DOSque may be distributed freely without charge in evaluation
  450.     form only.
  451.  
  452. 2.  DOSque in its shareware form may not be sold, licensed, or a fee charged
  453.     for its use.  If a fee is charged in connection with DOSque, it must
  454.     cover the cost of copying or dissemination only.  Such charges must be
  455.     clearly identified as such by the originating party.  Under no
  456.     circumstances may the purchaser be given the impression that he is buying
  457.     a registered version of DOSque.
  458.  
  459. 3.  Shareware DOSque must be presented as a complete unit with documentation.
  460.     Neither DOSque nor its documentation may be amended or altered in any way
  461.     without permission of the copyright holder.
  462.  
  463. 4.  By granting you the right to distribute the evaluation form of DOSque,
  464.     you do not become the owner of DOSque in any form.
  465.  
  466. Any other use, distribution or representation of DOSque is expressly
  467. forbidden without written consent from the author.
  468.  
  469. Registration
  470. ────────────
  471. The non-commercial single-user registration fee for DOSque is $40.00 US.
  472. ($5 shipping is included.)
  473.  
  474. The commercial/government and multi-system site fee for DOSque is:
  475.  
  476.      Non-network environment:
  477.           Per site           - $100.00 US.
  478.      Network environment:
  479.           Per site           - $100.00 US.
  480. ($10 shipping is included.)
  481.  
  482. Send a check, money order or company P.O. for the appropriate amount to:
  483.  
  484.           Bremer Corporation -DOSque
  485.           3401 Cactus Wren Way
  486.           Austin, Texas 78746
  487.  
  488. We also accept Mastercard, Visa, and American Express card telephone orders.
  489.  
  490. Thank you.
  491.  
  492. Telephone: 512-328-2465
  493. Compuserve ID: 71614,2556
  494.  
  495. Disclaimer
  496. ──────────
  497. The author does not warrant that the functions contained in this program will
  498. meet your requirements or that the program operation will be uninterrupted or
  499. error free.
  500.  
  501. The author specifically disclaims all other warranties, expressed or implied,
  502. including but not limited to implied warranties of fitness for any particular
  503. purpose and of merchantability.
  504.  
  505. In no event will the author be liable to you for any damages, including but
  506. not limited to any lost profits, lost savings, commercial damage or other
  507. incidental or consequential damages arising out of the use or inability to use
  508. this program, or for any claim by any other party.
  509.