.TH UEBERZUGPP 1 "2023 May" "Ueberzugpp 2.9.10"

.SH "نام (NAME)"
ueberzugpp \- نمایش تصاویر در پایانه

.SH "خلاصه دستور (SYNOPSIS)"
.SY ueberzugpp
.RI [ گزینه‌ها ]

.SH "توضیحات (DESCRIPTION)"
.PP
.B ueberzugpp
برنامه‌ای است که برای نمایش تصاویر در پایانه با استفاده از یک ارتباط میان‌فرآیندی (IPC) طراحی شده است.

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

.TP
.BR \-h ", " \-\-help
نمایش متن راهنما.

.TP
.BR \-\-version
نمایش نسخه.

.TP
.BR \-\-use\-escape\-codes
استفاده از کدهای گریز (escape codes) برای دریافت قابلیت‌های پایانه.

.TP
.BR \-\-no\-stdin
عدم گوش دادن به ورودی استاندارد (stdin) برای دریافت دستورها.

.TP
.BR \-\-no\-cache
غیرفعال‌سازی ذخیره‌سازی موقت (کَش) برای تصاویر تغییر‌اندازه‌داده‌شده.

.TP
.BR \-\-no\-opencv
عدم استفاده از OpenCV و استفاده از Libvips به‌جای آن.

.TP
.BR \-o ", " \-\-output
روش خروجی تصویر؛ مقادیر معتبر برای آن عبارتند از:
.PP
.RS
.I x11 " (در صورت غیرفعال بودن در زمان کامپایل، ممکن است در دسترس نباشد)"
.br
.I sixel
.br
.I kitty
.br
.I iterm2
.br
.I wayland " (در صورت غیرفعال بودن در زمان کامپایل، ممکن است در دسترس نباشد)"
.br
.I chafa
.RE

.TP
.BR \-p ", " \-\-parser
.B استفاده‌نشده ", "
صرفاً برای سازگاری با نسخه‌های پیشین وجود دارد.

.TP
.BR \-l ", " \-\-loader
.B استفاده‌نشده ", "
صرفاً برای سازگاری با نسخه‌های پیشین وجود دارد.

.SH "ورودی استاندارد (STDIN)"

.PP
برنامهٔ Ueberzugpp دستورها را از طریق stdin یا از طریق سوکت یونیکس واقع در /tmp/ueberzug_.sock می‌خواند.
.PP
دستورها باید در قالب JSON باشند، همان‌طور که در بخش JSON IPC شرح داده شده است.

.SH "ارتباط میان‌فرآیندی جیسون (JSON IPC)"

.PP
دو کنش وجود دارد:
.I add
و
.I remove
.PP

.SS
.B add
طرح‌وارهٔ JSON کنش
.PP
کلیدهای الزامی

.RE
.TP
.B action " (رشته)"
باید
.I add
باشد

.TP
.B path " (رشته)"
مسیر تصویر مورد استفاده

.TP
.B identifier " (رشته)"
یک شناسه برای تصویر، تا بتوان آن را با کنش remove حذف کرد

.TP
.B یکی از گزینه‌های width/height یا max_width/max_height

.TP
.B width " (عدد صحیح)"
عرض تصویر

.TP
.B max_width " (عدد صحیح)"
حداکثر عرض تصویر

.TP
.B height " (عدد صحیح)"
ارتفاع تصویر

.TP
.B max_height " (عدد صحیح)"
حداکثر ارتفاع تصویر

.TP
.B x " (عدد صحیح)"
موقعیت ستون در پایانه

.TP
.B y " (عدد صحیح)"
موقعیت سطر در پایانه

.PP
کلیدهای اختیاری

.TP
.B scaler " (رشته)"
می‌تواند fit_contain یا forced_cover باشد.
.br
هر دو حالت مقیاس را بر پایهٔ مقداری که بزرگ‌تر است (عرض یا ارتفاع تصویر) تعیین می‌کنند

.RE

.SS
.B remove
طرح‌وارهٔ JSON کنش
.PP
کلیدهای الزامی

.RS
.TP
.B action " (رشته)"
باید remove باشد

.TP
.B identifier " (رشته)"
شناسهٔ تصویری که باید حذف شود

.RE

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

.PP
برای کارکرد این مثال، یک فایل fifo به نام fifo ایجاد کرده و تصویری به نام image.png در پوشهٔ جاری داشته باشید

.PP
ueberzugpp layer -o sixel < fifo &

.PP
echo '{"path": "./image.png", "action": "add", "identifier": "image", "x": 0, "y": 0, "width": 20, "height": 20}' > fifo