OS Manuals

/usr/bin/argparse-manpage

Executable binaries for argcomplete-manpage installed for python3.13

From py3.13-argcomplete-manpage-bin 4.8-r2 (enterprise-packages), captured 2026-11-08 by running argparse-manpage --help (exit 0). permalink

usage: 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]

Build manual page from Python's argparse.ArgumentParser object.

options:
  -h, --help            show this help message and exit
  --module MODULE       search the OBJECT/FUNCTION in MODULE
  --pyfile PYFILE       search the OBJECT/FUNCTION in FILE
  --function FUNCTION   call FUNCTION from MODULE/FILE to obtain ArgumentParser object
  --object OBJECT       obtain ArgumentParser OBJECT from FUNCTION (to get argparse object) from
                        MODULE or FILE
  --project-name PROJECT_NAME
                        Name of the project the documented program is part of.
  --prog PROG           Substitutes %prog in ArgumentParser's usage.
  --version VERSION     Version of the program, will be visible in the manual page footer.
  --description TEXT    description of the program, used in the NAME section, after the leading
                        'name - ' part, see man (7) man-pages for more info
  --author [AUTHOR]     Author of the program. Can be specified multiple times.
  --url URL             Link to project's homepage
  --format {pretty,single-commands-section}
                        Format of the generated man page. Defaults to 'pretty'.
  --output OUTFILE      Output file. Defaults to stdout.
  --manual-section MANUAL_SECTION
                        Section of the manual, by default 1. See man (7) man-pages for more info
                        about existing sections.
  --manual-title MANUAL_TITLE
                        The title of the manual, by default "Generated Python Manual". See man (7)
                        man-pages for more instructions.
  --include FILE        File that contains extra material for the man page.
  --manfile FILE        File containing a complete man page.
Options (17)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--module MODULEsearch the OBJECT/FUNCTION in MODULEhelp + man
--pyfile PYFILEsearch the OBJECT/FUNCTION in FILEhelp + man
--function FUNCTIONcall FUNCTION from MODULE/FILE to obtain ArgumentParser objecthelp + man
--object OBJECTobtain ArgumentParser OBJECT from FUNCTION (to get argparse object) from MODULE or FILEhelp + man
--project-name PROJECT_NAMEName of the project the documented program is part of.help + man
--prog PROGSubstitutes %prog in ArgumentParser's usage.help + man
--version VERSIONVersion of the program, will be visible in the manual page footer.help + man
--description TEXTdescription of the program, used in the NAME section, after the leading 'name - ' part, see man (7) man-pages for more infohelp + man
--author AUTHORAuthor of the program.help
--url URLLink to project's homepagehelp + man
--format prettyFormat of the generated man page.help + man
--output OUTFILEOutput file.help + man
--manual-section MANUAL_SECTIONSection of the manual, by default 1.help + man
--manual-title MANUAL_TITLEThe title of the manual, by default "Generated Python Manual".help + man
--include FILEFile that contains extra material for the man page.help + man
--manfile FILEFile containing a complete man page.help + man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.