/usr/share/gtk-doc/html/seed/readline-module.html is in seed-doc 3.2.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>readline</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Seed Reference Manual">
<link rel="up" href="modules.html" title="Part IV. Seed Module Reference">
<link rel="prev" href="modules.html" title="Part IV. Seed Module Reference">
<link rel="next" href="sqlite-module.html" title="SQLite">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="modules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Seed Reference Manual</th>
<td><a accesskey="n" href="sqlite-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="readline-module"></a>readline</h2></div>
<div><div class="author">
<h3 class="author">
<span class="firstname">Robert</span> <span class="surname">Carr</span>
</h3>
<div class="affiliation"><div class="address"><p><br>
<code class="email"><<a class="email" href="mailto:racarr@gnome.org">racarr@<em class="parameter"><code>gnome.org</code></em></a>></code><br>
</p></div></div>
</div></div>
</div></div>
<div class="refsect1">
<a name="idp5409504"></a><h2>API Reference</h2>
<p>
The readline module allows for basic usage of the GNU readline library, in Seed. More advanced features may be added a a later time. In order to use the readline module it must be first imported.
</p>
<pre class="programlisting">
readline = imports.readline;
</pre>
<p>
</p>
<p>
</p>
<div class="refsect2">
<a name="readline-readline"></a><h3>readline.readline (prompt)</h3>
<p>Prompts for one line of input on standard input using <em class="parameter"><code>prompt</code></em> as the prompt.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>prompt</code></em></span></p></td>
<td>undefined</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span></span></p></td>
<td>A string entered on standard input.</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
<hr>
<div class="refsect2">
<a name="readline-bind"></a><h3>readline.bind (key, function)</h3>
<p>Binds <em class="parameter"><code>key</code></em> to <em class="parameter"><code>function</code></em> causing the function to be invokved whenever <em class="parameter"><code>key</code></em> is pressed</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em></span></p></td>
<td>undefined</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em></span></p></td>
<td>undefined</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
<hr>
<div class="refsect2">
<a name="readline-done"></a><h3>readline.done ()</h3>
<p>Indicates that readline should finish the current line, and return from <em class="parameter"><code>readline.readline</code></em>. Can be used in callbacks to implement features like multiline editing</p>
</div>
<p>
</p>
<hr>
<div class="refsect2">
<a name="readline-buffer"></a><h3>readline.buffer()</h3>
<p>Retrieve the current readline buffer</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span></span></p></td>
<td>The current readline buffer</td>
</tr></tbody>
</table></div>
</div>
<p>
</p>
<hr>
<div class="refsect2">
<a name="readline-insert"></a><h3>readline.insert (string)</h3>
<p>Inserts <em class="parameter"><code>string</code></em> in to the current readline buffer</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em></span></p></td>
<td>undefined</td>
</tr></tbody>
</table></div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="idp9336384"></a><h2>Examples</h2>
<p>Below are several examples of using the Seed readline module. For additional resources, consult the examples/ folder of the Seed source</p>
<div class="example">
<a name="readline-repl-example"></a><p class="title"><b>Example 14. </b></p>
<div class="example-contents">
<p>This demonstrates a simple REPL using the readline module</p>
<pre class="programlisting">
readline = imports.readline;
while (1){
try{
eval(readline.readline("> "));
}
catch(e) {
print(e.name + " " + e.message);
}
}
</pre>
</div>
</div>
<br class="example-break">
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|