.TH ARGPARSE\-MANPAGE "1" "2024\-02\-15" "argparse\-manpage 4.5" "Generated Python Manual"
.SH NAME
argparse\-manpage
.SH SYNOPSIS
.B 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]
.SH DESCRIPTION
Build manual page from Python's argparse.ArgumentParser object.

.SH OPTIONS
.TP
\fB\-\-module\fR \fI\,MODULE\/\fR
search the OBJECT/FUNCTION in MODULE

.TP
\fB\-\-pyfile\fR \fI\,PYFILE\/\fR
search the OBJECT/FUNCTION in FILE

.TP
\fB\-\-function\fR \fI\,FUNCTION\/\fR
call FUNCTION from MODULE/FILE to obtain ArgumentParser object

.TP
\fB\-\-object\fR \fI\,OBJECT\/\fR
obtain ArgumentParser OBJECT from FUNCTION (to get argparse object) from
MODULE or FILE

.TP
\fB\-\-project\-name\fR \fI\,PROJECT_NAME\/\fR
Name of the project the documented program is part of.

.TP
\fB\-\-prog\fR \fI\,PROG\/\fR
Substitutes %prog in ArgumentParser's usage.

.TP
\fB\-\-version\fR \fI\,VERSION\/\fR
Version of the program, will be visible in the manual page footer.

.TP
\fB\-\-description\fR \fI\,TEXT\/\fR
description of the program, used in the NAME section, after the leading 'name
\- ' part, see man (7) man\-pages for more info

.TP
\fB\-\-author\fR \fI\,[AUTHOR]\/\fR
Author of the program. Can be specified multiple times.

.TP
\fB\-\-url\fR \fI\,URL\/\fR
Link to project's homepage

.TP
\fB\-\-format\fR \fI\,{pretty,single\-commands\-section}\/\fR
Format of the generated man page. Defaults to 'pretty'.

.TP
\fB\-\-output\fR \fI\,OUTFILE\/\fR
Output file. Defaults to stdout.

.TP
\fB\-\-manual\-section\fR \fI\,MANUAL_SECTION\/\fR
Section of the manual, by default 1. See man (7) man\-pages for more info about
existing sections.

.TP
\fB\-\-manual\-title\fR \fI\,MANUAL_TITLE\/\fR
The title of the manual, by default "Generated Python Manual". See man (7)
man\-pages for more instructions.

.TP
\fB\-\-include\fR \fI\,FILE\/\fR
File that contains extra material for the man page.

.TP
\fB\-\-manfile\fR \fI\,FILE\/\fR
File containing a complete man page.

.SH AUTHOR
.nf
Gabriele Giammatteo <gabriele.giammatteo@eng.it>
.fi

.SH DISTRIBUTION
The latest version of argparse\-manpage may be downloaded from
.UR https://github.com/praiskup/argparse\-manpage
.UE