shell

Documentation

Index

• Variables
• func Detect() (string, error)
• func SetScript(ec EnvConfig, w io.Writer, envTmpl string, data interface{}) error
• func UnsetScript(ec EnvConfig, w io.Writer, vars []string) error
• type Config
  • func CfgSet(ec EnvConfig, plz, cmd string) *Config
• type EnvConfig

Variables

var (
	// ForceShell forces a shell name
	ForceShell string
)

Functions

func Detect

func Detect() (string, error)

Detect detects user's current shell.

func SetScript

func SetScript(ec EnvConfig, w io.Writer, envTmpl string, data interface{}) error

SetScript writes out a shell-compatible set script

func UnsetScript

func UnsetScript(ec EnvConfig, w io.Writer, vars []string) error

UnsetScript writes out a shell-compatible unset script

Types

type Config

type Config struct {
	Prefix    string
	Delimiter string
	Suffix    string
	UsageHint string
}

Config represents the shell config

func CfgSet

func CfgSet(ec EnvConfig, plz, cmd string) *Config

CfgSet generates context variables for shell

type EnvConfig

type EnvConfig struct {
	Shell string
}

EnvConfig encapsulates all external inputs into shell generation