ARGPARSE-MANPAGE(1)

💅 ARGPARSE-MANPAGE 💅

okay bestie, so this is argparse-manpage — that's the name, and honestly the name ate. it lives in the Generated Python Manual manual, section 1, and it's here to do one (1) iconic thing: turn your Python argparse.ArgumentParser object into a real, actual man page. no cap, that's the whole vibe. 🎀

---

✨ 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]

note the vibes of these parentheses, bestie: you must pick either --module or --pyfile, and you must pick either --function or --object. the rest is all optional glow-up. 💖

---

🌸 DESCRIPTION 🌸

Build manual page from Python's argparse.ArgumentParser object. that's it. that's the flex. you point it at your parser, it hands you a man page, and you go live your best life. 🦋

---

👑 OPTIONS 👑

• --module MODULE — search the OBJECT/FUNCTION in MODULE. like, go look inside this importable module for the thing, bestie. 🔍
• --pyfile PYFILE — search the OBJECT/FUNCTION in FILE. same energy, but reading a file instead of importing a module. 📄
• --function FUNCTION — call FUNCTION from MODULE/FILE to obtain the ArgumentParser object. you're literally just invoking it and it hands you the parser. slay. ✨
• --object OBJECT — obtain ArgumentParser OBJECT from FUNCTION (to get argparse object) from MODULE or FILE. yes, the wording is a whole mood, but the point is: grab the parser object itself instead of calling a function. 🙈
• --project-name PROJECT_NAME — Name of the project the documented program is part of. give your project its main character credit. 💅
• --prog PROG — Substitutes %prog in ArgumentParser's usage. so your usage line actually says the real program name instead of looking awkward. 🫶
• --version VERSION — Version of the program, will be visible in the manual page footer. put a number on it, it deserves it. ⭐
• --description TEXT — description of the program, used in the NAME section, after the leading 'name - ' part, see man (7) man-pages for more info. so the NAME section reads like name - your text here. 🎀
• --author [AUTHOR] — Author of the program. Can be specified multiple times. collect them all like pokémon, bestie. 👑
• --url URL — Link to project's homepage. drop the link, let people find the source. 🌈
• --format {pretty,single-commands-section} — Format of the generated man page. Defaults to 'pretty'. two aesthetics, pick your fighter. 🦋
• --output OUTFILE — Output file. Defaults to stdout. no file? it just spills the whole page straight into your terminal, which is honestly kind of a serve. 🍓
• --manual-section MANUAL_SECTION — Section of the manual, by default 1. See man (7) man-pages for more info about existing sections. it's the number in the parentheses up top, iykyk. 🔥
• --manual-title MANUAL_TITLE — The title of the manual, by default "Generated Python Manual". See man (7) man-pages for more instructions. this is the big ALL-CAPS words in the header, so make it good. 💜
• --include FILE — File that contains extra material for the man page. add your own lore, bestie. 🌸
• --manfile FILE — File containing a complete man page. full custom job, you bring the entire page, it's giving DIY. 🧚

---

💅 AUTHOR 💅

Gabriele Giammatteo <gabriele.giammatteo@eng.it> — yeah, the actual legend who made this. absolute icon behavior. 💖

---

🦋 DISTRIBUTION 🦋

The latest version of argparse-manpage may be downloaded from https://github.com/praiskup/argparse-manpage — go grab it, star it, tell your friends. 🫶

---

ngl bestie, that's the whole page. every flag, every default, nothing skipped. 👑

mwah 💋 — this was argparse-manpage version 4.7, dated 2025-08-15, signing off with the biggest kiss to you and to the ARGPARSE-MANPAGE(1) header up top. go generate something iconic. 🌟