1ARGPARSE-MANPAGE(1) Generated Python Manual ARGPARSE-MANPAGE(1)
2
3
4
6 argparse-manpage
7
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]
14
16 Build manual page from Python's argparse.ArgumentParser object.
17
18
20 --module MODULE
21 search the OBJECT/FUNCTION in MODULE
22
23
24 --pyfile PYFILE
25 search the OBJECT/FUNCTION in FILE
26
27
28 --function FUNCTION
29 call FUNCTION from MODULE/FILE to obtain ArgumentParser object
30
31
32 --object OBJECT
33 obtain ArgumentParser OBJECT from FUNCTION (to get argparse ob‐
34 ject) from MODULE or FILE
35
36
37 --project-name PROJECT_NAME
38 Name of the project the documented program is part of.
39
40
41 --prog PROG
42 Substitutes %prog in ArgumentParser's usage.
43
44
45 --version VERSION
46 Version of the program, will be visible in the manual page
47 footer.
48
49
50 --description TEXT
51 description of the program, used in the NAME section, after the
52 leading 'name - ' part, see man (7) man-pages for more info
53
54
55 --author [AUTHOR]
56 Author of the program. Can be specified multiple times.
57
58
59 --url URL
60 Link to project's homepage
61
62
63 --format {pretty,single-commands-section}
64 Format of the generated man page. Defaults to 'pretty'.
65
66
67 --output OUTFILE
68 Output file. Defaults to stdout.
69
70
71 --manual-section MANUAL_SECTION
72 Section of the manual, by default 1. See man (7) man-pages for
73 more info about existing sections.
74
75
76 --manual-title MANUAL_TITLE
77 The title of the manual, by default "Generated Python Manual".
78 See man (7) man-pages for more instructions.
79
80
82 Gabriele Giammatteo <gabriele.giammatteo@eng.it>
83
84
86 The latest version of argparse-manpage may be downloaded from
87 ⟨https://github.com/praiskup/argparse-manpage⟩
88
89
90
91argparse-manpage 4 2022-10-31 ARGPARSE-MANPAGE(1)