File: readline.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (237 lines) | stat: -rw-r--r-- 7,433 bytes parent folder | download
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.readline">
  <title>GNU Readline</title>
  <titleabbrev>Readline</titleabbrev>

  <partintro>
   <simpara>
    Die <function>readline</function> Funktionen realisieren eine
    Schnittstelle zur GNU Readline Bibliothek. Diese Funktionen bieten
    die Mglichkeit Kommandozeilen zu editieren. Ein Beispiel fr die
    Anwendung ist die Art und Weise, wie die Bash es erlaubt, die
    Pfeiltasten zu benutzen um Schriftzeichen einzufgen oder durch
    die Kommando-History zu scrollen. Auf Grund des interaktiven
    Charakters dieser Bibliothek ist diese von geringem Nutzen beim
    Programmieren von Webanwendungen, kann aber ntzlich sein, wenn
    Sie Skripte schreiben, die dafr gedacht sind in einer Shell
    abzulaufen.
   </simpara>
   <simpara>
    Die Homepage des GNU Readline Projekts finden Sie unter
    <ulink url="&url.readline;">&url.readline;</ulink>. Das Projekt
    wird von Chet Ramey betreut, der auerdem der Autor der Bash ist.
   </simpara>
  </partintro>

  <refentry id="function.readline">
   <refnamediv>
    <refname>readline</refname>
    <refpurpose>Liest eine Zeile</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>readline</methodname>
      <methodparam choice="opt"><type>string</type><parameter>prompt</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion gibt eine einzelne Zeichenkette vom Benutzer
     zurck. Sie knnen eine Zeichenkette angeben, mit dem Sie den
     Benutzer zur Eingabe auffordern. Der Zeile die Sie erhalten
     fehlt das abschlieende Zeichen fr einen Zeilenvorschub. Die
     Zeile mssen Sie selbst mit Hilfe der Funktion
     <function>readline_add_history</function> der History hinzufgen.
    </para>
    <example>
     <title><function>readline</function></title>
     <programlisting role="php">
<![CDATA[
//abfragen von 3 Kommandos vom Benutzer
for ($i=0; $i <; 3; $i++) {
        $zeile = readline ("Kommando: ");
        readline_add_history ($line);
}

//anzeigen der History
print_r (readline_list_history());

//anzeigen der Variablen
print_r (readline_info());
]]>
     </programlisting>
    </example>
   </refsect1>
  </refentry>

  <refentry id="function.readline-add-history">
   <refnamediv>
    <refname>readline_add_history</refname>
    <refpurpose>Fgt eine Zeile zur History hinzu</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>readline_add_history</methodname>
      <methodparam><type>string</type><parameter>zeile</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion fgt eine Zeile zur Kommandozeilen-History hinzu.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-clear-history">
   <refnamediv>
    <refname>readline_clear_history</refname>
    <refpurpose>Lscht die History</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_clear_history</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Diese Funktion lscht die gesamte Kommandozeilen-History.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-completion-function">
   <refnamediv>
    <refname>readline_completion_function</refname>
    <refpurpose>Registriert eine Vervollstndigungsfunktion
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_completion_function</methodname>
      <methodparam><type>string</type><parameter>zeile</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion registriert eine Vervollstndigungsfunktion. Sie
     mssen den Namen einer existierenden Funktion angeben, die einen
     Teil einer Kommandozeile akzeptiert und ein Array mglicher
     bereinstimmungen zurckgibt.
     Das ist die gleiche Art von Funktionalitt die Sie haben, wenn
     Sie die Tab-Taste benutzen, whrend Sie mit der Bash arbeiten.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-info">
   <refnamediv>
    <refname>readline_info</refname>
    <refpurpose>Liest/Setzt verschiedene interne readline
    Variablen</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>mixed</type><methodname>readline_info</methodname>
      <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>neuerwert</parameter></methodparam>
     </methodsynopsis>
    <para>
     Wenn diese Funktion ohne Parameter aufgerufen wird, gibt sie
     einen Array von Werten fr alle Einstellungen zurck, die
     readline benutzt. Die Elemente werden durch die folgenden Werte
     indiziert:
     done, end, erase_empty_line, library_version, line_buffer, mark,
     pending_input, point, prompt, readline_name und terminal_name.
    </para>
    <para>
     Wird die Funktion mit einem Parameter aufgerufen, wird der Wert
     dieser Einstellung zurckgegeben.
     Beim Aufruf mit zwei Parametern wird die Einstellung auf den
     angegebenen Wert gendert.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-list-history">
   <refnamediv>
    <refname>readline_list_history</refname>
    <refpurpose>Auflistung der History</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>readline_list_history</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Diese Funktion gibt ein Array der gesamten Kommandozeilen-History
     zurck. Die Elemente sind numerisch(integer) indiziert, beginnend bei
     Null.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-read-history">
   <refnamediv>
    <refname>readline_read_history</refname>
    <refpurpose>Liest die History</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_read_history</methodname>
      <methodparam><type>string</type><parameter>dateiname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liest eine Kommando-History aus einer Datei.
    </para>
   </refsect1>
  </refentry>


  <refentry id="function.readline-write-history">
   <refnamediv>
    <refname>readline_write_history</refname>
    <refpurpose>Schreibt die History</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_write_history</methodname>
      <methodparam><type>string</type><parameter>dateiname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion schreibt die Kommando-History in eine Datei.
    </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:
-->