Documentation

Supported features

Definition via structure field tag

Example

Flags

package flagimport"fmt"typeTarstruct {GZbool`names:"-z, --gz" usage:"gzip format"`BZbool`names:"-j, --bz" usage:"bzip2 format"`XZbool`names:"-J, --xz" usage:"xz format"`Createbool`names:"-c" usage:"create tar file"`Extractbool`names:"-x" usage:"extract tar file"`Filestring`names:"-f" usage:"output file for create or input file for extract"`Directorystring`names:"-C" usage:"extract directory"`SourceFiles []string`args:"true"`}func (t*Tar)Metadata()map[string]Flag {const (usage="tar is a tool for manipulate tape archives."version=`version: v1.0.0commit: 10adf10dc10date:   2017-01-01 10:00:01`desc=`tar creates and manipulates streaming archive files.  This implementation can extractfrom tar, pax, cpio, zip, jar, ar, and ISO 9660 cdrom images and can create tar, pax,cpio, ar, and shar archives.`)returnmap[string]Flag{"": {Usage:usage,Version:version,Desc:desc,},"--gz": {Desc:"use gzip format",},}}funcExampleFlagSet_ParseStruct() {vartarTarNewFlagSet(Flag{}).ParseStruct(&tar,"tar","-zcf","a.tgz","a.go","b.go")fmt.Println(tar.GZ)fmt.Println(tar.Create)fmt.Println(tar.File)fmt.Println(tar.SourceFiles)// Output:// true// true// a.tgz// [a.go b.go]}

Help message

tar is a tool for manipulate tape archives.Usage:      flag.test [FLAG]...Version:      version: v1.0.0      commit: 10adf10dc10      date:   2017-01-01 10:00:01Description:      tar creates and manipulates streaming archive files.  This implementation can extract      from tar, pax, cpio, zip, jar, ar, and ISO 9660 cdrom images and can create tar, pax,      cpio, ar, and shar archives.Flags:      -z, --gz     gzip format (bool)            use gzip format      -j, --bz     bzip2 format (bool)      -J, --xz     xz format (bool)      -c           create tar file (bool)      -x           extract tar file (bool)      -f           output file for create or input file for extract (string)      -C           extract directory (string)

FlagSet

typeGoCmdstruct {Buildstruct {EnableboolAlreadybool`names:"-a" important:"1" desc:"force rebuilding of packages that are already up-to-date."`Racebool`important:"1" desc:"enable data race detection.\nSupported only on linux/amd64, freebsd/amd64, darwin/amd64 and windows/amd64."`Outputstring`names:"-o" arglist:"output" important:"1" desc:"only allowed when compiling a single package"`LdFlagsstring`names:"-ldflags" arglist:"'flag list'" desc:"arguments to pass on each go tool link invocation."`Packages []string`args:"true"`}`usage:"compile packages and dependencies"`Cleanstruct {Enablebool}`usage:"remove object files"`Docstruct {Enablebool}`usage:"show documentation for package or symbol"`Envstruct {Enablebool}`usage:"print Go environment information"`Bugstruct {Enablebool}`usage:"start a bug report"`Fixstruct {Enablebool}`usage:"run go tool fix on packages"`Fmtstruct {Enablebool}`usage:"run gofmt on package sources"`}func (*GoCmd)Metadata()map[string]Flag {returnmap[string]Flag{"": {Usage:"Go is a tool for managing Go source code.",Arglist:"command [argument]",},"build": {Arglist:"[-o output] [-i] [build flags] [packages]",Desc:`Build compiles the packages named by the import paths,along with their dependencies, but it does not install the results....The build flags are shared by the build, clean, get, install, list, run,and test commands:`,},}}funcTestSubset(t*testing.T) {vargGoCmdset:=NewFlagSet(Flag{})set.StructFlags(&g)set.Help(false)fmt.Println()build,_:=set.FindSubset("build")build.Help(false)}

Go is a tool for managing Go source code.Usage:      flag.test command [argument]Sets:      build        compile packages and dependencies      clean        remove object files      doc          show documentation for package or symbol      env          print Go environment information      bug          start a bug report      fix          run go tool fix on packages      fmt          run gofmt on package sources

compile packages and dependenciesUsage:      build [-o output] [-i] [build flags] [packages]Description:      Build compiles the packages named by the import paths,      along with their dependencies, but it does not install the results.      ...      The build flags are shared by the build, clean, get, install, list, run,      and test commands:Flags:      -a                              force rebuilding of packages that are already up-to-date.      -race                           enable data race detection.            Supported only on linux/amd64, freebsd/amd64, darwin/amd64 and windows/amd64.      -o output                       only allowed when compiling a single package      -ldflags 'flag list'            arguments to pass on each go tool link invocation.

LICENSE