diff man/mlmmj-receive.1 @ 748:dfc9ab125fd4

Fix spelling of 'receive' and 'voodoo'; make mlmmj-recieve a symlink
author Chris Webb
date Sun, 03 Oct 2010 21:40:42 +1100
parents man/mlmmj-recieve.1@ebe24524a3f7
children c7fef0950be6
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/mlmmj-receive.1	Sun Oct 03 21:40:42 2010 +1100
@@ -0,0 +1,41 @@
+.TH mlmmj-receive "1" "September 2004" mlmmj-receive
+.SH NAME
+mlmmj-receive \- receive mails for an mlmmj managed mailinglist
+.SH SYNOPSIS
+.B mlmmj-receive
+\fI-L /path/to/listdir \fR[\fI-h\fR] [\fI-V\fR] [\fI-P\fR] [\fI-F\fR]
+.HP
+\fB\-h\fR: This help
+.HP
+\fB\-F\fR: Don't fork in the background (debugging only)
+.HP
+\fB\-L\fR: Full path to list directory
+.HP
+\fB\-P\fR: Don't execute mlmmj-process (debugging only)
+.HP
+\fB\-V\fR: Print version
+.SH DESCRIPTION
+The mlmmj-receive binary is the one specified in the mailserver configuration
+file (aliases file), which writes the mail to the <listdir>/incoming directory
+and invokes mlmmj-process unless the \fB\-P\fR option is specified. On systems
+using mailservers supporting the \fB/etc/aliases\fR file, a line to activate
+an mlmmj managed mailinglist would look like this:
+.LP
+list: "|/usr/bin/mlmmj-receive -L /var/spool/mlmmj/list/"
+
+It's very important to specify the full path to the binary, or the mailinglist
+will not function.
+
+When the \fB\-F\fR option is used, it will not fork in the background. The
+reason it forks is that if delivery of a mail takes longer time than the mail
+server will allow a command to be idle before presumed dead, the mail server
+would kill it.
+
+.SH "SEE ALSO"
+mlmmj-process(1)
+.SH AUTHORS
+This manual page was written by the following persons:
+.HP
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+.HP
+Mads Martin Jørgensen <mmj@mmj.dk>