program

Documentation

Overview

Package program provides the entry point to Elvish. Its subpackages correspond to subprograms of Elvish.

Index

• func Main(allArgs []string) int
• type Program
  • func FindProgram(flag *flagSet) Program
• type ShowBuildInfo
  • func (info ShowBuildInfo) Main([]string) int
• type ShowCorrectUsage
  • func (s ShowCorrectUsage) Main([]string) int
• type ShowHelp
  • func (s ShowHelp) Main([]string) int
• type ShowVersion
  • func (ShowVersion) Main([]string) int

Functions

func Main

func Main(allArgs []string) int

Types

type Program

type Program interface {
	// Main calls the subprogram with arguments. The return value will be used
	// as the exit status of the entire program.
	Main(args []string) int
}

Program represents a subprogram.

func FindProgram

func FindProgram(flag *flagSet) Program

FindProgram finds a suitable Program according to flags. It does not have any side effects.

type ShowBuildInfo

type ShowBuildInfo struct {
	JSON bool
}

ShowBuildInfo shows build information.

func (ShowBuildInfo) Main

func (info ShowBuildInfo) Main([]string) int

type ShowCorrectUsage

type ShowCorrectUsage struct {
	// contains filtered or unexported fields
}

func (ShowCorrectUsage) Main

func (s ShowCorrectUsage) Main([]string) int

type ShowHelp

type ShowHelp struct {
	// contains filtered or unexported fields
}

ShowHelp shows help message.

func (ShowHelp) Main

func (s ShowHelp) Main([]string) int

type ShowVersion

type ShowVersion struct{}

ShowVersion shows the version.

func (ShowVersion) Main

func (ShowVersion) Main([]string) int