1
0
Fork 0
cl-sites/guile.html_node/Readline-Options.html
2024-12-17 12:49:28 +01:00

96 lines
5 KiB
HTML

<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual documents Guile version 3.0.10.
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
Inc.
Copyright (C) 2021 Maxime Devos
Copyright (C) 2024 Tomas Volf
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License." -->
<title>Readline Options (Guile Reference Manual)</title>
<meta name="description" content="Readline Options (Guile Reference Manual)">
<meta name="keywords" content="Readline Options (Guile Reference Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content=".texi2any-real">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Readline-Support.html" rel="up" title="Readline Support">
<link href="Readline-Functions.html" rel="next" title="Readline Functions">
<link href="Loading-Readline-Support.html" rel="prev" title="Loading Readline Support">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="Readline-Options">
<div class="nav-panel">
<p>
Next: <a href="Readline-Functions.html" accesskey="n" rel="next">Readline Functions</a>, Previous: <a href="Loading-Readline-Support.html" accesskey="p" rel="prev">Loading Readline Support</a>, Up: <a href="Readline-Support.html" accesskey="u" rel="up">Readline Support</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Readline-Options-1"><span>7.9.2 Readline Options<a class="copiable-link" href="#Readline-Options-1"> &para;</a></span></h4>
<a class="index-entry-id" id="index-readline-options"></a>
<p>The readline interface module can be tweaked in a few ways to better
suit the user&rsquo;s needs. Configuration is done via the readline module&rsquo;s
options interface, in a similar way to the evaluator and debugging
options (see <a class="pxref" href="Runtime-Options.html">Runtime Options</a>).
</p>
<dl class="first-deffn">
<dt class="deffn" id="index-readline_002doptions"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">readline-options</strong><a class="copiable-link" href="#index-readline_002doptions"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-readline_002denable"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">readline-enable</strong> <var class="def-var-arguments">option-name</var><a class="copiable-link" href="#index-readline_002denable"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-readline_002ddisable"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">readline-disable</strong> <var class="def-var-arguments">option-name</var><a class="copiable-link" href="#index-readline_002ddisable"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-readline_002dset_0021"><span class="category-def">Scheme Syntax: </span><span><strong class="def-name">readline-set!</strong> <var class="def-var-arguments">option-name value</var><a class="copiable-link" href="#index-readline_002dset_0021"> &para;</a></span></dt>
<dd><p>Accessors for the readline options. Note that unlike the enable/disable
procedures, <code class="code">readline-set!</code> is syntax, which expects an unquoted
option name.
</p></dd></dl>
<p>Here is the list of readline options generated by typing
<code class="code">(readline-options 'help)</code> in Guile. You can also see the
default values.
</p>
<div class="example smalllisp lisp">
<pre class="lisp-preformatted">history-file yes Use history file.
history-length 200 History length.
bounce-parens 500 Time (ms) to show matching opening parenthesis
(0 = off).
bracketed-paste yes Disable interpretation of control characters
in pastes.
</pre></div>
<p>The readline options interface can only be used <em class="emph">after</em> loading
the readline module, because it is defined in that module.
</p>
</div>
</body>
</html>