TEXI2MDOC(1)

📦 version 0.1.2, in nixos 26.05, nixpkgs unstable

💅 TEXI2MDOC(1) 💅

okay so bestie, welcome to the General Commands Manual for texi2mdoc — she's giving "tiny utility, very specific job" energy and honestly? we stan. 🎀

✨ NAME ✨

texi2mdoc — convert texinfo documents to mdoc, no cap 💖

✨ SYNOPSIS ✨

texi2mdoc [-I dirs] [file]

✨ DESCRIPTION ✨

So the texi2mdoc utility does the thing: it converts GNU Texinfo documents into mdoc(7), mixed with tbl(7) when it applies. 🌸 By default, texi2mdoc reads from standard input — very demure, very mindful. 🧚

Here's what her arguments look like:

  • -I dirs — colon-separated directories to search for @include files. literally a little breadcrumb trail of places to look. 🍓
  • file — a Texinfo input file. if you specify it, the directory of file gets prepended to the list of -I directories. main character behavior. 👑

texi2mdoc can understand a significant subset of the texinfo language — she's not fluent in all of it, but she knows enough to hold a conversation. 🦋 She recognises herself as a plaintext formatter. The produced document's title is set to the filename of the file, and the description is set to the contents of the @settitle command. periodt. 💅

✨ EXIT STATUS ✨

The texi2mdoc utility exits 0 on success, and >0 if an error occurs. so like, zero means we ate, anything above zero means something went off. 😭🔥

✨ SEE ALSO ✨

✨ AUTHORS ✨

The texi2mdoc utility was written by Kristaps Dzonsons <kristaps@bsd.lv>. king behavior, we love to see it. 👑💜

✨ CAVEATS ✨

ngl, there's some stuff you should know before you get too comfortable:

  • The output consists of superfluous ‘Pp’ that cause
% mandoc -Tlint

to complain. she's a little messy, it's part of the charm. 🙈

  • Many commands that might contain useful information (such as @footnote) are thrown away. gone. reduced to atoms. 💀
  • The comma in Texinfo macro arguments may at times be escaped with a backslash. This is not supported. so like, don't come for her about that one. 😭

✨ SECURITY CONSIDERATIONS ✨

As a security precaution, texi2mdoc does not allow the inclusion (via @include or @verbatiminclude) of absolute paths or paths with .. as directory components. 🫶 so no sneaky escapes — she said "not on my watch". 🔥

💖 written with love by the Debian crew, dated February 25, 2015 — yeah she's been iconic for a minute. stay hydrated, read your man pages, and slay. 💅✨🌈
📦 where this page comes from