.\" $Id: crashecho.conf.5.in,v 1.17 2002/07/07 12:56:10 raorn Exp $
.TH CRASHECHO.CONF 5 " 2 September 2001" "Sir Raorn" "CrashEcho"
.SH NAME
crashecho.conf \- CrashEcho configuration file
.SH DESRIPTION
.PP
.\" Add more description here
.PP
The \fBcrashecho.conf\fR is the main configuration file for CrashEcho
tosser.
.PP
You should always use absolute paths in crashecho.conf, otherwise
CrashEcho will fail to unpack incoming bundles. If you used relative
paths, CrashEcho will also use relative paths in flow files which might
confuse your mailer.
.PP
Don't use the \fB~\fR character in paths. Such paths are expanded to
point to your home directory by the shell and not by the I/O functions
in the system. They will not work in CrashEcho.
.PP
The strings either must be in double quotes or spaces must be escaped.
Backslashes must always be escaped.
.PP
CrashEcho uses
.BR fnmatch (3)
for pattern matching.
.SH "CONFIGURATION PARAMETERS"
.SS General configuration
.TP
\fBSYSOP\fR\ <\fIname\fR>
This keyword lets you configure the name of the system operator. It is
used as the sender name of all messages that CrashEcho generates
(AreaFix responses, forward rquests). Max 36 characters.
.TP
\fBLOGFILE\fR\ <\fIfilename\fR>
.br
.ns
.TP
\fBLOGLEVEL\fR\ <\fIlevel\fR>
Here you can configure the logging in CrashEcho. CrashEcho will write
all log messages with a level lower than the \fIlevel\fR configured here
both to the console and to the specified file.
.sp
The following \fIlevel\fRs exist:
.RS
.TP
1
Minimum
.TP
2
Small
.TP
3
Normal
.TP
4
Extra
.TP
5
Extreme
.TP
6
Debug
.PP
If CrashEcho is compiled with
.BR syslog (3)
support, it is possible to enter facility name, prefixed with `\fB$\fR'
as the filename (e.g. \fI$local3\fR). If you do this, everything will be
logged to the syslog instead.
.RE
.TP
\fBDUPEFILE\fR\ <\fIfilename\fR>\ <\fImaxsize\fR>
.br
.ns
.TP
\fBDUPEMODE\fR\ <\fImode\fR>
Here the file that CrashEcho uses for its duplicate detection is
specified. \fImaxsize\fR is specified in KB and sets the maximum size of
the dupetable. Note that CrashEcho needs this amount of memory in a
continous memory block. Each stored message uses about 39.0865 bytes
in the dupe table.
.sp
These are the available \fImode\fRs for dupe checking:
.RS
.TP
\fBBAD\fR
Dupes are moved to the \fIBAD\fR area
.TP
\fBKILL\fR
Dupes are killed
.TP
\fBIGNORE\fR
No dupechecking
.RE
.TP
\fBMAXPKTSIZE\fR\ <\fImaxsize\fR>
.br
.ns
.TP
\fBMAXBUNDLESIZE\fR\ <\fImaxsize\fR>
Here you can configure the maximum size of the .pkt files and bundles
that CrashEcho generates. If a file grows bigger than this limit,
CrashEcho starts a new bundle/pkt instead. The limits are in KB.
.TP
\fBMSGBASEUMASK\fR\ <\fImask\fR>
.BR umask (2)
used when creating messagebases. E.g. to make them group
writable. \fImask\fR must be octal.
.TP
\fBDEFAULTZONE\fR\ <\fIzone\fR>
If CrashEcho can't figure out the zone of a message in another way,
the \fIzone\fR configured here is used.
.LP
.SS Paths
.TP
\fBPROTINBOUND\fR\ <\fIpath\fR>
The protected inbound directory is the directory where CrashEcho looks
for .pkt files and bundles to toss.
.TP
\fBINBOUND\fR\ <\fIpath\fR>
The unprotected inbound directory is the directory where CrashEcho looks
only for .pkt files to toss.
.TP
\fBLOCALINBOUND\fR\ <\fIpath\fR>
The local inbound directory is the directory where CrashEcho looks for
.pkt files and bundles to toss. Tossing performed without all security
checks
.TP
\fBTEMPINBOUND\fR\ <\fIpath\fR>
This is the directory where CrashEcho unpacks incoming bundles.
.TP
\fBOUTBOUND\fR\ <\fIpath\fR>
The outbound directory is where CrashEcho writes the flow files that
tells the mailer what files to send.
.TP
\fBCREATEPKTDIR\fR\ <\fIpath\fR>
This is the directory where CrashEcho stores created .pkt files until
they are stored in the packet directory.
.TP
\fBPACKETDIR\fR\ <\fIpath\fR>
This is the directory where CrashEcho stores generated bundles.
.TP
\fBSTATSFILE\fR\ <\fIfilename\fR>
This is the file where CrashEcho stores statistics about areas and
nodes. You can display the contents of this file with CrashStats.
.TP
\fBAREAFILE\fR\ <\fIfilename\fR>
This is the file where CrashEcho should look for areas definitions.
.LP
.SS "External programs"
.TP
\fBAFTERUNPACK\fR\ <\fIfilename\fR>
CrashEcho will execute <\fIfilename\fR> after successfull unpacking of
protected inbound.
.TP
\fBBEFOREPACK\fR\ <\fIfilename\fR>
CrashEcho will execute <\fIfilename\fI> before compressing outbound
.SS Switches
.TP
\fBSTRIPRE\fR
CrashEcho should strip all occurences of "\fBRe:\fR",
"\fBRe[\fR\fIn\fR\fB]:\fR" and "\fBRe^\fR\fIn\fR\fB:\fR" in the subject
of messages before they are imported.
.TP
\fBFORCEINTL\fR
CrashEcho should add an \fB^aINTL\fR line to all messages even when the sender
and the destination are in the same zone.
.TP
\fBCHECKSEENBY\fR
CrashEcho should never send echomail to nodes that already are in the
\fBSEEN\-BY\fR lines.
.TP
\fBCHECKPKTDEST\fR
CrashEcho should check the destination node of all incoming .pkt files
and only toss them if thety are adressed to one of the local \fBAKA\fRs.
.TP
\fBALLOWNULLPASSWORDS\fR
CrashEcho should accept .pkt files with empty passwords. Usually such
packets generated by buggy mailers (e.g. T-Mail)
.TP
\fBKEEPAREAFIX\fR
Use this if you want messages to CrashEcho's internal AreaFix not to
be deleted from your netmail area.
.TP
\fBAREAFIXREMOVE\fR
Use this to allow the AreaFix to remove areas when the last downlink
unsubscribed.
.TP
\fBWEEKDAYNAMING\fR
Name bundles according to the day of the week they are created.
.TP
\fBADDTID\fR
Add a \fB^aTID\fR line to all echomail messages exported by CrashEcho.
.TP
\fBALLOWRESCAN\fR
Allow nodes to rescan areas in the AreaFix.
.TP
\fBFORWARDPASSTHRU\fR
Make areas created when they were forward\-requested by a downlink
pass\-through rather than importing them to your messagebase.
.TP
\fBREMOVEWHENFEED\fR
CrashEcho should remove areas when the feed unsubscribes to
them. AreaFix messages or notification messages can be sent to your
downlinks, see the Node configuration.
.TP
\fBINCLUDEFORWARD\fR
Include all forward\-requestable areas in the area lists generated by
the AreaFix.
.TP
\fBNOMAXOUTBOUNDZONE\fR
CrashEcho normally puts outgoing mail for all zones >4095 in the
Bink\-style outbound for zone 4095 (usually \fIoutbound.fff\fR). If this
switch is turned on, CrashEcho will use separate outbound directories
also for zones >4095.  The background of this option is that the
Binkley outbound style originated on platforms where file names
were limited to 8+3 characters. For compatibility with many older
mailers, leave this switch turned off.  There are however some mailers
that also expect to find mail for zones >4095 in separate outbound
directories.
.TP
\fBUSEASO\fR
Use Amiga\-style outbound instead of BSO.
.TP
\fBALLOWKILLSENT\fR
If this option is used, CrashEcho will delete all netmail messages
with the killsent flag after they have been expored
.TP
\fBLOCKBYLINK\fR
If this option is used, CrashEcho will use
.BR link (2)
when creating lockfiles instead of
.BR open (2)
.TP
\fBCCONSCAN\fR
Do Carbon Copies when scanning
.LP
.SS Groupnames
.TP
\fBGROUPNAME\fR\ <\fIletter\fR>\ <\fIdescription\fR>
Here you can describe you groups. These descriptions are used in the
area lists created by the AreaFix.
.LP
.SS Carbon copy
.TP
\fBCARBON\fR\ <\fIarea\ pattern\fR>\ <\fItype\fR>\ <\fIpattern\fR>\ <\fIdestination\ area\fR>
Copy messages, that satisfy \fIpattern\fR, from \fIarea pattern\fR to
\fIdestination area\fR.
.sp
The following \fItype\fR's can be used:
.RS
.TP
\fBFROM\fR
Check "\fBFrom\fR" field of a message.
.TP
\fBTO\fR
Check "\fBTo\fR" field of a message.
.TP
\fBSUBJ\fR
Check "\fBSubject\fR" field of a message.
.RE
.LP
.SS Packers
.TP
\fBPACKER\fR\ <\fIname\fR>\ <\fIpack\ command\fR>\ <\fIunpackcommand\fR>\ <\fIrecog\fR>
Here you configure the external packers that CrashEcho uses. \fB%a\fR stands
for archive name and \fB%f\fR stands for file name. The recog string is
used when CrashEcho detects the packer used to pack a bundle. If the
beginning of the bundle matches the recog string, CrashEcho uses that
packer. \fB?\fR can be used as a wildcard and you can use \fB$\fR\fIxx\fR to
specify a hexadecimal number.
.PP
.SS AKA
.TP
\fBAKA\fR\ <\fInode\fR>
.br
.ns
.TP
\fBADDNODE\fR\ <\fInode1\fR>\ <\fInode2\fR>\ ...
.br
.ns
.TP
\fBREMNODE\fR\ <\fInodepattern1\fR>\ <\fInodepattern2\fR>\ ...
Here you configure the adresses of your node. \fBADDNODE\fR is used to
add nodes the the \fBSEEN\-BY\fR lines in areas with this \fBAKA\fR and
\fBREMNODE\fR is used to remove nodes. Nodes for \fBADDNODE\fR and
\fBREMNODE\fR has to be 2D, that is only net/node should be specified.
Patterns are allowed for \fBREMNODE\fR.
.LP
.SS Nodes
.TP
\fBNODE\fR\ <\fInode\fR>\ <\fIaka\ to\ use\fR>\ <\fIpacker\ name>\fR\ <\fIpacket\ password\fR>\ [<\fIflags\fR>]
.br
.ns
.TP
\fBAREAFIXINFO\fR\ <\fIareafix\ password\fR>\ <\fIgroups\fR>\ <\fIread\-only\ groups\fR>\ <\fIadd\ groups\fR>
.br
.ns
.TP
\fBDEFAULTGROUP\fR <\fIgroup\fR>
.br
.ns
.TP
\fBREMOTEAF\fR\ <\fIareafix\ name\fR>\ <\fIareafix\ password\fR>
.br
.ns
.TP
\fBREMOTESYSOP\fR <\fIname\fR>
These are the nodes you interchange mail with. You can only send
echomail to nodes specified here, but netmail can also be sent to
other nodes. The \fIgroups\fR decide what areas a node may subscribe to
in the AreaFix. If the area is in one of the \fIread\-only groups\fR, the
node will be added as read\-only. If a new area is added in one of the
\fIadd groups\fR, this node will automatically be subscribed to it. The
default \fIgroup\fR is the group used for areas that are autoadded from this
node. \fBREMOTEAF\fR and \fBREMOTESYSOP\fR are used when CrashEcho needs
to send messages to the AreaFix or the sysop of this node.
.sp
The following flags can be set for a node:
.RS
.TP
\fBNOTIFY\fR
When a \fBSENDQUERY\fR, \fBSENDLIST\fR, \fBSENDUNLINKED\fR,
\fBSENDINFO\fR or \fBSENDHELP\fR with the argument ALL is used on the
command\-line, messages will be sent to all nodes with this flag set.
.TP
\fBPASSIVE\fR
Echomail is never sent to this node. Used for the \fB%PAUSE\fR and
\fB%RESUME\fR commands in the AreaFix.
.TP
\fBNOSEENBY\fR
No \fBSEEN\-BY\fR lines are included in messages sent to this node. Should
normally not be used.
.TP
\fBTINYSEENBY\fR
Only sender and destination is included in \fBSEEN\-BY\fR lines in messages
sent to this node. Should normally not be used.
.TP
\fBFORWARDREQ\fR
This node is allowed to do forward\-requests.
.TP
\fBSENDAREAFIX\fR
AreaFix disconnect requests should be sent to this node when the feed
unsubscribes from an area.
.TP
\fBSENDTEXT\fR
Notification messages should be sent to the sysop of this node when
the feed unsubscribes from an area.
.TP
\fBAUTOADD\fR
New areas from this node should be auto\-added to the
configuration. If auto\-add is not set, the areas will still be added
but with an \fBUNCONFIRMED\fR line.
.TP
\fBCRASH\fR
Send echomail to this node with priority \fBCrash\fR.
.TP
\fBDIRECT\fR
Send echomail to this node with priority \fBDirect\fR.
.TP
\fBHOLD\fR
Send echomail to this node with priority \fBHold\fR.
.RE
.LP
.SS AreaFix
.TP
\fBAREAFIXHELP\fR <\fIfilename\fR>
The file that is sent when a downlink issues a \fB%HELP\fR command.
.TP
\fBAREAFIXMAXLINES\fR <\fImax\fR>
The maximum number of lines in an AreaFix response. CrashEcho splits
the response if it exceeds this number.
.TP
\fBAREAFIXNAME\fR <\fIname\fR>
A name that CrashEcho's AreaFix should respond to.
.TP
\fBFORWARDTIMEOUT\fR <\fIdays\fR>
This keyword sets time in days, that CrashEcho will wait until the requested
area is autocreated. If area has not been created within period specifyed,
request will be discarded.
See \fBEXPIRES\fR keyword.
.TP
\fBREMOVETIMEOUT\fR <\fIdays\fR>
This keyword sets time in days, that CrashEcho will ignore messages in deleted
areas.
See \fBREMOVED\fR keyword.
.TP
\fBAREALIST\fR\ <\fInode\fR>\ <\fIfile\ name\fR>\ [\fBGROUP\fR\ <\fIgroup\fR>]\ [\fBFORWARD\fR]\ [\fBDESC\fR]
This is a list of the areas that are available at a node. It should
contain lines with the format "<\fItagname\fR> \fIdescription\fR>". If
\fBDESC\fR is specified, descriptions are taken from this file when
CrashEcho auto\-adds areas. If \fBFORWARD\fR is specified, this file is used
to determine what files are available for forward\-requests. \fBGROUP\fR
specifies the group needed to be allowed to forward\-requests areas in
this list.
.LP
.SS MSG
.TP
\fBMSG_HIGHWATER\fR
Use 1.msg as highwater mark in *.msg areas.
.LP
.SS JAM
This keywords available only if CrashEcho is compiled with JAM
messagebase support.
.TP
\fBJAM_FLAGSDIR\fR <\fIpath\fR>
\fIpath\fR, where CrashEcho will create \fIimport.jam\fR and \fInewareas.jam\fR
files
.TP
\fBJAM_HIGHWATER\fR
Use highwater marks to speed up scanning. The highwater mark is stored
in a file called \fI<basename>.cmhw\fR.
.TP
\fBJAM_QUICKLINK\fR
Just compare the CRC of \fBMSGID\fR/\fBREPLY\fR when linking and don't
read the strings from the messagebase. This makes linking quicker, but
messages that don't match may be linked by mistake.
.TP
\fBJAM_HARDDELETE\fR
Delete messages by setting \fBUserCRC\fR and \fBHdrOffset\fR in the
index to 0xFFFFFFFF instead of setting \fBMSG_DELETED\fB attribute.
.TP
\fBJAM_MAXOPEN\fR <\fImax\fR>
This is the number of JAM messagebases that CrashEcho keeps open at a
time. A higher number speeds up tossing, but since CrashEcho keeps
four files open for each area, don't use a too high number if you only
can have a limited number of files open...
.SH AREAS
.TP
\fBNETMAILDIR\fR <\fIpath\fR>
Primary netmail area, where all messages from .pkt's or secondary
netmail areas will be imported.
.TP
\fBAREA\fR/\fBNETMAIL\fR/\fBLOCALAREA\fR\ <\fItagname\fR>\ <\fIaka\fR>\ [<\fImessagebase\fR>\ <\fIpath\fR>]
.br
.ns
.TP
\fBEXPORT\fR\ <\fInode1\fR>\ <\fInode2\fR>\ ...
.br
.ns
.TP
\fBBANNED\fR\ <\fInode1\fR>\ <\fInode2\fR>\ ...
.br
.ns
.TP
\fBDESCRIPTION\fR\ <\fIdesc\fR>
.br
.ns
.TP
\fBGROUP\fR\ <\fIgroup\fR>
.br
.ns
.TP
\fBKEEPNUM\fR\ <\fInum\fR>
.br
.ns
.TP
\fBKEEPDAYS\fR\ <\fInum\fR>
.br
.ns
.TP
\fBEXPIRES\fR\ <\fItime\fR>
.br
.ns
.TP
\fBREMOVED\fR\ <\fItime\fR>
.br
.ns
.TP
\fBUNCONFIRMED\fR
.br
.ns
.TP
\fBMANDATORY\fR
.br
.ns
.TP
\fBDEFREADONLY\fR
.br
.ns
.TP
\fBIGNOREDUPES\fR
.br
.ns
.TP
\fBIGNORESEENBY\fR
.br
.ns
.TP
\fBIMPORTSEENBY\fR
Here you configure all areas that CrashEcho knows. Area definitions
begin with \fBAREA\fR for echomail areas and \fBNETMAIL\fR for secondary
netmail areas. Local areas defined with \fBLOCALAREA\fR are not used by
CrashEcho, but are included in config files created by CrashExport and
are maintained when running CrashMaint.
.sp
To see the supported messagebase formats in your version of CrashEcho,
type "\fBcrashecho\fR \fB\-\-version\fR". What path should be used depends on the used
messagebase formats.
.sp
Echomail has one or more \fBEXPORT\fR lines where the nodes that this area
should be sent to are listed. Each node on an export line has the
format "[<\fImodifier\fR>]<\fBnode\fR>" where modifier may be \fB!\fR,
\fB@\fR or \fB%\fR.  \fB!\fR means that the node is read\-only, \fB@\fR
means that the node is write\-only and \fB%\fR means that the node is
the feed for this area.
.sp
Note that nodes on the \fBEXPORT\fR line may be abbreviated. And example:
.nf

    EXPORT 2:2/2 1 .5 3/2 .22 3 .33

.fi
will be expanded to
.nf

    EXPORT 2:2/2 2:2/1 2:2/1.5 2:3/2 2:3/2.22 2:3/3 2:3/3.33

.fi
Nodes in the \fBBANNED\fR line may not subscribe to this area with the
AreaFix.  \fBMANDATORY\fR means that nodes may not unsubscribe from this
area in the AreaFix. \fBDEFREADONLY\fR means that nodes that subscribe to
this area in the AreaFix will be added as read\-only.
.sp
Areas with \fBUNCONFIRMED\fR are areas that have been auto\-added by
CrashEcho but not yet confirmed. Areas get this flag when the node
didn't have the flag \fBAUTOADD\fR set. CrashEcho treats unconfirmed areas
as if they didn't exist at all.
.sp
\fBKEEPNUM\fR and \fBKEEPDAYS\fR are used by CrashMaint to decide how long
messages should be kept in the messagebase.
.sp
\fBEXPIRES\fR used when CrashEcho forwards request to uplink. If no messages
will be imported in this area until <\fItime\fR>, area will be removed.
.sp
\fBREMOVED\fR used when CrashEcho removes area to prevent accidental
autocreating. All messages that comes to this area will be ingored.
CrashEcho will remove this area from config when <\fItime\fR> comes.
.sp
An area with the tagname \fBBAD\fR is a special area that are used for
messages that for some reason are considered "bad" by CrashEcho.
.sp
Another special kind of areas are the default areas. When
CrashEcho adds an area, it searches for a default area to use as a
template. First it looks for an area named \fBDEFAULT_\fR<\fIgroups\fR> where
<\fIgroups\fR> contains the group of the new area. If such an area doesn't
exist, it looks for an area called \fBDEFAULT\fR. If a default area was
found, CrashEcho copies this configuration for this area to the new
area. In the path of the default area, you can use the following
\fB%\fR\-codes:
.RS
.TP
\fB%a\fR
Name of the area
.TP
\fB%l\fR
Name of the area in lowercase letters
.TP
\fB%8\fR
Eight digit serial number
.LP
You must use one of these \fB%\fR\-codes or the new path will not be unique.
.RE
.SH FILES
\fI/etc/ftn/crashecho.conf\fR
.SH "SEE ALSO"
.BR crashexport (1),
.BR crashmail (1),
.BR crashmaint (1),
.BR crashstats (1),
.BR crashwrite (1),
.BR fnmatch (3),
.BR syslog.conf (5)
.\" vim:ft=nroff: