Mercurial Mercurial > vmailmgr / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/configuration.html
changeset 0 6f7a81934006
child 2 b3afb9f1e801 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/configuration.html	Wed Jan 16 22:39:43 2008 +0100
@@ -0,0 +1,1027 @@
+<HTML>
+<HEAD>
+<!-- Created by texi2html 1.56k from configuration.texi on 14 September 2000 -->
+
+<TITLE>Vmailmgr Configuration Files</TITLE>
+</HEAD>
+<BODY>
+<H1>Vmailmgr Configuration Files</H1>
+<H2>14 September 2000</H2>
+<ADDRESS>Bruce Guenter</ADDRESS>
+<P>
+<P><HR><P>
+<H1>Table of Contents</H1>
+<UL>
+<LI><A NAME="TOC1" HREF="configuration.html#SEC1">1. General Information</A>
+<UL>
+<LI><A NAME="TOC2" HREF="configuration.html#SEC2">1.1 Search Order</A>
+<LI><A NAME="TOC3" HREF="configuration.html#SEC3">1.2 File Types</A>
+<LI><A NAME="TOC4" HREF="configuration.html#SEC4">1.3 Command Execution</A>
+</UL>
+<LI><A NAME="TOC5" HREF="configuration.html#SEC5">2. Configuration Files</A>
+<UL>
+<LI><A NAME="TOC6" HREF="configuration.html#SEC6">2.1 authvmailmgr-error</A>
+<LI><A NAME="TOC7" HREF="configuration.html#SEC7">2.2 authvmailmgr-loginfail</A>
+<LI><A NAME="TOC8" HREF="configuration.html#SEC8">2.3 authvmailmgr-postsetuid</A>
+<LI><A NAME="TOC9" HREF="configuration.html#SEC9">2.4 authvmailmgr-presetuid</A>
+<LI><A NAME="TOC10" HREF="configuration.html#SEC10">2.5 autoresponse-dir</A>
+<LI><A NAME="TOC11" HREF="configuration.html#SEC11">2.6 autoresponse-file</A>
+<LI><A NAME="TOC12" HREF="configuration.html#SEC12">2.7 bulletin-dir</A>
+<LI><A NAME="TOC13" HREF="configuration.html#SEC13">2.8 checkvpw-error</A>
+<LI><A NAME="TOC14" HREF="configuration.html#SEC14">2.9 checkvpw-loginfail</A>
+<LI><A NAME="TOC15" HREF="configuration.html#SEC15">2.10 checkvpw-postexec</A>
+<LI><A NAME="TOC16" HREF="configuration.html#SEC16">2.11 checkvpw-postsetuid</A>
+<LI><A NAME="TOC17" HREF="configuration.html#SEC17">2.12 checkvpw-presetuid</A>
+<LI><A NAME="TOC18" HREF="configuration.html#SEC18">2.13 default-expiry</A>
+<LI><A NAME="TOC19" HREF="configuration.html#SEC19">2.14 default-maildir</A>
+<LI><A NAME="TOC20" HREF="configuration.html#SEC20">2.15 default-msgcount</A>
+<LI><A NAME="TOC21" HREF="configuration.html#SEC21">2.16 default-msgsize</A>
+<LI><A NAME="TOC22" HREF="configuration.html#SEC22">2.17 default-hardquota</A>
+<LI><A NAME="TOC23" HREF="configuration.html#SEC23">2.18 default-softquota</A>
+<LI><A NAME="TOC24" HREF="configuration.html#SEC24">2.19 default-username</A>
+<LI><A NAME="TOC25" HREF="configuration.html#SEC25">2.20 error-maildir</A>
+<LI><A NAME="TOC26" HREF="configuration.html#SEC26">2.21 global-bulletin-dir</A>
+<LI><A NAME="TOC27" HREF="configuration.html#SEC27">2.22 maildir-arg-str</A>
+<LI><A NAME="TOC28" HREF="configuration.html#SEC28">2.23 password-file</A>
+<LI><A NAME="TOC29" HREF="configuration.html#SEC29">2.24 postmaster-aliases</A>
+<LI><A NAME="TOC30" HREF="configuration.html#SEC30">2.25 postmaster-email</A>
+<LI><A NAME="TOC31" HREF="configuration.html#SEC31">2.26 qmail-root</A>
+<LI><A NAME="TOC32" HREF="configuration.html#SEC32">2.27 separators</A>
+<LI><A NAME="TOC33" HREF="configuration.html#SEC33">2.28 socket-file</A>
+<LI><A NAME="TOC34" HREF="configuration.html#SEC34">2.29 user-dir</A>
+<LI><A NAME="TOC35" HREF="configuration.html#SEC35">2.30 user-dir-bits</A>
+<LI><A NAME="TOC36" HREF="configuration.html#SEC36">2.31 user-dir-slices</A>
+<LI><A NAME="TOC37" HREF="configuration.html#SEC37">2.32 vdeliver-postdeliver</A>
+<LI><A NAME="TOC38" HREF="configuration.html#SEC38">2.33 vdeliver-predeliver</A>
+<LI><A NAME="TOC39" HREF="configuration.html#SEC39">2.34 vsetup-pre</A>
+<LI><A NAME="TOC40" HREF="configuration.html#SEC40">2.35 vsetup-pre</A>
+</UL>
+</UL>
+<P><HR><P>
+
+
+<H1><A NAME="SEC1" HREF="configuration.html#TOC1">1. General Information</A></H1>
+
+
+
+<H2><A NAME="SEC2" HREF="configuration.html#TOC2">1.1 Search Order</A></H2>
+
+<P>
+The system will look for the configuration files listed below in one of
+the following three locations, in the order they are listed:
+
+<OL>
+<LI>The domain-local configuration directory
+
+<LI>The user-local configuration directory
+
+<LI>The global configuration directory
+
+</OL>
+
+<P>
+The global configuration directory is set to <TT>`/etc/vmailmgr'</TT> by
+default.
+The user-local and domain-local configuration directories (for now, one
+and the same) are a subdirectory, named <TT>`.vmailmgr'</TT> by default, of
+either the user's home directory or the domain subdirectory.  
+If a file matching the configuration name is found in one of the local
+directories, the search stops and it is not searched for in any
+higher up directories.
+
+
+
+
+<H2><A NAME="SEC3" HREF="configuration.html#TOC3">1.2 File Types</A></H2>
+
+<P>
+Each of the configuration files falls into one of the following types:
+
+
+<DL COMPACT>
+
+<DT>String
+<DD>
+A single line is read from this type and used as-is with no conversion.
+All data after the first line is ignored.
+
+<DT>Directory
+<DD>
+A single line is read from this type.
+If it does not have a trailing slash (<SAMP>`/'</SAMP>), one is appended.
+All data after the first line is ignored.
+
+<DT>Number
+<DD>
+A single line is read from this type and converted to an unsigned
+integer.
+If the conversion succeeds, the value is used.
+All data after the first line is ignored.
+
+<DT>List
+<DD>
+Each line of the file is read, stripped of leading and trailing
+whitespace, and treated as a separate value.
+Lines that contain only whitespace (ie blank lines) or lines beginning
+with a pound symbol (<SAMP>`#'</SAMP>) are ignored.
+
+<DT>Executable
+<DD>
+If the execute bits on the file are set, it is treated as an executable
+file and is executed with no interpretation by vmailmgr.
+The the Command Execution section below for details.
+
+</DL>
+
+<P>
+All lines are stripped of any leading or trailing white space.
+
+
+<P>
+Configuration files marked as <SAMP>`(global only)'</SAMP> are read
+before any user-level processing occurrs, and so are not functional in
+the user-level configuration.
+
+
+
+
+<H2><A NAME="SEC4" HREF="configuration.html#TOC4">1.3 Command Execution</A></H2>
+
+<P>
+The following rules apply to executing a single command or a list of
+commands.
+
+
+<P>
+The executables are searched in reverse order of the configuration
+files.
+That is, the global setting is used first, and then the local settings.
+If the named file either does not exist in a directory or is not
+executable, that directory is skipped.
+
+
+<P>
+A command exit code of <SAMP>`99'</SAMP> indicates that the command completed
+successfully but no further commands should be executed.
+All other non-zero exit codes are treated as an error and will cause the
+invoking program to stop with the same error code.
+For <TT>`vdeliver'</TT>, an error exit of 111 will be passed up to qmail as a
+temporary error, and an error exit of 100 will be passed up as a
+permanent failure.
+See the <TT>`qmail-command'</TT> man page for full details on delivery error
+codes.
+For <TT>`checkvpw'</TT>, any non-zero exit code (except as described above)
+will cause authentication to fail.
+
+
+<P>
+The following environment variables will be set (where applicable):
+
+
+<DL COMPACT>
+
+<DT><SAMP>`HOME'</SAMP>
+<DD>
+The home directory of the real user.
+<DT><SAMP>`MAILDIR'</SAMP>
+<DD>
+The mail directory of the real or virtual user.
+<DT><SAMP>`USER'</SAMP>
+<DD>
+The real user's name.
+<DT><SAMP>`VUSER'</SAMP>
+<DD>
+The virtual user's name.
+For base user logins, this is blank, and all the following items
+prefixed with <SAMP>`VUSER_'</SAMP> are not set.
+<DT><SAMP>`VUSER_CTIME'</SAMP>
+<DD>
+The virtual user's creation time (or "0" if unknown).
+<DT><SAMP>`VUSER_EXPIRY'</SAMP>
+<DD>
+The virtual user's expiry time (or "-" if not applicable).
+<DT><SAMP>`VUSER_HARDQUOTA'</SAMP>
+<DD>
+The virtual user's total size hard quota (in bytes, or "-" if not applicable).
+<DT><SAMP>`VUSER_MSGCOUNT'</SAMP>
+<DD>
+The virtual user's message count limit (or "-" if not applicable).
+<DT><SAMP>`VUSER_MSGSIZE'</SAMP>
+<DD>
+The virtual user's message size limit (or "-" if not applicable).
+<DT><SAMP>`VUSER_PERSONAL'</SAMP>
+<DD>
+The virtual user's personal data.
+<DT><SAMP>`VUSER_SOFTQUOTA'</SAMP>
+<DD>
+The virtual user's total size soft quota (in bytes, or "-" if not applicable).
+</DL>
+
+
+
+<H1><A NAME="SEC5" HREF="configuration.html#TOC5">2. Configuration Files</A></H1>
+
+<P>
+Each of the following sections identifies a single configuration file
+
+
+
+
+<H2><A NAME="SEC6" HREF="configuration.html#TOC6">2.1 authvmailmgr-error</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+authvmailmgr
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by authvmailmgr if any error occurrs other than those
+caught by <TT>`authvmailmgr-loginfail'</TT> below.
+The environment variable <CODE>AUTHVMAILMGR_ERROR</CODE> will contain an error
+message.
+This can be used to output logging messages about errors in authvmailmgr.
+</DL>
+
+
+
+<H2><A NAME="SEC7" HREF="configuration.html#TOC7">2.2 authvmailmgr-loginfail</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+authvmailmgr
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by authvmailmgr if the user's login fails.
+The environment variable <CODE>AUTHVMAILMGR_ERROR</CODE> will contain an error
+message.
+The environment variable <CODE>VUSER</CODE> will be set to the virtual user
+name if it has been determined.
+This can be used to output logging messages about login failures or to
+throttle hackers.
+</DL>
+
+
+
+<H2><A NAME="SEC8" HREF="configuration.html#TOC8">2.3 authvmailmgr-postsetuid</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+@samp {vpopbull}
+<DT><STRONG>Used By</STRONG>
+<DD>
+authvmailmgr
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by authvmailmgr after a user is successfully authenticated.
+</DL>
+
+
+
+<H2><A NAME="SEC9" HREF="configuration.html#TOC9">2.4 authvmailmgr-presetuid</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+authvmailmgr
+<DT><STRONG>Description</STRONG>
+<DD>
+This list is executed by authvmailmgr before changing user away from root,
+and before authenticating a virtual user.
+Note: The environment variable <SAMP>`MAILDIR'</SAMP> is not set since the
+virtual user has not yet been authenticated, or even looked up
+at this point.
+For the same reason, <SAMP>`VUSER'</SAMP> is not authenticated and is under
+complete control of the invoking user.
+</DL>
+
+
+
+<H2><A NAME="SEC10" HREF="configuration.html#TOC10">2.5 autoresponse-dir</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+directory
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`autoresponse'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd, autoresponder script
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the subdirectory of the virtual user directory in which all
+autoresponse data is stored.
+</DL>
+
+
+
+<H2><A NAME="SEC11" HREF="configuration.html#TOC11">2.6 autoresponse-file</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`message.txt'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd, autoresponder script
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the file name within the autoresponse directory that contains
+the autoresponse message.
+</DL>
+
+
+
+<H2><A NAME="SEC12" HREF="configuration.html#TOC12">2.7 bulletin-dir</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+directory
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`bulletins'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the subdirectory of the domain directory in which bulletins
+local to a domain are stored.
+</DL>
+
+
+
+<H2><A NAME="SEC13" HREF="configuration.html#TOC13">2.8 checkvpw-error</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by checkvpw if any error occurrs other than those
+caught by <TT>`checkvpw-loginfail'</TT> below.
+The environment variable <CODE>CHECKVPW_ERROR</CODE> will contain an error
+message.
+This can be used to output logging messages about errors in checkvpw.
+</DL>
+
+
+
+<H2><A NAME="SEC14" HREF="configuration.html#TOC14">2.9 checkvpw-loginfail</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by checkvpw if the user's login fails.
+The environment variable <CODE>CHECKVPW_ERROR</CODE> will contain an error
+message.
+The environment variable <CODE>VUSER</CODE> will be set to the virtual user
+name if it has been determined.
+This can be used to output logging messages about login failures or to
+throttle hackers.
+</DL>
+
+
+
+<H2><A NAME="SEC15" HREF="configuration.html#TOC15">2.10 checkvpw-postexec</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by checkvpw after the subcommand successfully completes.
+</DL>
+
+
+
+<H2><A NAME="SEC16" HREF="configuration.html#TOC16">2.11 checkvpw-postsetuid</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+@samp {vpopbull}
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+This is executed by checkvpw after a user is successfully authenticated.
+</DL>
+
+
+
+<H2><A NAME="SEC17" HREF="configuration.html#TOC17">2.12 checkvpw-presetuid</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+This list is executed by checkvpw before changing user away from root,
+and before authenticating a virtual user.
+Note: The environment variable <SAMP>`MAILDIR'</SAMP> is not set since the
+virtual user has not yet been authenticated, or even looked up
+at this point.
+For the same reason, <SAMP>`VUSER'</SAMP> is not authenticated and is under
+complete control of the invoking user.
+</DL>
+
+
+
+<H2><A NAME="SEC18" HREF="configuration.html#TOC18">2.13 default-expiry</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+number
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`-1'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vadduser
+<DT><STRONG>Description</STRONG>
+<DD>
+Sets the default expiry value for newly created users.
+Negative values indicate no expiry.
+</DL>
+
+
+
+<H2><A NAME="SEC19" HREF="configuration.html#TOC19">2.14 default-maildir</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+directory
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`Maildir'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+Sets the name of the directory to be used as a non-virtual user's maildir.
+</DL>
+
+
+
+<H2><A NAME="SEC20" HREF="configuration.html#TOC20">2.15 default-msgcount</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+number
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`-1'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vadduser
+<DT><STRONG>Description</STRONG>
+<DD>
+Sets the default message count limit.
+</DL>
+
+
+
+<H2><A NAME="SEC21" HREF="configuration.html#TOC21">2.16 default-msgsize</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+number
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`-1'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vadduser
+<DT><STRONG>Description</STRONG>
+<DD>
+Sets the default message size limit, in bytes.
+</DL>
+
+
+
+<H2><A NAME="SEC22" HREF="configuration.html#TOC22">2.17 default-hardquota</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+number
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`-1'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vadduser
+<DT><STRONG>Description</STRONG>
+<DD>
+Sets the default hard quota, in bytes.
+</DL>
+
+
+
+<H2><A NAME="SEC23" HREF="configuration.html#TOC23">2.18 default-softquota</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+number
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`-1'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vadduser
+<DT><STRONG>Description</STRONG>
+<DD>
+Sets the default soft quota, in bytes.
+</DL>
+
+
+
+<H2><A NAME="SEC24" HREF="configuration.html#TOC24">2.19 default-username</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`+'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the name of the virtual user to be looked up if a lookup of
+another virtual user fails.
+</DL>
+
+
+
+<H2><A NAME="SEC25" HREF="configuration.html#TOC25">2.20 error-maildir</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+directory
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`/var/lib/vmailmgr/error-maildir'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+Specifies the path of a read-only maildir containing a message to be
+sent to the user when the maildir corresponding to that user does not
+exist.
+</DL>
+
+
+
+<H2><A NAME="SEC26" HREF="configuration.html#TOC26">2.21 global-bulletin-dir</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+directory
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`/var/spool/bulletins'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies a site-wide bulletin directory.
+</DL>
+
+
+
+<H2><A NAME="SEC27" HREF="configuration.html#TOC27">2.22 maildir-arg-str</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`maildir'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw (global only)
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the string to search for when attempting to identify the
+maildir argument on the command line to checkvpw.
+</DL>
+
+
+
+<H2><A NAME="SEC28" HREF="configuration.html#TOC28">2.23 password-file</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`passwd'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd and command-line programs
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the file that contains user names, passwords, and
+destinations for a virtual domain.
+Note that this has nothing to do with "real" users, for which the
+password file is determined by the system libraries.
+</DL>
+
+
+
+<H2><A NAME="SEC29" HREF="configuration.html#TOC29">2.24 postmaster-aliases</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+list
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`mailer-daemon'</SAMP>
+<SAMP>`postmaster'</SAMP>
+<SAMP>`root'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vsetup
+<DT><STRONG>Description</STRONG>
+<DD>
+A list of aliases to the postmaster email address to set
+up when creating a new virtual domain with the vsetup command.
+This should <EM>always</EM> contain both <SAMP>`postmaster'</SAMP> and
+<SAMP>`mailer-daemon'</SAMP> (required by the RFCs), and should usually contain
+<SAMP>`root'</SAMP>.
+</DL>
+
+
+
+<H2><A NAME="SEC30" HREF="configuration.html#TOC30">2.25 postmaster-email</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`postmaster@'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vsetup
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the email address of the entity responsible
+for the administration of the (virtual) host when building the
+postmaster aliases above.
+If this value ends with a trailing <SAMP>`@'</SAMP>, the value of
+<TT>`/var/qmail/control/me'</TT> is filled in for the host name.
+If no <SAMP>`@'</SAMP> is present, the current virtual host name
+is filled in by vdeliver.
+If this is set to <SAMP>`postmaster'</SAMP>, a mail loop
+will result and all mail to this address will bounce.
+</DL>
+
+
+
+<H2><A NAME="SEC31" HREF="configuration.html#TOC31">2.26 qmail-root</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`/var/qmail'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw, vdeliver, vmailmgrd
+<DT><STRONG>Description</STRONG>
+<DD>
+Specifies the location of the base directory of your qmail install.
+Set this to whatever you put into <TT>`conf-home'</TT> when you built and
+installed qmail.
+</DL>
+
+
+
+<H2><A NAME="SEC32" HREF="configuration.html#TOC32">2.27 separators</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`@:'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+checkvpw (global only)
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the set of valid separators within a user login name between
+the virtual user name and virtual domain name when logging in via
+checkvpw.
+For example, if separators contains <SAMP>`@:'</SAMP> then <SAMP>`user@domain'</SAMP> and
+<SAMP>`user:domain'</SAMP> are equivalent POP mailbox names.
+</DL>
+
+
+
+<H2><A NAME="SEC33" HREF="configuration.html#TOC33">2.28 socket-file</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+string
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`/tmp/.vmailmgrd'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd, checkvpw, vdeliver, and the CGI programs
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the file name of the local socket used to
+communicate between the vmailmgr daemon and the other programs.
+<EM>Warning:</EM> Changing this in the local configuration directories
+will cause vdeliver to fail.
+</DL>
+
+
+
+<H2><A NAME="SEC34" HREF="configuration.html#TOC34">2.29 user-dir</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+directory
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`users'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd and command-line programs
+<DT><STRONG>Description</STRONG>
+<DD>
+Identifies the subdirectory from the virtual domain directory in which a
+virtual user's maildir will be created.
+Since this maildir is recorded in the password table, it does not have
+to be the same for each user within a domain.
+This is prefixed with <SAMP>`./'</SAMP> before it is used in the password table.
+</DL>
+
+
+
+<H2><A NAME="SEC35" HREF="configuration.html#TOC35">2.30 user-dir-bits</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`0'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd and command-line programs when creating new users.
+<DT><STRONG>Description</STRONG>
+<DD>
+See section <A HREF="configuration.html#SEC36">2.31 user-dir-slices</A>
+</DL>
+
+
+
+<H2><A NAME="SEC36" HREF="configuration.html#TOC36">2.31 user-dir-slices</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+<DT><STRONG>Default</STRONG>
+<DD>
+<SAMP>`0'</SAMP>
+<DT><STRONG>Used By</STRONG>
+<DD>
+vmailmgrd and command-line programs when creating new users.
+<DT><STRONG>Description</STRONG>
+<DD>
+<TT>`user-dir-bits'</TT> and <TT>`user-dir-slices'</TT> work together.  When creating a
+new user directory name, a hash code is generated on the name of the
+new user.  This hash code is split into <TT>`user-dir-slices'</TT> pieces, each
+<TT>`user-dir-bits'</TT> bits long.  Each of these pieces is translated to an
+ASCII string by converting the binary code to hexadecimal.  The
+resulting user directory name is then composed of:
+
+<UL>
+<LI>the base users directory, followed by a <SAMP>`/'</SAMP>
+
+<LI>each of the string pieces, each followed by a <SAMP>`/'</SAMP>
+
+<LI>the user's name
+
+</UL>
+
+For example, with <TT>`user-dir-bits'</TT> set to 6 and
+<TT>`user-dir-slices'</TT> set to 1, a user
+named <SAMP>`c'</SAMP> maps to a directory name of <SAMP>`users/2f/c/'</SAMP>.
+</DL>
+
+
+
+<H2><A NAME="SEC37" HREF="configuration.html#TOC37">2.32 vdeliver-postdeliver</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+vdeliver
+<DT><STRONG>Description</STRONG>
+<DD>
+This list is executed after the delivery is successfully
+completed.
+Since vdeliver expects <SAMP>`USER'</SAMP> and <SAMP>`HOME'</SAMP> to be set, it does
+not set them itself.
+If the command returns with an error code, a warning is printed, but
+delivery does not fail, as failure would lead to duplicates.
+</DL>
+
+
+
+<H2><A NAME="SEC38" HREF="configuration.html#TOC38">2.33 vdeliver-predeliver</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+vdeliver
+<DT><STRONG>Description</STRONG>
+<DD>
+This list is executed before the delivery is attempted, but
+after the virtual user information is looked up.
+Since vdeliver expects <SAMP>`USER'</SAMP> and <SAMP>`HOME'</SAMP> to be set, it does
+not set them itself.
+</DL>
+
+
+
+<H2><A NAME="SEC39" HREF="configuration.html#TOC39">2.34 vsetup-pre</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+vsetup
+<DT><STRONG>Description</STRONG>
+<DD>
+This list is executed after the vsetup command has sucessfully done
+everything else.
+</DL>
+
+
+
+<H2><A NAME="SEC40" HREF="configuration.html#TOC40">2.35 vsetup-pre</A></H2>
+
+<DL COMPACT>
+
+<DT><STRONG>Type</STRONG>
+<DD>
+executable
+<DT><STRONG>Default</STRONG>
+<DD>
+Empty
+<DT><STRONG>Used By</STRONG>
+<DD>
+vsetup
+<DT><STRONG>Description</STRONG>
+<DD>
+This list is executed before the vsetup command makes any changes.
+</DL>
+
+<P><HR><P>
+This document was generated on 14 September 2000 using
+<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
+</BODY>
+</HTML>
vmailmgr