home *** CD-ROM | disk | FTP | other *** search
/ Power Utilities / Power Utilities.iso / utility / pro32 / mb.doc < prev    next >
Encoding:
Text File  |  1993-11-03  |  14.8 KB  |  285 lines
  1. Document for MicroMacroBat....................................................
  2.  
  3. MB.EXE is a program which when run with an argument on the command line, from
  4. either the DOS prompt or within a batch file, performs the operations specified
  5. by that argument.  For example, by typing or placing this line in a batch
  6. file or on the command line:
  7.  
  8. MB BOX/1/1/12/80/1/112
  9.  
  10. MicroMacroBat will perform the operation specified by the argument
  11. BOX/1/1/12/80/1/112. The argument tells MicroMacroBat to place a BOX with the
  12. upper left corner at row 1, column 1, the lower right corner at row 12,
  13. column 80, use the single line box character and make the color black on
  14. white.
  15.  
  16. MicroMacroBat can be a very handy extention to your batch file writing tools
  17. without having to learn a new batch-file-writing language or performing
  18. a compilation.
  19.  
  20. MB.EXE can be tucked away in your utilities directory with a "path" pointing
  21. to it.  MicroMacroBat calls may be intermixed with the batch file routines you
  22. normally use without any further consideration other than proper syntax usage.
  23.  
  24. MicroMacroBat will have many uses:
  25.  
  26. *             In your AUTOEXEC.BAT files.
  27. *             In distribution disc BAT files for hard drive installations.
  28. *             In BAT files for making file backups.
  29. *             In BAT files for demonstration programs and slide shows.
  30. *             For Shareware distributors GO files.
  31. *             BLOADable screen design.  See note 3 under REGISTRATION.
  32.  
  33. DEMO.BAT is a batch file which demonstrates some of the routines and contains
  34. some important remarks.
  35.  
  36. NOTE:  In order that MB can load and execute as quickly as possible, syntax
  37. .      and error checking are non-existent.  Make no errors and you will have
  38. .      no problems.
  39.  
  40. The ONLY legal argument separator is the "/".  DO NOT use anything else.
  41. Either upper or lower case text is acceptable.  Remember, each line is to
  42. be prefixed with MB, followed by a space and the argument, ie:
  43.  
  44. .                        MB BOX/1/1/12/80/1/31
  45.  
  46. The following is a list of supported arguments, their proper syntax and an
  47. explanation of what the operation does.
  48.  
  49.  
  50. BOX/BR/BC/ER/EC/CHARACTER/COLOR/C       Draws a box where BR is the beginning
  51. .                                       row, BC the beginning column, ER the
  52. .                                       ending row, EC the ending column where
  53. .                                       BR < ER, BC < EC and COLOR < 256.
  54. .                                       CHARACTER is either 1 or 2 indicating
  55. .                                       a single or double line box.  COLOR
  56. .                                       is a single value representing the
  57. .                                       foreground and background colors.  See
  58. .                                       the single color chart below.  The
  59. .                                       values for   BR,  BC,  ER  and  EC
  60. .                                       should be within the allowable limits
  61. .                                       as dictated by the lines/columns mode
  62. .                                       of your monitor.  Appending /C to the
  63. .                                       argument clears the inside of the box
  64. .                                       to the background color specified in
  65. .                                       the COLOR argument.
  66. .                           Example:    BOX/1/5/12/75/1/79 draws a single-line
  67. .                                       box with the upper left corner at row
  68. .                                       1, column 5, the lower right corner at
  69. .                                       row 12 column 75 in bright white on
  70. .                                       red and not cleared.
  71.  
  72. CLEARSCR/BR/BC/ER/EC/COLOR              Clears an area of the screen where BR,
  73. .                                       BC, ER, EC and COLOR have the meanings
  74. .                                       as described above.
  75. .                           Example:    CLEARSCR/1/5/12/75/31
  76.  
  77. BLOAD/FILENAME$                         BLOADS a file into video memory as
  78. .                                       the BASIC's BLOAD command.  The area
  79. .                                       of video memory the file is loaded into
  80. .                                       is automatically determined by the
  81. .                                       monitor in use.  This command is for
  82. .                                       "slide shows" of predetermined screen
  83. .                                       files made with Basic's BSAVE or a
  84. .                                       screen capture utility.
  85. .                           Example:    BLOAD/MAINMENU.SCR
  86.  
  87. FILLSCRN/BR/BC/ER/EC/COLOR/ASCII        Fills the screen with the character
  88. .                                       represented by the value ASCII.  BR,
  89. .                                       BC, ER, EC and COLOR are as previously
  90. .                                       described.
  91. .                           Example:    FILLSCRN/1/5/12/75/30/45 will fill the
  92. .                                       described area with dashes colored
  93. .                                       yellow on blue.
  94.  
  95. PAINT/BR/BC/ER/EC/COLOR                 Paints the screen without disturbing
  96. .                                       the existing text.
  97. .                           Example:    PAINT/1/5/12/75/7
  98.  
  99. OCPRINT/ROW/COLUMN/TEXT$/COLOR          Same as PRINT, below, except that
  100. .                                       printing takes place slowly; one
  101. .                                       character at a time, for effect.
  102.  
  103. PRINT/ROW/COLUMN/TEXT$/COLOR            Rapidly prints TEXT$ in COLOR at the
  104. .                                       ROW/COLUMN.  TEXT$ will be displayed
  105. .                                       exactly as entered, including quotes
  106. .                                       if used.  Extended ASCII characters
  107. .                                       may be displayed. The routine writes
  108. .                                       to video memory; no line feed issued.
  109. .                           Example:    PRINT/5/1/display these words/31
  110.  
  111. CURSOROFF                               Turns the cursor off.
  112.  
  113. CURSORON                                Turns the cursor on.
  114.  
  115. LOCATE/ROW/COLUMN                       Locates the cursor at ROW/COLUMN.
  116. .                                       Handy if you want to use the ECHO
  117. .                                       command.  Printing by DOS will begin
  118. .                                       at the cursor position.
  119. .                           Example:    LOCATE/1/1
  120.  
  121. WAIT                                    Suspends operation and waits for a
  122. .                                       keypress.
  123.  
  124. CHIME/WHICHONE                          Makes a chime-like tone.  WHICHONE
  125. .                                       must be in the range of 1 to 10.
  126. .                           Example:    CHIME/7
  127.  
  128. SLEEP/SECONDS                           Suspends operation until SECONDS
  129. .                                       seconds elapses.
  130. .                           Example:    SLEEP/4
  131.  
  132. STUFF/TEXT$                             Stuffs text into the keyboard buffer,
  133. .                                       appending an <ENTER> keypress.
  134. .                                       To simulate pressing <ENTER>, simply
  135. .                                       use STUFF without parameters.  TEXT$
  136. .                                       CANNOT be more than 15 characters.
  137. .                           Example:    STUFF/Y
  138.  
  139. USCROLL/BR/BC/ER/EC/TIMES               Provides for scrolling of a selected
  140. DSCROLL/BR/BC/ER/EC/TIMES               area of the screen, either Up, Down,
  141. LSCROLL/BR/BC/ER/EC/TIMES               Left or Right, TIMES times.
  142. RSCROLL/BR/BC/ER/EC/TIMES
  143. .                           Example:    LSCROLL/1/1/12/80/4
  144.  
  145. FADE/COLOR                              Provides for a screen disolve to COLOR.
  146. .                           Example:    FADE/64
  147.  
  148. BIG/TEXT/CHR/R/C/COLOR                  Prints large block text; 3 rows, 10
  149. .                                       columns in COLOR color with ASCII
  150. .                                       character CHR.
  151. .                           Example:    BIG/Hello there/219/1/1/31
  152.  
  153. RECOLOR/OLD/NEW                         Changes all instances of color OLD to
  154. .                                       color NEW.
  155. .                           Example:    RECOLOR/31/78
  156.  
  157. LIST/ROW/COLUMN/COLOR/X/word/word/....  Prints a vertical list of words (18max)
  158. .                                       starting at ROW, COLUMN in COLOR.
  159. .                                       There will be X rows between words.
  160. .                           Example:    LIST/12/1/31/1/Item 1/Item 2/Item 3
  161.  
  162.  
  163. VPRINT/ROW/COLUMN/TEXT/COLOR            Prints TEXT vertically in starting at
  164. .                                       ROW, COLUMN.  Do not print more text
  165. .                                       than there is room for.
  166. .                           Example:    VPRINT/1/1/HELLO THERE/2
  167.  
  168. CBUF                                    Clears the keyboard buffer.
  169.  
  170.  
  171.  
  172.  
  173. __________________________________OneColor Chart______________________________
  174.  
  175. .             ......................Background...........................
  176. .             Black   Blue   Green   Cyan   Red   Magenta   Brown   White
  177.  
  178. Foreground
  179. ..........
  180. Black          0      16      32     48     64      80      96      112
  181. Blue           1      17      33     49     65      81      97      113
  182. Green          2      18      34     50     66      82      98      114
  183. Cyan           3      19      35     51     67      83      99      115
  184. Red            4      20      36     51     67      83     100      116
  185. Magenta        5      21      37     52     68      84     101      117
  186. Brown          6      22      38     52     69      85     102      118
  187. White          7      23      39     53     70      86     103      119
  188. Gray           8      24      40     54     71      87     104      120
  189. Bright blue    9      25      41     55     72      88     105      121
  190. Bright green  10      26      42     56     73      89     106      122
  191. Bright cyan   11      27      43     57     74      90     107      123
  192. Bright red    12      28      44     58     75      91     108      124
  193. Bright Mag    13      29      45     59     76      92     109      125
  194. Bright Brown  14      30      46     60     77      93     110      126
  195. Bright White  15      31      47     61     78      94     111      127
  196.  
  197. For a blinking foreground, add 128 to the above values.
  198.  
  199.  
  200. REGISTRATION.................................................................
  201.  
  202. The $35 registration fee for this program will provide you with:
  203.  
  204. The MicroMacroBat program broken down into it's component parts.  vMB, uMB and
  205. dMB are the video, utility and display/printing controllers, respectively.
  206. Separate controllers load and execute faster, but the speed is partly offset
  207. by the additional disc seek time.  Also, you may only need, or have room for,
  208. one controller on a disc.  The breakdown is as follows:
  209.  
  210. ------------------------------------------------------------------------------
  211. .          vMB                     uMB                        dMB
  212. ------------------------------------------------------------------------------
  213. .        ClearScr                 Wait                       Big
  214. .        FillScrn                 Chime                      VPrint
  215. .        Paint                    Stuff                      BLoad
  216. .        CursorOn                 Sleep                      OCPrint
  217. .        CursorOff                CBuf                       RScroll
  218. .        Print                    Fade                       UScroll
  219. .        Recolor                  Locate                     DScroll
  220. .        Box                                                 LScroll
  221. .        List
  222.  
  223. You will also be provided with:
  224.  
  225. 1.      A handy card showing the proper syntax of each routine.
  226.  
  227. 2.      A collection of even smaller, individual control programs, each
  228. .         containing a SINGLE routine.  These will prove to be of value,
  229. .         especially if you need only one or two.  You may use these stand
  230. .         alones in your batch files or run them from the DOS command line.
  231. .         The single routines will not need the MB prefix, are called by
  232. .         name and will use the same syntax as required by MicroMacroBat.
  233.  
  234. 3.      Other routines which will have been developed since the release
  235. .          of this shareware program.  One of these will DEFINITELY be a
  236. .          routine to allow MicroMacroBat to be used as a screen design
  237. .          utility; use a batch file to call MB repeatedly until you like
  238. .          the design then, simply press ^F1 and the screen is saved as a
  239. .          BLOADable file.  Using a small batch file to put you in a loop
  240. .          with a text editor will allow you to completely design a screen
  241. .          in less than 15 minutes!  You can save screens prior to registering
  242. .          MicroMacroBat with one of the screen capture utilities available.
  243.  
  244. 4.      COMA PASSWORD, a command line routine which Blanks the screen, disables
  245. .          ^Break, ^C and then waits for a password to be input.  Reenables
  246. .          ^Break and ^C after the password is entered.  If /FUSS is appended
  247. .          to the command line and the WRONG password is entered, the machine
  248. .          generates assorted speaker noises and displays a warning screen for
  249. .          about 5 seconds then waits for the correct password.  If /LOCK is
  250. .          appended to the command line and the WRONG password is entered, a
  251. .          warning screen is displayed and the machine will lock up.
  252.  
  253. 5.      Possible inclusion of YOUR suggestions in the registered disc you
  254. .          recieive.
  255.  
  256. 6.      Placement on the update list.  You will automatically receive notices
  257. .          of program enhancements and have the opportunity to upgrade for a
  258. .          pittance.
  259.  
  260. Even if you do not wish to receive the separate controllers & other advantages
  261. of registration, you are still expected to register your continued use of
  262. MicroMacroBat.
  263.  
  264.  
  265. Send your $35 registration fee to:  Sitting Duck Software
  266. .                                   POBox 130
  267. .                                   Veneta, OR 97487
  268. .                                   (503) 935-3982
  269.  
  270. If you have suggestions for additional features, we are happy to consider
  271. them.
  272.  
  273.  
  274. SITE and DISTRIBUTION LICENSES................................................
  275.  
  276. Site licenses are available for MicroMacroBat.  In order to legally distribute
  277. MB.EXE with your products, distribution licenses are also available.  Because
  278. the execution speed of MicroMacroBat depends on the size of the MB.EXE file,
  279. licensees may ask that only the routines they require be included.  Contact
  280. us at the above address for details.
  281.  
  282. MicroMacroBat (c) 1989        Sitting Duck Software         All rights reserved
  283.  
  284.  
  285.