Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND TODD C. MILLER DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL TODD C. MILLER BE LIABLE
FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.Dd August 13, 1998 .Dt LOCKSPOOL 1 .Os .Sh NAME .Nm lockspool .Nd lock user's system mailbox .Sh SYNOPSIS .Nm lockspool .Op Ar username .Sh DESCRIPTION .Nm is useful for a client mail program to attain proper locking. .Nm obtains a
a username.lock for the calling user and retains it until stdin is closed or a signal like .Dv SIGINT , .Dv SIGTERM , or .Dv SIGHUP is received. Additionally, the superuser may specify the name of a user in order to lock a different mailbox.
p If .Nm is able to create the lock file, .Dq 1 is written to stdout, otherwise .Dq 0 is written and an error message is written to stderr. .Nm will try up to 10 times to get the lock (sleeping for a short period in between tries).
p The .Nm utility exits 0 on success, and 1 if an error occurs. .Sh FILES l -tag -width /var/mail/username.lock -compact t Pa /var/mail/username.lock user's mail lock file .El .Sh SEE ALSO .Xr mail 1 , .Xr mail.local 8 , .Xr sendmail 8 .Sh HISTORY The .Nm program appeared in .Ox 2.4 .