TROFF2NULL(1)

πŸ“¦
version 1.04 Β· 2 versions
, in debian bookworm, ubuntu noble

πŸ’– NAME πŸ’–

troff2null β€” convert troff documents to troffcvt internal format

okay so real quick, before anything else: this is a page from your General Commands Manual, section 1, and the star of the show is a little program called troff2null. she takes your troff and turns it into something troffcvt can vibe with. bestie behavior honestly 🫢


✨ SYNTAX ✨

troff2null [ options ] file ...  ]

yes, that stray ] at the end is literally how it's written. don't touch it. she's perfect. πŸ’…


🌸 DESCRIPTION 🌸

so here's the tea πŸ“: troff2null converts files written in the troff input language and converts them to the troffcvt internal representation. the way she does this is by running your input files through troffcvt first, and then through tc2null. two steps, one slay, that's the pipeline.

troff2null understands the usual troffcvt options β€” you know, the standard ones, she's fluent. but she also understands these extra ones below, and these are the ones you actually came here for:

  • -D β€” Enable debugging output. she's gonna be loud about what she's doing, and honestly? good for her.
  • -E β€” Cause tc2null to echo token information to stderr as tokens are read from troffcvt. full transparency, tokens just narrating themselves in real time.
  • -n β€” No execution. Just show the commands that troff2null would execute to process the document. a dress rehearsal, not the actual performance ✨
  • -p β€” Don't run the postprocessor (tc2null). just... skip that part entirely. she goes halfway and stops.
  • -T title β€” Specify a title for the document. This can be used for documents that do not contain any recognizable title. If the document does contain a title, it is overridden. so like, you can force a title onto a doc that has none, but heads up: if the doc already has one, yours wins and the original gets absolutely steamrolled. 😭

πŸ‘€ SEE ALSO πŸ‘€

the friend group. go say hi. πŸ’œ


🫣 WHO-TO-BLAME 🫣

Paul DuBois, dubois@primate.wisc.edu.

if anything goes weird, that's the icon to contact. not me. 🌈


πŸ’€ BUGS πŸ’€

okay so this one's important, no cap. troff2null uses a set of special macros that tell troffcvt how to generate tc2null-specific output that tc2null uses to recognize NULL structural elements.

⚠️ These macros do not work in compatibility mode. periodt. if you're in compatibility mode, they're just not gonna do the thing, and you will be sad. πŸ˜”

kisses bestie, that's the whole page β€” this was TROFF2NULL(1) from your General Commands Manual, section 1, brought to you with love and zero regrets πŸ’…πŸŽ€βœ¨

πŸ“¦ where this page comes from