home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SQFLO129.ZIP / SQFILTER.CFG < prev    next >
Text File  |  1995-06-04  |  21KB  |  601 lines
  1. ; SqFilter.Cfg
  2. ; ------------
  3. ; Sample configuration file for SqFilter.
  4. ; (C) Raphaël Vanney, 06/1995
  5. ;----------------------------------------------------------------------------
  6.  
  7. ;
  8. ; You can't use this file as-is. The first thing you have to do before
  9. ; using SqFilter is to customize this file to suit your needs and setup.
  10. ;
  11. ; First of all, SqFilter is completely case-insensitive.
  12. ; Do I need to say that lines begining with a ";" are comments ?
  13. ;
  14. ; SqFilter expects you to use the IBM-PC character set.
  15. ;
  16.  
  17. ;                        ┌─────────────────────┐
  18. ;                        │ Miscellaneous setup │
  19. ;                        └─────────────────────┘
  20.  
  21. ;
  22. ; The Include keyword lets you include files in your configuration file.
  23. ; This might be handy if you use several configuration files and don't
  24. ; want to duplicate common information such as areas definition. You would
  25. ; then move the areas definition to another file and 'Include' this file
  26. ; in your main configuration files.
  27. ; The Include keyword may appear anywhere in the configuration file,
  28. ; except within a template text and filter definitions (where it would
  29. ; be considered part of the text).
  30. ; Nested include files are allowed, without any reachable limit.
  31. ;
  32. ; The syntax is :
  33. ;
  34. ; Include <file_name>
  35. ;
  36. Include SqFMsgAr.Cfg
  37.  
  38. ;
  39. ; The following line tells SqFilter to output English text. SqFilter
  40. ; usually selects the proper language support based on your CONFIG.SYS
  41. ; settings, but you may still force the use of English using this
  42. ; keyword. The other available language is French (for which the
  43. ; keyword is 'français').
  44. ;
  45. English
  46.  
  47. ;
  48. ; The v128Ok keyword is used to tell SqFilter that this configuration
  49. ; file was made with version 1.28 changes in mind. This is meant to
  50. ; prevent older versions' users to have bad surprises when switching
  51. ; to version 1.28.
  52. ; If you are upgrading from a version previous to 1.28, you might check
  53. ; what's new with version 1.28 in the SqFilter.Doc file, search for the
  54. ; 'template' word in this file, and look at the 'template.doc' file.
  55. ;
  56. v128Ok
  57.  
  58. ;
  59. ; The Address keyword is used to define your network address. This address
  60. ; will be used as an originating address for messages generated by SqFilter.
  61. ; It is unadvisable to define several addresses : in such a situation, only
  62. ; the last one will be used by SqFilter.
  63. ;
  64. Address 2:320/215.9
  65.  
  66. ;
  67. ; LogLevel tells SqFilter which amount of log you will get in the log
  68. ; file, from 1 to 4. Any Log<x> parameter given on the command line will
  69. ; be overwritten by the value specified here. However, the value given
  70. ; on the command line will stay in effect until this one is met, so
  71. ; you may specify a log level 4 on the command line, and a log level
  72. ; 1 at the end of the configuration file. This would make SqFilter
  73. ; issue maximum logging during the configuration file processing, and
  74. ; minimal logging during the program processing.
  75. ; The default value is 1.
  76. ;    log level 1    = logs only start, end and processing errors
  77. ;              2    = also logs performance
  78. ;              3    = also logs number of messages read, filtered + memory
  79. ;              4    = also logs the list of areas, statistics options
  80. ;
  81. ; Values greater than 4 have the same effect than 4.
  82. ;
  83. LogLevel 4
  84.  
  85. ;
  86. ; The following defines the maximum size of the log file : it's such a
  87. ; PITA to have to shrink these log files periodically. SqFilter will
  88. ; make sure that the log file does not grow over this size by removing
  89. ; older statements. Don't be surprised if one day the first line of
  90. ; your log file looks strange, SqFilter does not check where it cuts
  91. ; the log file.
  92. ; The default value is 100kb. It can be set to anything between 1 and
  93. ; 2^31 bytes.
  94. ;
  95. ; Warning : the log file shrinking is quite a straight process : the
  96. ; program just moves the last LogSizeLimit bytes of the file to the
  97. ; begining of the file, then truncate the file. This may be a lengthy
  98. ; process if your log file is 10Mb in size !
  99. ;
  100. ; Though you can't disable this feature, setting this value high enough
  101. ; will prevent SqFilter from shrinking the log file.
  102. ;
  103. LogSizeLimit 64000
  104.  
  105. ;
  106. ; SquishUserNo tells SqFilter which lastread record it should use in the
  107. ; Squish *.SQL files. You should make sure that, if your reader uses this
  108. ; feature, it is set to use a different user no. The same applies if you
  109. ; run a BBS that uses the lastread information stored in Squish files.
  110. ; The default for SqFilter is 2. You may use anything between 0 and 64k.
  111. ;
  112. SquishUserNo 5
  113.  
  114. ;
  115. ; FidoUserNo tells SqFilter which user number to use to store last read
  116. ; information for Fido *.MSG message bases. The same comments made about
  117. ; SquishUserNo apply.
  118. ;
  119. FidoUserNo 5
  120.  
  121. ;
  122. ; HudsonUserNo tells SqFilter which user number to use to store last
  123. ; read information for Hudson message bases. The same comments made about
  124. ; SquishUserNo apply.
  125. ;
  126. HudsonUserNo 5
  127.  
  128. ;
  129. ; JAMUserName tells SqFilter which user name to use (this is necessary
  130. ; to retrieve the last read information). You may use any name you want
  131. ; (I recommend not to use a real user's name, though). The default is
  132. ; 'SqFilter'.
  133. ;
  134. JAMUserName SqFilter User Name
  135.  
  136. ;
  137. ; JAMUserCRC is another way of telling SqFilter which JAM user id to use.
  138. ; The JAM bases actually identify last read information by mean of the CRC
  139. ; of the user name. You may use hexadecimal numbers by using the '$' prefix,
  140. ; ie :
  141. ; JAMUserCRC $12a45b78
  142.  
  143. ;
  144. ; HudsonPath tells SqFilter where your Hudson message base is stored.
  145. ;
  146. HudsonPath e:\Lora\msgs
  147.  
  148. ;
  149. ; SquishMaxMsg sets the default maximum number of messages in an area.
  150. ; SqFilter will use this value when it needs to write to a message base
  151. ; for which the maximum number of messages has not been defined, or
  152. ; when it creates a new message base.
  153. ; The default value is 100. You may use any number between 1 and about
  154. ; 2 billions.
  155. ;
  156. SquishMaxMsg 200
  157.  
  158. ;
  159. ; LockMaxDelay tells SqFilter how long it should wait, at most, for
  160. ; a file to be available for a lock. If a file can't be locked when
  161. ; SqFilter needs to, it will try to lock it for the specified amount
  162. ; of time. If the file couldn't be locked during all that time,
  163. ; SqFilter will issue an error message and fail. The value represents
  164. ; hundreds of second. The default value is 2000 (twenty seconds).
  165. ; It is a good idea to increase this value is you plan to run other
  166. ; processes using the same bases as SqFilter, at the same time.
  167. ;
  168. LockMaxDelay 6000
  169.  
  170. ;
  171. ; PopupOnError. If this line is present, SqFilter will popup a window
  172. ; when it encounters an error. The popup window is displayed whatever
  173. ; you are doing (ie even if you are working on a PM program). The
  174. ; popup window is closed when you press a key, or after 10 minutes.
  175. ; This used to be the default behaviour, but seemed to cause problems
  176. ; with some setups.
  177. ; OS/2 version only.
  178. ;
  179. ; PopupOnError
  180.  
  181. ;
  182. ; The three optional next lines tell SqFilter what to put in the message
  183. ; header for statistics messages. There should not be quote marks, unless
  184. ; you want them to appear in the header's field.
  185. ;
  186. StatMsgFrom Zlika stat generator
  187. StatMsgTo Statistics lovers
  188. StatMsgSubject Statistics on recent messages
  189.  
  190. ;
  191. ; The AreasWrittenTo keyword lets you define a file where SqFilter will
  192. ; put a list of all the message areas where it wrote a message. The
  193. ; typical use for this is to have a message tosser process these areas
  194. ; after SqFilter has done its job.
  195. ; If the file already exists, SqFilter appends data to it rather than
  196. ; overwritting it.
  197. ;
  198. ; The syntax is :
  199. ;
  200. ; AreasWrittenTo <file_name>
  201. ;
  202. AreasWrittenTo c:\BBS\EchoToss.Log
  203.  
  204. ;                        ┌─────────────────────┐
  205. ;                        │ Message areas setup │
  206. ;                        └─────────────────────┘
  207.  
  208. ;
  209. ; Message areas definition using area file. Using an area file relieves
  210. ; you from the pain of manually defining your message areas. Many BBSs
  211. ; and mailers use or can generate an AREAS.BBS configuration file.
  212. ;
  213. ; The syntax is :
  214. ;
  215. ; AreaFile <areafile_type> <file_name>
  216. ;
  217. ; <areafile_type>
  218. ;    Type of area definition file. May be 'AreasBBS', 'Squish' or 'Lora'.
  219. ;
  220. ; <file_name>
  221. ;    Full path to the area definition file.
  222. ;
  223. AreaFile AreasBBS e:\Lora\Areas.BBS
  224. AreaFile Squish e:\Squish.Cfg
  225. AreaFile Lora e:\Lora\SysMsg.Dat
  226.  
  227. ;
  228. ; Manual message area definition. The areas are defined with exactly the
  229. ; same syntax as used by GoldEd. This should let some of you do some cut
  230. ; and past.
  231. ;
  232. ; For those who don't use GoldEd, here's the syntax :
  233. ;
  234. ; AREA <tag> <name> <format>[<type>] <path_name> [attributes]
  235. ;
  236. ; <tag>
  237. ;    Area tag. A short name used to identify the message area.
  238. ;
  239. ; <name>
  240. ;    The complete name of the message area. Unused by SqFilter.
  241. ;    Delimited with quote marks.
  242. ;
  243. ; <format>
  244. ;    Format of the message base. May be 'M' for Squish bases, 'F' for
  245. ;    fido *.MSG bases, 'J' for JAM bases or 'H' for Hudson bases.
  246. ;
  247. ; <type>
  248. ;    Optional. May be 'E' for Echomail, 'N' for NetMail, 'L' for local
  249. ;    mail. Defaults to Netmail.
  250. ;
  251. ; <path_name>
  252. ;    For Squish and JAM bases, path and file name, without extention.
  253. ;    For Hudson bases, board number.
  254. ;    For Fido *.MSG bases, directory where the messages are stored.
  255. ;
  256. ; <attributes>
  257. ;    Optional. Unused by SqFilter.
  258.  
  259. ;
  260. ; Squish areas :
  261. ;
  262. Area MyMsg          "Tous mes messages"           ME e:\test
  263. Area MyGames        "Messages about my games"     ME e:\doom
  264. Area Interest        "Maybe interesting messages"  ME e:\interest
  265. Area Wanted.Fr      "Allfix requests"             ME e:\Lora\Msgs\WantedFr
  266.  
  267. ;
  268. ; JAM area :
  269. ;
  270. Area JAMBase        "Base JAM"                    JE e:\JAMBase
  271.  
  272. ;
  273. ; Fido *.MSG area :
  274. ;
  275. Area NetMail        "NetMail"                     FN e:\lora\fido\netmail
  276.  
  277.  
  278. ;                         ┌────────────────────┐
  279. ;                         │ Filter definitions │
  280. ;                         └────────────────────┘
  281.  
  282. ;
  283. ; Begin defining a filter. You may define as many filters as you want.
  284. ; (Well, actually as many as your memory will allow).
  285. ;
  286. BeginFilter
  287. ;
  288. ; Definition of the areas to scan ; you may include any of the previously
  289. ; defined areas. Generic names (OS2*) are handled (only a _trailing_ "*"
  290. ; character is handled, though. "OS2*" is ok, but "*.FR" is _not_).
  291. ; Scan defines areas to scan, while UnScan defines areas not to scan among
  292. ; those previously specified by Scan commands. The 'To' area is automagi-
  293. ; cally unscanned.
  294. ;
  295.      Scan *
  296.      UnScan MyGames
  297.      UnScan Interest
  298.  
  299. ;
  300. ; The "To" line defines where the filtered messages will be put. There
  301. ; may only be one "To" line per filter.
  302. ;
  303. ; To <tag> [<max_msg>]
  304. ;
  305. ;    <tag> is an area tag that must have been previously defined in
  306. ;          areas definition.
  307. ;
  308. ;    <max_msg> defines the maximum number of messages that will be kept
  309. ;          in the destination base. Defaults to 'SquishMaxMsg'. Used
  310. ;          only in Squish message areas.
  311. ;
  312. ;                        Note to Squish users :
  313. ;                        ----------------------
  314. ; The Squish API includes a specification by which the program should
  315. ; always keep the number of messages in a Squish base under a maximum
  316. ; which is specified in the file header. SqFilter, in respect to this,
  317. ; always ensures that, when it writes a message in a Squish base, the
  318. ; actual number of messages does not grow over the maximum. The problem
  319. ; is that several programs (GoldEd, Lora) set this maximum to 0!
  320. ;
  321. ; If a <max_msg> value is specified, SqFilter will set the maximum
  322. ; number of messages in the destination base to that value, whatever
  323. ; it was before.
  324. ; If no <max_msg> value is specified, SqFilter won't modify the maximum
  325. ; number of messages, except if this maximum is set to 0, in which case
  326. ; SqFilter will set it to 'SquishMaxMsg'.
  327. ;
  328. ; Destination areas of the Squish type need not be packed or anything,
  329. ; so you may omit to define them in your mailing/packing software (still,
  330. ; you will need to define them in your reader configuration).
  331. ;
  332. ; Warning : if you specify 200 as the maximum number of messages, and
  333. ; the base contains 10000 messages (for any reason, such as a previous
  334. ; value of max_msg of 10000), SqFilter will need to delete 9800 messages
  335. ; before it may write to the base, which can be en extremely lengthy
  336. ; process, due to the file structure.
  337. ;
  338. ; The <max_msg> value is irrelevant to fido *.MSG, Hudson and JAM bases.
  339. ;
  340.      To MyMsg 100
  341.  
  342. ;
  343. ; Keyword definition
  344. ;
  345. ; SqFilter proceeds include and exclude lines in the same order they are
  346. ; found in the configuration file.
  347. ; The syntax for a filter line is as follows :
  348. ;
  349. ; Include|Exclude [<section>] <text>
  350. ;
  351. ; <section> is defined as
  352. ;    <section>=<section_keyword> [<section>]
  353. ;
  354. ;    valid <section_keyword>s are :
  355. ;    to        : search <text> in the 'To:' field
  356. ;    from      :    "      "    "  "  'From:' field
  357. ;    subject   :    "      "    "  "  'Subject:' field
  358. ;    message   :    "      "    "  "  message body
  359. ;    kludges   :    "      "    "  "  kludge lines
  360. ;    header    :    "      "    "  "  'To:', 'From:' and 'Subject:' fields
  361. ;    all       :    "      "    "  "  whole message
  362. ;    orgaddr   : matches <text> with the originating address. Unlike other
  363. ;                section keywords, orgaddr does not result in a string compare
  364. ;                but in an address match. The <text> must be a valid fidonet
  365. ;                address, where any field may be replaced with '*'.
  366. ;                Ex:
  367. ;                   include orgaddr "2:320/215.*"
  368. ;                   will include all messages that come from 2:320/215 and its
  369. ;                   points (2:320/215.1, etc...)
  370. ;    destaddr  : matches <text> with the destination address.
  371. ;
  372. ;    If no section is defined, it is set by default to All.
  373. ;    You may include any number of section_keyword's in one line.
  374. ;
  375. ;    WARNING : I've found that some messages coming from some systems
  376. ;    contain unrealistic addresses in the header. Don't be too surprised
  377. ;    if you get unexpected messages from a filter that uses the
  378. ;    'orgaddr' and 'destaddr' keywords. If you can, check the message's
  379. ;    header content ('I' key with GoldEd) before sending me a bug report.
  380. ;
  381. ; <text> may be any text delimited with quote marks.
  382. ;
  383. ; Example :
  384. ; ---------
  385. ; The following will include any message containing the text "Raphael
  386. ; Vanney", except those which's "to" field include "Raphael Vanney"
  387. ; (such messages are already filtered by my mailing software).
  388. ;
  389. ; This is specially handy for Internet newsgroups, where all messages
  390. ; are directed to All. Since, usually, the message body contains a
  391. ; reference to the original poster, this filter would find all answers
  392. ; to my messages.
  393. ;
  394.      Include All "Raphael Vanney"
  395.      Exclude To "Raphael Vanney"
  396.  
  397. ;
  398. ; End of the filter definition.
  399. ; The 'EndFilter' keyword is _not_ optional.
  400. ;
  401. EndFilter
  402.  
  403. ;
  404. ; Here's a filter specifically dedicated to DOOM players that don't want
  405. ; to hear about cheat codes but like new PWAD files, and DOOM news.
  406. ;
  407. BeginFilter
  408.      To MyGames 150
  409.      Scan GAMING
  410.      Scan JEUX.Fr
  411.  
  412.      Include Subject "DOOM"
  413.      Include Subject Message "PWad"
  414.      Exclude All "cheat"
  415. EndFilter
  416.  
  417. ;
  418. ; Now there's another for GalCiv users (the last 'exclude' line removes
  419. ; those messages that will be filtered by the first filter). We also take
  420. ; care of this twit guy "Joe Twit"
  421. ;
  422. BeginFilter
  423.      To MyGames 150
  424.      Scan OS2*
  425.      Scan Comp.Os.OS2*
  426.  
  427.      Include All "GalCiv"
  428.      Include All "Galactic Civilization"
  429.      Exclude From "Joe Twit"
  430.      Exclude All "Vanney"
  431. EndFilter
  432.  
  433. ;
  434. ; Now for a more generic search, we'll include anything that we think may
  435. ; be of interest to us.
  436.  
  437. ; this Pluma looks like a promising software
  438. BeginFilter
  439.      To Interest 200
  440.      Scan OS2*
  441.      Scan Comp.OS.OS2*
  442.  
  443.      Include All "Pluma"
  444.      Exclude All "Vanney"
  445.      Exclude From "Joe Twit"
  446. EndFilter
  447.  
  448. ; we'd like to read about our hardware
  449. BeginFilter
  450.      To Interest 200
  451.      Scan OS2HW
  452.      Scan Comp.OS.OS2.Setup
  453.      Scan Comp.OS.OS2.Multimedia
  454.  
  455.      Include All "soundblaster"
  456.      Include All "TekRAM"
  457.      Include All "DC680"
  458.      Include All "Panasonic"
  459.      Include All "CR-562B"
  460.      Include All "CR562B"
  461.  
  462.      Exclude All "Vanney"
  463.      Exclude From "Joe Twit"
  464. EndFilter
  465.  
  466. ;
  467. ; The stat keyword tells SqFilter to make statistics from the messages
  468. ; bases. It provides an easy way to to generate a "Top 10 message
  469. ; writers" listing. The syntax of the 'Stat' keyword is :
  470. ;
  471. ; Stat <fields> [<max_number>]
  472. ;
  473. ; where :
  474. ;    <fields>            = <field_keyword> [<fields>]
  475. ;    <field_keyword>     = From|To|Subject|PID
  476. ;                             From      : statistics on message senders
  477. ;                             To        : statistics on message recipients
  478. ;                             Subject   : statistics on message subjects
  479. ;                             PID       : statistics on the PID kludge
  480. ;    <max_number>        = maximum number of results to show. The default
  481. ;                          value is 10.
  482. ;
  483. ; Note that a filter needs not contain any Include/Exclude line if it
  484. ; includes Stat lines.
  485. ;
  486. ; What and who's hot nowadays in OS/2 related newsgroups ?
  487. ;
  488. BeginFilter
  489.      Scan comp.os.*
  490.      Stat From Subject
  491.      To Interest
  492. EndFilter
  493.  
  494. ;
  495. ; The StatFtr template defines the footer of statistic messages. It
  496. ; might be a good idea to include a tear line and an origin line in your
  497. ; footers.
  498. ;
  499. StatFtr
  500. --- SqFilter !
  501.  * Origin:  Zlika - Courbevoie, France, Europe, Terre, etc... ({LocalAddr})
  502. EndTxt
  503.  
  504. ;
  505. ; Well, you get the picture... :-)
  506. ;
  507.  
  508. ;                          ┌──────────────────┐
  509. ;                          │ File areas setup │
  510. ;                          └──────────────────┘
  511.  
  512. ;
  513. ; LoraFiles reads Lora SYSFILE.DAT file, which contains file areas
  514. ; information. Please note that, in order to be used by SqFilter,
  515. ; your areas should have been defined with a 'Short Name' in LSetup.
  516. ; The short name is hereafter used to select which areas are to be
  517. ; included in searches by the Allfix processor.
  518. ; Areas not properly defined in Lora will be listed in the log file.
  519. ;
  520. LoraFiles e:\Lora\SysFile.Dat
  521.  
  522. ;
  523. ; MaximusFiles reads Maximus' FILEAREA.CTL file, which contains file
  524. ; areas information.
  525. ;
  526. MaximusFiles FileArea.Ctl
  527.  
  528. ;
  529. ; Manual definition of the file areas. The syntax is :
  530. ;
  531. ; FileArea <tag> <description> <files_list> <files_path>
  532. ;
  533. ; where
  534. ;
  535. ; <tag>             : tag name of the file area
  536. ;
  537. ; <description>     : any text within quote marks
  538. ;
  539. ; <files_list>      : name of the file that contains file descriptions.
  540. ;                     Must be in the FILES.BBS format.
  541. ;
  542. ; <files_path>      : path where the files actually reside
  543. ;
  544. ;
  545. FileArea EXEMPLE "Exemple" e:\lora\files\info\files.bbs e:\lora\files\info\
  546. FileArea soft_bbs "Pour monter votre BBS ..."   h:\max\file\bbs_soft\files.bbs h:\max\file\bbs_soft\
  547. FileArea txt_bbs  "French_Connexion - BBSF ..." h:\max\file\bbs_txt\files.bbs h:\max\file\bbs_txt\
  548.  
  549. ;                  ┌─────────────────────────────────┐
  550. ;                  │ AllFix requests processor setup │
  551. ;                  └─────────────────────────────────┘
  552.  
  553. ;
  554. ; If you don't plan to use the Allfix filefind feature of SqFilter, just
  555. ; rem out the following Include. If you do plan to use this feature, you
  556. ; will need to edit the Afx.Cfg file to suit your needs.
  557. ;
  558. Include Afx.Cfg
  559.  
  560. ;                     ┌───────────────────────────┐
  561. ;                     │ New files announcer setup │
  562. ;                     └───────────────────────────┘
  563.  
  564. ;
  565. ; If you don't plan to use the New Files Announcer feature of SqFilter,
  566. ; just rem out the following Include. If you do want to use it, you will
  567. ; need to edit the NFA.Cfg file to suit your needs.
  568. ;
  569. Include NFA.Cfg
  570.  
  571. ;                        ┌─────────────────────┐
  572. ;                        │ Files listing setup │
  573. ;                        └─────────────────────┘
  574.  
  575. ;
  576. ; If you don't plan to use the All Files Listing feature of SqFilter,
  577. ; just rem out the following Include. If you do want to use it, you will
  578. ; need to edit the AFL.Cfg file to suit your needs.
  579. ;
  580. Include AFL.Cfg
  581.  
  582. ;                        ┌─────────────────────────────┐
  583. ;                        │ File areas statistics setup │
  584. ;                        └─────────────────────────────┘
  585.  
  586. ;
  587. ; If you don't plan to use the File Areas Statistics feature of SqFilter,
  588. ; just rem out the following Include. If you do want to use it, you will
  589. ; need to edit the FSt.Cfg file to suit your needs.
  590. ;
  591. Include FSt.Cfg
  592.  
  593. ;
  594. ; The following line is intentionally not-commented-out, so that SqFilter
  595. ; halts with an error if you run it without having edited this file :-)
  596.  
  597. Don't use this .CFG file before it's edited to suit your needs.
  598. ;
  599. ; That's all... for now !
  600. ;------------------------------------------------------------------------- EOF
  601.