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

# [NAME](#NAME)

argparse-manpage

# [SYNOPSIS](#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]

# [DESCRIPTION](#DESCRIPTION)

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

# [OPTIONS](#OPTIONS)

[**--module** *MODULE*](#module)

search the OBJECT/FUNCTION in MODULE

[**--pyfile** *PYFILE*](#pyfile)

search the OBJECT/FUNCTION in FILE

[**--function** *FUNCTION*](#function)

call FUNCTION from MODULE/FILE to obtain ArgumentParser object

[**--object** *OBJECT*](#object)

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

[**--project-name** *PROJECT\_NAME*](#project)

Name of the project the documented program is part of.

[**--prog** *PROG*](#prog)

Substitutes %prog in ArgumentParser's usage.

[**--version** *VERSION*](#version)

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

[**--description** *TEXT*](#description)

description of the program, used in the NAME section, after the leading 'name - ' part, see [man (7)](/man/enterprise-packages/py3-argcomplete-manpage/man.7) man-pages for more info

[**--author** *\[AUTHOR\]*](#author)

Author of the program. Can be specified multiple times.

[**--url** *URL*](#url)

Link to project's homepage

[**--format** *{pretty,single-commands-section}*](#format)

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

[**--output** *OUTFILE*](#output)

Output file. Defaults to stdout.

[**--manual-section** *MANUAL\_SECTION*](#manual)

Section of the manual, by default 1. See [man (7)](/man/enterprise-packages/py3-argcomplete-manpage/man.7) man-pages for more info about existing sections.

[**--manual-title** *MANUAL\_TITLE*](#manual~2)

The title of the manual, by default "Generated Python Manual". See [man (7)](/man/enterprise-packages/py3-argcomplete-manpage/man.7) man-pages for more instructions.

[**--include** *FILE*](#include)

File that contains extra material for the man page.

[**--manfile** *FILE*](#manfile)

File containing a complete man page.

# [AUTHOR](#AUTHOR)

```
Gabriele Giammatteo <gabriele.giammatteo@eng.it>
```

# [DISTRIBUTION](#DISTRIBUTION)

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

1980-01-01 argparse-manpage 4.8

---

Document: argparse-manpage(1) from py3-argcomplete-manpage 4.8-r0 (Chainguard OS)
Source: https://github.com/praiskup/argparse-manpage.git