FBFRAME(1)

📦
version 7.44.0 · 2 versions
, in nixpkgs unstable

💅 FBFRAME(1) — the BRL-CAD glow-up page ✨

okay so real talk, this is fbframe from the BRL-CAD manual set, and it's here to give your framebuffer a little ✨lewk✨. buckle up bestie 🎀

🌸 NAME 🌸

fbframe — draws a colored border around a framebuffer, and honestly? it eats. 💅

🦋 SYNOPSIS 🦋

fbframe [-F framebuffer] [-s|-S squareframesize] [-w|-W frame_width] [-n|-N frame_height]

💖 DESCRIPTION 💖

okay so fbframe draws a single-pixel-wide colored border around the edge of a framebuffer. yes, one pixel. it's giving minimalist. 🎀

the border gets drawn counter-clockwise starting from the bottom, and the color order is iconic:

  • red along the bottom 🔥
  • green up the right side 💚
  • blue across the top 💙
  • white down the left side 🤍

why tho? because it's useful for verifying the displayable area and alignment of a framebuffer. that's the whole vibe check, no cap. it's literally how you confirm your screen isn't lying to you.

lowkey important detail: the -w/-W and -n/-N options set the width and height of the region that fbframe opens and frames. that is not the thickness of the border — the border thickness is always one pixel, periodt. don't @ me. if no size is given, the dimensions are taken from the opened framebuffer. 🫶

and the -F option selects the framebuffer; if you omit it, the FB_FILE environment variable is consulted (see brlcad(1)). iykyk.

✨ OPTIONS ✨

  • -F framebuffer — specify the framebuffer device to use. if you don't, the FB_FILE environment variable or the default framebuffer gets used instead. choose your fighter 🥊
  • -s squareframesize, -S squareframesize — sets both the width and height of the framed region to the given number of pixels. square vibes only. ⬜
  • -w frame_width, -W frame_width — sets the width (in pixels) of the framed region.
  • -n frame_height, -N frame_height — sets the height (in scanlines) of the framed region. yes, scanlines, we're being precise 💀
  • -h, -? — prints a usage message and exits. the classic "help me help you" move 🙈

💜 EXAMPLES 💜

⭐ Example 1. Frame a 1024x1024 region and verify it visually

fbframe -F /tmp/test.pix -s 1024
fb-png -F /tmp/test.pix -s 1024 > frame.png

so what's happening here: it opens a 1024x1024 framebuffer (in this case a memory-mapped pix(5) file, cute), draws the colored border, then captures the result to a PNG with fb-png(1). 📸

and the whole point of the red/green/blue/white edges is that they make it easy to confirm the full displayable area is being rendered and that no rows or columns are being clipped. like a little visual receipt. 🧾✨ no cap, that's the entire flex.

🌈 SEE ALSO 🌈

brlcad(1), fbgrid(1), fbcbars(1), fbclear(1), fb-png(1) — go read the whole friend group 🫶

👑 AUTHOR 👑

BRL-CAD Team

This software is Copyright (c) 1989-2026 by the United States Government as represented by U.S. Army Research Laboratory.

(governments get copyright too, bestie 💀)

🧚 BUG REPORTS 🧚

Reports of bugs or problems should be submitted via electronic mail to devs@brlcad.org

fr fr if something's cursed, tell the devs. don't just suffer in silence. 😭

and that's the page!! 💖 this whole thing is FBFRAME(1) out of the BRL-CAD manual set — 1989-2026 vintage, still cute, still drawing one-pixel borders. slay 🎀✨

📦 where this page comes from