home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / UT / UT099.ZIP / MB.DOC < prev    next >
Text File  |  1990-01-13  |  13KB  |  254 lines
  1. Document for MicroMacroBat....................................................
  2.  
  3. MB.EXE is a program that, 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:
  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.  
  32. DEMO.BAT is a batch file which demonstrates some of the routines.
  33.  
  34. NOTE:  In order that MB can load and execute as quickly as possible, syntax
  35. .      and error checking is non-existent.  Make no errors and you will have
  36. .      no problems (remember GIGO?).
  37.  
  38. The ONLY legal argument separator is the "/".  DO NOT use anything else.
  39. Either upper or lower case text is acceptable.  Remember, each argument is to
  40. be prefixed with MB, followed by a space and the argument, ie:
  41.  
  42. .                        MB BOX/1/1/12/80/1/31
  43.  
  44. The following is a list of supported arguments, their proper syntax and an
  45. explanation of what the operation does.
  46.  
  47.  
  48. BOX/BR/BC/ER/EC/CHARACTER/COLOR         Draws a box where BR is the beginning
  49. .                                       row, BC the beginning column, ER the
  50. .                                       ending row, EC the ending column where
  51. .                                       BR < ER, BC < EC and COLOR < 256.
  52. .                                       CHARACTER is either 1 or 2 indicating
  53. .                                       a single or double line box.  COLOR
  54. .                                       is a single value representing the
  55. .                                       foreground and background colors.  See
  56. .                                       the single color chart below.  The
  57. .                                       values for   BR,  BC,  ER  and  EC
  58. .                                       should be within the allowable limits
  59. .                                       as dictated by the lines/columns mode
  60. .                                       of your monitor.
  61. .                           Example:    BOX/1/5/12/75/1/79 draws a single-line
  62. .                                       box with the upper left corner at row
  63. .                                       1, column 5, the lower right corner at
  64. .                                       row 12 column 75 in bright white on
  65. .                                       red.
  66.  
  67. CLEARSCR/BR/BC/ER/EC/COLOR/C            Clears the screen where BR, BC, ER, EC
  68. .                                       and COLOR have the meanings described
  69. .                                       above.  Appending /C to the COLOR
  70. .                                       argument clears the inside of the box
  71. .                                       to the background color specified in
  72. .                                       the COLOR argument.
  73. .                           Example:    CLEARSCR/1/5/12/75/31/C
  74.  
  75. BLOAD/FILENAME$                         BLOADS a file into video memory like
  76. .                                       the BASIC's BLOAD command.  The area
  77. .                                       of video memory the file is loaded into
  78. .                                       is automatically determined by the
  79. .                                       monitor in use.  This command is for
  80. .                                       "slide shows" of predetermined screen
  81. .                                       files made with Basic's BSAVE or a
  82. .                                       screen capture utility.
  83. .                           Example:    BLOAD/MAINMENU.SCR
  84.  
  85. FILLSCRN/BR/BC/ER/EC/COLOR/ASCII        Fills the screen with the character
  86. .                                       represented by the value ASCII.  BR,
  87. .                                       BC, ER, EC and COLOR are as previously
  88. .                                       described.
  89. .                           Example:    FILLSCRN/1/5/12/75/30/45
  90.  
  91. PAINT/BR/BC/ER/EC/COLOR                 Paints the screen without disturbing
  92. .                                       the existing text.
  93. .                           Example:    PAINT/1/5/12/75/7
  94.  
  95. OCPRINT/ROW/COLUMN/TEXT$/COLOR          Same as PRINT, below, except that
  96. .                                       printing takes place slowly; one
  97. .                                       character at a time.
  98.  
  99. PRINT/ROW/COLUMN/TEXT$/COLOR            Rapidly prints TEXT$ in COLOR at the
  100. .                                       ROW/COLUMN.  TEXT$ will be displayed
  101. .                                       exactly as entered, including quotes
  102. .                                       if used.  Extended ASCII characters
  103. .                                       may be displayed. The routine writes
  104. .                                       to video memory; no line feed issued.
  105. .                           Example:    PRINT/5/1/display these words/31
  106.  
  107. CURSOROFF                               Turns the cursor off.
  108.  
  109. CURSORON                                Turns the cursor on.
  110.  
  111. LOCATE/ROW/COLUMN                       Locates the cursor at ROW/COLUMN.
  112. .                                       Handy if you want to use the ECHO
  113. .                                       command.
  114. .                           Example:    LOCATE/1/1
  115.  
  116. WAIT                                    Suspends operation and waits for a
  117. .                                       keypress.
  118.  
  119. CHIME/WHICHONE                          Makes a chime-like tone.  WHICHONE
  120. .                                       must be in the range of 1 to 10.
  121. .                           Example:    CHIME/7
  122.  
  123. SLEEP/SECONDS                           Suspends operation until SECONDS
  124. .                                       seconds elapses.
  125. .                           Example:    SLEEP/4
  126.  
  127. USCROLL/BR/BC/ER/EC/TIMES               Provides for scrolling of a selected
  128. DSCROLL/BR/BC/ER/EC/TIMES               area of the screen, either Up, Down,
  129. LSCROLL/BR/BC/ER/EC/TIMES               Left or Right, TIMES times.
  130. RSCROLL/BR/BC/ER/EC/TIMES
  131. .                           Example:    LSCROLL/1/1/12/80/4
  132.  
  133. FADE/COLOR                              Provides for a screen disolve to COLOR.
  134. .                           Example:    FADE/64
  135.  
  136. BIG/TEXT/CHR/R/C/COLOR                  Prints large block text; 3 rows, 10
  137. .                                       columns in COLOR color with ASCII
  138. .                                       character CHR.
  139. .                           Example:    BIG/Hello there/219/1/1/31
  140.  
  141. RECOLOR/OLD/NEW                         Changes all instances of color OLD to
  142. .                                       color NEW, on the screen.
  143. .                           Example:    RECOLOR/31/78
  144.  
  145. LIST/ROW/COLUMN/COLOR/X/word/word/....  Prints a vertical list of words (20max)
  146. .                                       starting at ROW, COLUMN in COLOR.
  147. .                                       There will be X rows between words.
  148. .                           Example:    LIST/12/1/31/1/Item 1/Item 2/Item 3
  149.  
  150.  
  151. VPRINT/ROW/COLUMN/TEXT/COLOR            Prints TEXT vertically in starting at
  152. .                                       ROW, COLUMN.  Do not print more text
  153. .                                       than there is room for.
  154. .                           Example:    VPRINT/1/1/HELLO THERE/2
  155.  
  156. CBUF                                    Clears the keyboard buffer.
  157.  
  158.  
  159.  
  160.  
  161. __________________________________OneColor Chart______________________________
  162.  
  163. .             ......................Background...........................
  164. .             Black   Blue   Green   Cyan   Red   Magenta   Brown   White
  165.  
  166. Foreground
  167. ..........
  168. Black          0      16      32     48     64      80      96      112
  169. Blue           1      17      33     49     65      81      97      113
  170. Green          2      18      34     50     66      82      98      114
  171. Cyan           3      19      35     51     67      83      99      115
  172. Red            4      20      36     51     67      83     100      116
  173. Magenta        5      21      37     52     68      84     101      117
  174. Brown          6      22      38     52     69      85     102      118
  175. White          7      23      39     53     70      86     103      119
  176. Gray           8      24      40     54     71      87     104      120
  177. Bright blue    9      25      41     55     72      88     105      121
  178. Bright green  10      26      42     56     73      89     106      122
  179. Bright cyan   11      27      43     57     74      90     107      123
  180. Bright red    12      28      44     58     75      91     108      124
  181. Bright Mag    13      29      45     59     76      92     109      125
  182. Bright Brown  14      30      46     60     77      93     110      126
  183. Bright White  15      31      47     61     78      94     111      127
  184.  
  185. For a blinking foreground, add 128 to the above values.
  186.  
  187.  
  188. REGISTRATION.................................................................
  189.  
  190. A $30 registration fee for this program will provide you with the MicroMacroBat
  191. program broken down into it's component parts.  vMB, uMB and dMB are the video,
  192. utility and display/printing controllers, respectively.  Separate controllers
  193. load and execute faster, but the speed is partly offset by the additional disc
  194. seek time.  Also, you may only need, or have room for, one controller on a
  195. disc.  The breakdown is as follows:
  196.  
  197. ------------------------------------------------------------------------------
  198. .          vMB                     uMB                        dMB
  199. ------------------------------------------------------------------------------
  200. .        ClearScr                 Wait                       Big
  201. .        FillScrn                 Chime                      VPrint
  202. .        Paint                    Locate                     BLoad
  203. .        CursorOn                 Sleep                      OCPrint
  204. .        CursorOff                CBuf                       RScroll
  205. .        Print                    Fade                       UScroll
  206. .        Recolor                  Locate                     DScroll
  207. .        Box                                                 LScroll
  208. .        List                           
  209.  
  210. You will also be provided with:
  211.  
  212. >       A manual.
  213. .
  214. >       A collection of even smaller, individual control programs, each
  215. .         containing a SINGLE routine.  These will prove to be of value,
  216. .         especially if you need only one or two.  You may use these stand
  217. .         alones in your batch files or run them from the DOS command line.
  218. .         The single routines do not need the MB prefix; they are called by
  219. .         name.
  220.  
  221. >       Other routines which will have been developed since the release of
  222. .          this shareware program.
  223.  
  224. >       Possible inclusion of YOUR suggestions in the registered disc you
  225. .          recieive.
  226.  
  227. >       Placement on the update list.  You will automatically receive notices
  228. .          of program enhancements and have the opportunity to upgrade for a
  229. .          pittance.
  230.  
  231. >       A text editor designed especially for writing batch files.  Say
  232. .          good-bye to EDLIN (if you ever use it).
  233.  
  234. Even if you do not wish to receive the separate controllers & other advantages
  235. of registration, you are still expected to register your use of MicroMacroBat.
  236.  
  237.  
  238. Send your $30 registration fee to:  Sitting Duck Software
  239. .                                   POBox 130
  240. .                                   Veneta, OR 97487
  241. .                                   (503) 935-3982
  242.  
  243. If you have suggestions for additional features, please submit them.
  244.  
  245.  
  246. SITE and DISTRIBUTION LICENSES................................................
  247.  
  248. Site licenses are available for MicroMacroBat.  In order to legally distribute
  249. MB.EXE with your products, distribution licenses are also available.
  250.  
  251. MicroMacroBat         (c)1989 Sitting Duck Software        All rights reserved
  252.  
  253.  
  254.