UEBERZUGPP(1)

📦 version 2.9.10, in arch rolling, nixos 26.05, nixpkgs unstable

💅 UEBERZUGPP(1) — aka the ueberzugpp manual, but make it make sense ✨

okay so bestie, welcome to the General Commands Manual entry for ueberzugpp — yes that's the real manual name, we're doing this properly 🎀

🌸 NAME 🌸

ueberzugpp — display images in a terminal 💖

✨ SYNOPSIS ✨

ueberzugpp [options]

that's it. that's the whole vibe check. 💅

🦋 DESCRIPTION 🦋

so ueberzugpp is a program made to display images in a terminal — and it does it with an IPC. that's the whole thing, no cap. main character energy, honestly. 🌈

🎀 OPTIONS 🎀

  • -h, --help — shows the help text. classic. iconic. 🫶
  • --version — shows the version. 👑
  • --use-escape-codes — use escape codes to get the terminal capabilities ✨
  • --no-stdin — do not listen on stdin for commands 🙈
  • --no-cache — disables caching of resized images 💀
  • --no-opencv — don't use OpenCV, use Libvips instead 🍓
  • -o, --output — the image output method. valid values for this include:
    • x11 (may not be available if disabled in compilation 😭)
    • sixel
    • kitty
    • iterm2
    • wayland (may not be available if disabled in compilation 😭)
    • chafa
  • -p, --parser — UNUSED, only present for backwards compatibility. literally just vibing there 🧚
  • -l, --loader — UNUSED, only present for backwards compatibility. also just vibing 🧚

⭐ STDIN ⭐

ueberzugpp reads commands through stdin. or through the unix socket located at /tmp/ueberzug_.sock 🔥

commands should be in JSON form, as described in the JSON IPC section below 👇

💜 JSON IPC 💜

there are two actions: add and remove. only two. that's the whole menu 🍓

🌸 add 🌸

action json schema 🎀

Requried Keys

yes, that's spelled Requried in the original and I'm keeping it, it's part of the lore now 💀
  • action (string) — should be add
  • path (string) — the path to the image to use
  • identifier (string) — an identifier for the image, so that it can be removed with the remove action

One of width/height, or max_width/max_height — pick a lane bestie, you need one of these pairs 👑

  • width (integer) — width of the image
  • max_width (integer) — maximum width of the image
  • height (integer) — height of the image
  • max_height (integer) — maximum height of the image
  • x (integer) — the column position in the terminal
  • y (integer) — the row position in the terminal

Optional keys

  • scaler (string) — can be fit_contain or forced_cover. both base the scale on whichever is larger — the width, or the height of the image ✨

🌈 remove 🌈

action json schema 💖

Requried Keys

  • action (string) — should be remove
  • identifier (string) — the identifier of the image to remove

🔥 EXAMPLE 🔥

okay so for this example to actually work: create a fifo file named fifo, and have an image in the current folder named image.png 🫶

ueberzugpp layer -o sixel < fifo &
echo '{"path": "./image.png", "action": "add", "identifier": "image",
"x": 0, "y": 0, "width": 20, "height": 20}' > fifo

slay. that's the whole demo. go off 💅✨

reminder bestie: the x11 and wayland outputs might not even exist for you if they were disabled in compilation — so if it's giving nothing, that's why 😭

and that's the manual 💖 this was Ueberzugpp 2.9.10, dated 2023 May — mwah, love you, bye 🎀🦋💜

📦 where this page comes from