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 (220 lines) | stat: -rw-r--r-- 7,106 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
<?xml version="1.0" encoding="iso-8859-2"?>
<!-- EN-Revision: 1.17 Maintainer: leon Status: ready -->
<!-- $Revision: 1.8 $ -->
 <reference id="ref.readline">
  <title>GNU Readline</title>
  <titleabbrev>Readline</titleabbrev>

  <partintro>
   <simpara>
    Funkcje <function>readline</function> implementuj interfejs do biblioteki
    GNU Readline. Funkcje te pozwalaj na tworzenie edytowalnych linii
    polece. Jako przykad moe posuy Bash, ktry pozwala na uywanie
    klawiszy strzaek do poruszania si po wpisanej czci polecenia lub
    przewijanie histrii. Ze wzgldu na interaktywno tej biblioteki, nie
    przyda si ona do pisania aplikacji sieciowych, lecz moe by przydatna do
    pisania skryptw ktre maj by uruchamiane z linii polece.
   </simpara>
   <simpara>
    Stron domow projektu GNU Readline mona znale pod adresem
    <ulink url="&url.readline;">&url.readline;</ulink>. Zajmuje si ni Chet
    Ramey, ktry jest take autorem Basha.
   </simpara>
  </partintro>

  <refentry id="function.readline">
   <refnamediv>
    <refname>readline</refname>
    <refpurpose>Czyta lini</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>string</type><methodname>readline</methodname>
      <methodparam choice="opt"><type>string</type><parameter>prompt</parameter></methodparam>
     </methodsynopsis>
    <para>
     Funkcja ta zwraca pojedyczy string pobrany od uytkownika. Jako parametr
     funkcji mona poda string zawierajcy prompt (znak zachty) ktry bdzie
     wywietlony. Zwracany string ma usunity z koca znak nowego wiersza.
     Musisz doda do lini do historii rcznie uywajc
     <function>readline_add_history</function>.
    </para>
    <example>
     <title><function>readline</function></title>
     <programlisting role="php">
<![CDATA[
//pobierz 3 komendy od uytkownika
for ($i=0; $i < 3; $i++) {
        $line = readline ("Komenda: ");
        readline_add_history ($line);
}

//zrzu histori
print_r (readline_list_history());

//zrzu zmienne
print_r (readline_info());
]]>
     </programlisting>
    </example>
   </refsect1>
  </refentry>

  <refentry id="function.readline-add-history">
   <refnamediv>
    <refname>readline_add_history</refname>
    <refpurpose>Dodaje lini do historii</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>void</type><methodname>readline_add_history</methodname>
      <methodparam><type>string</type><parameter>linia</parameter></methodparam>
     </methodsynopsis>
    <para>
     Funkcja ta dodaje lini do historii linii polece.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-clear-history">
   <refnamediv>
    <refname>readline_clear_history</refname>
    <refpurpose>Czyci histori</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_clear_history</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Funkcja ta czyci ca histori linii polece.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-completion-function">
   <refnamediv>
    <refname>readline_completion_function</refname>
    <refpurpose>Rejestruje funkcj dopeniania</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_completion_function</methodname>
      <methodparam><type>string</type><parameter>linia</parameter></methodparam>
     </methodsynopsis>
    <para>
     Funkcja ta rejestruje funkcj dopeniania. Musisz poda nazw istniejcej
     funkcji, ktra przyjmuje jako parametr czciowo wypenion lini i
     zwraca tablic moliwych dopenie. Jest to efekt ktry mona
     zaobserwowa wciskajc klawisz TAB uywajc Basha.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-info">
   <refnamediv>
    <refname>readline_info</refname>
    <refpurpose>Pobiera/ustawia rne wewntrzne zmienne readline'a</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>mixed</type><methodname>readline_info</methodname>
      <methodparam choice="opt"><type>string</type><parameter>nazwa_zmiennej</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>nowa_warto</parameter></methodparam>
     </methodsynopsis>
    <para>
     Jeli funkcja zostanie wywoana bez parametrw, to zwrcona zostanie
     tablica z wartociami wszystkich ustawie biblioteki readline. Elementy
     tej tablicy bd miay takie indeksy:  done, end, erase_empty_line,
     library_version, line_buffer, mark, pending_input, point, prompt,
     readline_name, i terminal_name.
    </para>
    <para>
     Jeli zostanie wywoana z jednym parametrem, to zwrcona zostanie warto
     ustawienia podanego jako parametr. Jeli zostanie wywoana z dwoma
     paremetrami, zmienione zostanie podane ustawienie.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-list-history">
   <refnamediv>
    <refname>readline_list_history</refname>
    <refpurpose>Zwraca list historii</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>array</type><methodname>readline_list_history</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Funkcja ta zwraca tablic zawierajc ca histori linii polece.
     Elementy s indeksowane przez liczby cakowite poczynajc od zera.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.readline-read-history">
   <refnamediv>
    <refname>readline_read_history</refname>
    <refpurpose>Czyta histori</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_read_history</methodname>
      <methodparam><type>string</type><parameter>nazwa_pliku</parameter></methodparam>
     </methodsynopsis>
    <para>
     Funkcja ta czyta histori polece z pliku.
    </para>
   </refsect1>
  </refentry>


  <refentry id="function.readline-write-history">
   <refnamediv>
    <refname>readline_write_history</refname>
    <refpurpose>Zapisuje histori</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Opis</title>
     <methodsynopsis>
      <type>bool</type><methodname>readline_write_history</methodname>
      <methodparam><type>string</type><parameter>nazwa_pliku</parameter></methodparam>
     </methodsynopsis>
    <para>
     Funkcja ta zapisuje histori polece do pliku.
    </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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->