georg Sun Jan 13 16:44:35 2002 EDT
Modified files:
/phpdoc/en/functions ncurses.xml
Log:
partinfo restructured
inserted a few constants
Index: phpdoc/en/functions/ncurses.xml
diff -u phpdoc/en/functions/ncurses.xml:1.8 phpdoc/en/functions/ncurses.xml:1.9
--- phpdoc/en/functions/ncurses.xml:1.8 Sat Jan 12 11:03:18 2002
+++ phpdoc/en/functions/ncurses.xml Sun Jan 13 16:44:34 2002
@@ -1,27 +1,537 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<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>
-
-
+ &warn.experimental;
+
+ <section id="ncurses.intro">
+ <title>What is ncurses?</title>
+ <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>
+ </section>
+ <section id="ncurses.platforms">
+ <title>Platforms</title>
+ <para>
+ Ncurses is available for the following platforms:
+ <itemizedlist>
+ <listitem><para>AIX</para></listitem>
+ <listitem><para>BeOS</para></listitem>
+ <listitem><para>Cygwin</para></listitem>
+ <listitem><para>Digital Unix (aka OSF1)</para></listitem>
+ <listitem><para>FreeBSD</para></listitem>
+ <listitem><para>GNU/Linux</para></listitem>
+ <listitem><para>HPUX</para></listitem>
+ <listitem><para>IRIX</para></listitem>
+ <listitem><para>OS/2</para></listitem>
+ <listitem><para>SCO OpenServer</para></listitem>
+ <listitem><para>Solaris</para></listitem>
+ <listitem><para>SunOS</para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="ncurses.requirements">
+ <title>Requirements</title>
+ <para>
+ You need the ncurses libraries and headerfiles. Download the
+ latest version from the <ulink
+ url="&url.ncurses">&url.ncurses;</ulink> or from an other GNU-Mirror.
+ </para>
+ </section>
+ <section id="ncurses.installation">
+ <title>Installation</title>
+ <para>
+ To get these functions to work, you have to compile the CGI
+ version of PHP with <option
+ role="configure">--with-ncurses</option>.
+ </para>
+ </section>
+ <section id="ncurses.constants">
+ <title>Ncurses predifined constants</title>
+ <section id="ncurses.errconsts">
+ <title>Error codes</title>
+ <para>
+ On error ncurses functions return NCURSES_ERR.
+ </para>
+ </section>
+ <section id="ncurses.colorconsts">
+ <title>Colors</title>
+ <table>
+ <title>ncurses color constants</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>constant</entry>
+ <entry>meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>NCURSES_COLOR_BLACK</entry>
+ <entry>no color (black)</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_WHITE</entry>
+ <entry>white</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_RED</entry>
+ <entry>red - supported when terminal is in color mode</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_GREEN</entry>
+ <entry>green - supported when terminal is in color mod</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_YELLOW</entry>
+ <entry>yellow - supported when terminal is in color mod</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_BLUE</entry>
+ <entry>blue - supported when terminal is in color mod</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_CYAN</entry>
+ <entry>cyan - supported when terminal is in color mod</entry>
+ </row>
+ <row>
+ <entry>NCURSES_COLOR_MAGENTA</entry>
+ <entry>magenta - supported when terminal is in color mod</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="ncurses.keyconsts">
+ <title>Keys</title>
+ <table>
+ <title>ncurses key constants</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>constant</entry>
+ <entry>meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>NCURSES_KEY_F0 - NCURSES_KEY_F64</entry>
+ <entry>function keys F1 - F64</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_DOWN</entry>
+ <entry>down arrow</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_UP</entry>
+ <entry>up arrow</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_LEFT</entry>
+ <entry>left arrow</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_RIGHT</entry>
+ <entry>right arrow</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_HOME</entry>
+ <entry>home key (upward+left arrow)</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_BACKSPACE</entry>
+ <entry>backspace</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_DL</entry>
+ <entry>delete line</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_IL</entry>
+ <entry>insert line</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_DC</entry>
+ <entry>delete character</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_IC</entry>
+ <entry>insert char or enter insert mode</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_EIC</entry>
+ <entry>exit insert char mode</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_CLEAR</entry>
+ <entry>clear screen</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_EOS</entry>
+ <entry>clear to end of screen</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_EOL</entry>
+ <entry>clear to end of line</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SF</entry>
+ <entry>scroll one line forward</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SR</entry>
+ <entry>scroll one line backward</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_NPAGE</entry>
+ <entry>next page</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_PPAGE</entry>
+ <entry>previous page</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_STAB</entry>
+ <entry>set tab</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_CTAB</entry>
+ <entry>clear tab</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_CATAB</entry>
+ <entry>clear all tabs</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SRESET</entry>
+ <entry>soft (partial) reset</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_RESET</entry>
+ <entry>reset or hard reset</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_PRINT</entry>
+ <entry>print</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_LL</entry>
+ <entry>lower left</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_A1</entry>
+ <entry>upper left of keypad</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_A3</entry>
+ <entry>upper right of keypad</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_B2</entry>
+ <entry>center of keypad</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_C1</entry>
+ <entry>lower left of keypad</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_C3</entry>
+ <entry>lower right of keypad</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_BTAB</entry>
+ <entry>back tab</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_BEG</entry>
+ <entry>beginning</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_CANCEL</entry>
+ <entry>cancel</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_CLOSE</entry>
+ <entry>close</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_COMMAND</entry>
+ <entry>cmd (command)</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_COPY</entry>
+ <entry>copy</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_CREATE</entry>
+ <entry>create</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_END</entry>
+ <entry>end</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_EXIT</entry>
+ <entry>exit</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_FIND</entry>
+ <entry>find</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_HELP</entry>
+ <entry>help</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_MARK</entry>
+ <entry>mark</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_MESSAGE</entry>
+ <entry>message</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_MOVE</entry>
+ <entry>move</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_NEXT</entry>
+ <entry>next</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_OPEN</entry>
+ <entry>open</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_OPTIONS</entry>
+ <entry>options</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_PREVIOUS</entry>
+ <entry>previous</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_REDO</entry>
+ <entry>redo</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_REFERENCE</entry>
+ <entry>ref (reference)</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_REFRESH</entry>
+ <entry>refresh</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_REPLACE</entry>
+ <entry>replace</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_RESTART</entry>
+ <entry>restart</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_RESUME</entry>
+ <entry>resume</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SAVE</entry>
+ <entry>save</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SBEG</entry>
+ <entry>shiftet beg (beginning)</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SCANCEL</entry>
+ <entry>shifted cancel</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SCOMMAND</entry>
+ <entry>shifted command</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SCOPY</entry>
+ <entry>shifted copy</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SCREATE</entry>
+ <entry>shifted create</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SDC</entry>
+ <entry>shifted delete char</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SDL</entry>
+ <entry>shifted delete line</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SELECT</entry>
+ <entry>select</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SEND</entry>
+ <entry>shifted end</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SEOL</entry>
+ <entry>shifted end of line</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SEXIT</entry>
+ <entry>shifted exit</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SFIND</entry>
+ <entry>shifted find</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SHELP</entry>
+ <entry>shifted help</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SHOME</entry>
+ <entry>shifted home</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SIC</entry>
+ <entry>shifted input</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SLEFT</entry>
+ <entry>shifted left arrow</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SMESSAGE</entry>
+ <entry>shifted message</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SMOVE</entry>
+ <entry>shifted move</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SNEXT</entry>
+ <entry>shifted next</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SOPTIONS</entry>
+ <entry>shifted options</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SPREVIOUS</entry>
+ <entry>shifted previous</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SPRINT</entry>
+ <entry>shifted print</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SREDO</entry>
+ <entry>shifted redo</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SREPLACE</entry>
+ <entry>shifted replace</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SRIGHT</entry>
+ <entry>shifted right arrow</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SRSUME</entry>
+ <entry>shifted resume</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SSAVE</entry>
+ <entry>shifted save</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_SSUSPEND</entry>
+ <entry>shifted suspend</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_UNDO</entry>
+ <entry>undo</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_MOUSE</entry>
+ <entry>mouse event has occured</entry>
+ </row>
+ <row>
+ <entry>NCURSES_KEY_MAX</entry>
+ <entry>maximum key value</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section>
+ <title>Mouse</title>
+ <table>
+ <title>mouse constants</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Constant</entry>
+ <entry>meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>NCURSES_BUTTON1_RELEASED - NCURSES_BUTTON4_RELEASED</entry>
+ <entry>button (1-4) released</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON1_PRESSED - NCURSES_BUTTON4_PRESSED</entry>
+ <entry>button (1-4) pressed</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON1_CLICKED - NCURSES_BUTTON4_CLICKED</entry>
+ <entry>button (1-4) clicked</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON1_DOUBLE_CLICKED -
+ NCURSES_BUTTON4_DOUBLE_CLICKED</entry>
+ <entry>button (1-4) double clicked</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON1_TRIPLE_CLICKED -
+ NCURSES_BUTTON4_TRIPLE_CLICKED</entry>
+ <entry>button (1-4) triple clicked</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON_CTRL</entry>
+ <entry>ctrl pressed during click</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON_SHIFT</entry>
+ <entry>shift pressed during click</entry>
+ </row>
+ <row>
+ <entry>NCURSES_BUTTON_ALT</entry>
+ <entry>alt pressed during click</entry>
+ </row>
+ <row>
+ <entry>NCURSES_ALL_MOUSE_EVENTS</entry>
+ <entry>report all mouse events</entry>
+ </row>
+ <row>
+ <entry>NCURSES_REPORT_MOUSE_POSITION</entry>
+ <entry>report mouse position</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+ </partintro>
+
<refentry id="function.ncurses-can-change-color">
<refnamediv>
<refname>ncurses_can_change_color</refname>
@@ -43,7 +553,6 @@
</para>
</refsect1>
</refentry>
-
<refentry id="function.ncurses-cbreak">
<refnamediv>
<refname>ncurses_cbreak</refname>
@@ -65,8 +574,8 @@
available to the program.
</para>
<para>
- <function>ncurses_cbreak</function> returns &true; if any error
- occured, otherwise &false;.
+ <function>ncurses_cbreak</function> returns &true; or NCURSES_ERR
+ if any error occured.
</para>
<para>
See also: <function>ncurses_nocbreak</function>
@@ -2772,7 +3281,6 @@
</para>
</refsect1>
</refentry>
-
</reference>
<!-- Keep this comment at the end of the file
Local variables:
