home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 2 BBS
/
02-BBS.zip
/
gpm108b.zip
/
English
/
Events.CFG
< prev
next >
Wrap
Text File
|
2000-04-26
|
12KB
|
284 lines
;*===========================================================================*
;* General Purpose Mailer. FTN-compatible Extended-Binkley-Style mailer *
;* for OS/2 Warp with multiline support and Presentation Manager GUI. *
;* Written by Igor Vanin (2:5030/448@fidonet, vanin@gpmail.spb.ru) *
;*===========================================================================*
;* Events and Processes setup *
;*===========================================================================*
; Instructions for Outbound and Event Manager start with "Event" and
; "Process" keywords. The Event Manager works in parallel with other mailer
; activities, so that all commands are executed on schedule with no delays.
;
; Process is an action performed under certain conditions, for example
; after receiving echomail or after session is finished. Processes are defined
; with strings like:
;
; Process [<when>] <condition> <action>
;
; <Action> field defines an action. Available actions are below.
;
; <Condition> field defines condition, under which the process is started.
; It may have the following values:
;
; *) Startup -- started once upon mailer start up.
;
; *) Arcmail -- started after receiving echomail.
;
; *) Netmail -- started after receiving uncompressed netmail (*.PKT files).
;
; *) Mail -- started after receiving echomail or uncompressed netmail
; (may be used instead of Arcmail and Netmail).
;
; *) TIC -- started after receiving *.TIC files, which accompany
; files from fileechoes.
;
; *) Session -- started after session is over.
;
; *) File <filename> -- started after receiving <filename> file.
; ('?' and '*' wildcards are allowed)
;
; *) BBS -- started when BBS is requested.
;
; *) NoModem -- started if modem initialization was unsuccessful.
;
; *) Flag <flagname> -- started when <flagname> file appeared on disk. This file
; is deleted after starting the process. Flag files are
; checked once a minute.
;
; *) ModemSays <keyword> -- started if <keyword> modem response is received while
; waiting for a call or connect. After the process is
; finished, mailer operates in ordinary way.
;
; *) External In <string> -- started if <string> is received from remote
; during handshake (so called external mailer). This
; action is performed instead of the FTN-session.
;
; *) External Out <addr_list> -- started after connecting to an address from the
; <addr_list>. If an external process is started with
; action and errorlevel <> 0 is returned, then the poll
; for this address is removed.
;
; *) View -- started for viewing a file from the Outbound Editor.
; For example you may place the "Exec" command here.
; The filename is specified by the *F macro.
;
;
; For certain processes the <when> field may be defined. It can be set to
; "After", "Online" or "Immediate". For processes like Arcmail, Netmail, TIC or
; File <filename> they mean the following:
;
; *) After -- the command is executed only after the session is completed;
; *) Online -- the command is executed after all files are received;
; *) Immediate -- the command is executed immediately after receiving a file
; of the specified type.
;
; For the "Session" Process the "Immediate" modifier means that the command
; must be executed before session is started rather than after it is completed.
;
; For starting the BBS you may fill the <when> field with "Online" or
; "Immediate" in the "Process BBS" string, or simply leave this field out.
; "Process After BBS" defines an action which is performed after the BBS is
; terminated.
;
; For the "Flag" process the "Immediate" modifier means that the appearance
; of this flag is checked every second rather than every minute. Using this
; feature is not recommended because of frequent disk scanning.
;
; Instead of the long "Immediate" modifier you may use its shorter
; equivalent -- "Imm".
;
;
; Event is an action performed by mailer at specific time. Events are
; defined with strings like:
;
; Event <time> <action>
;
; The <time> field sets the time when the event must be executed.
; The syntax for defining time variables is described in the "Time definition"
; Chapter.
;
; The <action> field defines an action. It may have the same values as
; in "Process" commands. Note that some commands have effect on all mailer
; windows while others only affect modem lines. If you want to define an action
; for a particular modem line, put the number of this line in square brackets
; before the "Event" string. Otherwise the event is executed for all modem lines.
; The description of available actions follows.
;
; *) Rescan
; Rescans outbound and builds the outbound queue.
;
; *) ReadConfig
; Rereads configuration files.
;
; *) Poll <prio> <address>
; Creates poll for specified addresses with <prio> priority (0..9).
; Several addresses separated by spaces may be defined.
;
; *) RemovePoll <address>
; If a poll for the <address> exists, it will be removed.
; Several addresses separated by spaces may be defined.
;
; *) Set <var> <value>
; Sets the <var> variable to <value>. This command may be executed globally
; or for specified modem lines.
;
; *) Log <string>
; Puts the <string> into log. If you use separate log files for Outbound and
; Event Manager and modem lines, then the string is written into Manager log
; unless you specify a line number as described above.
;
; *) Create <flagname>
; Creates a zero-length file named <flagname>. If this file already exists,
; it is freshened: its date and time are set to current date and time. If the
; full path is not defined, the file is created in the Flag_Dir directory.
;
; *) RemoveFile <filename>
; If the <filename> file exists on disk, it is removed. If the full path is
; not defined, the file is searched in the Flag_Dir directory.
;
; *) Exit <errorlevel>
; Terminates mailer with error level <errorlevel>.
;
; *) Hangup
; Goes on hook and breaks current connection (if On-Line).
;
; *) InitModem
; Initializes modem (if it is not busy).
;
; *) SendModem <string>
; Sends <string> to modem. This command is executed only if the line is not
; busy.
;
; *) Pause
; Activates Pause mode.
;
; *) Unpause
; Disables Pause mode, return to normal operation.
;
; *) Create_FileIndex
; Creates file index, that is used for faster file requests processing.
; Index file contains all files from FreqDir and FreqTree variables.
; File index is used if enabled by Use_FileIndex keyword.
;
; *) ResetTries <addr>
; Resets tries counter for address <addr>
;
; *) SetHold <time> <addr>
; Sets Hold flag for address <addr> valid during <time> (in minutes).
; If <time> is set to 0, the flag is set forever.
;
; *) RemoveHold <addr>
; Removes Hold flag, if it is set for address <addr>
;
; *) SetImm <time> <addr>
; Sets Imm flag for address <addr> valid during <time> (in minutes).
; If <time> is set to 0, the flag is set forever.
;
; *) RemoveImm <addr>
; Removes Imm flag, if it is set for address <addr>
;
; *) Play <filename>
; Plays sound file <filename> though MMPM/2 interface (usually this is a
; WAV-file)
;
; *) Sound <number of iterations> <4-digit patterns>
; Plays sounds through PC Internal Speaker.
; A pattern contains four digits:
; 1 - frequency (Hz) (0 means silence)
; 2 - frequency increment for 1 measure
; 3 - duration of measure (ms)
; 4 - number of measures
; You may specify a letter (note) followed by a number (octave 1..7)
; instead of frequency. A=la, B=si, æ=do, ..., G=sol.
;
; *) Exec <title> <modifiers> <progname> <param>
; Executes the <progname> program with specified parameters. All types of
; programs (OS/2 PM, OS/2 VIO, VDM, command files) may be run.
; <title> defines the window title (for windowed programs) or the string in
; tasklist (for fullscreen programs).
; <modifiers> are modifiers for run method, which form a word from the
; following characters:
; F - Foreground;
; B - Background;
; W - Windowed;
; V - Full Screen text mode;
; X - Maximized (only for windowed programs);
; N - Minimized (only for windowed programs);
; Z - Wait until the process is finished;
; C - Close port before running the program and wait until it is
; finished. If modem is busy at the time, the event will be executed
; when the line becomes free.
; (this modifier may be used only in "Event" and "Process Flag"
; command)
;
; <param> is a word which defines command line parameters passed to the
; program. It may be omitted if it is the last word in the string.
;
; When setting the parameters for programs you may use macros that are
; substituted with certain values at run-time:
;
; *A - full address of the system;
; *B - connection speed (DCE baudrate);
; *H - time left until the end of period when BBS is available (in minutes);
; *L - fixed port speed (locked port);
; *P - COM-port number;
; *T - Line number;
; *O - open COM-port handle;
; *FS - filename of the last sent file;
; *FR - filename of the last received file;
; ** - "*" character.
;
; The <action> field may contain several commands. The commands are
; separated by the "And" keyword.
;
; If you should define the same actions for different events and processes,
; you may define them once and then refer to them by a short identifier.
; The "DefineAction" keyword is used for this purpose:
;
; DefineAction <id> <commands>
;
; <id> - any word, an identifier for <commands>;
; <commands> - any commands matching he syntax described in this chapter.
;
; To execute a pre-defined action the "Action" keyword must be added to
; Manager instructions:
; Action <id>
; This keyword will execute the set of commands defined as <id>.
; Note that references from one action defined with "DefineAction" to others.
; Examples:
Event 0:00 Log "New day! :-)"
; Generate a poll to my uplinks 2:5030/251 and 2:5030/1016 (priority=8)
;Event 22:00,02:00,05:00,08:00,13:00,18:00 Poll 8 2:5030/251 2:5030/1016
; Çfter receiving netmail:
;Process Imm Netmail Create C:\Net\Flags\NetMail.FLG
; After receiving all files if echomail received:
;Process Online Arcmail Exec "Echo Tossing" BV C:\Net\Tosser\Toss.CMD "IN OUT"
; After session, if the files specified were received:
;Process After Tic Exec "File Tosser" VB ALLFIX.EXE -nocrc
;Process After File *.RI? Log "FRIP mail came here!"
; Two commands, separated by the "And" keyword:
;Process Flag Exit.FLG Log "Exit request detected" And Exit 100
; BBS software execution
;Process BBS Exec "BBS on COM*P (*B baud)" "VBZ" "C:\Net\GPMail\BBS.CMD" "*B *L *O"
; Running external fax-receiver:
;Process ModemSays "+FCO" {
; Exec "Fax receiving" VBZ "C:\Net\Fax\BGFAX.CMD" *O
; And Hangup
;}
; External viewer for the Outbound Editor:
; Process View <command>
; The filename is specified by the *F macro.
;Process View Exec "Viewer" FW C:\NET\GPMail\Viewer.CMD *F