filter(1) CLIX filter(1)
NAME
filter - Filters incoming messages before adding to a mailbox
SYNOPSIS
filter [-nrv] [-o file]
filter [-c] [-s|-S] [-o file]
FLAGS
These flags are available:
-c Removes log files.
-n Displays what would happen if a message is received while the
filter is in effect. No actions are actually performed on the
message.
-o file Redirects all log messages to the specified file or device.
Since sendmail is the program which invokes the filter command,
this flag is added to handle changes in the file system, as
sendmail is sensitive to the modes of files used for
redirecting.
-r Lists the rules currently being used.
-s Summarizes the log of filtered messages.
-S Includes message-by-message information about filtered messages
(but otherwise is the same as the -s flag).
-v Displays more verbose output for each message filtered. It can
be useful to redirect the output to /dev/console using the -o
flag.
DESCRIPTION
The filter command allows incoming mail to be filtered against a wide set
of criteria. The criteria are contained in the file $HOME/.elm/filter-
rules. (See filter-rules(4) for more information about creating the
filter rules.)
To use the filter command, create the filter-rules file and place it in
the $HOME/.elm directory. Then enter the filter command with any desired
flags. The incoming mail will now be filtered according to the criteria
in the rules file.
EXAMPLES
2/94 - Intergraph Corporation 1
filter(1) CLIX filter(1)
1. To filter messages, clear message logs after first summarizing them,
and to redirect all log messages to the file called log_report, enter
this command:
filter -c -s -o log_report
2. To list the current rules used for filtering and redirect all log
messages to the file log_report, enter this command:
filter -r -o log_report
FILES
$HOME/.elm/filter-rules Rule set for the user's filter.
$HOME/.elm/filterlog Log of what has passed through filter.
$HOME/.elm/filtersum Summary of what has passed through filter.
CAUTIONS
Not very efficient in pattern matching.
DIAGNOSTICS
If the $HOME/.elm/filter-rules file is missing, the error message
``Filter(username): Couldn't get rules!'' is displayed.
EXIT VALUES
The command exits with a value of 0 if successful. If unsuccessful, the
command exits with a value of 1.
RELATED INFORMATION
Commands: readmsg(1), elm(1), sendmail(8)
Files: filter-rules(4)
The Elm User's and Reference Guides
2 Intergraph Corporation - 2/94