GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
ARGPARSE-MANPAGE(1) Generated Python Manual ARGPARSE-MANPAGE(1)

argparse-manpage

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.

search the OBJECT/FUNCTION in MODULE

search the OBJECT/FUNCTION in FILE

call FUNCTION from MODULE/FILE to obtain ArgumentParser object

obtain ArgumentParser OBJECT from FUNCTION (to get argparse object) from MODULE or FILE

Name of the project the documented program is part of.

Substitutes %prog in ArgumentParser's usage.

Version of the program, will be visible in the manual page footer.

description of the program, used in the NAME section, after the leading 'name - ' part, see man (7) man-pages for more info

Author of the program. Can be specified multiple times.

Link to project's homepage

Format of the generated man page. Defaults to 'pretty'.

Output file. Defaults to stdout.

Section of the manual, by default 1. See man (7) man-pages for more info about existing sections.

The title of the manual, by default "Generated Python Manual". See man (7) man-pages for more instructions.

File that contains extra material for the man page.

File containing a complete man page.

Gabriele Giammatteo <gabriele.giammatteo@eng.it>

The latest version of argparse-manpage may be downloaded from https://github.com/praiskup/argparse-manpage

2025-07-03 argparse-manpage 4.6

Search for    or go to Top of page |  Section 1 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.