home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / Utils / allfiles.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  4.3 KB  |  214 lines

  1.  
  2.  
  3.  
  4.  
  5.    =====( TAF V1.10 )================================================
  6.  
  7.  
  8.         Trion 'Allfiles' Utility.
  9.  
  10.         (c) Copyright Paul Spijkerman, '94-'98. All rights reserved.
  11.  
  12.         Written for use with the Trion BBS package.
  13.  
  14.  
  15.    ===================================================================
  16.  
  17.    This is the Trion allfiles generator, it is basically a programm
  18.    that makes file lists of groups of selected file sections, archives
  19.    them and add them to the file catalogue.
  20.  
  21.    It can make a number of different allfiles with one configuration file.
  22.    Each list can be of the "Allfiles" or "Newfiles" type.
  23.    Only validated files are listed.
  24.    Only sections which contain files or newfiles are listed.
  25.  
  26.  
  27.    The allfiles programm uses a configuration file called
  28.    "trion:cfg/allfiles.cfg".
  29.    In the configuration file you can define a number of allfiles.
  30.    Each allfiles definition consists of a number of lines with
  31.    the information needed to create an allfiles and is ended
  32.    with an END line.
  33.    The information consist of file list methode (alphabetically
  34.    or chronologically), the file section it is added too, the
  35.    file sections a list is made of, and the names and description
  36.    of the file in the BBS and information needed to archive the list.
  37.  
  38.  
  39.    When the allfiles programm is started it get's the definitions
  40.    of the allfiles one at a time.
  41.    Then it removes the old allfiles from the file catalogue, it
  42.    makes a new list in the temporary directory (default RAM:)
  43.    Archives it and adds it to the file catalogue.
  44.    When an allfiles is added to the file catalogue it is validated
  45.    and has a 'FreeDownload' flag.
  46.  
  47.  
  48.    The file list code has 2 modes, the normal one, and one with
  49.    preformatted descriptions.
  50.  
  51.    The normal list mode occurs when there are no returns in a
  52.    description. The description is listed by means of wordwrap
  53.    at the end of a line, and skipping spaces at the start of
  54.    lines.
  55.  
  56.    The other list mode concerns preformatted descriptions, those
  57.    are basically descriptions with returns in them, wich come
  58.    from description files like FileID.DIZ files.
  59.    These are treated a little different because leading spaces
  60.    at the start of a line are not skipt, and that returns are
  61.    used to decide when to go to the next line over the
  62.    wordwrap methode.
  63.  
  64.  
  65.    Here is an example of an allfiles configuration file:
  66.  
  67.  
  68.  
  69.  
  70. ;====(  Tron AllFiles Configuration File )=====
  71.  
  72.  
  73.  
  74. ;; methode of sorting the list , can be 'ALPHA' or 'CHRONO'
  75.  
  76. SORT  ALPHA
  77.  
  78. ;; type ALLFILES or NEWFILES
  79.  
  80. TYPE ALLFILES
  81.  
  82. ;; number of days scanning back with newfiles 
  83.  
  84. DAYS 14
  85.  
  86. ;; Area to Add this AllFiles to
  87.  
  88. AREA  5
  89.  
  90. ;; Description in the BBS filecatalog
  91.  
  92. DESC  "AllFiles of this BBS"
  93.  
  94. ;; filename and archive name of the allfiles
  95.  
  96. NAME   "ALLFILES.TXT"
  97. ARC    "ALLFILES.LHA"
  98.  
  99. ;; Temporary directory to make file and archive
  100.  
  101. TEMP   "RAM:"
  102.  
  103. ;; How to archive this allfiles
  104. ;;  %a = archive  ,  %t = allfiles text
  105.  
  106. ARCHIVER   "Lha -q -N -m a %a %t"
  107.  
  108. ;; Wich sections to Add to this AllFiles
  109.  
  110. SECTIONS   3-5 , 12-14 , 20-35
  111. SECTIONS   60-73
  112.  
  113. ;; End of this allfiles
  114.  
  115. END
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123. ;; methode of sorting the list , can be 'ALPHA' or 'CHRONO'
  124.  
  125. SORT  ALPHA
  126.  
  127. ;; type ALLFILES or NEWFILES
  128.  
  129. TYPE NEWFILES
  130.  
  131. ;; number of days scanning back with newfiles 
  132.  
  133. DAYS 14
  134.  
  135. ;; Area to Add this AllFiles to
  136.  
  137. AREA  5
  138.  
  139. ;; Description in the BBS filecatalog
  140.  
  141. DESC  "newfiles of the last 14 days of this BBS"
  142.  
  143. ;; filename and archive name of the allfiles
  144.  
  145. NAME   "NEWFILES.TXT"
  146. ARC    "NEWFILES.LHA"
  147.  
  148. ;; Temporary directory to make file and archive
  149.  
  150. TEMP   "RAM:"
  151.  
  152. ;; How to archive this allfiles
  153. ;;  %a = archive  ,  %t = allfiles text
  154.  
  155. ARCHIVER   "Lha -q -N -m a %a %t"
  156.  
  157. ;; Wich sections to Add to this AllFiles
  158.  
  159. SECTIONS   3-5 , 12-14 , 20-35
  160. SECTIONS   60-73
  161.  
  162. ;; End of this allfiles
  163.  
  164. END
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172. ;; methode of sorting the list , can be 'ALPHA' or 'CHRONO'
  173.  
  174. SORT  ALPHA
  175.  
  176. ;; type ALLFILES or NEWFILES
  177.  
  178. TYPE ALLFILES
  179.  
  180. ;; number of days scanning back with newfiles 
  181.  
  182. DAYS 14
  183.  
  184. ;; Area to Add this AllFiles to
  185.  
  186. AREA  9
  187.  
  188. ;; Description in the BBS filecatalog
  189.  
  190. DESC  "AllFiles of TRION files"
  191.  
  192. ;; First part of filename of this Allfiles
  193.  
  194. NAME  TALLFILES.TXT
  195. ARC   TALLFILES.LHA
  196.  
  197. ;; Temporary directory to make file and archive
  198.  
  199. TEMP   "RAM:"
  200.  
  201. ;; How to archive this allfiles
  202. ;;  %a = archive  ,  %t = allfiles text
  203.  
  204. ARCHIVER   "Lha -q -N -m a %a %t"
  205.  
  206. ;; Wich sections to Add to this AllFiles
  207.  
  208. SECTIONS   9
  209.  
  210. ;; End of this allfiles
  211.  
  212. END
  213.  
  214.