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