home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / LHEAD110.ZIP / LHEADER.DOC < prev    next >
Text File  |  1995-05-20  |  9KB  |  177 lines
  1.  
  2.     Lora Header version 1.10
  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.  
  9.     - Usage -
  10.     Lora Header is easy to use.  But before you can start using Lora
  11.     Header, you need to create a file called LHEADER.BBS.  An
  12.     example file is already in the distribution package, but
  13.     you're free to leave it for what it is, and create a
  14.     LHEADER.BBS file of your own.  The size of the LHEADER.BBS file
  15.     might not be longer than 20 lines.  If you create a LHEADER.BBS
  16.     file of more than 20 lines, Lora Header will act real strange!
  17.     In the LHEADER.BBS file there are nine pointers you can use.
  18.     These pointers are:
  19.  
  20.     ^FNAME^   Will be translated into the name of the current
  21.               file-area.  The size of ^FNAME^ will always be 55
  22.               characters.
  23.     ^FNUM^    Will be translated into the number that the file-area
  24.               has.  The number generated will use up to 5 spaces,
  25.               and the number itself will be placed at the left side
  26.               of the start of ^FNUM^.
  27.               i.e. [^FNUM^] translates into [1    ]
  28.     ^FGRP^    Will be translated into the number of the file-group
  29.               that the file-area is part of. The number generated
  30.               will use up to 2 spaces, and the number itself will be
  31.               places on the left side of the start of ^FGRP^.
  32.               i.e. [^FGRP^] translates into [2 ]
  33.     ^SIZE^    Will be translated into the total size (in bytes,
  34.               without cumma's in it) of the files in the FILES.BBS.
  35.               ^SIZE^ will take up to 9 spaces when subtituted.
  36.               Unlike ^FNUM^, ^SIZE^ will start with empty spaces,
  37.               and end with the total size of the files.
  38.               i.e. [^SIZE^] translates into [     1024]
  39.     ^FILES^   Will be translated into the total number of on-line
  40.               files (off-line files are not counted because they
  41.               don't have any value to the BBS).  ^FILES^ will take
  42.               up to 4 spaces after it is subtituted, and just like
  43.               ^SIZE^, ^FILES^ will start with spaces, followed by
  44.               the number of on-line files there are in the area.
  45.               i.e. [^FILES^] translates into [  16]
  46.     ^UPDATED^ Will be translated into the date you've run Lora
  47.               Header the last time.  The date format will be in
  48.               European style (dd mmm yy), and therefor there is no
  49.               change in size after ^UPDATED^ is translated.
  50.               i.e. [^UPDATED^] translates into [26 Mar 95]
  51.     ^ALVL^    Will be translated into the minimum level that is needed
  52.               to acces the file-area.  The ^ALVL^ will be translated
  53.               just like LoraBBS writes down the levels.  After the
  54.               translation, ^ALVL^ will be 9 characters long, spaces
  55.               included.
  56.               i.e. [^ALVL^] translates into [Extra    ]
  57.     ^DLVL^    Will be translated into the minimum level that is
  58.               needed for the user to download a file from the
  59.               current file-area.  Just like ^ALVL^, ^DLVL^ will be 9
  60.               characters long after translation.
  61.     ^FLD^     Will be tanslated into a simple YES or NO.  The pointer
  62.               holds eigther a YES or NO regarding the FREE download
  63.               flag for the current file-area.  ^FLD^ will always use
  64.               3 characters after translation.
  65.               i.e. [^FDL^] translates into [NO ]
  66.     ^DCR^     Will be translated into a simple YES or NO.  The
  67.               pointer holds eigther a YES or NO regarding the CD-ROM
  68.               flag as is written in LoraBBS for the current
  69.               file-area.  Just like ^FDL^, ^CDR^ will use 3
  70.               characters after translation.
  71.  
  72.     As you see, each pointer starts with a '^', and ends with a '^'.
  73.     I've taken this character, because it is not commonly used.
  74.     Once you start using Lora Header, you are not allowed to use the
  75.     '^' character in eighter the description of the file-area of in
  76.     the LHEADER.BBS file.
  77.     The pointers you use in the LHEADER.BBS file are not case
  78.     sensitive.  This means that you can use eighter upper-case or
  79.     lower-case, or use mixed upper- and lower-case.
  80.     While Lora Header is running, all file-area's will be
  81.     processed, only the file-area's that have the 'Hidden' security
  82.     set for the access level.
  83.  
  84.     After you've created your own LHEADER.BBS (or you've decided to
  85.     use the one that came with the distribution package).  you've
  86.     got to place both the LHEADER.BBS and LHEADER.EXE files in the
  87.     LoraBBS home directory.  This must be the directory where the
  88.     files CONFIG.DAT and SYSFILE.DAT resides.
  89.     When you run Lora Header from the LoraBBS home directory, there
  90.     is one optional parameter you can use.  That is NOCD.  This
  91.     parameter prevents Lora Header to process CD-ROM file-area's
  92.     every time it is run.  After all, there won't change much on a
  93.     CD-ROM file-area <G>.
  94.  
  95.     NOTE: In the unregistered version of Lora Header, every time
  96.     you use Lora Header, you need to press a key to continue.  In
  97.     the registered version of Lora Header this little 'nag' is of
  98.     course removed...
  99.  
  100.     - Registration -
  101.     Lora Header is almost given to you under the shareware concept.
  102.     This means that you're free to use Lora Header for a trial
  103.     period of 30 days, and after that you must decide to register
  104.     Lora Header, or to remove it from your system, and never use
  105.     Lora Header again.
  106.     The price for a registration is reasonable.  Lora Header can be
  107.     used for only $7.  The registration fee has to be payed once.
  108.     Future versions can be downloaded for free from the support BBS,
  109.     or can be send crash to your BBS for a reasonable price.
  110.     To register your version of Lora Header, you need to complete
  111.     the REGISTER.FRM file, print it, and send it to the address
  112.     written on it.  Please do send cash only, and no bank-notes or
  113.     cheques.  Most banks charge twice the registration to cash a
  114.     bank-note or cheque.
  115.  
  116.     - Disclaimer -
  117.     Lora Header is profided 'as is'.  This means that the software
  118.     has no warrenty at all, except that it should do what is
  119.     writting in this documentation.  If Lora Header might crash your
  120.     harddisk, or does any other kind of harm to your computer, or
  121.     anything else that you have, too bad.
  122.     Remember.  You're using Lora Header because of your free will,
  123.     and you didn't pay real much for it...
  124.  
  125.     - Copyright -
  126.     Lora Header is Copyright 1995 by Alexander Erné.  Alexander Erné
  127.     holds all rights on the program, the source code, this
  128.     documentation and all other files that came in the original
  129.     distribution package from Lora Header.
  130.  
  131.     - Distribution -
  132.     You are free to share this program to anyone you like.  There
  133.     may only be no charge for Lora Header, other than the cost that
  134.     was needed to share the program with one other.
  135.     Lora Header may also be placed on any public or non-public
  136.     Bulletin Board system, and Lora Header mayalso be placed on
  137.     CD-ROM's containing shareware, without the written permission of
  138.     Alexander Erné.
  139.     Lora Header may not be included as a 3rd party program in an
  140.     other package.
  141.     Distribution may only be done in the original package,containing
  142.     an Authentic Verification, using PKWare's PKZIP for DOS.
  143.  
  144.     - Credits -
  145.     There are two persons I'd like to thank.
  146.     Maurice Elfert and Henk Dijksma, both for testing Lora Header
  147.     for those few days it was needed.
  148.     In this documentation I've talked about two other programs.
  149.     Here they are with the rights on them...
  150.     LoraBBS-OS/2, the maker of (what I personally think) the best
  151.     Bulletin Board System for OS/2 - Copyright by Marco Maccafferri.
  152.     OS/2 (Operating System/2) is copyright and TradeMark by IBM.
  153.  
  154.     - History -
  155.  
  156.     Version 1.10 [June 10, 1995]
  157.     *I seemed to have fixed the bug that caused the trashing of a
  158.      complete FILES.BBS listing. Maurice Elfert did the testing for
  159.      this, bacauseon his system, everytime he ran Lora Header, more
  160.      than 50% of hist FILES.BBS lisings were trashed.
  161.      Maurice Thanks for testing, and aslo thanks for showing real
  162.      friendship. If the problem overcame someone else, he/she would
  163.      probably have turned his back on my a long time ago...
  164.     *In addition of the previous mentioned bug, Lora Header makes now
  165.      a backup file of the FILES.BBS listing. CD-ROM area's are backed
  166.      up as FA<num>.BAK, where <num> representes the file-area number.
  167.      Lora Header doesn't create the file _TMPLST_.000 anymore. You can
  168.      erase it from the LoraBBS home directory.
  169.     *I've added a new keyword to Lora Header. ^FGRP^ that is. It stands
  170.      for the file-group a file-area is part of.
  171.     *I've added a new LHEADER.BBS in the distribution package. This one
  172.      uses Avatar color codes, and it will beautify your FILES.BBS even
  173.      more than version 1.00 did.
  174.  
  175.     Version 1.00 [March 27, 1995]
  176.     *The very first release of Lora Header.
  177.