home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / lfb_2_4.zip / LFB.ENG < prev    next >
Text File  |  1998-05-18  |  18KB  |  589 lines
  1.                        ░▒▓ LFB - file list builder ▓▒░
  2.                               v 2.4 05-19-98
  3.  
  4.     I put this filelist generator for your opinion. It's not more power that
  5. other generators - it's only next alternative. May be it will be nice for You,
  6. may be only HTML generating, may be You will be not successed - this program
  7. fully for You. If You want to know about new versions and want to test beta
  8. versions - send me message on address in the end of document.
  9.  
  10. -Distributions
  11.  
  12.     After unpacking archive You'll get followed files
  13.  
  14.         LFB.EXE     DOS executive module
  15.         LFB-2.EXE   OS/2 executive module
  16.         LFB-386.EXE DOS/386 executive module
  17.                     (requared RTM&DPMI16BI.OBL from Borland Pascal)
  18.         LFB.INI     configuration file
  19.         LFB.ARE     sample of area templates
  20.         LFB.TIT     sample of filelist title
  21.         LFB.END     sample of filelist footer
  22.         LFB.HDR     sample of area header
  23.         LFB.BDL     sample of BDL template
  24.         LFB.DIR     sample of directory list
  25.         LFB.EXL     sample of excluded directory list
  26.         T-MAIL.EXP  sample of export file
  27.         LFB.DUP     sample of duplicate list template
  28.         LFB.STA     sample of statistic table template
  29.         LFB.SUB     sample of subarea header template
  30.         LFB.CRK     sample of CRK/XCK templates
  31.         LFB.TBL     sample of FILE_ID.DIZ filtering table
  32.         LFB.URL     sample of path to URL translation (HTML)
  33.         LFB.HTM     sample of HTML templates
  34.         LFB.ICN     sample of icon relations
  35.         LFB.ENG     english manual
  36.         LFB.RUS     russian manual
  37.  
  38.  
  39. -Installation
  40.     Copy all files to your own directory, for example C:\MODEM\LFB.
  41.  
  42. -Setting
  43.   >>>>LFB.INI>>>>>
  44.  
  45.     OutFile         LEO_ALL.LST
  46.         Output filelist. You can set it in NUL - filelist will not be maked.
  47.  
  48.     OutNew          LEO_NEW.LST
  49.         Output filelist with new files.
  50.  
  51.     AreaTemplate    LFB.ARE
  52.         File with area template.
  53.  
  54.     TitleFile       LFB.TIT
  55.         File with filelist header
  56.  
  57.     FooterFile      LFB.END
  58.         File with filelist footer
  59.  
  60.     AreaHeader      LFB.HDR
  61.         File with area header
  62.  
  63.     SubAreaHeader   LFB.SUB
  64.         File with subsrea header
  65.  
  66.     DirectoryList   LFB.DIR
  67.         File with directory list
  68.  
  69.     ExcludeList     LFB.EXL
  70.         File with excluded directory list
  71.  
  72.     BBSFILE         FILES.BBS
  73.         Here you can set an alternative file name for files descriptions,
  74.         f.e. DESCRIPT.ION
  75.     
  76.     LogFile         LFB.LOG
  77.         Log file
  78.  
  79.     BDLTemplate     LFB.BDL
  80.         BDL template
  81.  
  82.     DupeFile    LEO_ALL.DUP
  83.         Output file with possible duplicates.
  84.  
  85.     DupeTemplate    LFB.DUP
  86.         Files with duplicatelist template.
  87.  
  88.     NewFileTime     7
  89.         Number of days for new files
  90.  
  91.     AddNewFiles     Yes
  92.         Do You want o add new files to FILES.BBS
  93.  
  94.     AddLongDesc     ' >'
  95.         String for long description
  96.  
  97.     LongDescColumn  33
  98.         Starting position in result filelist for long description
  99.  
  100.     DlCounter       '[--]'
  101.         Start string for download counter. If DLCOUNTER not specified -
  102.         download counter will be not added
  103.  
  104.     DLCounterIncrease   yes
  105.         Recalc dlcounters with T-Mail logfiles.
  106.  
  107.     MakeBDL     yes
  108.         Make best download list.
  109.  
  110.     BDLQuantity 20
  111.         Quantity files in BDL (up to 20)
  112.  
  113.     FileNotFound    '* Offline *'
  114.         Text for offline files
  115.  
  116.     T-Mail-log  C:\MODEM\LOG\T-MAIL-0.LOG
  117.     T-Mail-log  C:\MODEM\LOG\T-MAIL-1.LOG
  118.         Path and name of T-Mail logfile. You can specify up to 10 lines.
  119.  
  120.     NoDescription   'Description not available'
  121.         Text for files without FILE_ID.DIZ
  122.  
  123.     FilterTable     LFB.TBL
  124.         Table for FILE_ID.DIZ filtering
  125.  
  126.     MarkNewFiles    Yes
  127.         Do You want to mark new files
  128.  
  129.     NewFilesSign     *
  130.         Letter for new files marking
  131.  
  132.     SortFiles       Yes
  133.         Do You want to sort files when they added
  134.  
  135.     SkipEmpty       Yes
  136.         Skip empty areas in filelist
  137.  
  138.     LongNameSkipLine  Yes
  139.     DLCounterSkipLIne Yes
  140.         Start writing file description from new line, if file name more then
  141.         12 symbols or if download counter exist.
  142.  
  143.     LongDescOneLine  No
  144.         Put descriptions in one line
  145.  
  146.     PadFirstLine    Yes
  147.         Start first description line from LongDescColumn position
  148.  
  149.     MakeStatistic   Yes
  150.         Make area statistic in the end of filelist
  151.  
  152.     StatTemplate    LFB.STA
  153.         File with statistic table template
  154.  
  155.     ExcludeFiles    FILES.*,*.BAK,*.DMP,*.IDX,*.HTM
  156.         Filemasks that will not be added during new files search
  157.  
  158.     AreaLevel       0   Public Area
  159.     AreaLevel       1   Public Area
  160.         Levels and level names
  161.  
  162.     DateFormat      DD-MM-YY
  163.         Format of file date in output list. Possible combinations with
  164.         MM,DD,YY,YYYY,NNN (last - month name)
  165.  
  166.     GetFullMp3Info  No
  167.         In additional to Mp3 tags - get full info about MP3 file
  168.  
  169.     KeepBbsCase  YES
  170.         Filenames in FILES.BBS and result filelist will be in own case (YES),
  171.         upper (UP), lower (LOW) case.
  172.  
  173.     MakeNameOrder DUP
  174.         Order of trying to autoname areas during new area search.
  175.         Here must be combination from 3 letters:
  176.             D  - try to get area name from DIR.BBS in area
  177.             U  - try to parse area path via url mapping.
  178.                 Example
  179.                     ***LFB.URL***
  180.                         c:\bbs ftp://ftp.fonon.kiev.ua/pub/leosoft
  181.                     ***new area path***
  182.                         C:\BBS\OS2\REXX
  183.                     ***resulting area name***
  184.                         OS2/REXX
  185.             P - directory name will be area name
  186.                     ***new area path***
  187.                         C:\BBS\OS2\REXX
  188.                     ***resulting area name***
  189.                         REXX
  190.  
  191.     MakeHtml     yes
  192.         Make HTML during filelist making. Files will be maked in follow order
  193.             index0  - areas index
  194.             index1  - area 1
  195.             ......
  196.  
  197.     MakeNewHtml     yes
  198.         Make HTML with new files. It will be one file new.htm(l).
  199.  
  200.     HtmlPath        c:\bbs\html
  201.         Resulting path for HTMLs
  202.  
  203.     HtmlTemplate    LFB.HTM
  204.         Template for ALL HTML (see followed info about LFB.HTM)
  205.  
  206.     HtmlIndex       file:///C|/bbs/html
  207.         URL, which replace HtmlPath  in index file
  208.  
  209.     ParseFile       lfb.url
  210.         File with path to URL translations
  211.  
  212.     IconFile        lfb.icn
  213.         File with path to icon relations
  214.  
  215.     HtmlCode    DOS
  216.        Convert output text to DOS,WIN or KOI chartable (only letters)
  217.  
  218.     HtmlExtention   html
  219.        Extention for resulting files
  220.  
  221.     PutHtmlOffline  yes
  222.        Put offline iles into Html
  223.  
  224.     HtmlFileNotFound "MAIL ME"
  225.        Text placed instead of date/size
  226.  
  227.     HtmlFileNotFoundName mailto:su@fonon.kiev.ua?subject=~F
  228.        Reference on offline files. In such sample when user press on
  229.        offline file href, browser can open window with new mail for
  230.        request offline file from sysop. ~F - macros which will be replaced
  231.        with requarement file URL.
  232.  
  233.     HtmlKeepCase  YES
  234.         Filenames in HTML files will be in own case (YES), upper (UP),
  235.         lower (LOW) case.
  236.  
  237.     DOS.UnPackR??  Rar.exe e -av- -y -c-
  238.     OS/2.UnPackR??  Rar.exe e -av- -y -c-
  239.     DOS.UnPackA??  Arj.exe e -y
  240.     OS/2.UnPackA??  UnArj.exe e
  241.     DOS.UnPackZip  PkUnZip.exe -o
  242.     OS/2.UnPackZip  UnZip.exe -o -j -C -q
  243.     DOS.UnPackLzh  Lha.exe e -y
  244.     OS/2.UnPackLzh  Lha32.exe e -y
  245.     DOS.UnPackHa   Ha.exe ey
  246.     OS/2.UnPackHa   Ha2.exe ey
  247.         Unpackers settings. You can specify up free set of archivers in
  248.         followed format
  249.         DOS.UnPack<archive extention> <archiver command>
  250.         and/or
  251.         OS2.UnPack<archive extention> <archiver command>
  252.  
  253.         Wildcards using are possible
  254.  
  255.  
  256.   >>>>LFB.DIR>>>>>
  257.     Path   C:\BBS\BBS\
  258.         Area path
  259.  
  260.     Name   BBS
  261.         Area name
  262.  
  263.     SortFiles Yes
  264.         Can files be sorted when added. If not specified - LFB use global
  265.             setting
  266.  
  267.     AreaLevel 1
  268.         Access level for current area
  269.  
  270.     DLCounterIncrease   yes
  271.         Recalc dlcounters with T-Mail logfiles.
  272.  
  273.     Arealevel 1
  274.         Access level to area
  275.  
  276.     DeleteOffline Yes
  277.         Delete offline files in current area with command LFB -D
  278.  
  279.     LongDescOneLine  No
  280.         Put descriptions in one line
  281.  
  282.  
  283.     FilesBBS C:\BBS\BBS\FILES.BBS
  284.         Path and name of FILES.BBS (may be not same name). By default -
  285.         FILES.BBS of path Path.
  286.  
  287.     CheckDupe   Yes
  288.         Check dupes in current areas
  289.  
  290.     AddNewFiles     Yes
  291.         Do You want o add new files to FILES.BBS
  292.  
  293.     ADD     Y:\BBS\MODEM,C:\BBS\CD\BBS\MODEM\FILES.BBS,Modem tools on CD
  294.         Additional subareas to current area. Must be presented subarea path and,
  295.         optional, name and path to FILES.BBS and area description.
  296.  
  297.     AreaTemplate   AREA1.ARE
  298.         Independed template for output files into filelist. By default LFB
  299.         use global setting.
  300.  
  301.     Records must be delimited by empty line
  302.  
  303.   >>>>LFB.ARE>>>>>
  304.     This file must contain one(!) string with can contain followed macroses:
  305.  
  306.         ~F         file name
  307.         ~F(18)     outpu filename, padded up to 18 (right padding). If length
  308.                    of filename more than 18 - it padded with once space.
  309.  
  310.         ~S         file size
  311.         ~S(9)      file size padded up to 9 (left padding)
  312.         ~Sf(9)     file size padded up to 9 in floating format (by default)
  313.                      less than 1000  - in bytes
  314.                      less than 1000K - in kilobytes
  315.                      more than 1M    - in megabytes
  316.         ~Sb        filesize in bytes
  317.         ~Sk        filesize in kilobytes
  318.         ~Sm        filesize in megabytes
  319.  
  320.  
  321.          ~D        file data
  322.  
  323.          ~M        new files mark
  324.  
  325.          ~L        download counter
  326.  
  327.          ~N        file note (first 43 symbols, without splitting - by default)
  328.          ~N(80)    file note (first 80 symbols)
  329.          ~N(80,>)  file note (full note, splitted by 80 sysmbols)
  330.          ~N(800)   file note (first 800 symbols without splitting - full
  331.                               note in one line)
  332.                    When You not use splits - all lines from note will be merged
  333.                     and splitted after that.
  334.  
  335.  
  336.  
  337.  
  338.   >>>>LFB.TIT>>>>>
  339.     In this file You can use macros ~D - date of filelist creation
  340.  
  341.   >>>>LFB.HDR>>>>>
  342.     In this file You can use macroses
  343.         ~N      area number
  344.         ~A      area name
  345.         ~K      file size in Kb
  346.         ~F      count of files
  347.         ~U      access level number
  348.         ~L      access level name
  349.  
  350.    Symbol '#' sets field width, for example ~N## - area number will displayed
  351.    in 4 positions.
  352.  
  353.   >>>>LFB.SUB>>>>>
  354.     In this file You can use macros
  355.         ~A      area name
  356.  
  357.   >>>>LFB.DUP>>>>>
  358.     In this file You can use macros
  359.         ~N      area number
  360.         ~A      area name
  361.         ~P      area path
  362.         ~F      file name
  363.         ~S      file size
  364.         ~D      file date
  365.         ~O      file description
  366.  
  367.   >>>>LFB.STA>>>>>
  368.     In this file You can use macros
  369.         ~N      area number
  370.         ~A      area name
  371.         ~P      area path
  372.         ~T      file count
  373.         ~M      new file count
  374.         ~S      files size
  375.  
  376.  
  377.   >>>>LFB.EXL>>>>>
  378.     Directory list which can not be added to LFB.DIR during searching of new
  379.     areas. It not recursive, i.e. if listed directory C:\BBS\NEW - it not be
  380.     added, but directory C:\BBS\NEW\LIST can be added.
  381.  
  382.   >>>>LFB.BDL>>>>>
  383.     You simply draw your own table. File template begins from %FILESTART string
  384.     (nothing any in this string) and finish at %FILEEND string. In this section
  385.     you can use macroses
  386.         ~N      area number
  387.         ~A      area name
  388.         ~F      file name
  389.         ~C      download counter
  390.         with '#' field settings.
  391.     All other strings outside file section will be putted into BDL.
  392.     In additional You can use macros ~D - current date.
  393.  
  394.   >>>>*.EXP>>>>>
  395.   You can use 3 macroses
  396.  
  397.     &File       DIR.FRQ
  398.         Exported file name
  399.  
  400.         All text between &File and &PathArea will be place as header in
  401.         result file.
  402.  
  403.     &PathArea
  404.     &NameArea
  405.         Area path and name
  406.  
  407.    Other strings will be simply inserted into result file, include empty strings
  408.  
  409.  
  410.  
  411.    When LFB found new files it try to extract FILE_ID.DIZ from archives,
  412.    description from CRK and XCK files and size and number of colors from
  413.    BMP,GIF,JPG files, title from MP3,MOD,STM,S3M,XM.
  414.  
  415.   >>>>LFB.CRK>>>>>
  416.   In this file each line is a mask for finding description in CRK/XCK files.
  417.   If any string in CRK file begins from any string from LFB.CRK - the rest
  418.   of source string stayed as description.
  419.   If LFB not find any matches - it place first string from CRK file as
  420.   description.
  421.  
  422.   >>>>LFB.TBL>>>>>
  423.   This file contains 255 lines, each consist of one or two symbols, delimited
  424.   by space or tab, and specified in text, decimal or hex type, f.e "space" can
  425.   be ' ' or 32 or x20. First symbol - incoming letter, secont - outgoing after
  426.   exchanging. If second symbol not specified or set to 0x - it not be placed
  427.   into description.
  428.  
  429.   >>>>LFB.URL>>>>>
  430.   Here You can place rules for path to URL translations, for example
  431.  
  432.     C:\BBS http://www.fonon.kiev.ua/~su/ftp/
  433.     D:\ http://www.fonon.kiev.ua/~su/ftp1/
  434.     E:\OTHER ftp://ftp.fonon.kiev.ua/pub/e_drive
  435.  
  436.   >>>>LFB.ICN>>>>>
  437.   Here You can place strings within current format
  438.   <icon file name> <file extention> [<..>]
  439.   For example
  440.  
  441.     binary.gif      exe com
  442.     compress.gif    zip rar r?? arj a?? ha lzh lha
  443.     sound.gif       wav voc mod mid stm s3m xm mp3 mp2 ra
  444.     unknown.gif     *
  445.  
  446.   >>>>LFB.HTM>>>>>
  447.   Here You define of template for your HTML
  448.   !Attention! Please, keep order of %labels in template
  449.   Label must be simple one in each line
  450.  
  451.     %IndexHeader
  452.         Header of index HTML file.
  453.  
  454.     %Index
  455.         Template of reference to area. Available variables:
  456.             ~U - URL to area HTML
  457.             ~N - area name
  458.  
  459.     %IndexFooter
  460.         Footer for index HTML
  461.  
  462.  
  463.     %Header
  464.         Header for area HTML
  465.         Available variable
  466.             ~N - area name
  467.  
  468.     %TableHeader
  469.         Defining of table with files
  470.         Available variable
  471.             ~N - area name
  472.  
  473.     %RowHeader
  474.         Defining of row in table
  475.  
  476.     %Columns
  477.         Defining of items in the table row.
  478.         Available variables
  479.             ~U - file URL
  480.             ~F - file name
  481.             ~D - file date
  482.             ~S - file size (see area template formats)
  483.             ~L - download counter
  484.             ~N - file description
  485.             ~I - file name with icon, related to urrent file extention
  486.  
  487.     %RowFooter
  488.         Tag for closing table row
  489.  
  490.     %TableFooter
  491.         Tag for closing table
  492.         Available variables
  493.         ~C - total files count
  494.         ~S - total files size (see area template formats)
  495.  
  496.     %Footer
  497.         Document footer
  498.  
  499.  
  500. -Starting
  501.     Current version of LFB support follow command line parameters
  502.  
  503.     -B[n,...] [<output file>]
  504.         Build filelist and new filelist
  505.         n - only put areas with access level n (or levels, separated by commas)
  506.         <output file> - name of output file for filelist (filelist with
  507.             new files not will be created in this case)
  508.  
  509.     -F <root directory>
  510.         Find new areas with FILES.BBS. If file DIR.BBS exist - area name will
  511.         be given from it, else it will be directory name.
  512.  
  513.     -X <export template file>
  514.         Export areas list into other format
  515.  
  516.     -S
  517.         Sort files in areas
  518.  
  519.     -D
  520.         Delete offline files from FILES.BBS
  521.  
  522.     -GA
  523.     -GD
  524.         Add/delete download counters into/from ALL areas
  525.  
  526.     -L
  527.         Recalc dlcounter in areas within T-mail logfiles. Date and time of last
  528.         analise will be saved in LFB.TML file in directory with EXE file.
  529.  
  530.     -DF <file mask>
  531.         Delete specified file(s) from ALL FILES.BBS
  532.  
  533.     -FD
  534.         Find and print possible duplicate files.
  535.  
  536.     -FDF
  537.         Find and print possible duplicate files (only with same names)
  538.  
  539.     -DE
  540.         Delete empty lines from FILES.BBS
  541.  
  542.     -RE <old description>
  543.         Try to reget description from file, if it have <old description>
  544.         In FILES.BBS. Usefull if file was added from ALLFIX and not from
  545.         fileecho. If <old description> is multiword - please, quote it
  546.         by " symbol at begin and end of description.
  547.  
  548.  
  549.     -CFG <config file>
  550.         Alternate config file. This parameter can be used with other commands
  551.  
  552. -Next step
  553.  
  554.     What will never be in LFB:
  555.         -FILES.BBS editor
  556.  
  557.     What will be in LFB:
  558.         -increasing of supported file types fo automatic description
  559.          exstracting
  560.  
  561. -Total
  562.     That's all.
  563.     Wishes, observations, complaints - i'll be glad to see them at
  564.         2:463/67@fidonet
  565.         or (it will be quickly)
  566.         su@fonon.kiev.ua
  567.  
  568.     Last version available on http://www.fonon.kiev.ua/~su/soft.shtml
  569.     Sample of HTML output on http://www.fonon.kiev.ua/~su/ftp.html
  570.  
  571.     Special thanks to
  572.         Alexander Fedorko   AKA Panther
  573.             2:463/69        alx@fonon.kiev.ua
  574.         Konstantin Zhilenko AKA Vagabond
  575.             2:463/113       vagabond@fonon.kiev.ua
  576.         Alexey Dubov 
  577.             2:5053/15       al@intercom.ru 
  578.         Konstantin Kubatkin
  579.             2:468/13        cat@agrobank.kherson.ua
  580.     for neverending testing.
  581.  
  582.        Good luck!                   Alexey Suhoy AKA Uncle Su
  583.                                     2:463/67@fidonet
  584.                                     su@fonon.kiev.ua
  585.  
  586.                                     ░▒▓ LeoSoft Programmers Group ▓▒░
  587.                                                  1998
  588.  
  589.