xref: /netbsd-src/external/ibm-public/postfix/dist/html/postlock.1.html (revision 059c16a85b0b39d60ad6d18f53c09510815afa2b)
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=utf-8">
5<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
6<title> Postfix manual - postlock(1) </title>
7</head> <body> <pre>
8POSTLOCK(1)                                                        POSTLOCK(1)
9
10<b>NAME</b>
11       postlock - lock mail folder and execute command
12
13<b>SYNOPSIS</b>
14       <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>]
15               [<b>-v</b>] <i>file command...</i>
16
17<b>DESCRIPTION</b>
18       The  <a href="postlock.1.html"><b>postlock</b>(1)</a>  command locks <i>file</i> for exclusive access, and executes
19       <i>command</i>. The locking method is compatible with the  Postfix  UNIX-style
20       local delivery agent.
21
22       Options:
23
24       <b>-c</b> <i>config</i><b>_</b><i>dir</i>
25              Read  the  <a href="postconf.5.html"><b>main.cf</b></a>  configuration  file  in  the named directory
26              instead of the default configuration 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">mailbox_deliv</a>-</b>
30              <b><a href="postconf.5.html#mailbox_delivery_lock">ery_lock</a></b> configuration parameter (see below).
31
32       <b>-v</b>     Enable  verbose  logging  for  debugging  purposes.  Multiple <b>-v</b>
33              options make the software increasingly verbose.
34
35       Arguments:
36
37       <i>file</i>   A mailbox file. The user should have read/write permission.
38
39       <i>command...</i>
40              The command to  execute  while  <i>file</i>  is  locked  for  exclusive
41              access.   The  command is executed directly, i.e. without inter-
42              pretation by a shell command interpreter.
43
44<b>DIAGNOSTICS</b>
45       The result status is 75 (EX_TEMPFAIL) when <a href="postlock.1.html"><b>postlock</b>(1)</a> could  not  per-
46       form  the  requested operation.  Otherwise, the exit status is the exit
47       status from the command.
48
49<b>BUGS</b>
50       With remote file systems, the ability to acquire a lock does not neces-
51       sarily  eliminate access conflicts. Avoid file access by processes run-
52       ning on different machines.
53
54<b>ENVIRONMENT</b>
55       <b>MAIL_CONFIG</b>
56              Directory with Postfix configuration files.
57
58       <b>MAIL_VERBOSE</b>
59              Enable verbose logging for debugging purposes.
60
61<b>CONFIGURATION PARAMETERS</b>
62       The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant to  this  pro-
63       gram.   The  text  below  provides  only a parameter summary. See <a href="postconf.5.html"><b>post-</b></a>
64       <a href="postconf.5.html"><b>conf</b>(5)</a> for more details including examples.
65
66<b>LOCKING CONTROLS</b>
67       <b><a href="postconf.5.html#deliver_lock_attempts">deliver_lock_attempts</a> (20)</b>
68              The maximal number of attempts to acquire an exclusive lock on a
69              mailbox file or <a href="bounce.8.html"><b>bounce</b>(8)</a> logfile.
70
71       <b><a href="postconf.5.html#deliver_lock_delay">deliver_lock_delay</a> (1s)</b>
72              The  time  between  attempts  to  acquire an exclusive lock on a
73              mailbox file or <a href="bounce.8.html"><b>bounce</b>(8)</a> logfile.
74
75       <b><a href="postconf.5.html#stale_lock_time">stale_lock_time</a> (500s)</b>
76              The time after which  a  stale  exclusive  mailbox  lockfile  is
77              removed.
78
79       <b><a href="postconf.5.html#mailbox_delivery_lock">mailbox_delivery_lock</a> (see 'postconf -d' output)</b>
80              How  to  lock  a  UNIX-style  <a href="local.8.html"><b>local</b>(8)</a> mailbox before attempting
81              delivery.
82
83<b>RESOURCE AND RATE CONTROLS</b>
84       <b><a href="postconf.5.html#fork_attempts">fork_attempts</a> (5)</b>
85              The maximal number of attempts to fork() a child process.
86
87       <b><a href="postconf.5.html#fork_delay">fork_delay</a> (1s)</b>
88              The delay between attempts to fork() a child process.
89
90<b>MISCELLANEOUS CONTROLS</b>
91       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
92              The default location of the Postfix <a href="postconf.5.html">main.cf</a> and  <a href="master.5.html">master.cf</a>  con-
93              figuration files.
94
95       <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
96              The  list  of  environment  parameters that a privileged Postfix
97              process will  import  from  a  non-Postfix  parent  process,  or
98              name=value environment overrides.
99
100<b>SEE ALSO</b>
101       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
102
103<b>LICENSE</b>
104       The Secure Mailer license must be distributed with this software.
105
106<b>AUTHOR(S)</b>
107       Wietse Venema
108       IBM T.J. Watson Research
109       P.O. Box 704
110       Yorktown Heights, NY 10598, USA
111
112       Wietse Venema
113       Google, Inc.
114       111 8th Avenue
115       New York, NY 10011, USA
116
117                                                                   POSTLOCK(1)
118</pre> </body> </html>
119