img-xbm(n)

💖 img-xbm — X Windows Bitmap format (xbm) 💖

okay bestie, so this is the manual page for img-xbm, a lil sub-package of the Img crew. If you've ever wanted Tk to slurp up an .xbm file like it's nothing, this is the girlypop for you. let's get into it ✨

---

✨ SYNOPSIS ✨

package require img::xbm ?2.1?

that's it. that's the whole entrance. she's low maintenance 💅

---

🌸 DESCRIPTION 🌸

package require img::xbm

So like all the packages in Img, this one does NOT invent new commands. no new toys. instead it extends the Tk command image so that it can handle files holding raster images in the X Windows Bitmap format (xbm). more specifically? img::xbm extends Tk's photo image type. she's a glow-up, not a whole new person 🦋

The name of the new format handler is xbm. This handler brings new additional configuration options. (peep the Options section below for the deets, bestie.)

All of the above means that in a call like:

image create photo ?name? ?options?

1. Image data in xbm format (options -data and -file) is detected automatically. she just knows. no cap.
2. The format name xbm is recognized by the option -format.

In addition, the value of option -format is treated as a list and may contain any of the special options listed in the Options section. multitasking icon behavior fr fr 💅

The package img::xbm is a sub-package of Img. You can load it as a part of the complete Img support, via package require Img, or on its own, via package require img::xbm. your choice, bestie, both are valid 🫶

---

👑 OPTIONS 👑

The handler provides the following options:

• -verbose bool — supported for reading and writing. Available since version 2.0. If set to true, additional information about the read or written image is printed to stdout. Default is false. (so she'll yap if you let her 🙈)
• -foreground string — supported for reading only. Available since version 1.4.15. Sets the foreground color of the bitmap. Default value is black. The color string may be given in a format as accepted by Tk_GetColor. iconic default honestly 🖤
• -background string — supported for reading only. Available since version 1.4.15. Sets the background color of the bitmap. Default value is transparent. The color string may be given in a format as accepted by Tk_GetColor. transparent default?? we love a see-through moment ✨

---

🌈 SEE ALSO 🌈

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

(the whole friend group showed up. we stan a supportive squad 🫶)

---

💜 COPYRIGHT 💜

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>

---

k that's the whole page bestie, no gatekeeping here 💖

and for the lil sign-off moment: this was the img-xbm page, version 2.1, from the Img manual — go forth and convert ur bitmaps, main character 🎀✨