Categorygithub.com/kless/term
modulepackage
0.0.0-20161130133337-e551c64f56c0
Repository: https://github.com/kless/term.git
Documentation: pkg.go.dev

# README

term

Package term provides a portable interface for terminal I/O.

Documentation online

Installation

go get github.com/tredoe/term

Status

Tested in Linux 3.5.0, FreeBSD 9.1, NetBSD 6.1, OpenBSD 5.3, and Darwin systems, for AMD64 and i386 architectures.

License

The source files are distributed under the Mozilla Public License, version 2.0, unless otherwise noted.
Please read the FAQ if you have further questions regarding the license.


Generated by Gowizard

# Packages

Package readline provides simple functions for both line and screen editing.
Package sys contains low-level operating system primitives of the term.
Package test checks the functions that depend of the standard input, which is changed by `go test` to the standard error.

# Functions

DetectWinSize caughts a signal named SIGWINCH whenever the window size changes, being indicated in channel `WinSize.Change`.
IsTerminal returns true if the file descriptor is a term.
New creates a new terminal interface in the file descriptor InputFD.
ReadPassword reads characters from the input until press Enter or until fill in the given slice.
Restore restores the settings from State.
SupportANSI checks if the terminal supports ANSI escape sequences.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Default values for input and output.
Default values for input and output.
Default values for input and output.
If it is true, at reading a password it shows characters shadowed by each key pressed.

# Structs

No description provided by the author
A Terminal represents a general terminal interface.
WinSize represents a channel, Change, to know when the window size has changed through function DetectWinSize.