This is the clinenoise Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:58:57 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
clinenoiseA trivial line-input library for VT-like terminals
BSD-2
cffi-grovel (system).
cffi (system).
alexandria (system).
split-sequence (system).
cffi-grovel (system).
package.lisp (file).
termios-grovel.lisp (file).
cwrappers.lisp (file).
clinenoise.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clinenoise/clinenoise.asdclinenoise/package.lispclinenoise/termios-grovel.lispclinenoise/cwrappers.lispclinenoise/clinenoise.lispclinenoise/termios-grovel.lisppackage.lisp (file).
clinenoise (system).
clinenoise/cwrappers.lisptermios-grovel.lisp (file).
clinenoise (system).
clinenoise/clinenoise.lispcwrappers.lisp (file).
clinenoise (system).
history-add (function).
history-load (function).
history-save (function).
linenoise (function).
*completion-callback* (special variable).
*history* (special variable).
*history-len* (special variable).
*mlmode* (special variable).
*unread-char* (special variable).
+linenoise-default-history-max-len+ (constant).
+linenoise-max-line+ (constant).
+unsupported-term+ (special variable).
clear-screen (function).
complete-line (function).
copy-linenoise-state (function).
edit (function).
edit-backspace (function).
edit-delete (function).
edit-delete-prev-word (function).
edit-history-next (function).
edit-insert (function).
edit-move-left (function).
edit-move-right (function).
enable-raw-mode (function).
get-columns (function).
is-unsupported-term (function).
linenoise-beep (function).
linenoise-clear-screen (function).
linenoise-raw (function).
linenoise-set-multiline (function).
linenoise-state (structure).
linenoise-state-p (function).
ls-buf (reader).
(setf ls-buf) (writer).
ls-cols (reader).
(setf ls-cols) (writer).
ls-fd (reader).
(setf ls-fd) (writer).
ls-history-index (reader).
(setf ls-history-index) (writer).
ls-maxrows (reader).
(setf ls-maxrows) (writer).
ls-oldpos (reader).
(setf ls-oldpos) (writer).
ls-plen (reader).
(setf ls-plen) (writer).
ls-pos (reader).
(setf ls-pos) (writer).
ls-prompt (reader).
(setf ls-prompt) (writer).
make-linenoise-state (function).
my-read-char (function).
my-unread-char (function).
refresh-line (function).
refresh-multi-line (function).
refresh-single-line (function).
restore-tty (function).
set-completion-callback (function).
with-raw-mode (macro).
Packages are listed by definition order.
clinenoisealexandria.
cffi.
common-lisp.
split-sequence.
history-add (function).
history-load (function).
history-save (function).
linenoise (function).
*completion-callback* (special variable).
*history* (special variable).
*history-len* (special variable).
*mlmode* (special variable).
*unread-char* (special variable).
+linenoise-default-history-max-len+ (constant).
+linenoise-max-line+ (constant).
+unsupported-term+ (special variable).
clear-screen (function).
complete-line (function).
copy-linenoise-state (function).
cread (function).
edit (function).
edit-backspace (function).
edit-delete (function).
edit-delete-prev-word (function).
edit-history-next (function).
edit-insert (function).
edit-move-left (function).
edit-move-right (function).
enable-raw-mode (function).
get-columns (function).
getenv (function).
ioctl (macro).
is-unsupported-term (function).
isatty (function).
linenoise-beep (function).
linenoise-clear-screen (function).
linenoise-raw (function).
linenoise-set-multiline (function).
linenoise-state (structure).
linenoise-state-p (function).
ls-buf (reader).
(setf ls-buf) (writer).
ls-cols (reader).
(setf ls-cols) (writer).
ls-fd (reader).
(setf ls-fd) (writer).
ls-history-index (reader).
(setf ls-history-index) (writer).
ls-maxrows (reader).
(setf ls-maxrows) (writer).
ls-oldpos (reader).
(setf ls-oldpos) (writer).
ls-plen (reader).
(setf ls-plen) (writer).
ls-pos (reader).
(setf ls-pos) (writer).
ls-prompt (reader).
(setf ls-prompt) (writer).
make-linenoise-state (function).
my-read-char (function).
my-unread-char (function).
refresh-line (function).
refresh-multi-line (function).
refresh-single-line (function).
restore-tty (function).
set-completion-callback (function).
tcgetattr (function).
tcsetattr (function).
with-raw-mode (macro).
zero-or-error-from-c (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Add LINE to the prompt history
Load history from pathname FN
Save history to pathname FN
Display PROMPT and wait for a line to be entered with basic editing support PLEN can be specified for prompts that have a display width different from their character count (e.g. combining characters, escape codes)
Function to call for completions.
Takes the current line as a parameter, and returns a list of possible completions
Does not currently indicate the position of the cursor when the completion was requested
structure-object.
| Jump to: | (
C E F G H I L M R S T W Z |
|---|
| Jump to: | (
C E F G H I L M R S T W Z |
|---|
| Jump to: | *
+
B C F H M O P S |
|---|
| Jump to: | *
+
B C F H M O P S |
|---|
| Jump to: | C F L P S T |
|---|
| Jump to: | C F L P S T |
|---|