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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.9 $ -->
<reference id="ref.readline">
<title>GNU Readline</title>
<titleabbrev>Readline</titleabbrev>
<partintro>
<simpara>
<function>readline</function> 関数はGNU Readline ライブラリへのイ
ンターフェースを実装したものです。これらの関数は、コマンドラインの
編集機能を提供します。一例をあげると、Bash において文字を挿入した
り、コマンド履歴を走査したりする際に矢印キーを使用することを可能に
しているものです。このライブラリの対話的性質のためにWebアプリケー
ションではあまり使用されていませんが、シェルで動作することを目的と
したスクリプトを書く際には便利です。
</simpara>
<simpara>
GNU Readline プロジェクトのホームページは、
<ulink url="&url.readline;">&url.readline;</ulink>にあります。この
ライブラリは、Bash の作者でもある Chet Ramey により管理されています。
</simpara>
</partintro>
<refentry id="function.readline">
<refnamediv>
<refname>readline</refname>
<refpurpose>1行読み込む</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>string</type><methodname>readline</methodname>
<methodparam><type>string</type><parameter>
<replaceable><optional>prompt</optional></replaceable>
</parameter></methodparam>
</methodsynopsis>
<para>
この関数は、ユーザから取得した文字列を一つだけ返します。ユーザに
示すプロンプトを文字列で指定することも可能です。返される行は終端
の改行文字が削除されています。この行を
<function>readline_add_history</function>を用いてヒストリに追加す
る必要があります。
</para>
<example>
<title><function>readline</function></title>
<programlisting role="php">
<![CDATA[
// ユーザから3回コマンドを取得
for ($i=0; $i < 3; $i++) {
$line = readline ("Command: ");
readline_add_history ($line);
}
// ヒストリをダンプ
print_r(readline_list_history());
// 変数をダンプ
print_r(readline_info());
]]>
</programlisting>
</example>
</refsect1>
</refentry>
<refentry id="function.readline-add-history">
<refnamediv>
<refname>readline_add_history</refname>
<refpurpose>ヒストリに1行追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>void</type><methodname>readline_add_history</methodname>
<methodparam><type>string</type><parameter>line</parameter></methodparam>
</methodsynopsis>
<para>
この関数は、コマンドラインヒストリに1行追加します。
</para>
</refsect1>
</refentry>
<refentry id="function.readline-clear-history">
<refnamediv>
<refname>readline_clear_history</refname>
<refpurpose>ヒストリをクリアする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>bool</type><methodname>readline_clear_history</methodname>
<void/>
</methodsynopsis>
<para>
この関数はコマンドラインヒストリ全体をクリアします。
</para>
</refsect1>
</refentry>
<refentry id="function.readline-completion-function">
<refnamediv>
<refname>readline_completion_function</refname>
<refpurpose>補完関数を登録する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>bool</type><methodname>readline_completion_function</methodname>
<methodparam><type>string</type><parameter>line</parameter></methodparam>
</methodsynopsis>
<para>
この関数は補完用の関数を登録します。コマンドラインの一部を入力と
し、マッチする可能性がある文字列の配列を返す既存の関数の名前を指
定する必要があります。これは、Bashを使用している際に、タブキーを
押して得られる機能と同じ種類のものです。
</para>
</refsect1>
</refentry>
<refentry id="function.readline-info">
<refnamediv>
<refname>readline_info</refname>
<refpurpose>種々のreadlineの内部変数を取得/設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>mixed</type><methodname>readline_info</methodname>
<methodparam><type>string</type><parameter>
<replaceable><optional>varname</optional></replaceable>
</parameter></methodparam>
<methodparam><type>string</type><parameter>
<replaceable><optional>newvalue</optional></replaceable>
</parameter></methodparam>
</methodsynopsis>
<para>
パラメータを指定しないでコールした場合、この関数は readline が使
用する全ての設定の値を配列で返します。要素の添字は次のようになり
ます。:
done, end, erase_empty_line, library_version,
line_buffer, mark, pending_input, point, prompt, readline_name,
terminal_name
</para>
<para>
引数を1つ指定してコールした場合、その設定に関する値が返されます。
引数を2つ指定してコールした場合、その設定の値は指定した値に変更さ
れます。
</para>
</refsect1>
</refentry>
<refentry id="function.readline-list-history">
<refnamediv>
<refname>readline_list_history</refname>
<refpurpose>ヒストリのリスト</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>array</type><methodname>readline_list_history</methodname>
<void/>
</methodsynopsis>
<para>
この関数は、コマンドラインヒストリ全体の配列を返します。各要素は、
ゼロから始まる整数で添字が付加されています。
</para>
</refsect1>
</refentry>
<refentry id="function.readline-read-history">
<refnamediv>
<refname>readline_read_history</refname>
<refpurpose>ヒストリを読み込む</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>bool</type><methodname>readline_read_history</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
この関数は、コマンドヒストリをファイルから読み込みます。
</para>
</refsect1>
</refentry>
<refentry id="function.readline-write-history">
<refnamediv>
<refname>readline_write_history</refname>
<refpurpose>ヒストリを書きこむ</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<methodsynopsis>
<type>boolean</type><methodname>readline_write_history</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
この関数はコマンドヒストリをファイルに書き込みます。
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
