.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ARGBASH" 1 "2023-08-09" "argbash 2.10.0"
.SH NAME
argbash \- Argbash is an argument parser generator for Bash.
.SH SYNOPSIS
.sp
\fBargbash  [\-\-output OUTPUT] [\-\-in\-place] [\-\-type type] [\-\-library] [\-\-strip content] [\-\-check\-typos] [\-\-commented] [\-\-search SEARCH]... [\-\-debug DEBUG] [\-\-help] [\-\-version] <input>\fP
.SH DESCRIPTION
.sp
Argbash is a code generator that typically generates a bash argument\-parsing library tailor\-made for your script.
It lets you to describe arguments your script should take and then, you can generate the \fBbash\fP parsing code.
It stays in your script by default, but you can have it generated to a separate file and let \fBbash\fP to include it in your script for you.
\fBArgbash\fP is very simple to use and the generated code is relatively nice to read.
Moreover, argument definitions stay embedded in the script, so when you need to update the parsing logic, you just re\-run the \fBargbash\fP script on the already generated script.
.SH ARGUMENTS
.INDENT 0.0
.TP
.BI \-o \ OUTPUT\fR,\fB \ \-\-output \ OUTPUT
Name of the output file (pass \(aq\-\(aq for stdout).
[Default: \-]
.sp

.TP
.B  \-i\fP,\fB  \-\-in\-place
Update a bash script in\-place.
[Default: off]
.sp

.nf
|OPTION_IN_PLACE|
.fi

.UNINDENT
.INDENT 0.0
.TP
.B \-t bash\-script|posix\-script|manpage|manpage\-defs|completion|docopt, \-\-type bash\-script|posix\-script|manpage|manpage\-defs|completion|docopt  Output type to generate.
[Default: bash\-script]
.sp
Check out the documentation to learn about all argbash capabilities that are supported.
.UNINDENT
.INDENT 0.0
.TP
.B  \-\-library
Whether the input file if the pure parsing library.
[Default: off]
.sp
This option is deprecated and it is the same as \fB\-\-strip user\-content\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-strip none|user\-content|all                                                                                                               Determines what to have in the output.
[Default: none]
.sp
You can either strip \fBnone\fP, which is useful for scripts.
If you strip \fBuser\-content\fP, you keep the Argbash header.
If you strip \fBall\fP, you will have only the generated content in the result.
.UNINDENT
.INDENT 0.0
.TP
.B  \-\-check\-typos
Whether to check for possible argbash macro typos.
[Default: on]
.sp

.TP
.B  \-c\fP,\fB  \-\-commented
Commented mode \- include explanatory comments with the parsing code.
[Default: off]
.sp

.TP
.BI \-I \ SEARCH\fR,\fB \ \-\-search \ SEARCH
Directories to search for the wrapped scripts (directory of the template will be added to the end of the list).
[Default: \(dq.\(dq]
.sp

.TP
.BI \-\-debug \ DEBUG
(developer option) Tell autom4te to trace a macro.
.sp

.TP
.B  \-h\fP,\fB  \-\-help
Prints help.
.sp

.TP
.B  \-v\fP,\fB  \-\-version
Prints version.
.sp

.UNINDENT
.SH DOCUTILS SYSTEM MESSAGES
.IP "System Message: ERROR/3 (argbash.rst:, line 42)"
Undefined substitution referenced: \(dqOPTION_IN_PLACE\(dq.
.SH AUTHOR
Matěj Týč
.\" Generated by docutils manpage writer.
.