yodlconverters(7)

📦
version 4.05.02 · 4 versions
, in ubuntu resolute, ubuntu stonking

💖 yodlconverters(7) — Your Own Document Language, but make it a group chat 💖

okay bestie, sit down, grab a strawberry 🍓, because we're talking about yodlconverters(7) — the lil fam of shell scripts that take your Yodl documents and yeet them into literally every other format you could want. it's giving translator polyglot energy. 🌈

✨ SYNOPSIS ✨

yodl2... [OPTION]... FILE

that's it. that's the whole vibe. you hand it options, you hand it a FILE, it does the thing. 💅

🌸 DESCRIPTION 🌸

so this page is the main-character introduction to all the various shell scripts that convert documents written in the Yodl language into other formats. the core squad — the basic converters — is:

  • yodl2html(1): converts to HTML and writes a file with the extension .html. web girlie behavior, no cap.
  • yodl2man(1): converts to nroff man format and writes .man. you can take it further and process it with e.g. nroff -Tascii -man file.man. so meta, it's a manpage making manpages 🫶
  • yodl2latex(1): converts to LaTeX output and writes .latex. can be further processed with, e.g., latex file.latex. academic baddie mode activated.
  • yodl2txt(1): converts to plain ASCII and writes .txt. ngl this one is a very rudimentary converter — it's the last-resort. the "we're out of options but we still ball" converter. 😭

💅 OPTIONS 💅

the options are identical to those of the yodl(1) program. iconic, consistent, we love a family that shares.

Additionally, the following options are available:

  • --no-warnings — by default the converters call yodl(1) using the -w flag. this option suppresses that flag. so if the warnings are too loud and you want peace? here's your mute button. 🔇
  • --intermediate=<filename> — by default, the files used for the communication between yodl and yodlpost get removed following the conversion. this option lets you retain those files, and they're called <filename> and <filename>.idx. keeping receipts, literally. 📝

🎀 FILES 🎀

every single yodl2format converter needs a file called format.yo to be sitting in Yodl's include path (e.g., tmp/wip/macros). this file gets auto-loaded before FILE (yes, the one from the synopsis, keep up bestie 💖) is loaded — that's literally how the conversion to format becomes possible at all.

the output gets written to one or more files that have the extension .format. one or more. plural. it said what it said. ✨

🔥 SEE ALSO 🔥

yodl(1), yodlbuiltins(7), yodlletter(7), yodlmacros(7), yodlmanpage(7), yodlpost(1), yodlstriproff(1), yodltables(7), yodlverbinsert(1).

the whole extended universe. go read them, iykyk. 👑

💀 BUGS 💀

-

(that's it. that's the bugs section. nothing. flawless. no notes. 🧚)

🦋 AUTHOR 🦋

Frank B. Brokken (f.b.brokken@rug.nl),

and that's the whole page bestie!! shoutout to yodl_4.05.02, running the game from 1996 all the way to 2025 — that's longevity, that's main character energy, that's periodt. 💜✨🎀

📦 where this page comes from