RTLBROWSE(1)

💖 RTLBROWSE(1) — the File Viewing girlies' manual 💖

okay so bestie, welcome to rtlbrowse, straight out of the File Viewing section of the manual, and she is so much. she's your lil tour guide through Verilog HDL source code and library design files. let's get into it 🦋

✨ NAME ✨

rtlbrowse — allows hierarchical browsing of Verilog HDL source code and library design files. no cap, that's the whole vibe. 👑

🌸 SYNTAX 🌸

rtlbrowse <stemsfilename>

that's it. one argument. she's low maintenance. 💅

🎀 DESCRIPTION 🎀

so like, rtlbrowse lets you browse Verilog HDL source code and library design files hierarchically. it's giving tree structure, it's giving main character energy.

how you actually move around in there:

• you can navigate through the hierarchy by clicking on the open areas of the tree widget, and by clicking on the individual levels of hierarchy.
• inside the source code, you descend deeper into the RTL hierarchy by double clicking the module instantiation name, or by drag-clicking to select part of that name.

now for the annotation tea ☕:

not me dropping the important part — she performs optional source code annotation when she's called as a helper application by gtkwave(1) and when the primary marker is set.

⚠️ bestie listen: source code annotation is not available for all supported dumpfile types. she does not do it for everybody, okay??

it's directly available for:

• LXT2
• VZT
• FST
• AET2

for VCD, you gotta use the -o,--optimize option of gtkwave(1) in order to optimize the VCD file into FST. yes ma'am, that's the move. ✨

and every other dumpfile type — that's LXT and GHW — is unsupported at this time. 😭 rip. they're just not invited to the party yet.

🌈 EXAMPLES 🌈

to run this program the standard way, type:

rtlbrowse stemsfile

the RTL is then brought up in a GTK tree viewer. iconic behavior honestly.

💀 heads up though: the stems must have been previously generated with xml2stems(1) or some other tool capable of generating compatible stemsfiles. you cannot just roll up with nothing, she needs the stems already made. periodt.

also, gtkwave(1) will bring up this program as a client application for source code annotation. and the way she does that?? she brings up the viewer with the shared memory ID of a segment of memory in the viewer, rather than using a stems filename. iykyk. 🔥

🫶 AUTHORS 🫶

• Anthony Bybell <bybell@rocketmail.com> — the legend herself, we stan 💜

👑 SEE ALSO 👑

• xml2stems(1)
• gtkwave(1)

and that's a wrap, bestie!! 🎀 this page came to you courtesy of Anthony Bybell, version 3.3.28, from the RTLBROWSE(1) manual in the File Viewing section. go browse some hierarchy, you absolute icon. slay 💅✨🦋