--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/commands/vcheckquota.html Wed Jan 16 22:39:43 2008 +0100
@@ -0,0 +1,100 @@
+<HTML>
+<HEAD>
+<TITLE>vcheckquota - vmailmgr quota enforcement program</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="#SEE_ALSO">SEE ALSO</A>
+ <LI><A HREF="#AUTHORS">AUTHORS</A>
+</UL>
+-->
+<!-- INDEX END -->
+
+<P>
+<H1><A NAME="NAME">NAME</A></H1>
+<P>
+vcheckquota - vmailmgr quota enforcement program
+
+<P>
+<HR>
+<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
+<P>
+<STRONG>vcheckquota</STRONG>
+[<STRONG>-a UINT</STRONG>] [<STRONG>--soft-maxsize=UINT</STRONG>] [<STRONG>-m STR</STRONG>] [<STRONG>--soft-message=STR</STRONG>]
+
+<P>
+<HR>
+<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
+<P>
+<EM>vcheckquota</EM> ensures that the hard and soft quotas are enforced, that message counts and
+sizes are appropriately limited. The limits are set by the vadduser or
+vchattr command.
+
+<P>
+The following rules are applied:
+
+<OL>
+<LI>
+<P>
+If the message is larger than the message size limit, it is rejected.
+
+<LI>
+<P>
+If the user has too many messages in their mailbox, further messages are
+rejected.
+
+<LI>
+<P>
+If the user is over their hard quota, all further messages are rejected and
+no warning messages are linked in.
+
+<LI>
+<P>
+If the user is over their soft quota, and the message is small (as defined
+by <EM>soft-maxsize</EM>), the message is accepted, otherwise it is rejected. If <EM>soft-message</EM> is defined, a warning message is linked into the mailbox in either case.
+
+</OL>
+<P>
+Warning: the soft-message is linked into the users maildir once for each
+message that is received while the account is over its soft quota. This may
+result in multiple warning messages.
+
+<P>
+<HR>
+<H1><A NAME="OPTIONS">OPTIONS</A></H1>
+<DL>
+<DT><STRONG><A NAME="item__a">-a UINT, --soft-maxsize=UINT</A></STRONG><DD>
+<P>
+The maximum message size after soft quota is reached. Defaults to 4096.
+
+<DT><STRONG><A NAME="item__m">-m STR, --soft-message=STR</A></STRONG><DD>
+<P>
+The path to the soft quota warning message. Defaults to no message.
+
+</DL>
+<P>
+<HR>
+<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
+<P>
+<CODE>vadduser(1),</CODE> <CODE>vchattr(1)</CODE>
+
+<P>
+<HR>
+<H1><A NAME="AUTHORS">AUTHORS</A></H1>
+<P>
+Bruce Guenter <<A HREF="mailto:bruceg@em.ca">bruceg@em.ca</A>>
+
+</BODY>
+
+</HTML>