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

.SH "نام (NAME)"
ueberzug \- نمایش تصاویر در ترمینال

.SH "خلاصه دستور (SYNOPSIS)"
.SY ueberzug
.RI [ options ]

.SH "توضیحات (DESCRIPTION)"
.PP
.B ueberzug
برنامه‌ای است که برای نمایش تصاویر در محیط ترمینال با استفاده از ارتباط بین‌فرآیندی (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 UNUSED ", "
تنها برای سازگاری با نسخه‌های پیشین حفظ شده است.

.TP
.BR \-l ", " \-\-loader
.B UNUSED ", "
تنها برای سازگاری با نسخه‌های پیشین حفظ شده است.

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

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

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

.PP
دو عملیات وجود دارد:
.I add
و
.IR remove .
.PP

.SS
.B add
طرح‌واره جیسون عملیات (action json schema)
.PP
کلیدهای الزامی (Required Keys)

.RS
.TP
.B action " (string)"
باید برابر با
.I add
باشد.

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

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

.TP
.B یکی از موارد width/height یا max_width/max_height

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

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

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

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

.TP
.B x " (integer)"
موقعیت ستون در ترمینال.

.TP
.B y " (integer)"
موقعیت سطر در ترمینال.

.PP
کلیدهای اختیاری (Optional keys)

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

.RE

.SS
.B remove
طرح‌واره جیسون عملیات (action json schema)
.PP
کلیدهای الزامی (Required Keys)

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

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

.RE

.SH "مثال (EXAMPLE)"

.PP
جهت کارکرد این مثال، ابتدا یک فایل لوله‌ای با نام fifo (با دستور mkfifo fifo) بسازید و تصویری به نام image.png در پوشه جاری داشته باشید:

.PP
.EX
ueberzugpp layer \-o sixel < fifo &

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