home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / dosutils / 4ddbu512.arj / 4DDBU.DOC next >
Text File  |  1992-04-15  |  17KB  |  397 lines
  1.  
  2.  
  3.  
  4.        4DOS/DOS BATCH UTILITIES v5.12                         Page  -1-
  5.  
  6.  
  7.                                                         15th April 1992
  8.  
  9.  
  10.  
  11.                                    CONTENTS
  12.                                    --------
  13.  
  14.  
  15.        Limit of liability.............................................2
  16.        License information............................................2
  17.        Files included in the 4DOS/DOS Batch Utilities.................3
  18.        Use of each program............................................4
  19.           COMPACT.....................................................4
  20.           SQZ.BTM.....................................................4
  21.           GETCH.......................................................5
  22.           TIMEBOOT....................................................6
  23.           TIMEDASK....................................................6
  24.           TIMEDMSG....................................................7
  25.        History........................................................7
  26.        About 4DDBU....................................................8
  27.        Acknowledgments................................................8
  28. @PA
  29.  
  30.  
  31.  
  32.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -2-
  33.  
  34.  
  35.                               LIMIT OF LIABILITY
  36.  
  37.        These utilities  are distributed as-is.  The author disclaims all
  38.        warranties,  expressed  or  implied.  The  author  will assume no
  39.        liability for damages either from  the direct use of this product
  40.        or  as a  consequence of  the use  of this product.  Further, the
  41.        author reserves the right to  revise this publication and to make
  42.        changes  from  time  to  time   in  the  content  hereof  without
  43.        obligation of the author to  notify any person or organisation of
  44.        such revision or changes.
  45.  
  46.        These  utilities  were  originally  distributed  with  the  RECON
  47.        (formerly REBOOT) suite of programs.  As they don't depend on the
  48.        RECON program in any way, they have now been released separately.
  49.  
  50.  
  51.                               LICENSE INFORMATION
  52.  
  53.        These utilities are the copyrighted  property of Peter Ogden. You
  54.        are granted a limited license  to use, copy, and distribute these
  55.        programs provided the following conditions are met:
  56.  
  57.           A. Copying  and distribution fees may  not exceed fifteen (15)
  58.              Australian dollars.
  59.  
  60.           B. The  utilities may  only be  distributed in  their original
  61.              unmodified state.
  62.  
  63.        This software  is distributed under  the user supported  software
  64.        concept.  Though  copyrighted,  you  are  encouraged  to copy and
  65.        distribute this program  to others.  If you like this product and
  66.        find  it useful,  a registration  fee of  twenty (20)  Australian
  67.        dollars  (includes free  registration of  RECON) is  required for
  68.        continued use.  A twelve month  instant update plan  is available
  69.        (new versions mailed to you as  soon as they are complete) for an
  70.        additional AUD$ 25.00.  Site licenses are  available at a reduced
  71.        rate (contact the author).
  72.  
  73.        The user  supported software concept (also  known as 'shareware')
  74.        is an attempt  to provide quality software at  low cost. Both the
  75.        user and author benefit from this  plan. The user will benefit by
  76.        being able to "test  drive" software thoroughly before purchasing
  77.        it.  The author  benefits by  being able  to enter the commercial
  78.        software  market  while  avoiding  the  high  cost  of commercial
  79.        distribution.
  80.  
  81.        This concept  helps many independent authors  and small companies
  82.        that would otherwise be discouraged from developing and promoting
  83.        their ideas. It can only work  with your support. If you obtain a
  84. @PA
  85.  
  86.  
  87.  
  88.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -3-
  89.  
  90.  
  91.        user supported program  from a friend and you  are still using it
  92.        after a few  weeks, then it is obviously  worth something to you,
  93.        and a contribution should be sent.
  94.  
  95.        For   further   information   and   registration,   please   send
  96.        correspondence to:
  97.  
  98.                Peter Ogden
  99.                C/- ESB Consultancy
  100.                P.O. Box 2259,
  101.                Boulder,.
  102.                Western Australia,     6432
  103.  
  104.                Fax: +61-90-93-2220
  105.  
  106.        or,   for   information,   bug   reports,   or  suggestions  (not
  107.        registration) Netmail at 3:690/643.5 (FidoNet).
  108.  
  109.        The  latest version  of RECON  and 4DDBU  are available  for free
  110.        download  from ESB  Consultancy's BBS:  Algorithms Anonymous  (24
  111.        Hours) on +61-90-93-3145.
  112.  
  113.  
  114.                 FILES INCLUDED IN THE 4DOS/DOS BATCH UTILITIES
  115.  
  116.        4DDBU.DOC         This document.
  117.  
  118.        COMPACT.EXE       Program  that  removes  duplicates  from a 4DOS
  119.                          history file.
  120.  
  121.        GETCH.EXE         Program for  displaying a supplied  question on
  122.                          screen  requiring  a  single  character  reply.
  123.                          Returns  a  DOS  errorlevel  dependent  on  the
  124.                          answer.
  125.  
  126.        REGISTER.FRM      Registration form.
  127.  
  128.        SQZ.BTM           4DOS Batch To Memory (BTM) program that removes
  129.                          the duplicate  entries from the  in memory copy
  130.                          of the command history.
  131.  
  132.        TIMEBOOT.EXE      Program (for AT compatibles only) to reboot the
  133.                          computer automatically at a given time.
  134.  
  135.        TIMEDASK.EXE      Program for displaying a user supplied question
  136.                          on   screen  (requiring   a  single   character
  137.                          answer), returning a  DOS error level depending
  138.                          on the  answer (for use with  batch files). The
  139.                          question remains on screen  for a default of 15
  140.                          seconds (changeable).
  141. @PA
  142.  
  143.  
  144.  
  145.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -4-
  146.  
  147.  
  148.        TIMEDMSG.EXE      Program for displaying  a user supplied message
  149.                          on screen that may be cleared with a press of a
  150.                          key or will time out after a short delay.
  151.  
  152.  
  153.                               USE OF EACH PROGRAM
  154.  
  155.        COMPACT:
  156.  
  157.        This program is only of use to  users of 4DOS v3.0 or greater (if
  158.        you have not heard of 4DOS, see the note below).  COMPACT removes
  159.        duplicates from a 4DOS command history file. This type of file is
  160.        created by typing the following on the 4DOS command line:
  161.  
  162.                     HISTORY > FILENAME.EXT
  163.  
  164.        This creates  a file named  FILENAME.EXT containing the  complete
  165.        list  of commands  entered since  the  start  of 4DOS  up to  the
  166.        maximum memory size  allocated to the 4DOS History.  As this is a
  167.        complete  list there  are bound  to be  a few duplicated commands
  168.        where you  have entered the  command again rather  than scrolling
  169.        back through the previous commands in the history.
  170.  
  171.        COMPACT will remove these duplicates  so that you may reload your
  172.        compacted history  file from disk  (with the HISTORY  /R option -
  173.        see the  4DOS documentation).  This compacted history results  in
  174.        faster searches through the history for the desired commands.
  175.  
  176.        COMPACT can handle a history file up to 8K in size, with lines of
  177.        up to 255 characters, and a maximum of 4096 lines.
  178.  
  179.        Type "COMPACT /?" (without the quotes) to get a short explanation
  180.        of how to use COMPACT.
  181.  
  182.        Note: 4DOS is a shareware  replacement (by J.P. Software) for the
  183.              MS/PC-DOS COMMAND.COM.  It enhances the  existing commands,
  184.              adds more than 40 new commands, scrollable command history,
  185.              and heaps more. If you work with DOS at the command line or
  186.              write complex batch files, you should be using it!  4DOS is
  187.              available on good BBS's all over the world.
  188.  
  189.        SQZ.BTM:
  190.  
  191.        SQZ.BTM  is a  batch to  memory file  that will remove duplicates
  192.        from  the "in  memory" history.  This 4DOS  Batch To Memory (BTM)
  193.        program is an example of how COMPACT might be used. Note: SQZ.BTM
  194.        creates  a temporary  file (__HIST.TMP)  during the  process, and
  195.        deletes it after completion.
  196. @PA
  197.  
  198.  
  199.  
  200.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -5-
  201.  
  202.  
  203.        Another  use for  a compacted   history file  is to  pre-load the
  204.        history during the AUTOEXEC.BAT  to have frequently used commands
  205.        available via command history.
  206.  
  207.        GETCH:
  208.  
  209.        This program will optionally display a line of text that requires
  210.        a single character answer.  This allows batch  files to have user
  211.        interaction while running.  The program returns a DOS error level
  212.        which is the  same as the ascii code  of the uppercase equivalent
  213.        of the key pressed.  This error level can then be used in a batch
  214.        "if errorlevel" statement to control flow while running.
  215.  
  216.        e.g. GETCH Do you wish to run SCAN on C:? (Y//N)
  217.        displays: Do you wish to run SCAN on C: (Y/N)
  218.  
  219.        As is  shown above, to  use the switch  characters / or  - in the
  220.        text, two consecutive switch characters must be used. GETCH waits
  221.        for a  key to be  pressed, the errorlevel  returned is the  ascii
  222.        value of the uppercase equivalent of the  key (i.e. y = Y = 89, n
  223.        = N = 78).
  224.  
  225.        GETCH has three options: /F - Flush keyboard, /P - Pop-up window,
  226.        and  /W -  sound Warning.  The flush  keyboard option removes any
  227.        keystrokes  entered prior  to the  execution of  GETCH to prevent
  228.        accidental activation.  The warning option sounds a beep when the
  229.        text is  written to the screen  to draw the users attention.  The
  230.        Pop-up  option displays  a pop-up   window in  the centre  of the
  231.        screen in  the default colours  of white on red.  If you  wish to
  232.        change the default colours of the  window text and frame, set the
  233.        DOS environment  variables TextAttr and FrameAttr  to the colours
  234.        required  in  the  following  format:  ForeColourOnBackColour (no
  235.        spaces).  For example:
  236.  
  237.                 SET TextAttr=YellowOnBlue
  238.                 SET FrameAttr=LtGreenOnMagenta
  239.  
  240.        The available colours are:
  241.  
  242.        Low intensity:
  243.                 Black,  Blue, Green,  Cyan, Red,  Magenta, Brown, LtGrey
  244.                 (or LtGray).
  245.  
  246.        Hi intensity:
  247.                 DkGrey (or  DkGray), LtBlue, LtGreen,  LtCyan, LtRed (or
  248.                 Pink), LtMagenta, Yellow, White.
  249.  
  250.        If you  want flashing characters,  use a hi  intensity colour for
  251.        the background. Alternate spellings for grey are provided for, as
  252. @PA
  253.  
  254.  
  255.  
  256.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -6-
  257.  
  258.  
  259.        is Pink  allowed for LtRed.  This method is  used for all  of the
  260.        4DDBU utilities with pop-up window options.
  261.  
  262.        Type  "GETCH"  (alone,  without  the   quotes)  to  get  a  short
  263.        explanation of how to use GETCH.
  264.  
  265.        TIMEBOOT:
  266.  
  267.        This program will set the computer to automatically reboot itself
  268.        at  a given  time.  This is a  very simple  program that sets the
  269.        alarm function  of the AT  Real Time Clock  to activate the  BIOS
  270.        boot sequence.
  271.  
  272.        This  program  is  not  a  TSR,  no  memory  is  reserved, and no
  273.        processing time  is taken from the cpu.  To  disable a previously
  274.        set timed boot, type:
  275.  
  276.                TIMEBOOT OFF
  277.  
  278.        Type  "TIMEBOOT   /?"  (without  the  quotes)   to  get  a  short
  279.        explanation of how to use TIMEBOOT.
  280.  
  281.        NOTE: This  version of  TIMEBOOT is  for AT  compatible computers
  282.              only (it  uses the alarm  function of the  built in clock).
  283.  
  284.        TIMEDASK:
  285.  
  286.        This program allows the user  to display a question that requires
  287.        a single  character  answer  (for  use  in  batch  programs). The
  288.        program returns an DOS error level which is the same as the ascii
  289.        code of  the uppercase equivalent of  the key pressed, or  if the
  290.        user does not  answer within 15 seconds (or a  value set with the
  291.        DOS environment variable DELAY down  to a minimum of 5.0 seconds,
  292.        maximum of  approximately 3600.8 seconds), the  program will time
  293.        out, returning a  default error level of 0.  The question entered
  294.        will flash after  10 seconds, and time out  after 15 seconds. See
  295.        GETCH for an example. Type "TIMEDASK" (alone, without the quotes)
  296.        to get a short explanation of how to use TIMEDASK.
  297.  
  298.        TIMEDASK  has four  options: /B  - Beep  count down,  /F -  Flush
  299.        keyboard, /P  - Pop-up window, and  /W - Sound Warning.  The beep
  300.        option  beeps approximately  once per  second for  the last  five
  301.        seconds of the timed ask, to  draw the users attention. The flush
  302.        keyboard  option  removes  any  keystrokes  entered  prior to the
  303.        execution  of  TIMEDASK  to  prevent  accidental  activation. The
  304.        Pop-up  option displays  a pop-up   window in  the centre  of the
  305.        screen in the  default colours of white on red.  See GETCH for an
  306.        explanation  of how  to change  the default  colours. The warning
  307.        option sounds  a beep when the  text is written to  the screen to
  308.        draw the users attention.
  309. @PA
  310.  
  311.  
  312.  
  313.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -7-
  314.  
  315.  
  316.        TIMEDMSG:
  317.  
  318.        This program allows the user to simply display a message that may
  319.        be  cleared by  pressing a  key, or  if left,  will clear after a
  320.        delay (default  is 10 seconds,  though may be  changed by setting
  321.        the  DOS  environment  variable  DELAY  to  the value required in
  322.        seconds, up  to a maximum  of approximately 3600.8  seconds). The
  323.        program returns an DOS error level of 0 if the message is allowed
  324.        to  time  out,  or  1  if  a  key  was  pressed to clear it. Type
  325.        "TIMEDMSG" (without the quotes) to get a short explanation of how
  326.        to use TIMEDMSG.
  327.  
  328.        TIMEDMSG  has three  options: /F  - Flush  keyboard, /P  - Pop-up
  329.        window, and /W - Sound Warning. The flush keyboard option removes
  330.        any  keystrokes entered  prior to  the execution  of TIMEDMSG  to
  331.        prevent  accidental  activation.  The  Pop-up  option  displays a
  332.        pop-up window in the centre of  the screen in the default colours
  333.        of white  on red.  See GETCH for an explanation of  how to change
  334.        the default  colours.  The warning option sounds a  beep when the
  335.        text is written to the screen to draw the users attention.
  336.  
  337.  
  338.                                     HISTORY
  339.  
  340.        v4.01 : (and  earlier)  These  utilities  (with  the exception of
  341.                GETCH)  were previously  a part  of a  suite of  4DOS/DOS
  342.                utilities by the name of REBOOT. As these utilities stand
  343.                alone from  REBOOT and the  size of the  compressed files
  344.                was  becoming large,  it has  been decided  to distribute
  345.                these separately.
  346.  
  347.        v4.02 : New  program   added:  GETCH.  Similar   in  function  to
  348.                TIMEDASK, except GETCH will wait indefinitely for a users
  349.                reply.
  350.                Minor optimisation performed on all utilities.
  351.  
  352.        v5.00 : GETCH now has two new options: /F and /W.
  353.                TIMEDASK now has three new options: /B, /F, and /W.
  354.                All programs are now DESQview compatible.
  355.                Further optimisation performed on all utilities.
  356.  
  357.        v5.10 : New  program  added:  TIMEDMSG.  Similar  in  function to
  358.                TIMEDASK, except only displays a message.
  359.                New option added to TIMEDASK, and GETCH: /P.
  360.                Delay now variable in TIMEDASK and TIMEDMSG.
  361.  
  362.        v5.11 : Bug  fix for  CGA/Mono screen  disappearing  (wrong  mode
  363.                set).
  364. @PA
  365.  
  366.  
  367.  
  368.        4DOS/DOS BATCH UTILITIES v5.12 User Manual              Page  -8-
  369.  
  370.  
  371.        v5.12 : Bug fix  for TIMEDASK and  GETCH not correctly  returning
  372.                errorlevels.
  373.                Low level routines updated.
  374.  
  375.  
  376.                                  ABOUT 4DDBU
  377.  
  378.        For those that are interested,  the 4DDBU suite was written using
  379.        Turbo Pascal 6.0  and Turbo Assembler 2.0 with  the assistance of
  380.        Turbo  Debugger  and  Turbo  Profiler.  The  unit  libraries were
  381.        written by Glenn Crouch and Peter Ogden. The author would like to
  382.        thank Glenn  Crouch and Jason Cowie  (beta tester extraordinaire)
  383.        for their patience and thoroughness in beta testing the 4DDBU and
  384.        REBOOT/RECON programs.
  385.  
  386.  
  387.                                 ACKNOWLEDGMENTS
  388.  
  389.        4DOS is copyright Rex Conn & J.P. Software.
  390.        DESQview is copyright Quarterdeck Office Systems.
  391.        MS-DOS is copyright Microsoft.
  392.        Turbo Pascal and Turbo Assembler are copyright Borland.
  393.  
  394.  
  395.                                    ---***---
  396. @PA
  397.