home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / batch / batbox26.zip / BATBOX.DOC < prev    next >
Text File  |  1992-04-08  |  17KB  |  428 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.         
  8.                             
  9.                             
  10.                             
  11.                             
  12.                             
  13.                             
  14.                             
  15.                             
  16.                             
  17.                             
  18.                             
  19.                             
  20.                             
  21.                             
  22.                             
  23.                             
  24.                             STEENBURGH'S STUFF
  25.                           Mildly Useful Utilities
  26.                               For Batch Files
  27.                                 Version 2.0
  28.           Copyright 1991,1992 by Chuck Steenburgh and Tay-Jee Software
  29.         
  30.                             _______
  31.                        ____|__     |               (TM)
  32.                     --|       |    |-------------------
  33.                       |   ____|__  |  Association of
  34.                       |  |       |_|  Shareware
  35.                       |__|   o   |    Professionals
  36.                     -----|   |   |---------------------
  37.                          |___|___|    MEMBER
  38.         
  39.         
  40.         
  41.         
  42.         
  43.         
  44.         
  45.         
  46.         
  47.         
  48.         
  49.         
  50.         
  51.         
  52.         
  53.         
  54.         
  55.         
  56.         
  57.         
  58.         
  59.         
  60.         
  61.  
  62.                                      Page 1
  63.  
  64.  
  65.  
  66.  
  67.  
  68.         BATBOX.EXE 2.6                                                  |
  69.         Copyright 1991 by Chuck Steenburgh and Tay-Jee Software
  70.         
  71.            People have been creating menus with batch files for
  72.         years.  Some of these are quite elaborate, others very crude.
  73.         BATBOX is something in between.  BATBOX will allow you to
  74.         display an attractive, colorful menu and will wait for
  75.         the user to make a selection.  It will then set an appro-
  76.         priate ERRORLEVEL value which can be used to determine sub-
  77.         sequent actions in your batch file.
  78.         
  79.         Usage:       BATBOX  menufile [/C] [/Dn] [/Tn] [/Wn] [/H]       |
  80.                              [/O] [/Q] [/Pn]                            |
  81.         
  82.                   menufile        is the name of an ASCII text 
  83.                                   file which you create.  This
  84.                                   will contain the menu's title
  85.                                   and a list of options.
  86.                                   
  87.                   /C              Normally, the longest menu item  
  88.                                   is centered in the menu box and  
  89.                                   subsequent items are left-aligned
  90.                                   below it.  This switch will cause
  91.                                   each menu item to be centered in 
  92.                                   the menu box.
  93.                   
  94.                   /Dn             Date format.  Current valid values    
  95.                                   for n are:                            
  96.                                   
  97.                                        1   European style (YY.MM.DD)    
  98.                                        2   Short month (DD Mmm YY)      
  99.                                        3   Weekday (Www MM DD)          
  100.                                        -   Turn off date display        
  101.                                   
  102.                   /Tn             Time format.  Valid values for n are: 
  103.                   
  104.                                        1   Display time using 12-hour   
  105.                                            clock with AM/PM             
  106.                                        2   24-hour clock, no seconds    
  107.                                        3   12-hour clock, no seconds    
  108.                   
  109.                   /Wn             Exit menu if no keys are pressed with-|
  110.                                   in n seconds and return errorlevel of |
  111.                                   255.                                  |
  112.                   
  113.                   /H              Generates help screen.
  114.         
  115.                   /O              Ordinal menu selection.  Instead
  116.                                   of returning an errorlevel based
  117.                                   on the hotkey, returns an error-
  118.                                   level based on the ordinal pos- 
  119.                                   ition of the selected menu item.
  120.                                   
  121.                   /Q              Quiet mode suppresses all sounds.
  122.  
  123.                                      Page 2
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                   
  130.                   /Pn             Select predefined color palettes:     |
  131.                                        1 - Ice Blue                     |
  132.                                        2 - Fire Red                     |
  133.                                        3 - Pastel                       |
  134.                                        4 - Monochrome                   |
  135.                   
  136.            To create a menufile, use a text editor, word processor that 
  137.         can save ASCII files, or EDLIN.COM or EDIT.COM that come with 
  138.         DOS.  In a pinch, you can use the "copy con" command but this 
  139.         doesn't give you much in the way of an editing capability.
  140.         
  141.            The structure of the menufile is simple.  The first line
  142.         contains your menu's title, up to 60 characters.  If you
  143.         don't want a title, leave the line blank, without any spaces.
  144.         (Hint:  press RETURN immediately without doing anything else 
  145.         when you first begin editing your document.)  Each succes-
  146.         sive line contains a menu item, exactly as you want it to ap-
  147.         pear on the screen.  Do NOT include any blank lines here or 
  148.         you will end up with blank lines in your menu!
  149.         
  150.            A few limitations:  each line can contain no more than 60
  151.         characters (if you need more than this to describe your menu
  152.         choices, maybe you need Microsoft Windows, a Macintosh, or 
  153.         something else with lots of pictures!).  In addition, your menu
  154.         items (but NOT the menu title) should each begin with a dis-
  155.         tinct letter in order for the selection function to work pro-
  156.         perly.  The selection function for BATBOX is case-insensitive,
  157.         so if you begin one line with the letter 's' and the other
  158.         with the letter 'S', these are considered the same.  Up to
  159.         10 menu items are permitted in any one file.  
  160.         
  161.           When you type BATBOX on the command line followed by the
  162.         name of your menufile (they must both be in the current dir-
  163.         ectory), you will see a menu pop up in the middle of the
  164.         screen.  The title will appear at the top, with each of your
  165.         menu items (up to ten) appearing at double spaced-intervals
  166.         inside the menu box.  Each item will also be numbered from 1  
  167.         to 0 (the 10th item being numbered "0").  At the bottom of the
  168.         menu you will see a the message "Enter your menu choice: ".  
  169.         If you have a color monitor, you will notice that the first 
  170.         letter (the "hotkey") of each menu item appears in a different
  171.         color than the rest of the text.  The time and date will also 
  172.         be displayed at the top of the menu.                          
  173.         
  174.            There are now three separate methods of selecting a menu    
  175.         item.  The first is by pressing the hotkey described above.    
  176.         The second is by pressing the item number displayed to the left
  177.         of each menu item (1-0, with 0 representing item 10).  The     
  178.         third method, new since Version 2.5, is by positioning the cur-
  179.         sor bar over the appropriate menu item and pressing ENTER.  Use
  180.         the up/down cursor arrow keys to move the bar up and down.  You
  181.         may also use the PgUp key to position the bar over the first   
  182.         menu item and the PgDn key to position it over the last menu   
  183.  
  184.                                      Page 3
  185.  
  186.  
  187.  
  188.  
  189.  
  190.         item.  PRESSING ANY OTHER KEY will produce an error tone (un-  
  191.         less the /Q switch is specified) but otehrwise do nothing.     
  192.         
  193.            After selecting a menu item in one of the ways above, BATBOX
  194.         will then exit, and return an errorlevel based on the hotkey.  
  195.         See Appendix 1 for a list of legal first letters and the error-
  196.         levels that are returned by BATBOX.  If you select the /O op- 
  197.         tion, BATBOX will return the position of the selected menu item
  198.         via the errorlevel.  For example, if you select the 1st item on
  199.         the list and have specified /O, the errorlevel will be set to  
  200.         1.  If you select the 5th item, the errorlevel will be 5, and  
  201.         so on.  You can use the errorlevel value that is returned to   
  202.         branch to different parts of your batch file or to execute 
  203.         commands.  See the DEMO.BAT file for an example of one way to 
  204.         do this. (DEMO.BAT is part of the STUF??.ZIP archive which     
  205.         contains demonstration files for all of the STEENBURGH'S STUFF 
  206.         utilities).                                                    
  207.         
  208.            The errorlevel that is returned is affected only by the /O  
  209.         switch, and NOT by whether the item is selected via the hotkey,
  210.         the item number, or the cursor bar.                             
  211.         
  212.            If you enter BATBOX alone on the command line without any
  213.         parameters, the help screen will be displayed.
  214.         
  215.         Customizing Colors
  216.         
  217.         Beginning with version 2.1, BATBOX users can customize their
  218.         menu's colors by using a small text file called BATBOX.CFG.
  219.         Using the color codes from Appendix 3 of STEENBURGH'S STUFF
  220.         documentation, enter a color value into a text file for the
  221.         following items, one entry per line:
  222.         
  223.              Line #       Controls       Valid Values
  224.              ======       ========       ============
  225.                1       Menu color            1-127
  226.                2       Menu border type      1-4
  227.                3       Menu shadow pattern   1-3
  228.                4       Menu title color      1-255
  229.                5       Menu interior color   1-127
  230.                6       Menu item color       1-255
  231.                7       Hot key color         1-255
  232.                8       Cursor bar color      1-255
  233.                9       Prompt message color  1-255
  234.               10       Date/time color       1-255
  235.         
  236.         See the enclosed file BATBOX.CFG for an example.  The 5 pre-    |
  237.         defined color palettes (one default and four selectable with    |
  238.         the /P switch) are shown below.                                 |
  239.         
  240.                          PREDEFINED COLOR PALETTES                      |
  241.         
  242.                        0         1         2         3         4        |
  243.                      =====     =====     =====     =====     =====      |
  244.  
  245.                                      Page 4
  246.  
  247.  
  248.  
  249.  
  250.  
  251.         Menu color     79        27        78        53       112       | 
  252.         Menu border     2         1         1         1         1       |
  253.         Menu shadow     2         3         2         3         2       |
  254.         Menu title     79        27       116        95        14       |
  255.         Menu interior  31        27        64        48         0       |
  256.         Menu item      79        27       116        53         7       |
  257.         Hot key        30        31        79        63        14       |
  258.         Cursor bar     14        49        78        95       112       |
  259.         Prompts        31        27       116        61         7       |
  260.         Date/time     113        27       124        53         7       |
  261.         
  262.         
  263.         OMBUDSMAN
  264.         
  265.           This program is produced by a member of the Association of
  266.         Shareware Professionals (ASP).  ASP wants to make sure that
  267.         the shareware principle works for you.  If you are unable to
  268.         resolve a shareware-related problem with an ASP member by
  269.         contacting the member directly, ASP may be able to help.  The
  270.         ASP Ombudsman can help you resolve a dispute or problem with
  271.         an ASP member, but does not provide technical support for 
  272.         members' products.  Please write to the ASP Ombudsman at 545
  273.         Grover Road, Muskegon, MI 49442 or send a CompuServe message
  274.         via CompuServe Mail to ASP Ombudsman, 70007,3536.
  275.         
  276.         
  277.         DISCLAIMER
  278.         
  279.            The programs described in this documentation are guaran-
  280.         teed to do absolutely nothing!  They have, however, in my exper-
  281.         ience performed essentially as described herein.  The author
  282.         will not be responsible for any loss or damages caused through
  283.         the use of these programs.  No warranty, express or implied,
  284.         is provided for this software's performance, merchantability,
  285.         or fitness for a particular purpose.
  286.         
  287.            All trademarks are property of their respective owners.
  288.         
  289.            The programs and documentation are Copyright 1991,1992 by 
  290.         Chuck Steenburgh.  You are encouraged to distribute these pro-
  291.         grams provided the following conditions are met:
  292.         
  293.            - all files contained in the archive or distribution disk
  294.              must be distributed together in UNMODIFIED form
  295.         
  296.            - you charge no more than a reasonable fee for copying or
  297.              subscription, and clearly indicate that payment of such
  298.              a fee does NOT grant ownership of the programs.
  299.         
  300.            This program is part of set of utilities known as STEEN-
  301.         BURGH'S STUFF (Mildly Useful Utilities).  The full set of
  302.         utilities includes the following programs:
  303.         
  304.              BATBOX:     Simple menu creation/input system
  305.  
  306.                                      Page 5
  307.  
  308.  
  309.  
  310.  
  311.  
  312.              CHKPRN:     Checks parallel printer status
  313.              CLK:        Displays time on screen
  314.              CURSOR:     Change cursor shape
  315.              DOSVER:     Checks for DOS version currently running
  316.              INPUT:      Simple prompt/input system
  317.              KLS:        Colorful screen-clearing utility
  318.              LAUNCHER:   File selection/execution system
  319.              MUSIC:      Plays transcribed sheet music on the PC
  320.              RAND:       Random number generator
  321.              SKIP:       Prints blank lines from batch files
  322.              SOUNDER:    Wide range of noise making options
  323.              SPACE:      File/disk space reporting utility
  324.              WAITFOR:    Timed pauses 
  325.              WHENISIT:   Date/time telling utility
  326.              WRITE:      Colorful output anywhere on screen
  327.              XD:         Create/switch directories at the same time
  328.         
  329.            You may evaluate these programs for up to 30 days on a free
  330.         trial basis.  After 30 days, you should register your use of
  331.         these programs.  The registration fee is $20, payable to the
  332.         author at the address given below.  For those registering
  333.         directly with Tay-Jee Software, we offer a $5 cash discount.
  334.         
  335.            Let's be real: I don't plan to make alot of money this way.
  336.         Registration does have its advantages:
  337.         
  338.            - I am improving these programs all the time.  Registration
  339.              will get you IMMEDIATELY a disk with the latest version.
  340.              You will also get the next major release of the program set
  341.              sent to you free of charge.
  342.         
  343.            - While I can't promise to include everyone's suggestions
  344.              in program updates, you can bet I'll listen to registered
  345.              users before any of you scrounges out there.
  346.         
  347.            - You will make me feel all warm and fuzzy and appreciated, 
  348.              and all that good stuff.
  349.         
  350.            - You will also get an evaluation copy of my text-file for-
  351.              matting program (used to produce the margins in this doc-
  352.              ument), and any other electronic creations I have decided
  353.              to unleash on a foolish, unsuspecting world.
  354.         
  355.            Send comments/registrations to:
  356.         
  357.                 Tay-Jee Software
  358.                 Post Office Box 835
  359.                 Lexington, VA 24450
  360.                 (703)464-5290
  361.                 
  362.                 !!!VIRGINIA RESIDENTS ADD 4.5SALES TAX!!!
  363.         
  364.                 CIS 72330,1776 (I haunt the IBMSYS and IBMPRO forums)
  365.         
  366.  
  367.                                      Page 6
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.                                      Page 7