go-sockaddr: github.com/hashicorp/go-sockaddr/cmd/sockaddr/command Index | Files

package command

import "github.com/hashicorp/go-sockaddr/cmd/sockaddr/command"

Index

Package Files

autohelp.go dump.go eval.go multi_arg.go rfc.go rfc_list.go tech_support.go version.go

func MakeHelp Uses

func MakeHelp(c AutoHelp) string

MakeHelp generates a help string based on the capabilities of the Command

func OptionsHelpOutput Uses

func OptionsHelpOutput(flags []*flag.Flag) string

OptionsHelpOutput returns a string of formatted options

type AutoHelp Uses

type AutoHelp interface {
    Usage() string
    Description() string
    InitOpts()
    VisitAllFlags(func(f *flag.Flag))
}

AutoHelp specifies the necessary methods required to have their help completely generated for them.

type ByName Uses

type ByName []*flag.Flag

ByOptName implements sort.Interface for flag.Flag based on the Name field.

func (ByName) Len Uses

func (a ByName) Len() int

func (ByName) Less Uses

func (a ByName) Less(i, j int) bool

func (ByName) Swap Uses

func (a ByName) Swap(i, j int)

type DumpCommand Uses

type DumpCommand struct {
    Ui cli.Ui
    // contains filtered or unexported fields
}

func (*DumpCommand) Description Uses

func (c *DumpCommand) Description() string

Description is the long-form command help.

func (*DumpCommand) Help Uses

func (c *DumpCommand) Help() string

Help returns the full help output expected by `sockaddr -h cmd`

func (*DumpCommand) InitOpts Uses

func (c *DumpCommand) InitOpts()

InitOpts is responsible for setup of this command's configuration via the command line. InitOpts() does not parse the arguments (see parseOpts()).

func (*DumpCommand) Run Uses

func (c *DumpCommand) Run(args []string) int

Run executes this command.

func (*DumpCommand) Synopsis Uses

func (c *DumpCommand) Synopsis() string

Synopsis returns a terse description used when listing sub-commands.

func (*DumpCommand) Usage Uses

func (c *DumpCommand) Usage() string

Usage is the one-line usage description

func (*DumpCommand) VisitAllFlags Uses

func (c *DumpCommand) VisitAllFlags(fn func(*flag.Flag))

VisitAllFlags forwards the visitor function to the FlagSet

type EvalCommand Uses

type EvalCommand struct {
    Ui cli.Ui
    // contains filtered or unexported fields
}

func (*EvalCommand) Description Uses

func (c *EvalCommand) Description() string

Description is the long-form command help.

func (*EvalCommand) Help Uses

func (c *EvalCommand) Help() string

Help returns the full help output expected by `sockaddr -h cmd`

func (*EvalCommand) InitOpts Uses

func (c *EvalCommand) InitOpts()

InitOpts is responsible for setup of this command's configuration via the command line. InitOpts() does not parse the arguments (see parseOpts()).

func (*EvalCommand) Run Uses

func (c *EvalCommand) Run(args []string) int

Run executes this command.

func (*EvalCommand) Synopsis Uses

func (c *EvalCommand) Synopsis() string

Synopsis returns a terse description used when listing sub-commands.

func (*EvalCommand) Usage Uses

func (c *EvalCommand) Usage() string

Usage is the one-line usage description

func (*EvalCommand) VisitAllFlags Uses

func (c *EvalCommand) VisitAllFlags(fn func(*flag.Flag))

VisitAllFlags forwards the visitor function to the FlagSet

type MultiArg Uses

type MultiArg []string

func (*MultiArg) Set Uses

func (v *MultiArg) Set(raw string) error

func (*MultiArg) String Uses

func (v *MultiArg) String() string

type RFCCommand Uses

type RFCCommand struct {
    Ui cli.Ui
    // contains filtered or unexported fields
}

func (*RFCCommand) Description Uses

func (c *RFCCommand) Description() string

Description is the long-form command help.

func (*RFCCommand) Help Uses

func (c *RFCCommand) Help() string

Help returns the full help output expected by `sockaddr -h cmd`

func (*RFCCommand) InitOpts Uses

func (c *RFCCommand) InitOpts()

InitOpts is responsible for setup of this command's configuration via the command line. InitOpts() does not parse the arguments (see parseOpts()).

func (*RFCCommand) Run Uses

func (c *RFCCommand) Run(args []string) int

Run executes this command.

func (*RFCCommand) Synopsis Uses

func (c *RFCCommand) Synopsis() string

Synopsis returns a terse description used when listing sub-commands.

func (*RFCCommand) Usage Uses

func (c *RFCCommand) Usage() string

Usage is the one-line usage description

func (*RFCCommand) VisitAllFlags Uses

func (c *RFCCommand) VisitAllFlags(fn func(*flag.Flag))

VisitAllFlags forwards the visitor function to the FlagSet

type RFCListCommand Uses

type RFCListCommand struct {
    Ui cli.Ui
    // contains filtered or unexported fields
}

func (*RFCListCommand) Description Uses

func (c *RFCListCommand) Description() string

Description is the long-form command help.

func (*RFCListCommand) Help Uses

func (c *RFCListCommand) Help() string

Help returns the full help output expected by `sockaddr -h cmd`

func (*RFCListCommand) InitOpts Uses

func (c *RFCListCommand) InitOpts()

InitOpts is responsible for setup of this command's configuration via the command line. InitOpts() does not parse the arguments (see parseOpts()).

func (*RFCListCommand) Run Uses

func (c *RFCListCommand) Run(args []string) int

Run executes this command.

func (*RFCListCommand) Synopsis Uses

func (c *RFCListCommand) Synopsis() string

Synopsis returns a terse description used when listing sub-commands.

func (*RFCListCommand) Usage Uses

func (c *RFCListCommand) Usage() string

Usage is the one-line usage description

func (*RFCListCommand) VisitAllFlags Uses

func (c *RFCListCommand) VisitAllFlags(fn func(*flag.Flag))

VisitAllFlags forwards the visitor function to the FlagSet

type TechSupportCommand Uses

type TechSupportCommand struct {
    Ui cli.Ui
    // contains filtered or unexported fields
}

func (*TechSupportCommand) Description Uses

func (c *TechSupportCommand) Description() string

Description is the long-form command help.

func (*TechSupportCommand) Help Uses

func (c *TechSupportCommand) Help() string

Help returns the full help output expected by `sockaddr -h cmd`

func (*TechSupportCommand) InitOpts Uses

func (c *TechSupportCommand) InitOpts()

InitOpts is responsible for setup of this command's configuration via the command line. InitOpts() does not parse the arguments (see parseOpts()).

func (*TechSupportCommand) Run Uses

func (c *TechSupportCommand) Run(args []string) int

Run executes this command.

func (*TechSupportCommand) Synopsis Uses

func (c *TechSupportCommand) Synopsis() string

Synopsis returns a terse description used when listing sub-commands.

func (*TechSupportCommand) Usage Uses

func (c *TechSupportCommand) Usage() string

Usage is the one-line usage description

func (*TechSupportCommand) VisitAllFlags Uses

func (c *TechSupportCommand) VisitAllFlags(fn func(*flag.Flag))

VisitAllFlags forwards the visitor function to the FlagSet

type VersionCommand Uses

type VersionCommand struct {
    HumanVersion string
    Ui           cli.Ui
}

VersionCommand is a Command implementation prints the version.

func (*VersionCommand) Help Uses

func (c *VersionCommand) Help() string

func (*VersionCommand) Run Uses

func (c *VersionCommand) Run(_ []string) int

func (*VersionCommand) Synopsis Uses

func (c *VersionCommand) Synopsis() string

Package command imports 18 packages (graph) and is imported by 1 packages. Updated 2018-06-23. Refresh now. Tools for package owners.