home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / dwnsrt64.zip / DOWNSORT.CFG < prev    next >
Text File  |  1997-11-30  |  31KB  |  575 lines

  1. ;
  2. ;      ██▐███   █▐███  ██   ██ ██▐███ ██▐████  █▐███  ██▐███  ██▐████
  3. ;      ██   ██ ██   ██ ██   ██ ██  ██ ██      ██   ██ ██   ██   ▐██
  4. ;      ██   ██ ██   ██ ██ █ ██ ██  ██ ██▐████ ██   ██ ██▐███    ▐██
  5. ;      ██   ██ ██   ██ ██ █ ██ ██  ██      ██ ██   ██ ██ █      ▐██
  6. ;      ██▐███   █▐███   █▐███  ██  ██ ██▐████  █▐███  ██  ██    ▐██
  7. ;                                                                  (font 2)
  8. ;
  9. ;
  10. ; ▄▀▀▀▄ ▄▀▀▀▄ █▄  █ █▀▀▀▀ ▀█▀ ▄▀▀▀▄ █   █ █▀▀▀▄ ▄▀▀▀▄ ▀▀█▀▀ ▀█▀ ▄▀▀▀▄ █▄  █
  11. ; █     █   █ █▀█▄█ █▄▄    █  █  ▄▄ █   █ █▄▄▄▀ █▄▄▄█   █    █  █   █ █ ▀▄█
  12. ; ▀▄▄▄▀ ▀▄▄▄▀ █  ▀█ █     ▄█▄ ▀▄▄▄▀ ▀▄▄▄▀ █ ▀▄▄ █   █   █   ▄█▄ ▀▄▄▄▀ █   █
  13. ;                                                                  (font 1)
  14. ;
  15. ;
  16. ;                   █▀▀▀▀▀▀   █     █       █▀▀▀▀▀▀
  17. ;                   █▄▄▄▄▄▄   █▄    █▄      █▄▄▄▄▄▄
  18. ;                   ██        ██    ██      ██
  19. ;                   ██        ██    ██▄▄▄▄▄ ██▄▄▄▄▄
  20. ;                                                                  (font 3)
  21. ;                                            (font 4 is reverse video of 3)
  22. ;
  23. ;
  24. ;  ┌╦══╦┐    ┌╦  ╦┐ ┌╦══╦┐ ┌╦═╦═╦┐ ┌╦══╦┐ ┌╦══╦┐ ┌╦    ┌╦╦╦┐ ┌╦══╦┐ ┌╦══╦┐
  25. ;  │╠═╦╩┘ ┌┐ │╠══╣│ │╠══╣│ │║ ║ ║│ │╠═    │╠═╦╩┘ │║      ║   │║  ║│ │║ ═╦┐
  26. ;  └╩ ╚═┘ └┘ └╩  ╩┘ └╩  ╩┘ └╩   ╩┘ └╩══╩┘ └╩ ╚═┘ └╩═╩┘ └╩╩╩┘ └╩  ╩┘ └╩══╩┘
  27. ;                                                                  (font 5)
  28. ;
  29. ;        *******  Sample Configuration File for DOWNSORT  *******
  30. ;
  31. ;    DOWNSORT is designed to make many lists in almost any combination
  32. ;             in a single run with different groups of file areas.
  33. ;
  34. ; ┌──────────────────────────────────────────────────────────────────────┐
  35. ; │  This configuration file may look complicated for first time users.  │
  36. ; │  But Downsort needs no parameters for a default ALLFILES list!!!     │
  37. ; │  Just run DOWNSORT, and read chapter 'Quick Start' in Downsort.Doc!  │
  38. ; └──────────────────────────────────────────────────────────────────────┘
  39. ;
  40. ;  Rules for parameter specifications in a configuration file:
  41. ;  ──────────────────────────────────────────────────────────
  42. ;   - Lines are free format: leading and spacing blanks are ignored.
  43. ;   - All parameters for a specific keyword should be on a single line.
  44. ;   - For unsupported keywords a warning message is issued.
  45. ;   - Of mutually exclusive options only the last will take effect.
  46. ;   - Lines with a valid keyword but without any parameter, are handled as
  47. ;     comment lines and are ignored.
  48. ;   - Empty lines or lines with '%', '*' or ';' as first non-blank character
  49. ;     are considered to contain comments only and are ignored.
  50. ;   - Invalid or not-recognised parameters may be ignored without notice.
  51. ;
  52. ;    Downsort can be invoked with a commandline parameter specifying another
  53. ;    than the default configuration filename 'Downsort.Cfg', for example:
  54. ;         DOWNSORT @SPECIAL.CFG
  55. ;    (the '@' prefix denotes that a configuration filespec is following)
  56. ;
  57. ; ────────────────────────────────────────────────────────────────────────
  58. ;
  59. ;    RegName  The name for which you registered, enclosed in double quotes.
  60. ;    -------  Unregistered use of Downsort is permitted for up to 45 days.
  61. ;             See the file 'Register.Doc' for registration instructions.
  62.  
  63.   RegName     "Rob Hamerling"
  64.  
  65. ; WaitTime    Maximum number seconds to wait on another Downsort.
  66. ; --------    Determines what to do if another active Downsort is running
  67. ;6.4          when this instance of Downsort is started:
  68. ;6.4            negative  - Proceed: ignore activity of other Downsorts
  69. ;6.4               0      - Terminate immediately (rc 640)
  70. ;6.4            positive  - Wait for at most this number of seconds.
  71. ;6.4                        Resume when no other Downsort(s) active anymore
  72. ;6.4                        within this period, otherwise terminate (rc 640).
  73. ;6.4          Default: -1
  74. ;6.4
  75. ;6.4          Note: Decision made after processing configuration file.
  76.  
  77. ; WaitTime    0
  78.  
  79. ; ──────────────────────────────────────────────
  80. ;  Specifications for the data collection phase
  81. ; ──────────────────────────────────────────────
  82. ;
  83. ; FareaDat     Path specification of your 'FAREA.DAT' file.
  84. ; --------     FAREA.DAT is built by Maximus' SILT[P] (-a, -af or -x option).
  85. ;              Default: FAREA.DAT in current directory, or otherwise in
  86. ;                       MAXIMUS base directory (environment var. 'Maximus').
  87.  
  88. ; FareaDat     d:\max3\farea.dat
  89.  
  90. ; AreaGroup    Defines a logical name for a group of fileareas or divisions.
  91. ; ---------    AreaGroups are used to build lists for groups of fileareas.
  92. ;              With AreaINclude and or AreaEXclude keywords following this
  93. ;              AreaGroup keyword, the collection of areas for this group
  94. ;              is defined. The groups are independent: areas may be member
  95. ;              of more than one group, other areas may not be in any group.
  96. ;              A new AreaGroup keyword closes the previous.
  97. ;              During data collection only the required areas are scanned.
  98. ;              WARNING: If at least one list does NOT specify an areagroup,
  99. ;                       file info of ALL area's is collected, which may
  100. ;                       significantly downgrade the performance of Downsort,
  101. ;                       especially when CDROM drives are involved!
  102. ;              NOTE: Areagroups are only meaningful in combination with a
  103. ;                    '-S' specification on an xxxFileList line (see below)!
  104.  
  105. ; AreaINclude  Select areas to be INCLUDED in the group.
  106. ; AreaEXclude  Select areas to be EXCLUDED from the group.
  107. ; -----------  Character strings define which filedivisions and/or
  108. ;              fileareas have to be INcluded in or EXcluded from the group.
  109. ;              The strings are used as PREFIX. All areanames that start with
  110. ;              the specified string are considered 'matching' the
  111. ;              specification. The FULLY QUALIFIED areanames (including
  112. ;              FileDivision prefixes!) are considered.
  113. ;              You may specify multiple strings on a line, separated by one
  114. ;              or more blanks, and as many lines as needed. AreaINclude
  115. ;              and AreaEXclude keywords may appear in any sequence in
  116. ;              an AreaGroup. All comparisons are case-INsensitive.
  117. ;
  118. ;              The following rules determine which areas will be member of
  119. ;              an AreaGroup:
  120. ;              - If only areaINclude is specified for a group, then ONLY
  121. ;                the areas of which the name matches with any areaINclude
  122. ;                string will be member of this group.
  123. ;              - If only areaEXclude is used for a group then ALL areas
  124. ;                will be included EXCEPT those areas of which the name
  125. ;                matches with any areaEXclude string.
  126. ;              - If both areaINclude and areaEXclude are specified for a
  127. ;                group, then all areaINcludes precede any areaEXclude.
  128. ;              - If neither areaINclude nor areaEXclude is specified
  129. ;                then the group is empty.
  130.  
  131. ;              Hints for the use of AreaGroups:
  132. ;              - If you don't use areaINclude, you probably want to
  133. ;                areaEXclude 'Sysop', 'Upload', 'Inbound', etc.
  134. ;                More generally: remember to areaEXclude those areas that
  135. ;                you normally want to hide for all users!
  136. ;              - You would normally use one of both keywords. Using them
  137. ;                both is only meaningful if the areaEXclude strings are
  138. ;                more restrictive (longer) then the areaINclude strings.
  139. ;                See for an example the AreaGroup 'HOB' below:
  140. ;                Suppose you have fileareas named HC000 to HC999
  141. ;                in a filedivision Hob (denoting the HOBBES CDROM),
  142. ;                then the group HOB would select the files from
  143. ;                areas HC000 to HC039, but NOT those ending with a '9'.
  144. ;              - 'CDROM NoList' has precedence over AreaInclude!
  145.  
  146.   AreaGroup  OS2
  147.      AreaINclude  OS2. FW.
  148.   AreaGroup  nonOS2
  149.      AreaEXclude  OS2. FW. SYSOP. UPLOAD INBOUND
  150. ; AreaGroup  HOB
  151. ;    AreaINclude  Hob.hc00  Hob.hc01  Hob.hc02  Hob.hc03
  152. ;    AreaEXclude  Hob.hc009 Hob.hc019 Hob.hc029 Hob.hc039
  153.  
  154. ; FileEXclude  Select FILES to be excluded from all(!) lists.
  155. ; -----------  By default all files in all (selected) areas will be
  156. ;              included, unless you use this keyword.
  157. ;              Specify 8.3 filename.ext type of strings, wildcards are
  158. ;              allowed and honored. Don't specify quotes.
  159. ;              The selection is case-insensitive and is independent of area.
  160. ;              You may specify multiple filespecs on a line, separated
  161. ;              by one or more blanks, and as many lines as needed.
  162.  
  163.   FileExclude  FILES.*    *.BAK        SYSTEM*.?BS   DIR.?BS
  164.   FileExclude  00INDEX.*  WILDCAT.TXT  DESCRIPT.ION  TEST*.*
  165.  
  166. ; CDROM        Areas that are located on CDROM can be handled differently
  167. ; -----        than areas on other media. A Filearea must have been
  168. ;              specified for Maximus with "Type CD" to be recognised
  169. ;              as such by Downsort.
  170. ;              One of two values is accepted:
  171. ;                NoScan  - No directory-scan will be performed.
  172. ;                          Filenames and the description in Files.Bbs will
  173. ;                          be included in the lists.
  174. ;                          When the area is specified with "Type CD DateList"
  175. ;                          and Files.Bbs contains filesize and filedate,
  176. ;                          the values of Files.Bbs will be used.
  177. ;                          Otherwise files will be reported as 'offline',
  178. ;                          filedate will be '01 Jan 1980' and filesize 0.
  179. ;                NoList  - CDROM-areas will be completely ignored.
  180. ;
  181. ;              Default: no special handling of CDROM-areas.
  182.  
  183. ; CDROM  NoScan
  184.  
  185. ; DIZimport    Import a file-description from the file File_Id.Diz in
  186. ; ---------    an archive. This will become the description in all lists.
  187. ;                No     - No import, leave descr. asis (even when missing!)
  188. ;                Yes    - Import only when no description in Files.Bbs
  189. ;                Force  - Import always: substitute existing description
  190. ;                nn     - Numeric value for the length of the existing
  191. ;                         description to force import of File_Id.Diz
  192. ;                         (if length smaller than nn then force import)
  193. ;              Default: No
  194.  
  195. ; DIZimport    No
  196.  
  197. ; CompressCfg  Filespec of configuration file for archive utilities.
  198. ; -----------  It can be the same as used by Maximus and Squish for archiver
  199. ;6.4           specifications. An optimised file 'Compress.Dwn' is provided.
  200. ;              The file is only needed with DIZimport activity.
  201. ;              See Maximus or Squish documentation for specification details.
  202. ;              Default: Compress.Cfg in current directory, or otherwise in
  203. ;                       Maximus base directory (environment var. 'Maximus').
  204. ;6.4                    If not found, DizImport is effectively 'No'.
  205.  
  206.   CompressCfg  Compress.Dwn
  207.  
  208.  
  209. ;  ───────────────────────────────────────────────────────────────────────
  210. ;  List-specifications with a global scope,
  211. ;  common parameters that apply to all lists.
  212. ;  ───────────────────────────────────────────────────────────────────────
  213. ;  Title:      Short string that will be displayed in BLOCK-characters
  214. ;  -----       on top of NEW, TOP, IPF, IPN, GBL and ALL, but not in
  215. ;              BBS, ORP, DUP, USR and FILES.BBS.
  216. ;              An unlimited number of 'Title'-lines may be specified.
  217. ;              The '`'-character (reverse quote) is translated into a half
  218. ;              width space, the '~'-character into a full width space.
  219. ;              Default: <none>
  220.  
  221.   Title        ~DownSort
  222.   Title        ~~~from
  223.   Title        ~Holland
  224.  
  225. ;  PreTitle    Lines to be displayed immediately before the BLOCK-title.
  226. ;  --------    The lines will be copied as is. Leading blanks will be
  227. ;              skipped, no wrapping or truncation will be applied for
  228. ;              'long' lines. '~' (tilde) characters are translated to blanks
  229. ;              An unlimited number of PreTitle lines may be specified.
  230. ;              Empty PreTitle lines are ignored. To space lines in your
  231. ;              headers specify a PreTitle with a tilde.
  232.  
  233.   PreTitle     ~
  234.   PreTitle     ~~~~~~~<─────────── P R E S E N T I N G ─────────────>
  235.   PreTitle     ~
  236.  
  237. ;  SubTitle    Lines to be displayed below the BLOCK-title.
  238. ;  --------    The same rules apply as for PreTitle.
  239. ;              Note: If an include file is specified on the xxxFileList
  240. ;              line, then this is inserted between block title and subtitle!
  241. ;              Default: <none>
  242.  
  243.   SubTitle     ~
  244.   SubTitle     ~<────────────────────────────────────────────────────────>
  245.   SubTitle     ~  Overview of downloadable files on this magnificent BBS
  246.   SubTitle     ~<────────────────────────────────────────────────────────>
  247.   SubTitle     ~
  248.  
  249. ;  BottomLine  Lines to be displayed at the end of the filelist.
  250. ;  ----------  The same rules apply as for PreTitle.
  251. ;              Default: <none>
  252.  
  253.   BottomLine   ~
  254.   BottomLine   ~~~~~~<──── How do you like DOWNSORT, folks? ────>
  255.   BottomLine   ~
  256.  
  257. ; DupNameSize  Indicates the number of characters of the fileNAME that are
  258. ; -----------  maximally to be compared to consider a name 'duplicate'.
  259. ;              Allows version numbers to be detected, for example:
  260. ;              with "DupNameSize 7" DWNSRT63.ZIP and DWNSRT64.ZIP will
  261. ;              appear as duplicates in the DupFileList report.
  262. ;              Default: 8
  263.  
  264. ; DupNameSize  8
  265.  
  266. ; NonDupEXT    Suppress reporting as 'duplicate' if 2 files with equal
  267. ; ---------    filenames but unequal extensions are defined as 'pair'.
  268. ;              The example specification below has the effect that files of
  269. ;              any pair "xyz.SDA" and "xyz.SDN"  ("xyz": any filename) will
  270. ;              not be listed in DupFileList.
  271. ;               -  Files with equal filename AND equal extension will
  272. ;                  still be reported as duplicate even when the extension
  273. ;                  is one of a 'NonDupEXT' pair!
  274. ;               -  Multiple extensions must be specified in as many pairs
  275. ;                  as can be formed (3 extension 3 pairs; 4 ext. 6 pairs;
  276. ;                  etc, e.g: for Nodelists:  DAT EXT  DAT IDX  EXT IDX).
  277. ;              You may specify multiple extension-pairs on a line
  278. ;              (separate the extensions with blanks), and as many lines
  279. ;              as needed. Wildcards are not supported.
  280. ;              Default: no suppression
  281.  
  282.   NonDupEXT    SDN SDA ZIP ARJ JPG GIF
  283.  
  284. ; OrphanDesc   Description text of 'orphan' (file without entry in FILES.BBS)
  285. ; NotFoundDesc Description text of file without description in FILES.BBS.
  286. ; ------------ The description will replace the default text.
  287. ;              Up to 45 characters may be specified.
  288.  
  289. ; OrphanDesc   ********  Orphan  *********
  290. ; NotFoundDesc *** Missing description ***
  291.  
  292. ; OfflineDesc  When a filespecification is found in FILES.BBS but the file
  293. ; -----------  is not found in the corresponding download directory, this
  294. ;              text replaces the filesize and date (right aligned).
  295. ;              Up to 14 characters are accepted.
  296.  
  297.   OfflineDesc  [-archived-]
  298.  
  299. ; AVAstrip     You may wish to strip off AVATAR graphics characters from
  300. ; --------     the contents of your FILES.BBS files.
  301. ;              Specify 'No' to deactivate stripping
  302. ;              ==> Works ONLY for COMMENT lines in ALL- and IPF-lists.
  303. ;                  remember: comments are only listed with KEEPSEQ.
  304. ;              Default: Yes
  305.  
  306. ; AVAstrip     Yes
  307.  
  308. ; HighASCII    Downsort generates some high-ASCII characters in its titles
  309. ; --------     and headers. Specify 'No' if you don't want these. Special
  310. ;              characters will then be substituted by a low-ASCII equivalent.
  311. ;              Note: Applies only to text generated by Downsort,
  312. ;                    not to file-descriptions, included files, etc..
  313. ;              Default: Yes
  314.  
  315. ; HighASCII    Yes
  316.  
  317. ; LinkPathSubst  Link Path Substitution
  318. ;6.4           This allows use of HTMFileList on an Internet server with
  319. ;6.4           download facility by 'clicking' the filename.
  320. ;6.4           With the keyword LinkPathSubst Downsort replaces (part of) the
  321. ;6.4           original filepath by a prefix referencing an Internet resource.
  322. ;6.4           Specification of this keyword in combination with a matching
  323. ;6.4           path prefix, has 2 effects:
  324. ;6.4           - a hypertext link will be generated
  325. ;6.4           - specified first part of BBS-filepath is replaced by the
  326. ;6.4             Internet resource reference.
  327. ;6.4           In case of 'overlapping' original paths, specify the most
  328. ;6.4           significant strings first. See some examples below.
  329. ;6.4           In the reference string backslashes are replaced by slashes.
  330. ;6.4           Default: No hypertext links on file level.
  331. ;
  332. ;                prefix original path .. to be substituted by
  333. ;                ====================    ====================
  334. ; LinkPathSubst  d:\files                http://server1.bbs
  335. ; LinkPathSubst  e:\download             ftp://server2.dl
  336. ; LinkPathSubst  ..\files\               ftp://server1/diskF/files/
  337. ; LinkPathSubst  i:\cdrom                ///i:/cdrom
  338.  
  339. ; AreaOrder    Order in which areas have to be sorted in the lists.
  340. ;              Selection can be: Alpha   - Alphabetic order of areaname
  341. ;                                Group   - Group (FileDivision) order
  342. ;                                Include - order of areaINclude
  343. ;                                Keep    - Keep order of FAREA.DAT
  344. ;              Specify one of these type (first letter is sufficient).
  345. ;              Where areanames are involved in sorts, the sequence will be
  346. ;              according to AreaOrder. With 'Group' the areas will be sorted
  347. ;              alphabetically in sequence of the fully qualified areaname,
  348. ;              (including division prefixes), with 'Alpha' areas will be
  349. ;              in sequence of the unqualified areaname (ignoring divisions).
  350. ;              'Group' and 'Keep' will make division boundaries visible.
  351. ;              Note: 'Include' uses the AreaInclude specifications, which
  352. ;              are prefixes. Areas matching the same AreaInclude string
  353. ;              will be sorted in 'Keep' sequence.
  354. ;              Default: Group
  355.  
  356. ; AreaOrder    Group
  357.  
  358. ; ───────────────────────────────────────────────────────────────────────────
  359. ; Specification of individual List parameters.
  360. ; Some may override settings of the global common parameters.
  361. ; Abey this sequence: first global common, then specific parameters!
  362. ; ───────────────────────────────────────────────────────────────────────────
  363. ;
  364. ; xxxFileList:  Create a File lists of type 'xxx' (1 list per keyword)
  365. ;
  366. ; xxx ────┐          ┌── Specification of output
  367. ;         │          │
  368. ;         │          │        ┌── Additional options for
  369. ;                   │        │   each list individually:
  370. ;    ┌── ALL         │        │
  371. ;    ┌── BBS         │        │ -A     Alphabetic sort on filename
  372. ;    ┌── DUP         │        │ -Cn    Continuation-line indent
  373. ;    ┌── GBL         │        │ -D     Date sort (descending)
  374. ;    ┌── HTM         │        │ -F#    Font number for BLOCK title (1..5)
  375. ;    ┌── HTN         │        │ -G     Group (division) sort
  376. ;    ┌── IPF         │        │ -If    Imbed filespec
  377. ;    ┌── IPN         │        │ -K     Keep original FILES.BBS sequence
  378. ;    ┌── NEW         │        │ -O     Orphans to be reported / adopted
  379. ;    ┌── OK          │        │ -R     Remove 'not-found' file descriptions
  380. ;    ┌── ORP         │        │ -Sg    Select areagroup 'g'
  381. ;    ┌── TOP         │        │ -T[n]  Truncate file descriptions
  382. ;    ┌── USR         │        │ -Um    USRmodel logical name selection
  383. ;    │               │        │ -W[n]  Wrap file descriptions
  384. ;    │               │        │ -X     eXclude display of ACS in headers
  385. ;    │               │        │ nnn[P] entries limit: number or period
  386. ;    │               │        │        ('P' = Days | Weeks | Months)
  387. ;                           
  388. ;   ═══─═══════  ════════  ════════════════════════════════
  389. ;   xxxFileList  PathSpec [Option-1] [Option-2] . . . [Option-n]
  390. ;
  391. ;      The output 'PathSpec' is mandatory for each list.
  392. ;
  393. ;  The following options may be specified (in any sequence):
  394. ;     -A   sort files Alphabetically on filename (within area)
  395. ;     -D   sort files on Date/time of the files
  396. ;     -G   sort files on Group (division) name
  397. ;     -K   Keep sequence of files as they appear in FILES.BBS.
  398. ;          Note: not all sorts apply to all list types (but most do)
  399. ;
  400. ;     -Cn  Continuation Indentation of description: relative position
  401. ;          of description on second and following lines if wrapped
  402. ;          descriptions are used. 'n' will normally be the width of
  403. ;          a download counter field.
  404. ;          May be specified negative for left-indentation (e.g. -C-16)!
  405. ;
  406. ;     -F#  BLOCK title font. Choose for '#' a number from 1 to 5.
  407. ;          Valid numbers:   1 .. Simple font             (5x6 pattern)
  408. ;                           2 .. Pseudo-Stencil Font     (7x10 pattern)
  409. ;                           3 .. ROBoComputer Font       (7x8 pattern)
  410. ;                           4 .. Reversed Video RoboComp (7x8 pattern)
  411. ;                           5 .. Wide open font          (7x6 pattern)
  412. ;          See some samples of the fonts in the top of this file.
  413. ;          Default font is 3, which is hard coded in some parts of the lists.
  414. ;          By specification of '-F' or 'F0', you may suppress block titles
  415. ;          (maybe also on places where you still want 'm, experiment!).
  416. ;
  417. ;     -If  Imbed userfile ('f' is file-spec) immediately following the
  418. ;          block-title (if any). The contents of the file is included without
  419. ;          any translation, so beware of special characters and effects like
  420. ;          formatting (word-wrap) especially in IPF- and HTML-lists!
  421. ;          NOTEs: - does not apply to lists of 'Sysop'-type (like DUP, ORP)
  422. ;                 - BBSFileList imbeds always DOWNSORT.HDR and DOWNSORT.TRL
  423. ;
  424. ;     -O   Orphans to be reported in xxxFileList or adopted in FILES.BBS.
  425. ;          Definition: 'Orphans' are files in a download directory that
  426. ;          have no entry in the corresponding FILES.BBS.
  427. ;          The entries will get the 'OrphanDesc' and will be reported in any
  428. ;          xxxFileList when the flag -O is specified. But it has effect only
  429. ;          when also an ORPFileList is requested!
  430. ;          Default: orphans will NOT be listed or adopted.
  431. ;
  432. ;     -R   Remove 'offline' file-entries.
  433. ;          Definition: 'Offline' files have an entry in FILES.BBS, but are
  434. ;          not in the download directory of the corresponding area.
  435. ;          These files will be listed with 'offline' in the size/date field.
  436. ;          When you specify '-R' the file will not appear in the list, and
  437. ;          when specified on xxxFilePath, it will be removed from Files.Bbs.
  438. ;          Default: list and do not remove 'offline' file entries.
  439. ;
  440. ;     -Sg  Select AreaGroup for the list. 'g' should be a name defined with
  441. ;          AreaGroup keyword. The list will only contain areas of the
  442. ;          specified group. If the specified group is not defined the list
  443. ;          will be empty. If no group is selected the list will contain ALL
  444. ;          areas.
  445. ;          Default: Include all areas.
  446. ;
  447. ;     -T[n] Causes Truncation of long descriptions so that linelength will
  448. ;          not be exceeded and each file-entry will take just a single line.
  449. ;     -W[n] Causes Wrapping of long descriptions: the report will contain
  450. ;          as many lines as needed for the complete file description.
  451. ;          Both -T and -W may be followed by a number to specify the required
  452. ;          linelength (minimum 69, maximum 2000).
  453. ;6.4       Default 79 (ORP, DUP, IPF: 255; FILES.BBS, HTML: 1024)
  454. ;
  455. ;     -Um  USRmodel-name to be selected for USRFileList.
  456. ;          'm' should be the name of one of the specified USRmodel statements.
  457. ;          Default: nothing (no list generated).
  458. ;
  459. ;     -X   eXclude ACS reporting the area-headers.
  460. ;
  461. ;   nnn[P] Limit the number of file-entries to a maximum of 'nnn'.
  462. ;          If followed by Period-indicator ('D', 'W' or 'M') the list is
  463. ;          limited not by number, but by file-AGE in Days, Weeks or Months.
  464. ;          NOTEs: - the Period-letter does not apply to IPF-lists
  465. ;                 - ALL-lists can only be limited by period (not by number).
  466. ;                 - 'nnn' denotes maximum number of files on a VIEW-page.
  467.  
  468. ; AllFileList  Allfiles.Lst
  469. ; AllFileList  list\Allfiles.new   2m -a -w -f5 -x           -IDownsort.Inc
  470. ; AllFileList  list\Allfiles.hob      -k -W         -sHOB    -IDownsort.Inc
  471. ; AllFileList  list\Allfiles.dos      -k -W         -snonOS2 -IDownsort.Inc
  472. ; BbsFileList  list\Bulletin.bbs   3w -d -w     -x
  473. ; DupFileList  list\Dupes.psq
  474. ; GblFileList  list\GblFiles.psq      -a -w   -c6            -IDownsort.Inc
  475.   HtmFileList  list1\HTMfiles.htm     -a -w         -sOS2
  476. ; HtnFileList  list2\HTNfiles.htm 200 -k -w         -sOS2
  477. ; IpfFileList  list\Allfiles.Ipf  200 -k -w         -sOS2
  478. ; IpnFileList  list\Newfiles.Ipf   6w -g    -f1     -sOS2
  479. ; NewFileList  list\Newfiles.psq   2m -g -t -f2 -x -t -l1000
  480. ; OKFileList   list\Okfile.psq                               -iDownsort.mag
  481. ; OrpFileList  list\Orphans.psq       -g
  482. ; TopFileList  list\TOPfiles.psq   30 -a -w
  483.  
  484. ;  NOTE: The IPF-list has the format of an INPUT-file for the Information
  485. ;        Presentation Facility Compiler (IPFC).
  486. ;        It should be compiled with:  "IPFC  Allfiles.IPF  /INF".
  487. ;        This will produce a file called Allfiles.INF, which is ready
  488. ;        to be viewed with the command:   VIEW  Allfiles
  489. ;        Note: For copyright reasons the IPFC compiler is not distributed
  490. ;              with DOWNSORT. It can be obtained with the IBM program
  491. ;              development toolkit for OS/2, and is part of many OS/2
  492. ;              compilers.
  493.  
  494. ; ───────────────────────────────────────────────────────────────────────────
  495. ; USRFileList   Create a list of 'user format' lines with file information.
  496. ; -----------   It is designed to build batch-files for file maintenance.
  497. ;               The format of each line is a variable string. It is given a
  498. ;               name with the USRmodel keyword. The corresponding format is
  499. ;               the line immediately following the name (use no space-lines!).
  500. ;               The format-string may contain symbolic variables that will be
  501. ;               replaced by the actual value of file- or area-information
  502. ;               as follows:
  503. ;                %$ - ACS (Access Control String) of file area
  504. ;                %2 - duplicate file flag: '2' if duplicate file, '1' if not
  505. ;                %A - Areaname (fully qualified including division prefixes)
  506. ;                %C - file Creation date (fixed 8 characters)
  507. ;                %D - most recent of lastwrite and creation Date of file
  508. ;                %F - Filename.ext
  509. ;                %H - File-age in days
  510. ;                %N - Download count (from [nnn] in FILES.BBS file-desc)
  511. ;                %P - Path specification of the file's download directory
  512. ;                %S - file Size
  513. ;                %U - Unqualified areaname (without division prefix)
  514. ;                %W - file lastWrite date
  515. ;                %Z - file lastaccess date
  516. ;               Notes: - unknown symbolic variables are not substituted
  517. ;                      - to obtain '%' on the outputline specify: '%%'
  518. ;
  519. ;               A number of example statements as suggestions:
  520. ;               - The first USRmodel builds a batch file (REXX) to move
  521. ;                 Fernwood files from their original directory to a directory
  522. ;                 with areaname as the subdirectory-name of G:\Fernwood\.
  523. ;               - The second model will erase files older than 2 years but
  524. ;                 only when downloaded less than 5 times.
  525. ;               - The third model is a specification for a 'long' OKfile.
  526. ;               - The fourth model contains all symbolic variables
  527. ;                 supported by Downsort for USRFileList.
  528.  
  529.   USRmodel move
  530. move '%P%F G:\Fernwood\%U\'
  531.   USRmodel old
  532. if %H > 730 & %N < 5 then  erase '%P%F'   /* check filedate: %D */
  533.   USRmodel ok
  534. @%F %P%F
  535.   USRmodel all
  536. %%$=%$ %%2=%2 %%A=%A %%C=%C %%D=%D %%F=%F %%H=%H %%N=%N %%P=%P %%S=%S %%U=%U %%W=%W %%Z=%Z
  537.  
  538. ;  USRFileList  list2\usrlist1.cmd  -G  -Umove  -sOS2    -Idownsort.rex
  539. ;  USRFileList  list2\usrlist2.cmd  -G  -Uold            -Idownsort.rex
  540. ;  USRFileList  list2\usrlist3.OK   -a  -Uok
  541. ;  USRFileList  list2\usrlist4.all  -G  -Uall   -sOS2
  542.  
  543. ; ─────────────────────────────────────────────────────────────────────────
  544. ;  Below follow the specifications for manipulating/rebuilding FILES.BBS
  545. ; ─────────────────────────────────────────────────────────────────────────
  546. ; FILFilePath  - First parameter is [optional] PATH-specification of
  547. ; -----------    destination directory of generated 'FILES.BBS' files.
  548. ;                Use for the pathspec the format:  drive:\path\
  549. ;                If pathspec is specified the output-files will be called
  550. ;                "areaname.BBS" (any filedivision prefix removed). Long
  551. ;                areanames will be truncated to the first 8 characters.
  552. ;                If pathspec is not specified the MAXIMUS path specification
  553. ;                will be used (FileList parameter if used in Maximus'
  554. ;                FAREA.CTL, or otherwise Files.Bbs in the Download directory).
  555. ;              - Many but not all flags as defined for the other lists
  556. ;                apply to the FILES.BBS-output of Downsort, for example:
  557. ;                 - File-descriptions will be wrapped or truncated to
  558. ;                   lines with a maximum length of 1024 characters.
  559. ;                   Default: Wrap
  560. ;                 - Title specifications are ignored.
  561. ;                 - Entries can be sorted, but then you will loose your
  562. ;                   comments: -K (Keep sequence and comments!) is default.
  563. ;                 - Avatar codes will not be touched.
  564. ;              - When using group selection ('-Sg') and multiple FILFilePaths,
  565. ;                beware not to overwrite previous output (e.g. define and
  566. ;                use mutually exclusive groups, such as the OS2 and nonOS2
  567. ;                example above).
  568.  
  569. ;  FILFilePath   list3\   -a    -R
  570.  
  571. ; ────────────────────────────────────────────────────────────────────────
  572. ;
  573. ; End of sample Downsort.Cfg as provided with the orginal Downsort package.
  574. ;
  575.