home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / newc_dev / billbrd.lha / bb.docs < prev    next >
Text File  |  1992-10-18  |  4KB  |  62 lines

  1.                               Billboard v2.0
  2.                      Copyright © 1992 Todd J. Petit
  3.  
  4.  
  5. WHAT IS BILLBOARD?
  6. Billboard (BB) is intended as a means to send messages to a computer user in a more attractive way than simply using the ECHO command. When BB is run it will open a gadget-less window in the center of your Workbench screen. This window can have one of three different graphic images in it and up to three lines of user-definable text. The three graphics are 1) the Commodore logo, 2) a "bored man", 3) an "announcer".
  7.  
  8. WHEN TO USE BILLBOARD
  9. If run without any arguments, BB will open with the Commodore logo and the words "Welcome to Amiga!". This is very similar to the "Welcome to Macintosh" window that Apple computers display upon bootup. It works nicely as the first command in your "user-startup" script.
  10.     When used with the "bored man" image, BB can be used to ask a user to "please wait" while a long program load or process is taken care of (if you launch your programs from the TOOL menu via a program such as TOOLMANAGER or ADDMENU, this works very well).
  11.     With the "announcer" graphic, BB can be used to inform the user of some event which has taken place in your script.
  12.  
  13. WHAT DO I NEED TO RUN BILLBOARD?
  14. An Amiga--and Workbench 2.0 would help. BB doesn't really use any 2.0-specific features, but its graphics are designed with the 2.0 color scheme in mind. If you are running 1.3 you still can use BB--it just won't look right with 1.3's default palette.
  15.  
  16. HOW DO I USE BILLBOARD?
  17. BB must be called from the CLI, or from within a script. Executing "BB ?" will bring up a usage template which supplies the information below, but in abbreviated form.
  18.     The following switches are available:
  19.  
  20.     -s[seconds]         specify the number of seconds to hold the BB window
  21.                            open (defaults to 5 seconds)
  22.     -i[image#]          image number 1 = Commodore logo
  23.                                      2 = "bored man"
  24.                                      3 = "announcer"
  25.     -p[program]         a program name. When this option is given the first
  26.                            line in the BB window is automatically set to 
  27.                            "Loading", the second line to your program name,
  28.                            and the third to "please wait...". This is used
  29.                            to best effect with image 2.
  30.     -1[string]          text to display on line 1 (overrides default of
  31.                            "Welcome").
  32.     -2[string]          text to display on line 2 (overrides default of
  33.                            "to").
  34.     -3[string]          text to display on line 3 (overrides default of
  35.                            "Amiga!").
  36.  
  37.     Note: if you wish to enclose spaces in a program name or text string,
  38.           you must enclose both the switch AND the text in double quotes
  39.           (e.g. "-pFinal Copy")
  40.  
  41.     Usage examples:
  42.  
  43.           bb
  44.             (Commodore logo and "Welcome to Amiga!" for five seconds.)
  45.  
  46.           bb -i2 -s10
  47.             ("Bored man" and "Welcome to Amiga!" for ten seconds.)
  48.  
  49.           bb -i2 -pWordPerfect
  50.             ("Bored man" and "Loading WordPerfect please wait..." for
  51.               five seconds.)
  52.          
  53.           bb -i3 "-1One moment" "-2while I sort" "-3your data..." -s20
  54.              ("Announcer" and "One moment while I sort your data..." for
  55.                twenty seconds.)
  56.  
  57. CAN I USE MY OWN GRAPHICS?
  58. Only if you can program in C. I am releasing the source code to BB with this distribution so that you can add your own custom images to BB. (As this is one of my first C-language programs, I do not offer it up as an example of how to code in C however!) If you chose to do this, please do not re-release BB as your own.
  59.  
  60. HOW CAN I CONTACT YOU?
  61. I prefer to be contacted via Internet (todd_petit@agwbbs.new-orleans.LA.US) but for those who don't have access to it, my snail-mail address is: 302 Alice St., Ama, LA 70031-2016.
  62.