georg Tue Dec 25 18:25:24 2001 EDT
Modified files:
/phpdoc/en/functions ncurses.xml
Log:
new functions documented.
Status: 30 Function documented, 84 still undocumented
Index: phpdoc/en/functions/ncurses.xml
diff -u phpdoc/en/functions/ncurses.xml:1.3 phpdoc/en/functions/ncurses.xml:1.4
--- phpdoc/en/functions/ncurses.xml:1.3 Sat Dec 22 13:02:35 2001
+++ phpdoc/en/functions/ncurses.xml Tue Dec 25 18:25:24 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<reference id="ref.ncurses">
<title>Ncurses terminal screen control functions</title>
<titleabbrev>ncurses functions</titleabbrev>
@@ -343,19 +343,23 @@
<refentry id="function.ncurses-erasechar">
<refnamediv>
<refname>ncurses_erasechar</refname>
- <refpurpose>Return current erase character </refpurpose>
+ <refpurpose>Returns current erase character </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>bool <function>ncurses_erasechar</function></funcdef>
+ <funcdef>string <function>ncurses_erasechar</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_erasechar</function> returns the current erase
+ char character.
+ </para>
+ <para>
+ See also: <function>ncurses_killchar</function>
</para>
</refsect1>
</refentry>
@@ -375,7 +379,12 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_flash</function> flashes the screen, and if
+ its not possible, sends an audible alert (bell).
+ Returns &false; on success, otherwise &true;.
+ </para>
+ <para>
+ See also: <function>ncurses_beep</function>
</para>
</refsect1>
</refentry>
@@ -395,7 +404,10 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ The <function>ncurses_flushinp</function> throws away any
+ typeahead that has been typed and has not yet been read by your
+ program.
+ Returns &false; on success, otherwise &true;.
</para>
</refsect1>
</refentry>
@@ -415,7 +427,11 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_has_colors</function> returns &true; or &false;
+ depending on whether the terminal has color capacitites.
+ </para>
+ <para>
+ See also: <function>ncurses_can_change_color</function>
</para>
</refsect1>
</refentry>
@@ -435,7 +451,12 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_has_ic</function> checks terminals insert- and
+ delete capabilitites. It returns &true; when terminal has
+ insert/delete-capabilities, otherwise &false;.
+ </para>
+ <para>
+ See also: <function>ncurses_has_il</function>
</para>
</refsect1>
</refentry>
@@ -455,7 +476,12 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_has_il</function> checks terminals insert- and
+ delete-line-capabilities. It returns &true; when terminal has
+ insert/delete-line capabilities, otherwise &false;
+ </para>
+ <para>
+ See also: <function>ncurses_has_ic</function>
</para>
</refsect1>
</refentry>
@@ -469,13 +495,14 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>bool <function>ncurses_inch</function></funcdef>
+ <funcdef>string <function>ncurses_inch</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_inch</function> returns the character from the
+ current position.
</para>
</refsect1>
</refentry>
@@ -495,7 +522,8 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_insertln</function> inserts a new line above
+ the current line. The bottom line will be lost.
</para>
</refsect1>
</refentry>
@@ -515,7 +543,14 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_isendwin</function> returns &true;, if
+ <function>ncurses_endwin</function> has been called without any
+ subsequent calls to <function>ncurses_wrefresh</function>,
+ otherwise &false;.
+ </para>
+ <para>
+ See also: <function>ncurses_endwin</function>
+ <function>ncurses_wrefresh()</function>
</para>
</refsect1>
</refentry>
@@ -523,7 +558,7 @@
<refentry id="function.ncurses-killchar">
<refnamediv>
<refname>ncurses_killchar</refname>
- <refpurpose>Return current line kill character </refpurpose>
+ <refpurpose>Returns current line kill character </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -535,7 +570,11 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_killchar</function> returns the current line
+ kill character.
+ </para>
+ <para>
+ See also: <function>ncurses_erasechar</function>
</para>
</refsect1>
</refentry>
@@ -575,7 +614,15 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_nocbreak</function> routine returns terminal to
+ normal (cooked) mode. Initially the terminal may or may not in
+ cbreak mode as the mode is inherited. Therefore a program should
+ call <function>ncurses_cbreak</function> and
+ <function>ncurses_nocbreak</function> explicitly.
+ Returns &true; if any error occured, otherwise &false;.
+ </para>
+ <para>
+ See also: <function>ncurses_cbreak</function>
</para>
</refsect1>
</refentry>
@@ -595,7 +642,13 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_noecho</function> prevents echoing of user
+ typed characters.
+ Returns &true; if any error occured, otherwise &false;.
+ </para>
+ <para>
+ See also: <function>ncurses_echo</function>,
+ <function>ncurses_getch</function>
</para>
</refsect1>
</refentry>
@@ -603,7 +656,7 @@
<refentry id="function.ncurses-nonl">
<refnamediv>
<refname>ncurses_nonl</refname>
- <refpurpose>Do not ranslate newline and carriage return / line feed </refpurpose>
+ <refpurpose>Do not translate newline and carriage return / line feed </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -635,7 +688,18 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_noraw</function> switches the terminal out of raw
+ mode. Raw mode is similar to cbreak mode, in that characters
+ typed are immediately passed through to the user program. The
+ differences that are that in raw mode, the interrupt, quit,
+ suspend and flow control characters are all passed through
+ uninterpreted, instead of generating a signal.
+ Returns &true; if any error occured, otherwise &false;.
+ </para>
+ <para>
+ See also: <function>ncurses_raw</function>,
+ <function>ncurses_cbreak</function>,
+ <function>ncurses_nocbreak</function>
</para>
</refsect1>
</refentry>
@@ -655,7 +719,18 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_raw</function> places the terminal in raw
+ mode. Raw mode is similar to cbreak mode, in that characters
+ typed are immediately passed through to the user program. The
+ differences that are that in raw mode, the interrupt, quit,
+ suspend and flow control characters are all passed through
+ uninterpreted, instead of generating a signal.
+ Returns &true; if any error occured, otherwise &false;.
+ </para>
+ <para>
+ See also: <function>ncurses_noraw</function>,
+ <function>ncurses_cbreak</function>,
+ <function>ncurses_nocbreak</function>
</para>
</refsect1>
</refentry>
@@ -823,7 +898,7 @@
<refentry id="function.ncurses-termattrs">
<refnamediv>
<refname>ncurses_termattrs</refname>
- <refpurpose>Return a logical OR of all attribute flags supported by terminal
</refpurpose>
+ <refpurpose>Returns a logical OR of all attribute flags supported by terminal
+</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -1046,7 +1121,7 @@
<refentry id="function.ncurses-baudrate">
<refnamediv>
<refname>ncurses_baudrate</refname>
- <refpurpose>Return baudrate of terminal </refpurpose>
+ <refpurpose>Returns baudrate of terminal </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -1078,7 +1153,12 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_beep</function> sends an audlible alert (bell)
+ and if its not possible flashes the screen.
+ Returns &false; on success, otherwise &true;.
+ </para>
+ <para>
+ See also: <function>ncurses_flash</function>
</para>
</refsect1>
</refentry>
@@ -1500,7 +1580,7 @@
<refentry id="function.ncurses-instr">
<refnamediv>
<refname>ncurses_instr</refname>
- <refpurpose>Read string from terminal screen </refpurpose>
+ <refpurpose>Reads string from terminal screen </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -1512,7 +1592,11 @@
</funcsynopsis>
&warn.experimental.func;
<para>
- undocumented
+ <function>ncurses_instr</function> returns the number of
+ charaters read from the current character position until end of
+ line.
+ <parameter>buffer</parameter> contains the characters. Atrributes
+ are stripped from the characters.
</para>
</refsect1>
</refentry>
@@ -2390,7 +2474,7 @@
</refsect1>
</refentry>
- <refentry id="function.ncurses-use-env">
+<refentry id="function.ncurses-use-env">
<refnamediv>
<refname>ncurses_use_env</refname>
<refpurpose>Control use of environment information about terminal size
</refpurpose>
@@ -2410,8 +2494,7 @@
</refsect1>
</refentry>
- </reference>
-
+</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
