aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2023-11-30 01:22:02 +0100
committerThomas Voss <mail@thomasvoss.com> 2023-11-30 01:22:02 +0100
commit625187cf19df20917f83f51fc9fbbc95d7842dd2 (patch)
tree817249a977fe1fb489894f2530fdf6e598c441de /README.md
parentbc291f2bc1f256dc396b687c39bf8f349be016c3 (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md108
1 files changed, 79 insertions, 29 deletions
diff --git a/README.md b/README.md
index 44b4904..f2916ba 100644
--- a/README.md
+++ b/README.md
@@ -5,49 +5,99 @@ getopt_long(3) flag parsing in Go. For details, check out the godoc
documentation.
Note that unlike the `getopt()` C function, the ‘:’ and ‘?’ flags are not
-returned on errors — the errors are instead returned via the `err` return value
-of `opts.Get()` and `opts.GetLong()`. Additionally, a leading ‘:’ in the
-opt-string provided to `opts.Get()` is not supported; you are responsible for
-your own I/O.
+returned on errors — the errors are instead returned via the `err` return
+value of `opts.Get()` and `opts.GetLong()`. Additionally, a leading ‘:’
+in the opt-string provided to `opts.Get()` is not supported; you are
+responsible for your own I/O.
## Example Usage
-The following demonstrates an example usage of the `opts.Get()` function:
+The following demonstrates an example usage of the `opts.Get()` function…
```go
package main
import (
- "fmt"
- "os"
+ "fmt"
+ "os"
- "git.sr.ht/~mango/opts"
+ "git.sr.ht/~mango/opts"
)
func usage() {
- fmt.Fprintf(os.Stderr, "Usage: %s [-ßλ] [-a arg]\n", os.Args[0])
- os.Exit(1)
+ fmt.Fprintf(os.Stderr, "Usage: %s [-ßλ] [-a arg]\n", os.Args[0])
+ os.Exit(1)
}
func main() {
- flags, optind, err := opts.Get(os.Args, "a:ßλ")
- if err != nil {
- fmt.Fprintf(os.Stderr, "%s: %s\n", os.Args[0], err)
- usage()
- }
-
- for _, opt := range opts {
- switch opt.Key {
- case 'a':
- fmt.Println("-a given with argument", opt.Value)
- case 'ß':
- fmt.Println("-ß given")
- case 'λ':
- fmt.Println("-λ given")
- }
- }
-
- // The remaining arguments
- rest := os.Args[optind:]
+ flags, optind, err := opts.Get(os.Args, "a:ßλ")
+ if err != nil {
+ fmt.Fprintf(os.Stderr, "%s: %s\n", os.Args[0], err)
+ usage()
+ }
+
+ for _, opt := range opts {
+ switch opt.Key {
+ case 'a':
+ fmt.Println("-a given with argument", opt.Value)
+ case 'ß':
+ fmt.Println("-ß given")
+ case 'λ':
+ fmt.Println("-λ given")
+ }
+ }
+
+ // The remaining arguments
+ rest := os.Args[optind:]
+}
+```
+
+…and the following demonstrates an example usage of the `opts.GetLong()`
+function:
+
+```go
+package main
+
+import (
+ "fmt"
+ "os"
+
+ "git.sr.ht/~mango/opts"
+)
+
+const noShortFlag = -1
+
+func usage() {
+ fmt.Fprintf(os.Stderr, "Usage: %s [-ßλ] [-a arg] [--no-short]\n", os.Args[0])
+ os.Exit(1)
+}
+
+func main() {
+ flags, optind, err := opts.GetLong(os.Args, []opts.LongOpt{
+ {Short: 'a', Long: "add", Arg: Required},
+ {Short: 'ß', Long: "sheiße", Arg: None},
+ {Short: 'λ', Long: "λεωνίδας", Arg: None},
+ {Short: noShortFlag, Long: "no-short", Arg: None},
+ })
+ if err != nil {
+ fmt.Fprintf(os.Stderr, "%s: %s\n", os.Args[0], err)
+ usage()
+ }
+
+ for _, opt := range opts {
+ switch opt.Key {
+ case 'a':
+ fmt.Println("-a or --add given with argument", opt.Value)
+ case 'ß':
+ fmt.Println("-ß or --sheiße given")
+ case 'λ':
+ fmt.Println("-λ or --λεωνίδας given")
+ case noShortFlag:
+ fmt.Println("--no-short given")
+ }
+ }
+
+ // The remaining arguments
+ rest := os.Args[optind:]
}
```