1ARGPARSE-MANPAGE(1)         Generated Python Manual        ARGPARSE-MANPAGE(1)
2
3
4

NAME

6       argparse-manpage
7

SYNOPSIS

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

DESCRIPTION

17       Build manual page from Python's argparse.ArgumentParser object.
18
19

OPTIONS

21       --module MODULE
22              search the OBJECT/FUNCTION in MODULE
23
24
25       --pyfile PYFILE
26              search the OBJECT/FUNCTION in FILE
27
28
29       --function FUNCTION
30              call FUNCTION from MODULE/FILE to obtain ArgumentParser object
31
32
33       --object OBJECT
34              obtain ArgumentParser OBJECT from FUNCTION (to get argparse  ob‐
35              ject) from MODULE or FILE
36
37
38       --project-name PROJECT_NAME
39              Name of the project the documented program is part of.
40
41
42       --prog PROG
43              Substitutes %prog in ArgumentParser's usage.
44
45
46       --version VERSION
47              Version  of  the  program,  will  be  visible in the manual page
48              footer.
49
50
51       --description TEXT
52              description of the program, used in the NAME section, after  the
53              leading 'name - ' part, see man (7) man-pages for more info
54
55
56       --author [AUTHOR]
57              Author of the program. Can be specified multiple times.
58
59
60       --url URL
61              Link to project's homepage
62
63
64       --format {pretty,single-commands-section}
65              Format of the generated man page. Defaults to 'pretty'.
66
67
68       --output OUTFILE
69              Output file. Defaults to stdout.
70
71
72       --manual-section MANUAL_SECTION
73              Section  of  the manual, by default 1. See man (7) man-pages for
74              more info about existing sections.
75
76
77       --manual-title MANUAL_TITLE
78              The title of the manual, by default "Generated  Python  Manual".
79              See man (7) man-pages for more instructions.
80
81
82       --include FILE
83              File that contains extra material for the man page.
84
85
86       --manfile FILE
87              File containing a complete man page.
88
89

AUTHOR

91       Gabriele Giammatteo <gabriele.giammatteo@eng.it>
92
93

DISTRIBUTION

95       The   latest   version  of  argparse-manpage  may  be  downloaded  from
96       ⟨https://github.com/praiskup/argparse-manpage⟩
97
98
99
100argparse-manpage 4.5              2023-09-22               ARGPARSE-MANPAGE(1)
Impressum