package pty

import "github.com/creack/pty"

Package pty provides functions for working with Unix terminals.

Index ¶

• Constants
• Variables
• func Getsize(t *os.File) (rows, cols int, err error)
• func InheritSize(pty, tty *os.File) error
• func Open() (pty, tty *os.File, err error)
• func Setsize(t *os.File, ws *Winsize) error
• func Start(cmd *exec.Cmd) (*os.File, error)
• func StartWithAttrs(c *exec.Cmd, sz *Winsize, attrs *syscall.SysProcAttr) (*os.File, error)
• func StartWithSize(cmd *exec.Cmd, ws *Winsize) (*os.File, error)
• type Winsize
• func GetsizeFull(t *os.File) (size *Winsize, err error)

Constants ¶

const (
	TIOCGWINSZ = syscall.TIOCGWINSZ
	TIOCSWINSZ = syscall.TIOCSWINSZ
)

Local syscall const values.

Variables ¶

var ErrUnsupported = errors.New("unsupported")

ErrUnsupported is returned if a function is not available on the current platform.

Functions ¶

func Getsize ¶

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

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

func InheritSize ¶

func InheritSize(pty, tty *os.File) error

InheritSize applies the terminal size of pty to tty. This should be run in a signal handler for syscall.SIGWINCH to automatically resize the tty when the pty receives a window size change notification.

func Open ¶

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

Open a pty and its corresponding tty.

func Setsize ¶

func Setsize(t *os.File, ws *Winsize) error

Setsize resizes t to s.

func Start ¶

func Start(cmd *exec.Cmd) (*os.File, error)

Start assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, and c.Stderr, calls c.Start, and returns the File of the tty's corresponding pty.

Starts the process in a new session and sets the controlling terminal.

func StartWithAttrs ¶

func StartWithAttrs(c *exec.Cmd, sz *Winsize, attrs *syscall.SysProcAttr) (*os.File, error)

StartWithAttrs assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, and c.Stderr, calls c.Start, and returns the File of the tty's corresponding pty.

This will resize the pty to the specified size before starting the command if a size is provided. The `attrs` parameter overrides the one set in c.SysProcAttr.

This should generally not be needed. Used in some edge cases where it is needed to create a pty without a controlling terminal.

func StartWithSize ¶

func StartWithSize(cmd *exec.Cmd, ws *Winsize) (*os.File, error)

StartWithSize assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, and c.Stderr, calls c.Start, and returns the File of the tty's corresponding pty.

This will resize the pty to the specified size before starting the command. Starts the process in a new session and sets the controlling terminal.

Types ¶

type Winsize ¶

type Winsize struct {
	Rows uint16 // ws_row: Number of rows (in cells).
	Cols uint16 // ws_col: Number of columns (in cells).
	X    uint16 // ws_xpixel: Width in pixels.
	Y    uint16 // ws_ypixel: Height in pixels.
}

Winsize describes the terminal size.

func GetsizeFull ¶

func GetsizeFull(t *os.File) (size *Winsize, err error)

GetsizeFull returns the full terminal size description.

Source Files ¶

doc.go ioctl.go ioctl_inner.go pty_unsupported.go run.go start.go winsize.go winsize_unix.go