reference/readline/functions/readline-info.xml
d8ba69fe4e7c835bc2b76dcd908597f75d1c65a1
d8ba69fe4e7c835bc2b76dcd908597f75d1c65a1
...
...
@@ -10,8 +10,8 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>mixed</type><methodname>readline_info</methodname>
13
-
<methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>newvalue</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>var_name</parameter><initializer>&null;</initializer></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>int</type><type>string</type><type>bool</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
Gets or sets various internal readline variables.
...
...
@@ -23,7 +23,7 @@
23
23
<para>
24
24
<variablelist>
25
25
<varlistentry>
26
-
<term><parameter>varname</parameter></term>
26
+
<term><parameter>var_name</parameter></term>
27
27
<listitem>
28
28
<para>
29
29
A variable name.
...
...
@@ -31,7 +31,7 @@
31
31
</listitem>
32
32
</varlistentry>
33
33
<varlistentry>
34
-
<term><parameter>newvalue</parameter></term>
34
+
<term><parameter>value</parameter></term>
35
35
<listitem>
36
36
<para>
37
37
If provided, this will be the new value of the setting.
...
...
@@ -46,18 +46,41 @@
46
46
&reftitle.returnvalues;
47
47
<para>
48
48
If called with no parameters, this function returns an array of
49
-
values for all the setting readline uses. The elements will
50
-
be indexed by the following values: done, end, erase_empty_line,
51
-
library_version, line_buffer, mark, pending_input, point, prompt,
52
-
readline_name, and terminal_name.
49
+
values for all the settings readline uses. The elements will
50
+
be indexed by the following values: <literal>done</literal>, <literal>end</literal>, <literal>erase_empty_line</literal>,
51
+
<literal>library_version</literal>, <literal>line_buffer</literal>, <literal>mark</literal>, <literal>pending_input</literal>, <literal>point</literal>, <literal>prompt</literal>,
52
+
<literal>readline_name</literal>, and <literal>terminal_name</literal>.
53
+
The &array; will only contain those elements which are supported by the library
54
+
used to built the readline extension.
53
55
</para>
54
56
<para>
55
57
If called with one or two parameters, the old value is returned.
56
58
</para>
57
59
</refsect1>
58
60
59
-
</refentry>
61
+
<refsect1 role="changelog">
62
+
&reftitle.changelog;
63
+
<informaltable>
64
+
<tgroup cols="2">
65
+
<thead>
66
+
<row>
67
+
<entry>&Version;</entry>
68
+
<entry>&Description;</entry>
69
+
</row>
70
+
</thead>
71
+
<tbody>
72
+
<row>
73
+
<entry>8.0.0</entry>
74
+
<entry>
75
+
<parameter>var_name</parameter> and <parameter>value</parameter> are nullable now.
76
+
</entry>
77
+
</row>
78
+
</tbody>
79
+
</tgroup>
80
+
</informaltable>
81
+
</refsect1>
60
82
83
+
</refentry>
61
84
<!-- Keep this comment at the end of the file
62
85
Local variables:
63
86
mode: sgml
64
87