verflag

Documentation

Overview

Package verflag defines utility functions to handle command line flags related to version.

Index

• Constants
• func AddFlags(fs *flag.FlagSet)
• func PrintAndExitIfRequested()
• func Version(name string, value versionValue, usage string) *versionValue
• func VersionVar(p *versionValue, name string, value versionValue, usage string)

Constants

const (
	VersionFalse versionValue = 0
	VersionTrue  versionValue = 1
	VersionRaw   versionValue = 2
)

Functions

func AddFlags

func AddFlags(fs *flag.FlagSet)

AddFlags registers this package's flags on arbitrary FlagSets, such that they point to the same value as the global flags.

func PrintAndExitIfRequested

func PrintAndExitIfRequested()

PrintAndExitIfRequested will check if the -version flag was passed and, if so, print the version and exit.

func Version

func Version(name string, value versionValue, usage string) *versionValue

func VersionVar

func VersionVar(p *versionValue, name string, value versionValue, usage string)