doc/configuration.info
changeset 2 b3afb9f1e801
equal deleted inserted replaced
1:30113bfbe723 2:b3afb9f1e801
       
     1 This is configuration.info, produced by makeinfo version 4.7 from
       
     2 configuration.texi.
       
     3 
       
     4      Copyright (C) 1998 Bruce Guenter
       
     5 
       
     6 
       
     7 File: configuration.info,  Node: Top,  Next: General Information,  Prev: (dir),  Up: (dir)
       
     8 
       
     9 * Menu:
       
    10 
       
    11 * General Information::
       
    12 * Configuration Files::
       
    13 
       
    14 
       
    15 File: configuration.info,  Node: General Information,  Next: Configuration Files,  Prev: Top,  Up: Top
       
    16 
       
    17 1 General Information
       
    18 *********************
       
    19 
       
    20 * Menu:
       
    21 
       
    22 * Search Order::
       
    23 * File Types::
       
    24 * Command Execution::
       
    25 
       
    26 
       
    27 File: configuration.info,  Node: Search Order,  Next: File Types,  Prev: General Information,  Up: General Information
       
    28 
       
    29 1.1 Search Order
       
    30 ================
       
    31 
       
    32 The system will look for the configuration files listed below in one of
       
    33 the following three locations, in the order they are listed:
       
    34   1. The domain-local configuration directory
       
    35 
       
    36   2. The user-local configuration directory
       
    37 
       
    38   3. The global configuration directory
       
    39           The global configuration directory is set to `/etc/vmailmgr'
       
    40 by default.  The user-local and domain-local configuration directories
       
    41 (for now, one and the same) are a subdirectory, named `.vmailmgr' by
       
    42 default, of either the user's home directory or the domain subdirectory.
       
    43 If a file matching the configuration name is found in one of the local
       
    44 directories, the search stops and it is not searched for in any higher
       
    45 up directories.
       
    46 
       
    47 
       
    48 File: configuration.info,  Node: File Types,  Next: Command Execution,  Prev: Search Order,  Up: General Information
       
    49 
       
    50 1.2 File Types
       
    51 ==============
       
    52 
       
    53 Each of the configuration files falls into one of the following types:
       
    54 
       
    55 String
       
    56      A single line is read from this type and used as-is with no
       
    57      conversion.  All data after the first line is ignored.
       
    58 
       
    59 Directory
       
    60      A single line is read from this type.  If it does not have a
       
    61      trailing slash (`/'), one is appended.  All data after the first
       
    62      line is ignored.
       
    63 
       
    64 Number
       
    65      A single line is read from this type and converted to an unsigned
       
    66      integer.  If the conversion succeeds, the value is used.  All data
       
    67      after the first line is ignored.
       
    68 
       
    69 List
       
    70      Each line of the file is read, stripped of leading and trailing
       
    71      whitespace, and treated as a separate value.  Lines that contain
       
    72      only whitespace (ie blank lines) or lines beginning with a pound
       
    73      symbol (`#') are ignored.
       
    74 
       
    75 Executable
       
    76      If the execute bits on the file are set, it is treated as an
       
    77      executable file and is executed with no interpretation by vmailmgr.
       
    78      The the Command Execution section below for details.
       
    79 
       
    80 
       
    81      All lines are stripped of any leading or trailing white space.
       
    82 
       
    83      Configuration files marked as `(global only)' are read before any
       
    84 user-level processing occurrs, and so are not functional in the
       
    85 user-level configuration.
       
    86 
       
    87 
       
    88 File: configuration.info,  Node: Command Execution,  Prev: File Types,  Up: General Information
       
    89 
       
    90 1.3 Command Execution
       
    91 =====================
       
    92 
       
    93 The following rules apply to executing a single command or a list of
       
    94 commands.
       
    95 
       
    96      The executables are searched in reverse order of the configuration
       
    97 files.  That is, the global setting is used first, and then the local
       
    98 settings.  If the named file either does not exist in a directory or is
       
    99 not executable, that directory is skipped.
       
   100 
       
   101      A command exit code of `99' indicates that the command completed
       
   102 successfully but no further commands should be executed.  All other
       
   103 non-zero exit codes are treated as an error and will cause the invoking
       
   104 program to stop with the same error code.  For `vdeliver', an error
       
   105 exit of 111 will be passed up to qmail as a temporary error, and an
       
   106 error exit of 100 will be passed up as a permanent failure.  See the
       
   107 `qmail-command' man page for full details on delivery error codes.  For
       
   108 `checkvpw', any non-zero exit code (except as described above) will
       
   109 cause authentication to fail.
       
   110 
       
   111      The following environment variables will be set (where applicable):
       
   112 
       
   113 `HOME'
       
   114      The home directory of the real user.
       
   115 
       
   116 `MAILDIR'
       
   117      The mail directory of the real or virtual user.
       
   118 
       
   119 `USER'
       
   120      The real user's name.
       
   121 
       
   122 `VUSER'
       
   123      The virtual user's name.  For base user logins, this is blank, and
       
   124      all the following items prefixed with `VUSER_' are not set.
       
   125 
       
   126 `VUSER_CTIME'
       
   127      The virtual user's creation time (or "0" if unknown).
       
   128 
       
   129 `VUSER_EXPIRY'
       
   130      The virtual user's expiry time (or "-" if not applicable).
       
   131 
       
   132 `VUSER_HARDQUOTA'
       
   133      The virtual user's total size hard quota (in bytes, or "-" if not
       
   134      applicable).
       
   135 
       
   136 `VUSER_MSGCOUNT'
       
   137      The virtual user's message count limit (or "-" if not applicable).
       
   138 
       
   139 `VUSER_MSGSIZE'
       
   140      The virtual user's message size limit (or "-" if not applicable).
       
   141 
       
   142 `VUSER_PERSONAL'
       
   143      The virtual user's personal data.
       
   144 
       
   145 `VUSER_SOFTQUOTA'
       
   146      The virtual user's total size soft quota (in bytes, or "-" if not
       
   147      applicable).
       
   148 
       
   149 
       
   150 File: configuration.info,  Node: Configuration Files,  Prev: General Information,  Up: Top
       
   151 
       
   152 2 Configuration Files
       
   153 *********************
       
   154 
       
   155 Each of the following sections identifies a single configuration file
       
   156 
       
   157 * Menu:
       
   158 
       
   159 * authvmailmgr-error::
       
   160 * authvmailmgr-loginfail::
       
   161 * authvmailmgr-postsetuid::
       
   162 * authvmailmgr-presetuid::
       
   163 * autoresponse-dir::
       
   164 * autoresponse-file::
       
   165 * bulletin-dir::
       
   166 * checkvpw-error::
       
   167 * checkvpw-loginfail::
       
   168 * checkvpw-postexec::
       
   169 * checkvpw-postsetuid::
       
   170 * checkvpw-presetuid::
       
   171 * default-expiry::
       
   172 * default-maildir::
       
   173 * default-msgcount::
       
   174 * default-msgsize::
       
   175 * default-hardquota::
       
   176 * default-softquota::
       
   177 * default-username::
       
   178 * error-maildir::
       
   179 * global-bulletin-dir::
       
   180 * maildir-arg-str::
       
   181 * password-file::
       
   182 * postmaster-aliases::
       
   183 * postmaster-email::
       
   184 * qmail-root::
       
   185 * separators::
       
   186 * socket-file::
       
   187 * user-dir::
       
   188 * user-dir-bits::
       
   189 * user-dir-slices::
       
   190 * vdeliver-postdeliver::
       
   191 * vdeliver-predeliver::
       
   192 * vsetup-post::
       
   193 * vsetup-pre::
       
   194 
       
   195 
       
   196 File: configuration.info,  Node: authvmailmgr-error,  Next: authvmailmgr-loginfail,  Prev: Configuration Files,  Up: Configuration Files
       
   197 
       
   198 2.1 authvmailmgr-error
       
   199 ======================
       
   200 
       
   201 *Type*
       
   202      executable
       
   203 
       
   204 *Default*
       
   205      Empty
       
   206 
       
   207 *Used By*
       
   208      authvmailmgr
       
   209 
       
   210 *Description*
       
   211      This is executed by authvmailmgr if any error occurrs other than
       
   212      those caught by `authvmailmgr-loginfail' below.  The environment
       
   213      variable `AUTHVMAILMGR_ERROR' will contain an error message.  This
       
   214      can be used to output logging messages about errors in
       
   215      authvmailmgr.
       
   216 
       
   217 
       
   218 File: configuration.info,  Node: authvmailmgr-loginfail,  Next: authvmailmgr-postsetuid,  Prev: authvmailmgr-error,  Up: Configuration Files
       
   219 
       
   220 2.2 authvmailmgr-loginfail
       
   221 ==========================
       
   222 
       
   223 *Type*
       
   224      executable
       
   225 
       
   226 *Default*
       
   227      Empty
       
   228 
       
   229 *Used By*
       
   230      authvmailmgr
       
   231 
       
   232 *Description*
       
   233      This is executed by authvmailmgr if the user's login fails.  The
       
   234      environment variable `AUTHVMAILMGR_ERROR' will contain an error
       
   235      message.  The environment variable `VUSER' will be set to the
       
   236      virtual user name if it has been determined.  This can be used to
       
   237      output logging messages about login failures or to throttle
       
   238      hackers.
       
   239 
       
   240 
       
   241 File: configuration.info,  Node: authvmailmgr-postsetuid,  Next: authvmailmgr-presetuid,  Prev: authvmailmgr-loginfail,  Up: Configuration Files
       
   242 
       
   243 2.3 authvmailmgr-postsetuid
       
   244 ===========================
       
   245 
       
   246 *Type*
       
   247      executable
       
   248 
       
   249 *Default*
       
   250      `vpopbull'
       
   251 
       
   252 *Used By*
       
   253      authvmailmgr
       
   254 
       
   255 *Description*
       
   256      This is executed by authvmailmgr after a user is successfully
       
   257      authenticated.
       
   258 
       
   259 
       
   260 File: configuration.info,  Node: authvmailmgr-presetuid,  Next: autoresponse-dir,  Prev: authvmailmgr-postsetuid,  Up: Configuration Files
       
   261 
       
   262 2.4 authvmailmgr-presetuid
       
   263 ==========================
       
   264 
       
   265 *Type*
       
   266      executable
       
   267 
       
   268 *Default*
       
   269      Empty
       
   270 
       
   271 *Used By*
       
   272      authvmailmgr
       
   273 
       
   274 *Description*
       
   275      This list is executed by authvmailmgr before changing user away
       
   276      from root, and before authenticating a virtual user.  Note: The
       
   277      environment variable `MAILDIR' is not set since the virtual user
       
   278      has not yet been authenticated, or even looked up at this point.
       
   279      For the same reason, `VUSER' is not authenticated and is under
       
   280      complete control of the invoking user.
       
   281 
       
   282 
       
   283 File: configuration.info,  Node: autoresponse-dir,  Next: autoresponse-file,  Prev: authvmailmgr-presetuid,  Up: Configuration Files
       
   284 
       
   285 2.5 autoresponse-dir
       
   286 ====================
       
   287 
       
   288 *Type*
       
   289      directory
       
   290 
       
   291 *Default*
       
   292      `autoresponse'
       
   293 
       
   294 *Used By*
       
   295      vmailmgrd, autoresponder script
       
   296 
       
   297 *Description*
       
   298      Identifies the subdirectory of the virtual user directory in which
       
   299      all autoresponse data is stored.
       
   300 
       
   301 
       
   302 File: configuration.info,  Node: autoresponse-file,  Next: bulletin-dir,  Prev: autoresponse-dir,  Up: Configuration Files
       
   303 
       
   304 2.6 autoresponse-file
       
   305 =====================
       
   306 
       
   307 *Type*
       
   308      string
       
   309 
       
   310 *Default*
       
   311      `message.txt'
       
   312 
       
   313 *Used By*
       
   314      vmailmgrd, autoresponder script
       
   315 
       
   316 *Description*
       
   317      Identifies the file name within the autoresponse directory that
       
   318      contains the autoresponse message.
       
   319 
       
   320 
       
   321 File: configuration.info,  Node: bulletin-dir,  Next: checkvpw-error,  Prev: autoresponse-file,  Up: Configuration Files
       
   322 
       
   323 2.7 bulletin-dir
       
   324 ================
       
   325 
       
   326 *Type*
       
   327      directory
       
   328 
       
   329 *Default*
       
   330      `bulletins'
       
   331 
       
   332 *Used By*
       
   333      checkvpw
       
   334 
       
   335 *Description*
       
   336      Identifies the subdirectory of the domain directory in which
       
   337      bulletins local to a domain are stored.
       
   338 
       
   339 
       
   340 File: configuration.info,  Node: checkvpw-error,  Next: checkvpw-loginfail,  Prev: bulletin-dir,  Up: Configuration Files
       
   341 
       
   342 2.8 checkvpw-error
       
   343 ==================
       
   344 
       
   345 *Type*
       
   346      executable
       
   347 
       
   348 *Default*
       
   349      Empty
       
   350 
       
   351 *Used By*
       
   352      checkvpw
       
   353 
       
   354 *Description*
       
   355      This is executed by checkvpw if any error occurrs other than those
       
   356      caught by `checkvpw-loginfail' below.  The environment variable
       
   357      `CHECKVPW_ERROR' will contain an error message.  This can be used
       
   358      to output logging messages about errors in checkvpw.
       
   359 
       
   360 
       
   361 File: configuration.info,  Node: checkvpw-loginfail,  Next: checkvpw-postexec,  Prev: checkvpw-error,  Up: Configuration Files
       
   362 
       
   363 2.9 checkvpw-loginfail
       
   364 ======================
       
   365 
       
   366 *Type*
       
   367      executable
       
   368 
       
   369 *Default*
       
   370      Empty
       
   371 
       
   372 *Used By*
       
   373      checkvpw
       
   374 
       
   375 *Description*
       
   376      This is executed by checkvpw if the user's login fails.  The
       
   377      environment variable `CHECKVPW_ERROR' will contain an error
       
   378      message.  The environment variable `VUSER' will be set to the
       
   379      virtual user name if it has been determined.  This can be used to
       
   380      output logging messages about login failures or to throttle
       
   381      hackers.
       
   382 
       
   383 
       
   384 File: configuration.info,  Node: checkvpw-postexec,  Next: checkvpw-postsetuid,  Prev: checkvpw-loginfail,  Up: Configuration Files
       
   385 
       
   386 2.10 checkvpw-postexec
       
   387 ======================
       
   388 
       
   389 *Type*
       
   390      executable
       
   391 
       
   392 *Default*
       
   393      Empty
       
   394 
       
   395 *Used By*
       
   396      checkvpw
       
   397 
       
   398 *Description*
       
   399      This is executed by checkvpw after the subcommand successfully
       
   400      completes.
       
   401 
       
   402 
       
   403 File: configuration.info,  Node: checkvpw-postsetuid,  Next: checkvpw-presetuid,  Prev: checkvpw-postexec,  Up: Configuration Files
       
   404 
       
   405 2.11 checkvpw-postsetuid
       
   406 ========================
       
   407 
       
   408 *Type*
       
   409      executable
       
   410 
       
   411 *Default*
       
   412      `vpopbull'
       
   413 
       
   414 *Used By*
       
   415      checkvpw
       
   416 
       
   417 *Description*
       
   418      This is executed by checkvpw after a user is successfully
       
   419      authenticated.
       
   420 
       
   421 
       
   422 File: configuration.info,  Node: checkvpw-presetuid,  Next: default-expiry,  Prev: checkvpw-postsetuid,  Up: Configuration Files
       
   423 
       
   424 2.12 checkvpw-presetuid
       
   425 =======================
       
   426 
       
   427 *Type*
       
   428      executable
       
   429 
       
   430 *Default*
       
   431      Empty
       
   432 
       
   433 *Used By*
       
   434      checkvpw
       
   435 
       
   436 *Description*
       
   437      This list is executed by checkvpw before changing user away from
       
   438      root, and before authenticating a virtual user.  Note: The
       
   439      environment variable `MAILDIR' is not set since the virtual user
       
   440      has not yet been authenticated, or even looked up at this point.
       
   441      For the same reason, `VUSER' is not authenticated and is under
       
   442      complete control of the invoking user.
       
   443 
       
   444 
       
   445 File: configuration.info,  Node: default-expiry,  Next: default-maildir,  Prev: checkvpw-presetuid,  Up: Configuration Files
       
   446 
       
   447 2.13 default-expiry
       
   448 ===================
       
   449 
       
   450 *Type*
       
   451      number
       
   452 
       
   453 *Default*
       
   454      `-1'
       
   455 
       
   456 *Used By*
       
   457      vadduser
       
   458 
       
   459 *Description*
       
   460      Sets the default expiry value for newly created users.  Negative
       
   461      values indicate no expiry.
       
   462 
       
   463 
       
   464 File: configuration.info,  Node: default-maildir,  Next: default-msgcount,  Prev: default-expiry,  Up: Configuration Files
       
   465 
       
   466 2.14 default-maildir
       
   467 ====================
       
   468 
       
   469 *Type*
       
   470      directory
       
   471 
       
   472 *Default*
       
   473      `Maildir'
       
   474 
       
   475 *Used By*
       
   476      checkvpw
       
   477 
       
   478 *Description*
       
   479      Sets the name of the directory to be used as a non-virtual user's
       
   480      maildir.
       
   481 
       
   482 
       
   483 File: configuration.info,  Node: default-msgcount,  Next: default-msgsize,  Prev: default-maildir,  Up: Configuration Files
       
   484 
       
   485 2.15 default-msgcount
       
   486 =====================
       
   487 
       
   488 *Type*
       
   489      number
       
   490 
       
   491 *Default*
       
   492      `-1'
       
   493 
       
   494 *Used By*
       
   495      vadduser
       
   496 
       
   497 *Description*
       
   498      Sets the default message count limit.
       
   499 
       
   500 
       
   501 File: configuration.info,  Node: default-msgsize,  Next: default-hardquota,  Prev: default-msgcount,  Up: Configuration Files
       
   502 
       
   503 2.16 default-msgsize
       
   504 ====================
       
   505 
       
   506 *Type*
       
   507      number
       
   508 
       
   509 *Default*
       
   510      `-1'
       
   511 
       
   512 *Used By*
       
   513      vadduser
       
   514 
       
   515 *Description*
       
   516      Sets the default message size limit, in bytes.
       
   517 
       
   518 
       
   519 File: configuration.info,  Node: default-hardquota,  Next: default-softquota,  Prev: default-msgsize,  Up: Configuration Files
       
   520 
       
   521 2.17 default-hardquota
       
   522 ======================
       
   523 
       
   524 *Type*
       
   525      number
       
   526 
       
   527 *Default*
       
   528      `-1'
       
   529 
       
   530 *Used By*
       
   531      vadduser
       
   532 
       
   533 *Description*
       
   534      Sets the default hard quota, in bytes.
       
   535 
       
   536 
       
   537 File: configuration.info,  Node: default-softquota,  Next: default-username,  Prev: default-hardquota,  Up: Configuration Files
       
   538 
       
   539 2.18 default-softquota
       
   540 ======================
       
   541 
       
   542 *Type*
       
   543      number
       
   544 
       
   545 *Default*
       
   546      `-1'
       
   547 
       
   548 *Used By*
       
   549      vadduser
       
   550 
       
   551 *Description*
       
   552      Sets the default soft quota, in bytes.
       
   553 
       
   554 
       
   555 File: configuration.info,  Node: default-username,  Next: error-maildir,  Prev: default-softquota,  Up: Configuration Files
       
   556 
       
   557 2.19 default-username
       
   558 =====================
       
   559 
       
   560 *Type*
       
   561      string
       
   562 
       
   563 *Default*
       
   564      `+'
       
   565 
       
   566 *Used By*
       
   567      vmailmgrd
       
   568 
       
   569 *Description*
       
   570      Identifies the name of the virtual user to be looked up if a
       
   571      lookup of another virtual user fails.
       
   572 
       
   573 
       
   574 File: configuration.info,  Node: error-maildir,  Next: global-bulletin-dir,  Prev: default-username,  Up: Configuration Files
       
   575 
       
   576 2.20 error-maildir
       
   577 ==================
       
   578 
       
   579 *Type*
       
   580      directory
       
   581 
       
   582 *Default*
       
   583      `/var/lib/vmailmgr/error-maildir'
       
   584 
       
   585 *Used By*
       
   586      checkvpw
       
   587 
       
   588 *Description*
       
   589      Specifies the path of a read-only maildir containing a message to
       
   590      be sent to the user when the maildir corresponding to that user
       
   591      does not exist.
       
   592 
       
   593 
       
   594 File: configuration.info,  Node: global-bulletin-dir,  Next: maildir-arg-str,  Prev: error-maildir,  Up: Configuration Files
       
   595 
       
   596 2.21 global-bulletin-dir
       
   597 ========================
       
   598 
       
   599 *Type*
       
   600      directory
       
   601 
       
   602 *Default*
       
   603      `/var/spool/bulletins'
       
   604 
       
   605 *Used By*
       
   606      checkvpw
       
   607 
       
   608 *Description*
       
   609      Identifies a site-wide bulletin directory.
       
   610 
       
   611 
       
   612 File: configuration.info,  Node: maildir-arg-str,  Next: password-file,  Prev: global-bulletin-dir,  Up: Configuration Files
       
   613 
       
   614 2.22 maildir-arg-str
       
   615 ====================
       
   616 
       
   617 *Type*
       
   618      string
       
   619 
       
   620 *Default*
       
   621      `maildir'
       
   622 
       
   623 *Used By*
       
   624      checkvpw (global only)
       
   625 
       
   626 *Description*
       
   627      Identifies the string to search for when attempting to identify the
       
   628      maildir argument on the command line to checkvpw.
       
   629 
       
   630 
       
   631 File: configuration.info,  Node: password-file,  Next: postmaster-aliases,  Prev: maildir-arg-str,  Up: Configuration Files
       
   632 
       
   633 2.23 password-file
       
   634 ==================
       
   635 
       
   636 *Type*
       
   637      string
       
   638 
       
   639 *Default*
       
   640      `passwd'
       
   641 
       
   642 *Used By*
       
   643      vmailmgrd and command-line programs
       
   644 
       
   645 *Description*
       
   646      Identifies the file that contains user names, passwords, and
       
   647      destinations for a virtual domain.  Note that this has nothing to
       
   648      do with "real" users, for which the password file is determined by
       
   649      the system libraries.
       
   650 
       
   651 
       
   652 File: configuration.info,  Node: postmaster-aliases,  Next: postmaster-email,  Prev: password-file,  Up: Configuration Files
       
   653 
       
   654 2.24 postmaster-aliases
       
   655 =======================
       
   656 
       
   657 *Type*
       
   658      list
       
   659 
       
   660 *Default*
       
   661      `mailer-daemon' `postmaster' `root'
       
   662 
       
   663 *Used By*
       
   664      vsetup
       
   665 
       
   666 *Description*
       
   667      A list of aliases to the postmaster email address to set up when
       
   668      creating a new virtual domain with the vsetup command.  This
       
   669      should _always_ contain both `postmaster' and `mailer-daemon'
       
   670      (required by the RFCs), and should usually contain `root'.
       
   671 
       
   672 
       
   673 File: configuration.info,  Node: postmaster-email,  Next: qmail-root,  Prev: postmaster-aliases,  Up: Configuration Files
       
   674 
       
   675 2.25 postmaster-email
       
   676 =====================
       
   677 
       
   678 *Type*
       
   679      string
       
   680 
       
   681 *Default*
       
   682      `postmaster@'
       
   683 
       
   684 *Used By*
       
   685      vsetup
       
   686 
       
   687 *Description*
       
   688      Identifies the email address of the entity responsible for the
       
   689      administration of the (virtual) host when building the postmaster
       
   690      aliases above.  If this value ends with a trailing `@', the value
       
   691      of `/var/qmail/control/me' is filled in for the host name.  If no
       
   692      `@' is present, the current virtual host name is filled in by
       
   693      vdeliver.  If this is set to `postmaster', a mail loop will result
       
   694      and all mail to this address will bounce.
       
   695 
       
   696 
       
   697 File: configuration.info,  Node: qmail-root,  Next: separators,  Prev: postmaster-email,  Up: Configuration Files
       
   698 
       
   699 2.26 qmail-root
       
   700 ===============
       
   701 
       
   702 *Type*
       
   703      string
       
   704 
       
   705 *Default*
       
   706      `/var/qmail'
       
   707 
       
   708 *Used By*
       
   709      checkvpw, vdeliver, vmailmgrd
       
   710 
       
   711 *Description*
       
   712      Specifies the location of the base directory of your qmail install.
       
   713      Set this to whatever you put into `conf-home' when you built and
       
   714      installed qmail.
       
   715 
       
   716 
       
   717 File: configuration.info,  Node: separators,  Next: socket-file,  Prev: qmail-root,  Up: Configuration Files
       
   718 
       
   719 2.27 separators
       
   720 ===============
       
   721 
       
   722 *Type*
       
   723      string
       
   724 
       
   725 *Default*
       
   726      `@:'
       
   727 
       
   728 *Used By*
       
   729      checkvpw (global only)
       
   730 
       
   731 *Description*
       
   732      Identifies the set of valid separators within a user login name
       
   733      between the virtual user name and virtual domain name when logging
       
   734      in via checkvpw.  For example, if separators contains `@:' then
       
   735      `user@domain' and `user:domain' are equivalent POP mailbox names.
       
   736 
       
   737 
       
   738 File: configuration.info,  Node: socket-file,  Next: user-dir,  Prev: separators,  Up: Configuration Files
       
   739 
       
   740 2.28 socket-file
       
   741 ================
       
   742 
       
   743 *Type*
       
   744      string
       
   745 
       
   746 *Default*
       
   747      `/tmp/.vmailmgrd'
       
   748 
       
   749 *Used By*
       
   750      vmailmgrd, checkvpw, vdeliver, and the CGI programs
       
   751 
       
   752 *Description*
       
   753      Identifies the file name of the local socket used to communicate
       
   754      between the vmailmgr daemon and the other programs.  _Warning:_
       
   755      Changing this in the local configuration directories will cause
       
   756      vdeliver to fail.
       
   757 
       
   758 
       
   759 File: configuration.info,  Node: user-dir,  Next: user-dir-bits,  Prev: socket-file,  Up: Configuration Files
       
   760 
       
   761 2.29 user-dir
       
   762 =============
       
   763 
       
   764 *Type*
       
   765      directory
       
   766 
       
   767 *Default*
       
   768      `users'
       
   769 
       
   770 *Used By*
       
   771      vmailmgrd and command-line programs
       
   772 
       
   773 *Description*
       
   774      Identifies the subdirectory from the virtual domain directory in
       
   775      which a virtual user's maildir will be created.  Since this
       
   776      maildir is recorded in the password table, it does not have to be
       
   777      the same for each user within a domain.  This is prefixed with
       
   778      `./' before it is used in the password table.
       
   779 
       
   780 
       
   781 File: configuration.info,  Node: user-dir-bits,  Next: user-dir-slices,  Prev: user-dir,  Up: Configuration Files
       
   782 
       
   783 2.30 user-dir-bits
       
   784 ==================
       
   785 
       
   786 *Type*
       
   787 
       
   788 *Default*
       
   789      `0'
       
   790 
       
   791 *Used By*
       
   792      vmailmgrd and command-line programs when creating new users.
       
   793 
       
   794 *Description*
       
   795      *Note user-dir-slices::.
       
   796 
       
   797 
       
   798 File: configuration.info,  Node: user-dir-slices,  Next: vdeliver-postdeliver,  Prev: user-dir-bits,  Up: Configuration Files
       
   799 
       
   800 2.31 user-dir-slices
       
   801 ====================
       
   802 
       
   803 *Type*
       
   804 
       
   805 *Default*
       
   806      `0'
       
   807 
       
   808 *Used By*
       
   809      vmailmgrd and command-line programs when creating new users.
       
   810 
       
   811 *Description*
       
   812      `user-dir-bits' and `user-dir-slices' work together.  When
       
   813      creating a new user directory name, a hash code is generated on
       
   814      the name of the new user.  This hash code is split into
       
   815      `user-dir-slices' pieces, each `user-dir-bits' bits long.  Each of
       
   816      these pieces is translated to an ASCII string by converting the
       
   817      binary code to hexadecimal.  The resulting user directory name is
       
   818      then composed of:
       
   819         * the base users directory, followed by a `/'
       
   820 
       
   821         * each of the string pieces, each followed by a `/'
       
   822 
       
   823         * the user's name
       
   824      For example, with `user-dir-bits' set to 6 and `user-dir-slices'
       
   825      set to 1, a user named `c' maps to a directory name of
       
   826      `users/2f/c/'.
       
   827 
       
   828 
       
   829 File: configuration.info,  Node: vdeliver-postdeliver,  Next: vdeliver-predeliver,  Prev: user-dir-slices,  Up: Configuration Files
       
   830 
       
   831 2.32 vdeliver-postdeliver
       
   832 =========================
       
   833 
       
   834 *Type*
       
   835      executable
       
   836 
       
   837 *Default*
       
   838      Empty
       
   839 
       
   840 *Used By*
       
   841      vdeliver
       
   842 
       
   843 *Description*
       
   844      This list is executed after the delivery is successfully completed.
       
   845      Since vdeliver expects `USER' and `HOME' to be set, it does not
       
   846      set them itself.  If the command returns with an error code, a
       
   847      warning is printed, but delivery does not fail, as failure would
       
   848      lead to duplicates.
       
   849 
       
   850 
       
   851 File: configuration.info,  Node: vdeliver-predeliver,  Next: vsetup-post,  Prev: vdeliver-postdeliver,  Up: Configuration Files
       
   852 
       
   853 2.33 vdeliver-predeliver
       
   854 ========================
       
   855 
       
   856 *Type*
       
   857      executable
       
   858 
       
   859 *Default*
       
   860      Empty
       
   861 
       
   862 *Used By*
       
   863      vdeliver
       
   864 
       
   865 *Description*
       
   866      This list is executed before the delivery is attempted, but after
       
   867      the virtual user information is looked up.  Since vdeliver expects
       
   868      `USER' and `HOME' to be set, it does not set them itself.
       
   869 
       
   870 
       
   871 File: configuration.info,  Node: vsetup-post,  Next: vsetup-pre,  Prev: vdeliver-predeliver,  Up: Configuration Files
       
   872 
       
   873 2.34 vsetup-post
       
   874 ================
       
   875 
       
   876 *Type*
       
   877      executable
       
   878 
       
   879 *Default*
       
   880      Empty
       
   881 
       
   882 *Used By*
       
   883      vsetup
       
   884 
       
   885 *Description*
       
   886      This list is executed after the vsetup command has sucessfully done
       
   887      everything else.
       
   888 
       
   889 
       
   890 File: configuration.info,  Node: vsetup-pre,  Prev: vsetup-post,  Up: Configuration Files
       
   891 
       
   892 2.35 vsetup-pre
       
   893 ===============
       
   894 
       
   895 *Type*
       
   896      executable
       
   897 
       
   898 *Default*
       
   899      Empty
       
   900 
       
   901 *Used By*
       
   902      vsetup
       
   903 
       
   904 *Description*
       
   905      This list is executed before the vsetup command makes any changes.
       
   906 
       
   907 
       
   908 
       
   909 Tag Table:
       
   910 Node: Top126
       
   911 Node: General Information278
       
   912 Node: Search Order493
       
   913 Node: File Types1358
       
   914 Node: Command Execution2759
       
   915 Node: Configuration Files4801
       
   916 Node: authvmailmgr-error5743
       
   917 Node: authvmailmgr-loginfail6311
       
   918 Node: authvmailmgr-postsetuid6956
       
   919 Node: authvmailmgr-presetuid7343
       
   920 Node: autoresponse-dir8020
       
   921 Node: autoresponse-file8426
       
   922 Node: bulletin-dir8819
       
   923 Node: checkvpw-error9180
       
   924 Node: checkvpw-loginfail9700
       
   925 Node: checkvpw-postexec10311
       
   926 Node: checkvpw-postsetuid10663
       
   927 Node: checkvpw-presetuid11023
       
   928 Node: default-expiry11676
       
   929 Node: default-maildir12028
       
   930 Node: default-msgcount12371
       
   931 Node: default-msgsize12667
       
   932 Node: default-hardquota12972
       
   933 Node: default-softquota13274
       
   934 Node: default-username13577
       
   935 Node: error-maildir13939
       
   936 Node: global-bulletin-dir14381
       
   937 Node: maildir-arg-str14710
       
   938 Node: password-file15109
       
   939 Node: postmaster-aliases15623
       
   940 Node: postmaster-email16175
       
   941 Node: qmail-root16900
       
   942 Node: separators17325
       
   943 Node: socket-file17846
       
   944 Node: user-dir18359
       
   945 Node: user-dir-bits18940
       
   946 Node: user-dir-slices19246
       
   947 Node: vdeliver-postdeliver20259
       
   948 Node: vdeliver-predeliver20838
       
   949 Node: vsetup-post21312
       
   950 Node: vsetup-pre21647
       
   951 
       
   952 End Tag Table