pty

README

pty

Pty is a Go package for using unix pseudo-terminals.

Install

go get github.com/kr/pty

Example

package main

import (
	"github.com/kr/pty"
	"io"
	"os"
	"os/exec"
)

func main() {
	c := exec.Command("grep", "--color=auto", "bar")
	f, err := pty.Start(c)
	if err != nil {
		panic(err)
	}

	go func() {
		f.Write([]byte("foo\n"))
		f.Write([]byte("bar\n"))
		f.Write([]byte("baz\n"))
		f.Write([]byte{4}) // EOT
	}()
	io.Copy(os.Stdout, f)
}

Documentation

Overview

Package pty provides functions for working with Unix terminals.

Index

• Variables
• func Getsize(t *os.File) (rows, cols int, err error)
• func Open() (pty, tty *os.File, err error)
• func Setsize(t *os.File, rows, cols int) error
• func Start(c *exec.Cmd) (pty *os.File, err error)

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 Open

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

Opens a pty and its corresponding tty.

func Setsize

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

Setsize sets the number of rows (lines) and cols (positions in each line) in terminal t. Both rows and cols have to be positive integers.

func Start

func Start(c *exec.Cmd) (pty *os.File, err 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.