Skip to content

Commit 770fc9e

Browse files
committed
Added the supported formats to the README
1 parent 7f0dc09 commit 770fc9e

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,36 @@
1-
# BASH Argument Parser
1+
# BASH Argument Parser
2+
3+
Takes arguments passed in nearly any format to a bash script and allows easy access to them and their values
4+
5+
## Supported Argument Formats
6+
7+
### Short Form
8+
9+
```bash
10+
-a
11+
-X
12+
-b somevalue
13+
-c 38
14+
-d "some value with spaces"
15+
-e "some value with
16+
newlines"
17+
```
18+
19+
### Long Form
20+
21+
```bash
22+
--debug
23+
--test mode0
24+
--test "all the code"
25+
--Case-Sensitive true
26+
--long-parameter
27+
--newline "
28+
"
29+
```
30+
31+
### Chained Short Form Arguments
32+
33+
```bash
34+
-aih # Equivalent to -a -i -h
35+
-dav 4 # Equivalent to -d -a -v 4
36+
```

0 commit comments

Comments
 (0)