package term

Import Path
	github.com/reeflective/readline/internal/term (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 6 packages

Involved Source Files

	    codes.go
	    cursor.go
	    raw_linux.go
	    raw_unix.go
	    term.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type State (struct)
		State contains the state of a terminal.

		As Outputs Of (at least 2)
			func GetState(fd int) (*State, error)
			func MakeRaw(fd int) (*State, error)
		As Inputs Of (at least one exported)
			func Restore(fd int, state *State) error


Package-Level Functions (total 11)

	 func GetLength() int
		GetLength returns the length of the terminal
		(Y length), or 80 if it cannot be established.

	 func GetSize(fd int) (width, height int, err error)
		GetSize returns the dimensions of the given terminal.

	 func GetState(fd int) (*State, error)
		GetState returns the current state of a terminal which may be useful to
		restore the terminal after a signal.

	 func GetWidth() (termWidth int)
		GetWidth returns the width of Stdout or 80 if the width cannot be established.

	 func IsTerminal(fd int) bool
		IsTerminal returns true if the given file descriptor is a terminal.

	 func MakeRaw(fd int) (*State, error)
		MakeRaw put the terminal connected to the given file descriptor into raw
		mode and returns the previous state of the terminal so that it can be
		restored.

	 func MoveCursorBackwards(i int)
		MoveCursorBackwards moves the cursor backward i columns.

	 func MoveCursorDown(i int)
		MoveCursorDown moves the cursor down i lines.

	 func MoveCursorForwards(i int)
		MoveCursorForwards moves the cursor forward i columns.

	 func MoveCursorUp(i int)
		MoveCursorUp moves the cursor up i lines.

	 func Restore(fd int, state *State) error
		Restore restores the terminal connected to the given file descriptor to a
		previous state.


Package-Level Variables (total 4)

	  var ArrowDown string // ^[[B
		Some core keys needed by some stuff.

	  var ArrowLeft string // ^[[D
		Some core keys needed by some stuff.

	  var ArrowRight string // ^[[C
		Some core keys needed by some stuff.

	  var ArrowUp string // ^[[A
		Some core keys needed by some stuff.


Package-Level Constants (total 12)

	const ClearDisplay = "\x1b[3J" // Clears screen fully, wipes the scroll buffer
		Terminal control sequences.

	const ClearLine = "\x1b[2K"
		Terminal control sequences.

	const ClearLineAfter = "\x1b[0K"
		Terminal control sequences.

	const ClearLineBefore = "\x1b[1K"
		Terminal control sequences.

	const ClearScreen = "\x1b[2J" // Clears screen, preserving scroll buffer
		Terminal control sequences.

	const ClearScreenBelow = "\x1b[0J"
		Terminal control sequences.

	const CursorTopLeft = "\x1b[H"
		Terminal control sequences.

	const HideCursor = "\x1b[?25l"
		Terminal control sequences.

	const NewlineReturn = "\r\n"
		Terminal control sequences.

	const RestoreCursorPos = "\x1b8"
		Terminal control sequences.

	const SaveCursorPos = "\x1b7"
		Terminal control sequences.

	const ShowCursor = "\x1b[?25h"
		Terminal control sequences.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.