package termios

Import Path
	github.com/charmbracelet/x/termios (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	    bit_other.go
	    syscalls_linux.go
	    termios.go
	    termios_linux.go
	    termios_other.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type C uint8 (basic type)
		Control

		As Inputs Of (at least one exported)
			func SetTermios(fd int, ispeed uint32, ospeed uint32, cc map[CC]uint8, iflag map[I]bool, oflag map[O]bool, cflag map[C]bool, lflag map[L]bool) error
		As Types Of (total 4)
			const CS7
			const CS8
			const PARENB
			const PARODD

	 type CC uint8 (basic type)
		CC is the termios cc field.
		
		It stores an array of special characters related to terminal I/O.

		As Inputs Of (at least one exported)
			func SetTermios(fd int, ispeed uint32, ospeed uint32, cc map[CC]uint8, iflag map[I]bool, oflag map[O]bool, cflag map[C]bool, lflag map[L]bool) error
		As Types Of (total 18)
			const DISCARD
			const DSUSP
			const EOF
			const EOL
			const EOL2
			const ERASE
			const FLUSH
			const INTR
			const KILL
			const LNEXT
			const QUIT
			const RPRNT
			const START
			const STATUS
			const STOP
			const SUSP
			const SWTCH
			const WERASE

	 type I uint8 (basic type)
		Input Controls

		As Inputs Of (at least one exported)
			func SetTermios(fd int, ispeed uint32, ospeed uint32, cc map[CC]uint8, iflag map[I]bool, oflag map[O]bool, cflag map[C]bool, lflag map[L]bool) error
		As Types Of (total 12)
			const ICRNL
			const IGNCR
			const IGNPAR
			const IMAXBEL
			const INLCR
			const INPCK
			const ISTRIP
			const IUCLC
			const IXANY
			const IXOFF
			const IXON
			const PARMRK

	 type L uint8 (basic type)
		Line Controls.

		As Inputs Of (at least one exported)
			func SetTermios(fd int, ispeed uint32, ospeed uint32, cc map[CC]uint8, iflag map[I]bool, oflag map[O]bool, cflag map[C]bool, lflag map[L]bool) error
		As Types Of (total 14)
			const ECHO
			const ECHOCTL
			const ECHOE
			const ECHOK
			const ECHOKE
			const ECHONL
			const ICANON
			const IEXTEN
			const ISIG
			const IUTF8
			const NOFLSH
			const PENDIN
			const TOSTOP
			const XCASE

	 type O uint8 (basic type)
		Output Controls

		As Inputs Of (at least one exported)
			func SetTermios(fd int, ispeed uint32, ospeed uint32, cc map[CC]uint8, iflag map[I]bool, oflag map[O]bool, cflag map[C]bool, lflag map[L]bool) error
		As Types Of (total 6)
			const OCRNL
			const OLCUC
			const ONLCR
			const ONLRET
			const ONOCR
			const OPOST


Package-Level Functions (total 4)

	 func GetTermios(fd int) (*unix.Termios, error)
		GetTermios gets the termios of the given fd.

	 func GetWinsize(fd int) (*unix.Winsize, error)
		GetWinsize gets window size for an fd.

	 func SetTermios(fd int, ispeed uint32, ospeed uint32, cc map[CC]uint8, iflag map[I]bool, oflag map[O]bool, cflag map[C]bool, lflag map[L]bool) error
		SetTermios sets the given termios over the given fd's current termios.

	 func SetWinsize(fd int, w *unix.Winsize) error
		SetWinsize sets window size for an fd from a Winsize.


Package-Level Constants (total 54)

	const CS7 C = 0
		Control possible values.

	const CS8 C = 1
		Control possible values.

	const DISCARD CC = 13
		CC possible values.

	const DSUSP CC = 16
		CC possible values.

	const ECHO L = 2
		Line possible values.

	const ECHOCTL L = 9
		Line possible values.

	const ECHOE L = 3
		Line possible values.

	const ECHOK L = 4
		Line possible values.

	const ECHOKE L = 10
		Line possible values.

	const ECHONL L = 5
		Line possible values.

	const EOF CC = 4
		CC possible values.

	const EOL CC = 5
		CC possible values.

	const EOL2 CC = 6
		CC possible values.

	const ERASE CC = 2
		CC possible values.

	const FLUSH CC = 17
		CC possible values.

	const ICANON L = 1
		Line possible values.

	const ICRNL I = 6
		Input possible values.

	const IEXTEN L = 8
		Line possible values.

	const IGNCR I = 5
		Input possible values.

	const IGNPAR I = 0
		Input possible values.

	const IMAXBEL I = 10
		Input possible values.

	const INLCR I = 4
		Input possible values.

	const INPCK I = 2
		Input possible values.

	const INTR CC = 0
		CC possible values.

	const ISIG L = 0
		Line possible values.

	const ISTRIP I = 3
		Input possible values.

	const IUCLC I = 11
		Input possible values.

	const IUTF8 L = 12
		Line possible values.

	const IXANY I = 8
		Input possible values.

	const IXOFF I = 9
		Input possible values.

	const IXON I = 7
		Input possible values.

	const KILL CC = 3
		CC possible values.

	const LNEXT CC = 12
		CC possible values.

	const NOFLSH L = 6
		Line possible values.

	const OCRNL O = 2
		Output possible values.

	const OLCUC O = 5
		Output possible values.

	const ONLCR O = 1
		Output possible values.

	const ONLRET O = 4
		Output possible values.

	const ONOCR O = 3
		Output possible values.

	const OPOST O = 0
		Output possible values.

	const PARENB C = 2
		Control possible values.

	const PARMRK I = 1
		Input possible values.

	const PARODD C = 3
		Control possible values.

	const PENDIN L = 11
		Line possible values.

	const QUIT CC = 1
		CC possible values.

	const RPRNT CC = 11
		CC possible values.

	const START CC = 7
		CC possible values.

	const STATUS CC = 14
		CC possible values.

	const STOP CC = 8
		CC possible values.

	const SUSP CC = 9
		CC possible values.

	const SWTCH CC = 15
		CC possible values.

	const TOSTOP L = 7
		Line possible values.

	const WERASE CC = 10
		CC possible values.

	const XCASE L = 13
		Line possible values.

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.