MKD2MAN(1)

💖 MKD2MAN(1) — the general commands manual, but make it cute 💖

okay bestie, so this is mkd2man, from the General Commands Manual section, and she is literally the glow-up artist of the manual page world 🌸

✨ NAME ✨

mkd2man — convert a markdown document into an mdoc manual page

🎀 SYNOPSIS 🎀

mkd2man [-h] [-d date] [-s section] [-t title] [file]

🦋 DESCRIPTION 🦋

so the mkd2man utility reads file and generates mdoc(7) input from markdown source. that's the whole vibe. ✨

and if you don't specify a file? no worries bestie, it just takes standard input instead. flexible queen 💅

The options are as follows:

• -d, --date — sets the document date (Dd) to date. and pls, the manpage says preferrably in "Month Day, Year" format — yes that typo is in the original, we keep it, it's iconic. 🙈 If unspecified, mkd2man uses the file modification date, or the current date if reading is from standard input or if stat(2) fails.
• -h, --help — displays help text. simple. slay.
• -s, --section — sets the document section (Dt) to section. If unspecified, mkd2man uses 1.
• -t, --title — sets the document title (Dt) to title. If unspecified, mkd2man uses the suffix-stripped filename part of file.

⚠️ okay but real talk: when reading is from stdin, the title must be specified. no title, no entry, no exceptions, periodt. 💀

🔥 EXIT STATUS 🔥

The mkd2man utility exits 0 on success, and >0 if an error occurs.

🌈 SEE ALSO 🌈

mkd2html(1), mkd2latex(1), mdoc(7)

👑 AUTHORS 👑

mkd2man was written by Natasha "Kerensikova" Porte <natacha@instinctive.eu> and Baptiste Daroussin <bapt@freebsd.org>.

Manual page was originally written by Massimo Manghi <mxmanghi@apache.org>, and rewritten to mdoc format by Svyatoslav Mishyn <juef@openmailbox.org>.

and that's a wrap, bestie 💖 this one came to you from Debian, dated March 30, 2016 — yes she's a lil vintage, but vintage is a vibe, okurrr? 🎀✨🦋