aboutsummaryrefslogtreecommitdiff
path: root/bin/clamp
diff options
context:
space:
mode:
authorEuAndreh <eu@euandre.org>2023-04-12 08:15:20 -0300
committerEuAndreh <eu@euandre.org>2023-04-12 08:15:20 -0300
commitc6188975d2da6c1696c4433f6fce8ae4c9a6ac38 (patch)
tree613545634bc999385d13ecb107d2cce113ba11c4 /bin/clamp
parentbin/: Add trailing semicolor to Perl heredocs (diff)
downloaddotfiles-c6188975d2da6c1696c4433f6fce8ae4c9a6ac38.tar.gz
dotfiles-c6188975d2da6c1696c4433f6fce8ae4c9a6ac38.tar.xz
bin/: Make help string more consistent across several executables
Diffstat (limited to 'bin/clamp')
-rwxr-xr-xbin/clamp7
1 files changed, 7 insertions, 0 deletions
diff --git a/bin/clamp b/bin/clamp
index fab6967..a2c8bee 100755
--- a/bin/clamp
+++ b/bin/clamp
@@ -12,9 +12,14 @@ usage() {
help() {
cat <<-'EOF'
+
Options:
-h, --help show this message
+ NUMBER the number to be clamped
+ MIN lower bound
+ MAX upper bound
+
Clamp the NUMBER between MIN and MAX.
@@ -26,11 +31,13 @@ help() {
$ clamp 5 3 9
5
+
When a number is below MIN it gets clamped:
$ clamp 1 3 9
3
+
When a number is above MAX it gets clamped:
$ clamp 15 3 9