From 69eca0eb16ce5a76301de4df87208bddcdb7c69d Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Thu, 14 Feb 2019 19:43:39 -0800 Subject: [PATCH] Edited for clarity --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3625372..55ea1af 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ cd $path && curl -O example.com/file.zip ``` ## Usage -`arg -f ...`, `arg -flag ...`, or `arg --flag ...`. If `arg` finds the -given flag among the rest of the command line arguments, it will print -the flag's value (if any) and exit successfully, otherwise, it will -fail (exit status 1). The value may be of the form `--flag=value`, -`--flag value`, `-f value`. Single-letter flags will match when grouped -with other single letter flags, but will not have a value, i.e. -`arg -b -abc foo` will exit successfully without printing anything. -When using `arg` in a shell script, it is best to use quotes around `$@`, -as in `arg --foo "$@"`, so arguments with spaces will parse properly, -like `my_script.sh --flag "one two"`. +The following forms are accepted: `arg -f ...`, `arg -flag ...`, or `arg --flag +...`. If `arg` finds the first given flag among the rest of the command line +arguments, it will print the flag's value (if any) and exit successfully, +otherwise, it will fail (exit status 1). The value may be of the form +`--flag=value`, `--flag value`, `-f value`, or `-f=value`. Single-letter flags +will match when grouped with other single letter flags, but will not have a +value, i.e. `arg -b -abc foo` will exit successfully without printing anything. +When using `arg` in a shell script, it is best to use quotes around `$@`, as in +`arg --foo "$@"`, so arguments with spaces will parse properly, like +`my_script.sh --flag "one two"`.