aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Ogier <[email protected]>2012-05-09 14:15:59 -0400
committerAlex Ogier <[email protected]>2012-05-09 14:15:59 -0400
commit29188b4c3e68fce705b1ca2660ba5a0cf7ab3b99 (patch)
tree8ddf99763e63e4e26ed22f52feec19e8073a5c80
parentfd456b3a45afd5b9eb9204556d5b2d5ab809b90f (diff)
New section heading for command-line usage
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index b43b0dc..2decdf8 100644
--- a/README.md
+++ b/README.md
@@ -98,9 +98,16 @@ flag.VarP(&flagVar, "varname", "v", 1234, "help message")
Shorthand letters can be used with single dashes on the command line.
Boolean shorthand flags can be combined with other shorthand flags.
-Command line flag syntax:
+The default set of command-line flags is controlled by
+top-level functions. The FlagSet type allows one to define
+independent sets of flags, such as to implement subcommands
+in a command-line interface. The methods of FlagSet are
+analogous to the top-level functions for the command-line
+flag set.
-``` go
+## Command line flag syntax
+
+```
--flag // boolean flags only
--flag=x
--flag x // non-boolean flags only
@@ -109,7 +116,7 @@ Command line flag syntax:
The last form is not permitted for boolean flags because the
meaning of the command
-``` go
+```
cmd --flag *
```
@@ -120,7 +127,7 @@ Unlike the flag package, a single dash before an option means something
different than a double dash. Single dashes signify a series of shorthand
letters for flags. All but the last shorthand letter must be boolean flags.
-``` go
+```
-f // f must be boolean
-abc // all flags must be boolean
-abcn=1234
@@ -137,13 +144,6 @@ Integer flags accept 1234, 0664, 0x1234 and may be negative.
Boolean flags may be 1, 0, t, f, true, false, TRUE, FALSE, True, False.
Duration flags accept any input valid for time.ParseDuration.
-The default set of command-line flags is controlled by
-top-level functions. The FlagSet type allows one to define
-independent sets of flags, such as to implement subcommands
-in a command-line interface. The methods of FlagSet are
-analogous to the top-level functions for the command-line
-flag set.
-
## More info
You can get a full reference of the pflag package through go's standard