home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / lhead150.zip / LHEADER.DOC < prev    next >
Text File  |  1995-10-04  |  12KB  |  227 lines
  1.  
  2.     Lora Header version 1.50
  3.  
  4.     - Introduction -
  5.     Lora Header is a small tool, written for LoraBBS-OS/2 (not for
  6.     the DOS version of LoraBBS), made to beautify your FILES.BBS
  7.     just the way you want them to be.
  8.     Lora Header is written for LoraBBS version 2.40 and up. At this
  9.     moment Lora Header is know to un on versions 2.40 and 2.41B1.
  10.  
  11.     - Usage -
  12.     Lora Header is easy to use.  But before you can start using Lora
  13.     Header, you need to create a file called LHEADER.BBS.  An
  14.     example file is already in the distribution package, but
  15.     you're free to leave it for what it is, and create a
  16.     LHEADER.BBS file of your own.  The size of the LHEADER.BBS file
  17.     might not be longer than 20 lines.  If you create a LHEADER.BBS
  18.     file of more than 20 lines, Lora Header will act real strange!
  19.     In the LHEADER.BBS file there are nine pointers you can use.
  20.     These pointers are:
  21.  
  22.     ^FNAME^   Will be translated into the name of the current
  23.               file-area.  The size of ^FNAME^ will always be 55
  24.               characters.
  25.     ^FNUM^    Will be translated into the number that the file-area
  26.               has.  The number generated will use up to 5 spaces,
  27.               and the number itself will be placed at the left side
  28.               of the start of ^FNUM^.
  29.               i.e. [^FNUM^] translates into [1    ]
  30.     ^FGRP^    Will be translated into the number of the file-group
  31.               that the file-area is part of. The number generated
  32.               will use up to 2 spaces, and the number itself will be
  33.               places on the left side of the start of ^FGRP^.
  34.               i.e. [^FGRP^] translates into [2 ]
  35.     ^SIZE^    Will be translated into the total size (in bytes,
  36.               without cumma's in it) of the files in the FILES.BBS.
  37.               ^SIZE^ will take up to 9 spaces when subtituted.
  38.               Unlike ^FNUM^, ^SIZE^ will start with empty spaces,
  39.               and end with the total size of the files.
  40.               i.e. [^SIZE^] translates into [     1024]
  41.     ^FILES^   Will be translated into the total number of on-line
  42.               files (off-line files are not counted because they
  43.               don't have any value to the BBS).  ^FILES^ will take
  44.               up to 4 spaces after it is subtituted, and just like
  45.               ^SIZE^, ^FILES^ will start with spaces, followed by
  46.               the number of on-line files there are in the area.
  47.               i.e. [^FILES^] translates into [  16]
  48.     ^UPDATED^ Will be translated into the date you've run Lora
  49.               Header the last time.  The date format will be in
  50.               European style (dd mmm yy), and therefor there is no
  51.               change in size after ^UPDATED^ is translated.
  52.               i.e. [^UPDATED^] translates into [26 Mar 95]
  53.     ^ALVL^    Will be translated into the minimum level that is needed
  54.               to acces the file-area.  The ^ALVL^ will be translated
  55.               just like LoraBBS writes down the levels.  After the
  56.               translation, ^ALVL^ will be 9 characters long, spaces
  57.               included.
  58.               i.e. [^ALVL^] translates into [Extra    ]
  59.     ^DLVL^    Will be translated into the minimum level that is
  60.               needed for the user to download a file from the
  61.               current file-area.  Just like ^ALVL^, ^DLVL^ will be 9
  62.               characters long after translation.
  63.     ^FLD^     Will be tanslated into a simple YES or NO.  The pointer
  64.               holds eigther a YES or NO regarding the FREE download
  65.               flag for the current file-area.  ^FLD^ will always use
  66.               3 characters after translation.
  67.               i.e. [^FDL^] translates into [NO ]
  68.     ^DCR^     Will be translated into a simple YES or NO.  The
  69.               pointer holds eigther a YES or NO regarding the CD-ROM
  70.               flag as is written in LoraBBS for the current
  71.               file-area.  Just like ^FDL^, ^CDR^ will use 3
  72.               characters after translation.
  73.  
  74.     As you see, each pointer starts with a '^', and ends with a '^'.
  75.     I've taken this character, because it is not commonly used.
  76.     Once you start using Lora Header, you are not allowed to use the
  77.     '^' character in eighter the description of the file-area of in
  78.     the LHEADER.BBS file.
  79.     The pointers you use in the LHEADER.BBS file are not case
  80.     sensitive.  This means that you can use eighter upper-case or
  81.     lower-case, or use mixed upper- and lower-case.
  82.     While Lora Header is running, all file-area's will be
  83.     processed, only the file-area's that have the 'Hidden' security
  84.     set for the access level.
  85.  
  86.     After you've created your own LHEADER.BBS (or you've decided to
  87.     use the one that came with the distribution package).  you've
  88.     got to place both the LHEADER.BBS and LHEADER.EXE files in the
  89.     LoraBBS home directory.  This must be the directory where the
  90.     files CONFIG.DAT and SYSFILE.DAT resides.
  91.  
  92.     When using Lora Header, you also might want to add some parameters
  93.     to the command-line, so you can make Lora Header more configurable
  94.     as it already is. The parameters you can add are listed below, with
  95.     the meaning of them.
  96.      Input:<Lheader.BBS> - With this parameter you can use an other
  97.          header instead of the default header LHEADER.BBS. Using the
  98.          parameter you can give every file-group their own header.
  99.      Group:<x>[,<x>[-<x>]] - This parameter allowes you to define a
  100.          number of file-groups to be processed. When using this
  101.          parameter, you can select one group, a few groups, or a range
  102.          of groups. Examples of the group selection are:
  103.           Group:1     -> Selects only file-group 1
  104.           Group:1,5   -> Selects file-groups 1 and 5
  105.           Group:1,5-7 -> Selects file-groups 1 and 5 tru 7
  106.      LoraPath:<d:\path\> - This parameter shows Lora Header where the
  107.          main files are from LoraBBS. This allowes you to use Lora
  108.          Header form an other directory than the directory where
  109.          LoraBBS resides.
  110.      CD - This parameter will force Lora Header to process file-area's
  111.          that have CD-ROM flag set on.
  112.      NoCD - With this parameter, you only process the file-area's that
  113.           have the CD-ROM flag turned off.
  114.  
  115.     NOTE: In the unregistered version of Lora Header, every time
  116.     you use Lora Header, you need to press a key to continue.  In
  117.     the registered version of Lora Header this little 'nag' is of
  118.     course removed. You also are not able to use the 'Group:'
  119.     parameter.
  120.  
  121.     - Registration -
  122.     Lora Header is almost given to you under the shareware concept.
  123.     This means that you're free to use Lora Header for a trial
  124.     period of 30 days, and after that you must decide to register
  125.     Lora Header, or to remove it from your system, and never use
  126.     Lora Header again.
  127.     The price for a registration is reasonable.  Lora Header can be
  128.     used for only $7.  The registration fee has to be payed once.
  129.     Future versions can be downloaded for free from the support BBS.
  130.     To register your version of Lora Header, you need to complete
  131.     the REGISTER.FRM file, print it, and send it to the address
  132.     written on it.  Please do send cash only, and no bank-notes or
  133.     cheques.  Most banks charge twice the registration to cash a
  134.     bank-note or cheque.
  135.  
  136.     - Support -
  137.     Support for Lora Header can be gained at the author, on one of the
  138.     following addresses/places.
  139.     BBS     : SEXES - 3120-6900028
  140.     FidoNet : 2:280/230, in the LORA echo, or in the OS2BBS echo
  141.     InterNet: alexerne@xs4all.nl
  142.     Mail    : EAgle Soft
  143.               a.t.t.n. Alexander Erne
  144.               Burg de Kievietstraat 86
  145.               1111 GR  Diemen
  146.               The Netherlands
  147.     For the USA and Canada, support can be gained via Robert Butler.
  148.     BBS     : Fire 4 Effect! BBS - 1-817-699-3865
  149.     FidoNet : 1:395/419, in the LORA echo, or in the OS2BBS echo
  150.     Mail    : Robert M Butler
  151.               4108 Lake RD 8
  152.               Killeen, TX 76543-3301
  153.  
  154.     - Disclaimer -
  155.     Lora Header is profided 'as is'.  This means that the software
  156.     has no warrenty at all, except that it should do what is
  157.     writting in this documentation.  If Lora Header might crash your
  158.     harddisk, or does any other kind of harm to your computer, or
  159.     anything else that you have, too bad.
  160.     Remember.  You're using Lora Header because of your free will,
  161.     and you didn't pay real much for it...
  162.  
  163.     - Copyright -
  164.     Lora Header is Copyright 1995 by Alexander Erné / EAgle Soft.
  165.     Alexander Erné / EAgle Soft holds all rights on the program,
  166.     the source code, this documentation and all other files that
  167.     came in the original distribution package from Lora Header.
  168.  
  169.     - Distribution -
  170.     You are free to share this program to anyone you like.  There
  171.     may only be no charge for Lora Header, other than the cost that
  172.     was needed to share the program with one other.
  173.     Lora Header may also be placed on any public or non-public
  174.     Bulletin Board system, and Lora Header mayalso be placed on
  175.     CD-ROM's containing shareware, without the written permission of
  176.     Alexander Erné.
  177.     Lora Header may not be included as a 3rd party program in an
  178.     other package without the express written permission of the author.
  179.     Distribution may only be done in the original package, containing
  180.     an Authentic Verification created by the RAR compression method.
  181.  
  182.     - Credits -
  183.     There are two persons I'd like to thank.
  184.     Maurice Elfert and Henk Dijksma, both for testing Lora Header
  185.     for those few days it was needed.
  186.     In this documentation I've talked about two other programs.
  187.     Here they are with the rights on them...
  188.     LoraBBS-OS/2, the maker of (what I personally think) the best
  189.     Bulletin Board System for OS/2 - Copyright by Marco Maccafferri.
  190.     OS/2 (Operating System/2) is copyright and TradeMark by IBM.
  191.  
  192.     - History -
  193.  
  194.     Version 1.50 [Oktober 4, 1995]
  195.     *Yet again. I seemed to have fixed the bug that caused trashing
  196.      of the FILES.BBS listings. The problem was caused by a sharing
  197.      voilation when opening the file. After 25 test runs on my system
  198.      all of my FILES.BBS listings were still okay.
  199.     *Added the following parameters:
  200.       Input:<Lheader.BBS>
  201.       Group:<x>[,<x>[-<x>]]
  202.       LoraPath:<d:\path\>
  203.       CD
  204.     *Created a simple registration system, that goes for all future
  205.      versions of Lora Header.
  206.  
  207.     Version 1.10 [June 10, 1995]
  208.     *I seemed to have fixed the bug that caused the trashing of a
  209.      complete FILES.BBS listing. Maurice Elfert did the testing for
  210.      this, bacauseon his system, everytime he ran Lora Header, more
  211.      than 50% of hist FILES.BBS lisings were trashed.
  212.      Maurice Thanks for testing, and aslo thanks for showing real
  213.      friendship. If the problem overcame someone else, he/she would
  214.      probably have turned his back on my a long time ago...
  215.     *In addition of the previous mentioned bug, Lora Header makes now
  216.      a backup file of the FILES.BBS listing. CD-ROM area's are backed
  217.      up as FA<num>.BAK, where <num> representes the file-area number.
  218.      Lora Header doesn't create the file _TMPLST_.000 anymore. You can
  219.      erase it from the LoraBBS home directory.
  220.     *I've added a new keyword to Lora Header. ^FGRP^ that is. It stands
  221.      for the file-group a file-area is part of.
  222.     *I've added a new LHEADER.BBS in the distribution package. This one
  223.      uses Avatar color codes, and it will beautify your FILES.BBS even
  224.      more than version 1.00 did.
  225.  
  226.     Version 1.00 [March 27, 1995]
  227.     *The very first release of Lora Header.