retchmail/retchmail.1

   1 .TH RETCHMAIL 1 "Jan 2002" "Retchmail"
   2
   3 .SH NAME
   4 retchmail \- The world's most stupidly fast POP3 retriever.
   5
   6
   7 .SH SYNOPSIS
   8 .B retchmail
   9 .BR \-d \ |
  10 .BR \-dd \ |
  11 .BR \-q \ |
  12 .BR \-qq \ |
  13 .BR \-c \ |
  14 .BR \-V \ |
  15 .BR \-E \ |
  16 .BR \-F \ |
  17 .br
  18 .ti 17
  19 .BI \-t\  deliverto\fR\ |
  20 .IR fromacct ..."
  21
  22 .SH DESCRIPTION
  23 .B retchmail
  24 is a stupidly fast mail retriever, similar to the
  25 .BR fetchmail (1)
  26 program, except that it is blazingly fast, and only handles POP3 and POP3s
  27 (POP3 over SSL).
  28 .PP
  29 When
  30 .B retchmail
  31 starts, it first loads its configuration from
  32 .hy 0
  33 .IR ~/.retchmail/retchmail.conf ,
  34 .hy 14
  35 which contains basic information about the accounts, mailboxes, etc.
  36 .PP
  37 It will then go out and retrieve all of the mail from those accounts.
  38 .PP
  39 .SH OPTIONS
  40 Several options are recognized by
  41 .BR retchmail .
  42 .TP
  43 .B \-q
  44 Run in quiet mode (Don't print every message header)
  45 .TP
  46 .B \-qq
  47 Run in REALLY quiet mode (only print error messages)
  48 .TP
  49 .B \-c \fR[\|\fIconfig_moniker\fR\|]
  50 Run retchmail with \fIconfig_moniker\fR as the configuration file (instead of
  51 ini:$HOME/.retchmail/retchmail.conf).
  52 .TP
  53 .B \-E
  54 Explode a multidrop mailbox and deliver mail to the users that X-Envelope-To
  55 says to.
  56 .TP
  57 .B \-F
  58 Flush all messages after downloading - you probably want to make sure this
  59 is on the command line, or else you will keep downloading the same messages
  60 over and over and over and (you get the idea).
  61 .TP
  62 .B \-V
  63 Prints the current
  64 .B retchmail
  65 version information and exits.
  66 .TP
  67 .B \-d
  68 Displays debug information for troubleshooting
  69 .BR retchmail
  70 .TP
  71 .B \-dd
  72 Displays a lot of debug information for troubleshooting
  73 .BR retchmail.
  74 Use this option when reporting any bugs or problems with the program.
  75 .PP
  76 .SH BUGS
  77 Probably very few, but if you find any, please report them to
  78 .hy 0
  79 .BR <retchmail\-bugs@nit.ca> .
  80 .hy 14
  81 .PP
  82 Also, there is now a mailing list for discussion about
  83 .BR retchmail .
  84 If you are having problems, or have anything else to say, send e-mail to
  85 .hy 0
  86 .BR <wvstreams\-dev@lists.nit.ca> .
  87 .hy 14
  88 .PP
  89 .SH FILES
  90 .TP
  91 $HOME/.retchmail/retchmail.conf
  92 Configuration file which contains account, passwords and delivery
  93 information. See retchmail.conf(5).
  94 .PP
  95 .SH AUTHORS
  96 Avery Pennarun and Patrick Patterson for Net Integration Technologies Inc., as
  97 part of the NetIntegrator project.
  98 .SH CONTRIBUTORS
  99 MJ Ray for Luminas Ltd added APOP, as part of internal systems development.
 100 .PP
 101 .SH FAQ
 102 .TP
 103 .BR http://open.nit.ca/wiki/index.php?page=RetchMail
 104 .PP
 105 .SH SEE ALSO
 106 .BR retchmail.conf (5),
 107 .PP