.\"	$OpenBSD: lockspool.1,v 1.14 2019/01/25 00:19:26 millert Exp $
.\"
.\" Copyright (c) 1998 Todd C. Miller <millert@openbsd.org>
.\"
.\" 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 THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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 $Mdocdate: January 25 2019 $
.Dt LOCKSPOOL 1
.Os
.Sh "نام (NAME)"
.Nm lockspool
.Nd قفل کردن صندوق پستی سیستم کاربر
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm lockspool
.Op Ar username
.Sh "توضیحات (DESCRIPTION)"
.Nm
برای برنامه‌های کلاینت ایمیل به منظور دستیابی به قفل‌گذاری مناسب مفید است.
.Nm
یک فایل
.Pa username.lock
را برای کاربر فراخواننده به دست می‌آورد و آن را تا زمان بسته شدن stdin یا دریافت سیگنالی مانند
.Dv SIGINT ,
.Dv SIGTERM ,
یا
.Dv SIGHUP
نگه می‌دارد.
علاوه بر این، مدیر سیستم (کاربر ارشد) می‌تواند نام یک کاربر را برای قفل کردن یک صندوق پستی دیگر مشخص کند.
.Pp
اگر
.Nm
قادر به ایجاد فایل قفل باشد،
.Dq 1
در خروجی استاندارد (stdout) نوشته می‌شود، در غیر این صورت
.Dq 0
نوشته شده و یک پیام خطا در خطای استاندارد (stderr) ارسال می‌گردد.
.Nm
تا ۱۰ بار برای به دست آوردن قفل تلاش خواهد کرد (با توقف کوتاه میان تلاش‌ها).
.Pp
کاربرد معمول برای یک کارگزار ایمیل کاربر (مانند
.Xr mail 1 )
این است که هنگام نیاز به قفل کردن اسپول ایمیل کاربر، یک پایپ به
.Nm
باز کند.
بستن پایپ موجب می‌شود که
.Nm
قفل را آزاد کند.
.Sh "فایل‌ها (FILES)"
.Bl -tag -width /var/mail/username.lock -compact
.It Pa /var/mail/username.lock
فایل قفل ایمیل کاربر
.El
.Sh "وضعیت خروج (EXIT STATUS)"
ابزار
.Nm
در صورت موفقیت با مقدار 0، و در صورت بروز خطا با مقدار 1 خارج می‌شود.
.Sh "همچنین ببینید (SEE ALSO)"
.Xr mail 1 ,
.Xr mail.local 8 ,
.Xr smtpd 8
.Sh "تاریخچه (HISTORY)"
برنامه
.Nm
در
.Ox 2.4
ظاهر شد.