--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/commands/vpopbull.html Wed Jan 16 22:39:43 2008 +0100
@@ -0,0 +1,118 @@
+<HTML>
+<HEAD>
+<TITLE>vpopbull - Delivers pop bulletins to virtual users</TITLE>
+<LINK REV="made" HREF="mailto:root@porky.devel.redhat.com">
+</HEAD>
+
+<BODY>
+
+<!-- INDEX BEGIN -->
+<!--
+
+<UL>
+
+ <LI><A HREF="#NAME">NAME</A>
+ <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
+ <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
+ <LI><A HREF="#OPTIONS">OPTIONS</A>
+ <LI><A HREF="#RETURN_VALUE">RETURN VALUE</A>
+ <LI><A HREF="#ENVIRONMENT">ENVIRONMENT</A>
+ <LI><A HREF="#FILES">FILES</A>
+ <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
+ <LI><A HREF="#NOTES">NOTES</A>
+ <LI><A HREF="#AUTHORS">AUTHORS</A>
+</UL>
+-->
+<!-- INDEX END -->
+
+<P>
+<H1><A NAME="NAME">NAME</A></H1>
+<P>
+vpopbull - Delivers pop bulletins to virtual users
+
+<P>
+<HR>
+<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
+<P>
+<STRONG>vpopbull</STRONG>
+[<STRONG>--quiet</STRONG>]
+
+<P>
+<HR>
+<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
+<P>
+Scans bulletin directories for any which are newer than the
+<EM>.timestamp</EM> file in the specified maildir. For each bulletin that it finds, it adds a
+symlink to that bulletin to the specified maildir. Since no reformatting is
+done, these bulletins must be fully formatted email messages, including
+full headers.
+
+<P>
+This program is designed to be run from <CODE>checkvpw-postsetuid</CODE>.
+
+<P>
+<HR>
+<H1><A NAME="OPTIONS">OPTIONS</A></H1>
+<DL>
+<DT><STRONG><A NAME="item__quiet">--quiet</A></STRONG><DD>
+<P>
+Suppress all status messages.
+
+</DL>
+<P>
+<HR>
+<H1><A NAME="RETURN_VALUE">RETURN VALUE</A></H1>
+<P>
+Exits false if an error occurred during startup, true otherwise.
+
+<P>
+<HR>
+<H1><A NAME="ENVIRONMENT">ENVIRONMENT</A></H1>
+<P>
+This program expects the environment variable <CODE>HOME</CODE> to be set, and executes a change directory to the contents of it before
+starting.
+
+<P>
+This program expects <CODE>MAILDIR</CODE> to be set, and delivers any bulletins that it finds into this maildir.
+
+<P>
+If <CODE>VUSER</CODE> is set, a local bulletin directory is searched as above.
+
+<P>
+<HR>
+<H1><A NAME="FILES">FILES</A></H1>
+<P>
+The following control files are used:
+
+<DL>
+<DT><STRONG><A NAME="item_global">global-bulletin-dir</A></STRONG><DD>
+<P>
+This specifies the bulletin directory for all domains.
+
+<DT><STRONG><A NAME="item_bulletin">bulletin-dir</A></STRONG><DD>
+<P>
+This specifies the bulletin (sub)directory for virtual domains.
+
+</DL>
+<P>
+<HR>
+<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
+<P>
+<CODE>vmailmgr(7),</CODE> <CODE>checkvpw(8),</CODE> configuration.html
+
+<P>
+<HR>
+<H1><A NAME="NOTES">NOTES</A></H1>
+<P>
+If either the global or local bulletin directories do not exist, they are
+silently ignored without failing.
+
+<P>
+<HR>
+<H1><A NAME="AUTHORS">AUTHORS</A></H1>
+<P>
+Bruce Guenter <<A HREF="mailto:bruceg@em.ca">bruceg@em.ca</A>>
+
+</BODY>
+
+</HTML>