← Back to branch summary

~ubuntu-branches/ubuntu/trusty/postfix/trusty-proposed

« back to all changes in this revision

Viewing changes to man/man1/postlock.1

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
Import upstream version 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man1/postlock.1
 
1
.TH POSTLOCK 1 
 
2
.ad
 
3
.fi
 
4
.SH NAME
 
5
postlock
 
6
\-
 
7
lock mail folder and execute command
 
8
.SH "SYNOPSIS"
 
9
.na
 
10
.nf
 
11
.fi
 
12
\fBpostlock\fR [\fB-c \fIconfig_dir\fB] [\fB-l \fIlock_style\fB]
 
13
        [\fB-v\fR] \fIfile command...\fR
 
14
.SH DESCRIPTION
 
15
.ad
 
16
.fi
 
17
The \fBpostlock\fR command locks \fIfile\fR for exclusive
 
18
access, and executes \fIcommand\fR. The locking method is
 
19
compatible with the Postfix UNIX-style local delivery agent.
 
20
 
 
21
Options:
 
22
.IP "\fB-c \fIconfig_dir\fR"
 
23
Read the \fBmain.cf\fR configuration file in the named directory
 
24
instead of the default configuration directory.
 
25
.IP "\fB-l \fIlock_style\fR"
 
26
Override the locking method specified via the
 
27
\fBmailbox_delivery_lock\fR configuration parameter (see below).
 
28
.IP \fB-v\fR
 
29
Enable verbose logging for debugging purposes. Multiple \fB-v\fR
 
30
options make the software increasingly verbose.
 
31
.PP
 
32
Arguments:
 
33
.IP \fIfile\fR
 
34
A mailbox file. The user should have read/write permission.
 
35
.IP \fIcommand...\fR
 
36
The command to execute while \fIfile\fR is locked for exclusive
 
37
access.  The command is executed directly, i.e. without
 
38
interpretation by a shell command interpreter.
 
39
.SH DIAGNOSTICS
 
40
.ad
 
41
.fi
 
42
The result status is 75 (EX_TEMPFAIL) when \fBpostlock\fR
 
43
could not perform the requested operation.  Otherwise, the
 
44
exit status is the exit status from the command.
 
45
.SH BUGS
 
46
.ad
 
47
.fi
 
48
With remote file systems, the ability to acquire a lock does not
 
49
necessarily eliminate access conflicts. Avoid file access by
 
50
processes running on different machines.
 
51
.SH "ENVIRONMENT"
 
52
.na
 
53
.nf
 
54
.ad
 
55
.fi
 
56
.IP \fBMAIL_CONFIG\fR
 
57
Directory with Postfix configuration files.
 
58
.IP \fBMAIL_VERBOSE\fR
 
59
Enable verbose logging for debugging purposes.
 
60
.SH "CONFIGURATION PARAMETERS"
 
61
.na
 
62
.nf
 
63
.ad
 
64
.fi
 
65
The following \fBmain.cf\fR parameters are especially relevant to
 
66
this program.
 
67
The text below provides only a parameter summary. See
 
68
postconf(5) for more details including examples.
 
69
.SH "LOCKING CONTROLS"
 
70
.na
 
71
.nf
 
72
.ad
 
73
.fi
 
74
.IP "\fBdeliver_lock_attempts (20)\fR"
 
75
The maximal number of attempts to acquire an exclusive lock on a
 
76
mailbox file or bounce(8) logfile.
 
77
.IP "\fBdeliver_lock_delay (1s)\fR"
 
78
The time between attempts to acquire an exclusive lock on a mailbox
 
79
file or bounce(8) logfile.
 
80
.IP "\fBstale_lock_time (500s)\fR"
 
81
The time after which a stale exclusive mailbox lockfile is removed.
 
82
.IP "\fBmailbox_delivery_lock (see 'postconf -d' output)\fR"
 
83
How to lock a UNIX-style local(8) mailbox before attempting delivery.
 
84
.SH "RESOURCE AND RATE CONTROLS"
 
85
.na
 
86
.nf
 
87
.ad
 
88
.fi
 
89
.IP "\fBfork_attempts (5)\fR"
 
90
The maximal number of attempts to fork() a child process.
 
91
.IP "\fBfork_delay (1s)\fR"
 
92
The delay between attempts to fork() a child process.
 
93
.SH "MISCELLANEOUS CONTROLS"
 
94
.na
 
95
.nf
 
96
.ad
 
97
.fi
 
98
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 
99
The default location of the Postfix main.cf and master.cf
 
100
configuration files.
 
101
.SH "SEE ALSO"
 
102
.na
 
103
.nf
 
104
postconf(5), configuration parameters
 
105
.SH "LICENSE"
 
106
.na
 
107
.nf
 
108
.ad
 
109
.fi
 
110
The Secure Mailer license must be distributed with this software.
 
111
.SH "AUTHOR(S)"
 
112
.na
 
113
.nf
 
114
Wietse Venema
 
115
IBM T.J. Watson Research
 
116
P.O. Box 704
 
117
Yorktown Heights, NY 10598, USA