1ARGPARSE-MANPAGE(1)         General Commands 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]  [--long-description  TEXT]
12       [--author [AUTHOR]] [--url URL] [--format  {pretty,single-commands-sec‐
13       tion}] [--output OUTFILE]
14

DESCRIPTION

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

OPTIONS

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.
47
48
49       --description TEXT
50              Description of the program.
51
52
53       --long-description TEXT
54              Extended description of the program.
55
56
57       --author [AUTHOR]
58              Author of the program. Can be specified multiple times.
59
60
61       --url URL
62              Link to project's homepage
63
64
65       --format {pretty,single-commands-section}
66              Format of the generated man page. Defaults to 'pretty'.
67
68
69       --output OUTFILE
70              Output file. Defaults to stdout.
71
72

AUTHORS

74       Gabriele Giammatteo <gabriele.giammatteo@eng.it>
75
76

DISTRIBUTION

78       The  latest  version  of  argparse-manpage  may  be   downloaded   from
79       ⟨https://github.com/praiskup/argparse-manpage⟩
80
81
82
83                                    Manual                 ARGPARSE-MANPAGE(1)