postfix-master/postlock.1.html

   1 <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
   2         "http://www.w3.org/TR/html4/loose.dtd">
   3 <html> <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
   5 <title> Postfix manual - postlock(1) </title>
   6 </head> <body> <pre>
   7 POSTLOCK(1)                                                        POSTLOCK(1)
   8
   9 <b>NAME</b>
  10        postlock - lock mail folder and execute command
  11
  12 <b>SYNOPSIS</b>
  13        <b>postlock</b> [<b>-c</b> <i>config</i><b>_</b><i>dir</i><b>] [-l</b> <i>lock</i><b>_</b><i>style</i><b>]</b>
  14                <b>[-v</b>] <i>file command...</i>
  15
  16 <b>DESCRIPTION</b>
  17        The  <a href="postlock.1.html"><b>postlock</b>(1)</a>  command locks <i>file</i> for exclusive access,
  18        and executes <i>command</i>. The  locking  method  is  compatible
  19        with the Postfix UNIX-style local delivery agent.
  20
  21        Options:
  22
  23        <b>-c</b> <i>config</i><b>_</b><i>dir</i>
  24               Read  the  <a href="postconf.5.html"><b>main.cf</b></a>  configuration file in the named
  25               directory  instead  of  the  default  configuration
  26               directory.
  27
  28        <b>-l</b> <i>lock</i><b>_</b><i>style</i>
  29               Override the locking method specified via the <b><a href="postconf.5.html#mailbox_delivery_lock">mail</a>-</b>
  30               <b><a href="postconf.5.html#mailbox_delivery_lock">box_delivery_lock</a></b>  configuration   parameter   (see
  31               below).
  32
  33        <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
  34               tiple <b>-v</b> options  make  the  software  increasingly
  35               verbose.
  36
  37        Arguments:
  38
  39        <i>file</i>   A  mailbox  file.  The  user should have read/write
  40               permission.
  41
  42        <i>command...</i>
  43               The command to execute while  <i>file</i>  is  locked  for
  44               exclusive   access.    The   command   is  executed
  45               directly, i.e. without interpretation  by  a  shell
  46               command interpreter.
  47
  48 <b>DIAGNOSTICS</b>
  49        The  result  status  is  75 (EX_TEMPFAIL) when <a href="postlock.1.html"><b>postlock</b>(1)</a>
  50        could not perform the requested operation.  Otherwise, the
  51        exit status is the exit status from the command.
  52
  53 <b>BUGS</b>
  54        With  remote  file  systems, the ability to acquire a lock
  55        does not necessarily  eliminate  access  conflicts.  Avoid
  56        file access by processes running on different machines.
  57
  58 <b>ENVIRONMENT</b>
  59        <b>MAIL_CONFIG</b>
  60               Directory with Postfix configuration files.
  61
  62        <b>MAIL_VERBOSE</b>
  63               Enable verbose logging for debugging purposes.
  64
  65 <b>CONFIGURATION PARAMETERS</b>
  66        The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
  67        to this program.  The text below provides only a parameter
  68        summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including exam-
  69        ples.
  70
  71 <b>LOCKING CONTROLS</b>
  72        <b><a href="postconf.5.html#deliver_lock_attempts">deliver_lock_attempts</a> (20)</b>
  73               The maximal number of attempts to acquire an exclu-
  74               sive lock on a mailbox file or <a href="bounce.8.html"><b>bounce</b>(8)</a> logfile.
  75
  76        <b><a href="postconf.5.html#deliver_lock_delay">deliver_lock_delay</a> (1s)</b>
  77               The  time  between attempts to acquire an exclusive
  78               lock on a mailbox file or <a href="bounce.8.html"><b>bounce</b>(8)</a> logfile.
  79
  80        <b><a href="postconf.5.html#stale_lock_time">stale_lock_time</a> (500s)</b>
  81               The time after  which  a  stale  exclusive  mailbox
  82               lockfile is removed.
  83
  84        <b><a href="postconf.5.html#mailbox_delivery_lock">mailbox_delivery_lock</a> (see 'postconf -d' output)</b>
  85               How  to  lock  a UNIX-style <a href="local.8.html"><b>local</b>(8)</a> mailbox before
  86               attempting delivery.
  87
  88 <b>RESOURCE AND RATE CONTROLS</b>
  89        <b><a href="postconf.5.html#fork_attempts">fork_attempts</a> (5)</b>
  90               The maximal number of attempts to  fork()  a  child
  91               process.
  92
  93        <b><a href="postconf.5.html#fork_delay">fork_delay</a> (1s)</b>
  94               The  delay  between  attempts  to  fork()  a  child
  95               process.
  96
  97 <b>MISCELLANEOUS CONTROLS</b>
  98        <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
  99               The default location of  the  Postfix  <a href="postconf.5.html">main.cf</a>  and
 100               <a href="master.5.html">master.cf</a> configuration files.
 101
 102 <b>SEE ALSO</b>
 103        <a href="postconf.5.html">postconf(5)</a>, configuration parameters
 104
 105 <b>LICENSE</b>
 106        The  Secure  Mailer  license must be distributed with this
 107        software.
 108
 109 <b>AUTHOR(S)</b>
 110        Wietse Venema
 111        IBM T.J. Watson Research
 112        P.O. Box 704
 113        Yorktown Heights, NY 10598, USA
 114
 115                                                                    POSTLOCK(1)
 116 </pre> </body> </html>