yodlmanpage(7)

💅 NAME 💅

okay so bestie, meet yodlmanpage — it's Yodl's very own manpage document type, and honestly? iconic. 🎀

---

✨ SYNOPSIS ✨

The manpage document type was specifically implemented to write Unix-style manual pages. no cap. The other Yodl document formats — like article, report and book — are documented in the Yodl guide and in the manpage for yodlmacros, so go read those if that's your vibe. 📖

---

🦋 DESCRIPTION 🦋

This manual page briefly describes the manpage document type of the Yodl document language. fr fr, this document type is specific enough that it warrants a separate manpage. queen behaviour. 👑

Yodl manpage documents can be converted to groff documents (using yodl2man), to html documents (using yodl2html), or to plain ascii text documents (using yodl2txt). pick your fighter ✨

manpage documents do not use the standard sectioning commands (e.g., sect() and subsect() — not them), but they have specific manpage...() macros instead. You can however use other normal macros (and bestie, you are encouraged to!!), such as description(...) or itemization(...) for lists, or bf() for boldface and em() for emphasis. As for fonts, the following is suggested:

• Use em(text) when text is a variable, or a placeholder, etc.. 🧚
• Use bf(text) when text is literal, such as a command, a filename, a directory.

Each manpage document in Yodl must be organized as follows:

• manpage(name) (section) (date) (package) (source): this is the preamble of the document. It states whatever the page describes, the section where it belongs, the release date, the package that it belongs to, and the source of the package. And the section number should be (according to the Linux manpage on man) — listen up, this is important 👑:
  • 1 for commands
  • 2 for system calls
  • 3 for library calls
  • 4 for special files
  • 5 for file formats
  • 6 for games
  • 7 for macro packages and conventions
  • 8 for system management commands
  • 9 for other special subjects (e.g., kernel commands)
• manpagename(name) (short description): the name is again whatever is described, and the short description is what e.g., the whatis database uses for descriptions.
• manpagesynopsis(): a very short usage information or similar. Keep this section short — e.g., a line with all program options is acceptable but without descriptions (those come later). no spoilers 🫶
• manpagedescription(): the purpose of the program and such. This is also the place to document the workings.
• manpageoptions(): this is the place to document e.g. the flags that are stated in the manpagesynopsis(). This section is optional, but when present, must appear at this place. 👀
• manpagefiles(): relevant files are described in this section.
• manpageseealso(): this section lists related manual pages.
• manpagediagnostics(): error conditions, error messages, etc..
• manpagebugs(): this is where known bugs are described. This section is optional.
• manpageauthor(): stating the author and/or the maintainer.
• manpagesection(NAME): this macro starts a generic, non-required section. E.g., you might want a manpagesection(EXAMPLES) in your document. As a typographic suggestion, use upper case for the NAME argument for consistency reasons. 💅

---

🌈 SEE ALSO 🌈

go give these a lil read, they're all connected bestie:

• yodl(1)
• yodlbuiltins(7)
• yodlconverters(1)
• yodlletter(7)
• yodlmacros(7)
• yodlpost(1)
• yodlstriproff(1)
• yodltables(7)
• yodlverbinsert(1)

---

💀 BUGS 💀

• -

literally nothing. flawless. we love to see it. ✨

---

🎀 AUTHOR 🎀

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

---

that's the whole page, bestie 💖 this one's from yodl_4.05.02, dated 1996-2025, and it goes by yodlmanpage(7). stan. 🦋🌸