flag

Documentation

Index

• func InitFlags(flags *pflag.FlagSet)
• func PrintFlags(flags *pflag.FlagSet)
• func PrintSections(w io.Writer, fss NamedFlagSets, cols int)
• func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
• func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
• type NamedFlagSets
  • func (nfs *NamedFlagSets) FlagSet(name string) *pflag.FlagSet

Functions

func InitFlags

func InitFlags(flags *pflag.FlagSet)

InitFlags normalizes, parses, then logs the command line flags.

func PrintFlags

func PrintFlags(flags *pflag.FlagSet)

PrintFlags logs the flags in the flagset.

func PrintSections

func PrintSections(w io.Writer, fss NamedFlagSets, cols int)

PrintSections prints the given names flag sets in sections, with the maximal given column number. If cols is zero, lines are not wrapped.

func WarnWordSepNormalizeFunc

func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

WarnWordSepNormalizeFunc changes and warns for flags that contain "_" separators.

func WordSepNormalizeFunc

func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

WordSepNormalizeFunc changes all flags that contain "_" separators.

Types

type NamedFlagSets

type NamedFlagSets struct {
	// Order is an ordered list of flag set names.
	Order []string
	// FlagSets stores the flag sets by name.
	FlagSets map[string]*pflag.FlagSet
}

NamedFlagSets stores named flag sets in the order of calling FlagSet.

func (*NamedFlagSets) FlagSet

func (nfs *NamedFlagSets) FlagSet(name string) *pflag.FlagSet

FlagSet returns the flag set with the given name and adds it to the ordered name list if it is not in there yet.