Update information for Rainbow v0.61 released on 30 October 1994
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

* Added support to use  Include <name of cfg file>

Short readme file for RAINBOW.EXE/TTP  v0.60 released on 03 Sep 1994
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

Rainbow is a small menu view programm usable for the Octopus Bulletin Board
System written by me (Koos Kuil) which runs on all Atari computers they are
available on this moment.

The EXE version runs only on PC's with ANSI.SYS loaded (i use this driver
because it's much easyer to programm a portable version of Rainbow) and it
runs in Mono and Color modes.

Rainbow will use the OCTOPUS environment path when available, use on Atari
computers the small CPX module (ENV.CPX) or using SET OCTOPUS=... on PC
compatibles.   All menu files are searched default into the Octopus MenuPath
and not in the startup directory.

A good idea is to place RAINBOW.TTP somewhere on your desktop, you can drag a
menu file on the Rainbow icon and you'll see the menu you want to see.

If the OCTOPUS enviroment is available, it's not needed to add the full
pathname for menus, only   RAINBOW FILEMENU  is enough!

This version of Rainbow is full compatible with all menu macros used in menus
created for use with Octopus and also left/right outlined and trim support
is added (like the statistics files in MAF v1.34).   To use Rainbow some
commandline arguments are required and some of them are optional.

Also new in this version is that you can use a user name for easy checking
on menu rights and options.  Just try it out!

 Usage of Rainbow...

 RAINBOW [-<privilege>] [-<emulation>] [-k<key>] [-u<name>] [-<delay>]
         <menu name>

 RAINBOW -ansicolor -5 -k2 -uDirk_de_Vos -sysop welcome.v52
                             ^^^^^^^^^^^
 NOTE: Underscores are required for full names in case of spaces, another
       example is RAINBOW -uKoos_Kuil hmenu

       Some values can be different if you use the same userfile on Atari
       and MS-DOS, this is a low/high processor feature and can't be fixed.

 Privilege: Twit       Disgrace   Limited     Normal
            Worthy     Privil     Favoured    Extra
            Clerk      Member     Co-Sysop    Sysop

            Due a language-mistake the privilege  Worhty (Worthy) is
            usable for backwards compatibility.

 Emulation: Ascii      VT52Color  VT52Mono
            AnsiColor  AnsiMono   VT52Falcon

 UserKeys : value 1 t/m 32   (needed for security)
 Delaytime: value 1 t/m 255  (for showing the menu "slower")

Wildcards are also supported, you may use the * and ? chars for displaying
more menus in one loop.    More user security keys can be added using more
arguments (-k<key>) placed on the commandline.

VT52 screen emulations are only usable on Atari ST computers, VT52Falcon
does only work on a Atari Falcon 030 if NVDI (screen accelator) is installed
(normal TOS does not support all VT52 codes), it's also much faster when NVDI
is used.

Rainbow will use as default screen emulation the current one in the Octopus
configuration file.

A new list of known macros in Rainbow is following....

     Ŀ
                         User Macros (`U.)                          
     Ĵ
      Internal name   charwidth description                      
     Ĵ
O ~ o MA_AGE            A   2   Age of current user              
  o o MA_BBS_FAX        B  39   BBS or FAX name                  
  o o MA_CITY           C  35   City                             
  o o MA_DATA_TEL       D  14   Telephone Data                   
  o o MA_FNAME          F       First name                       
  o o MA_MODEM          M  39   Modem type                       
  o o MA_NAME           N  35   First & Last name                
  o o MA_POSTCODE       P   7   Postcode                         
  o o MA_STREET         S  35   Street & Number                  
  o o MA_VOICE_TEL      V  14   Telephone Voice                  
                                                                 
  o o MA_CALLS          a   5   calls of user                    
O ~ o MA_BIRTHDAY       b  ***  User Birthday                    
  o o MA_COMPUTER       c  39   Computer type                    
  o o MA_UTIME_DAY      d   3   User time / day in minutes       
  \ \ MA_FIDOCREDIT     f   3   Fidonet credit                   
  o o MA_LASTCALL       l  ***  Last called on date...           
  o o MA_PRIVILEGE      p       User Privilege                   
  o o MA_UTIME_SEC      s   3   User time left in seconds        
  o o MA_UTIME          t   3   User time left in minutes        
  o o MA_UTIME_USED     u   3   User time used in minutes        
                                                                 
  o o MA_TODAY_DOWN     1   5   Today downloaded files size Kb   
  o o MA_TOTAL_DOWN     2   5   Total downloaded files size Kb   
  o o MA_FILES_DOWN     3   5   Total number of downloaded files 
  o o MA_DAY_DOWN       4   5   Maximum download per Periode Kb  
  o o MA_DAY_DOWN_LEFT  5   5   Maximum download in Kb 'today'   
  o o MA_DAY_DOWN_DONE  6   5   Downloaded size in Kb 'today'    
  o o MA_TODAY_UP       7   5   Today uploaded files size Kb     
  o o MA_TOTAL_UP       8   5   Total uploaded files size Kb     
  o o MA_FILES_UP       9   5   Total number of uploaded files   
     

     Ŀ
                        Message macros (`M.)                        
     Ĵ
      Internal name   charwidth description                      
     Ĵ
O ~ o M_ECHO_MSGS       E       Written echomail messages        
O ~ o M_LOCAL_MSGS      L       Written local messages           
O ~ o M_NETMAIL_MSGS    N       Written netmail messages         
O ~ o M_SYSOP_MSGS      S       Written messages to sysop        
  o o M_MAREA           a   20  Current message area             
  o o M_MDESCRIP        d       Current message area description 
  o o M_LAST            l    5  Last readed message in msg area  
  o o M_MESSAGES        m    5  Number of messages in msg area   
     

     Ŀ
                       Filebase macros (`F.)                        
     Ĵ
      Internal name   charwidth description                      
     Ĵ
  o o F_FAREA           a   20  Default file area                
  o o F_FDESCRIP        d       Default file area description    
  o o F_FILES           f    5  Number of files in file area     
  o o F_GETFILENAME     n  ***  Get filename from DTA buf        
  o o F_SIZE            s    8  Total size of files in file area 
     

     Ŀ
                   General System Macros (`.)                       
     Ĵ
      Internal name   charwidth description                      
     Ĵ
  o o MA_BUTTON         B       Send a Button                    
  o o MA_GETKEY         K       Wait on keypress                 
  o o MA_LAST           L  35   Last caller full name            
  o o MA_SYSNAME        N  79   System Name                      
  o o MA_SECURITY       P       Menu security key                
  o o MA_READLINE       R       Read a line & append to log      
  o o MA_SYSOP          S  35   Full Sysop Name                  
  o o MA_SYSTIME        T  ***  System computer time             
  o o MA_VERSION        V       OCTP version name & serial.      
                                                                 
  o o MA_BAUDRATE       b   6   Current Baudrate                 
  o o MA_EMULATION      e       Screen emulation                 
  o o MA_FAREA          f       Current filearea (duplicate)     
  o o MA_PROMPT         p       Ask for more prompt              
  \ o MA_CHAT_SYSOP     s       Sysop Chat Status                
  o o MA_TCALLS         t   6   Total calls to me                
  o o MA_USERS          u   5   Total number of users            
  o o MA_ACCENT         `   1   `````` Char                      
  | |
  | |
  | +--------- Supported by Rainbow v0.60
  +----------- Octopus v0.59 Beta

        o - available
        \ - available but filled with defaults
        ~ - not available in Octopus v0.59 Beta, added in next version.

The macros MA_BIRTHDAY, MA_LASTCALL & MA_SYSTIME are time-macros require
a Time-String for use with the strftime C function.

Like:   `T%H:%M:%S|

Other macros like F_GETFILENAME needs a filename like: `FnAEO*.TXT|

The `P macro can be used for menus with hidden options for users with
a low security level.  See the Octopus documentation file for how to use
this macro.

Left and right trimming options are usable with all menu macros,
just an easy example how to use:

        @E
        |`UN|           No trimming, using default method.
        |`7UN|          Maximum 7 chars left outlined.
        |`20UN|         Maximum 20 chars left outlined.
        |`-20UN|        20 chars long, name right outlined.

Will converted to:

        |Koos Kuil                          |   (`UN)
        |Koos Ku|                               (`7UN)
        |Koos Kuil           |                  (`20UN)
        |           Koos Kuil|                  (`-20UN)

There's a small mistake in current MAF version 1.34 Beta, it's not fatal
but an update to correct them is needed.   Rainbow is OK.

I hope you like this small programm, it's a small conversion using functions
from Octopus and a few other lines source code.   It's updated using my PC
because my Falcon's HD did crash mechanical last week and in repair now.

Enjoy!
                        Koos

        FidoNet: 2:282/397    UseNet: Koos_Kuil@textlitho.nl
        NesT:   90:500/103    BBS/FAX: 31-5978-18087 (24h)
        FAN:   190:100/204

