1ARGBASH(1)                                                          ARGBASH(1)
2
3
4

NAME

6       argbash - Argbash is an argument parser generator for Bash.
7

SYNOPSIS

9       argbash   [--output  OUTPUT]  [--in-place]  [--type  type]  [--library]
10       [--strip content] [--check-typos]  [--commented]  [--search  SEARCH]...
11       [--debug DEBUG] [--help] [--version] <input>
12

DESCRIPTION

14       Argbash  is  a  code  generator  that  typically generates a bash argu‐
15       ment-parsing library tailor-made for your script.  It lets you  to  de‐
16       scribe arguments your script should take and then, you can generate the
17       bash parsing code.  It stays in your script by  default,  but  you  can
18       have it generated to a separate file and let bash to include it in your
19       script for you.  Argbash is very simple to use and the  generated  code
20       is relatively nice to read.  Moreover, argument definitions stay embed‐
21       ded in the script, so when you need to update the  parsing  logic,  you
22       just re-run the argbash script on the already generated script.
23

ARGUMENTS

25       -o OUTPUT, --output OUTPUT
26              Name of the output file (pass '-' for stdout).  [Default: -]
27
28
29
30       -i, --in-place
31              Update a bash script in-place.  [Default: off]
32
33
34              |OPTION_IN_PLACE|
35
36
37       -t     bash-script|posix-script|manpage|manpage-defs|completion|docopt,
38       --type  bash-script|posix-script|manpage|manpage-defs|completion|docopt
39       Output type to generate.
40              [Default: bash-script]
41
42              Check out the documentation to learn about all argbash capabili‐
43              ties that are supported.
44
45       --library
46              Whether the input file if the pure parsing  library.   [Default:
47              off]
48
49              This  option  is  deprecated  and  it  is  the  same  as --strip
50              user-content.
51
52       --strip none|user-content|all Determines what to have in the output.
53              [Default: none]
54
55              You can either strip none, which is useful for scripts.  If  you
56              strip  user-content,  you keep the Argbash header.  If you strip
57              all, you will have only the generated content in the result.
58
59       --check-typos
60              Whether to check for possible argbash  macro  typos.   [Default:
61              on]
62
63
64
65       -c, --commented
66              Commented  mode  - include explanatory comments with the parsing
67              code.  [Default: off]
68
69
70
71       -I SEARCH, --search SEARCH
72              Directories to search for the wrapped scripts (directory of  the
73              template will be added to the end of the list).  [Default: "."]
74
75
76
77       --debug DEBUG
78              (developer option) Tell autom4te to trace a macro.
79
80
81
82       -h, --help
83              Prints help.
84
85
86
87       -v, --version
88              Prints version.
89
90
91

DOCUTILS SYSTEM MESSAGES

93       System Message: ERROR/3 (argbash.rst:, line 42)
94              Undefined substitution referenced: "OPTION_IN_PLACE".
95

AUTHOR

97       Matěj Týč
98
99
100
101
102argbash 2.10.0                    2023-07-19                        ARGBASH(1)