.\"-
.\" Copyright (c) 2012 Andreas Olsson
.\" Copyright (c) 2016 Tim Duesterhus
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.TH SPIPED 1 "@DATE@" "spiped @VERSION@" "spiped README"
.SH "نام (NAME)"
spiped \- دیمن لولهٔ امن
.SH "خلاصه دستور (SYNOPSIS)"
.B spiped
{\-e | \-d} \-s <source socket>
\-t <target socket>
\-k <key file>
.br
[\-DFj]
[\-b <bind address>]
[\-f | \-g]
[\-n <max # connections>]
.br
[\-o <connection timeout>]
[\-p <pidfile>]
[\-r <rtime> | \-R]
[\-\-syslog]
.br
[\-u <username> | <:groupname> | <username:groupname>]
.br
.B spiped
\-v
.SH "گزینه‌ها (OPTIONS)"
.TP
.B \-e
اتصال‌های رمزگذاری‌نشده را از
.I source socket
گرفته و اتصال‌های رمزگذاری‌شده را به
.IR "target socket"
ارسال می‌کند.
.TP
.B \-d
اتصال‌های رمزگذاری‌شده را از
.I source socket
گرفته و اتصال‌های رمزگذاری‌نشده را به
.IR "target socket"
ارسال می‌کند.
.TP
.B \-s <source socket>
نشانی‌ای که spiped باید روی آن برای اتصال‌های ورودی گوش فرا دهد. قالب‌های پذیرفته‌شده مشابه موارد پذیرفته‌شده برای
.IR "target socket"
است. توجه داشته باشید که برخلاف
.IR "target socket" ،
نام‌های میزبان هنگام راه‌اندازی
.B spiped
تحلیل می‌شوند و پس از آن مجدداً تحلیل نخواهند شد؛ بنابراین در صورت تغییر ورودی‌های DNS،
.B spiped
همچنان به پذیرش اتصال‌ها روی نشانی منقضی‌شده ادامه خواهد داد.
.TP
.B \-t <target socket>
نشانی‌ای که
.B spiped
باید به آن متصل شود.
باید در یکی از قالب‌های زیر باشد:
.IP \(bu
/absolute/path/to/unix/socket
.IP \(bu
host.name:port
.IP \(bu
[ip.v4.ad.dr]:port
.IP \(bu
[ipv6::addr]:port
.IP
نام‌های میزبان هر
.I rtime
ثانیه یک‌بار دوباره تحلیل می‌شوند.
.TP
.B \-k <key file>
از فایل کلید ارائه‌شده برای احراز هویت و رمزگذاری استفاده می‌کند.
برای خواندن از ورودی استاندارد مقدار «\-» را بدهید.
.TP
.B \-b <bind address>
نشانی خروجی را مقید (bind) می‌کند. اگر این یک نشانی شبکه باشد، شمارهٔ درگاه (port) می‌تواند مشخص شده یا به سیستم‌عامل واگذار شود. اگر شمارهٔ درگاه را تعیین کنید، سیستم‌عامل به شما اجازهٔ برقراری اتصال دوم را تا زمانی که اتصال نخست کاملاً منقضی شود (یعنی وضعیت TCP دیگر در وضعیت TIME-WAIT نباشد) نخواهد داد.
.TP
.B \-D
انتظار برای DNS. در حالت عادی هنگامی که
.B spiped
راه‌اندازی می‌شود، پیش از بازگشت فرایند والد، نشانی‌ها را تحلیل کرده و به
.I source socket
خود مقید می‌شود؛ با این گزینه ابتدا فرایند دیمن شده و جستجوهای ناموفق DNS را تا زمان موفقیت تکرار می‌کند. این امر به
.B spiped
اجازه می‌دهد حتی اگر DNS هنوز برپا نشده باشد اجرا شود، اما به قیمت از دست رفتن این تضمین که پس از اتمام راه‌اندازی
.BR spiped ،
برنامه بی‌درنگ آمادهٔ ایجاد لوله‌ها خواهد بود.
.TP
.B \-f
استفاده از دست‌تکانی سریع/ضعیف: این گزینه زمان پردازنده (CPU) مصرفی در برپایی اولیهٔ اتصال را با غیرفعال کردن دست‌تکانی Diffie-Hellman کاهش می‌دهد، به بهای از دست دادن رازداری سرآمد کامل (perfect forward secrecy).
.TP
.B \-g
الزام به رازداری سرآمد کامل (perfect forward secrecy) از طریق قطع اتصال در صورتی که میزبان مقابل از گزینهٔ \-f استفاده کند.
.TP
.B \-F
اجرا در پیش‌زمینه (foreground). این گزینه می‌تواند برای سیستم‌هایی مانند daemontools مفید باشد.
.TP
.B \-j
غیرفعال کردن پیام‌های زنده‌داری (keep-alives) لایهٔ انتقال.
(به‌طور پیش‌فرض فعال هستند.)
.TP
.B \-n <max # connections>
محدودیت تعداد اتصال‌های هم‌زمان مجاز.
مقدار 0 نشان‌دهندهٔ عدم اعمال محدودیت است؛ این کار ممکن است در برخی شرایط مناسب نباشد، چرا که اگر
.B spiped
نتواند برای مدیریت یک اتصال جدید حافظه تخصیص دهد، متوقف خواهد شد.
پیش‌فرض 100 اتصال است.
.TP
.B \-o <connection timeout>
مهلت زمانی (timeout) بر حسب ثانیه که پس از آن، در صورت کامل نشدن تلاش برای اتصال به مقصد یا دست‌تکانی پروتکل، فرایند لغو (و اتصال قطع) خواهد شد. پیش‌فرض 5 ثانیه است.
.TP
.B \-p <pidfile>
فایلی که شناسهٔ فرایند (PID) متعلق به
.B spiped
باید در آن نوشته شود. پیش‌فرض
.IR "source socket" .pid
است (در دایرکتوری فعلی، در صورتی که
.I source socket
یک مسیر مطلق نباشد). در صورت استفاده از گزینهٔ \-F (اجرا در پیش‌زمینه)، هیچ فایلی نوشته نخواهد شد.
.TP
.B \-r <rtime>
تحلیل مجدد نشانی
.I target socket
در هر
.I rtime
ثانیه.
پیش‌فرض تحلیل مجدد هر 60 ثانیه یک‌بار است.
.TP
.B \-R
غیرفعال کردن تحلیل مجدد نشانی مقصد.
.TP
.B \-\-syslog
پس از دیمن شدن، هشدارها به جای stderr به syslog ارسال شوند. در صورت استفاده از \-F (اجرا در پیش‌زمینه)، اثری نخواهد داشت.
.TP
.B \-u <username> | <:groupname> | <username:groupname>
پس از مقیدسازی (bind) سوکت، تغییر کاربر به
.I username
و/یا گروه به
.IR groupname .
.TP
.B \-v
چاپ شمارهٔ نسخه.
.SH "سیگنال‌ها (SIGNALS)"
دستور spiped رفتار ویژه‌ای برای سیگنال‌های زیر در نظر گرفته است:
.TP
.B SIGTERM
با دریافت سیگنال
.IR SIGTERM ،
.B spiped
پذیرش اتصالات جدید را متوقف کرده و به محض اینکه هیچ اتصال فعالی باقی نماند، خارج می‌شود.
.SH "همچنین ببینید (SEE ALSO)"
.BR spipe (1).