xterminal

Documentation

Overview

Package xterminal provides functions to change termios or console attributes and restore them later on. It supports Unix and Windows.

This does the same thing as x/crypto/ssh/terminal on Linux. On Windows, it sets the same console modes as the terminal package but also sets `ENABLE_VIRTUAL_TERMINAL_INPUT` and `ENABLE_VIRTUAL_TERMINAL_PROCESSING` to allow for VT100 sequences in the console. This is important, otherwise Linux apps (with colors or ncurses) that are run through SSH or wsep get garbled in a Windows console.

More details can be found out about Windows console modes here: https://docs.microsoft.com/en-us/windows/console/setconsolemode

Index

• func ColorEnabled(fd uintptr) (bool, error)
• func ResizeEvents(ctx context.Context, termFD uintptr) chan ResizeEvent
• func Restore(fd uintptr, state *State) error
• type ResizeEvent
• type State
  • func MakeOutputRaw(fd uintptr) (*State, error)
  • func MakeRaw(fd uintptr) (*State, error)

Functions

func ColorEnabled

func ColorEnabled(fd uintptr) (bool, error)

ColorEnabled returns true on Linux if handle is a terminal.

func ResizeEvents

func ResizeEvents(ctx context.Context, termFD uintptr) chan ResizeEvent

ResizeEvents sends terminal resize events.

func Restore

func Restore(fd uintptr, state *State) error

Restore terminal back to original state.

Types

type ResizeEvent

type ResizeEvent struct {
	Height uint16
	Width  uint16
}

ResizeEvent describes the new terminal dimensions following a resize.

type State

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

State differs per-platform.

func MakeOutputRaw

func MakeOutputRaw(fd uintptr) (*State, error)

MakeOutputRaw does nothing on non-Windows platforms.

func MakeRaw

func MakeRaw(fd uintptr) (*State, error)

MakeRaw sets the terminal to raw.