manual(1)

🦋 manual(1) 🦋

okay so bestie, welcome to manual(1) — straight outta the General Commands Manual, and it's giving documentation generator energy. No cap, this one is here to generate manual pages for the command(s) you give it. ✨

---

🌸 NAME 🌸

manual — Generate manual page for the given command(s) 🎀

💖 SYNOPSIS 💖

manual [-d|--dir] [-h|--help] [CMDS]

✨ DESCRIPTION ✨

Generate manual page for the given command(s).

okay so the whole vibe is: this command lets you generate a manual page (following the man page format) for a given command. The page is printed to the standard output, so it can be written to a file using unix redirection. Giving a directory instead writes one page per command in it, creating the directory if it does not exist. slay. 💅

🎀 OPTIONS 🎀

• -d, --dir <PATH> — Save manual pages to the given directory. 🗂️
• -h, --help — Print help (see a summary with '-h'). 🙋
• [CMDS] — Command(s) for which manual page should be generated for. 👑

A command is named after its manual page: the program name for the main page, the program name followed by a dash and the subcommand name for a subcommand one. Defaults to every command, which requires a directory. 🫶

xoxo, manual · manual(1) — footer vibes only, bestie 💖