# README
A powerful readline library in Linux macOS Windows Solaris AIX
Guide
Repos using readline
Feedback
If you have any questions, please submit a github issue and any pull requests is welcomed :)
Backers
Love Readline? Help me keep it alive by donating funds to cover project expenses!
[Become a backer]
Sponsors
Become a sponsor and get your logo here on our Github page. [Become a sponsor]
# Functions
add history to global instance manually raise error only if `SetHistoryPath` is set with a non-empty path.
ClearScreen clears the console screen.
append log info to another file.
GetSize returns the dimensions of the given terminal.
GetState returns the current state of a terminal which may be useful to restore the terminal after a signal.
IsTerminal returns true if the given file descriptor is a terminal.
readline with global configs.
calculate how many lines for N character.
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.
NewFillableStdin gives you FillableStdin.
ReadPassword reads a line of input from a terminal without local echo.
set auto completer to global instance.
let readline load history from filepath and try to persist history into disk set fp to "" to prevent readline persisting history to disk so the `AddHistory` will return nil error forever.
SuspendMe use to send suspend signal to myself, when we in the raw mode.
WaitForResume need to call before current process got suspend.
# Constants
exit raw.
# Structs
FillableStdin is a stdin reader which can prepend some data before reading into the real stdin.
State contains the state of a terminal.