diff --git a/nohtml.1 b/nohtml.1 index 10ec0bd..7470fdd 100644 --- a/nohtml.1 +++ b/nohtml.1 @@ -2,23 +2,52 @@ .TH nohtml 1 "TundraWare Inc." .SH NAME -nohtml \- Short Description +nohtml \- Suppress HTML Attachments In Email .SH SYNOPSIS -nohtml [-hv] - -.SH DESCRIPTION -Long description +nohtml.py [-hv] .SH OPTIONS .TP .B -h -print this help information +print help information .TP .B -v print detailed version information. + + +.SH DESCRIPTION +\'nohtml\' is a short Python script intended to be used in +a mail alias to strip HTML out of inbound messages. It is most +useful when used in conjunction with something like the +\'majordomo\' mailing list manager to keep people from posting +HTML to mailing lists. + +For example, here are \'Before\' and \'After\' entries in +the sendmail \'aliases\' file which enable this filter to +process inbound emails before they are delivered to the mailing +list: + +.nf + +Before: + +listname: "|/usr/local/majordomo/wrapper resend -l listname -h hostdomain.com listname-list" + + +After: + +listname: "|/local/bin/python /local/bin/nohtml.py |/usr/local/majordomo/wrapper resend -l listname -h hostdomain.com listname-list" + +.fi + +Notice that, in this context, you must explictly invoke the Python +interpreter in the alias pipeline. This is because there is no shell +interpeter present at the time the alias is invoked, so the usual #! +shell invocation found in the first line of the script will not work. + .SH OTHER You must have a reasonably current version of Python installed. @@ -27,9 +56,7 @@ .SH COPYRIGHT AND LICENSING \'nohtml\' is Copyright(c) \*(CP TundraWare Inc. For terms of use, see -the nohtml-license.txt file in the program distribution. If you -install \'nohtml\' on a FreeBSD system using the 'ports' mechanism, you -will also find this file in /usr/local/share/doc/nohtml. +the nohtml-license.txt file in the program distribution. .SH AUTHOR .nf