home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / olss2rl.lha / Docs / OLSS.DOC < prev    next >
Text File  |  1992-08-23  |  8KB  |  174 lines
  1.  
  2.                      /------------------------------\
  3.                      |   OLSS  Off Line Soft Scan   |
  4.                      |                              |
  5.                      | Version 2.00Rl  by Tim Walls |
  6.                      \------------------------------/
  7.  
  8.  
  9. INTRODUCTION:
  10.     OLSS is a utility designed specifically for Falcon CBCS BBS systems, but
  11. which could be used on other systems (eg. DLG).  OLSS is designed to allow
  12. users of a BBS access to the sysops library of software held offline, on
  13. floppy disks, which would not normally be available for download.  This is
  14. achieved through an online database system, with the ability to generate
  15. file requests.  The sysop then copies the requested files from disk to a BBS
  16. download area at a convenient time, ready for the user to download on the
  17. next login.
  18.  
  19. Read OLSSysop.DOC for details of installing the OLSSysop program.
  20.  
  21. COPYRIGHT & DISTRIBUTION:
  22.     The following copyright & distribution notice applies to all the programs
  23. supplied in the OLSS distribution, specifically OLSS, OLSSysop, OLSS.scr,
  24. ADDPROG and all related files.  This group of programs will be referred to as
  25. "OLSS".
  26.  
  27.  
  28.   OLSS was written by Tim Walls, and is (c) 1992.  These programs'
  29.   executable code is freely distributable.  The source code to these
  30.   programs is NOT public domain, and attempts to reverse engineer,
  31.   disassemble or otherwise obtain the source to these programs will
  32.   be deemed breach of copyright.
  33.  
  34.   GMacro is not guaranteed in any way.  The author of these programs
  35.   accepts no liability, in whole or in part, for damage incurred
  36.   as a result of this software, either direct, indirect, incidental
  37.   or consequential.  If your state/country prohibits such exclusions
  38.   of liability, YOU MAY NOT USE THESE PROGRAMS.  The entire risk as to
  39.   the program's quality and performace is with the user.
  40.  
  41.  
  42.  
  43. INSTALLATION:
  44.     Once OLSS is installed, its use is pretty much self explanatory (& fully
  45. documented through online help files), so the rest of this document will
  46. explain the installation process itself:
  47.  
  48.     OLSS must be run in a RAW: console environment, and must also be run via a
  49. script file to ensure that the stack is an appropriate size!  Step-by-step
  50. installation is as follows:
  51.  
  52.     1) Make a directory doors:OffLineSoft
  53.     2) Make a directory doors:OffLineSoft/Users
  54.     3) Copy OLSS doors:OLSS
  55.     4) copy OLSS.scr doors:OLSS.scr
  56.     5) Add a menu item to your menus.bbs as follows (you may use any key
  57.        you want for the menu option, obviously!!):
  58.  
  59. TWIT * RAW C "execute doors:OLSS.scr doors:OffLineSoft/OLSS.cfg
  60.               «FULLNAME» «LEVEL» «IBMCHARS»«IBM»«NOIBM» «HEIGHT» 2400"
  61.  
  62.        note that this is all one line!!  Note also the last number (2400):
  63.        This is a dummy entry.  In reality it is meant to indicate the baud
  64.        rate at which the user is logged on, but until Falcon can actually
  65.        send that information it is useless :-( (DLG users will no doubt be
  66.        laughing!).  It is relates to the BACKDROP config file keyword.
  67.  
  68.     5) Create the configuration file, doors:OffLineSoft/OLSS.cfg
  69.        This may be done by modifying the supplied OLSS.cfg file;  it is
  70.        fairly self explanatory methinks.  Note, though, that paths, filenames,
  71.        directory names etc. _MUST_ be surrounded by "'s.
  72.  
  73.     6) Initialise the databases.  This is (quite!!) simple.  Use Falcon in
  74.        the local terminal and use your new OLSS option.  If your data file
  75.        OLSS.data was set up correctly you should see two menu options, one
  76.        for each database.  Select the first.  You will be asked if you want
  77.        to initialise the database.  Answer Y)es.  The program will then ask
  78.        you to input 12 "flag names" for the database.  Once this is done, the
  79.        datafile is initialised and the program will exit.  To access the
  80.        database rerun the program.
  81.  
  82.        Do this for each of your databases.
  83.  
  84.     7) Add some database items.  This may be performed "online".  Select the
  85.        flags you wish the program to be identified with by hitting the
  86.        appropriate letter keys (A to L).  When you are satisfied, hit "*"
  87.        to add a program.  You will be asked some fairly self explanatory
  88.        questions and then the program will be added to the database.
  89.  
  90.        NOTE THAT YOU MUST SET THE FLAGS _BEFORE_ HITTING THE * KEY TO ADD
  91.        A PROGRAM TO THE DATABASE.
  92.  
  93.        Items may also be added from the CLI using the ADDPROG program;  See
  94.        accompanying documentation.
  95.  
  96. -------------------------* IMPORTANT NOTE *-----------------------------
  97.  
  98.     A new function in version 1.72sr of OLSS is the "Long Description"
  99. system.  Whilst adding a new program to the database, you are asked for a one
  100. line description.  This may not be enough, however.  So, if you prefix the
  101. description with a #, the following text will be assumed to be a filename and
  102. path.  So, for example:
  103.  
  104. DESCRIPTION: Dead good file.
  105.  
  106. is a standard oneline description.  However,
  107.  
  108. DESCRIPTION: #doors:OLSS/Longdesc.dat
  109.  
  110. would tell OLSS to go and look for a file of that name and to use the contents
  111. of that file for its description.  Note:  This file HAS A SPECIAL FORMAT.
  112.  
  113. 7a) LONG HELP FILE FORMAT
  114.  
  115.     The long help file has a special format which can neatly be summed up
  116. as follows:
  117.  
  118. Catalogue entry
  119. {
  120. Keys
  121. }
  122. Text
  123.  
  124. CATALOGUE ENTRY:
  125. The catalogue entry may be up to 80 characters long, and is the description
  126. which will appear in the "Catalogue" option of OLSS.
  127.  
  128. Note the { and } delimeters.  THESE ARE ESSENTIAL.  THEY _MUST_ BE THE FIRST
  129. AND ONLY CHARACTER ON A LINE.
  130.  
  131. KEYS:
  132. Between the { and } characters is a list of keys.  You may have up to 20 keys,
  133. each of up to 20 letters.  The keys should basically be a set of words which
  134. you feel neatly sum up the program entry.  It is these keys which will be
  135. searched on (using the "Search text" entry) during a "Begin Scan" or
  136. "Catalogue" call.  The actual text content of the message is NOT searched (to
  137. do so would be far too slooooooow).  Each key must be on a seperate line.
  138.  
  139. TEXT:
  140. Here you should put your description of the program entry.  The text may be
  141. COMPLETELY free-form, with lines of any length etc.  It should be borne in
  142. mind, however, that no word-wrap is performed by the viewer, and thus you
  143. should justify your text for a 75 COLUMN screen (to take into account borders
  144. etc.).  Nothing drastic will happen if you don't, just text split over lines
  145. etc.
  146.  
  147.  
  148. USES FOR THE LONG DESC FUNTION
  149.     The primary concern when installing this function was to make it easier
  150. for sysops to include disk-based libraries in the system.  A single program
  151. entry may cater for an entire disk, for example, and by using a "Long desc"
  152. entry you can still detail ALL the software on the disk.
  153.     It may, of course, simply be used for more detailed descriptions of
  154. ordinary individual files.
  155. ---------------------------------------------------------------------------
  156.  
  157. All other options have online help to explain them (use # from the main menu
  158. to access the online help).
  159.  
  160. ONE LAST THING...
  161.     You must remember to check your request file (using OLSSysop) regularly.
  162.     You may also wish to set up a seperate file area for OLSS
  163.     requested files.
  164.  
  165. The best way to achieve this first aim is to make sure that running the
  166. OLSSysop program is in your login stack.
  167.  
  168. THATS ALL FOLKS...
  169.     Good luck!!  Any questions, comments, bug reports etc. may be directed
  170. towards...
  171.  
  172.        Tim Walls @ 2:253/513         Fidonet
  173.        Tim Walls @ 39:133/1          Amiganet
  174.        twalls@ncc1701d.demon.co.uk   Internet