roffit(1)

📦
version 0.17 · 2 versions
, in alpine 3.24, debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

🎀 NAME 🎀

roffit — okay so bestie, it converts nroff into HTML. That's the whole gig. Iconic behaviour, honestly. 💅

✨ SYNOPSIS ✨

roffit [options] < inputfile > outputfile

🦋 DESCRIPTION 🦋

So here's the tea ☕: roffit takes your inputfile and turns it into your outputfile. And listen — the inputfile has to be an nroff formatted man page, like that's non-negotiable, no substitutes. The outputfile comes out as an HTML document. Slay. 👑

💅 OPTIONS 💅

  • --bare — the output HTML is gonna be naked ✨, meaning it will not include any HTML, HEAD or BODY tags. And also — heads up — when you pick this, there's no inlined CSS either, so you're fully on your own defining the classes you need, bestie. You got this tho 🫶
  • --version — displays the version number and then just dips. Bye 👋
  • --mandir=<dir> — sets a directory where roffit will go looking for other man pages (in nroff [name].[num] format) that this one refers to. If it finds them? A <a href> link gets made to that page with a html extension instead of the number. And the file name in the generated link will be prefixed by the dir you gave with --hrefdir. 🌈

This works for references written as manpage(3) (inside the emphasis formatting) and also in a plain .BR section — which is, like, the one everyone uses in the SEE ALSO section. iykyk 💜

  • --hrefdir=<dir> — specify a directory to prefix the generated href links that were created with the --mandir option. Defaults to ".". Yes, just a lil dot. Humble. 🎀
  • --preserve-case — when you use this, roffit preserves the case in SH (section header) in the output instead of uppercasing the first letter and lowercasing the rest. Not me telling you that this case-changing behaviour was introduced in roffit 0.13 — because it was, fr fr. 🗓️

🌸 CSS CLASSES 🌸

  • h2.nroffsh — the nroff ".SH" section. These are normally the "headlines" that come before each sub section inside the man page. Main character energy fr 👑
  • p.nroffip — the nroff ".IP" section. These are normally the bullet kind, used to list each option out of several in a list. Usually followed by a p.level0 containing the descriptive text. 🍓
  • p.level0 — normal text at the first level. Normally not indented at all.
  • p.level1 — text at the next logical indent level. Normally indented one level right. ➡️
  • p.level2 — text at the second logical indent level. Normally indented two levels right. ➡️➡️
  • span.bold — text marked to be bold.
  • span.manpage — text marked as a reference to another man page. 🔗
  • span.emphasis — text marked to be emphasized. 💫
  • p.roffit — used for the advertising final paragraph. Yes it's literally a class for the ad. We love a self-promo moment. 🙈

🌈 WWW 🌈

https://daniel.haxx.se/projects/roffit

And that's the whole page, bestie — this was the roffit 0.13 manual, dated October 5 2021. Go forth and convert your man pages. Periodt. 💖✨🎀

📦 where this page comes from