.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "FY-TOOL" "1" "Mar 15, 2026" "" "libfyaml"
.SH "نام (NAME)"
fy-tool \- ابزار تجزیه، اعتبارسنجی و دستکاری فایل‌های YAML
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBfy\-tool\fP [\fIگزینه‌ها\fP] [<\fIفایل\fP> …]
.sp
\fBfy\-dump\fP [\fIگزینه‌ها\fP] [<\fIفایل\fP> …]
.sp
\fBfy\-testsuite\fP [\fIگزینه‌ها\fP] <\fIفایل\fP>
.sp
\fBfy\-filter\fP [\fIگزینه‌ها\fP] [\-f \fIFILE\fP] [<\fIمسیر\fP> …]
.sp
\fBfy\-join\fP [\fIگزینه‌ها\fP] [\-T \fIPATH\fP] [\-F \fIPATH\fP] [\-t \fIPATH\fP] [<\fIفایل\fP> …]
.sp
\fBfy\-ypath\fP [\fIگزینه‌ها\fP] <\fIypath\-expression\fP> [<\fIفایل\fP> …]
.sp
\fBfy\-compose\fP [\fIگزینه‌ها\fP] [<\fIفایل\fP> …]
.sp
\fBfy\-b3sum\fP [\fIگزینه‌ها\fP] [<\fIفایل\fP> …]
.SH "توضیحات (DESCRIPTION)"
.sp
دستور
\fBfy\-tool\fP
رابط خط فرمان کتابخانه libfyaml برای تجزیه، بازنویسی، پرس‌وجو، ادغام، آزمایش و محاسبه هش داده‌های YAML و JSON است.
.sp
رفتار این فایل اجرایی بر اساس نام برنامه فراخوانی‌شده
(\fBfy\-dump\fP، \fBfy\-testsuite\fP، \fBfy\-filter\fP، \fBfy\-join\fP، \fBfy\-ypath\fP،
\fBfy\-compose\fP، \fBfy\-b3sum\fP)
یا با گزینه‌های صریح انتخاب حالت مانند
\fB\-\-dump\fP
یا
\fB\-\-filter\fP
تغییر می‌کند.
.sp
حالت پیش‌فرض
\fBdump\fP
است.
.SH "گزینه‌ها (OPTIONS)"
.sp
گزینه‌های عمومی
.INDENT 0.0
.TP
.B \-h, \-\-help
نمایش پیام راهنمای توکار.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-version
نمایش نسخه libfyaml.
.UNINDENT
.INDENT 0.0
.TP
.B \-q, \-\-quiet
جلوگیری از نمایش خروجی‌های اطلاعاتی و هشدارهای غیربحرانی.
.UNINDENT
.INDENT 0.0
.TP
.B \-d LEVEL, \-\-debug\-level LEVEL
تعیین حداقل سطح شدت پیام‌های تشخیصی صادرشده توسط کتابخانه. مقدار پیش‌فرض
\fB3\fP
(سطح هشدار) است.
.UNINDENT
.INDENT 0.0
.TP
.B \-C MODE, \-\-color MODE
کنترل خروجی رنگی ANSI. مقادیر پشتیبانی‌شده عبارتند از
\fBon\fP، \fBoff\fP
و
\fBauto\fP\&.
مقدار پیش‌فرض
\fBauto\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-V, \-\-visible
نمایش فاصله‌ها، تب‌ها و شکست‌های خط در خروجی متنی.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dry\-run
تجزیه ورودی بدون تولید خروجی معمول.
.UNINDENT
.sp
گزینه‌های عیب‌یابی
.INDENT 0.0
.TP
.B \-\-disable\-diag MODULE
غیرفعال کردن خروجی تشخیصی برای ماژول مشخص‌شده.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-enable\-diag MODULE
فعال کردن خروجی تشخیصی برای ماژول مشخص‌شده.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-diag OPTION
نمایش فیلد تشخیصی مشخص‌شده. مقادیر پشتیبانی‌شده عبارتند از
\fBsource\fP،
\fBposition\fP،
\fBtype\fP
و
\fBmodule\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hide\-diag OPTION
پنهان کردن فیلد تشخیصی مشخص‌شده.
.UNINDENT
.sp
گزینه‌های تجزیه‌کننده
.INDENT 0.0
.TP
.B \-I DIR, \-\-include DIR
افزودن
\fBDIR\fP
به مسیر جستجوی شمول (include) ورودی.
.UNINDENT
.INDENT 0.0
.TP
.B \-j MODE, \-\-json MODE
انتخاب نحوه مدیریت ورودی JSON. مقادیر پشتیبانی‌شده عبارتند از
\fBno\fP، \fBforce\fP
و
\fBauto\fP\&.
مقدار پیش‌فرض
\fBauto\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-r, \-\-resolve
حل لنگرها (anchors) و کلیدهای ادغام در حین تجزیه.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yaml\-1.1
اعمال اجباری قواعد YAML 1.1 هنگامی که ورودی نسخه را اعلام نکرده باشد.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yaml\-1.2
اعمال اجباری قواعد YAML 1.2 هنگامی که ورودی نسخه را اعلام نکرده باشد.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yaml\-1.3
اعمال اجباری قواعد YAML 1.3 هنگامی که ورودی نسخه را اعلام نکرده باشد.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-follow
دنبال کردن نام‌های مستعار (aliases) در حین پیمایش مسیر و عملیات مبتنی بر مسیر مرتبط.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sloppy\-flow\-indentation
پذیرش قوانین تورفتگی آسان‌گیرانه در حالت جریان (flow mode).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-prefer\-recursive
ترجیح الگوریتم‌های بازگشتی بر الگوریتم‌های تکرارشونده (iterative).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ypath\-aliases
فعال‌سازی پردازش نام‌های مستعار برای ارزیابی ypath.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-allow\-duplicate\-keys
مجاز دانستن کلیدهای نگاشت تکراری.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-collect\-errors
جمع‌آوری چندین خطای تجزیه پیش از گزارش شکست.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-disable\-accel
غیرفعال کردن ویژگی‌های شتاب‌دهنده تجزیه‌کننده/تولیدکننده.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-disable\-buffering
غیرفعال کردن بافرینگ stdio و استفاده از خواندن مستقیم توصیف‌گر فایل (file descriptor).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-disable\-mmap
غیرفعال کردن ورودی مبتنی بر نگاشت حافظه (mmap).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-disable\-depth\-limit
غیرفعال کردن محدودیت معمول عمق تو در تویی.
.UNINDENT
.sp
گزینه‌های تولیدکننده خروجی
.INDENT 0.0
.TP
.B \-i INDENT, \-\-indent INDENT
تعیین عرض تورفتگی خروجی. مقدار پیش‌فرض
\fB2\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-w WIDTH, \-\-width WIDTH
تعیین عرض ترجیحی خروجی. برای عدم اعمال محدودیت عرض از
\fBinf\fP
استفاده کنید. مقدار پیش‌فرض
\fB80\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-m MODE, \-\-mode MODE
انتخاب شیوه خروجی. مقادیر پشتیبانی‌شده عبارتند از
\fBoriginal\fP، \fBblock\fP،
\fBflow\fP، \fBflow\-oneline\fP، \fBjson\fP، \fBjson\-tp\fP، \fBjson\-oneline\fP،
\fBdejson\fP، \fBpretty\fP، \fBflow\-compact\fP
و
\fBjson\-compact\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-sort
مرتب‌سازی کلیدهای نگاشت پیش از تولید خروجی.
.UNINDENT
.INDENT 0.0
.TP
.B \-c, \-\-comment
حفظ و صدور توضیحات (کامنت‌ها) در صورت پشتیبانی.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-strip\-labels
حذف لنگرها و نام‌های مستعار از خروجی صادرشده.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-strip\-tags
حذف برچسب‌های صادرشده.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-strip\-doc
حذف نشانگرهای شروع و پایان سند.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-strip\-empty\-kv
نادیده گرفتن کلیدهایی که مقادیر آن‌ها خالی یا تهی (null) است.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-null\-output
جلوگیری از تولید خروجی معمول.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-ending\-newline
عدم افزودن خط جدید پایانی.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-preserve\-flow\-layout
حفظ چیدمان مجموعه‌های جریانی تک‌خطی در صورت امکان.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-indented\-seq\-in\-map
ایجاد تورفتگی برای توالی‌های بلوکی که درون نگاشت‌های بلوکی قرار دارند.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-streaming
استفاده از حالت خروجی جریانی. این حالت پیش‌فرض است.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-streaming
غیرفعال کردن حالت خروجی جریانی.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-recreating
بازتولید رویدادهای جریانی به جای عبور مستقیم آن‌ها.
.UNINDENT
.sp
گزینه‌های مجموعه آزمون
.INDENT 0.0
.TP
.B \-\-disable\-flow\-markers
نادیده گرفتن نشانگرهای جریان در مجموعه آزمون.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-disable\-doc\-markers
نادیده گرفتن نشانگرهای سند در مجموعه آزمون.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-disable\-scalar\-styles
نادیده گرفتن نشانگرهای سبک اسکالر در مجموعه آزمون.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-document\-event\-stream
ساخت ابتدا سند و سپس تولید جریان رویدادها از روی آن.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tsv\-format
صدور خروجی مجموعه آزمون در قالب TSV.
.UNINDENT
.sp
گزینه‌های ورودی
.INDENT 0.0
.TP
.B \-f FILE, \-\-file FILE
خواندن از
\fBFILE\fP
به جای ورودی استاندارد در حالت‌هایی که از یک منبع ورودی استفاده می‌کنند. اگر
\fBFILE\fP
با
\fB>\fP
آغاز شود، ادامه متن به عنوان محتوای ورودی لفظی در نظر گرفته می‌شود.
.UNINDENT
.sp
گزینه‌های ادغام
.INDENT 0.0
.TP
.B \-T PATH, \-\-to PATH
ادغام در
\fBPATH\fP\&.
مقدار پیش‌فرض
\fB/\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-F PATH, \-\-from PATH
دریافت ورودی ادغام‌شده از
\fBPATH\fP\&.
مقدار پیش‌فرض
\fB/\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-t PATH, \-\-trim PATH
صدور تنها
\fBPATH\fP
از نتیجه ادغام‌شده. مقدار پیش‌فرض
\fB/\fP
است.
.UNINDENT
.sp
گزینه‌های YPATH
.INDENT 0.0
.TP
.B \-F PATH, \-\-from PATH
شروع ارزیابی از
\fBPATH\fP\&.
مقدار پیش‌فرض
\fB/\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dump\-pathexpr
نمایش عبارت مسیر تجزیه‌شده پیش از ارزیابی.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-noexec
تجزیه عبارت بدون اجرای آن.
.UNINDENT
.sp
گزینه‌های ترکیب (Compose)
.INDENT 0.0
.TP
.B \-\-dump\-path
نمایش مسیر در حین ترکیب سند.
.UNINDENT
.sp
گزینه‌های B3SUM
.INDENT 0.0
.TP
.B \-\-b3sum
فعال‌سازی حالت محاسبه هش BLAKE3.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-derive\-key CONTEXT
استفاده از حالت اشتقاق کلید همراه با
\fBCONTEXT\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-names
حذف نام فایل‌ها از خروجی چکسام.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-raw
صدور بایت‌های خام خلاصه پیام (digest).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-length N
صدور تنها
\fBN\fP
بایت خروجی، تا سقف حداکثر BLAKE3.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-check
بررسی و اعتبارسنجی چکسام‌های خوانده‌شده از فایل‌های ورودی.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keyed
استفاده از هش کلیددار، با خواندن کلید مخفی از ورودی استاندارد.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-backend BACKEND
انتخاب پیاده‌سازی بک‌اند BLAKE3.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-list\-backends
فهرست کردن بک‌اندهای موجود برای BLAKE3.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-num\-threads N
تعیین تعداد ریسمان‌های پردازشی کارگر. مقدار
\fB0\fP
به معنی انتخاب خودکار و
\fB\-1\fP
غیرفعال‌کننده هش چندریسمانی است.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-file\-buffer N
تعیین اندازه بافر ورودی/خروجی به ازای هر فایل.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-mmap\-min\-chunk N
تعیین حداقل اندازه تکه مورد استفاده برای ورودی هش با نگاشت حافظه.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-mmap\-max\-chunk N
تعیین حداکثر اندازه تکه مورد استفاده برای ورودی هش با نگاشت حافظه.
.UNINDENT
.sp
حالت‌ها
.INDENT 0.0
.TP
.B \-\-dump
انتخاب حالت dump. این حالت پیش‌فرض و همچنین حالت مورد استفاده توسط
\fBfy\-dump\fP
است.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-testsuite
انتخاب حالت مجموعه آزمون. این حالت همچنین توسط
\fBfy\-testsuite\fP
استفاده می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-filter
انتخاب حالت فیلتر. این حالت همچنین توسط
\fBfy\-filter\fP
استفاده می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-join
انتخاب حالت ادغام. این حالت همچنین توسط
\fBfy\-join\fP
استفاده می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ypath
انتخاب حالت پرس‌وجوی ypath. این حالت همچنین توسط
\fBfy\-ypath\fP
استفاده می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-scan\-dump
انتخاب حالت داخلی scan\-dump.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-parse\-dump
انتخاب حالت داخلی parse\-dump.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-compose
انتخاب حالت dump هدایت‌کننده ترکیب‌کننده (composer\-driver). این حالت همچنین توسط
\fBfy\-compose\fP
استفاده می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yaml\-version\-dump
چاپ اطلاعات نسخه YAML.
.UNINDENT
.SH "مثال‌ها (EXAMPLES)"
.sp
خروجی گرفتن مجدد از یک فایل YAML با استفاده از حالت پیش‌فرض تولیدکننده خروجی:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-dump invoice.yaml
.EE
.UNINDENT
.UNINDENT
.sp
حل لنگرها و حذف برچسب‌ها از نتیجه نهایی:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-dump \-r \-\-strip\-labels simple\-anchors.yaml
.EE
.UNINDENT
.UNINDENT
.sp
خواندن متن ورودی لفظی از طریق
\fB\-\-file\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-filter \-\-file \e\(dq>foo: bar\e\(dq /
.EE
.UNINDENT
.UNINDENT
.sp
انتخاب داده‌ها از یک فایل با استفاده از عبارت مسیر:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-filter \-\-file simple\-anchors.yaml /baz/bar
.EE
.UNINDENT
.UNINDENT
.sp
ادغام دو نگاشت ریشه در یک سند واحد:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-join simple\-anchors.yaml invoice.yaml
.EE
.UNINDENT
.UNINDENT
.sp
تولید خروجی رویدادهای مجموعه آزمون:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-testsuite invoice.yaml
.EE
.UNINDENT
.UNINDENT
.sp
فهرست کردن بک‌اندهای موجود برای BLAKE3:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ fy\-b3sum \-\-list\-backends
.EE
.UNINDENT
.UNINDENT
.SH "نویسندگان (AUTHORS)"
.sp
Pantelis Antoniou <\X'tty: link mailto:pantelis.antoniou@konsulko.com'\fI\%pantelis.antoniou@konsulko.com\fP\X'tty: link'>
.SH "اشکالات (BUGS)"
.INDENT 0.0
.IP \(bu 2
تنها کدگذاری نویسه‌ای پشتیبانی‌شده برای ورودی و خروجی UTF8 است.
.IP \(bu 2
مرتب‌سازی تنظیمات زبان و محلی را در نظر نمی‌گیرد.
.IP \(bu 2
هیچ راهکاری برای تعیین طرح رنگ‌بندی متفاوت توسط کاربر وجود ندارد.
.UNINDENT
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBlibfyaml(3)\fP
.SH "حق نشر (COPYRIGHT)"
2019-2026, Pantelis Antoniou
.\" Generated by docutils manpage writer.
.