termios

Documentation

Overview

Package termios implements basic termios operations including getting a tty struct, termio struct, a winsize struct, and setting raw mode. To get a TTY, call termios.New. To get a Termios, call tty.Get(); to set it, call tty.Set(*Termios) To set raw mode and then restore, one can do: tty := termios.NewTTY() restorer, err := tty.Raw() do things tty.Set(restorer)

Index

• Constants
• func GTTY(fd int) (*tty, error)
• func GetTermios(fd uintptr) (*unix.Termios, error)
• func GetWinSize(fd uintptr) (*unix.Winsize, error)
• func MakeRaw(term *unix.Termios) *unix.Termios
• func Raw(fd int) (*tty, error)
• func SetTermios(fd uintptr, ti *unix.Termios) error
• func SetWinSize(fd uintptr, w *unix.Winsize) error
• type TTY
  • func New() (*TTY, error)
  • func (t *TTY) Get() (*unix.Termios, error)
  • func (t *TTY) GetWinSize() (*unix.Winsize, error)
  • func (t *TTY) Raw() (*unix.Termios, error)
  • func (t *TTY) Read(b []byte) (int, error)
  • func (t *TTY) Set(ti *unix.Termios) error
  • func (t *TTY) SetWinSize(w *unix.Winsize) error
  • func (t *TTY) Write(b []byte) (int, error)

Constants

const (
	I = iota // Input control
	O        // Output control
	C        // Control
	L        // Line control
)

These consts describe the offsets into the termios struct of various elements.

Functions

func GTTY

func GTTY(fd int) (*tty, error)

GTTY returns the tty struct for a given fd. It is like a New in many packages but the name GTTY is a tradition.

func GetTermios

func GetTermios(fd uintptr) (*unix.Termios, error)

func GetWinSize

func GetWinSize(fd uintptr) (*unix.Winsize, error)

func MakeRaw

func MakeRaw(term *unix.Termios) *unix.Termios

func Raw

func Raw(fd int) (*tty, error)

Raw sets a tty into raw more, returning a tty struct

func SetTermios

func SetTermios(fd uintptr, ti *unix.Termios) error

func SetWinSize

func SetWinSize(fd uintptr, w *unix.Winsize) error

Types

type TTY

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

TTY is a wrapper that only allows Read and Write.

func New

func New() (*TTY, error)

func (*TTY) Get

func (t *TTY) Get() (*unix.Termios, error)

func (*TTY) GetWinSize

func (t *TTY) GetWinSize() (*unix.Winsize, error)

func (*TTY) Raw

func (t *TTY) Raw() (*unix.Termios, error)

func (*TTY) Read

func (t *TTY) Read(b []byte) (int, error)

func (*TTY) Set

func (t *TTY) Set(ti *unix.Termios) error

func (*TTY) SetWinSize

func (t *TTY) SetWinSize(w *unix.Winsize) error

func (*TTY) Write

func (t *TTY) Write(b []byte) (int, error)