نام (NAME)

ueberzug - نمایش تصاویر در ترمینال

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

ueberzug [options]

توضیحات (DESCRIPTION)

ueberzug برنامه‌ای است که برای نمایش تصاویر در محیط ترمینال با استفاده از ارتباط بین‌فرآیندی (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: UNUSED , تنها برای سازگاری با نسخه‌های پیشین حفظ شده است.
-l, --loader: UNUSED , تنها برای سازگاری با نسخه‌های پیشین حفظ شده است.

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

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

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

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

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

add

طرح‌واره جیسون عملیات (action json schema)

کلیدهای الزامی (Required Keys)

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

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

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

remove

طرح‌واره جیسون عملیات (action json schema)

کلیدهای الزامی (Required Keys)

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

مثال (EXAMPLE)

جهت کارکرد این مثال، ابتدا یک فایل لوله‌ای با نام fifo (با دستور mkfifo 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