/usr/share/doc/mailutils-doc/mailutils.html/locking-statement.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301, USA

Copyright (C) 1999-2004, 2008-2012, 2014-2016 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover, and no Back-Cover texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: locking statement</title>

<meta name="description" content="GNU Mailutils Manual: locking statement">
<meta name="keywords" content="GNU Mailutils Manual: locking statement">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="configuration.html#configuration" rel="up" title="configuration">
<link href="mailer-statement.html#mailer-statement" rel="next" title="mailer statement">
<link href="mailbox-statement.html#mailbox-statement" rel="prev" title="mailbox statement">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="locking-statement"></a>
<div class="header">
<p>
Next: <a href="mailer-statement.html#mailer-statement" accesskey="n" rel="next">mailer statement</a>, Previous: <a href="mailbox-statement.html#mailbox-statement" accesskey="p" rel="prev">mailbox statement</a>, Up: <a href="configuration.html#configuration" accesskey="u" rel="up">configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="The-locking-Statement"></a>
<h4 class="subsection">3.2.8 The <code>locking</code> Statement</h4>
<a name="Locking-Statement"></a><a name="index-locking"></a>
<a name="Syntax-5"></a>
<h4 class="subheading">Syntax</h4>
<div class="example">
<pre class="example">locking {
  # <span class="roman">Default locker flags.</span>
  flags <var>arg</var>;
  
  # <span class="roman">Set timeout for acquiring the lock.</span>
  retry-timeout <var>arg</var>;
  
  # <span class="roman">Set the maximum number of times to retry acquiring the lock.</span>
  retry-count <var>number</var>;
  
  # <span class="roman">Expire locks older than this amount of time.</span>
  expire-timeout <var>number</var>;
  
  # <span class="roman">Use <var>prog</var> as external locker program.</span>
  external-locker <var>prog</var>;
}
</pre></div>

<a name="Description-3"></a>
<h4 class="subheading">Description</h4>
<p>This block statement configures various parameters used when locking
UNIX mailboxes in order to prevent simultaneous writes.
</p>
<p>It is important to note, that locking applies only to traditional
UNIX mailboxes (see <a href="Local-Mailboxes.html#mbox">mbox</a>).  All other
mailbox types don&rsquo;t require locking.
</p>
<dl>
<dt><a name="index-flags"></a>Configuration: <strong>flags</strong> <em><var>string</var></em></dt>
<dd><p>Set locking flags.  Argument is a string consisting of one or more of
the following letters:
</p>
<dl compact="compact">
<dt>E</dt>
<dd><p>Use an external program to manage locks.  The program is given by the
<code>external-locker</code> statement (see below).
</p>
</dd>
<dt>R</dt>
<dd><p>If the locking attempt failed, retry it.  This is the default.  The
number of retries, and time interval between the two successive
attempts is given by <code>retry-count</code> and <code>retry-timeout</code>
statements, correspondingly.
</p>
</dd>
<dt>T</dt>
<dd><p>If a lock file exists, check its modification time and, if it is
older than a predefined amount of time, remove the lock.  The amount
of time is specified by <code>expire-timeout</code> statement.
</p>
</dd>
<dt>P</dt>
<dd><p>Store the PID of the locking process in a lock file.
</p></dd>
</dl>
</dd></dl>

<dl>
<dt><a name="index-retry_002dcount"></a>Configuration: <strong>retry-count</strong> <em><var>number</var></em></dt>
<dd><p>Number of locking attempts.  The &lsquo;<samp>P</samp>&rsquo; flag must be set for this to
take effect.
</p></dd></dl>

<dl>
<dt><a name="index-retry_002dtimeout"></a>Configuration: <strong>retry-timeout</strong> <em><var>seconds</var></em></dt>
<dd><p>Time interval, in seconds, between the two successive locking
attempts.  The &lsquo;<samp>P</samp>&rsquo; flag must be set for this to take effect.
</p></dd></dl>

<dl>
<dt><a name="index-expire_002dtimeout"></a>Configuration: <strong>expire-timeout</strong> <em><var>seconds</var></em></dt>
<dd><p>Remove existing lock file, if it is created more than this number of
seconds ago.  The &lsquo;<samp>T</samp>&rsquo; flag must be set for this to take effect.
</p></dd></dl>

<dl>
<dt><a name="index-external_002dlocker"></a>Configuration: <strong>external-locker</strong> <em><var>string</var></em></dt>
<dd><p>Determines the external locker program to use.  The <var>string</var>
argument is the valid command line, starting with the full program
name.  The &lsquo;<samp>E</samp>&rsquo; flag must be set for this to take effect. 
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="mailer-statement.html#mailer-statement" accesskey="n" rel="next">mailer statement</a>, Previous: <a href="mailbox-statement.html#mailbox-statement" accesskey="p" rel="prev">mailbox statement</a>, Up: <a href="configuration.html#configuration" accesskey="u" rel="up">configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
mailutils-doc 1:3.1.1-1 / usr / share / doc / mailutils-doc / mailutils.html / locking-statement.html
