external/ibm-public/postfix/dist/man/man1/postlock.1

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