.TH fstrm_capture 1

.SH "نام (NAME)"

fstrm_capture \- دریافت و ذخیره داده‌های Frame Streams از سوکت

.SH "خلاصه دستور (SYNOPSIS)"

.B fstrm_capture -t \fIcontent-type\fB -w \fIfilename\fB
.br
.B "	[ -u \fIsocket-path\fB ] [ -a \fIIP\fB -p \fIport\fB ]"
.br
.B "	[ -c \fImax-connections\fB ] [ -b \fIbuffer-size\fB ]"
.br
.B "	[ -s \fIseconds\fB ] [ --gmtime ] [ --localtime ]"
.br
.B "	[ -d [-d ...] ]"

.PP

.B fstrm_capture --type \fIcontent-type\fB --write \fIfilename\fB
.br
.B "	[ --unix \fIsocket-path\fB ] [ --tcp \fIIP\fB --port \fIport\fB ]"
.br
.B "	[ --maxconns \fImax-connections\fB ] [ --buffersize \fIbuffer-size\fB ]"
.br
.B "	[ --split \fIseconds\fB ] [ --gmtime ] [ --localtime ]"
.br
.B "	[ --debug [--debug ...] ]"


.SH "توضیحات (DESCRIPTION)"

دستور
.B fstrm_capture
به یک سوکت دامنه یونیکس (UNIX domain) یا TCP گوش فرا می‌دهد، داده‌های Frame Streams را دریافت کرده و در یک فایل می‌نویسد.

.SH "گزینه‌ها (OPTIONS)"

.TP
.B -w \fIfilename\fB | --write \fIfilename \fB
نوشتن داده‌ها در فایل
.IR filename .

اگر گزینه
.B \-\-gmtime
یا
.B \-\-localtime
داده شده باشد،
.I filename
با استفاده از
.B strftime()
پیش‌پردازش می‌شود. این امر امکان مشخص کردن یک رشته قالب‌بندی حاوی تاریخ و زمان را برای نام فایل ایجادشده فراهم می‌کند.

اگر
.I filename
برابر با «-» باشد و خروجی استاندارد به ترمینال متصل نباشد،
.B fstrm_capture
در خروجی استاندارد می‌نویسد. تقسیم‌بندی خروجی
.RB ( \-s )
را نمی‌توان با
.I filename
برابر «-» استفاده کرد.

ارسال سیگنال
.I SIGHUP
به
.B fstrm_capture
تمام خروجی‌های بافر شده را در فایل تخلیه (flush) می‌کند. ارسال
.I SIGUSR1
فایل را بسته و دوباره باز می‌کند.

.TP
.B -t \fIcontent-type\fB | --type \fIcontent-type\fB
مشخص کردن
.I content-type
برای دریافت از سوکت و نوشتن در
.I filename
خروجی.

.TP
.B -u \fIsocket-path\fB | --unix \fIsocket-path\fB
گوش دادن به سوکت دامنه یونیکس
.I socket-path
برای دریافت داده‌های Frame Streams. تنها یکی از گزینه‌های
.B \-u
یا
.B \-a
می‌تواند مشخص شود.

.TP
.B -a \fIIP\fB | --tcp \fIIP\fB
گوش دادن به اتصالات TCP روی آدرس
.I IP
برای دریافت داده‌های Frame Streams. تنها یکی از گزینه‌های
.B \-u
یا
.B \-a
می‌تواند مشخص شود. استفاده از
.B \-a
نیازمند مشخص کردن پورت با
.B \-p
است.

.TP
.B -p \fIport\fB | --port \fIport\fB
در صورت مشخص شدن
.BR \-a ،
به پورت TCP با شماره
.I port
برای دریافت داده‌های Frame Streams گوش فرا می‌دهد.

.TP
.B -c \fImax-conns\fB | --maxconns \fImax-conns\fB
اجازه دادن به حداکثر
.I max-conns
اتصال همزمان. در صورت عدم تعیین، اتصالات همزمان محدود نمی‌شوند.

.TP
.B -b \fIbuffersize\fB | --buffersize \fIbuffersize\fB
تنظیم اندازه بافر خواندن بر حسب بایت به مقدار
.IR buffersize .
در ترکیب با
.BR \-c ،
می‌توان از این گزینه برای محدود کردن کل حافظه مصرفی
.B fstrm_capture
استفاده کرد. مقدار
.I buffersize
همچنین بر حداکثر اندازه فریمی که
.B fstrm_capture
می‌پذیرد تأثیر می‌گذارد. فریم‌های بزرگ‌تر از
.IR buffersize ،
با احتساب ۴ بایت بار اضافه فریم‌بندی (framing overhead)، دور ریخته خواهند شد.

مقدار پیش‌فرض
.I buffersize
برابر ۲۶۲۱۴۴ (۲۵۶ کیبی‌بایت) است.

.TP
.B -s \fIinterval\fB | --split \fIinterval\fB
بازگشایی مجدد فایل خروجی در هر
.I interval
ثانیه. نیازمند استفاده از یکی از گزینه‌های
.B \-\-gmtime
یا
.B \-\-localtime
است.

توجه داشته باشید که این چرخش فایل با ورود داده‌ها فعال می‌شود، بنابراین ممکن است پس از پایان بازه زمانی، با اندکی تأخیر رخ دهد.

.TP
.B --gmtime
پردازش نام فایل مشخص‌شده در
.B \-\-write
از طریق
.B strftime()
بر اساس زمان فعلی در گرینویچ (GMT).
از این گزینه می‌توان برای ایجاد یک فایل خروجی دارای برچسب زمانی هنگام شروع
.BR fstrm_capture ،
هنگام بازگشایی مجدد فایل خروجی با استفاده از گزینه
.BR \-\-split ،
یا هنگام دریافت سیگنال
.I SIGUSR1
استفاده کرد.

.TP
.B --localtime
پردازش نام فایل مشخص‌شده در
.B \-\-write
از طریق
.B strftime()
بر اساس زمان فعلی در منطقه زمانی محلی سیستم.
از این گزینه می‌توان برای ایجاد یک فایل خروجی دارای برچسب زمانی هنگام شروع
.BR fstrm_capture ،
هنگام بازگشایی مجدد فایل خروجی با استفاده از گزینه
.BR \-\-split ،
یا هنگام دریافت سیگنال
.I SIGUSR1
استفاده کرد.

.TP
.B -d [ -d ... ] | --debug [ --debug ]
افزایش سطح اشکال‌زدایی. بدون گزینه
.BR \-d ،
دستور
.B fstrm_capture
تنها پیام‌های خطای حیاتی را چاپ می‌کند. حداکثر پنج گزینه
.B \-d
می‌تواند مشخص شود و تکرار بیش از آن تأثیری نخواهد داشت.

.SH "مثال‌ها (EXAMPLES)"

دریافت داده‌های dnstap و ذخیره آن‌ها در فایل‌هایی با چرخش ساعتی
(با نام تبدیل‌شده‌ای مانند
\fI/var/log/dnstap/dnstap-2018-05-04-12:58:48.fstrm\fR):

.nf
	fstrm_capture -t protobuf:dnstap.Dnstap \\
		-u /var/run/named/dnstap.sock \\
		-w /var/log/dnstap/dnstap-%F-%T.fstrm \\
		-s 3600 --gmtime
.fi

.SH "همچنین ببینید (SEE ALSO)"

.BR fstrm_dump (1),
.BR fstrm_replay (1),
.BR strftime (3),
.br
کتابخانه Frame Streams C \fBhttps://farsightsec.github.io/fstrm\fR