Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.08 KB

linenoise.md

File metadata and controls

63 lines (43 loc) · 1.08 KB

linenoise: light readline alternative

linenoise is a small self-contained alternative to readline and libedit.

Warning: linenoise has not been ported to Windows. The following functions works on Windows but are stubbed using the Lua io module when possible. The history can not be saved on Windows.

linenoise.read(prompt)

prints prompt and returns the string entered by the user.

linenoise.read_mask(prompt)

is the same as linenoise.read(prompt) but the characters are not echoed but replaced with *.

linenoise.add(line)

adds line to the current history.

linenoise.set_len(len)

sets the maximal history length to len.

linenoise.save(filename)

saves the history to the file filename.

linenoise.load(filename)

loads the history from the file filename.

linenoise.clear()

clears the screen.

linenoise.multi_line(ml)

enable/disable the multi line mode (enabled by default).

linenoise.mask(b)

enable/disable the mask mode.