img-xpm(n)

💅 img-xpm — the manual, but make it cute

okay so bestie, this is img-xpm(n), part of the Img family, and it's literally the girl who handles X Windows Pixmap Format (xpm) files. yes that xpm. the one with the ASCII art and the color palettes. iconic behavior tbh 🎀

---

✨ NAME ✨

img-xpm — X Windows Pixmap Format (xpm) 💖

---

🌸 SYNOPSIS 🌸

package require img::xpm ?2.1?

---

🦋 DESCRIPTION 🦋

okay so first thing, you gotta do the thing:

package require img::xpm

and here's the tea 🍓 — like literally every other package in Img, this one does not give you brand new commands. no ma'am. instead it extends the Tk command image so that it can handle files with raster images in the X Windows Pixmap Format (xpm). more specifically, img::xpm extends Tk's photo image type, which you can go read about over at https://www.tcl.tk/man/tcl9.0/TkCmd/photo.html if you're feeling scholarly 📚

the name of this new format handler is xpm. and this handler brings new additional configuration options, so if you wanna know the deets, go look at the Options section below. i'll wait 🫶

all of the above means that when you make a call like:

image create photo ?name? ?options?

here's what's actually happening:

1. image data in xpm format — that's the options -data and -file — is detected automatically. no extra work, she just knows ✨
2. the format name xpm is recognized by the option -format.

and bonus: the value of the option -format gets treated as a list, so it can contain any of the special options listed in the Options section. versatile queen 👑

also, img::xpm is a sub-package of Img. so you can load it either as part of the whole complete Img support situation, via package require Img, or all on its own like a strong independent package, via package require img::xpm. both are valid, do what feels right 💅

---

💖 OPTIONS 💖

the handler provides the following options, and yes there's only one but she's doing her best:

• -verbose bool — this option is supported for reading and writing. it's been available since version 2.0. if you set it to true, additional information about the image you read or wrote gets printed to stdout. the default is false. lowkey a chatterbox when you let her be 🗣️

---

👑 SEE ALSO 👑

go check out her whole friend group fr fr:

img, img-bmp, img-dted, img-flir, img-gif, img-ico, img-jpeg, img-pcx, img-pixmap, img-png, img-ppm, img-ps, img-raw, img-sgi, img-sun, img-tga, img-tiff, img-window, img-xbm, img-xpm

---

🌈 COPYRIGHT 🌈

the legal girlies, show them respect:

• Copyright (c) 1995-2025 Jan Nijtmans <nijtmans@users.sourceforge.net>
• Copyright (c) 2002-2025 Andreas Kupries <andreas_kupries@users.sourceforge.net>
• Copyright (c) 2003-2025 Paul Obermeier <obermeier@users.sourceforge.net>

---

and that's the whole page bestie 🎀 this was img-xpm at version 2.1, dated img-xpm(n) — no cap, that's literally everything. now go make some pixmaps, you absolute main character 💜✨🦋