Amiga Format CD 13/amigaformatcd13.iso/-seriously_amiga-/shareware/misc/bootbar/bootbar.guide

Amigaguide Document | 1997-03-07 | 7KB | 153 lines

@database "BootBar"
@$VER: BootBar.guide 1.0 (1997-02-17)
@(C) MagerValp 1997
@author MagerValp
@remark -------------------------------------------------------------------
@remark -----------Hello there. Can you find the easter eggs?--------------
@remark -------------------------------------------------------------------
@node main "Guide to BootBar"
            @{b}BootBar@{ub}
    @{" Legal mush " link license}
    @{" Overview " link overview}
    @{" Requirements " link requirements}
    @{" Installation " link installation}
    @{" Usage " link usage}
    @{" Known bugs " link bugs}
    @{" Program history " link history}
    @{" The next version " link future}
    @{" Author's address " link address}
@{i}Please note:
  This is a beta release, so there are no guarantees that the program
  will work on your computer. There is also no easy way of installing
  and configuring the program, but I hope that doesn't scare you off.@{ui}
@endnode
@remark -------------------------------------------------------------------
@node license "License"
This program, and all the files in the archive are copyright Per Olofsson.
The program may be spread freely, as long as no profit is made and no
changes are made to the distribution.
@endnode
@remark -------------------------------------------------------------------
@node overview "Overview"
As I got bored of my static boot picture I decided to implement a version
of the Macintosh bootscreen. BootBar displays a picture while booting,
together with a progressbar. You can also get icons to pop up on the
screen. Sounds more fun than that boring old boot picture, doesn't it?
@endnode
@remark -------------------------------------------------------------------
@node requirements "Requirements"
The program currently works (or should work) with OS 3.0 or better. I
follow all the rules and guidelines in the Amiga autodocs, so basically,
there shouldn't be a problem. Heh.
The program could be made into working with OS 2 as well, if there is
enough interest to motivate the work. @{"Mail me if you want me to." link address}
@endnode
@remark -------------------------------------------------------------------
@node installation "Installation"
Move the files "BootBar", "SetBar" and "BootIcon" to a convenient place,
such as C:, where the programs can be found during startup.
Doubleclicking on "Click to install" moves the three programs to C:.
@endnode
@remark -------------------------------------------------------------------
@node bugs "Known bugs"
 Colour remapping of icons is not implemented.
      (got a good colour matching routine? @{"Mail me" link address})
 Automatic placing of icons is not implemented.
 The screen flickers when the workbench screen is opened.
      (how do I get the screen to stay on top? @{"Mail me" link address})
 Dirty interprocess communication. Should use message ports.
@endnode
@remark -------------------------------------------------------------------
@node history "Program history"
  Version 1.0
    First public release
@endnode
@remark -------------------------------------------------------------------
@node future "Coming up"
Use message ports for interprocess communication.
Easy to use installation and configuration programs.
Automatic timing of the startup to get a smoothly moving progressbar.
@endnode
@remark -------------------------------------------------------------------
@node address "Addresses"
If you would like to contact me, please email @{u}[e-mail]@{uu}.
@endnode
@remark -------------------------------------------------------------------
@remark -------------------------------------------------------------------
@remark -------------------------------------------------------------------
@node usage "Usage"
BootBar is split into three programs which are used in the startup-
sequence. BootBar is the main program, which is started in the beginning.
Throughout the startup-sequence SetBar is used to update the progressbar,
and BootIcon is used to display icons on the BootBar screen. Pretty basic.
  @{" BootBar " link bootbarusage}
  @{" SetBar " link setbarusage}
  @{" BootIcon " link booticonusage}
@endnode
@remark -------------------------------------------------------------------
@node bootbarusage "BootBar"
BootBar is the main program. It starts by opening up the bootscreen and
then it sits back, waiting for SetBar or BootIcon to call it.
  FORMAT:    BootBar [SW=<screenwidth>] [SH=<screenheight>] [SD=<depth>]
        [SM=<screenmode>] [X=<xpos>] [Y=<ypos>] [W=<width>]
        [H=<height>] [MODE=<barmode>] [BG=<picture>]
        [BACKFILL=<pen>] [PEN=<pen>] [HILIT=<pen>] [SHADE=<pen>]
        [QUIT] [NOCLEAR]
  TEMPLATE:    SW/K/N,SH/K/N,SD/K/N,SM/K/N,X/K/N,Y/K/N,W/K/N,H/K/N,MODE/K,
        BG/K,BACKFILL/K/N,PEN/K/N,HILIT/K/N,SHADE/K/N,QUIT/S,
        NOCLEAR/S
  BG=<picture>
    Load <picture> as the background image. It must be an IFF-ILBM
    picture in 1-256 colours, in a screenmode that your computer can
    display.
  SW=<screenwidth>, SH=<screenheight>, SD=<depth>
    If no picture is loaded SW, SH and SD controls the dimensions of the
    blank screen that is opened.
  SM=<screenmode>
    Open the screen using this screenmode, where screenmode is a
    32-bit hexadecimal value. This can also be used to override the
    screenmode found in the backgound picture.
  X=<xpos>,Y=<ypos>,W=<width>,H=<height>
    This sets the position and size of the progressbar.
  MODE=<barmode>
    This controls how the progressbar is drawn. Can be one of "flat",
    "embossed" (default) and "recessed".
  BACKFILL=<pen>,PEN=<pen>,HILIT=<pen>,SHADE=<pen>
    This determines which pen will be used to draw the different parts
    of the progressbar. BACKFILL is the colour used to clear the area
    under the bar. PEN is the main colour. HILIT is the colour used to
    produce the highlight, and SHADE is the colour used to produce the
    shadow.
  NOCLEAR
    If set, the unused areas of the progressbar will not be cleared
    when redrawn. Use it if the bar appears on top of drawn graphics
    and you aren't planning to make the bar go backwards.
  QUIT
    Tell BootBar to close its screen and quit. Put "BootBar QUIT" at
    the end of your startup-sequence.
@endnode
@remark -------------------------------------------------------------------
@node setbarusage "SetBar"
SetBar controls the progressbar.
  FORMAT:    SetBar <value>
  TEMPLATE:    VALUE/A/N
<value>
    A number between 0 and 100. 0 is an empty bar, and 100 is a full
    bar.
@endnode
@remark -------------------------------------------------------------------
@node booticonusage "BootIcon"
BootIcon displays an icon on the bootscreen.
  FORMAT:    BootIcon <picture> [<xpos>] [<ypos>] [REMAP]
  TEMPLATE:    ICONFILE/A,X/N,Y/N,REMAP/S
<picture>
    The name of an IFF-ILBM file to display.
<xpos>,<ypos>
    The coordinates at which the picture should be displayed. If no
    values are given, the next "logical" position is used. @{i}See
    @{"Known bugs" link bugs}@{ui}.
@endnode
@remark -------------------------------------------------------------------
@remark --------------------Well, that's it. EOF.--------------------------
@remark -------------------------------------------------------------------