NXBROWSE(1)

📦 version 4.4.3, in debian bookworm, debian trixie, epel 10, epel 9, fedora 43, fedora 44, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 NXBROWSE(1) 💖

okay bestie, gather round — this is the manual page for nxbrowse, a lil interactive browser for NeXus files. It lives in the General Commands Manual section of your system, and it is genuinely so much fun to poke around in. Let's get into it. 🦋

✨ NAME ✨

nxbrowse — browse a NeXus file 🌸

🎀 SYNOPSIS 🎀

nxbrowse [filename]

💅 DESCRIPTION 💅

So like, if you don't hand nxbrowse a filename right there on the command line, it's gonna ask you for one. Rude? No, it's just polite. 🫶

Once the file is opened, you can explore it interactively using all the commands listed down below. It's giving "choose your own adventure" but for data. 👑

⭐ OPTIONS ⭐

No command line options are supported. That's it. That's the section. nxbrowse said "I'm low maintenance." 💀

🌈 COMMANDS 🌈

When the file gets opened, nxbrowse will print out its version number and then the contents of the NXroot node of the NeXus file. Then it hits you with its prompt:

NX>

And from there, these commands are recognised — and yes, they are case insensitive, so type however your heart desires. 💖

  • help — gives you a list of all the available commands. Synonym: info
  • exit — dips out of the program. Synonym: quit
  • dir — lists everything inside the current group. Synonym: ls
  • open groupName — opens the NeXus group groupName. Same as: cd groupName
  • close — closes the NeXus group groupName, aka it moves you up one level in the hierarchy. Same as: cd ..
  • read dataItem [dimension indicies ...] — prints the contents of the NeXus data item labelled dataItem. The dimension indicies bit is an optional comma separated list of dimensions of the correct rank, and you use it to specify one value. 🔥
  • dump dataItem fileName — writes the contents of the NeXus data item labelled dataItem out to a new file named fileName. Slay. 💾
  • byteaschar — toggles treating (signed and unsigned) byte data as characters. Cute lil switch. 🎚️
bonus round: if your version of nxbrowse was compiled with readline support, you get tab completion for commands, groups and data. Absolutely iconic. ✨

👀 SEE ALSO 👀

💜 AUTHOR 💜

nxbrowse was originally written by Ray Osborn <ROsborn@anl.gov> 🧚

This manual page was written by Tobias Richter <Tobias.Richter@diamond.ac.uk> and may be used by others.

and that's the whole vibe check, bestie 💖 this page is dated June 2010, and it came to you from the NXBROWSE(1) corner of the General Commands Manual. go forth and browse those NeXus files, main character. 👑🌈🦋

📦 where this page comes from