home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 2 BBS
/
02-BBS.zip
/
sqflo130.zip
/
SQFILTER.CFG
< prev
next >
Wrap
Text File
|
1995-07-02
|
22KB
|
606 lines
; SqFilter.Cfg
; ------------
; Sample configuration file for SqFilter.
; (C) Raphaël Vanney, 06/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.
;
; ┌─────────────────────┐
; │ Miscellaneous setup │
; └─────────────────────┘
;
; The Include keyword lets you include files in your configuration file.
; This might be handy if you use several configuration files and don't
; want to duplicate common information such as areas definition. You would
; then move the areas definition to another file and 'Include' this file
; in your main configuration files.
; The Include keyword may appear anywhere in the configuration file,
; except within a template text and filter definitions (where it would
; be considered part of the text).
; Nested include files are allowed, without any reachable limit.
;
; The syntax is :
;
; Include <file_name>
;
Include SqFMsgAr.Cfg
;
; 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. The other available language is French (for which the
; keyword is 'français').
;
English
;
; The v128Ok keyword is used to tell SqFilter that this configuration
; file was made with version 1.28 changes in mind. This is meant to
; prevent older versions' users to have bad surprises when switching
; to version 1.28.
; If you are upgrading from a version previous to 1.28, you might check
; what's new with version 1.28 in the SqFilter.Doc file, search for the
; 'template' word in this file, and look at the 'template.doc' file.
;
v128Ok
;
; The Address keyword is used to define your network address. This address
; will be used as an originating address for messages generated by SqFilter.
; It is unadvisable to define several addresses : in such a situation, only
; the last one will be used by SqFilter.
;
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 anything 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 !
;
; Though you can't disable this feature, setting this value high enough
; will prevent SqFilter from shrinking the log file.
;
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 5
;
; 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
;
; The AreasWrittenTo keyword lets you define a file where SqFilter will
; put a list of all the message areas where it wrote a message. The
; typical use for this is to have a message tosser process these areas
; after SqFilter has done its job.
; If the file already exists, SqFilter appends data to it rather than
; overwritting it.
;
; The syntax is :
;
; AreasWrittenTo <file_name>
;
AreasWrittenTo c:\BBS\EchoToss.Log
; ┌─────────────────────┐
; │ 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', 'Squish' or 'Lora'.
;
; <file_name>
; Full path to the area definition file.
;
AreaFile AreasBBS e:\Lora\Areas.BBS
AreaFile Squish e:\Squish.Cfg
AreaFile Lora e:\Lora\SysMsg.Dat
;
; 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 bases, 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>] [move]
;
; <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.
;
; move tells SqFilter to MOVE the messages that are filtered rather
; than copy them (original messages will be deleted). Deleting
; messages currently works with Squish and Hudson bases. This
; has not been thoroughly tested, so use it with caution.
;
; 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 <text> 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
; orgaddr : matches <text> with the originating address. Unlike other
; section keywords, orgaddr does not result in a string compare
; but in an address match. The <text> must be a valid fidonet
; address, where any field may be replaced with '*'.
; Ex:
; include orgaddr "2:320/215.*"
; will include all messages that come from 2:320/215 and its
; points (2:320/215.1, etc...)
; destaddr : matches <text> with the destination address.
;
; If no section is defined, it is set by default to All.
; You may include any number of section_keyword's in one line.
;
; WARNING : I've found that some messages coming from some systems
; contain unrealistic addresses in the header. Don't be too surprised
; if you get unexpected messages from a filter that uses the
; 'orgaddr' and 'destaddr' keywords. If you can, check the message's
; header content ('I' key with GoldEd) before sending me a bug report.
;
; <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 my 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 newsgroups ?
;
BeginFilter
Scan comp.os.*
Stat From Subject
To Interest
EndFilter
;
; The StatFtr template defines the footer of statistic messages. It
; might be a good idea to include a tear line and an origin line in your
; footers.
;
StatFtr
--- SqFilter !
* Origin: Zlika - Courbevoie, France, Europe, Terre, etc... ({LocalAddr})
EndTxt
;
; 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 │
; └─────────────────────────────────┘
;
; If you don't plan to use the Allfix filefind feature of SqFilter, just
; rem out the following Include. If you do plan to use this feature, you
; will need to edit the Afx.Cfg file to suit your needs.
;
Include Afx.Cfg
; ┌───────────────────────────┐
; │ New files announcer setup │
; └───────────────────────────┘
;
; If you don't plan to use the New Files Announcer feature of SqFilter,
; just rem out the following Include. If you do want to use it, you will
; need to edit the NFA.Cfg file to suit your needs.
;
Include NFA.Cfg
; ┌─────────────────────┐
; │ Files listing setup │
; └─────────────────────┘
;
; If you don't plan to use the All Files Listing feature of SqFilter,
; just rem out the following Include. If you do want to use it, you will
; need to edit the AFL.Cfg file to suit your needs.
;
Include AFL.Cfg
; ┌─────────────────────────────┐
; │ File areas statistics setup │
; └─────────────────────────────┘
;
; If you don't plan to use the File Areas Statistics feature of SqFilter,
; just rem out the following Include. If you do want to use it, you will
; need to edit the FSt.Cfg file to suit your needs.
;
Include FSt.Cfg
;
; 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