From e58a6fb09fe0d3310f742a907e06b51a8d90238a Mon Sep 17 00:00:00 2001
From: Georg Richter <georg@php.net>
Date: Sat, 22 Dec 2001 18:02:35 +0000
Subject: [PATCH] Documentation for the following functions:
 ncurses_can_change_color ncurses_cbreak ncurses_clear ncurses_clrtobot
 ncurses_clrtoeol ncurses_def_rpog_mode ncurses_def_shell_mode ncurses_delch
 ncurses_deleteln ncurses_doupdate ncurses_echo ncurses_erase

Status: 12 functions documented
        102 functions still undocumented


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@65988 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/ncurses.xml | 118 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 104 insertions(+), 14 deletions(-)

diff --git a/functions/ncurses.xml b/functions/ncurses.xml
index d2e39087a2..84d26618ef 100644
--- a/functions/ncurses.xml
+++ b/functions/ncurses.xml
@@ -1,11 +1,23 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
  <reference id="ref.ncurses">
   <title>Ncurses terminal screen control functions</title>
   <titleabbrev>ncurses functions</titleabbrev>
   
   <partintro>
    <para>
+   ncurses (new curses) is a free software emulation of curses in
+   System V Rel 4.0 (and above). It uses terminfo format, supports pads, colors, multiple
+   highlights, form characters and function key mapping.
+   </para>
+   <para>
+    To get these functions to work, you have to compile the CGI
+    version of PHP with <option
+    role="configure">--with-ncurses</option>.
+    That requires the ncurses library to be installed. Download the
+    latest version from <ulink
+    url="&url.ncurses;">&url.ncurses;</ulink>,
+    compile and install it.
    </para>
   </partintro>
   
@@ -25,7 +37,9 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+     The function <function>ncurses_can_change_color</function> returns 
+     &true; or &false;, depending on whether the terminal has color
+     capabilities and whether the programmer can change the colors.
     </para>
    </refsect1>
   </refentry>
@@ -45,7 +59,17 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_cbreak</function> disables line buffering and
+    character processing (interrupt and flow control characters are
+    unaffected), making characters typed by the user immediately
+    available to the program.
+    </para>
+    <para>
+    <function>ncurses_cbreak</function> returns &true; if any error
+    occured, otherwise &false;.
+    </para>
+    <para>
+    See also: <function>ncurses_nocbreak</function>
     </para>
    </refsect1>
   </refentry>
@@ -65,7 +89,16 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_clear</function> clears the screen completely
+    without setting blanks. Returns &false; on success, otherwise &true;.     
+    </para>
+    <para>
+    Note: <function>ncurses_clear</function> clears the screen without
+    setting blanks, which have the current background rendition. To
+    clear screen with blanks, use <function>ncurses_erase</function>.
+    </para>
+    <para>
+    See also: <function>ncurses_erase</function>
     </para>
    </refsect1>
   </refentry>
@@ -85,7 +118,14 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_clrtobot</function> erases all lines from cursor
+    to end of screen and creates blanks. Blanks created by 
+    <function>ncurses_clrtobot</function> have the current background
+    rendition. Returns &true; if any error occured, otherwise &false;.
+    </para>
+    <para>
+    See also: <function>ncurses_clear</function>, 
+    <function>ncurses_clrtoeol</function>
     </para>
    </refsect1>
   </refentry>
@@ -105,8 +145,15 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_clrtoeol</function> erases the current line from
+    cursor position to the end. Blanks created by 
+    <function>ncurses_clrtoeol</function> have the current background
+    rendition. Returns &true; if any error occured, otherwise &false;.
     </para>
+    <para>
+    See also: <function>ncurses_clear</function>, 
+    <function>ncurses_clrtobot</function>
+    </para> 
    </refsect1>
   </refentry>
 
@@ -125,7 +172,13 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_def_prog_mode</function> saves the current
+    terminal modes for program (in curses) for use by
+    <function>ncurses_reset_prog_mode</function>. Returns &false; on
+    success, otherwise &true;.
+    </para>
+    <para>
+    See also: <function>ncurses_reset_prog_mode</function>
     </para>
    </refsect1>
   </refentry>
@@ -145,7 +198,13 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_def_shell_mode</function> saves the current
+    terminal modes for shell (not in curses) for use by
+    <function>ncurses_reset_shell_mode</function>. Returns &false; on
+    success, otherwise &true;.
+    </para>
+    <para>
+    See also: <function>ncurses_reset_shell_mode</function>
     </para>
    </refsect1>
   </refentry>
@@ -165,7 +224,14 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+     <function>ncurses_delch</function> deletes the character under
+     the cursor. All characters to the right of the cursor on the same
+     line are moved to the left one position and the last character on
+     the line is filled with a blank. The cursor position does
+     not change. Returns &false; on success, otherwise &true;.
+    </para>
+    <para>
+    See also: <function>ncurses_deleteln</function>
     </para>
    </refsect1>
   </refentry>
@@ -185,7 +251,15 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_deleteln</function> deletes the current line under
+    cursorposition. All lines below the current line are moved up one
+    line.
+    The bottom line of window is cleared. Cursor position does not
+    change.
+    Returns &false; on success, otherwise &true;.
+    </para>
+    <para>
+    See also: <function>ncurses_delch</function>
     </para>
    </refsect1>
   </refentry>
@@ -205,7 +279,10 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_doupdate()</function> compares the virtual screen to the
+    physical screen and updates the physical screen. This way is more
+    effective than using multiple refresh calls.
+    Returns &false; on success, &true; if any error occured. 
     </para>
    </refsect1>
   </refentry>
@@ -225,7 +302,13 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+    <function>ncurses_echo</function> enables echo mode.
+    All characters typed by user are echoed by
+    <function>ncurses_getch</function>.
+    Returns &false; on success, &true; if any error occured. 
+    </para>
+    <para>
+    To disable echo mode use <function>ncurses_noecho</function>.
     </para>
    </refsect1>
   </refentry>
@@ -233,7 +316,7 @@
   <refentry id="function.ncurses-erase">
    <refnamediv>
     <refname>ncurses_erase</refname>
-    <refpurpose>Erease terminal screen </refpurpose>
+    <refpurpose>Erase terminal screen </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -245,7 +328,14 @@
     </funcsynopsis>
      &warn.experimental.func;
     <para>
-     undocumented
+     <function>ncurses_erase</function> fills the terminal screen with
+     blanks. Created blanks have the current background rendition, set
+     by <function>ncurses_bkgd</function>.
+     Returns &false; on success, &true; if any error occured.
+    </para>
+    <para>
+    See also: <function>ncurses_bkgd</function>,
+    <function>ncurses_clear</function>
     </para>
    </refsect1>
   </refentry>