home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 2 BBS
/
02-BBS.zip
/
sqfltro.zip
/
SQFILTER.CFG
< prev
next >
Wrap
Text File
|
1995-04-01
|
22KB
|
678 lines
; SqFilter.Cfg
; ------------
; Sample configuration file for SqFilter.
; (C) Raphaël Vanney, 04/1995
;----------------------------------------------------------------------------
;
; You can't use this file as-is. The first thing you have to do before
; using SqFilter is to customize this file to suit your needs and setup.
;
; First of all, SqFilter is completely case-insensitive.
; Do I need to say that lines begining with a ";" are comments ?
;
; SqFilter expects you to use the IBM-PC character set.
;
;
; Here's an overview of the content of this file :
; . Miscellaneous setup is where you will define various options
; regarding your system and SqFilter's behaviour.
; . Message areas setup is where you define your message areas. The
; message areas are the center of SqFilter's operation.
; . Filter definitions is where you define filters :-). If you are
; not interrested in SqFilter's filter and statistics features, you
; may skip (comment-out) this part.
; . File areas setup is where you define your file areas. If you don't
; plan to use any of the following features, you may skip (comment-out)
; this part.
; . AllFix requests processor setup is where you configure SqFilter's
; AllFix requests' processor. If you don't plan to use this feature,
; you may skip (comment-out) this part. If you don't know what this
; is all about, well maybe I will some day document it.
; . New files announcer setup lets you define options related to the
; new files annoucer.
; . Files listing setup is where you define if and how SqFilter is to
; generate a listing of the files on you system.
;
; ┌─────────────────────┐
; │ Miscellaneous setup │
; └─────────────────────┘
;
; The following line tells SqFilter to output English text. SqFilter
; usually selects the proper language support based on your CONFIG.SYS
; settings, but you may still force the use of English using this
; keyword.
;
English
;
; The Address keyword is used to define your network address.
; This should not be omitted if you use the Allfix requests processor
; feature.
;
Address 2:320/215.9
;
; LogLevel tells SqFilter which amount of log you will get in the log
; file, from 1 to 4. Any Log<x> parameter given on the command line will
; be overwritten by the value specified here. However, the value given
; on the command line will stay in effect until this one is met, so
; you may specify a log level 4 on the command line, and a log level
; 1 at the end of the configuration file. This would make SqFilter
; issue maximum logging during the configuration file processing, and
; minimal logging during the program processing.
; The default value is 1.
; log level 1 = logs only start, end and processing errors
; 2 = also logs performance
; 3 = also logs number of messages read, filtered + memory
; 4 = also logs the list of areas, statistics options
;
; Values greater than 4 have the same effect than 4.
;
LogLevel 4
;
; The following defines the maximum size of the log file : it's such a
; PITA to have to shrink these log files periodically. SqFilter will
; make sure that the log file does not grow over this size by removing
; older statements. Don't be surprised if one day the first line of
; your log file looks strange, SqFilter does not check where it cuts
; the log file.
; The default value is 100kb. It can be set to anythink between 1 and
; 2^31 bytes.
;
; Warning : the log file shrinking is quite a straight process : the
; program just moves the last LogSizeLimit bytes of the file to the
; begining of the file, then truncate the file. This may be a lengthy
; process if your log file is 10Mb in size !
;
LogSizeLimit 64000
;
; SquishUserNo tells SqFilter which lastread record it should use in the
; Squish *.SQL files. You should make sure that, if your reader uses this
; feature, it is set to use a different user no. The same applies if you
; run a BBS that uses the lastread information stored in Squish files.
; The default for SqFilter is 2. You may use anything between 0 and 64k.
;
SquishUserNo 5
;
; FidoUserNo tells SqFilter which user number to use to store last read
; information for Fido *.MSG message bases. The same comments made about
; SquishUserNo apply.
;
FidoUserNo 5
;
; HudsonUserNo tells SqFilter which user number to use to store last
; read information for Hudson message bases. The same comments made about
; SquishUserNo apply.
;
HudsonUserNo
;
; JAMUserName tells SqFilter which user name to use (this is necessary
; to retrieve the last read information). You may use any name you want
; (I recommend not to use a real user's name, though). The default is
; 'SqFilter'.
;
JAMUserName SqFilter User Name
;
; JAMUserCRC is another way of telling SqFilter which JAM user id to use.
; The JAM bases actually identify last read information by mean of the CRC
; of the user name. You may use hexadecimal numbers by using the '$' prefix,
; ie :
; JAMUserCRC $12a45b78
;
; HudsonPath tells SqFilter where your Hudson message base is stored.
;
HudsonPath e:\Lora\msgs
;
; SquishMaxMsg sets the default maximum number of messages in an area.
; SqFilter will use this value when it needs to write to a message base
; for which the maximum number of messages has not been defined, or
; when it creates a new message base.
; The default value is 100. You may use any number between 1 and about
; 2 billions.
;
SquishMaxMsg 200
;
; LockMaxDelay tells SqFilter how long it should wait, at most, for
; a file to be available for a lock. If a file can't be locked when
; SqFilter needs to, it will try to lock it for the specified amount
; of time. If the file couldn't be locked during all that time,
; SqFilter will issue an error message and fail. The value represents
; hundreds of second. The default value is 2000 (twenty seconds).
; It is a good idea to increase this value is you plan to run other
; processes using the same bases as SqFilter, at the same time.
;
LockMaxDelay 6000
;
; PopupOnError. If this line is present, SqFilter will popup a window
; when it encounters an error. The popup window is displayed whatever
; you are doing (ie even if you are working on a PM program). The
; popup window is closed when you press a key, or after 10 minutes.
; This used to be the default behaviour, but seemed to cause problems
; with some setups.
; OS/2 version only.
;
; PopupOnError
;
; The three optional next lines tell SqFilter what to put in the message
; header for statistics messages. There should not be quote marks, unless
; you want them to appear in the header's field.
;
StatMsgFrom Zlika stat generator
StatMsgTo Statistics lovers
StatMsgSubject Statistics on recent messages
; ┌─────────────────────┐
; │ Message areas setup │
; └─────────────────────┘
;
; Message areas definition using area file. Using an area file relieves
; you from the pain of manually defining your message areas. Many BBSs
; and mailers use or can generate an AREAS.BBS configuration file.
;
; The syntax is :
;
; AreaFile <areafile_type> <file_name>
;
; <areafile_type>
; Type of area definition file. May be 'AreasBBS' or 'Squish'.
;
; <file_name>
; Full path to the area definition file.
;
AreaFile AreasBBS e:\Lora\Areas.BBS
AreaFile Squish e:\Squish.Cfg
;
; Manual message area definition. The areas are defined with exactly the
; same syntax as used by GoldEd. This should let some of you do some cut
; and past.
;
; For those who don't use GoldEd, here's the syntax :
;
; AREA <tag> <name> <format>[<type>] <path_name> [attributes]
;
; <tag>
; Area tag. A short name used to identify the message area.
;
; <name>
; The complete name of the message area. Unused by SqFilter.
; Delimited with quote marks.
;
; <format>
; Format of the message base. May be 'M' for Squish bases, 'F' for
; fido *.MSG bases, 'J' for JAM bases or 'H' for Hudson bases.
;
; <type>
; Optional. May be 'E' for Echomail, 'N' for NetMail, 'L' for local
; mail. Defaults to Netmail.
;
; <path_name>
; For Squish and JAM base, path and file name, without extention.
; For Hudson bases, board number.
; For Fido *.MSG bases, directory where the messages are stored.
;
; <attributes>
; Optional. Unused by SqFilter.
;
; Squish areas :
;
Area MyMsg "Tous mes messages" ME e:\test
Area MyGames "Messages about my games" ME e:\doom
Area Interest "Maybe interesting messages" ME e:\interest
Area Wanted.Fr "Allfix requests" ME e:\Lora\Msgs\WantedFr
;
; JAM area :
;
Area JAMBase "Base JAM" JE e:\JAMBase
;
; Fido *.MSG area :
;
Area NetMail "NetMail" FN e:\lora\fido\netmail
; ┌────────────────────┐
; │ Filter definitions │
; └────────────────────┘
;
; Begin defining a filter. You may define as many filters as you want.
; (Well, actually as many as your memory will allow).
;
BeginFilter
;
; Definition of the areas to scan ; you may include any of the previously
; defined areas. Generic names (OS2*) are handled (only a _trailing_ "*"
; character is handled, though. "OS2*" is ok, but "*.FR" is _not_).
; Scan defines areas to scan, while UnScan defines areas not to scan among
; those previously specified by Scan commands. The 'To' area is automagi-
; cally unscanned.
;
Scan *
UnScan MyGames
UnScan Interest
;
; The "To" line defines where the filtered messages will be put. There
; may only be one "To" line per filter.
;
; To <tag> [<max_msg>]
;
; <tag> is an area tag that must have been previously defined in
; areas definition.
;
; <max_msg> defines the maximum number of messages that will be kept
; in the destination base. Defaults to 'SquishMaxMsg'. Used
; only in Squish message areas.
;
; Note to Squish users :
; ----------------------
; The Squish API includes a specification by which the program should
; always keep the number of messages in a Squish base under a maximum
; which is specified in the file header. SqFilter, in respect to this,
; always ensures that, when it writes a message in a Squish base, the
; actual number of messages does not grow over the maximum. The problem
; is that several programs (GoldEd, Lora) set this maximum to 0!
;
; If a <max_msg> value is specified, SqFilter will set the maximum
; number of messages in the destination base to that value, whatever
; it was before.
; If no <max_msg> value is specified, SqFilter won't modify the maximum
; number of messages, except if this maximum is set to 0, in which case
; SqFilter will set it to 'SquishMaxMsg'.
;
; Destination areas of the Squish type need not be packed or anything,
; so you may omit to define them in your mailing/packing software (still,
; you will need to define them in your reader configuration).
;
; Warning : if you specify 200 as the maximum number of messages, and
; the base contains 10000 messages (for any reason, such as a previous
; value of max_msg of 10000), SqFilter will need to delete 9800 messages
; before it may write to the base, which can be en extremely lengthy
; process, due to the file structure.
;
; The <max_msg> value is irrelevant to fido *.MSG, Hudson and JAM bases.
;
To MyMsg 100
;
; Keyword definition
;
; SqFilter proceeds include and exclude lines in the same order they are
; found in the configuration file.
; The syntax for a filter line is as follows :
;
; Include|Exclude [<section>] <text>
;
; <section> is defined as
; <section>=section_keyword [<section>]
;
; valid <section_keyword>s are :
; to : search string in the 'To:' field
; from : " " " " 'From:' field
; subject : " " " " 'Subject:' field
; message : " " " " message body
; kludges : " " " " kludge lines
; header : " " " " 'To:', 'From:' and 'Subject:' fields
; all : " " " " whole message
;
; If no section is defined, it is set by default to All.
; You may include any number of section_keyword's in one line.
;
; <text> may be any text delimited with quote marks.
;
; Example :
; ---------
; The following will include any message containing the text "Raphael
; Vanney", except those which's "to" field include "Raphael Vanney"
; (such messages are already filtered by my mailing software).
;
; This is specially handy for Internet newsgroups, where all messages
; are directed to All. Since, usually, the message body contains a
; reference to the original poster, this filter would find all answers
; to your messages.
;
Include All "Raphael Vanney"
Exclude To "Raphael Vanney"
;
; End of the filter definition.
; The 'EndFilter' keyword is _not_ optional.
;
EndFilter
;
; Here's a filter specifically dedicated to DOOM players that don't want
; to hear about cheat codes but like new PWAD files, and DOOM news.
;
BeginFilter
To MyGames 150
Scan GAMING
Scan JEUX.Fr
Include Subject "DOOM"
Include Subject Message "PWad"
Exclude All "cheat"
EndFilter
;
; Now there's another for GalCiv users (the last 'exclude' line removes
; those messages that will be filtered by the first filter). We also take
; care of this twit guy "Joe Twit"
;
BeginFilter
To MyGames 150
Scan OS2*
Scan Comp.Os.OS2*
Include All "GalCiv"
Include All "Galactic Civilization"
Exclude From "Joe Twit"
Exclude All "Vanney"
EndFilter
;
; Now for a more generic search, we'll include anything that we think may
; be of interest to us.
; this Pluma looks like a promising software
BeginFilter
To Interest 200
Scan OS2*
Scan Comp.OS.OS2*
Include All "Pluma"
Exclude All "Vanney"
Exclude From "Joe Twit"
EndFilter
; we'd like to read about our hardware
BeginFilter
To Interest 200
Scan OS2HW
Scan Comp.OS.OS2.Setup
Scan Comp.OS.OS2.Multimedia
Include All "soundblaster"
Include All "TekRAM"
Include All "DC680"
Include All "Panasonic"
Include All "CR-562B"
Include All "CR562B"
Exclude All "Vanney"
Exclude From "Joe Twit"
EndFilter
;
; The stat keyword tells SqFilter to make statistics from the messages
; bases. It provides an easy way to to generate a "Top 10 message
; writers" listing. The syntax of the 'Stat' keyword is :
;
; Stat <fields> [<max_number>]
;
; where :
; <fields> = <field_keyword> [<fields>]
; <field_keyword> = From|To|Subject|PID
; From : statistics on message senders
; To : statistics on message recipients
; Subject : statistics on message subjects
; PID : statistics on the PID kludge
; <max_number> = maximum number of results to show. The default
; value is 10.
;
; Note that a filter needs not contain any Include/Exclude line if it
; includes Stat lines.
;
; What and who's hot nowadays in OS/2 related usegroups ?
;
BeginFilter
Scan comp.os.*
Stat From Subject
To Interest
EndFilter
;
; Well, you get the picture... :-)
;
; ┌──────────────────┐
; │ File areas setup │
; └──────────────────┘
;
; LoraFiles reads Lora SYSFILE.DAT file, which contains file areas
; information. Please note that, in order to be used by SqFilter,
; your areas should have been defined with a 'Short Name' in LSetup.
; The short name is hereafter used to select which areas are to be
; included in searches by the Allfix processor.
; Areas not properly defined in Lora will be listed in the log file.
;
LoraFiles e:\Lora\SysFile.Dat
;
; MaximusFiles reads Maximus' FILEAREA.CTL file, which contains file
; areas information.
;
MaximusFiles FileArea.Ctl
;
; Manual definition of the file areas. The syntax is :
;
; FileArea <tag> <description> <files_list> <files_path>
;
; where
;
; <tag> : tag name of the file area
;
; <description> : any text within quote marks
;
; <files_list> : name of the file that contains file descriptions.
; Must be in the FILES.BBS format.
;
; <files_path> : path where the files actually reside
;
;
FileArea EXEMPLE "Exemple" e:\lora\files\info\files.bbs e:\lora\files\info\
FileArea soft_bbs "Pour monter votre BBS ..." h:\max\file\bbs_soft\files.bbs h:\max\file\bbs_soft\
FileArea txt_bbs "French_Connexion - BBSF ..." h:\max\file\bbs_txt\files.bbs h:\max\file\bbs_txt\
; ┌─────────────────────────────────┐
; │ AllFix requests processor setup │
; └─────────────────────────────────┘
;
; AfxScan tells SqFilter's Allfix request processor which file areas
; should be scanned for files.
;
;
; AfxScan <area_tag>
;
; where <area_tag> is the <tag> defined in 'FileArea' or the 'short
; name' in Lora, or the number in FILEAREA.CTL.
;
; Generic names are handled the same way as in the previously defined
; 'SCAN' keyword.
;
AfxScan Info
AfxScan DOS*
AfxScan OS2*
AfxScan Pascal
AfxScan Divers
;
; AfxMaxAnswers defines a limit to the number of file descriptions that
; will be sent in response to a request. The default value is 20, and
; the value may range from 1 to 64k.
;
AFxMaxAnswers 20
;
; AfxMaxDescLines puts a limit to how many lines of descriptions are
; allowed for one file. The default value is 5, and the value may range
; from 1 to 64k.
;
AfxMaxDescLines 5
;
; AfxReqArea defines in which message area the Allfix requests are to be
; searched. Requests are identified by a 'To:' field containing 'Allfix'
; or 'SqFltr'. This message area must have been previously defined by an
; 'Area' or 'AreaFile' keyword.
; If this keyword is not defined, the Allfix request processor is
; disabled.
;
AfxReqArea Wanted.Fr
;
; AfxAnsArea defines the message area where the answers will be sent.
;
AfxAnsArea MyMsg
;
; AfxFoundHdr defines the header of a response. The text ends with
; the 'EndTxt' keyword.
;
AfxFoundHdr
Found at : Zlika
SysOp : Raphaël Vanney
Location : Courbevoie, France
Phone # : +33-1-47748723
Max. speed : 14400
Open hours : from 10am to 7pm on weekdays
EndTxt
;
; AfxFoundFtr defines the footer of response messages.
;
AfxFoundFtr
You may freely download these files.
F'req SQFLTRO for the last OS/2 version of SqFilter, SQFLTRD for DOS.
EndTxt
; ┌───────────────────────────┐
; │ New files announcer setup │
; └───────────────────────────┘
;
; NFAScan defines which file areas should be scanned for new files. If
; no area is specified through NFAScan, the new files annoucement feature
; of SqFilter is disabled.
;
NFAScan DOS*
NFAScan OS2*
NFAScan Exemple
; Maximus' area scan :
NFAScan 1
;
; NFAUnscan defines file areas not to scan from those defined within
; a previous NFAScan command.
;
NFAUnScan DOSOutil
;
; NFAAnnounce defines in which message area new files announcements
; should be made. If this area is not defined while some areas have
; been tagged with the 'NFAScan' keyword, SqFilter will halt with
; an error.
;
NFAAnnounce Interest
;
; NFAMessageHdr defines the header of the file annoucement messages.
;
NFAMessageHdr
The following files recently made their way to Zlika :
EndTxt
;
; NFAMessageFtr defines the footer of the file announcement messages
;
NFAMessageFtr
These files may be freely downloaded from 10am to 7pm on weekdays.
EndTxt
;
; NFAMemoSize tells SqFilter how many announced new files should be
; remembered (so as not to re-announce them). A good value would be
; something slightly greater than the actual number of files listed
; in all your file areas.
; The default value is 1000, the maximum is 16300.
; DOS systems with low memory may experience problems with too great
; values for this parameter.
;
NFAMemoSize 1000
; ┌─────────────────────┐
; │ Files listing setup │
; └─────────────────────┘
;
; AFLFileHdr is the header that will be put at the beginning of the
; files listing.
;
AFLFileHdr
╔══════════════════════════════════════╗
║ List of all available files on Zlika ║
╚══════════════════════════════════════╝
EndTxt
;
; AFLFileFtr is the footer that will be apended at the end of the
; files listing.
;
AFLFileFtr
────
These files may be freely downloaded.
Zlika is open from 10am to 7pm on weekdays.
EndTxt
;
; AFLScan tells SqFilter which file areas will be included in the
; files listing.
;
AFLScan *
;
; AllFilesListing tells SqFilter the name of the file to which it
; will list the files. There is no default for this keyword ; if it
; is not used, no files listing is generated.
;
AllFilesListing e:\Lora\Files\Allfiles.Lst
;
; The following line is intentionally not-commented-out, so that SqFilter
; halts with an error if you run it without having edited this file :-)
Don't use this .CFG file before it's edited to suit your needs.
;
; That's all... for now !
;------------------------------------------------------------------------- EOF