terminal

Documentation

Index

• Constants
• type Terminal
  • func NewTerminal() *Terminal
  • func (t *Terminal) AddDecorator(d decorators.Decorator)
  • func (t *Terminal) ForceRedraw()
  • func (t *Terminal) HideOutput()
  • func (t *Terminal) Pty() *os.File
  • func (t *Terminal) Run(commands ...string) error
  • func (t *Terminal) SetDir(dir string)
  • func (t *Terminal) SetMOTD(motd string)
  • func (t *Terminal) SetNestingAllowed(allowed bool)
  • func (t *Terminal) SetShell(shell string)
  • func (t *Terminal) ShowOutput()

Constants

const BackOffReadInitialSleepDuration = time.Millisecond

const BackOffReadMaxSleepDuration = time.Millisecond * 16

Types

type Terminal

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

Terminal communicates with the underlying terminal which is running shox

func NewTerminal

func NewTerminal() *Terminal

NewTerminal creates a new terminal instance

func (*Terminal) AddDecorator

func (t *Terminal) AddDecorator(d decorators.Decorator)

AddDecorator adds a decorator to alter the terminal output

func (*Terminal) ForceRedraw

func (t *Terminal) ForceRedraw()

func (*Terminal) HideOutput

func (t *Terminal) HideOutput()

func (*Terminal) Pty

func (t *Terminal) Pty() *os.File

Pty exposes the underlying terminal pty, if it exists

func (*Terminal) Run

func (t *Terminal) Run(commands ...string) error

Run starts the terminal/shell proxying process

func (*Terminal) SetDir

func (t *Terminal) SetDir(dir string)

SetDir sets the directory the shell will start in (CWD)

func (*Terminal) SetMOTD

func (t *Terminal) SetMOTD(motd string)

SetMOTD sets the motd to write to the terminal before the main command is launched

func (*Terminal) SetNestingAllowed

func (t *Terminal) SetNestingAllowed(allowed bool)

SetNestingAllowed sets whether multiple shox bars can be nested inside each other

func (*Terminal) SetShell

func (t *Terminal) SetShell(shell string)

SetShell sets the shell program being used by the terminal

func (*Terminal) ShowOutput

func (t *Terminal) ShowOutput()