pty

Documentation

Overview

Package pty provides functions for working with Unix terminals.

SPDX-License-Identifier: MIT

Index

• func Getsize(t *os.File) (rows, cols uint16, err error)
• func IsForeground(f *os.File) bool
• func IsTerminal(f *os.File) bool
• func Open() (pty, tty *os.File, err error)
• func Ptsname(f *os.File) (string, error)
• func Resizer(parent, child *os.File)
• func Restore(f *os.File, state *State) error
• func Setsize(f *os.File, rows, cols uint16) error
• func Unlockpt(f *os.File) error
• type State
  • func MakeRaw(f *os.File) (*State, error)
  • func Makefilelike(f *os.File) (*State, error)

Functions

func Getsize

func Getsize(t *os.File) (rows, cols uint16, err error)

Getsize returns the number of rows (lines) and cols (positions in each line) in terminal t.

func IsForeground

func IsForeground(f *os.File) bool

func IsTerminal

func IsTerminal(f *os.File) bool

IsTerminal returns true if the given file descriptor is a terminal.

func Open

func Open() (pty, tty *os.File, err error)

Opens a pty and its corresponding tty.

func Ptsname

func Ptsname(f *os.File) (string, error)

func Resizer

func Resizer(parent, child *os.File)

func Restore

func Restore(f *os.File, state *State) error

Restore sets a terminal back to a previously saved state

func Setsize

func Setsize(f *os.File, rows, cols uint16) error

func Unlockpt

func Unlockpt(f *os.File) error

Types

type State

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

State is the terminos struct

func MakeRaw

func MakeRaw(f *os.File) (*State, error)

MakeRaw puts a tty into raw mode and returns the previous state

func Makefilelike

func Makefilelike(f *os.File) (*State, error)