home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / batch / batmgr12.arj / BAT-MAN.DOC next >
Encoding:
Text File  |  1992-04-23  |  18.8 KB  |  495 lines
  1.  
  2.    
  3.     BatManager                      Copyright (c) 1991 Timothy Clingen
  4.     Version 1.2                                    All rights reserved
  5.         
  6.  
  7.  
  8.    
  9.  
  10.                            TABLE OF CONTENTS
  11.    
  12.  
  13.     About BatManager   ...................................  Chapter  1
  14.    
  15.  
  16.     Install and Load Instructions  .......................  Chapter  2
  17.  
  18.    
  19.     User Notes  ..........................................  Chapter  3
  20.  
  21.    
  22.     Conflicts over Function Keys  ........................  Chapter  4
  23.  
  24.  
  25.     Utilities  ...........................................  Chapter  5
  26.  
  27.            
  28.     Advanced Operations  .........
  29.              ... Non Menu Batch Files, Parameter Passing .  Chapter  6
  30.  
  31.  
  32.     Registration Information  ............................  Chapter  7
  33.  
  34.  
  35.     Compiling Batch Files with ...
  36.              ... BATCOM, BAT2EXEC, POWERBATCH  ...........  Chapter  8
  37.  
  38.  
  39.  
  40.  
  41.     Disclaimer of Warranty
  42.  
  43.     This Software and manual are sold "as is" and without warranties.
  44.     Because of the variety of hardware and software environments into
  45.     which this progrram may be put, no warranty of fitness for a 
  46.     particular purpose is offered.  Good data processing procedure
  47.     dictates that any program be thoroughly tested with non-critical
  48.     data before relying on it.  The user must assume the entire risk
  49.     of using the program.  Any liability of the seller will be limited
  50.     exclusisvely to product replacement or refund of purchase price.
  51.      
  52.                                Chapter - 1
  53.             
  54.     About BatManager
  55.     
  56.     BatManager  is a simple batch file manager and menu system.  Because 
  57.     it is simple, BatManager has several distinct advantages over other 
  58.     menu systems.
  59.     
  60.     First, BatManager allows the user to remain at the DOS command line.
  61.     Experienced DOS users are not denied access to the power, flexibility
  62.     or functionality of the DOS command line interface.  Novice DOS users
  63.     are not sheltered from learning DOS.  Both experienced and novice users
  64.     can benefit from the convenience and ease of a menu interface. 
  65.  
  66.     Second, BatManager does not tie up memory (RAM).  Access to batch 
  67.     files is provided by using  ANSI's  attribute-handling abilities to 
  68.     configure and redefine the DOS function keys.  No memory resident (TSR)
  69.     programs are loaded.  No program loop is active.
  70.     
  71.     Next, unlike many other menu systems, BatManager does not require the
  72.     user to learn a new editor.  Any ASCII editor may be included into the
  73.     BatManager system.
  74.  
  75.     With BatManager you write "real" batch files.  Program specific symbols or
  76.     syntax are not required.  Files are not limited in length or complexity.
  77.  
  78.     BatManager  is not a MACINTOSH emulation.  I designed BatManager for
  79.     people who need to get the most out of their PC and the DOS operating 
  80.     system.  And for people who will benefit from an organized, systematic 
  81.     approach to accessing their software.     
  82.     
  83.     The simple low overhead strategy used by BatManager allows the program 
  84.     to run effectively on both high and low end systems.  It can be loaded 
  85.     at boot time without hogging resources.  BatManager menu options may 
  86.     be used to load more sophisticated user interfaces like  DOSSHELL  or 
  87.     PCTOOLS.  The only system requirements is hard drive, the ANSI driver,
  88.     and an ASCII editor. 
  89.  
  90.     BatManager currently supports many batch file compilers, including:
  91.  
  92.     * BATCOM     -- Wenham Software Co., 5 Burley St., Wenham, Ma. 01984.
  93.                     Most of BatManager is compiled with BATCOM.  
  94.  
  95.     * BAT2EXEC   -- Doug Boling -- PC Mag.
  96.                     Available on many bulletin boards.
  97.  
  98.     * POWERBATCH -- Computing Systems Design, Inc. 
  99.                     Available on many bulletin boards.
  100.     
  101.     Finally, BatManager is a shareware program.  You may try before you buy.
  102.     All the programs and documentation were written by me, Tim Clingen.  If 
  103.     you have any questions not covered in this documentation (BAT-MAN.DOC)
  104.     please call me.
  105.  
  106.                                Chapter - 2
  107.     
  108.     Installation Instructions:  
  109.  
  110.     BATMGR12.EXE - is a self-extracting file containing programs and data
  111.     necessary to INSTALL BatManager.  Enter the command BATMGR12 to start
  112.     the file extraction procedure.  The INSTALL process may then begin.
  113.     
  114.     INSTALL.BAT  - will initiate the installation procedure.  Read the
  115.     following check list before continuing.  If possible, use the default
  116.     directory name "\BM".
  117.  
  118.     After reading the check list, type the command INSTALL at the DOS 
  119.     command line and press RETURN.
  120.  
  121.  
  122.                        INSTALLATION  CHECK  LIST
  123.     
  124.     ?  What EDITOR do you want to use?           _____  (i.e., EDIT)
  125.     
  126.     ?  Has ANSI.SYS been loaded?                 _____  (Y/N)
  127.     
  128.     ?  Has the DOS environment been expanded?    _____  (Y/N)
  129.       
  130.     ?  Which disk drive do you want to use?      _____ (DEFAULT IS C:)
  131.     
  132.     ?  What directory name do you want to use?   _____ (DEFAULT IS \BM)
  133.     
  134.     ?  What DOS version are you using?           _____  
  135.     
  136.     Editor       BatManager allows you to select any ASCII editor.
  137.     ------       Add one line to your AUTOEXEC.BAT file to identify
  138.                  your editor.
  139.                  i.e.,  SET ED=<editor name>
  140.     
  141.     The editor must be in the DOS PATH or in the BM directory.
  142.     
  143.     ANSI.SYS     This device driver must be identified in the
  144.     --------     CONFIG.SYS file.  
  145.                  i.e,   DEVICE=ANSI.SYS
  146.     
  147.     Environment  Increase the DOS environment.  Modify the CONFIG.SYS file.
  148.     -----------  i.e,   SHELL=COMMAND.COM /E:800 /P  (DOS version 3.2+)
  149.                         SHELL=COMMAND.COM /E:62  /P  (DOS 3.0 and 3.1)
  150.     
  151.                  See your DOS manual for more details.
  152.     
  153.  
  154.  
  155.     Defaults     If possible use the default directory name \BM.
  156.     --------
  157.      After BatManager has been installed begin the LOAD proceedure.
  158.     
  159.        -  Change the default to the program directory 
  160.     
  161.        -  Enter the command BATMAN from the DOS command line
  162.     
  163.           These activities can be done in the Autoexec.bat
  164.                i.e.,       SET ED=<editor name>
  165.                            CD \BM
  166.                            BATMAN
  167.    ________________________________________________________________
  168.    
  169.    Your CONFIG.SYS file should look something like this
  170.    
  171.            SHELL=COMMAND.COM /E:800 /P
  172.            DEVICE=ANSI.SYS
  173.     ________________________________________________________________
  174.     
  175.    Your AUTOEXEC.BAT file should look something like this
  176.      
  177.             SET ED=<your editor name>
  178.     _______________________________________________________________
  179.  
  180.  
  181.    Recommendations: Download these two programs from a BBS in your area.
  182.  
  183.    TED.COM   (by Ted Kilken)   - a very small, fast ASCII editor.
  184.    NANSI.SYS (by Daniel Kegel) - an improved ANSI driver.
  185.  
  186.      
  187.                                 Chapter - 3
  188.         
  189.     User Notes
  190.     
  191.     FUNCTION KEYS
  192.     
  193.     Menu options are assigned to function keys.  You may redefine the
  194.     function keys F1 through F9 and Shift F1 through Shift F9.  Adding,
  195.     editing and deleting options is done with four Special Function Keys.
  196.  
  197.     SPECIAL FUNCTION KEYS
  198.     
  199.     The four (4) Special Functions are displayed on the screen whenever
  200.     the menu is displayed.  The Special Functions all use the F10 key.
  201.     
  202.       -  Display the menu             - press  F10
  203.     
  204.       -  Edit an option               - Shift  F10 + the key to edit
  205.     
  206.       -  Delete an option             - Ctrl   F10 + the key to delete
  207.     
  208.       -  Utilities                    - Alt    F10 
  209.  
  210.     NOTE: See chapter 4  for more information on function keys.
  211.     
  212.     THE EDITOR
  213.  
  214.     The default editor may be changed from the DOS command
  215.     line by changing the environmental variable ED. 
  216.      
  217.                i.e.  SET ED=<new editor name>
  218.                      SET ED=TED
  219.                      SET ED=EDIT
  220.  
  221.                                Chapter - 4
  222.  
  223.     Conflicts over Function Keys
  224.  
  225.     BatManager redefines the function keys using ANSI.SYS.  Most programs
  226.     using function keys bypass the ANSI redefinition.  However, to ensure
  227.     compatibility with as many applications as possible, I have developed
  228.     three solutions for resolving conflicts.
  229.  
  230.     1.  Function keys F1 through F9 have been redefined.  If your 
  231.         application requests one of these keys and does not respond 
  232.         correctly, press the corresponding ALT-Function Key.
  233.  
  234.         For example:  DOS 5.0 users may still access DOSKEY functions.
  235.  
  236.            Use ALT+F3 instead of F3 to display the last command entered.
  237.  
  238.            Use ALT+F7 instead of F7 to display the command line history.
  239.  
  240.    2.  Optionally, users may force BatManager to reset the unshifted
  241.        function keys to there original status.  The Utilities option: 'D'
  242.        will reset the unshifted function keys.  The BatManager menu will
  243.        now use the alternate function keys in place of the unshifted keys.
  244.  
  245.        I refer to this option as DOSKEY compatibility mode.  This option
  246.        may be selected from the command line by entering D + F10.
  247.      
  248.    3.  All function keys may be reset by selecting the Utilities option: 'U'
  249.        or, from the command enter U + F10 to unload BatManager.  To restore
  250.        BatManager, enter the command BATMAN from the command line.
  251.  
  252.        BatManager can be unloaded from within a batch file by including the
  253.        command $U in the batch file.  The program $U.EXE will restore the 
  254.        function keys to normal.  Likewise, BatManager can be reloaded from
  255.        the same batch file by including the command BATMAN in the batch file.
  256.  
  257.        Hopefully you will never need to use this option.  If you do, please
  258.        write to me and complain and I will try to resolve the conflict.
  259.  
  260.                                Chapter - 5
  261.      
  262.     Utilities Option.
  263.     
  264.     The Special Function - ALT + F10 will display the Utilities Menu. 
  265.     
  266.     NOTE: Most utility options may be accessed from the DOS command line
  267.           without invoking the Utilities Menu. 
  268.      
  269.       C - Change Sort Order.  The menu may be sorted three ways.  Try 
  270.           all three and select your preference.  From the DOS command
  271.           line, enter C + F10.
  272.     
  273.                    K.  By Function Key
  274.                    A.  Alpha Sort by Title
  275.                    B.  Alpha Sort by Title and by Function Key
  276.  
  277.       D - DOSKEY Compatability Mode.  See chapter - 4.
  278.           From the DOS command line, enter D + F10.
  279.      
  280.       F - Switch Screen Format.  Some users may prefer the alternate
  281.           screen format.  Try both formats and select your preference.
  282.           From the DOS command line, enter F + F10.
  283.  
  284.       I - Import a Batch File.  Previously written batch files may be
  285.           imported into the BatManager system without retyping.  After
  286.           selecting the Import option the system will prompt for the 
  287.           file name and corresponding function key for assignment.  From
  288.           the DOS command line, enter C + F10.
  289.          
  290.       K - The option, List Available Keys, will display the status of
  291.           each function key.  From the DOS command line, enter K + F10.
  292.      
  293.       M - Press M to switch between the Main Menu and the Alternate
  294.           Menu.  From the DOS command line, enter M + F10.
  295.  
  296.       R - Press R to enter your registration number.
  297.  
  298.       S - Swap Function Key Assignments.  You may switch two function 
  299.           key assignments.  From the DOS command line enter S + F10.
  300.  
  301.       U - Option U restores function keys to the original DOS state.
  302.           From the DOS command line, enter, U + F10.  (To return to the
  303.           menu enter BATMAN).
  304.      
  305.       H - Enter the Help Menu.  From DOS command line, enter H + F10.
  306.     
  307.       T - Tutorial.  From the DOS command line, enter T + F10.
  308.  
  309.           Note:  The tutorial may be modified by the user.
  310.                  It will then be a second Alternate Menu.
  311.  
  312.                                Chapter - 6
  313.  
  314.     Advanced Operation
  315.  
  316.     * Managing  "Non Menu"  Batch Files
  317.  
  318.     BatManager is more than a menu program.  It is a Batch File Manager.
  319.     By using the Special Function Keys you may create, modify, delete, and
  320.     compile batch files not assigned to function keys.
  321.  
  322.     Press the Add/Edit key - Shft+F10 - followed by a batch file name.  If
  323.     the batch file is in the \BM directory you may modify it.  If it is not
  324.     one will be created in the \BM directory.  
  325.  
  326.     Also, you may use the $Del function to delete batch files in the \BM
  327.     directory.  Press - Ctrl+F10 - followed by a batch file name you want
  328.     to delete.
  329.  
  330.     If you currently have batch files on your system, copy them into the 
  331.     \BM directory.  Once loaded into the \BM directory you may use Bat-
  332.     Manager to maintain them.
  333.  
  334.     Note: Program names reserved by BatManager:
  335.           BATMAN, RESORT, BAT-EDIT, BAT-LOAD, $M, $U, $I, U$M, M$M, D$M,
  336.           F$M, K$M, I$M, C$M, L$1
  337.  
  338.     Note to POWERBATCH users:  You will have to give your batch files a .BAT
  339.                                extension if you want BatManager to use them.
  340.  
  341.     * Passing parameters to batch files.
  342.  
  343.     Pressing a function key associated with a menu option launches the batch
  344.     file without allowing the user to enter command line parameters.  There
  345.     is one solution.  From the command line, type in the name of the batch file
  346.     and its parameters without pressing the function key.    
  347.  
  348.     By now you may have figured out the names of the batch files BatManager 
  349.     assigns to function keys.  All of the unshifted keys begin with an "!".
  350.     The second character is the number of the function key.  The shifted keys
  351.     begin with an "@".
  352.  
  353.     Therefore:  To enter parameters with menu option F5, type !5 p1 p2 p... at
  354.                 the command line.  For options shift F6, type @6 p1 p2 p... 
  355.                 You will have to press return.
  356.  
  357.                 Sorry, I am working on a better solution.    
  358.  
  359.                                Chapter - 7
  360.     
  361.     Registration Information
  362.      
  363.     This is a shareware product.  You are granted a 30-day trial license
  364.     to test BatManager. If you want to continue using BatManager please
  365.     register your copy.  
  366.  
  367.     Registered copies will bypass the 'delay' procedure.  Once registered
  368.     BatManager will stop asking you to register.
  369.     
  370.     You may distribute BatManager to others by giving them a diskette 
  371.     containing the single file BATMGR12.EXE.  The Utilities option: 'X'
  372.     will prepare a floppy disk for distribution.  When you distribute 
  373.     BATMGR12.EXE to friends include a copy of your favorite public domain
  374.     or shareware editor for them to try.
  375.  
  376.     Thank you for your support.
  377.     
  378.     TO REGISTER
  379.     
  380.        Single copy - single system  - US $20.00  +  3.00 (s/h)
  381.     
  382.        Add $5.00 for each additional system.  
  383.     
  384.     Send check or money order to:
  385.     
  386.        Tim Clingen
  387.        1017 Cheltenham Road
  388.        Santa Barbara CA 93105
  389.     
  390.        Phone orders:  (805) 682-5172
  391.        CompuServe [70062,1262]
  392.  
  393.                             Chapter - 8
  394.    Compiling Batch Files.   
  395.  
  396.    Currently three batch file compilers are supported by BatManager.  Other
  397.    compilers may be used.  Please contact me for updates and instructions.
  398.    ------------   ------------   ------------   ------------   ------------
  399.    * BAT2EXEC -- Is distributed by PC Mag.  The compiler converts batch 
  400.      files to .COM files.  The program may be found on bulletin boards.
  401.  
  402.    BatManager will invoke BAT2EXEC when the first line of the
  403.    batch file is a remark with the name of the compiler on it.
  404.  
  405.        example:     REM   BAT2EXEC
  406.  
  407.    Entering this line at the top of a batch file instructs BatManager 
  408.    to compile with BAT2EXEC.   BAT2EXEC.COM must be in the path or in the 
  409.    "\BM" directory.
  410.    ------------   ------------   ------------   ------------   ------------
  411.    * POWERBATCH  -- By Computing Systems Design, Inc.
  412.      Converts batch files to .EXE files.  Many 'non DOS' commands.
  413.    
  414.    BatManager will invoke POWERBATCH when the first line of the 
  415.    batch file is a remark with the name of the compiler on it.
  416.  
  417.       example:     ;   POWERBATCH
  418.                    ;   TITLE ?Power Batch Program #9
  419.  
  420.    The POWERBATCH files must be in the path.  Please note: BatManager requires
  421.    a file extension of .BAT (not .PWR).  You may have to rename or copy old
  422.    programs to interface with BatManager.
  423.    ------------   ------------   ------------   ------------   ------------
  424.    * BATCOM  -- is a batch file compiler published and supported by:
  425.  
  426.       Wenham Software Co.
  427.       5 Burley St.
  428.       Wenham, Ma. 01984  
  429.       (508) 774-7036
  430.  
  431.    Batcom produces .EXE files and includes a library of powerful commands.
  432.  
  433.    To use Batcom with BatManager you must.
  434.  
  435.       1.  Identify the path where Batcom.exe and Batcom.lib reside.
  436.  
  437.           example:   SET $BC=C:\BATCOM
  438.  
  439.           BatManager does NOT require Batcom to be in the DOS path.  
  440.           However, both BATCOM.EXE and BATCOM.LIB must be in the 
  441.           directory identified by the $BC environmental variable.
  442.  
  443.       2.  The first line of a BatManager batch file must be a remark
  444.           statement with the word BATCOM on the same line.
  445.  
  446.           example    REM BATCOM
  447.                      CLS
  448.                      REM TITLE?Compiled Program #9
  449.                      etc.
  450.  
  451.       3.  Batcom qualifiers must be on the same remark line.
  452.  
  453.           example    REM BATCOM /A /NL
  454.  
  455.    To reduce the number of files created by the compile process,  the object
  456.    file is written to the '\BM' directory and is named !!BATMAN.OBJ;  The map
  457.    file is written to the '\BATCOM' directory and is called !!BATMAN.MAP.
  458.    ------------   ------------   ------------   ------------   ------------
  459.    
  460.  
  461.  
  462.  
  463.  
  464.      Order Form
  465.    
  466.      BatManager 
  467.      Version 1.2                       
  468.      Copyright (c) 1991 Timothy Clingen
  469.      All Rights Reserved
  470.  
  471.  
  472.      Description             Quantity                         Price
  473.      -----------             --------                         -----
  474.  
  475.      BatManager program          1                   US    $  20.00
  476.  
  477.      Extra systems license     ____         @$5.00 each  = $ ______
  478.  
  479.      Shipping and handling                                 $   3.00
  480.  
  481.  
  482.                                                    Total   $ ______
  483.  
  484.  
  485.      Disk size      5 1/4 inch  _____
  486.  
  487.                     3 1/2 inch  _____
  488.  
  489.  
  490.      Make check payable to:    Timothy Clingen
  491.                                -----------------------
  492.                                1017 Cheltenham Rd
  493.                                Santa Barbara, CA 93105
  494. 
  495.