نام (NAME)

ueberzugpp - نمایش تصاویر در پایانه

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

ueberzugpp [گزینه‌ها]

توضیحات (DESCRIPTION)

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

گزینه‌ها (OPTIONS)

-h, --help: نمایش متن راهنما.
--version: نمایش نسخه.
--use-escape-codes: استفاده از کدهای گریز (escape codes) برای دریافت قابلیت‌های پایانه.
--no-stdin: عدم گوش دادن به ورودی استاندارد (stdin) برای دریافت دستورها.
--no-cache: غیرفعال‌سازی ذخیره‌سازی موقت (کَش) برای تصاویر تغییر‌اندازه‌داده‌شده.
--no-opencv: عدم استفاده از OpenCV و استفاده از Libvips به‌جای آن.
-o, --output: روش خروجی تصویر؛ مقادیر معتبر برای آن عبارتند از:

x11 (در صورت غیرفعال بودن در زمان کامپایل، ممکن است در دسترس نباشد)
sixel
kitty
iterm2
wayland (در صورت غیرفعال بودن در زمان کامپایل، ممکن است در دسترس نباشد)
chafa

-p, --parser: استفاده‌نشده , صرفاً برای سازگاری با نسخه‌های پیشین وجود دارد.
-l, --loader: استفاده‌نشده , صرفاً برای سازگاری با نسخه‌های پیشین وجود دارد.

ورودی استاندارد (STDIN)

برنامهٔ Ueberzugpp دستورها را از طریق stdin یا از طریق سوکت یونیکس واقع در /tmp/ueberzug_.sock می‌خواند.

دستورها باید در قالب JSON باشند، همان‌طور که در بخش JSON IPC شرح داده شده است.

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

دو کنش وجود دارد: add و remove

add

طرح‌وارهٔ JSON کنش

کلیدهای الزامی

action (رشته): باید add باشد
path (رشته): مسیر تصویر مورد استفاده
identifier (رشته): یک شناسه برای تصویر، تا بتوان آن را با کنش remove حذف کرد
یکی از گزینه‌های width/height یا max_width/max_height
width (عدد صحیح): عرض تصویر
max_width (عدد صحیح): حداکثر عرض تصویر
height (عدد صحیح): ارتفاع تصویر
max_height (عدد صحیح): حداکثر ارتفاع تصویر
x (عدد صحیح): موقعیت ستون در پایانه
y (عدد صحیح): موقعیت سطر در پایانه

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

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

remove

طرح‌وارهٔ JSON کنش

کلیدهای الزامی

action (رشته): باید remove باشد
identifier (رشته): شناسهٔ تصویری که باید حذف شود

مثال‌ها (EXAMPLES)

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

ueberzugpp layer -o sixel < fifo &

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