ARGPARSE-MANPAGE(1)

🦋 ARGPARSE-MANPAGE(1) — the argparse-manpage glow-up ✨

okay so bestie, welcome to argparse-manpage, section 1 of the Generated Python Manual. this is the page that literally builds man pages out of Python's argparse.ArgumentParser object, no cap. it's giving "I write my docs once and the man page just appears" energy 💅

---

🌸 SYNOPSIS 🌸

argparse-manpage [-h] (--module MODULE | --pyfile PYFILE) (--function
FUNCTION | --object OBJECT) [--project-name PROJECT_NAME] [--prog PROG]
[--version VERSION] [--description TEXT] [--author [AUTHOR]] [--url URL]
[--format {pretty,single-commands-section}] [--output OUTFILE]
[--manual-section MANUAL_SECTION] [--manual-title MANUAL_TITLE]
[--include FILE] [--manfile FILE]

like, yes, that's a lot of brackets. it's fine. those are choices she's giving you 🎀

---

💖 DESCRIPTION 💖

Build a manual page from Python's argparse.ArgumentParser object. that's it, that's the whole vibe. your parser already knows all the flags — she just needs a little help getting dressed for the man page format 💅✨

---

👑 OPTIONS 👑

• --module MODULE — search for the OBJECT/FUNCTION inside MODULE. 🔍
• --pyfile PYFILE — search for the OBJECT/FUNCTION inside FILE instead. same energy, different door. 🚪
• --function FUNCTION — call FUNCTION from MODULE/FILE to obtain the ArgumentParser object. she does the work, you get the parser 🫶
• --object OBJECT — obtain the ArgumentParser OBJECT from FUNCTION (yes, to get the argparse object) from MODULE or FILE. iykyk 🔥
• --project-name PROJECT_NAME — the name of the project that the documented program is part of. give her some family, she deserves it 💖
• --prog PROG — substitutes %prog in ArgumentParser's usage. iconic substitution moment ✨
• --version VERSION — the version of the program — this one will be visible in the manual page footer. main character placement fr 🌟
• --description TEXT — a description of the program, used in the NAME section, right after the leading 'name - ' part. check out man (7) man-pages for more info 📖
• --author [AUTHOR] — author of the program. can be specified multiple times — collect them like stickers 🎀
• --url URL — a link to the project's homepage. link her up 🔗
• --format {pretty,single-commands-section} — the format of the generated man page. defaults to 'pretty'. two options, both slay, pick your fighter 💅
• --output OUTFILE — the output file. defaults to stdout. no file? she'll just scream it into your terminal, respectfully 😭
• --manual-section MANUAL_SECTION — the section of the manual, 1 by default. peep man (7) man-pages for more info about which sections exist 📚
• --manual-title MANUAL_TITLE — the title of the manual, "Generated Python Manual" by default. see man (7) man-pages for more instructions 🏷️
• --include FILE — a file that contains extra material for the man page. bonus content, we love her 🍓
• --manfile FILE — a file containing a complete man page. the whole thing, ready to go 👑

---

🧚 AUTHOR 🧚

Gabriele Giammatteo <gabriele.giammatteo@eng.it> — the icon, the legend, the reason this page exists 💜

---

🌈 DISTRIBUTION 🌈

the latest version of argparse-manpage may be downloaded from https://github.com/praiskup/argparse-manpage — go get her, she's fresh 🦋

---

ok bestie real talk for a sec: --output defaults to stdout, so if you forget to give her a file she'll just dump the whole page right there in your terminal. not a bug, just ✨a choice✨ you made 🙈

---

and that's the tea, bestie 🎀 this was argparse-manpage version 4.6, dated 2025-04-01 — go forth and generate man pages that are, honestly, prettier than mine 💖✨🌸🫶