home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / utils / elm / filter.man < prev    next >
Text File  |  1992-03-28  |  3KB  |  99 lines
  1. NAME
  2.      filter - filter incoming messages before adding to mailbox
  3.  
  4. SYNOPSIS
  5.      filter [-v] [-o output]
  6.      filter [-n]
  7.      filter [-r] [-o output]
  8.      filter [-c] [-s] [-o output]
  9.      filter [-c] [-S] [-o output]
  10.  
  11. DESCRIPTION
  12.      Filter is a  sophisticated  program  that  allows  incoming  mail  to  be
  13.      filtered  against  a  wide  set  of  criteria.  The format for the rules,
  14.      located in $HOME/.elm/filter-rules, is;
  15.  
  16.              rule  ::=  if  (expression)  then  action
  17.  
  18.      where expression is:
  19.  
  20.              expression  ::=  {  not  }  condition  expr2
  21.  
  22.              expr2  ::=  NULL  |  and  condition  expr2
  23.  
  24.              condition  ::=  field  relationship  value
  25.                         ::=  lines  relop  numvalue
  26.      or                 ::=  always
  27.  
  28.      These further break down as:
  29.  
  30.              field  ::=  from  |  subject  |  to  |  lines
  31.  
  32.              relationship  ::=  =  |  !=
  33.  
  34.              relop  ::=  =  |  !=  |  <  |  >  |  <=  |  >=
  35.  
  36.              value  ::=  any  quoted  string
  37.  
  38.              numvalue  ::=  any  integer  value
  39.  
  40.      Action can be any of:
  41.  
  42.              delete
  43.              save  foldername
  44.              savecopy foldername
  45.              execute  command
  46.              forward  address
  47.              leave
  48.  
  49.      For further information about the rules  language,  please  see  The  Elm
  50.      Filter Guide.
  51.  
  52.      The flags the filter program understands are;
  53.  
  54.      -c          Clear logs.  If this flag is used,  the  log  files  will  be
  55.                  removed  after  being  summarized by either "-s" or "-S" (see
  56.                  below).
  57.  
  58.      -n          Not really.  Output what would happen if given  message  from
  59.                  standard input, but don't actually do anything with it.
  60.  
  61.      -o file     Redirect all log messages to the specified  file  or  device.
  62.                  (This  is  added  to more gracefully deal with changes in the
  63.                  file system (since sendmail is quite  picky  about  modes  of
  64.                  files being redirected into.))
  65.  
  66.      -r          Rules.  List the rules currently being used.
  67.  
  68.      -s          Summarize.  List a summary of the message filtered log.
  69.  
  70.      -S          This is the same  as  `-s'  but  includes  message-by-message
  71.                  information additionally.
  72.  
  73.      -v          Verbose.  Give  output  on  standard  out  for  each  message
  74.                  filtered.   Useful to have redirected to ``/dev/console'' and
  75.                  such.  (see -o too).
  76.  
  77. AUTHOR
  78.      Dave Taylor, Hewlett-Packard Laboratories.
  79.  
  80. FILES
  81.      $HOME/.elm/filter-rules     The ruleset for the users filter
  82.      $HOME/.elm/filterlog        A log of what has been done
  83.      $HOME/.elm/filtersum        A summary of what has been done
  84.      /etc/passwd             Used to get users home directory
  85.  
  86. SEE ALSO
  87.      The Elm Filter Guide, by Dave Taylor.
  88.      readmsg(1L), elm(1L), mail(1), mailx(1), sendmail(1,8)
  89.  
  90. COMMENTS
  91.      Not real smart about pattern matching.
  92.  
  93. BUG REPORTS TO
  94.      Syd Weinstein elm@DSI.COM (dsinc!elm)
  95.  
  96. COPYRIGHTS
  97.      (c) Copyright 1986, 1987 by Dave Taylor
  98.      (c) Copyright 1988, 1989, 1990 by The USENET Community Trust
  99.