aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Tim Segers <tsegers@pm.me>2022-10-11 18:08:18 +0200
committerGravatar Tim Segers <tsegers@pm.me>2022-10-11 18:13:15 +0200
commite2a4e48252ef051f99da0f2e7a0c1fa0ee00c5ea (patch)
tree9deac67f6031cef232205fca1b9eb778fb92e407 /README.md
parent70ea0d58f937c4493bdcbacd59d4f7bf18792352 (diff)
downloadopendeco-e2a4e48252ef051f99da0f2e7a0c1fa0ee00c5ea.tar.gz
Add section headers to --help outputv0.3
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 19 insertions, 4 deletions
diff --git a/README.md b/README.md
index a04b1a6..76f1a8c 100644
--- a/README.md
+++ b/README.md
@@ -2,18 +2,33 @@
[![builds.sr.ht status](https://builds.sr.ht/~tsegers/opendeco/commits/main.svg)](https://builds.sr.ht/~tsegers/opendeco/commits/main?)
-```Usage: opendeco [OPTION...]
+```
+Usage: opendeco [OPTION...]
Implementation of Buhlmann ZH-L16 with Gradient Factors:
+ Dive options:
-d, --depth=NUMBER Set the depth of the dive in meters
-t, --time=NUMBER Set the time of the dive in minutes
+
-g, --gas=STRING Set the bottom gas used during the dive, defaults
to Air
+
+ -p, --pressure=NUMBER Set the surface air pressure, defaults to
+ 1.01325bar or 1atm
+
+ Deco options:
-l, --gflow=NUMBER Set the gradient factor at the first stop,
defaults to 30
+
-h, --gfhigh=NUMBER Set the gradient factor at the surface, defaults
to 75
+
-G, --decogasses=LIST Set the gasses available for deco
+
+ -s Only switch gas at deco stops
+
+ Informational options:
+
-?, --help Give this help list
--usage Give a short usage message
-V, --version Print program version
@@ -23,9 +38,9 @@ for any corresponding short options.
Examples:
- ./opendeco -d 18 -t 60 -g Air
- ./opendeco -d 30 -t 60 -g EAN32
- ./opendeco -d 40 -t 120 -g 21/35 -l 20 -h 80 --decogasses Oxygen,EAN50
+ ./opendeco -d 18 -t 60 -g Air
+ ./opendeco -d 30 -t 60 -g EAN32
+ ./opendeco -d 40 -t 120 -g 21/35 -l 20 -h 80 --decogasses Oxygen,EAN50
Report bugs to <~tsegers/opendeco@lists.sr.ht> or
https://todo.sr.ht/~tsegers/opendeco.