VIPS(1)

🦋 NAME 🦋

okay so this is vips — run vips operations from the command line. that's it, that's the whole vibe. you're in the <pink>VIPS(1)` general commands manual, bestie, and we're gonna have a time 💅

---

✨ SYNOPSIS ✨

vips [options] [command] [command-options] [command-args]

literally that's the whole shape of it. <cyan>options</cyan> first, then your <purple>command</purple>, then that command's own options, then its args. iykyk 🫶

---

🌸 DESCRIPTION 🌸

so <hotpink>vips(1)</hotpink> is the VIPS universal main program. it's the main character 👑. you can use it to:

• run any VIPS operation straight from the command line, no cap
• query the VIPS class hierarchy (like, snoop on the family tree 🌳)
• maintain parts of the VIPS library

and to actually run a VIPS operation? the first argument has to be the name of the operation, and everything after that is the operation's arguments. it's giving very straightforward, we love that for us 💖

for example:

$ vips invert lena.v lena2.v

see? iconic. ate. no crumbs. 🍓

---

💅 OPTIONS 💅

• -l BASE-NAME, --list=BASE-NAME — List operations below BASE-NAME. this prints a one-line summary of every single operation in vips below the class BASE-NAME. and BASE-NAME can be a full vips class name or a nickname, whichever you vibe with.

and if you don't supply BASE-NAME at all? it lists all classes below VipsOperation. go off, queen 🎀

• -p PLUGIN, --plugin=PLUGIN — Load PLUGIN. also heads up bestie, plugins sitting in $VIPSHOME/lib/vips-plugins-MAJOR.MINOR are loaded automatically, so you don't gotta do anything for those 🧚
• -v, --version — Show VIPS version. short, sweet, slays ✨
• -c NAME, --completion NAME — Print completions for NAME. tab-tab-tab your way through life 🌈

---

🔥 COMMANDS 🔥

• operation-name operation-arguments — Execute a named operation, for example add. yes that's really it, you just say the operation's name and hand it the args 💜

---

🌟 EXAMPLES 🌟

run a vips operation

Operation options must follow the operation name. (this is the rule, bestie, do not fight it 🙈)

$ vips insert lena.v lena2.v out.v 0 0 --background "128 0 0"

get a "usage" message for an operation

$ vips insert
insert image @sub into @main at @x, @y
usage:
   insert main sub out x y
where:
   main         - Main input image, input VipsImage
   sub          - Sub-image to insert into main image, input VipsImage
   out          - Output image, output VipsImage
   x            - Left edge of sub in main, input gint
default: 0                  min: -100000000, max: 100000000
   y            - Top edge of sub in main, input gint
default: 0                  min: -100000000, max: 100000000
optional arguments:
   expand       - Expand output to hold all of both inputs, input
gboolean                  default: false
   background   - Colour for new pixels, input VipsArrayDouble
operation flags: sequential

look at that, it literally tells you the whole menu. <mint>self-documenting king</mint> 🫶

list all draw operations

$ vips -l draw
  VipsDraw (draw), draw operations
    VipsDrawink (drawink), draw with ink operations
      VipsDrawRect (draw_rect), paint a rectangle on an image
      VipsDrawMask (draw_mask), draw a mask on an image
      VipsDrawLine (draw_line), draw a line on an image
      VipsDrawCircle (draw_circle), draw a circle on an image
      VipsDrawFlood (draw_flood), flood-fill an area
    VipsDrawImage (draw_image), paint an image into another image
    VipsDrawSmudge (draw_smudge), blur a rectangle on an image

the <purple>indentation</purple> is the class hierarchy btw — it's a whole family tree and honestly? adorable 🌸

---

⭐ RETURN VALUE ⭐

returns 0 on success and non-zero on error. so if you get a zero, you're thriving. if you don't... <red>bestie, something went wrong</red> 😭

---

🎀 SEE ALSO 🎀

vipsheader(1) — go read that one too, you're welcome 💖

---

👑 COPYRIGHT 👑

The National Gallery and Birkbeck College, 1989-1996.

---

and that's the whole page, no notes 💅 this little ray of sunshine came out of the General Commands Manual — <rainbow>VIPS(1)</rainbow> — dated 30 June 1993. iconic since '93, fr fr. go run some operations, bestie, you got this 🦋✨