This is the linedit Reference Manual, version 0.17.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 05:32:57 2025 GMT+0.
linedit/linedit.asdlinedit/packages.lisplinedit/utility-functions.lisplinedit/utility-macros.lisplinedit/matcher.lisplinedit/backend.lisplinedit/terminal-glue.lisplinedit/terminal-translations.lisplinedit/terminal.lisplinedit/smart-terminal.lisplinedit/dumb-terminal.lisplinedit/rewindable.lisplinedit/line.lisplinedit/buffer.lisplinedit/command-keys.lisplinedit/editor.lisplinedit/main.lisplinedit/complete.lisplinedit/command-functions.lisplinedit/ports/sbcl.lisplinedit/ports/ccl.lisplinedit/ports/generic.lispThe main system appears first, followed by any subsystem dependency.
lineditReadline-style library.
Anmol Khirbat <anmol@khirbat.net>
Nikodemus Siivola <nikodemus@random-state.net>
MIT
0.17.6
cffi (system).
terminfo (system).
osicat (system).
alexandria (system).
packages.lisp (file).
utility-functions.lisp (file).
utility-macros.lisp (file).
matcher.lisp (file).
backend.lisp (file).
terminal-glue.lisp (file).
terminal-translations.lisp (file).
terminal.lisp (file).
smart-terminal.lisp (file).
dumb-terminal.lisp (file).
rewindable.lisp (file).
line.lisp (file).
buffer.lisp (file).
command-keys.lisp (file).
editor.lisp (file).
main.lisp (file).
complete.lisp (file).
command-functions.lisp (file).
ports (module).
Modules are listed depth-first from the system components tree.
linedit/portsmain.lisp (file).
linedit (system).
sbcl.lisp (file).
ccl.lisp (file).
generic.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
linedit/linedit.asdlinedit/packages.lisplinedit/utility-functions.lisplinedit/utility-macros.lisplinedit/matcher.lisplinedit/backend.lisplinedit/terminal-glue.lisplinedit/terminal-translations.lisplinedit/terminal.lisplinedit/smart-terminal.lisplinedit/dumb-terminal.lisplinedit/rewindable.lisplinedit/line.lisplinedit/buffer.lisplinedit/command-keys.lisplinedit/editor.lisplinedit/main.lisplinedit/complete.lisplinedit/command-functions.lisplinedit/ports/sbcl.lisplinedit/ports/ccl.lisplinedit/ports/generic.lisplinedit/utility-functions.lisppackages.lisp (file).
linedit (system).
end-debug (function).
start-debug (function).
*debug* (special variable).
*word-delimiters* (special variable).
at-delimiter-p (function).
concat (function).
dbg (function).
eof-handler (function).
make-whitespace (function).
min* (function).
required (function).
whitespacep (function).
word-delimiter-p (function).
yes-or-no (function).
linedit/utility-macros.lisppackages.lisp (file).
utility-functions.lisp (file).
linedit (system).
acase (macro).
aif (macro).
awhen (macro).
dbg-values (macro).
do-internal-symbols (macro).
ensure (macro).
invariant (macro).
with-unique-names (macro).
linedit/matcher.lisppackages.lisp (file).
linedit (system).
after-close-p (function).
at-open-p (function).
dwim-mark-parens (function).
dwim-match-parens (function).
find-close-paren (function).
find-close-quote (function).
find-open-paren (function).
find-open-quote (function).
paren-count-delta (function).
quoted-p (function).
linedit/backend.lisputility-macros.lisp (file).
linedit (system).
*default-columns* (special variable).
*default-lines* (special variable).
*highlight-color* (special variable).
backend (class).
backend-ready-p (reader method).
(setf backend-ready-p) (writer method).
backend-translations (reader method).
display (generic function).
get-start (reader method).
(setf get-start) (writer method).
with-backend (macro).
without-backend (macro).
linedit/terminal-glue.lisplinedit (system).
+linedit-attr-error+ (special variable).
+linedit-memory-error+ (special variable).
+linedit-no-attr-error+ (special variable).
+linedit-not-atty+ (special variable).
+linedit-ok+ (special variable).
+linedit-tcgetattr-error+ (special variable).
+linedit-tcsetattr-error+ (special variable).
c-terminal-close (function).
c-terminal-columns (function).
c-terminal-init (function).
c-terminal-lines (function).
c-terminal-winsize (function).
linedit/terminal-translations.lisppackages.lisp (file).
linedit (system).
*terminal-translations* (special variable).
deftrans (macro).
linedit/terminal.lispterminal-translations.lisp (file).
backend.lisp (file).
terminal-glue.lisp (file).
linedit (system).
+terminal-bell+ (constant).
backend-close (method).
backend-columns (method).
backend-init (method).
backend-lines (method).
beep (method).
dirty-p (reader method).
(setf dirty-p) (writer method).
newline (method).
page (method).
print-in-columns (method).
print-in-lines (method).
read-chord (method).
terminal (class).
linedit/smart-terminal.lispterminal.lisp (file).
matcher.lisp (file).
linedit (system).
backend-init (method).
display (method).
find-col (function).
find-row (function).
fix-wraparound (function).
move-in-column (function).
old-markup (reader method).
(setf old-markup) (writer method).
old-point (reader method).
(setf old-point) (writer method).
old-string (reader method).
(setf old-string) (writer method).
paren-style (function).
place-point (function).
set-column-address (function).
smart-terminal (class).
smart-terminal-p (function).
linedit/dumb-terminal.lispterminal.lisp (file).
linedit (system).
display (method).
dumb-terminal (class).
linedit/rewindable.lisputility-macros.lisp (file).
linedit (system).
%rewind-count (function).
%rewind-index (reader method).
(setf %rewind-index) (writer method).
%rewind-store (reader method).
last-state (function).
rewind-state (method).
rewindable (class).
save-rewindable-state (function).
linedit/line.lisputility-macros.lisp (file).
linedit (system).
get-point (reader method).
(setf get-point) (method).
(setf get-point) (writer method).
get-string (reader method).
(setf get-string) (method).
(setf get-string) (writer method).
line (class).
linedit/buffer.lisputility-macros.lisp (file).
linedit (system).
%buffer-list (reader method).
(setf %buffer-list) (writer method).
%buffer-next (reader method).
(setf %buffer-next) (writer method).
%buffer-pathname (reader method).
(setf %buffer-pathname) (writer method).
%buffer-prev (reader method).
(setf %buffer-prev) (writer method).
buffer (class).
buffer-cycle (function).
buffer-find-next-if (function).
buffer-find-previous-if (function).
buffer-next (function).
buffer-peek (function).
buffer-previous (function).
buffer-push (function).
copy-buffer (function).
ensure-buffer (function).
linedit/command-keys.lisppackages.lisp (file).
linedit (system).
*commands* (special variable).
defcommand (macro).
linedit/editor.lispbackend.lisp (file).
rewindable.lisp (file).
line.lisp (file).
buffer.lisp (file).
command-keys.lisp (file).
linedit (system).
initialize-instance (method).
*announced* (special variable).
*aux-prompt* (special variable).
*debug-info* (special variable).
*history* (special variable).
*killring* (special variable).
*last-command* (special variable).
*version* (special variable).
dumb-editor (class).
editor (class).
editor-commands (reader method).
editor-complete (function).
editor-completer (reader method).
editor-history (reader method).
(setf editor-history) (writer method).
editor-insert-mode (reader method).
(setf editor-insert-mode) (writer method).
editor-interrupt (function).
editor-killring (reader method).
(setf editor-killring) (writer method).
editor-last-yank (reader method).
(setf editor-last-yank) (writer method).
editor-mark (reader method).
(setf editor-mark) (writer method).
editor-next-word-end (function).
editor-previous-word-start (function).
editor-prompt (reader method).
(setf editor-prompt) (writer method).
editor-replace-word (function).
editor-sexp-end (function).
editor-sexp-start (function).
editor-stop (function).
editor-word (function).
editor-word-end (function).
editor-word-start (function).
editor-yank (reader method).
(setf editor-yank) (writer method).
forget-yank (function).
get-finished-string (function).
in-quoted-string-p (function).
make-editor (function).
next-chord (function).
redraw-line (function).
remember-yank (function).
rewind-state (method).
save-state (function).
smart-editor (class).
try-yank (function).
with-editor-point-and-string (macro).
linedit/main.lispeditor.lisp (file).
linedit (system).
*editor* (special variable).
*level* (special variable).
colon-reader (function).
semicolon-reader (function).
linedit/complete.lisputility-macros.lisp (file).
linedit (system).
directory-complete (function).
lisp-complete (function).
logical-pathname-complete (function).
logical-pathname-p (function).
tilde-expand-string (function).
underlying-directory-p (function).
linedit/command-functions.lispeditor.lisp (file).
linedit (system).
%yank (function).
*history-needle* (special variable).
*history-search* (special variable).
add-char (function).
apropos-word (function).
backward-sexp (function).
close-all-sexp (function).
complete (function).
copy-region (function).
cut-region (function).
delete-char-backwards (function).
delete-char-forwards (function).
delete-char-forwards-or-eof (function).
delete-word-backwards (function).
delete-word-forwards (function).
describe-word (function).
downcase-word (function).
finish-input (function).
forward-sexp (function).
help (function).
history-next (function).
history-previous (function).
history-search (function).
history-search-needle (function).
interrupt-lisp (function).
kill-sexp (function).
kill-to-bol (function).
kill-to-eol (function).
move-char-left (function).
move-char-right (function).
move-to-bol (function).
move-to-eol (function).
move-word-backwards (function).
move-word-forwards (function).
search-history-backwards (function).
search-history-forwards (function).
set-mark (function).
stop-lisp (function).
toggle-insert (function).
undo (function).
unknown-command (function).
upcase-word (function).
yank (function).
yank-cycle (function).
linedit/ports/sbcl.lisp:sbcl
ports (module).
install-repl (function).
uninstall-repl (function).
linedit/ports/ccl.lisplinedit/ports/generic.lisp(:not (:or :sbcl :ccl))
ports (module).
Packages are listed by definition order.
lineditcommon-lisp.
osicat.
*default-columns* (special variable).
*default-lines* (special variable).
*highlight-color* (special variable).
end-debug (function).
formedit (function).
install-repl (function).
linedit (function).
start-debug (function).
uninstall-repl (function).
%buffer-list (generic reader).
(setf %buffer-list) (generic writer).
%buffer-next (generic reader).
(setf %buffer-next) (generic writer).
%buffer-pathname (generic reader).
(setf %buffer-pathname) (generic writer).
%buffer-prev (generic reader).
(setf %buffer-prev) (generic writer).
%rewind-count (function).
%rewind-index (generic reader).
(setf %rewind-index) (generic writer).
%rewind-store (generic reader).
%yank (function).
*announced* (special variable).
*aux-prompt* (special variable).
*commands* (special variable).
*debug* (special variable).
*debug-info* (special variable).
*editor* (special variable).
*history* (special variable).
*history-needle* (special variable).
*history-search* (special variable).
*killring* (special variable).
*last-command* (special variable).
*level* (special variable).
*terminal-translations* (special variable).
*version* (special variable).
*word-delimiters* (special variable).
+linedit-attr-error+ (special variable).
+linedit-memory-error+ (special variable).
+linedit-no-attr-error+ (special variable).
+linedit-not-atty+ (special variable).
+linedit-ok+ (special variable).
+linedit-tcgetattr-error+ (special variable).
+linedit-tcsetattr-error+ (special variable).
+terminal-bell+ (constant).
acase (macro).
add-char (function).
after-close-p (function).
aif (macro).
apropos-word (function).
at-delimiter-p (function).
at-open-p (function).
awhen (macro).
backend (class).
backend-close (generic function).
backend-columns (generic function).
backend-init (generic function).
backend-lines (generic function).
backend-ready-p (generic reader).
(setf backend-ready-p) (generic writer).
backend-translations (generic reader).
backward-sexp (function).
beep (generic function).
buffer (class).
buffer-cycle (function).
buffer-find-next-if (function).
buffer-find-previous-if (function).
buffer-next (function).
buffer-peek (function).
buffer-previous (function).
buffer-push (function).
c-terminal-close (function).
c-terminal-columns (function).
c-terminal-init (function).
c-terminal-lines (function).
c-terminal-winsize (function).
close-all-sexp (function).
colon-reader (function).
complete (function).
concat (function).
copy-buffer (function).
copy-region (function).
cut-region (function).
dbg (function).
dbg-values (macro).
defcommand (macro).
deftrans (macro).
delete-char-backwards (function).
delete-char-forwards (function).
delete-char-forwards-or-eof (function).
delete-word-backwards (function).
delete-word-forwards (function).
describe-word (function).
directory-complete (function).
dirty-p (generic reader).
(setf dirty-p) (generic writer).
display (generic function).
do-internal-symbols (macro).
downcase-word (function).
dumb-editor (class).
dumb-terminal (class).
dwim-mark-parens (function).
dwim-match-parens (function).
editor (class).
editor-commands (generic reader).
editor-complete (function).
editor-completer (generic reader).
editor-history (generic reader).
(setf editor-history) (generic writer).
editor-insert-mode (generic reader).
(setf editor-insert-mode) (generic writer).
editor-interrupt (function).
editor-killring (generic reader).
(setf editor-killring) (generic writer).
editor-last-yank (generic reader).
(setf editor-last-yank) (generic writer).
editor-mark (generic reader).
(setf editor-mark) (generic writer).
editor-next-word-end (function).
editor-previous-word-start (function).
editor-prompt (generic reader).
(setf editor-prompt) (generic writer).
editor-replace-word (function).
editor-sexp-end (function).
editor-sexp-start (function).
editor-stop (function).
editor-word (function).
editor-word-end (function).
editor-word-start (function).
editor-yank (generic reader).
(setf editor-yank) (generic writer).
ensure (macro).
ensure-buffer (function).
eof-handler (function).
find-close-paren (function).
find-close-quote (function).
find-col (function).
find-open-paren (function).
find-open-quote (function).
find-row (function).
finish-input (function).
fix-wraparound (function).
forget-yank (function).
forward-sexp (function).
get-finished-string (function).
get-point (generic reader).
(setf get-point) (generic function).
get-start (generic reader).
(setf get-start) (generic writer).
get-string (generic reader).
(setf get-string) (generic function).
help (function).
history-next (function).
history-previous (function).
history-search (function).
history-search-needle (function).
in-quoted-string-p (function).
interrupt-lisp (function).
invariant (macro).
kill-sexp (function).
kill-to-bol (function).
kill-to-eol (function).
last-state (function).
line (class).
lisp-complete (function).
logical-pathname-complete (function).
logical-pathname-p (function).
make-editor (function).
make-whitespace (function).
min* (function).
move-char-left (function).
move-char-right (function).
move-in-column (function).
move-to-bol (function).
move-to-eol (function).
move-word-backwards (function).
move-word-forwards (function).
newline (generic function).
next-chord (function).
old-markup (generic reader).
(setf old-markup) (generic writer).
old-point (generic reader).
(setf old-point) (generic writer).
old-string (generic reader).
(setf old-string) (generic writer).
page (generic function).
paren-count-delta (function).
paren-style (function).
place-point (function).
print-in-columns (generic function).
print-in-lines (generic function).
quoted-p (function).
read-chord (generic function).
redraw-line (function).
remember-yank (function).
required (function).
rewind-state (generic function).
rewindable (class).
save-rewindable-state (function).
save-state (function).
search-history-backwards (function).
search-history-forwards (function).
semicolon-reader (function).
set-column-address (function).
set-mark (function).
smart-editor (class).
smart-terminal (class).
smart-terminal-p (function).
stop-lisp (function).
terminal (class).
tilde-expand-string (function).
toggle-insert (function).
try-yank (function).
underlying-directory-p (function).
undo (function).
unknown-command (function).
upcase-word (function).
whitespacep (function).
with-backend (macro).
with-editor-point-and-string (macro).
with-unique-names (macro).
without-backend (macro).
word-delimiter-p (function).
yank (function).
yank-cycle (function).
yes-or-no (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Color to use for highlighting parentheses. NIL is the current foreground color bolded, other options are terminal colors :BLACK, :RED, :GREEN, :YELLOW, :BLUE, :MAGENTA, :CYAN, and :WHITE.
End linedit debugging output.
Reads a single form (s-expession) of input with line-editing from
standard input of the process and returns it as a string.
Results are unspecified if *STANDARD-INPUT* has been bound or altered,
or if *READTABLE* is not the standard readtable.
PROMPT1 specifies the string to print to *STANDARD-OUTPUT* before
starting the accept input.
PROMPT2 specifies the string to print to *STANDARD-OUTPUT* when input spans multiple lines (ie. prefixing every but first line of input.)
HISTORY and KILLRING can be pathname designators, in which case
they indicate the file to use for history and killring persistence,
respectively.
Further keyword arguments to FORMEDIT are an advanced and undocumented topic, but if you’re willing to dive into sources you can eg. use multiple kill-rings not shared between different invocations of FORMEDIT, or change the function responsible for providing input completion.
Reads a single line of input with line-editing from standard input
of the process and returns it as a string.
Results are unspecified if *STANDARD-INPUT* has been bound or altered.
PROMPT specifies the string to print to *STANDARD-OUTPUT* before
starting the accept input.
HISTORY and KILLRING can be pathname designators, in which case
they indicate the file to use for history and killring persistence,
respectively.
Further keyword arguments to LINEDIT are an advanced and undocumented topic, but if you’re willing to dive into sources you can eg. use multiple kill-rings not shared between different invocations of LINEDIT, or change the function responsible for providing input completion.
Start linedit debugging output to pathname, with additional open-args passed to ‘open’.
Returns the index just beyond the last letter of current or next word, if the point was between words.
Returns the index of the first letter of current or previous word, if the point was at the start of a word or between words.
Returns the current word the point is in or right after, or an empty string.
Returns the index just beyond the current word or the point if point is not inside a word.
Returns the index of the first letter of current or previous word, if the point is just after a word, or the point.
Like min, except ignores NILs.
Returns the supplied string, with a prefix of ~ or ~user expanded to the appropriate home directory.
Like Y-OR-N-P, but using linedit functionality.
rewindable)) ¶automatically generated reader method
rewindable)) ¶automatically generated writer method
rewindable)) ¶automatically generated reader method
smart-terminal)) ¶dumb-terminal) &key prompt line point &allow-other-keys) ¶smart-terminal) &key prompt line point markup) ¶smart-terminal)) ¶automatically generated reader method
smart-terminal)) ¶automatically generated writer method
smart-terminal)) ¶automatically generated reader method
smart-terminal)) ¶automatically generated writer method
smart-terminal)) ¶automatically generated reader method
smart-terminal)) ¶automatically generated writer method
rewindable)) ¶editor-commands.
editor-completer.
(setf editor-history).
editor-history.
(setf editor-insert-mode).
editor-insert-mode.
(setf editor-killring).
editor-killring.
(setf editor-last-yank).
editor-last-yank.
(setf editor-mark).
editor-mark.
(setf editor-prompt).
editor-prompt.
(setf editor-yank).
editor-yank.
initialize-instance.
rewind-state.
linedit::*commands*
:commands
This slot is read-only.
(quote linedit::lisp-complete)
:complete
This slot is read-only.
t
:insert-mode
""
:prompt
| Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U W Y |
|---|
| Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U W Y |
|---|
| Jump to: | *
+
C D H I K L M N O P R S T Y |
|---|
| Jump to: | *
+
C D H I K L M N O P R S T Y |
|---|
| Jump to: | B C D E F G L M P R S T U |
|---|
| Jump to: | B C D E F G L M P R S T U |
|---|