diff options
| author | Ed Schouten <ed@FreeBSD.org> | 2011-04-30 10:55:14 +0000 |
|---|---|---|
| committer | Ed Schouten <ed@FreeBSD.org> | 2011-04-30 10:55:14 +0000 |
| commit | 0294a182a1629b1d854b84906e73487d6cb75fba (patch) | |
| tree | e563e21bcc0164ba11452983316bda26eebb1d3c /doc/html/man | |
| parent | 22b11c4db16996bf8d4878fab98762c348676df3 (diff) | |
| download | src-0294a182a1629b1d854b84906e73487d6cb75fba.tar.gz src-0294a182a1629b1d854b84906e73487d6cb75fba.zip | |
Import a stock copy of ncurses 5.8 into the vendor space.vendor/ncurses/5.8-20110226
It seems both local changes we made to 5.7 have already been fixed
upstream properly, so there is no need to preserve the changes. Also,
with SVN we import full source trees. Unlike CVS, where we removed
unneeded cruft.
Notes
Notes:
svn path=/vendor/ncurses/dist/; revision=221243
svn path=/vendor/ncurses/5.8-20110226/; revision=221244; tag=vendor/ncurses/5.8-20110226
Diffstat (limited to 'doc/html/man')
134 files changed, 25580 insertions, 0 deletions
diff --git a/doc/html/man/adacurses-config.1.html b/doc/html/man/adacurses-config.1.html new file mode 100644 index 000000000000..0bce33efdb90 --- /dev/null +++ b/doc/html/man/adacurses-config.1.html @@ -0,0 +1,96 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: MKada_config.in,v 1.3 2010/03/06 22:29:06 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>ADACURSES 1 User Commands</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>ADACURSES 1 User Commands</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="ADACURSES.1.html">ADACURSES(1)</A></STRONG> User Commands <STRONG><A HREF="ADACURSES.1.html">ADACURSES(1)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + adacurses-config - helper script for AdaCurses libraries + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>adacurses-config</STRONG> [<EM>options</EM>] + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is a shell script which simplifies configuring an + application to use the AdaCurses library binding to + ncurses. + + +</PRE> +<H2>OPTIONS</H2><PRE> + <STRONG>--cflags</STRONG> + echos the gnat (Ada compiler) flags needed to com- + pile with adacurses + + <STRONG>--libs</STRONG> echos the gnat libraries needed to link with + adacurses + + <STRONG>--version</STRONG> + echos the release+patchdate version of adacurses + + <STRONG>--help</STRONG> prints this message + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="ADACURSES.1.html">ADACURSES(1)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/captoinfo.1m.html b/doc/html/man/captoinfo.1m.html new file mode 100644 index 000000000000..05f36871ed2e --- /dev/null +++ b/doc/html/man/captoinfo.1m.html @@ -0,0 +1,229 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: captoinfo.1m,v 1.25 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>captoinfo 1m</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>captoinfo 1m</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG> <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>captoinfo</STRONG> - convert a <EM>termcap</EM> description into a <EM>terminfo</EM> + description + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>captoinfo</STRONG> [<STRONG>-v</STRONG><EM>n</EM> <EM>width</EM>] [<STRONG>-V</STRONG>] [<STRONG>-1</STRONG>] [<STRONG>-w</STRONG> <EM>width</EM>] <EM>file</EM> . . . + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>captoinfo</STRONG> looks in each given text <EM>file</EM> for <STRONG>termcap</STRONG> + descriptions. For each one found, an equivalent <STRONG>terminfo</STRONG> + description is written to standard output. Termcap <STRONG>tc</STRONG> + capabilities are translated directly to terminfo <STRONG>use</STRONG> capa- + bilities. + + If no <EM>file</EM> is given, then the environment variable <STRONG>TERMCAP</STRONG> + is used for the filename or entry. If <STRONG>TERMCAP</STRONG> is a full + pathname to a file, only the terminal whose name is speci- + fied in the environment variable <STRONG>TERM</STRONG> is extracted from + that file. If the environment variable <STRONG>TERMCAP</STRONG> is not + set, then the file <STRONG>/usr/share/terminfo</STRONG> is read. + + <STRONG>-v</STRONG> print out tracing information on standard error as + the program runs. + + <STRONG>-V</STRONG> print out the version of the program in use on stan- + dard error and exit. + + <STRONG>-1</STRONG> cause the fields to print out one to a line. Other- + wise, the fields will be printed several to a line to + a maximum width of 60 characters. + + <STRONG>-w</STRONG> change the output to <EM>width</EM> characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo Compiled terminal description + database. + + +</PRE> +<H2>TRANSLATIONS FROM NONSTANDARD CAPABILITIES</H2><PRE> + Some obsolete nonstandard capabilities will automatically + be translated into standard (SVr4/XSI Curses) terminfo + capabilities by <STRONG>captoinfo</STRONG>. Whenever one of these auto- + matic translations is done, the program will issue an + notification to stderr, inviting the user to check that it + has not mistakenly translated a completely unknown and + random capability and/or syntax error. + + + Nonstd Std From Terminfo + name name capability + ----------------------------------------------- + BO mr AT&T enter_reverse_mode + CI vi AT&T cursor_invisible + CV ve AT&T cursor_normal + DS mh AT&T enter_dim_mode + EE me AT&T exit_attribute_mode + FE LF AT&T label_on + FL LO AT&T label_off + XS mk AT&T enter_secure_mode + EN @7 XENIX key_end + GE ae XENIX exit_alt_charset_mode + GS as XENIX enter_alt_charset_mode + + HM kh XENIX key_home + LD kL XENIX key_dl + PD kN XENIX key_npage + PN po XENIX prtr_off + PS pf XENIX prtr_on + PU kP XENIX key_ppage + RT @8 XENIX kent + UP ku XENIX kcuu1 + KA k; Tek key_f10 + KB F1 Tek key_f11 + KC F2 Tek key_f12 + KD F3 Tek key_f13 + KE F4 Tek key_f14 + KF F5 Tek key_f15 + BC Sb Tek set_background + FC Sf Tek set_foreground + HS mh Iris enter_dim_mode + + XENIX termcap also used to have a set of extension capa- + bilities for forms drawing, designed to take advantage of + the IBM PC high-half graphics. They were as follows: + + + Cap Graphic + ----------------------------- + G2 upper left + G3 lower left + G1 upper right + G4 lower right + GR pointing right + GL pointing left + GU pointing up + GD pointing down + GH horizontal line + GV vertical line + GC intersection + G6 upper left + G7 lower left + G5 upper right + G8 lower right + Gr tee pointing right + Gr tee pointing left + Gu tee pointing up + Gd tee pointing down + Gh horizontal line + Gv vertical line + Gc intersection + GG acs magic cookie count + + If the single-line capabilities occur in an entry, they + will automatically be composed into an <EM>acsc</EM> string. The + double-line capabilities and <STRONG>GG</STRONG> are discarded with a warn- + ing message. + + IBM's AIX has a terminfo facility descended from SVr1 ter- + minfo but incompatible with the SVr4 format. The follow- + ing AIX extensions are automatically translated: + + IBM XSI + ------------- + ksel kslt + kbtab kcbt + font0 s0ds + font1 s1ds + font2 s2ds + + font3 s3ds + + Additionally, the AIX <EM>box1</EM> capability will be automati- + cally translated to an <EM>acsc</EM> string. + + Hewlett-Packard's terminfo library supports two nonstan- + dard terminfo capabilities <EM>meml</EM> (memory lock) and <EM>memu</EM> + (memory unlock). These will be discarded with a warning + message. + + +</PRE> +<H2>NOTES</H2><PRE> + This utility is actually a link to <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, running in <EM>-I</EM> + mode. You can use other <STRONG>tic</STRONG> options such as <STRONG>-f</STRONG> and <STRONG>-x</STRONG>. + + The trace option is not identical to SVr4's. Under SVr4, + instead of following the <STRONG>-v</STRONG> with a trace level n, you + repeat it n times. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + +</PRE> +<H2>AUTHOR</H2><PRE> + Eric S. Raymond <esr@snark.thyrsus.com> and + Thomas E. Dickey <dickey@invisible-island.net> + + + + <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/clear.1.html b/doc/html/man/clear.1.html new file mode 100644 index 000000000000..2edf5a9aa97d --- /dev/null +++ b/doc/html/man/clear.1.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: clear.1,v 1.8 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>clear 1</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>clear 1</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="clear.1.html">clear(1)</A></STRONG> <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>clear</STRONG> - clear the terminal screen + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>clear</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>clear</STRONG> clears your screen if this is possible. It looks in + the environment for the terminal type and then in the <STRONG>ter-</STRONG> + <STRONG>minfo</STRONG> database to figure out how to clear the screen. + + <STRONG>clear</STRONG> ignores any command-line parameters that may be + present. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_add_wch.3x.html b/doc/html/man/curs_add_wch.3x.html new file mode 100644 index 000000000000..77ed34d591bd --- /dev/null +++ b/doc/html/man/curs_add_wch.3x.html @@ -0,0 +1,232 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2001-2010,2011 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_add_wch.3x,v 1.14 2011/01/15 15:27:43 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_add_wch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_add_wch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, <STRONG>echo_wchar</STRONG>, + <STRONG>wecho_wchar</STRONG> - add a complex character and rendition to a + <STRONG>curses</STRONG> window, then advance the cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>add_wch(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wadd_wch(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvadd_wch(</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwadd_wch(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> + <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>echo_wchar(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wecho_wchar(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, and <STRONG>mvwadd_wch</STRONG> functions + put the complex character <EM>wch</EM> into the given window at its + current position, which is then advanced. These functions + perform wrapping and special-character processing as fol- + lows: + + <STRONG>o</STRONG> If <EM>wch</EM> refers to a spacing character, then any previ- + ous character at that location is removed. A new + character specified by <EM>wch</EM> is placed at that location + with rendition specified by <EM>wch</EM>. The cursor then + advances to the next spacing character on the screen. + + <STRONG>o</STRONG> If <EM>wch</EM> refers to a non-spacing character, all previous + characters at that location are preserved. The non- + spacing characters of <EM>wch</EM> are added to the spacing + complex character, and the rendition specified by <EM>wch</EM> + is ignored. + + <STRONG>o</STRONG> If the character part of <EM>wch</EM> is a tab, newline, + backspace or other control character, the window is + updated and the cursor moves as if <STRONG>addch</STRONG> were called. + + The <STRONG>echo_wchar</STRONG> function is functionally equivalent to a + call to <STRONG>add_wch</STRONG> followed by a call to <STRONG>refresh</STRONG>. Similarly, + the <STRONG>wecho_wchar</STRONG> is functionally equivalent to a call to + <STRONG>wadd_wch</STRONG> followed by a call to <STRONG>wrefresh</STRONG>. The knowledge + that only a single character is being output is taken into + consideration and, for non-control characters, a consider- + able performance gain might be seen by using the *<STRONG>echo</STRONG>* + functions instead of their equivalents. + + <STRONG>Line</STRONG> <STRONG>Graphics</STRONG> + Like <STRONG><A HREF="addch.3x.html">addch(3x)</A></STRONG>, <STRONG>addch_wch</STRONG> accepts symbols which make it + simple to draw lines and other frequently used special + characters. These symbols correspond to the same VT100 + line-drawing set as <STRONG><A HREF="addch.3x.html">addch(3x)</A></STRONG>. + + + <EM>Name</EM> <EM>Unicode</EM> <EM>Default</EM> <EM>Description</EM> + ---------------------------------------------------------------- + WACS_BLOCK 0x25ae # solid square block + WACS_BOARD 0x2592 # board of squares + WACS_BTEE 0x2534 + bottom tee + WACS_BULLET 0x00b7 o bullet + + WACS_CKBOARD 0x2592 : checker board (stipple) + WACS_DARROW 0x2193 v arrow pointing down + WACS_DEGREE 0x00b0 ' degree symbol + WACS_DIAMOND 0x25c6 + diamond + WACS_GEQUAL 0x2265 > greater-than-or-equal-to + WACS_HLINE 0x2500 - horizontal line + WACS_LANTERN 0x2603 # lantern symbol + WACS_LARROW 0x2190 < arrow pointing left + WACS_LEQUAL 0x2264 < less-than-or-equal-to + WACS_LLCORNER 0x2514 + lower left-hand corner + WACS_LRCORNER 0x2518 + lower right-hand corner + WACS_LTEE 0x2524 + left tee + WACS_NEQUAL 0x2260 ! not-equal + WACS_PI 0x03c0 * greek pi + WACS_PLMINUS 0x00b1 # plus/minus + WACS_PLUS 0x253c + plus + WACS_RARROW 0x2192 > arrow pointing right + WACS_RTEE 0x251c + right tee + WACS_S1 0x23ba - scan line 1 + WACS_S3 0x23bb - scan line 3 + WACS_S7 0x23bc - scan line 7 + WACS_S9 0x23bd _ scan line 9 + WACS_STERLING 0x00a3 f pound-sterling symbol + WACS_TTEE 0x252c + top tee + WACS_UARROW 0x2191 ^ arrow pointing up + WACS_ULCORNER 0x250c + upper left-hand corner + WACS_URCORNER 0x2510 + upper right-hand corner + WACS_VLINE 0x2502 | vertical line + + The wide-character configuration of ncurses also defines + symbols for thick- and double-lines: + + + <EM>Name</EM> <EM>Unicode</EM> <EM>Default</EM> <EM>Description</EM> + --------------------------------------------------------------------- + WACS_T_ULCORNER 0x250f + thick upper left corner + WACS_T_LLCORNER 0x2517 + thick lower left corner + WACS_T_URCORNER 0x2513 + thick upper right corner + WACS_T_LRCORNER 0x251b + thick lower right corner + WACS_T_LTEE 0x252b + thick tee pointing right + WACS_T_RTEE 0x2523 + thick tee pointing left + WACS_T_BTEE 0x253b + thick tee pointing up + WACS_T_TTEE 0x2533 + thick tee pointing down + WACS_T_HLINE 0x2501 - thick horizontal line + WACS_T_VLINE 0x2503 | thick vertical line + WACS_T_PLUS 0x254b + thick large plus or crossover + WACS_D_ULCORNER 0x2554 + double upper left corner + WACS_D_LLCORNER 0x255a + double lower left corner + WACS_D_URCORNER 0x2557 + double upper right corner + WACS_D_LRCORNER 0x255d + double lower right corner + WACS_D_RTEE 0x2563 + double tee pointing left + WACS_D_LTEE 0x2560 + double tee pointing right + WACS_D_BTEE 0x2569 + double tee pointing up + WACS_D_TTEE 0x2566 + double tee pointing down + WACS_D_HLINE 0x2550 - double horizontal line + WACS_D_VLINE 0x2551 | double vertical line + WACS_D_PLUS 0x256c + double large plus or crossover + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on + success. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>add_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>, and <STRONG>echo_wchar</STRONG> + may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All of these functions are described in the XSI Curses + standard, Issue 4. The defaults specified for line-draw- + ing characters apply in the POSIX locale. + + X/Open Curses makes it clear that the WACS_ symbols should + be defined as a pointer to <STRONG>cchar_t</STRONG> data, e.g., in the dis- + cussion of <STRONG>border_set</STRONG>. A few implementations are problem- + atic: + + <STRONG>o</STRONG> NetBSD curses defines the symbols as a <STRONG>wchar_t</STRONG> within + a <STRONG>cchar_t</STRONG>. + + <STRONG>o</STRONG> HPUX curses equates some of the <EM>ACS</EM><STRONG>_</STRONG> symbols to the + analogous <EM>WACS</EM><STRONG>_</STRONG> symbols as if the <EM>ACS</EM><STRONG>_</STRONG> symbols were + wide characters. The misdefined symbols are the + arrows and other symbols which are not used for line- + drawing. + + X/Open Curses does not define symbols for thick- or dou- + ble-lines. SVr4 curses implementations defined their + line-drawing symbols in terms of intermediate symbols. + This implementation extends those symbols, providing new + definitions which are not in the SVr4 implementations. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, + <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="putwc.3.html">putwc(3)</A></STRONG> + + + + <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html new file mode 100644 index 000000000000..0f676ce3a150 --- /dev/null +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_add_wchstr.3x,v 1.9 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_add_wchstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_add_wchstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>, + <STRONG>mvadd_wchstr</STRONG>, <STRONG>mvadd_wchnstr</STRONG>, <STRONG>mvwadd_wchstr</STRONG>, <STRONG>mvwadd_wchnstr</STRONG> + - add an array of complex characters (and attributes) to a + curses window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>add_wchstr(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>add_wchnstr(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wadd_wchstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wadd_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvadd_wchstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvadd_wchnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwadd_wchstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwadd_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines copy the array of complex characters <EM>wchstr</EM> + into the window image structure at and after the current + cursor position. The four routines with <EM>n</EM> as the last + argument copy at most <EM>n</EM> elements, but no more than will + fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the whole array is copied, + to the maximum number of characters that will fit on the + line. + + The window cursor is <EM>not</EM> advanced. These routines work + faster than <STRONG>waddnstr</STRONG>. On the other hand, they do not per- + form checking (such as for the newline, backspace, or car- + riage return characters), they do not advance the current + cursor position, they do not expand other control charac- + ters to ^-escapes, and they truncate the string if it + crosses the right margin, rather than wrapping it around + to the new line. + + These routines end successfully on encountering a null + <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM>, or when they have filled the current line. If a + complex character cannot completely fit at the end of the + current line, the remaining columns are filled with the + background character and rendition. + + +</PRE> +<H2>NOTES</H2><PRE> + All functions except <STRONG>wadd_wchnstr</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on + success. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these entry points are described in the XSI Curses + standard, Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>, <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_addch.3x.html b/doc/html/man/curs_addch.3x.html new file mode 100644 index 000000000000..af567118c69b --- /dev/null +++ b/doc/html/man/curs_addch.3x.html @@ -0,0 +1,220 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_addch.3x,v 1.32 2011/01/15 14:15:10 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_addch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_addch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>addch</STRONG>, <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, <STRONG>echochar</STRONG>, <STRONG>wechochar</STRONG> - + add a character (with attributes) to a <STRONG>curses</STRONG> window, then + advance the cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>addch(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>waddch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>echochar(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>wechochar(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>addch</STRONG>, <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG> and <STRONG>mvwaddch</STRONG> routines put the + character <EM>ch</EM> into the given window at its current window + position, which is then advanced. They are analogous to + <STRONG>putchar</STRONG> in <STRONG><A HREF="stdio.3.html">stdio(3)</A></STRONG>. If the advance is at the right mar- + gin, the cursor automatically wraps to the beginning of + the next line. At the bottom of the current scrolling + region, if <STRONG>scrollok</STRONG> is enabled, the scrolling region is + scrolled up one line. + + If <EM>ch</EM> is a tab, newline, or backspace, the cursor is moved + appropriately within the window. Backspace moves the cur- + sor one character left; at the left edge of a window it + does nothing. Newline does a <STRONG>clrtoeol</STRONG>, then moves the + cursor to the window left margin on the next line, + scrolling the window if on the last line. Tabs are con- + sidered to be at every eighth column. The tab interval + may be altered by setting the <STRONG>TABSIZE</STRONG> variable. + + If <EM>ch</EM> is any control character other than tab, newline, or + backspace, it is drawn in <STRONG>^</STRONG><EM>X</EM> notation. Calling <STRONG>winch</STRONG> + after adding a control character does not return the char- + acter itself, but instead returns the ^-representation of + the control character. + + Video attributes can be combined with a character argument + passed to <STRONG>addch</STRONG> or related functions by logical-ORing them + into the character. (Thus, text, including attributes, + can be copied from one place to another using <STRONG>inch</STRONG> and + <STRONG>addch</STRONG>.) See the <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> page for values of prede- + fined video attribute constants that can be usefully OR'ed + into characters. + + The <STRONG>echochar</STRONG> and <STRONG>wechochar</STRONG> routines are equivalent to a + call to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, or a call to + <STRONG>waddch</STRONG> followed by a call to <STRONG>wrefresh</STRONG>. The knowledge that + only a single character is being output is used and, for + non-control characters, a considerable performance gain + may be seen by using these routines instead of their + equivalents. + + <STRONG>Line</STRONG> <STRONG>Graphics</STRONG> + The following variables may be used to add line drawing + characters to the screen with routines of the <STRONG>addch</STRONG> fam- + ily. The default character listed below is used if the + <STRONG>acsc</STRONG> capability does not define a terminal-specific + replacement for it. The names are taken from VT100 + nomenclature. + + + <EM>Name</EM> <EM>Default</EM> <EM>Description</EM> + -------------------------------------------------- + ACS_BLOCK # solid square block + ACS_BOARD # board of squares + ACS_BTEE + bottom tee + ACS_BULLET o bullet + ACS_CKBOARD : checker board (stipple) + ACS_DARROW v arrow pointing down + ACS_DEGREE ' degree symbol + ACS_DIAMOND + diamond + ACS_GEQUAL > greater-than-or-equal-to + ACS_HLINE - horizontal line + ACS_LANTERN # lantern symbol + ACS_LARROW < arrow pointing left + ACS_LEQUAL < less-than-or-equal-to + ACS_LLCORNER + lower left-hand corner + ACS_LRCORNER + lower right-hand corner + ACS_LTEE + left tee + ACS_NEQUAL ! not-equal + ACS_PI * greek pi + ACS_PLMINUS # plus/minus + ACS_PLUS + plus + ACS_RARROW > arrow pointing right + ACS_RTEE + right tee + ACS_S1 - scan line 1 + ACS_S3 - scan line 3 + ACS_S7 - scan line 7 + ACS_S9 _ scan line 9 + ACS_STERLING f pound-sterling symbol + ACS_TTEE + top tee + ACS_UARROW ^ arrow pointing up + ACS_ULCORNER + upper left-hand corner + ACS_URCORNER + upper right-hand corner + ACS_VLINE | vertical line + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on + success (the SVr4 manuals specify only "an integer value + other than <STRONG>ERR</STRONG>") upon successful completion, unless other- + wise noted in the preceding routine descriptions. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>addch</STRONG>, <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, and <STRONG>echochar</STRONG> may be + macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these functions are described in the XSI Curses stan- + dard, Issue 4. The defaults specified for forms-drawing + characters apply in the POSIX locale. + + X/Open Curses states that the <EM>ACS</EM><STRONG>_</STRONG> definitions are <STRONG>char</STRONG> + constants. For the wide-character implementation (see + <STRONG>curs_add_wch</STRONG>), there are analogous <EM>WACS</EM><STRONG>_</STRONG> definitions which + are <STRONG>cchar_t</STRONG> constants. + + Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL, ACS_GEQUAL, + ACS_PI, ACS_NEQUAL, ACS_STERLING) were not documented in + any publicly released System V. However, many publicly + available terminfos include <STRONG>acsc</STRONG> strings in which their + key characters (pryz{|}) are embedded, and a second-hand + list of their character descriptions has come to light. + The ACS-prefixed names for them were invented for + <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. + + The <STRONG>TABSIZE</STRONG> variable is implemented in some versions of + curses, but is not part of X/Open curses. + + If <EM>ch</EM> is a carriage return, the cursor is moved to the + beginning of the current row of the window. This is true + of other implementations, but is not documented. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>, + <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, + <STRONG><A HREF="putc.3.html">putc(3)</A></STRONG>. + + Comparable functions in the wide-character (ncursesw) + library are described in <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html new file mode 100644 index 000000000000..e8861399946a --- /dev/null +++ b/doc/html/man/curs_addchstr.3x.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_addchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_addchstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_addchstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>addchstr</STRONG>, <STRONG>addchnstr</STRONG>, <STRONG>waddchstr</STRONG>, <STRONG>waddchnstr</STRONG>, <STRONG>mvaddchstr</STRONG>, + <STRONG>mvaddchnstr</STRONG>, <STRONG>mvwaddchstr</STRONG>, <STRONG>mvwaddchnstr</STRONG> - add a string of + characters (and attributes) to a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>addchstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>addchnstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>waddchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>waddchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddchstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddchnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> + <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> + <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines copy <EM>chstr</EM> into the window image structure + at and after the current cursor position. The four rou- + tines with <EM>n</EM> as the last argument copy at most <EM>n</EM> elements, + but no more than will fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the + whole string is copied, to the maximum number of charac- + ters that will fit on the line. + + The window cursor is <EM>not</EM> advanced, and these routines work + faster than <STRONG>waddnstr</STRONG>. On the other hand, they do not per- + form any kind of checking (such as for the newline, + backspace, or carriage return characters), they do not ad- + vance the current cursor position, they do not expand oth- + er control characters to ^-escapes, and they truncate the + string if it crosses the right margin, rather than wrap- + ping it around to the new line. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on + success (the SVr4 manuals specify only "an integer value + other than <STRONG>ERR</STRONG>") upon successful completion, unless other- + wise noted in the preceding routine descriptions. + + X/Open does not define any error conditions. This imple- + mentation returns an error if the window pointer is null. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>waddchnstr</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These entry points are described in the XSI Curses stan- + dard, Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + Comparable functions in the wide-character (ncursesw) li- + brary are described in <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html new file mode 100644 index 000000000000..d89503cc8bc9 --- /dev/null +++ b/doc/html/man/curs_addstr.3x.html @@ -0,0 +1,125 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_addstr.3x,v 1.16 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_addstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_addstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>addstr</STRONG>, <STRONG>addnstr</STRONG>, <STRONG>waddstr</STRONG>, <STRONG>waddnstr</STRONG>, <STRONG>mvaddstr</STRONG>, <STRONG>mvaddnstr</STRONG>, + <STRONG>mvwaddstr</STRONG>, <STRONG>mvwaddnstr</STRONG> - add a string of characters to a + <STRONG>curses</STRONG> window and advance cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>addstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>addnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>waddstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>waddnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str,</EM> <EM>int</EM> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines write the characters of the (null-terminat- + ed) character string <EM>str</EM> on the given window. It is simi- + lar to calling <STRONG>waddch</STRONG> once for each character in the + string. The four routines with <EM>n</EM> as the last argument + write at most <EM>n</EM> characters. If <EM>n</EM> is -1, then the entire + string will be added, up to the maximum number of charac- + ters that will fit on the line, or until a terminating + null is reached. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on + success (the SVr4 manuals specify only "an integer value + other than <STRONG>ERR</STRONG>") upon successful completion. + + X/Open does not define any error conditions. This imple- + mentation returns an error if the window pointer is null + or if the string pointer is null or if the corresponding + calls to <STRONG>waddch</STRONG> return an error. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all of these routines except <STRONG>waddstr</STRONG> and + <STRONG>waddnstr</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these entry points are described in the XSI Curses + standard, Issue 4. The XSI errors EILSEQ and EOVERFLOW, + associated with extended-level conformance, are not yet + detected. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_addwstr.3x.html b/doc/html/man/curs_addwstr.3x.html new file mode 100644 index 000000000000..99ab802ec689 --- /dev/null +++ b/doc/html/man/curs_addwstr.3x.html @@ -0,0 +1,124 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_addwstr.3x,v 1.10 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_addwstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_addwstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>addwstr</STRONG>, <STRONG>addnwstr</STRONG>, <STRONG>waddwstr</STRONG>, <STRONG>waddnwstr</STRONG>, <STRONG>mvaddwstr</STRONG>, + <STRONG>mvaddnwstr</STRONG>, <STRONG>mvwaddwstr</STRONG>, <STRONG>mvwaddnwstr</STRONG> - add a string of wide + characters to a <STRONG>curses</STRONG> window and advance cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>addwstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>addnwstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>waddwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>waddnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvaddnwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwaddnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines write the characters of the (null-terminat- + ed) <STRONG>wchar_t</STRONG> character string <EM>wstr</EM> on the given window. It + is similar to constructing a <STRONG>cchar_t</STRONG> for each wchar_t in + the string, then calling <STRONG>wadd_wch</STRONG> for the resulting + <STRONG>cchar_t</STRONG>. + + The <EM>mv</EM> routines perform cursor movement once, before writ- + ing any characters. Thereafter, the cursor is advanced as + a side-effect of writing to the window. + + The four routines with <EM>n</EM> as the last argument write at + most <EM>n</EM> <STRONG>wchar_t</STRONG> characters. If <EM>n</EM> is -1, then the entire + string will be added, up to the maximum number of charac- + ters that will fit on the line, or until a terminating + null is reached. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on + success. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all of these routines except <STRONG>waddnwstr</STRONG> may be + macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these entry points are described in the XSI Curses + standard, Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html new file mode 100644 index 000000000000..23a157332e76 --- /dev/null +++ b/doc/html/man/curs_attr.3x.html @@ -0,0 +1,267 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_attr.3x,v 1.36 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_attr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_attr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>, + <STRONG>color_set</STRONG>, <STRONG>wcolor_set</STRONG>, <STRONG>standend</STRONG>, <STRONG>wstandend</STRONG>, <STRONG>standout</STRONG>, + <STRONG>wstandout</STRONG>, <STRONG>attr_get</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>attr_off</STRONG>, <STRONG>wattr_off</STRONG>, + <STRONG>attr_on</STRONG>, <STRONG>wattr_on</STRONG>, <STRONG>attr_set</STRONG>, <STRONG>wattr_set</STRONG>, <STRONG>chgat</STRONG>, <STRONG>wchgat</STRONG>, + <STRONG>mvchgat</STRONG>, <STRONG>mvwchgat</STRONG>, <STRONG>PAIR_NUMBER</STRONG> - <STRONG>curses</STRONG> character and + window attribute control routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>int</STRONG> <STRONG>attroff(int</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>wattroff(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>attron(int</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>wattron(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>attrset(int</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>wattrset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>color_set(short</STRONG> <STRONG>color_pair_number,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG> + <STRONG>int</STRONG> <STRONG>wcolor_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>short</STRONG> <STRONG>color_pair_number,</STRONG> + <STRONG>void*</STRONG> <STRONG>opts);</STRONG> + <STRONG>int</STRONG> <STRONG>standend(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wstandend(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>standout(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wstandout(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>attr_get(attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>wattr_get(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG> + <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>attr_off(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>wattr_off(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>attr_on(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>wattr_on(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>attr_set(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>wattr_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>pair,</STRONG> <STRONG>void</STRONG> + <STRONG>*opts);</STRONG> + <STRONG>int</STRONG> <STRONG>chgat(int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG> + <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG> + <STRONG>int</STRONG> <STRONG>wchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> + <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG> + <STRONG>int</STRONG> <STRONG>mvchgat(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> + <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG> + <STRONG>int</STRONG> <STRONG>mvwchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> + <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines manipulate the current attributes of the + named window. The current attributes of a window apply to + all characters that are written into the window with <STRONG>wadd-</STRONG> + <STRONG>ch</STRONG>, <STRONG>waddstr</STRONG> and <STRONG>wprintw</STRONG>. Attributes are a property of the + character, and move with the character through any + scrolling and insert/delete line/character operations. To + the extent possible, they are displayed as appropriate + modifications to the graphic rendition of characters put + on the screen. + + The routine <STRONG>attrset</STRONG> sets the current attributes of the + given window to <EM>attrs</EM>. The routine <STRONG>attroff</STRONG> turns off the + named attributes without turning any other attributes on + or off. The routine <STRONG>attron</STRONG> turns on the named attributes + without affecting any others. The routine <STRONG>standout</STRONG> is the + same as <STRONG>attron(A_STANDOUT)</STRONG>. The routine <STRONG>standend</STRONG> is the + same as <STRONG>attrset(A_NORMAL)</STRONG> or <STRONG>attrset(0)</STRONG>, that is, it turns + off all attributes. + + The <STRONG>attrset</STRONG> and related routines do not affect the at- + tributes used when erasing portions of the window. See + <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> for functions which modify the attributes + used for erasing and clearing. + + The routine <STRONG>color_set</STRONG> sets the current color of the given + window to the foreground/background combination described + by the color_pair_number. The parameter opts is reserved + for future use, applications must supply a null pointer. + + The routine <STRONG>wattr_get</STRONG> returns the current attribute and + color pair for the given window; <STRONG>attr_get</STRONG> returns the cur- + rent attribute and color pair for <STRONG>stdscr</STRONG>. The remaining + <STRONG>attr_</STRONG>* functions operate exactly like the corresponding + <STRONG>attr</STRONG>* functions, except that they take arguments of type + <STRONG>attr_t</STRONG> rather than <STRONG>int</STRONG>. + + The routine <STRONG>chgat</STRONG> changes the attributes of a given number + of characters starting at the current cursor location of + <STRONG>stdscr</STRONG>. It does not update the cursor and does not per- + form wrapping. A character count of -1 or greater than + the remaining window width means to change attributes all + the way to the end of the current line. The <STRONG>wchgat</STRONG> func- + tion generalizes this to any window; the <STRONG>mvwchgat</STRONG> function + does a cursor move before acting. In these functions, the + color argument is a color-pair index (as in the first ar- + gument of <EM>init</EM><STRONG>_</STRONG><EM>pair</EM>, see <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>). The <STRONG>opts</STRONG> argu- + ment is not presently used, but is reserved for the future + (leave it <STRONG>NULL</STRONG>). + + <STRONG>Attributes</STRONG> + The following video attributes, defined in <STRONG><curses.h></STRONG>, can + be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or + OR'd with the characters passed to <STRONG>addch</STRONG>. + + + <STRONG>A_NORMAL</STRONG> Normal display (no highlight) + <STRONG>A_STANDOUT</STRONG> Best highlighting mode of the terminal. + <STRONG>A_UNDERLINE</STRONG> Underlining + <STRONG>A_REVERSE</STRONG> Reverse video + <STRONG>A_BLINK</STRONG> Blinking + <STRONG>A_DIM</STRONG> Half bright + <STRONG>A_BOLD</STRONG> Extra bright or bold + <STRONG>A_PROTECT</STRONG> Protected mode + <STRONG>A_INVIS</STRONG> Invisible or blank mode + <STRONG>A_ALTCHARSET</STRONG> Alternate character set + <STRONG>A_CHARTEXT</STRONG> Bit-mask to extract a character + <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> Color-pair number <EM>n</EM> + + The following macro is the reverse of <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>: + + <STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM>) Returns the pair number associated + with the <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> attribute. + + The return values of many of these routines are not mean- + ingful (they are implemented as macro-expanded assignments + and simply return their argument). The SVr4 manual page + claims (falsely) that these routines always return <STRONG>1</STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>attroff</STRONG>, <STRONG>wattroff</STRONG>, <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>, + <STRONG>wattrset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG> may be macros. + + <STRONG>COLOR_PAIR</STRONG> values can only be OR'd with attributes if the + pair number is less than 256. The alternate functions + such as <STRONG>color_set</STRONG> can pass a color pair value directly. + However, ncurses ABI 4 and 5 simply OR this value within + the alternate functions. You must use ncurses ABI 6 to + support more than 256 color pairs. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are supported in the XSI Curses standard, + Issue 4. The standard defined the dedicated type for + highlights, <STRONG>attr_t</STRONG>, which is not defined in SVr4 curses. + The functions taking <STRONG>attr_t</STRONG> arguments are not supported + under SVr4. + + The XSI Curses standard states that whether the tradition- + al functions <STRONG>attron</STRONG>/<STRONG>attroff</STRONG>/<STRONG>attrset</STRONG> can manipulate at- + tributes other than <STRONG>A_BLINK</STRONG>, <STRONG>A_BOLD</STRONG>, <STRONG>A_DIM</STRONG>, <STRONG>A_REVERSE</STRONG>, + <STRONG>A_STANDOUT</STRONG>, or <STRONG>A_UNDERLINE</STRONG> is "unspecified". Under this + implementation as well as SVr4 curses, these functions + correctly manipulate all other highlights (specifically, + <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>). + + XSI Curses added the new entry points, <STRONG>attr_get</STRONG>, <STRONG>attr_on</STRONG>, + <STRONG>attr_off</STRONG>, <STRONG>attr_set</STRONG>, <STRONG>wattr_on</STRONG>, <STRONG>wattr_off</STRONG>, <STRONG>wattr_get</STRONG>, <STRONG>wat-</STRONG> + <STRONG>tr_set</STRONG>. These are intended to work with a new series of + highlight macros prefixed with <STRONG>WA_</STRONG>. + + Older versions of this library did not force an update of + the screen when changing the attributes. Use <STRONG>touchwin</STRONG> to + force the screen to match the updated attributes. + + + <STRONG>WA_NORMAL</STRONG> Normal display (no highlight) + <STRONG>WA_STANDOUT</STRONG> Best highlighting mode of the terminal. + <STRONG>WA_UNDERLINE</STRONG> Underlining + <STRONG>WA_REVERSE</STRONG> Reverse video + <STRONG>WA_BLINK</STRONG> Blinking + <STRONG>WA_DIM</STRONG> Half bright + <STRONG>WA_BOLD</STRONG> Extra bright or bold + <STRONG>WA_ALTCHARSET</STRONG> Alternate character set + + The XSI curses standard specifies that each pair of corre- + sponding <STRONG>A_</STRONG> and <STRONG>WA_</STRONG>-using functions operates on the same + current-highlight information. + + The XSI standard extended conformance level adds new high- + lights <STRONG>A_HORIZONTAL</STRONG>, <STRONG>A_LEFT</STRONG>, <STRONG>A_LOW</STRONG>, <STRONG>A_RIGHT</STRONG>, <STRONG>A_TOP</STRONG>, <STRONG>A_VER-</STRONG> + <STRONG>TICAL</STRONG> (and corresponding <STRONG>WA_</STRONG> macros for each) which this + implementation does not yet support. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>OK</STRONG> on success, or <STRONG>ERR</STRONG> on + failure. + + X/Open does not define any error conditions. + + This implementation returns an error if the window pointer + is null. The <STRONG>wcolor_set</STRONG> function returns an error if the + color pair parameter is outside the range 0..COL- + OR_PAIRS-1. This implementation also provides <STRONG>getattrs</STRONG> + for compatibility with older versions of curses. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>, + <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_beep.3x.html b/doc/html/man/curs_beep.3x.html new file mode 100644 index 000000000000..e450ce29bfb1 --- /dev/null +++ b/doc/html/man/curs_beep.3x.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_beep.3x,v 1.12 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_beep 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_beep 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>beep</STRONG>, <STRONG>flash</STRONG> - <STRONG>curses</STRONG> bell and screen flash routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>beep(void);</STRONG> + <STRONG>int</STRONG> <STRONG>flash(void);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>beep</STRONG> and <STRONG>flash</STRONG> routines are used to alert the terminal + user. The routine <STRONG>beep</STRONG> sounds an audible alarm on the + terminal, if possible; otherwise it flashes the screen + (visible bell). The routine <STRONG>flash</STRONG> flashes the screen, and + if that is not possible, sounds the alert. If neither + alert is possible, nothing happens. Nearly all terminals + have an audible alert (bell or beep), but only some can + flash the screen. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <STRONG>OK</STRONG> if they succeed in beeping or + flashing, <STRONG>ERR</STRONG> otherwise. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + SVr4's beep and flash routines always returned <STRONG>OK</STRONG>, so it + was not possible to tell when the beep or flash failed. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. Like SVr4, it specifies that they always return + <STRONG>OK</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html new file mode 100644 index 000000000000..56f5cb91c5c7 --- /dev/null +++ b/doc/html/man/curs_bkgd.3x.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2003,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_bkgd.3x,v 1.22 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_bkgd 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_bkgd 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>bkgdset</STRONG>, <STRONG>wbkgdset</STRONG>, <STRONG>bkgd</STRONG>, <STRONG>wbkgd</STRONG>, <STRONG>getbkgd</STRONG> - <STRONG>curses</STRONG> window + background manipulation routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>void</STRONG> <STRONG>bkgdset(chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>bkgd(chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG> routines manipulate the back- + ground of the named window. The window background is a + <STRONG>chtype</STRONG> consisting of any combination of attributes (i.e., + rendition) and a character. The attribute part of the + background is combined (OR'ed) with all non-blank charac- + ters that are written into the window with <STRONG>waddch</STRONG>. Both + the character and attribute parts of the background are + combined with the blank characters. The background + becomes a property of the character and moves with the + character through any scrolling and insert/delete + line/character operations. + + To the extent possible on a particular terminal, the + attribute part of the background is displayed as the + graphic rendition of the character put on the screen. + + The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the background property + of the current or specified window and then apply this + setting to every character position in that window: + + The rendition of every character on the screen is + changed to the new background rendition. + + Wherever the former background character appears, + it is changed to the new background character. + + The <STRONG>getbkgd</STRONG> function returns the given window's current + background character/attribute pair. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The routines <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>. The + SVr4.0 manual says "or a non-negative integer if <STRONG>immedok</STRONG> + is set", but this appears to be an error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. It specifies that <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return <STRONG>ERR</STRONG> on + failure, but gives no failure conditions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG>curs_out-</STRONG> + <STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html new file mode 100644 index 000000000000..5dc6fdb16a2b --- /dev/null +++ b/doc/html/man/curs_bkgrnd.3x.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_bkgrnd.3x,v 1.4 2010/12/04 18:49:20 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_bkgrnd 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_bkgrnd 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>bkgrnd</STRONG>, <STRONG>wbkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, <STRONG>wbkgrndset</STRONG>, <STRONG>getbkgrnd</STRONG>, <STRONG>wget-</STRONG> + <STRONG>bkgrnd</STRONG> - <STRONG>curses</STRONG> window complex background manipulation + routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>bkgrnd(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wbkgrnd(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>void</STRONG> <STRONG>bkgrndset(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG> + <STRONG>void</STRONG> <STRONG>wbkgrndset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>getbkgrnd(cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wgetbkgrnd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines manipulate the back- + ground of the named window. The window background is a + <STRONG>cchar_t</STRONG> consisting of any combination of attributes (i.e., + rendition) and a complex character. The attribute part of + the background is combined (OR'ed) with all non-blank + characters that are written into the window with <STRONG>waddch</STRONG>. + Both the character and attribute parts of the background + are combined with the blank characters. The background + becomes a property of the character and moves with the + character through any scrolling and insert/delete + line/character operations. + + To the extent possible on a particular terminal, the + attribute part of the background is displayed as the + graphic rendition of the character put on the screen. + + The <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the background prop- + erty of the current or specified window and then apply + this setting to every character position in that window: + + The rendition of every character on the screen is + changed to the new background rendition. + + Wherever the former background character appears, + it is changed to the new background character. + + The <STRONG>getbkgrnd</STRONG> function returns the given window's current + background character/attribute pair via the <STRONG>wch</STRONG> pointer. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a + value. + + Upon successful completion, the other functions return <STRONG>OK</STRONG>. + Otherwise, they return <STRONG>ERR</STRONG>. A null window pointer is + treated as an error. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_border.3x.html b/doc/html/man/curs_border.3x.html new file mode 100644 index 000000000000..880d59bca209 --- /dev/null +++ b/doc/html/man/curs_border.3x.html @@ -0,0 +1,162 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_border.3x,v 1.22 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_border 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_border 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>border</STRONG>, <STRONG>wborder</STRONG>, <STRONG>box</STRONG>, <STRONG>hline</STRONG>, <STRONG>whline</STRONG>, <STRONG>vline</STRONG>, <STRONG>wvline</STRONG>, + <STRONG>mvhline</STRONG>, <STRONG>mvwhline</STRONG>, <STRONG>mvvline</STRONG>, <STRONG>mvwvline</STRONG> - create <STRONG>curses</STRONG> + borders, horizontal and vertical lines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>int</STRONG> <STRONG>border(chtype</STRONG> <STRONG>ls,</STRONG> <STRONG>chtype</STRONG> <STRONG>rs,</STRONG> <STRONG>chtype</STRONG> <STRONG>ts,</STRONG> <STRONG>chtype</STRONG> <STRONG>bs,</STRONG> + <STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG> <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG> + <STRONG>int</STRONG> <STRONG>wborder(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ls,</STRONG> <STRONG>chtype</STRONG> <STRONG>rs,</STRONG> + <STRONG>chtype</STRONG> <STRONG>ts,</STRONG> <STRONG>chtype</STRONG> <STRONG>bs,</STRONG> <STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG> + <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG> + <STRONG>int</STRONG> <STRONG>box(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>verch,</STRONG> <STRONG>chtype</STRONG> <STRONG>horch);</STRONG> + <STRONG>int</STRONG> <STRONG>hline(chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>whline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>vline(chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>wvline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvhline(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwhline(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvvline(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwvline(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>border</STRONG>, <STRONG>wborder</STRONG> and <STRONG>box</STRONG> routines draw a box around the + edges of a window. Other than the window, each argument + is a character with attributes: + + <EM>ls</EM> - left side, + <EM>rs</EM> - right side, + <EM>ts</EM> - top side, + <EM>bs</EM> - bottom side, + <EM>tl</EM> - top left-hand corner, + <EM>tr</EM> - top right-hand corner, + <EM>bl</EM> - bottom left-hand corner, and + <EM>br</EM> - bottom right-hand corner. + + If any of these arguments is zero, then the corresponding + default values (defined in <STRONG>curses.h</STRONG>) are used instead: + + <STRONG>ACS_VLINE</STRONG>, + <STRONG>ACS_VLINE</STRONG>, + <STRONG>ACS_HLINE</STRONG>, + <STRONG>ACS_HLINE</STRONG>, + <STRONG>ACS_ULCORNER</STRONG>, + <STRONG>ACS_URCORNER</STRONG>, + <STRONG>ACS_LLCORNER</STRONG>, + <STRONG>ACS_LRCORNER</STRONG>. + + <STRONG>box(</STRONG><EM>win</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>)</STRONG> is a shorthand for the following + call: <STRONG>wborder(</STRONG><EM>win</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>,</STRONG> <STRONG>0,</STRONG> <STRONG>0,</STRONG> <STRONG>0,</STRONG> + <STRONG>0)</STRONG>. + + The <STRONG>hline</STRONG> and <STRONG>whline</STRONG> functions draw a horizontal (left to + right) line using <EM>ch</EM> starting at the current cursor posi- + tion in the window. The current cursor position is not + changed. The line is at most <EM>n</EM> characters long, or as + many as fit into the window. + + The <STRONG>vline</STRONG> and <STRONG>wvline</STRONG> functions draw a vertical (top to + bottom) line using <EM>ch</EM> starting at the current cursor posi- + tion in the window. The current cursor position is not + changed. The line is at most <EM>n</EM> characters long, or as + many as fit into the window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>OK</STRONG>. The SVr4.0 manual + says "or a non-negative integer if <STRONG>immedok</STRONG> is set", but + this appears to be an error. + + X/Open does not define any error conditions. This imple- + mentation returns an error if the window pointer is null. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + The borders generated by these functions are <EM>inside</EM> bor- + ders (this is also true of SVr4 curses, though the fact is + not documented). + + Note that <STRONG>border</STRONG> and <STRONG>box</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on + failure, but specifies no error conditions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_border_set.3x.html b/doc/html/man/curs_border_set.3x.html new file mode 100644 index 000000000000..c64a816c173e --- /dev/null +++ b/doc/html/man/curs_border_set.3x.html @@ -0,0 +1,184 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2010,2011 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_border_set.3x,v 1.10 2011/01/15 12:56:18 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_border_set 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_border_set 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>border_set</STRONG>, <STRONG>wborder_set</STRONG>, <STRONG>box_set</STRONG>, <STRONG>hline_set</STRONG>, <STRONG>whline_set</STRONG>, + <STRONG>mvhline_set</STRONG>, <STRONG>mvwhline_set</STRONG>, <STRONG>vline_set</STRONG>, <STRONG>wvline_set</STRONG>, + <STRONG>mvvline_set</STRONG>, <STRONG>mvwvline_set</STRONG> - create <STRONG>curses</STRONG> borders or lines + using complex characters and renditions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>border_set(</STRONG> + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>ls</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>rs</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>ts</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>bs</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>tl</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>tr</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>bl</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>br</EM> <STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wborder_set(</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*win</STRONG>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>ls</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>rs</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>ts</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>bs</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>tl</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>tr</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>bl</EM>, <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>br</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>box_set(</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*win</STRONG>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>verch</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>horch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>hline_set(</STRONG> + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>whline_set(</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvhline_set(</STRONG> + <STRONG>int</STRONG> <EM>y</EM>, <STRONG>int</STRONG> <EM>x</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwhline_set(</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM>, + <STRONG>int</STRONG> <EM>y</EM>, <STRONG>int</STRONG> <EM>x</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>vline_set(</STRONG> + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wvline_set(</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvvline_set(</STRONG> + <STRONG>int</STRONG> <EM>y</EM>, <STRONG>int</STRONG> <EM>x</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwvline_set(</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM>, + <STRONG>int</STRONG> <EM>y</EM>, <STRONG>int</STRONG> <EM>x</EM>, + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM>, <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>border_set</STRONG> and <STRONG>wborder_set</STRONG> functions draw a border + around the edges of the current or specified window. + These functions do not change the cursor position, and do + not wrap. + + Other than the window, each argument is a complex charac- + ter with attributes: + <EM>ls</EM> - left side, + <EM>rs</EM> - right side, + <EM>ts</EM> - top side, + <EM>bs</EM> - bottom side, + <EM>tl</EM> - top left-hand corner, + <EM>tr</EM> - top right-hand corner, + <EM>bl</EM> - bottom left-hand corner, and + <EM>br</EM> - bottom right-hand corner. + + If any of these arguments is zero, then the corresponding + default values (defined in <STRONG>curses.h</STRONG>) are used instead: + <STRONG>WACS_VLINE</STRONG>, + <STRONG>WACS_VLINE</STRONG>, + <STRONG>WACS_HLINE</STRONG>, + <STRONG>WACS_HLINE</STRONG>, + <STRONG>WACS_ULCORNER</STRONG>, + <STRONG>WACS_URCORNER</STRONG>, + <STRONG>WACS_LLCORNER</STRONG>, and + <STRONG>WACS_LRCORNER</STRONG>. + + <STRONG>box_set(</STRONG><EM>win</EM>, <EM>verch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>);</STRONG> is a shorthand for the follow- + ing call: + + <STRONG>wborder_set(</STRONG><EM>win</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> + <EM>horch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>,</STRONG> <STRONG>NULL,</STRONG> <STRONG>NULL,</STRONG> <STRONG>NULL,</STRONG> <STRONG>NULL);</STRONG> + + The <STRONG>*line_set</STRONG> functions use <EM>wch</EM> to draw a line starting at + the current cursor position in the window. The line is at + most <EM>n</EM> characters long or as many as fit into the window. + The current cursor position is not changed. + + The <STRONG>hline_set</STRONG>, <STRONG>mvhline_set</STRONG>, <STRONG>mvwhline_set</STRONG>, and <STRONG>whline_set</STRONG> + functions draw a line proceeding toward the last column of + the same line. + + The <STRONG>vline_set</STRONG>, <STRONG>mvvline_set</STRONG>, <STRONG>mvwvline_set</STRONG>, and <STRONG>wvline_set</STRONG> + functions draw a line proceeding toward the last line of + the window. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>border_set</STRONG>, <STRONG>hline_set</STRONG>, <STRONG>mvhline_set</STRONG>, <STRONG>mvvline_set</STRONG>, + <STRONG>mvwhline_set</STRONG>, <STRONG>mvwvline_set</STRONG>, and <STRONG>vline_set</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + Upon successful completion, these functions return <STRONG>OK</STRONG>. + Otherwise, they return <STRONG>ERR</STRONG>. + + Functions using a window parameter return an error if it + is null. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>, <STRONG>curs_out-</STRONG> + <STRONG><A HREF="curs_outopts.3x.html">opts(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html new file mode 100644 index 000000000000..ca581c2b0b14 --- /dev/null +++ b/doc/html/man/curs_clear.3x.html @@ -0,0 +1,146 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_clear.3x,v 1.14 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_clear 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_clear 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, <STRONG>wclrtobot</STRONG>, + <STRONG>clrtoeol</STRONG>, <STRONG>wclrtoeol</STRONG> - clear all or part of a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#</STRONG> <STRONG>include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>erase(void);</STRONG> + <STRONG>int</STRONG> <STRONG>werase(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>clear(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wclear(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>clrtobot(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wclrtobot(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>clrtoeol(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wclrtoeol(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>erase</STRONG> and <STRONG>werase</STRONG> routines copy blanks to every posi- + tion in the window, clearing the screen. + + The <STRONG>clear</STRONG> and <STRONG>wclear</STRONG> routines are like <STRONG>erase</STRONG> and <STRONG>werase</STRONG>, + but they also call <STRONG>clearok</STRONG>, so that the screen is cleared + completely on the next call to <STRONG>wrefresh</STRONG> for that window + and repainted from scratch. + + The <STRONG>clrtobot</STRONG> and <STRONG>wclrtobot</STRONG> routines erase from the cursor + to the end of screen. That is, they erase all lines below + the cursor in the window. Also, the current line to the + right of the cursor, inclusive, is erased. + + The <STRONG>clrtoeol</STRONG> and <STRONG>wclrtoeol</STRONG> routines erase the current line + to the right of the cursor, inclusive, to the end of the + current line. + + Blanks created by erasure have the current background ren- + dition (as set by <STRONG>wbkgdset</STRONG>) merged into them. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on + failure. The SVr4.0 manual says "or a non-negative inte- + ger if <STRONG>immedok</STRONG> is set", but this appears to be an error. + + X/Open defines no error conditions. In this implementa- + tion, functions using a window pointer parameter return an + error if it is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, and <STRONG>clr-</STRONG> + <STRONG>toeol</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on + failure, but specifies no error conditions. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(std-</STRONG> + <STRONG>scr)</STRONG>. This will not work under ncurses. + + This implementation, and others such as Solaris, sets the + current position to 0,0 after erasing via <STRONG>werase()</STRONG> and + <STRONG>wclear()</STRONG>. That fact is not documented in other implemen- + tations, and may not be true of implementations which were + not derived from SVr4 source. + + Not obvious from the description, most implementations + clear the screen after <STRONG>wclear</STRONG> even for a subwindow or de- + rived window. If you do not want to clear the screen dur- + ing the next <STRONG>wrefresh</STRONG>, use <STRONG>werase</STRONG> instead. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> + <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_color.3x.html b/doc/html/man/curs_color.3x.html new file mode 100644 index 000000000000..39a73184fccb --- /dev/null +++ b/doc/html/man/curs_color.3x.html @@ -0,0 +1,285 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_color.3x,v 1.35 2010/12/20 00:50:58 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_color 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_color 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>start_color</STRONG>, <STRONG>init_pair</STRONG>, <STRONG>init_color</STRONG>, <STRONG>has_colors</STRONG>, + <STRONG>can_change_color</STRONG>, <STRONG>color_content</STRONG>, <STRONG>pair_content</STRONG>, <STRONG>COLOR_PAIR</STRONG> + - <STRONG>curses</STRONG> color manipulation routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#</STRONG> <STRONG>include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>start_color(void);</STRONG> + <STRONG>int</STRONG> <STRONG>init_pair(short</STRONG> <STRONG>pair,</STRONG> <STRONG>short</STRONG> <STRONG>f,</STRONG> <STRONG>short</STRONG> <STRONG>b);</STRONG> + <STRONG>int</STRONG> <STRONG>init_color(short</STRONG> <STRONG>color,</STRONG> <STRONG>short</STRONG> <STRONG>r,</STRONG> <STRONG>short</STRONG> <STRONG>g,</STRONG> <STRONG>short</STRONG> <STRONG>b);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_colors(void);</STRONG> + <STRONG>bool</STRONG> <STRONG>can_change_color(void);</STRONG> + <STRONG>int</STRONG> <STRONG>color_content(short</STRONG> <STRONG>color,</STRONG> <STRONG>short</STRONG> <STRONG>*r,</STRONG> <STRONG>short</STRONG> <STRONG>*g,</STRONG> <STRONG>short</STRONG> + <STRONG>*b);</STRONG> + <STRONG>int</STRONG> <STRONG>pair_content(short</STRONG> <STRONG>pair,</STRONG> <STRONG>short</STRONG> <STRONG>*f,</STRONG> <STRONG>short</STRONG> <STRONG>*b);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>Overview</STRONG> + <STRONG>curses</STRONG> support color attributes on terminals with that ca- + pability. To use these routines <STRONG>start_color</STRONG> must be + called, usually right after <STRONG>initscr</STRONG>. Colors are always + used in pairs (referred to as color-pairs). A color-pair + consists of a foreground color (for characters) and a + background color (for the blank field on which the charac- + ters are displayed). A programmer initializes a color- + pair with the routine <STRONG>init_pair</STRONG>. After it has been ini- + tialized, <STRONG>COLOR_PAIR</STRONG>(<EM>n</EM>), a macro defined in <STRONG><curses.h></STRONG>, + can be used as a new video attribute. + + If a terminal is capable of redefining colors, the pro- + grammer can use the routine <STRONG>init_color</STRONG> to change the defi- + nition of a color. The routines <STRONG>has_colors</STRONG> and + <STRONG>can_change_color</STRONG> return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>, depending on + whether the terminal has color capabilities and whether + the programmer can change the colors. The routine <STRONG>col-</STRONG> + <STRONG>or_content</STRONG> allows a programmer to extract the amounts of + red, green, and blue components in an initialized color. + The routine <STRONG>pair_content</STRONG> allows a programmer to find out + how a given color-pair is currently defined. + + <STRONG>Routine</STRONG> <STRONG>Descriptions</STRONG> + The <STRONG>start_color</STRONG> routine requires no arguments. It must be + called if the programmer wants to use colors, and before + any other color manipulation routine is called. It is + good practice to call this routine right after <STRONG>initscr</STRONG>. + <STRONG>start_color</STRONG> initializes eight basic colors (black, red, + green, yellow, blue, magenta, cyan, and white), and two + global variables, <STRONG>COLORS</STRONG> and <STRONG>COLOR_PAIRS</STRONG> (respectively + defining the maximum number of colors and color-pairs the + terminal can support). It also restores the colors on the + terminal to the values they had when the terminal was just + turned on. + + The <STRONG>init_pair</STRONG> routine changes the definition of a color- + pair. It takes three arguments: the number of the color- + pair to be changed, the foreground color number, and the + background color number. For portable applications: + + <STRONG>o</STRONG> The value of the first argument must be between <STRONG>1</STRONG> and + <STRONG>COLOR_PAIRS-1</STRONG>, except that if default colors are used + (see <STRONG>use_default_colors</STRONG>) the upper limit is adjusted + to allow for extra pairs which use a default color in + foreground and/or background. + + <STRONG>o</STRONG> The value of the second and third arguments must be + between 0 and <STRONG>COLORS</STRONG>. Color pair 0 is assumed to be + white on black, but is actually whatever the terminal + implements before color is initialized. It cannot be + modified by the application. + + If the color-pair was previously initialized, the screen + is refreshed and all occurrences of that color-pair are + changed to the new definition. + + As an extension, ncurses allows you to set color pair 0 + via the <STRONG>assume_default_colors</STRONG> routine, or to specify the + use of default colors (color number <STRONG>-1</STRONG>) if you first in- + voke the <STRONG>use_default_colors</STRONG> routine. + + The <STRONG>init_color</STRONG> routine changes the definition of a color. + It takes four arguments: the number of the color to be + changed followed by three RGB values (for the amounts of + red, green, and blue components). The value of the first + argument must be between <STRONG>0</STRONG> and <STRONG>COLORS</STRONG>. (See the section + <STRONG>Colors</STRONG> for the default color index.) Each of the last + three arguments must be a value between 0 and 1000. When + <STRONG>init_color</STRONG> is used, all occurrences of that color on the + screen immediately change to the new definition. + + The <STRONG>has_colors</STRONG> routine requires no arguments. It returns + <STRONG>TRUE</STRONG> if the terminal can manipulate colors; otherwise, it + returns <STRONG>FALSE</STRONG>. This routine facilitates writing terminal- + independent programs. For example, a programmer can use + it to decide whether to use color or some other video at- + tribute. + + The <STRONG>can_change_color</STRONG> routine requires no arguments. It + returns <STRONG>TRUE</STRONG> if the terminal supports colors and can + change their definitions; other, it returns <STRONG>FALSE</STRONG>. This + routine facilitates writing terminal-independent programs. + + The <STRONG>color_content</STRONG> routine gives programmers a way to find + the intensity of the red, green, and blue (RGB) components + in a color. It requires four arguments: the color number, + and three addresses of <STRONG>short</STRONG>s for storing the information + about the amounts of red, green, and blue components in + the given color. The value of the first argument must be + between 0 and <STRONG>COLORS</STRONG>. The values that are stored at the + addresses pointed to by the last three arguments are be- + tween 0 (no component) and 1000 (maximum amount of compo- + nent). + + The <STRONG>pair_content</STRONG> routine allows programmers to find out + what colors a given color-pair consists of. It requires + three arguments: the color-pair number, and two addresses + of <STRONG>short</STRONG>s for storing the foreground and the background + color numbers. The value of the first argument must be + between 1 and <STRONG>COLOR_PAIRS-1</STRONG>. The values that are stored + at the addresses pointed to by the second and third argu- + ments are between 0 and <STRONG>COLORS</STRONG>. + + <STRONG>Colors</STRONG> + In <STRONG><curses.h></STRONG> the following macros are defined. These are + the default colors. <STRONG>curses</STRONG> also assumes that <STRONG>COLOR_BLACK</STRONG> + is the default background color for all terminals. + + <STRONG>COLOR_BLACK</STRONG> + <STRONG>COLOR_RED</STRONG> + <STRONG>COLOR_GREEN</STRONG> + <STRONG>COLOR_YELLOW</STRONG> + <STRONG>COLOR_BLUE</STRONG> + <STRONG>COLOR_MAGENTA</STRONG> + <STRONG>COLOR_CYAN</STRONG> + <STRONG>COLOR_WHITE</STRONG> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The routines <STRONG>can_change_color()</STRONG> and <STRONG>has_colors()</STRONG> return + <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>. + + All other routines return the integer <STRONG>ERR</STRONG> upon failure and + an <STRONG>OK</STRONG> (SVr4 specifies only "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion. + + X/Open defines no error conditions. This implementation + will return <STRONG>ERR</STRONG> on attempts to use color values outside + the range 0 to COLORS-1 (except for the default colors ex- + tension), or use color pairs outside the range 0 to COL- + OR_PAIRS-1. Color values used in <STRONG>init_color</STRONG> must be in + the range 0 to 1000. An error is returned from all func- + tions if the terminal has not been initialized. An error + is returned from secondary functions such as <STRONG>init_pair</STRONG> if + <STRONG>start_color</STRONG> was not called. + + <STRONG>init_color</STRONG> + returns an error if the terminal does not support + this feature, e.g., if the <EM>initialize</EM><STRONG>_</STRONG><EM>color</EM> capa- + bility is absent from the terminal description. + + <STRONG>start_color</STRONG> + returns an error if the color table cannot be al- + located. + + +</PRE> +<H2>NOTES</H2><PRE> + In the <EM>ncurses</EM> implementation, there is a separate color + activation flag, color palette, color pairs table, and as- + sociated COLORS and COLOR_PAIRS counts for each screen; + the <STRONG>start_color</STRONG> function only affects the current screen. + The SVr4/XSI interface is not really designed with this in + mind, and historical implementations may use a single + shared color palette. + + Note that setting an implicit background color via a color + pair affects only character cells that a character write + operation explicitly touches. To change the background + color used when parts of a window are blanked by erasing + or scrolling operations, see <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>. + + Several caveats apply on 386 and 486 machines with VGA- + compatible graphics: + + <STRONG>o</STRONG> COLOR_YELLOW is actually brown. To get yellow, use + COLOR_YELLOW combined with the <STRONG>A_BOLD</STRONG> attribute. + + <STRONG>o</STRONG> The A_BLINK attribute should in theory cause the back- + ground to go bright. This often fails to work, and + even some cards for which it mostly works (such as the + Paradise and compatibles) do the wrong thing when you + try to set a bright "yellow" background (you get a + blinking yellow foreground instead). + + <STRONG>o</STRONG> Color RGB values are not settable. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + This implementation satisfies XSI Curses's minimum maxi- + mums for <STRONG>COLORS</STRONG> and <STRONG>COLOR_PAIRS</STRONG>. + + The <STRONG>init_pair</STRONG> routine accepts negative values of fore- + ground and background color to support the <STRONG>use_de-</STRONG> + <STRONG>fault_colors</STRONG> extension, but only if that routine has been + first invoked. + + The assumption that <STRONG>COLOR_BLACK</STRONG> is the default background + color for all terminals can be modified using the <STRONG>as-</STRONG> + <STRONG>sume_default_colors</STRONG> extension. + + This implementation checks the pointers, e.g., for the + values returned by <STRONG>color_content</STRONG> and <STRONG>pair_content</STRONG>, and + will treat those as optional parameters when null. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> + <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>, <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_delch.3x.html b/doc/html/man/curs_delch.3x.html new file mode 100644 index 000000000000..174b17d8e629 --- /dev/null +++ b/doc/html/man/curs_delch.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_delch.3x,v 1.11 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_delch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_delch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>delch</STRONG>, <STRONG>wdelch</STRONG>, <STRONG>mvdelch</STRONG>, <STRONG>mvwdelch</STRONG> - delete character under + the cursor in a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>delch(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wdelch(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>mvdelch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwdelch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines delete 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 (after moving to <EM>y</EM>, <EM>x</EM>, if specified). (This + does not imply use of the hardware delete character fea- + ture.) + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> + (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") + upon successful completion. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>delch</STRONG>, <STRONG>mvdelch</STRONG>, and <STRONG>mvwdelch</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on + failure, but specifies no error conditions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_deleteln.3x.html b/doc/html/man/curs_deleteln.3x.html new file mode 100644 index 000000000000..5015849dd090 --- /dev/null +++ b/doc/html/man/curs_deleteln.3x.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_deleteln.3x,v 1.13 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_deleteln 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_deleteln 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>deleteln</STRONG>, <STRONG>wdeleteln</STRONG>, <STRONG>insdelln</STRONG>, <STRONG>winsdelln</STRONG>, <STRONG>insertln</STRONG>, <STRONG>win-</STRONG> + <STRONG>sertln</STRONG> - delete and insert lines in a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>deleteln(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wdeleteln(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>insdelln(int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>winsdelln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>insertln(void);</STRONG> + <STRONG>int</STRONG> <STRONG>winsertln(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>deleteln</STRONG> and <STRONG>wdeleteln</STRONG> routines delete the line under + the cursor in the window; all lines below the current line + are moved up one line. The bottom line of the window is + cleared. The cursor position does not change. + + The <STRONG>insdelln</STRONG> and <STRONG>winsdelln</STRONG> routines, for positive <EM>n</EM>, + insert <EM>n</EM> lines into the specified window above the current + line. The <EM>n</EM> bottom lines are lost. For negative <EM>n</EM>, + delete <EM>n</EM> lines (starting with the one under the cursor), + and move the remaining lines up. The bottom <EM>n</EM> lines are + cleared. The current cursor position remains the same. + + The <STRONG>insertln</STRONG> and <STRONG>winsertln</STRONG> routines insert a blank line + above the current line and the bottom line is lost. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> + (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") + upon successful completion. + + X/Open defines no error conditions. In this implementa- + tion, if the window parameter is null, an error is + returned. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on + failure, but specifies no error conditions. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all but <STRONG>winsdelln</STRONG> may be macros. + + These routines do not require a hardware line delete or + insert feature in the terminal. In fact, they will not + use hardware line delete/insert unless <STRONG>idlok(...,</STRONG> <STRONG>TRUE)</STRONG> + has been set on the current window. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_extend.3x.html b/doc/html/man/curs_extend.3x.html new file mode 100644 index 000000000000..a90ccd717f51 --- /dev/null +++ b/doc/html/man/curs_extend.3x.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1999-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1999-on + * @Id: curs_extend.3x,v 1.19 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_extend 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_extend 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous curses + extensions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>curses_version(void);</STRONG> + <STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <STRONG>enable);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions are extensions to the curses library which + do not fit easily into other categories. + + Use <EM>curses</EM><STRONG>_</STRONG><EM>version()</EM> to get the version number, including + patch level of the library, e.g., <STRONG>5.0.19991023</STRONG> + + The <EM>use</EM><STRONG>_</STRONG><EM>extended</EM><STRONG>_</STRONG><EM>names()</EM> function controls whether the + calling application is able to use user-defined or non- + standard names which may be compiled into the terminfo + description, i.e., via the terminfo or termcap interfaces. + Normally these names are available for use, since the + essential decision is made by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> + to compile extended terminal definitions. However you can + disable this feature to ensure compatibility with other + implementations of curses. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>, <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>, + <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG>key-</STRONG> + <STRONG><A HREF="keybound.3x.html">bound(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_get_wch.3x.html b/doc/html/man/curs_get_wch.3x.html new file mode 100644 index 000000000000..0b2373e6b74f --- /dev/null +++ b/doc/html/man/curs_get_wch.3x.html @@ -0,0 +1,155 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_get_wch.3x,v 1.7 2010/08/14 23:31:42 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_get_wch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_get_wch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, <STRONG>mvwget_wch</STRONG>, <STRONG>unget_wch</STRONG> - get + (or push back) a wide character from curses terminal key- + board + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>get_wch(wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wget_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvget_wch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwget_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions + read a character from the terminal associated with the + current or specified window. In no-delay mode, if no + input is waiting, the value <STRONG>ERR</STRONG> is returned. In delay + mode, the program waits until the system passes text + through to the program. Depending on the setting of + <STRONG>cbreak</STRONG>, this is after one character (cbreak mode), or + after the first newline (nocbreak mode). In half-delay + mode, the program waits until the user types a character + or the specified timeout interval has elapsed. + + Unless <STRONG>noecho</STRONG> has been set, these routines echo the char- + acter into the designated window. + + If the window is not a pad and has been moved or modified + since the last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will be called + before another character is read. + + If <STRONG>keypad</STRONG> is enabled, these functions respond to the + pressing of a function key by setting the object pointed + to by <EM>wch</EM> to the corresponding <STRONG>KEY_</STRONG> value defined in + <STRONG><curses.h></STRONG> and returning <STRONG>KEY_CODE_YES</STRONG>. If a character + (such as escape) that could be the beginning of a function + key is received, curses sets a timer. If the remainder of + the sequence does arrive within the designated time, + curses passes through the character; otherwise, curses + returns the function key value. For this reason, many + terminals experience a delay between the time a user + presses the escape key and the time the escape is returned + to the program. + + The <STRONG>unget_wch</STRONG> function pushes the wide character <EM>wch</EM> back + onto the head of the input queue, so the wide character is + returned by the next call to <STRONG>get_wch</STRONG>. The pushback of one + character is guaranteed. If the program calls <STRONG>unget_wch</STRONG> + too many times without an intervening call to <STRONG>get_wch</STRONG>, the + operation may fail. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><curses.h></STRONG> automatically includes the + header file <STRONG><stdio.h></STRONG>. + + Applications should not define the escape key by itself as + a single-character function. + + When using <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, or <STRONG>mvwget_wch</STRONG>, + applications should not use <STRONG>nocbreak</STRONG> mode and <STRONG>echo</STRONG> mode at + the same time. Depending on the state of the tty driver + when each character is typed, the program may produce + undesirable results. + + All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + When <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> func- + tions successfully report the pressing of a function key, + they return <STRONG>KEY_CODE_YES</STRONG>. When they successfully report a + wide character, they return <STRONG>OK</STRONG>. Otherwise, they return + <STRONG>ERR</STRONG>. + + Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>. Other- + wise, the function returns <STRONG>ERR</STRONG>. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>, + <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html new file mode 100644 index 000000000000..5775678fe042 --- /dev/null +++ b/doc/html/man/curs_get_wstr.3x.html @@ -0,0 +1,166 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_get_wstr.3x,v 1.8 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_get_wstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_get_wstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, + <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of + wide characters from a curses terminal keyboard + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>get_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>getn_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wget_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wgetn_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvget_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvgetn_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwget_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwgetn_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to + <STRONG>get_wch</STRONG> were made, until a newline, other end-of-line, or + end-of-file condition is processed. An end-of-file condi- + tion is represented by <STRONG>WEOF</STRONG>, as defined in <STRONG><wchar.h></STRONG>. The + newline and end-of-line conditions are represented by the + <STRONG>\n</STRONG> <STRONG>wchar_t</STRONG> value. In all instances, the end of the string + is terminated by a null <STRONG>wchar_t</STRONG>. The routine places re- + sulting values in the area pointed to by <EM>wstr</EM>. + + The user's erase and kill characters are interpreted. If + keypad mode is on for the window, <STRONG>KEY_LEFT</STRONG> and + <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's + kill character. + + Characters input are echoed only if <STRONG>echo</STRONG> is currently on. + In that case, backspace is echoed as deletion of the pre- + vious character (typically a left motion). + + The effect of <STRONG>wget_wstr</STRONG> is as though a series of calls to + <STRONG>wget_wch</STRONG> were made. + + The effect of <STRONG>mvget_wstr</STRONG> is as though a call to <STRONG>move</STRONG> and + then a series of calls to <STRONG>get_wch</STRONG> were made. + + The effect of <STRONG>mvwget_wstr</STRONG> is as though a call to <STRONG>wmove</STRONG> and + then a series of calls to <STRONG>wget_wch</STRONG> were made. + + The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> + functions are identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, + <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG> functions, respectively, except + that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM> characters, letting + the application prevent overflow of the input buffer. + + +</PRE> +<H2>NOTES</H2><PRE> + Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to + read a line that overflows the array pointed to by <STRONG>wstr</STRONG> + causes undefined results. The use of <STRONG>getn_wstr</STRONG>, + <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>, respectively, is + recommended. + + These functions cannot return <STRONG>KEY_</STRONG> values because there is + no way to distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> + value. + + All of these routines except <STRONG>wgetn_wstr</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All of these functions return <STRONG>OK</STRONG> upon successful comple- + tion. Otherwise, they return <STRONG>ERR</STRONG>. + + Functions using a window parameter return an error if it + is null. + + <STRONG>wgetn_wstr</STRONG> + returns an error if the associated call to + <STRONG>wget_wch</STRONG> failed. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in The Single Unix Specifi- + cation, Version 2. No error conditions are defined. This + implementation returns ERR if the window pointer is null, + or if the lower-level <STRONG>wget_wch</STRONG> call returns an ERR. In + the latter case, an ERR return without other data is + treated as an end-of-file condition, and the returned ar- + ray contains a <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>. + + X/Open curses documents these functions to pass an array + of <STRONG>wchar_t</STRONG>, but all of the vendors implement this using + <STRONG>wint_t</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html new file mode 100644 index 000000000000..22cb819fbd3d --- /dev/null +++ b/doc/html/man/curs_getcchar.3x.html @@ -0,0 +1,158 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2001-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_getcchar.3x,v 1.15 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_getcchar 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_getcchar 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>getcchar</STRONG>, <STRONG>setcchar</STRONG> - Get a wide character string and ren- + dition from a <STRONG>cchar_t</STRONG> or set a <STRONG>cchar_t</STRONG> from a wide-charac- + ter string + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>getcchar(</STRONG> + <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG> + <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG> + <STRONG>attr_t</STRONG> <STRONG>*</STRONG><EM>attrs</EM><STRONG>,</STRONG> + <STRONG>short</STRONG> <STRONG>*</STRONG><EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG> + <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG> + + <STRONG>int</STRONG> <STRONG>setcchar(</STRONG> + <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>,</STRONG> + <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>,</STRONG> + <STRONG>const</STRONG> <STRONG>attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> + <STRONG>short</STRONG> <EM>color</EM><STRONG>_</STRONG><EM>pair</EM><STRONG>,</STRONG> + <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM> <STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>getcchar</STRONG> function gets a wide-character string and + rendition from a <STRONG>cchar_t</STRONG> argument. When <EM>wch</EM> is not a null + pointer, the <STRONG>getcchar</STRONG> function does the following: + + <STRONG>o</STRONG> Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM> + + <STRONG>o</STRONG> Stores the character attributes in the location + pointed to by <EM>attrs</EM> + + <STRONG>o</STRONG> Stores the color-pair in the location pointed to by + <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> + + <STRONG>o</STRONG> Stores the wide-character string, characters refer- + enced by <EM>wcval</EM>, into the array pointed to by <EM>wch</EM>. + + When <EM>wch</EM> is a null pointer, the <STRONG>getcchar</STRONG> function does the + following: + + <STRONG>o</STRONG> Obtains the number of wide characters pointed to by + <EM>wcval</EM> + + <STRONG>o</STRONG> Does not change the data referenced by <EM>attrs</EM> or + <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> + + The <STRONG>setcchar</STRONG> function initializes the location pointed to + by <EM>wcval</EM> by using: + + <STRONG>o</STRONG> The character attributes in <EM>attrs</EM> + + <STRONG>o</STRONG> The color pair in <EM>color</EM><STRONG>_</STRONG><EM>pair</EM> + + <STRONG>o</STRONG> The wide-character string pointed to by <EM>wch</EM>. The + string must be L'\0' terminated, contain at most one + spacing character, which must be the first. + + Up to <STRONG>CCHARW_MAX</STRONG>-1 nonspacing characters may follow. + Additional nonspacing characters are ignored. + + The string may contain a single control character + instead. In that case, no nonspacing characters are + allowed. + + +</PRE> +<H2>NOTES</H2><PRE> + The <EM>opts</EM> argument is reserved for future use. Currently, + an application must provide a null pointer as <EM>opts</EM>. + + The <EM>wcval</EM> argument may be a value generated by a call to + <STRONG>setcchar</STRONG> or by a function that has a <STRONG>cchar_t</STRONG> output argu- + ment. If <EM>wcval</EM> is constructed by any other means, the + effect is unspecified. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of + wide characters referenced by <EM>wcval</EM>, including one for a + trailing null. + + When <EM>wch</EM> is not a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon + successful completion, and <STRONG>ERR</STRONG> otherwise. + + Upon successful completion, <STRONG>setcchar</STRONG> returns <STRONG>OK</STRONG>. Other- + wise, it returns <STRONG>ERR</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + Functions: <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, + <STRONG><A HREF="wcwidth.3.html">wcwidth(3)</A></STRONG>. + + + + <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html new file mode 100644 index 000000000000..2bdcdc423a25 --- /dev/null +++ b/doc/html/man/curs_getch.3x.html @@ -0,0 +1,359 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_getch.3x,v 1.36 2011/01/22 19:38:51 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_getch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_getch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG>, <STRONG>mvwgetch</STRONG>, <STRONG>ungetch</STRONG>, <STRONG>has_key</STRONG> - get + (or push back) characters from <STRONG>curses</STRONG> terminal keyboard + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>getch(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wgetch(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>mvgetch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwgetch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>int</STRONG> <STRONG>ungetch(int</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>has_key(int</STRONG> <STRONG>ch);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG> and <STRONG>mvwgetch</STRONG>, routines read a + character from the window. In no-delay mode, if no input + is waiting, the value <STRONG>ERR</STRONG> is returned. In delay mode, the + program waits until the system passes text through to the + program. Depending on the setting of <STRONG>cbreak</STRONG>, this is af- + ter one character (cbreak mode), or after the first new- + line (nocbreak mode). In half-delay mode, the program + waits until a character is typed or the specified timeout + has been reached. + + Unless <STRONG>noecho</STRONG> has been set, then the character will also + be echoed into the designated window according to the fol- + lowing rules: if the character is the current erase char- + acter, left arrow, or backspace, the cursor is moved one + space to the left and that screen position is erased as if + <STRONG>delch</STRONG> had been called. If the character value is any oth- + er <STRONG>KEY_</STRONG> define, the user is alerted with a <STRONG>beep</STRONG> call. + Otherwise the character is simply output to the screen. + + If the window is not a pad, and it has been moved or modi- + fied since the last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will be + called before another character is read. + + If <STRONG>keypad</STRONG> is <STRONG>TRUE</STRONG>, and a function key is pressed, the to- + ken for that function key is returned instead of the raw + characters. Possible function keys are defined in <STRONG><curs-</STRONG> + <STRONG>es.h></STRONG> as macros with values outside the range of 8-bit + characters whose names begin with <STRONG>KEY_</STRONG>. Thus, a variable + intended to hold the return value of a function key must + be of short size or larger. + + When a character that could be the beginning of a function + key is received (which, on modern terminals, means an es- + cape character), <STRONG>curses</STRONG> sets a timer. If the remainder of + the sequence does not come in within the designated time, + the character is passed through; otherwise, the function + key value is returned. For this reason, many terminals + experience a delay between the time a user presses the es- + cape key and the escape is returned to the program. + + The <STRONG>ungetch</STRONG> routine places <EM>ch</EM> back onto the input queue to + be returned by the next call to <STRONG>wgetch</STRONG>. There is just one + input queue for all windows. + + + <STRONG>Function</STRONG> <STRONG>Keys</STRONG> + The following function keys, defined in <STRONG><curses.h></STRONG>, might + be returned by <STRONG>getch</STRONG> if <STRONG>keypad</STRONG> has been enabled. Note + that not all of these are necessarily supported on any + particular terminal. + + + <EM>Name</EM> <EM>Key</EM> <EM>name</EM> + KEY_BREAK Break key + KEY_DOWN The four arrow keys ... + KEY_UP + KEY_LEFT + KEY_RIGHT + KEY_HOME Home key (upward+left arrow) + KEY_BACKSPACE Backspace + KEY_F0 Function keys; space for 64 keys + is reserved. + KEY_F(<EM>n</EM>) For 0 <= <EM>n</EM> <= 63 + KEY_DL Delete line + KEY_IL Insert line + KEY_DC Delete character + KEY_IC Insert char or enter insert mode + KEY_EIC Exit insert char mode + KEY_CLEAR Clear screen + KEY_EOS Clear to end of screen + KEY_EOL Clear to end of line + KEY_SF Scroll 1 line forward + KEY_SR Scroll 1 line backward (reverse) + KEY_NPAGE Next page + KEY_PPAGE Previous page + KEY_STAB Set tab + KEY_CTAB Clear tab + KEY_CATAB Clear all tabs + KEY_ENTER Enter or send + KEY_SRESET Soft (partial) reset + KEY_RESET Reset or hard reset + KEY_PRINT Print or copy + KEY_LL Home down or bottom (lower left) + KEY_A1 Upper left of keypad + KEY_A3 Upper right of keypad + KEY_B2 Center of keypad + KEY_C1 Lower left of keypad + KEY_C3 Lower right of keypad + KEY_BTAB Back tab key + KEY_BEG Beg(inning) key + KEY_CANCEL Cancel key + KEY_CLOSE Close key + KEY_COMMAND Cmd (command) key + KEY_COPY Copy key + KEY_CREATE Create key + KEY_END End key + KEY_EXIT Exit key + KEY_FIND Find key + KEY_HELP Help key + KEY_MARK Mark key + KEY_MESSAGE Message key + KEY_MOUSE Mouse event read + KEY_MOVE Move key + KEY_NEXT Next object key + KEY_OPEN Open key + KEY_OPTIONS Options key + KEY_PREVIOUS Previous object key + KEY_REDO Redo key + KEY_REFERENCE Ref(erence) key + KEY_REFRESH Refresh key + KEY_REPLACE Replace key + KEY_RESIZE Screen resized + KEY_RESTART Restart key + KEY_RESUME Resume key + + KEY_SAVE Save key + KEY_SBEG Shifted beginning key + KEY_SCANCEL Shifted cancel key + KEY_SCOMMAND Shifted command key + KEY_SCOPY Shifted copy key + KEY_SCREATE Shifted create key + KEY_SDC Shifted delete char key + KEY_SDL Shifted delete line key + KEY_SELECT Select key + KEY_SEND Shifted end key + KEY_SEOL Shifted clear line key + KEY_SEXIT Shifted exit key + KEY_SFIND Shifted find key + KEY_SHELP Shifted help key + KEY_SHOME Shifted home key + KEY_SIC Shifted input key + KEY_SLEFT Shifted left arrow key + KEY_SMESSAGE Shifted message key + KEY_SMOVE Shifted move key + KEY_SNEXT Shifted next key + KEY_SOPTIONS Shifted options key + KEY_SPREVIOUS Shifted prev key + KEY_SPRINT Shifted print key + KEY_SREDO Shifted redo key + KEY_SREPLACE Shifted replace key + KEY_SRIGHT Shifted right arrow + KEY_SRSUME Shifted resume key + KEY_SSAVE Shifted save key + KEY_SSUSPEND Shifted suspend key + KEY_SUNDO Shifted undo key + KEY_SUSPEND Suspend key + KEY_UNDO Undo key + + Keypad is arranged like this: + + + +-----+------+-------+ + | <STRONG>A1</STRONG> | <STRONG>up</STRONG> | <STRONG>A3</STRONG> | + +-----+------+-------+ + |<STRONG>left</STRONG> | <STRONG>B2</STRONG> | <STRONG>right</STRONG> | + +-----+------+-------+ + | <STRONG>C1</STRONG> | <STRONG>down</STRONG> | <STRONG>C3</STRONG> | + +-----+------+-------+ + The <STRONG>has_key</STRONG> routine takes a key value from the above list, + and returns TRUE or FALSE according to whether the current + terminal type recognizes a key with that value. Note that + a few values do not correspond to a real key, e.g., + <STRONG>KEY_RESIZE</STRONG> and <STRONG>KEY_MOUSE</STRONG>. See <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> for more de- + tails about <STRONG>KEY_RESIZE</STRONG>, and <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> for a discus- + sion of <STRONG>KEY_MOUSE</STRONG>. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an + integer value other than <STRONG>ERR</STRONG> (<STRONG>OK</STRONG> in the case of ungetch()) + upon successful completion. + + <STRONG>ungetch</STRONG> + returns an error if there is no more room in + the FIFO. + + <STRONG>wgetch</STRONG> + returns an error if the window pointer is + null, or if its timeout expires without having + any data. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Use of the escape key by a programmer for a single charac- + ter function is discouraged, as it will cause a delay of + up to one second while the keypad code looks for a follow- + ing function-key sequence. + + Note that some keys may be the same as commonly used con- + trol keys, e.g., <STRONG>KEY_ENTER</STRONG> versus control/M, <STRONG>KEY_BACKSPACE</STRONG> + versus control/H. Some curses implementations may differ + according to whether they treat these control keys spe- + cially (and ignore the terminfo), or use the terminfo def- + initions. <STRONG>Ncurses</STRONG> uses the terminfo definition. If it + says that <STRONG>KEY_ENTER</STRONG> is control/M, <STRONG>getch</STRONG> will return + <STRONG>KEY_ENTER</STRONG> when you press control/M. + + Generally, <STRONG>KEY_ENTER</STRONG> denotes the character(s) sent by the + <EM>Enter</EM> key on the numeric keypad: + + <STRONG>o</STRONG> the terminal description lists the most useful keys, + + <STRONG>o</STRONG> the <EM>Enter</EM> key on the regular keyboard is already han- + dled by the standard ASCII characters for carriage-re- + turn and line-feed, + + <STRONG>o</STRONG> depending on whether <STRONG>nl</STRONG> or <STRONG>nonl</STRONG> was called, pressing + "Enter" on the regular keyboard may return either a + carriage-return or line-feed, and finally + + <STRONG>o</STRONG> "Enter or send" is the standard description for this + key. + + When using <STRONG>getch</STRONG>, <STRONG>wgetch</STRONG>, <STRONG>mvgetch</STRONG>, or <STRONG>mvwgetch</STRONG>, nocbreak + mode (<STRONG>nocbreak</STRONG>) and echo mode (<STRONG>echo</STRONG>) should not be used at + the same time. Depending on the state of the tty driver + when each character is typed, the program may produce un- + desirable results. + + Note that <STRONG>getch</STRONG>, <STRONG>mvgetch</STRONG>, and <STRONG>mvwgetch</STRONG> may be macros. + + Historically, the set of keypad macros was largely defined + by the extremely function-key-rich keyboard of the AT&T + 7300, aka 3B1, aka Safari 4. Modern personal computers + usually have only a small subset of these. IBM PC-style + consoles typically support little more than <STRONG>KEY_UP</STRONG>, + <STRONG>KEY_DOWN</STRONG>, <STRONG>KEY_LEFT</STRONG>, <STRONG>KEY_RIGHT</STRONG>, <STRONG>KEY_HOME</STRONG>, <STRONG>KEY_END</STRONG>, + <STRONG>KEY_NPAGE</STRONG>, <STRONG>KEY_PPAGE</STRONG>, and function keys 1 through 12. The + Ins key is usually mapped to <STRONG>KEY_IC</STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The *get* functions are described in the XSI Curses stan- + dard, Issue 4. They read single-byte characters only. + The standard specifies that they return <STRONG>ERR</STRONG> on failure, + but specifies no error conditions. + + The echo behavior of these functions on input of <STRONG>KEY_</STRONG> or + backspace characters was not specified in the SVr4 docu- + mentation. This description is adopted from the XSI Curs- + es standard. + + The behavior of <STRONG>getch</STRONG> and friends in the presence of han- + dled signals is unspecified in the SVr4 and XSI Curses + documentation. Under historical curses implementations, + it varied depending on whether the operating system's im- + plementation of handled signal receipt interrupts a + <STRONG><A HREF="read.2.html">read(2)</A></STRONG> call in progress or not, and also (in some imple- + mentations) depending on whether an input timeout or non- + blocking mode has been set. + + Programmers concerned about portability should be prepared + for either of two cases: (a) signal receipt does not in- + terrupt <STRONG>getch</STRONG>; (b) signal receipt interrupts <STRONG>getch</STRONG> and + causes it to return ERR with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>. Under + the <STRONG>ncurses</STRONG> implementation, handled signals never inter- + rupt <STRONG>getch</STRONG>. + + The <STRONG>has_key</STRONG> function is unique to <STRONG>ncurses</STRONG>. We recommend + that any code using it be conditionalized on the <STRONG>NCURS-</STRONG> + <STRONG>ES_VERSION</STRONG> feature macro. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, + <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>, <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>re-</STRONG> + <STRONG><A HREF="resizeterm.3x.html">sizeterm(3x)</A></STRONG>. + + Comparable functions in the wide-character (ncursesw) li- + brary are described in <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_getstr.3x.html b/doc/html/man/curs_getstr.3x.html new file mode 100644 index 000000000000..222f00bc7006 --- /dev/null +++ b/doc/html/man/curs_getstr.3x.html @@ -0,0 +1,155 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_getstr.3x,v 1.19 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_getstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_getstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>getstr</STRONG>, <STRONG>getnstr</STRONG>, <STRONG>wgetstr</STRONG>, <STRONG>wgetnstr</STRONG>, <STRONG>mvgetstr</STRONG>, <STRONG>mvgetnstr</STRONG>, + <STRONG>mvwgetstr</STRONG>, <STRONG>mvwgetnstr</STRONG> - accept character strings from + <STRONG>curses</STRONG> terminal keyboard + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>getstr(char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>getnstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>wgetstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>wgetnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvgetstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwgetstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>mvgetnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwgetnstr(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>getstr</STRONG> is equivalent to a series of calls to + <STRONG>getch</STRONG>, until a newline or carriage return is received (the + terminating character is not included in the returned + string). The resulting value is placed in the area point- + ed to by the character pointer <EM>str</EM>. + + <STRONG>wgetnstr</STRONG> reads at most <EM>n</EM> characters, thus preventing a + possible overflow of the input buffer. Any attempt to en- + ter more characters (other than the terminating newline or + carriage return) causes a beep. Function keys also cause + a beep and are ignored. The <STRONG>getnstr</STRONG> function reads from + the <EM>stdscr</EM> default window. + + The user's erase and kill characters are interpreted. If + keypad mode is on for the window, <STRONG>KEY_LEFT</STRONG> and + <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's + kill character. + + Characters input are echoed only if <STRONG>echo</STRONG> is currently on. + In that case, backspace is echoed as deletion of the pre- + vious character (typically a left motion). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> + (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") + upon successful completion. + + X/Open defines no error conditions. + + In this implementation, these functions return an error if + the window pointer is null, or if its timeout expires + without having any data. + + This implementation provides an extension as well. If a + SIGWINCH interrupts the function, it will return <STRONG>KEY_RE-</STRONG> + <STRONG>SIZE</STRONG> rather than <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. They read single-byte characters only. The + standard does not define any error conditions. This im- + plementation returns ERR if the window pointer is null, or + if the lower-level <STRONG>wgetch</STRONG> call returns an ERR. + + SVr3 and early SVr4 curses implementations did not reject + function keys; the SVr4.0 documentation claimed that "spe- + cial keys" (such as function keys, "home" key, "clear" + key, <EM>etc</EM>.) are "interpreted", without giving details. It + lied. In fact, the `character' value appended to the + string by those implementations was predictable but not + useful (being, in fact, the low-order eight bits of the + key's KEY_ value). + + The functions <STRONG>getnstr</STRONG>, <STRONG>mvgetnstr</STRONG>, and <STRONG>mvwgetnstr</STRONG> were + present but not documented in SVr4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html new file mode 100644 index 000000000000..7a3771641a70 --- /dev/null +++ b/doc/html/man/curs_getyx.3x.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_getyx.3x,v 1.18 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_getyx 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_getyx 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG>, <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor + and window coordinates + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>void</STRONG> <STRONG>getparyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>void</STRONG> <STRONG>getbegyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>getyx</STRONG> macro places the current cursor position of the + given window in the two integer variables <EM>y</EM> and <EM>x</EM>. + + If <EM>win</EM> is a subwindow, the <STRONG>getparyx</STRONG> macro places the + beginning coordinates of the subwindow relative to the + parent window into two integer variables <EM>y</EM> and <EM>x</EM>. Other- + wise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>. + + Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros store the + current beginning coordinates and size of the specified + window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The return values of these macros are undefined (i.e., + they should not be used as the right-hand side of assign- + ment statements). + + +</PRE> +<H2>NOTES</H2><PRE> + All of these interfaces are macros. A "<STRONG>&</STRONG>" is not neces- + sary before the variables <EM>y</EM> and <EM>x</EM>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros are + described in the XSI Curses standard, Issue 4. + + This implementation also provides functions <STRONG>getbegx</STRONG>, <STRONG>getb-</STRONG> + <STRONG>egy</STRONG>, <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>get-</STRONG> + <STRONG>pary</STRONG> for compatibility with older versions of curses. + + Although X/Open Curses does not address this, many imple- + mentations provide members of the WINDOW structure con- + taining values corresponding to these macros. For best + portability, do not rely on using the data in WINDOW, + since some implementations make WINDOW opaque (do not + allow direct use of its members). + + Besides the problem of opaque structures, the data stored + in like-named members may not have like-values in differ- + ent implementations. For example, the WINDOW._maxx and + WINDOW._maxy values in ncurses have (at least since + release 1.8.1) differed by one from some other implementa- + tions. The difference is hidden by means of the macro + <STRONG>getmaxyx</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_in_wch.3x.html b/doc/html/man/curs_in_wch.3x.html new file mode 100644 index 000000000000..1535e51be223 --- /dev/null +++ b/doc/html/man/curs_in_wch.3x.html @@ -0,0 +1,109 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_in_wch.3x,v 1.5 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_in_wch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_in_wch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>in_wch</STRONG>, <STRONG>mvin_wch</STRONG>, <STRONG>mvwin_wch</STRONG>, <STRONG>win_wch</STRONG> - extract a complex + character and rendition from a window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>in_wch(cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvin_wch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwin_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>win_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wcval</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions extract the complex character and rendi- + tion from the current position in the named window into + the <STRONG>cchar_t</STRONG> object referenced by wcval. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + No errors are defined in the XSI Curses standard. This + implementation checks for null pointers, returns ERR in + that case. Also, the <EM>mv</EM> routines check for error moving + the cursor, returning ERR in that case. Otherwise they + return OK + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all of these routines may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html new file mode 100644 index 000000000000..e394e9063ce1 --- /dev/null +++ b/doc/html/man/curs_in_wchstr.3x.html @@ -0,0 +1,124 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_in_wchstr.3x,v 1.8 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_in_wchstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_in_wchstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>in_wchstr</STRONG>, <STRONG>in_wchnstr</STRONG>, <STRONG>win_wchstr</STRONG>, <STRONG>win_wchnstr</STRONG>, + <STRONG>mvin_wchstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG> - + get an array of complex characters and renditions from a + curses window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>in_wchstr(cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>in_wchnstr(cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>win_wchstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>win_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvin_wchstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvin_wchnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwin_wchstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwin_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM>, int <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions return an array of complex characters in + <EM>wchstr</EM>, starting at the current cursor position in the + named window. Attributes (rendition) are stored with the + characters. + + The <STRONG>in_wchnstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG> and <STRONG>win_wchn-</STRONG> + <STRONG>str</STRONG> fill the array with at most <EM>n</EM> <STRONG>cchar_t</STRONG> elements. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>win_wchnstr</STRONG> may be macros. + + Reading a line that overflows the array pointed to by <EM>wch-</EM> + <EM>str</EM> with <STRONG>in_wchstr</STRONG>, <STRONG>mvin_wchstr</STRONG>, <STRONG>mvwin_wchstr</STRONG> or <STRONG>win_wch-</STRONG> + <STRONG>str</STRONG> causes undefined results. Therefore, the use of + <STRONG>in_wchnstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG>, or <STRONG>win_wchnstr</STRONG> is + recommended. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + Upon successful completion, these functions return <STRONG>OK</STRONG>. + Otherwise, they return <STRONG>ERR</STRONG>. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses defines no error conditions. This imple- + mentation checks for null pointers, returning ERR in that + case. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>, + <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_inch.3x.html b/doc/html/man/curs_inch.3x.html new file mode 100644 index 000000000000..43c6159317ce --- /dev/null +++ b/doc/html/man/curs_inch.3x.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_inch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_inch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>inch</STRONG>, <STRONG>winch</STRONG>, <STRONG>mvinch</STRONG>, <STRONG>mvwinch</STRONG> - get a character and + attributes from a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG> + <STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return the character, of type <STRONG>chtype</STRONG>, at + the current position in the named window. If any + attributes are set for that position, their values are + OR'ed into the value returned. Constants defined in + <STRONG><curses.h></STRONG> can be used with the <STRONG>&</STRONG> (logical AND) operator + to extract the character or attributes alone. + + <STRONG>Attributes</STRONG> + The following bit-masks may be AND-ed with characters + returned by <STRONG>winch</STRONG>. + + <STRONG>A_CHARTEXT</STRONG> Bit-mask to extract character + <STRONG>A_ATTRIBUTES</STRONG> Bit-mask to extract attributes + <STRONG>A_COLOR</STRONG> Bit-mask to extract color-pair field information + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all of these routines may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + Comparable functions in the wide-character (ncursesw) + library are described in <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html new file mode 100644 index 000000000000..73a78fc9c5c0 --- /dev/null +++ b/doc/html/man/curs_inchstr.3x.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_inchstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_inchstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>, + <STRONG>mvinchnstr</STRONG>, <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a string of + characters (and attributes) from a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>inchstr(chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>inchnstr(chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>winchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>winchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinchstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinchnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> + <STRONG>int</STRONG> <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return a NULL-terminated array of <STRONG>chtype</STRONG> + quantities, starting at the current cursor position in the + named window and ending at the right margin of the window. + The four functions with <EM>n</EM> as the last argument, return a + leading substring at most <EM>n</EM> characters long (exclusive of + the trailing (chtype)0). Constants defined in <STRONG><curses.h></STRONG> + can be used with the <STRONG>&</STRONG> (logical AND) operator to extract + the character or the attribute alone from any position in + the <EM>chstr</EM> [see <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>]. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an + integer value other than <STRONG>ERR</STRONG> upon successful completion + (the number of characters retrieved, exclusive of the + trailing 0). + + No error conditions are defined. If the <EM>chstr</EM> parameter + is null, no data is returned, and the return value is ze- + ro. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>winchnstr</STRONG> may be macros. + SVr4 does not document whether the result string is zero- + terminated; it does not document whether a length limit + argument includes any trailing 0; and it does not document + the meaning of the return value. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. It is no more specific than the SVr4 documenta- + tion on the trailing 0. It does specify that the success- + ful return of the functions is <STRONG>OK</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>. + + Comparable functions in the wide-character (ncursesw) li- + brary are described in <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_initscr.3x.html b/doc/html/man/curs_initscr.3x.html new file mode 100644 index 000000000000..5c4364d80e4d --- /dev/null +++ b/doc/html/man/curs_initscr.3x.html @@ -0,0 +1,167 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_initscr.3x,v 1.17 2010/12/04 18:36:58 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_initscr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_initscr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>initscr</STRONG>, <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> - + <STRONG>curses</STRONG> screen initialization and manipulation routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>WINDOW</STRONG> <STRONG>*initscr(void);</STRONG> + <STRONG>int</STRONG> <STRONG>endwin(void);</STRONG> + <STRONG>bool</STRONG> <STRONG>isendwin(void);</STRONG> + <STRONG>SCREEN</STRONG> <STRONG>*newterm(char</STRONG> <STRONG>*type,</STRONG> <STRONG>FILE</STRONG> <STRONG>*outfd,</STRONG> <STRONG>FILE</STRONG> <STRONG>*infd);</STRONG> + <STRONG>SCREEN</STRONG> <STRONG>*set_term(SCREEN</STRONG> <STRONG>*new);</STRONG> + <STRONG>void</STRONG> <STRONG>delscreen(SCREEN*</STRONG> <STRONG>sp);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>initscr</STRONG> is normally the first <STRONG>curses</STRONG> routine to call when + initializing a program. A few special routines sometimes + need to be called before it; these are <STRONG>slk_init</STRONG>, <STRONG>filter</STRONG>, + <STRONG>ripoffline</STRONG>, <STRONG>use_env</STRONG>. For multiple-terminal applications, + <STRONG>newterm</STRONG> may be called before <STRONG>initscr</STRONG>. + + The initscr code determines the terminal type and initial- + izes all <STRONG>curses</STRONG> data structures. <STRONG>initscr</STRONG> also causes the + first call to <STRONG>refresh</STRONG> to clear the screen. If errors oc- + cur, <STRONG>initscr</STRONG> writes an appropriate error message to stan- + dard error and exits; otherwise, a pointer is returned to + <STRONG>stdscr</STRONG>. + + A program that outputs to more than one terminal should + use the <STRONG>newterm</STRONG> routine for each terminal instead of + <STRONG>initscr</STRONG>. A program that needs to inspect capabilities, so + it can continue to run in a line-oriented mode if the ter- + minal cannot support a screen-oriented program, would also + use <STRONG>newterm</STRONG>. The routine <STRONG>newterm</STRONG> should be called once + for each terminal. It returns a variable of type <STRONG>SCREEN</STRONG> <STRONG>*</STRONG> + which should be saved as a reference to that terminal. + The arguments are the <EM>type</EM> of the terminal to be used in + place of <STRONG>$TERM</STRONG>, a file pointer for output to the terminal, + and another file pointer for input from the terminal (if + <EM>type</EM> is <STRONG>NULL</STRONG>, <STRONG>$TERM</STRONG> will be used). The program must also + call <STRONG>endwin</STRONG> for each terminal being used before exiting + from <STRONG>curses</STRONG>. If <STRONG>newterm</STRONG> is called more than once for the + same terminal, the first terminal referred to must be the + last one for which <STRONG>endwin</STRONG> is called. + + A program should always call <STRONG>endwin</STRONG> before exiting or es- + caping from <STRONG>curses</STRONG> mode temporarily. This routine re- + stores tty modes, moves the cursor to the lower left-hand + corner of the screen and resets the terminal into the + proper non-visual mode. Calling <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> after + a temporary escape causes the program to resume visual + mode. + + The <STRONG>isendwin</STRONG> routine returns <STRONG>TRUE</STRONG> if <STRONG>endwin</STRONG> has been + called without any subsequent calls to <STRONG>wrefresh</STRONG>, and <STRONG>FALSE</STRONG> + otherwise. + + The <STRONG>set_term</STRONG> routine is used to switch between different + terminals. The screen reference <STRONG>new</STRONG> becomes the new cur- + rent terminal. The previous terminal is returned by the + routine. This is the only routine which manipulates + <STRONG>SCREEN</STRONG> pointers; all other routines affect only the cur- + rent terminal. + + The <STRONG>delscreen</STRONG> routine frees storage associated with the + <STRONG>SCREEN</STRONG> data structure. The <STRONG>endwin</STRONG> routine does not do + this, so <STRONG>delscreen</STRONG> should be called after <STRONG>endwin</STRONG> if a par- + ticular <STRONG>SCREEN</STRONG> is no longer needed. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>endwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon + successful completion. + + Routines that return pointers always return <STRONG>NULL</STRONG> on error. + + X/Open defines no error conditions. In this implementa- + tion <STRONG>endwin</STRONG> returns an error if the terminal was not ini- + tialized. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. It specifies that portable applications must not + call <STRONG>initscr</STRONG> more than once. + + Old versions of curses, e.g., BSD 4.4, may have returned a + null pointer from <STRONG>initscr</STRONG> when an error is detected, + rather than exiting. It is safe but redundant to check + the return value of <STRONG>initscr</STRONG> in XSI Curses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, + <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_inopts.3x.html b/doc/html/man/curs_inopts.3x.html new file mode 100644 index 000000000000..d85164234c5a --- /dev/null +++ b/doc/html/man/curs_inopts.3x.html @@ -0,0 +1,261 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_inopts.3x,v 1.15 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_inopts 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_inopts 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>cbreak</STRONG>, <STRONG>nocbreak</STRONG>, <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>, + <STRONG>keypad</STRONG>, <STRONG>meta</STRONG>, <STRONG>nodelay</STRONG>, <STRONG>notimeout</STRONG>, <STRONG>raw</STRONG>, <STRONG>noraw</STRONG>, <STRONG>noqiflush</STRONG>, + <STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, <STRONG>wtimeout</STRONG>, <STRONG>typeahead</STRONG> - <STRONG>curses</STRONG> input + options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>cbreak(void);</STRONG> + <STRONG>int</STRONG> <STRONG>nocbreak(void);</STRONG> + <STRONG>int</STRONG> <STRONG>echo(void);</STRONG> + <STRONG>int</STRONG> <STRONG>noecho(void);</STRONG> + <STRONG>int</STRONG> <STRONG>halfdelay(int</STRONG> <STRONG>tenths);</STRONG> + <STRONG>int</STRONG> <STRONG>intrflush(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>keypad(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>meta(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>nodelay(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>raw(void);</STRONG> + <STRONG>int</STRONG> <STRONG>noraw(void);</STRONG> + <STRONG>void</STRONG> <STRONG>noqiflush(void);</STRONG> + <STRONG>void</STRONG> <STRONG>qiflush(void);</STRONG> + <STRONG>int</STRONG> <STRONG>notimeout(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>void</STRONG> <STRONG>timeout(int</STRONG> <STRONG>delay);</STRONG> + <STRONG>void</STRONG> <STRONG>wtimeout(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>delay);</STRONG> + <STRONG>int</STRONG> <STRONG>typeahead(int</STRONG> <STRONG>fd);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Normally, the tty driver buffers typed characters until a + newline or carriage return is typed. The <STRONG>cbreak</STRONG> routine + disables line buffering and erase/kill character-process- + ing (interrupt and flow control characters are unaffect- + ed), making characters typed by the user immediately + available to the program. The <STRONG>nocbreak</STRONG> routine returns + the terminal to normal (cooked) mode. + + Initially the terminal may or may not be in <STRONG>cbreak</STRONG> mode, + as the mode is inherited; therefore, a program should call + <STRONG>cbreak</STRONG> or <STRONG>nocbreak</STRONG> explicitly. Most interactive programs + using <STRONG>curses</STRONG> set the <STRONG>cbreak</STRONG> mode. Note that <STRONG>cbreak</STRONG> over- + rides <STRONG>raw</STRONG>. [See <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> for a discussion of how + these routines interact with <STRONG>echo</STRONG> and <STRONG>noecho</STRONG>.] + + The <STRONG>echo</STRONG> and <STRONG>noecho</STRONG> routines control whether characters + typed by the user are echoed by <STRONG>getch</STRONG> as they are typed. + Echoing by the tty driver is always disabled, but initial- + ly <STRONG>getch</STRONG> is in echo mode, so characters typed are echoed. + Authors of most interactive programs prefer to do their + own echoing in a controlled area of the screen, or not to + echo at all, so they disable echoing by calling <STRONG>noecho</STRONG>. + [See <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> for a discussion of how these routines + interact with <STRONG>cbreak</STRONG> and <STRONG>nocbreak</STRONG>.] + + The <STRONG>halfdelay</STRONG> routine is used for half-delay mode, which + is similar to <STRONG>cbreak</STRONG> mode in that characters typed by the + user are immediately available to the program. However, + after blocking for <EM>tenths</EM> tenths of seconds, ERR is re- + turned if nothing has been typed. The value of <STRONG>tenths</STRONG> + must be a number between 1 and 255. Use <STRONG>nocbreak</STRONG> to leave + half-delay mode. + + If the <STRONG>intrflush</STRONG> option is enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), when an + interrupt key is pressed on the keyboard (interrupt, + break, quit) all output in the tty driver queue will be + flushed, giving the effect of faster response to the in- + terrupt, but causing <STRONG>curses</STRONG> to have the wrong idea of what + is on the screen. Disabling (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the option + prevents the flush. The default for the option is inher- + ited from the tty driver settings. The window argument is + ignored. + + The <STRONG>keypad</STRONG> option enables the keypad of the user's termi- + nal. If enabled (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the user can press a func- + tion key (such as an arrow key) and <STRONG>wgetch</STRONG> returns a sin- + gle value representing the function key, as in <STRONG>KEY_LEFT</STRONG>. + If disabled (<EM>bf</EM> is <STRONG>FALSE</STRONG>), <STRONG>curses</STRONG> does not treat function + keys specially and the program has to interpret the escape + sequences itself. If the keypad in the terminal can be + turned on (made to transmit) and off (made to work local- + ly), turning on this option causes the terminal keypad to + be turned on when <STRONG>wgetch</STRONG> is called. The default value for + keypad is false. + + Initially, whether the terminal returns 7 or 8 significant + bits on input depends on the control mode of the tty driv- + er [see <STRONG><A HREF="termio.7.html">termio(7)</A></STRONG>]. To force 8 bits to be returned, in- + voke <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>TRUE</STRONG>); this is equivalent, under POSIX, to + setting the CS8 flag on the terminal. To force 7 bits to + be returned, invoke <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>FALSE</STRONG>); this is equivalent, + under POSIX, to setting the CS7 flag on the terminal. The + window argument, <EM>win</EM>, is always ignored. If the terminfo + capabilities <STRONG>smm</STRONG> (meta_on) and <STRONG>rmm</STRONG> (meta_off) are defined + for the terminal, <STRONG>smm</STRONG> is sent to the terminal when + <STRONG>meta</STRONG>(<EM>win</EM>, <STRONG>TRUE</STRONG>) is called and <STRONG>rmm</STRONG> is sent when <STRONG>meta</STRONG>(<EM>win</EM>, + <STRONG>FALSE</STRONG>) is called. + + The <STRONG>nodelay</STRONG> option causes <STRONG>getch</STRONG> to be a non-blocking call. + If no input is ready, <STRONG>getch</STRONG> returns <STRONG>ERR</STRONG>. If disabled (<EM>bf</EM> + is <STRONG>FALSE</STRONG>), <STRONG>getch</STRONG> waits until a key is pressed. + + While interpreting an input escape sequence, <STRONG>wgetch</STRONG> sets a + timer while waiting for the next character. If <STRONG>notime-</STRONG> + <STRONG>out(</STRONG><EM>win</EM>, <STRONG>TRUE</STRONG>) is called, then <STRONG>wgetch</STRONG> does not set a + timer. The purpose of the timeout is to differentiate be- + tween sequences received from a function key and those + typed by a user. + + The <STRONG>raw</STRONG> and <STRONG>noraw</STRONG> routines place the terminal into or out + of raw mode. Raw mode is similar to <STRONG>cbreak</STRONG> mode, in that + characters typed are immediately passed through to the us- + er program. The differences are that in raw mode, the in- + terrupt, quit, suspend, and flow control characters are + all passed through uninterpreted, instead of generating a + signal. The behavior of the BREAK key depends on other + bits in the tty driver that are not set by <STRONG>curses</STRONG>. + + When the <STRONG>noqiflush</STRONG> routine is used, normal flush of input + and output queues associated with the <STRONG>INTR</STRONG>, <STRONG>QUIT</STRONG> and <STRONG>SUSP</STRONG> + characters will not be done [see <STRONG><A HREF="termio.7.html">termio(7)</A></STRONG>]. When <STRONG>qiflush</STRONG> + is called, the queues will be flushed when these control + characters are read. You may want to call <STRONG>noqiflush()</STRONG> in + a signal handler if you want output to continue as though + the interrupt had not occurred, after the handler exits. + + The <STRONG>timeout</STRONG> and <STRONG>wtimeout</STRONG> routines set blocking or non- + blocking read for a given window. If <EM>delay</EM> is negative, + blocking read is used (i.e., waits indefinitely for in- + put). If <EM>delay</EM> is zero, then non-blocking read is used + (i.e., read returns <STRONG>ERR</STRONG> if no input is waiting). If <EM>delay</EM> + is positive, then read blocks for <EM>delay</EM> milliseconds, and + returns <STRONG>ERR</STRONG> if there is still no input. Hence, these rou- + tines provide the same functionality as <STRONG>nodelay</STRONG>, plus the + additional capability of being able to block for only <EM>de-</EM> + <EM>lay</EM> milliseconds (where <EM>delay</EM> is positive). + + The <STRONG>curses</STRONG> library does ``line-breakout optimization'' by + looking for typeahead periodically while updating the + screen. If input is found, and it is coming from a tty, + the current update is postponed until <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> + is called again. This allows faster response to commands + typed in advance. Normally, the input FILE pointer passed + to <STRONG>newterm</STRONG>, or <STRONG>stdin</STRONG> in the case that <STRONG>initscr</STRONG> was used, + will be used to do this typeahead checking. The <STRONG>typeahead</STRONG> + routine specifies that the file descriptor <EM>fd</EM> is to be + used to check for typeahead instead. If <EM>fd</EM> is -1, then no + typeahead checking is done. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines that return an integer return <STRONG>ERR</STRONG> upon fail- + ure and OK (SVr4 specifies only "an integer value other + than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + + X/Open does not define any error conditions. In this im- + plementation, functions with a window parameter will re- + turn an error if it is null. Any function will also re- + turn an error if the terminal was not initialized. Also, + + <STRONG>halfdelay</STRONG> + returns an error if its parameter is outside + the range 1..255. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + The ncurses library obeys the XPG4 standard and the his- + torical practice of the AT&T curses implementations, in + that the echo bit is cleared when curses initializes the + terminal state. BSD curses differed from this slightly; + it left the echo bit on at initialization, but the BSD <STRONG>raw</STRONG> + call turned it off as a side-effect. For best portabili- + ty, set echo or noecho explicitly just after initializa- + tion, even if your program remains in cooked mode. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>echo</STRONG>, <STRONG>noecho</STRONG>, <STRONG>halfdelay</STRONG>, <STRONG>intrflush</STRONG>, <STRONG>meta</STRONG>, <STRONG>node-</STRONG> + <STRONG>lay</STRONG>, <STRONG>notimeout</STRONG>, <STRONG>noqiflush</STRONG>, <STRONG>qiflush</STRONG>, <STRONG>timeout</STRONG>, and <STRONG>wtimeout</STRONG> + may be macros. + + The <STRONG>noraw</STRONG> and <STRONG>nocbreak</STRONG> calls follow historical practice in + that they attempt to restore to normal (`cooked') mode + from raw and cbreak modes respectively. Mixing raw/noraw + and cbreak/nocbreak calls leads to tty driver control + states that are hard to predict or understand; it is not + recommended. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="termio.7.html">termio(7)</A></STRONG> + + + + <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_ins_wch.3x.html b/doc/html/man/curs_ins_wch.3x.html new file mode 100644 index 000000000000..2b3714c55dd4 --- /dev/null +++ b/doc/html/man/curs_ins_wch.3x.html @@ -0,0 +1,104 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_ins_wch.3x,v 1.5 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_ins_wch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_ins_wch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>ins_wch</STRONG>, <STRONG>mvins_wch</STRONG>, <STRONG>mvwins_wch</STRONG>, <STRONG>wins_wch</STRONG> - insert a com- + plex character and rendition into a window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + #include <curses.h> + + <STRONG>int</STRONG> <STRONG>ins_wch(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wins_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win,</EM> <EM>const</EM> <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM> <EM>*wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvins_wch(int</STRONG> <EM>y,</EM> <EM>int</EM> <EM>x,</EM> <EM>const</EM> <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM> <EM>*wch</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwins_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win,</EM> <EM>int</EM> <EM>y,</EM> <EM>int</EM> <EM>x,</EM> <EM>const</EM> <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM> + <EM>*wch</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines, insert the complex character <EM>wch</EM> with ren- + dition before the character under the cursor. All charac- + ters to the right of the cursor are moved one space to the + right, with the possibility of the rightmost character on + the line being lost. The insertion operation does not + change the cursor position. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + If successful, these functions return OK. If not, they + return ERR. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>ERRORS</H2><PRE> + No errors are defined. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_ins_wstr.3x.html b/doc/html/man/curs_ins_wstr.3x.html new file mode 100644 index 000000000000..5f7cee6142ca --- /dev/null +++ b/doc/html/man/curs_ins_wstr.3x.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_ins_wstr.3x,v 1.6 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_ins_wstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_ins_wstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>ins_wstr</STRONG>, <STRONG>ins_nwstr</STRONG>, <STRONG>wins_wstr</STRONG>, <STRONG>wins_nwstr</STRONG>, <STRONG>mvins_wstr</STRONG>, + <STRONG>mvins_nwstr</STRONG>, <STRONG>mvwins_wstr</STRONG>, <STRONG>mvwins_nwstr</STRONG> - insert a wide- + character string into a curses window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>ins_wstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr);</EM> + <STRONG>int</STRONG> <STRONG>ins_nwstr(const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wins_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>wins_nwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvins_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvins_nwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwins_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwins_nwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines insert a <STRONG>wchar_t</STRONG> character string (as many + characters as will fit on the line) before the character + under the cursor. All characters to the right of the cur- + sor are shifted right, with the possibility of the right- + most characters on the line being lost. No wrapping is + performed. The cursor position does not change (after + moving to <EM>y</EM>, <EM>x</EM>, if specified). The four routines with <EM>n</EM> + as the last argument insert a leading substring of at most + <EM>n</EM> <STRONG>wchar_t</STRONG> characters. If <EM>n</EM> is less than 1, the entire + string is inserted. + + If a character in <EM>wstr</EM> is a tab, newline, carriage return + or backspace, the cursor is moved appropriately within the + window. A newline also does a <STRONG>clrtoeol</STRONG> before moving. + Tabs are considered to be at every eighth column. If a + character in <EM>wstr</EM> is another control character, it is + drawn in the <STRONG>^</STRONG><EM>X</EM> notation. Calling <STRONG>win_wch</STRONG> after adding a + control character (and moving to it, if necessary) does + not return the control character, but instead returns a + character in the ^-representation of the control charac- + ter. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all but wins_nwstr may be macros. + + If the first character in the string is a nonspacing char- + acter, these functions will fail. XSI does not define + what will happen if a nonspacing character follows a con- + trol character. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + Upon successful completion, these functions return OK. + Otherwise, they return ERR. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>, + <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_insch.3x.html b/doc/html/man/curs_insch.3x.html new file mode 100644 index 000000000000..f8c833eb5c8e --- /dev/null +++ b/doc/html/man/curs_insch.3x.html @@ -0,0 +1,117 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_insch.3x,v 1.13 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_insch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_insch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>insch</STRONG>, <STRONG>winsch</STRONG>, <STRONG>mvinsch</STRONG>, <STRONG>mvwinsch</STRONG> - insert a character + before cursor in a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>insch(chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>winsch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinsch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinsch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines insert the character <EM>ch</EM> before the charac- + ter under the cursor. All characters to the right of the + cursor are moved one space to the right, with the possi- + bility of the rightmost character on the line being lost. + The insertion operation does not change the cursor posi- + tion. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines that return an integer return <STRONG>ERR</STRONG> upon fail- + ure and OK (SVr4 specifies only "an integer value other + than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + These routines do not necessarily imply use of a hardware + insert character feature. + + Note that <STRONG>insch</STRONG>, <STRONG>mvinsch</STRONG>, and <STRONG>mvwinsch</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + Comparable functions in the wide-character (ncursesw) + library are described in <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html new file mode 100644 index 000000000000..7a616489e6d3 --- /dev/null +++ b/doc/html/man/curs_insstr.3x.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_insstr.3x,v 1.21 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_insstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_insstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>insstr</STRONG>, <STRONG>insnstr</STRONG>, <STRONG>winsstr</STRONG>, <STRONG>winsnstr</STRONG>, <STRONG>mvinsstr</STRONG>, <STRONG>mvinsnstr</STRONG>, + <STRONG>mvwinsstr</STRONG>, <STRONG>mvwinsnstr</STRONG> - insert string before cursor in a + <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>int</STRONG> <STRONG>insstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>insnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>winsstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>winsnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinsstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinsnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinsstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinsnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> + <STRONG>int</STRONG> <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines insert a character string (as many charac- + ters as will fit on the line) before the character under + the cursor. All characters to the right of the cursor are + shifted right with the possibility of the rightmost char- + acters on the line being lost. The cursor position does + not change (after moving to <EM>y</EM>, <EM>x</EM>, if specified). The + functions with <EM>n</EM> as the last argument insert a leading + substring of at most <EM>n</EM> characters. If <EM>n</EM><=0, then the + entire string is inserted. + + Special characters are handled as in <STRONG>addch</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines that return an integer return <STRONG>ERR</STRONG> upon fail- + ure and OK (SVr4 specifies only "an integer value other + than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + + X/Open defines no error conditions. In this implementa- + tion, if the window parameter is null or the str parameter + is null, an error is returned. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all but <STRONG>winsnstr</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4, which adds const qualifiers to the arguments. + + The Single Unix Specification, Version 2 states that + <STRONG>insnstr</STRONG> and <STRONG>winsnstr</STRONG> perform wrapping. This is probably + an error, since it makes this group of functions inconsis- + tent. Also, no implementation of curses documents this + inconsistency. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html new file mode 100644 index 000000000000..0f32d58eae62 --- /dev/null +++ b/doc/html/man/curs_instr.3x.html @@ -0,0 +1,123 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_instr.3x,v 1.16 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_instr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_instr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>instr</STRONG>, <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwin-</STRONG> + <STRONG>str</STRONG>, <STRONG>mvwinnstr</STRONG> - get a string of characters from a <STRONG>curses</STRONG> + window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> + <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return a string of characters in <EM>str</EM>, + extracted starting at the current cursor position in the + named window. Attributes are stripped from the charac- + ters. The four functions with <EM>n</EM> as the last argument + return a leading substring at most <EM>n</EM> characters long + (exclusive of the trailing NUL). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All of the functions return <STRONG>ERR</STRONG> upon failure, or the num- + ber of characters actually read into the string. + + X/Open defines no error conditions. In this implementa- + tion, if the window parameter is null or the str parameter + is null, a zero is returned. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>winnstr</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + SVr4 does not document whether a length limit includes or + excludes the trailing NUL. + + The ncurses library extends the XSI description by allow- + ing a negative value for <EM>n</EM>. In this case, the functions + return the string ending at the right margin. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html new file mode 100644 index 000000000000..223c398de20f --- /dev/null +++ b/doc/html/man/curs_inwstr.3x.html @@ -0,0 +1,115 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_inwstr.3x,v 1.7 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_inwstr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_inwstr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>inwstr</STRONG>, <STRONG>innwstr</STRONG>, <STRONG>winwstr</STRONG>, <STRONG>winnwstr</STRONG>, <STRONG>mvinwstr</STRONG>, <STRONG>mvinnwstr</STRONG>, + <STRONG>mvwinwstr</STRONG>, <STRONG>mvwinnwstr</STRONG> - get a string of <STRONG>wchar_t</STRONG> characters + from a curses window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>inwstr(wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>innwstr(wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>winwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>winnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvinnwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwinnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return a string of <STRONG>wchar_t</STRONG> characters in + <EM>wstr</EM>, extracted starting at the current cursor position in + the named window. Attributes are stripped from the char- + acters. The four functions with <EM>n</EM> as the last argument + return a leading substring at most <EM>n</EM> bytes long (exclusive + of the trailing NUL). Transfer stops at the end of the + current line, or when <EM>n</EM> bytes have been stored at the + location referenced by <EM>wstr</EM>. + + If the size <EM>n</EM> is not large enough to store a complete + character, an error is generated. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>winnwstr</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All routines return <STRONG>ERR</STRONG> upon failure. Upon successful com- + pletion, the *<STRONG>inwstr</STRONG> routines return <STRONG>OK</STRONG>, and the *<STRONG>innwstr</STRONG> + routines return the number of characters read into the + string. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_kernel.3x.html b/doc/html/man/curs_kernel.3x.html new file mode 100644 index 000000000000..a2e247cea512 --- /dev/null +++ b/doc/html/man/curs_kernel.3x.html @@ -0,0 +1,206 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_kernel.3x,v 1.19 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_kernel 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_kernel 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, + <STRONG>reset_shell_mode</STRONG>, <STRONG>resetty</STRONG>, <STRONG>savetty</STRONG>, <STRONG>getsyx</STRONG>, <STRONG>setsyx</STRONG>, + <STRONG>ripoffline</STRONG>, <STRONG>curs_set</STRONG>, <STRONG>napms</STRONG> - low-level <STRONG>curses</STRONG> routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>def_prog_mode(void);</STRONG> + <STRONG>int</STRONG> <STRONG>def_shell_mode(void);</STRONG> + <STRONG>int</STRONG> <STRONG>reset_prog_mode(void);</STRONG> + <STRONG>int</STRONG> <STRONG>reset_shell_mode(void);</STRONG> + <STRONG>int</STRONG> <STRONG>resetty(void);</STRONG> + <STRONG>int</STRONG> <STRONG>savetty(void);</STRONG> + <STRONG>void</STRONG> <STRONG>getsyx(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>void</STRONG> <STRONG>setsyx(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>int</STRONG> <STRONG>ripoffline(int</STRONG> <STRONG>line,</STRONG> <STRONG>int</STRONG> <STRONG>(*init)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int));</STRONG> + <STRONG>int</STRONG> <STRONG>curs_set(int</STRONG> <STRONG>visibility);</STRONG> + <STRONG>int</STRONG> <STRONG>napms(int</STRONG> <STRONG>ms);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The following routines give low-level access to various + <STRONG>curses</STRONG> capabilities. These routines typically are used + inside library routines. + + The <STRONG>def_prog_mode</STRONG> and <STRONG>def_shell_mode</STRONG> routines save the + current terminal modes as the "program" (in <STRONG>curses</STRONG>) or + "shell" (not in <STRONG>curses</STRONG>) state for use by the <STRONG>re-</STRONG> + <STRONG>set_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines. This is done + automatically by <STRONG>initscr</STRONG>. There is one such save area for + each screen context allocated by <STRONG>newterm()</STRONG>. + + The <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines restore + the terminal to "program" (in <STRONG>curses</STRONG>) or "shell" (out of + <STRONG>curses</STRONG>) state. These are done automatically by <STRONG>endwin</STRONG> + and, after an <STRONG>endwin</STRONG>, by <STRONG>doupdate</STRONG>, so they normally are + not called. + + The <STRONG>resetty</STRONG> and <STRONG>savetty</STRONG> routines save and restore the + state of the terminal modes. <STRONG>savetty</STRONG> saves the current + state in a buffer and <STRONG>resetty</STRONG> restores the state to what + it was at the last call to <STRONG>savetty</STRONG>. + + The <STRONG>getsyx</STRONG> routine returns the current coordinates of the + virtual screen cursor in <EM>y</EM> and <EM>x</EM>. If <STRONG>leaveok</STRONG> is currently + <STRONG>TRUE</STRONG>, then <STRONG>-1</STRONG>,<STRONG>-1</STRONG> is returned. If lines have been removed + from the top of the screen, using <STRONG>ripoffline</STRONG>, <EM>y</EM> and <EM>x</EM> in- + clude these lines; therefore, <EM>y</EM> and <EM>x</EM> should be used only + as arguments for <STRONG>setsyx</STRONG>. + + The <STRONG>setsyx</STRONG> routine sets the virtual screen cursor to <EM>y</EM>, <EM>x</EM>. + If <EM>y</EM> and <EM>x</EM> are both <STRONG>-1</STRONG>, then <STRONG>leaveok</STRONG> is set. The two rou- + tines <STRONG>getsyx</STRONG> and <STRONG>setsyx</STRONG> are designed to be used by a li- + brary routine, which manipulates <STRONG>curses</STRONG> windows but does + not want to change the current position of the program's + cursor. The library routine would call <STRONG>getsyx</STRONG> at the be- + ginning, do its manipulation of its own windows, do a + <STRONG>wnoutrefresh</STRONG> on its windows, call <STRONG>setsyx</STRONG>, and then call + <STRONG>doupdate</STRONG>. + + The <STRONG>ripoffline</STRONG> routine provides access to the same facili- + ty that <STRONG>slk_init</STRONG> [see <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>] uses to reduce the + size of the screen. <STRONG>ripoffline</STRONG> must be called before + <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> is called. If <EM>line</EM> is positive, a line + is removed from the top of <STRONG>stdscr</STRONG>; if <EM>line</EM> is negative, a + line is removed from the bottom. When this is done inside + <STRONG>initscr</STRONG>, the routine <STRONG>init</STRONG> (supplied by the user) is called + with two arguments: a window pointer to the one-line win- + dow that has been allocated and an integer with the number + of columns in the window. Inside this initialization rou- + tine, the integer variables <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> (defined in + <STRONG><curses.h></STRONG>) are not guaranteed to be accurate and <STRONG>wrefresh</STRONG> + or <STRONG>doupdate</STRONG> must not be called. It is allowable to call + <STRONG>wnoutrefresh</STRONG> during the initialization routine. + + <STRONG>ripoffline</STRONG> can be called up to five times before calling + <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>. + + The <STRONG>curs_set</STRONG> routine sets the cursor state to invisible, + normal, or very visible for <STRONG>visibility</STRONG> equal to <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG> + respectively. If the terminal supports the <EM>visibility</EM> re- + quested, the previous <EM>cursor</EM> state is returned; otherwise, + <STRONG>ERR</STRONG> is returned. + + The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>curs_set</STRONG>, these routines always return <STRONG>OK</STRONG>. + + <STRONG>curs_set</STRONG> returns the previous cursor state, or <STRONG>ERR</STRONG> if the + requested <EM>visibility</EM> is not supported. + + X/Open defines no error conditions. In this implementa- + tion + + <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>re-</STRONG> + <STRONG>set_shell_mode</STRONG> + return an error if the terminal was not ini- + tialized, or if the I/O call to obtain the + terminal settings fails. + + <STRONG>ripoffline</STRONG> + returns an error if the maximum number of + ripped-off lines exceeds the maximum (NRIPS = + 5). + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>getsyx</STRONG> is a macro, so <STRONG>&</STRONG> is not necessary before + the variables <EM>y</EM> and <EM>x</EM>. + + Older SVr4 man pages warn that the return value of + <STRONG>curs_set</STRONG> "is currently incorrect". This implementation + gets it right, but it may be unwise to count on the cor- + rectness of the return value anywhere else. + + Both ncurses and SVr4 will call <STRONG>curs_set</STRONG> in <STRONG>endwin</STRONG> if + <STRONG>curs_set</STRONG> has been called to make the cursor other than + normal, i.e., either invisible or very visible. There is + no way for ncurses to determine the initial cursor state + to restore that. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The functions <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> are not described in the + XSI Curses standard, Issue 4. All other functions are as + described in XSI Curses. + + The SVr4 documentation describes <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> as hav- + ing return type int. This is misleading, as they are + macros with no documented semantics for the return value. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG>curs_re-</STRONG> + <STRONG><A HREF="curs_refresh.3x.html">fresh(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> + <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html new file mode 100644 index 000000000000..5a86252fbcb7 --- /dev/null +++ b/doc/html/man/curs_legacy.3x.html @@ -0,0 +1,121 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_legacy.3x,v 1.5 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_legacy 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_legacy 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + getattrs - get <STRONG>curses</STRONG> cursor and window coordinates, + attributes + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>getattrs(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getbegx(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getbegy(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getcurx(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getcury(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getmaxx(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getmaxy(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getparx(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>getpary(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>getbegy</STRONG> and <STRONG>getbegx</STRONG> functions return the same data as + <STRONG>getbegyx</STRONG>. + + The <STRONG>getcury</STRONG> and <STRONG>getcurx</STRONG> functions return the same data as + <STRONG>getyx</STRONG>. + + The <STRONG>getmaxy</STRONG> and <STRONG>getmaxx</STRONG> functions return the same data as + <STRONG>getmaxyx</STRONG>. + + The <STRONG>getpary</STRONG> and <STRONG>getparx</STRONG> functions return the same data as + <STRONG>getparyx</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These functions return an integer, or ERR if the window + parameter is null. + + +</PRE> +<H2>NOTES</H2><PRE> + All of these interfaces are provided as macros and func- + tions. The macros are suppressed (and only the functions + provided) when <STRONG>NCURSES_OPAQUE</STRONG> is defined. The standard + forms such as <STRONG>getyx</STRONG> must be implemented as macros, and (in + this implementation) are defined in terms of the functions + described here, to avoid reliance on internal details of + the WINDOW structure. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions were supported on Version 7, BSD or System + V implementations. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_memleaks.3x.html b/doc/html/man/curs_memleaks.3x.html new file mode 100644 index 000000000000..540ea935a4ce --- /dev/null +++ b/doc/html/man/curs_memleaks.3x.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_memleaks.3x,v 1.3 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_memleaks 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_memleaks 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>_nc_freeall</STRONG> <STRONG>_nc_free_and_exit</STRONG> - <STRONG>curses</STRONG> memory-leak + checking + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG> + <STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions are used to simplify analysis of memory + leaks in the ncurses library. They are normally not + available; they must be configured into the library at + build time using the <STRONG>--disable-leaks</STRONG> option. That com- + piles-in code that frees memory that normally would not be + freed. + + Any implementation of curses must not free the memory as- + sociated with a screen, since (even after calling <STRONG>endwin</STRONG>), + it must be available for use in the next call to <STRONG>refresh</STRONG>. + There are also chunks of memory held for performance rea- + sons. That makes it hard to analyze curses applications + for memory leaks. To work around this, one can build a + debugging version of the ncurses library which frees those + chunks which it can, and provides these functions to free + all of the memory allocated by the ncurses library. + + The _nc_free_and_exit function is the preferred one since + some of the memory which is freed may be required for the + application to continue running. Its parameter is the + code to pass to the exit routine. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These functions do not return a value. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are not part of the XSI interface. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html new file mode 100644 index 000000000000..d640680c2013 --- /dev/null +++ b/doc/html/man/curs_mouse.3x.html @@ -0,0 +1,318 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_mouse.3x,v 1.38 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_mouse 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_mouse 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>, + <STRONG>mouse_trafo</STRONG>, <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - mouse interface + through curses + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>typedef</STRONG> <STRONG>unsigned</STRONG> <STRONG>long</STRONG> <STRONG>mmask_t;</STRONG> + + typedef struct + { + short id; <EM>/*</EM> <EM>ID</EM> <EM>to</EM> <EM>distinguish</EM> <EM>multiple</EM> <EM>devices</EM> <EM>*/</EM> + <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>y,</STRONG> <STRONG>z;</STRONG> <EM>/*</EM> <EM>event</EM> <EM>coordinates</EM> <EM>*/</EM> + <STRONG>mmask_t</STRONG> <STRONG>bstate;</STRONG> <EM>/*</EM> <EM>button</EM> <EM>state</EM> <EM>bits</EM> <EM>*/</EM> + <STRONG>}</STRONG> + <STRONG>MEVENT;</STRONG> + <STRONG>bool</STRONG> <STRONG>has_mouse(void);</STRONG> + <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*event);</STRONG> + <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*event);</STRONG> + <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <STRONG>newmask,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*oldmask);</STRONG> + <STRONG>bool</STRONG> <STRONG>wenclose(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <STRONG>pY,</STRONG> <STRONG>int*</STRONG> <STRONG>pX,</STRONG> <STRONG>bool</STRONG> <STRONG>to_screen);</STRONG> + <STRONG>bool</STRONG> <STRONG>wmouse_trafo(const</STRONG> <STRONG>WINDOW*</STRONG> <STRONG>win,</STRONG> <STRONG>int*</STRONG> <STRONG>pY,</STRONG> <STRONG>int*</STRONG> <STRONG>pX,</STRONG> + <STRONG>bool</STRONG> <STRONG>to_screen);</STRONG> + <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <STRONG>erval);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions provide an interface to mouse events from + <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. Mouse events are represented by <STRONG>KEY_MOUSE</STRONG> + pseudo-key values in the <STRONG>wgetch</STRONG> input stream. + + To make mouse events visible, use the <STRONG>mousemask</STRONG> function. + This will set the mouse events to be reported. By de- + fault, no mouse events are reported. The function will + return a mask to indicate which of the specified mouse + events can be reported; on complete failure it returns 0. + If oldmask is non-NULL, this function fills the indicated + location with the previous value of the given window's + mouse event mask. + + As a side effect, setting a zero mousemask may turn off + the mouse pointer; setting a nonzero mask may turn it on. + Whether this happens is device-dependent. + + Here are the mouse event type masks which may be defined: + + + <EM>Name</EM> <EM>Description</EM> + --------------------------------------------------------------------- + BUTTON1_PRESSED mouse button 1 down + BUTTON1_RELEASED mouse button 1 up + BUTTON1_CLICKED mouse button 1 clicked + BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked + BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked + --------------------------------------------------------------------- + BUTTON2_PRESSED mouse button 2 down + BUTTON2_RELEASED mouse button 2 up + BUTTON2_CLICKED mouse button 2 clicked + BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked + + + BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked + --------------------------------------------------------------------- + BUTTON3_PRESSED mouse button 3 down + BUTTON3_RELEASED mouse button 3 up + BUTTON3_CLICKED mouse button 3 clicked + BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked + BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked + --------------------------------------------------------------------- + BUTTON4_PRESSED mouse button 4 down + BUTTON4_RELEASED mouse button 4 up + BUTTON4_CLICKED mouse button 4 clicked + BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked + BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked + --------------------------------------------------------------------- + BUTTON5_PRESSED mouse button 5 down + BUTTON5_RELEASED mouse button 5 up + BUTTON5_CLICKED mouse button 5 clicked + BUTTON5_DOUBLE_CLICKED mouse button 5 double clicked + BUTTON5_TRIPLE_CLICKED mouse button 5 triple clicked + --------------------------------------------------------------------- + BUTTON_SHIFT shift was down during button state change + BUTTON_CTRL control was down during button state change + BUTTON_ALT alt was down during button state change + ALL_MOUSE_EVENTS report all button state changes + REPORT_MOUSE_POSITION report mouse movement + --------------------------------------------------------------------- + + Once a class of mouse events have been made visible in a + window, calling the <STRONG>wgetch</STRONG> function on that window may re- + turn <STRONG>KEY_MOUSE</STRONG> as an indicator that a mouse event has been + queued. To read the event data and pop the event off the + queue, call <STRONG>getmouse</STRONG>. This function will return <STRONG>OK</STRONG> if a + mouse event is actually visible in the given window, <STRONG>ERR</STRONG> + otherwise. When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the data deposited + as y and x in the event structure coordinates will be + screen-relative character-cell coordinates. The returned + state mask will have exactly one bit set to indicate the + event type. The corresponding data in the queue is marked + invalid. A subsequent call to <STRONG>getmouse</STRONG> will retrieve the + next older item from the queue. + + The <STRONG>ungetmouse</STRONG> function behaves analogously to <STRONG>ungetch</STRONG>. + It pushes a <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and as- + sociates with that event the given state data and screen- + relative character-cell coordinates. + + The <STRONG>wenclose</STRONG> function tests whether a given pair of + screen-relative character-cell coordinates is enclosed by + a given window, returning TRUE if it is and FALSE other- + wise. It is useful for determining what subset of the + screen windows enclose the location of a mouse event. + + The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coor- + dinates from stdscr-relative coordinates to coordinates + relative to the given window or vice versa. Please remem- + ber, that stdscr-relative coordinates are not always iden- + tical to window-relative coordinates due to the mechanism + to reserve lines on top or bottom of the screen for other + purposes (see the <STRONG>ripoffline()</STRONG> and <STRONG>slk_init</STRONG> calls, for ex- + ample). If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers + <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference the coordinates of a location inside + the window <STRONG>win</STRONG>. They are converted to window-relative co- + ordinates and returned through the pointers. If the con- + version was successful, the function returns <STRONG>TRUE</STRONG>. If one + of the parameters was NULL or the location is not inside + the window, <STRONG>FALSE</STRONG> is returned. If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the + pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference window-relative coordi- + nates. They are converted to stdscr-relative coordinates + if the window <STRONG>win</STRONG> encloses this point. In this case the + function returns <STRONG>TRUE</STRONG>. If one of the parameters is NULL + or the point is not inside the window, <STRONG>FALSE</STRONG> is returned. + Please notice, that the referenced coordinates are only + replaced by the converted coordinates if the transforma- + tion was successful. + + The <STRONG>mouse_trafo</STRONG> function performs the same translation as + <STRONG>wmouse_trafo</STRONG>, using stdscr for <STRONG>win</STRONG>. + + The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thou- + sands of a second) that can elapse between press and re- + lease events for them to be recognized as a click. Use + <STRONG>mouseinterval(0)</STRONG> to disable click resolution. This func- + tion returns the previous interval value. Use <STRONG>mouseinter-</STRONG> + <STRONG>val(-1)</STRONG> to obtain the interval without altering it. The + default is one sixth of a second. + + The <STRONG>has_mouse</STRONG> function returns TRUE if the mouse driver + has been successfully initialized. + + Note that mouse events will be ignored when input is in + cooked mode, and will cause an error beep when cooked mode + is being simulated in a window by a function such as <STRONG>get-</STRONG> + <STRONG>str</STRONG> that expects a linefeed for input-loop termination. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon fail- + ure or <STRONG>OK</STRONG> upon successful completion. + + <STRONG>getmouse</STRONG> + returns an error. If no mouse driver was ini- + tialized, or if the mask parameter is zero, it + also returns an error if no more events remain + in the queue. + + <STRONG>ungetmouse</STRONG> + returns an error if the FIFO is full. + + <STRONG>mousemask</STRONG> returns the mask of reportable events. + + <STRONG>mouseinterval</STRONG> returns the previous interval value, unless + the terminal was not initialized. In that case, it re- + turns the maximum interval value (166). + + <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning + <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> depending on their test result. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These calls were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not + found in SVr4 curses, 4.4BSD curses, or any other previous + version of curses. + + The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the + preprocessor can be used to test whether these features + are present. If the interface is changed, the value of + <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be incremented. These values + for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when configur- + ing ncurses: + + 1 has definitions for reserved events. The mask + uses 28 bits. + + 2 adds definitions for button 5, removes the defi- + nitions for reserved events. The mask uses 29 + bits. + + The order of the <STRONG>MEVENT</STRONG> structure members is not guaran- + teed. Additional fields may be added to the structure in + the future. + + Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are implemented using ei- + ther xterm's built-in mouse-tracking API or platform-spe- + cific drivers including + Alessandro Rubini's gpm server + FreeBSD sysmouse + OS/2 EMX + If you are using an unsupported configuration, mouse + events will not be visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mouse-</STRONG> + <STRONG>mask</STRONG> function will always return <STRONG>0</STRONG>). + + If the terminfo entry contains a <STRONG>XM</STRONG> string, this is used + in the xterm mouse driver to control the way the terminal + is initialized for mouse operation. The default, if <STRONG>XM</STRONG> is + not found, corresponds to private mode 1000 of xterm: + \E[?1000%?%p1%{1}%=%th%el%; + The z member in the event structure is not presently used. + It is intended for use with touch screens (which may be + pressure-sensitive) or with 3D-mice/trackballs/power + gloves. + + +</PRE> +<H2>BUGS</H2><PRE> + Mouse events under xterm will not in fact be ignored dur- + ing cooked mode, if they have been enabled by <STRONG>mousemask</STRONG>. + Instead, the xterm mouse report sequence will appear in + the string read. + + Mouse events under xterm will not be detected correctly in + a window with its keypad bit off, since they are inter- + preted as a variety of function key. Your terminfo de- + scription should have <STRONG>kmous</STRONG> set to "\E[M" (the beginning + of the response from xterm for mouse clicks). Other val- + ues for <STRONG>kmous</STRONG> are permitted, but under the same assump- + tion, i.e., it is the beginning of the response. + + Because there are no standard terminal responses that + would serve to identify terminals which support the xterm + mouse protocol, <STRONG>ncurses</STRONG> assumes that if your $TERM envi- + ronment variable contains "xterm", or <STRONG>kmous</STRONG> is defined in + the terminal description, then the terminal may send mouse + events. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> + <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_move.3x.html b/doc/html/man/curs_move.3x.html new file mode 100644 index 000000000000..d78178d35d7d --- /dev/null +++ b/doc/html/man/curs_move.3x.html @@ -0,0 +1,105 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_move.3x,v 1.14 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_move 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_move 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG> <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>move</STRONG>, <STRONG>wmove</STRONG> - move <STRONG>curses</STRONG> window cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>move(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>int</STRONG> <STRONG>wmove(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines move the cursor associated with the window + to line <EM>y</EM> and column <EM>x</EM>. This routine does not move the + physical cursor of the terminal until <STRONG>refresh</STRONG> is called. + The position specified is relative to the upper left-hand + corner of the window, which is (0,0). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <STRONG>ERR</STRONG> upon failure and OK (SVr4 speci- + fies only "an integer value other than <STRONG>ERR</STRONG>") upon success- + ful completion. + + Specifically, they return an error if the window pointer + is null, or if the position is outside the window. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>move</STRONG> may be a macro. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_opaque.3x.html b/doc/html/man/curs_opaque.3x.html new file mode 100644 index 000000000000..6d01f2e5b1c4 --- /dev/null +++ b/doc/html/man/curs_opaque.3x.html @@ -0,0 +1,161 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2007-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_opaque.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_opaque 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_opaque 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>is_cleared</STRONG>, <STRONG>is_idlok</STRONG>, <STRONG>is_idcok</STRONG>, <STRONG>is_immedok</STRONG>, <STRONG>is_keypad</STRONG>, + <STRONG>is_leaveok</STRONG>, <STRONG>is_nodelay</STRONG>, <STRONG>is_notimeout</STRONG>, <STRONG>is_pad</STRONG>, <STRONG>is_scrollok</STRONG>, + <STRONG>is_subwin</STRONG>, <STRONG>is_syncok</STRONG> - <STRONG>curses</STRONG> window properties + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>bool</STRONG> <STRONG>is_cleared(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_idcok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_idlok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_immedok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_keypad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_leaveok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_nodelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_notimeout(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_pad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_scrollok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_subwin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_syncok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>wgetparent(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>wgetscrreg(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>*top,</STRONG> <STRONG>int</STRONG> <STRONG>*bottom);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This implementation provides functions which return prop- + erties set in the WINDOW structure, allowing it to be + ``opaque'' if the symbol <STRONG>NCURSES_OPAQUE</STRONG> is defined: + + <STRONG>is_cleared</STRONG> + returns the value set in <STRONG>clearok</STRONG> + + <STRONG>is_idcok</STRONG> + returns the value set in <STRONG>idcok</STRONG> + + <STRONG>is_idlok</STRONG> + returns the value set in <STRONG>idlok</STRONG> + + <STRONG>is_immedok</STRONG> + returns the value set in <STRONG>immedok</STRONG> + + <STRONG>is_keypad</STRONG> + returns the value set in <STRONG>keypad</STRONG> + + <STRONG>is_leaveok</STRONG> + returns the value set in <STRONG>leaveok</STRONG> + + <STRONG>is_nodelay</STRONG> + returns the value set in <STRONG>nodelay</STRONG> + + <STRONG>is_notimeout</STRONG> + returns the value set in <STRONG>notimeout</STRONG> + + <STRONG>is_pad</STRONG> + returns TRUE if the window is a pad i.e., created by + <STRONG>newpad</STRONG> + + <STRONG>is_scrollok</STRONG> + returns the value set in <STRONG>scrollok</STRONG> + + <STRONG>is_subwin</STRONG> + returns TRUE if the window is a subwindow, i.e., cre- + ated by <STRONG>subwin</STRONG> or <STRONG>derwin</STRONG> + + <STRONG>is_syncok</STRONG> + returns the value set in <STRONG>syncok</STRONG> + + <STRONG>wgetparent</STRONG> + returns the parent WINDOW pointer for subwindows, or + NULL for windows having no parent. + + <STRONG>wgetscrreg</STRONG> + returns the top and bottom rows for the scrolling + margin as set in <STRONG>wsetscrreg</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These functions all return TRUE or FALSE, except as noted. + + +</PRE> +<H2>NOTES</H2><PRE> + Both a macro and a function are provided for each name. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on ncurses ex- + tensions be conditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG>curs_win-</STRONG> + <STRONG><A HREF="curs_window.3x.html">dow(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html new file mode 100644 index 000000000000..9be94d9b78fb --- /dev/null +++ b/doc/html/man/curs_outopts.3x.html @@ -0,0 +1,234 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_outopts.3x,v 1.25 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_outopts 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_outopts 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>clearok</STRONG>, <STRONG>idlok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>immedok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>setscrreg</STRONG>, + <STRONG>wsetscrreg</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> - <STRONG>curses</STRONG> output options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>clearok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>idlok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>void</STRONG> <STRONG>idcok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>void</STRONG> <STRONG>immedok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>leaveok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>setscrreg(int</STRONG> <STRONG>top,</STRONG> <STRONG>int</STRONG> <STRONG>bot);</STRONG> + <STRONG>int</STRONG> <STRONG>wsetscrreg(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>top,</STRONG> <STRONG>int</STRONG> <STRONG>bot);</STRONG> + <STRONG>int</STRONG> <STRONG>scrollok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>int</STRONG> <STRONG>nl(void);</STRONG> + <STRONG>int</STRONG> <STRONG>nonl(void);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines set options that change the style of output + within <STRONG>curses</STRONG>. All options are initially <STRONG>FALSE</STRONG>, unless + otherwise stated. It is not necessary to turn these op- + tions off before calling <STRONG>endwin</STRONG>. + + If <STRONG>clearok</STRONG> is called with <STRONG>TRUE</STRONG> as argument, the next call + to <STRONG>wrefresh</STRONG> with this window will clear the screen com- + pletely and redraw the entire screen from scratch. This + is useful when the contents of the screen are uncertain, + or in some cases for a more pleasing visual effect. If + the <EM>win</EM> argument to <STRONG>clearok</STRONG> is the global variable <STRONG>curscr</STRONG>, + the next call to <STRONG>wrefresh</STRONG> with any window causes the + screen to be cleared and repainted from scratch. + + If <STRONG>idlok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, <STRONG>curses</STRONG> + considers using the hardware insert/delete line feature of + terminals so equipped. Calling <STRONG>idlok</STRONG> with <STRONG>FALSE</STRONG> as second + argument disables use of line insertion and deletion. + This option should be enabled only if the application + needs insert/delete line, for example, for a screen edi- + tor. It is disabled by default because insert/delete line + tends to be visually annoying when used in applications + where it is not really needed. If insert/delete line can- + not be used, <STRONG>curses</STRONG> redraws the changed portions of all + lines. + + If <STRONG>idcok</STRONG> is called with <STRONG>FALSE</STRONG> as second argument, <STRONG>curses</STRONG> + no longer considers using the hardware insert/delete char- + acter feature of terminals so equipped. Use of character + insert/delete is enabled by default. Calling <STRONG>idcok</STRONG> with + <STRONG>TRUE</STRONG> as second argument re-enables use of character inser- + tion and deletion. + + If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> <STRONG>as</STRONG> <STRONG>argument</STRONG>, any change in + the window image, such as the ones caused by <STRONG>waddch,</STRONG> <STRONG>wclr-</STRONG> + <STRONG>tobot,</STRONG> <STRONG>wscrl</STRONG>, etc., automatically cause a call to <STRONG>wre-</STRONG> + <STRONG>fresh</STRONG>. However, it may degrade performance considerably, + due to repeated calls to <STRONG>wrefresh</STRONG>. It is disabled by de- + fault. + + Normally, the hardware cursor is left at the location of + the window cursor being refreshed. The <STRONG>leaveok</STRONG> option al- + lows the cursor to be left wherever the update happens to + leave it. It is useful for applications where the cursor + is not used, since it reduces the need for cursor motions. + + The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the applica- + tion programmer to set a software scrolling region in a + window. The <EM>top</EM> and <EM>bot</EM> parameters are the line numbers + of the top and bottom margin of the scrolling region. + (Line 0 is the top line of the window.) If this option + and <STRONG>scrollok</STRONG> are enabled, an attempt to move off the bot- + tom margin line causes all lines in the scrolling region + to scroll one line in the direction of the first line. + Only the text of the window is scrolled. (Note that this + has nothing to do with the use of a physical scrolling re- + gion capability in the terminal, like that in the VT100. + If <STRONG>idlok</STRONG> is enabled and the terminal has either a + scrolling region or insert/delete line capability, they + will probably be used by the output routines.) + + The <STRONG>scrollok</STRONG> option controls what happens when the cursor + of a window is moved off the edge of the window or + scrolling region, either as a result of a newline action + on the bottom line, or typing the last character of the + last line. If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor is left + on the bottom line. If enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the window + is scrolled up one line (Note that to get the physical + scrolling effect on the terminal, it is also necessary to + call <STRONG>idlok</STRONG>). + + The <STRONG>nl</STRONG> and <STRONG>nonl</STRONG> routines control whether the underlying + display device translates the return key into newline on + input, and whether it translates newline into return and + line-feed on output (in either case, the call <STRONG>addch('\n')</STRONG> + does the equivalent of return and line feed on the virtual + screen). Initially, these translations do occur. If you + disable them using <STRONG>nonl</STRONG>, <STRONG>curses</STRONG> will be able to make bet- + ter use of the line-feed capability, resulting in faster + cursor motion. Also, <STRONG>curses</STRONG> will then be able to detect + the return key. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The functions <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon suc- + cess and <STRONG>ERR</STRONG> upon failure. All other routines that return + an integer always return <STRONG>OK</STRONG>. + + X/Open does not define any error conditions. + + In this implementation, those functions that have a window + pointer will return an error if the window pointer is + null. + + <STRONG>wclrtoeol</STRONG> + returns an error if the cursor position is + about to wrap. + + <STRONG>wsetscrreg</STRONG> + returns an error if the scrolling region lim- + its extend outside the window. + + X/Open does not define any error conditions. This imple- + mentation returns an error if the window pointer is null. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + The XSI Curses standard is ambiguous on the question of + whether <STRONG>raw</STRONG>() should disable the CRLF translations con- + trolled by <STRONG>nl</STRONG>() and <STRONG>nonl</STRONG>(). BSD curses did turn off these + translations; AT&T curses (at least as late as SVr1) did + not. We choose to do so, on the theory that a programmer + requesting raw input wants a clean (ideally 8-bit clean) + connection that the operating system will not alter. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(std-</STRONG> + <STRONG>scr)</STRONG>. This will not work under ncurses. + + Earlier System V curses implementations specified that + with <STRONG>scrollok</STRONG> enabled, any window modification triggering + a scroll also forced a physical refresh. XSI Curses does + not require this, and <STRONG>ncurses</STRONG> avoids doing it to perform + better vertical-motion optimization at <STRONG>wrefresh</STRONG> time. + + The XSI Curses standard does not mention that the cursor + should be made invisible as a side-effect of <STRONG>leaveok</STRONG>. + SVr4 curses documentation does this, but the code does + not. Use <STRONG>curs_set</STRONG> to make the cursor invisible. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>clearok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> and + <STRONG>setscrreg</STRONG> may be macros. + + The <STRONG>immedok</STRONG> routine is useful for windows that are used as + terminal emulators. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, + <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, + <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html new file mode 100644 index 000000000000..69ed0fcaafa1 --- /dev/null +++ b/doc/html/man/curs_overlay.3x.html @@ -0,0 +1,122 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_overlay.3x,v 1.16 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_overlay 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_overlay 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate + overlapped <STRONG>curses</STRONG> windows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG> + <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG> + <STRONG>int</STRONG> <STRONG>copywin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin,</STRONG> <STRONG>int</STRONG> + <STRONG>sminrow,</STRONG> + <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>dminrow,</STRONG> <STRONG>int</STRONG> <STRONG>dmincol,</STRONG> <STRONG>int</STRONG> <STRONG>dmaxrow,</STRONG> + <STRONG>int</STRONG> <STRONG>dmaxcol,</STRONG> <STRONG>int</STRONG> <STRONG>overlay);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top + of <EM>dstwin</EM>. <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the + same size; only text where the two windows overlap is + copied. The difference is that <STRONG>overlay</STRONG> is non-destructive + (blanks are not copied) whereas <STRONG>overwrite</STRONG> is destructive. + + The <STRONG>copywin</STRONG> routine provides a finer granularity of con- + trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. Like in the + <STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina- + tion window, (<EM>dminrow</EM>, <EM>dmincol</EM>) and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), + and the upper-left-corner coordinates of the source win- + dow, (<EM>sminrow</EM>, <EM>smincol</EM>). If the argument <EM>overlay</EM> is <STRONG>true</STRONG>, + then copying is non-destructive, as in <STRONG>overlay</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <STRONG>ERR</STRONG> upon failure, + and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion. + + X/Open defines no error conditions. In this implementa- + tion, <STRONG>copywin</STRONG>, <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return an error if + either of the window pointers are null, or if some part of + the window would be placed off-screen. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these functions + (adding the const qualifiers). It further specifies their + behavior in the presence of characters with multibyte ren- + ditions (not yet supported in this implementation). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_pad.3x.html b/doc/html/man/curs_pad.3x.html new file mode 100644 index 000000000000..ca16cf4603de --- /dev/null +++ b/doc/html/man/curs_pad.3x.html @@ -0,0 +1,184 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_pad.3x,v 1.17 2010/12/04 18:41:07 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_pad 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_pad 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>newpad</STRONG>, <STRONG>subpad</STRONG>, <STRONG>prefresh</STRONG>, <STRONG>pnoutrefresh</STRONG>, <STRONG>pechochar</STRONG>, + <STRONG>pecho_wchar</STRONG> - create and display <STRONG>curses</STRONG> pads + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>WINDOW</STRONG> <STRONG>*newpad(int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols);</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*subpad(WINDOW</STRONG> <STRONG>*orig,</STRONG> <STRONG>int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG> + <STRONG>int</STRONG> <STRONG>begin_y,</STRONG> <STRONG>int</STRONG> <STRONG>begin_x);</STRONG> + <STRONG>int</STRONG> <STRONG>prefresh(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>int</STRONG> <STRONG>pminrow,</STRONG> <STRONG>int</STRONG> <STRONG>pmincol,</STRONG> + <STRONG>int</STRONG> <STRONG>sminrow,</STRONG> <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>smaxrow,</STRONG> <STRONG>int</STRONG> <STRONG>smaxcol);</STRONG> + <STRONG>int</STRONG> <STRONG>pnoutrefresh(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>int</STRONG> <STRONG>pminrow,</STRONG> <STRONG>int</STRONG> <STRONG>pmincol,</STRONG> + <STRONG>int</STRONG> <STRONG>sminrow,</STRONG> <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>smaxrow,</STRONG> <STRONG>int</STRONG> <STRONG>smaxcol);</STRONG> + <STRONG>int</STRONG> <STRONG>pechochar(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>int</STRONG> <STRONG>pecho_wchar(WINDOW</STRONG> <STRONG>*pad,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*wch);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>newpad</STRONG> routine creates and returns a pointer to a new + pad data structure with the given number of lines, <EM>nlines</EM>, + and columns, <EM>ncols</EM>. A pad is like a window, except that + it is not restricted by the screen size, and is not neces- + sarily associated with a particular part of the screen. + Pads can be used when a large window is needed, and only a + part of the window will be on the screen at one time. Au- + tomatic refreshes of pads (e.g., from scrolling or echoing + of input) do not occur. It is not legal to call <STRONG>wrefresh</STRONG> + with a <EM>pad</EM> as an argument; the routines <STRONG>prefresh</STRONG> or + <STRONG>pnoutrefresh</STRONG> should be called instead. Note that these + routines require additional parameters to specify the part + of the pad to be displayed and the location on the screen + to be used for the display. + + The <STRONG>subpad</STRONG> routine creates and returns a pointer to a sub- + window within a pad with the given number of lines, + <EM>nlines</EM>, and columns, <EM>ncols</EM>. Unlike <STRONG>subwin</STRONG>, which uses + screen coordinates, the window is at position (<EM>begin</EM>_<EM>x</EM><STRONG>,</STRONG> + <EM>begin</EM>_<EM>y</EM>) on the pad. The window is made in the middle of + the window <EM>orig</EM>, so that changes made to one window affect + both windows. During the use of this routine, it will of- + ten be necessary to call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> be- + fore calling <STRONG>prefresh</STRONG>. + + The <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG> routines are analogous to + <STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> except that they relate to pads + instead of windows. The additional parameters are needed + to indicate what part of the pad and screen are involved. + The <EM>pminrow</EM> and <EM>pmincol</EM> parameters specify the upper left- + hand corner of the rectangle to be displayed in the pad. + The <EM>sminrow</EM>, <EM>smincol</EM>, <EM>smaxrow</EM>, and <EM>smaxcol</EM> parameters + specify the edges of the rectangle to be displayed on the + screen. The lower right-hand corner of the rectangle to + be displayed in the pad is calculated from the screen co- + ordinates, since the rectangles must be the same size. + Both rectangles must be entirely contained within their + respective structures. Negative values of <EM>pminrow</EM>, <EM>pmin-</EM> + <EM>col</EM>, <EM>sminrow</EM>, or <EM>smincol</EM> are treated as if they were zero. + + The <STRONG>pechochar</STRONG> routine is functionally equivalent to a call + to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, a call to <STRONG>waddch</STRONG> + followed by a call to <STRONG>wrefresh</STRONG>, or a call to <STRONG>waddch</STRONG> fol- + lowed by a call to <STRONG>prefresh</STRONG>. The knowledge that only a + single character is being output is taken into considera- + tion and, for non-control characters, a considerable per- + formance gain might be seen by using these routines in- + stead of their equivalents. In the case of <STRONG>pechochar</STRONG>, the + last location of the pad on the screen is reused for the + arguments to <STRONG>prefresh</STRONG>. + + The <STRONG>pecho_wchar</STRONG> function is the analogous wide-character + form of <STRONG>pechochar</STRONG>. It outputs one character to a pad and + immediately refreshes the pad. It does this by a call to + <STRONG>wadd_wch</STRONG> followed by a call to <STRONG>prefresh</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <STRONG>ERR</STRONG> upon failure + and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion. + + Routines that return pointers return <STRONG>NULL</STRONG> on error, and + set <STRONG>errno</STRONG> to <STRONG>ENOMEM</STRONG>. + + X/Open does not define any error conditions. In this im- + plementation + + <STRONG>prefresh</STRONG> and <STRONG>pnoutrefresh</STRONG> + return an error if the window pointer is null, + or if the window is not really a pad or if the + area to refresh extends off-screen or if the + minimum coordinates are greater than the maxi- + mum. + + <STRONG>pechochar</STRONG> + returns an error if the window is not really a + pad, and the associated call to <STRONG>wechochar</STRONG> re- + turns an error. + + <STRONG>pecho_wchar</STRONG> + returns an error if the window is not really a + pad, and the associated call to <STRONG>wecho_wchar</STRONG> + returns an error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>pechochar</STRONG> may be a macro. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>, <STRONG>curs_add-</STRONG> + <STRONG><A HREF="curs_addch.3x.html">ch(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_print.3x.html b/doc/html/man/curs_print.3x.html new file mode 100644 index 000000000000..11b64a7f5509 --- /dev/null +++ b/doc/html/man/curs_print.3x.html @@ -0,0 +1,121 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_print.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_print 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_print 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mcprint</STRONG> - ship binary data to printer + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>mcprint(char</STRONG> <STRONG>*data,</STRONG> <STRONG>int</STRONG> <STRONG>len);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This function uses the <STRONG>mc5p</STRONG> or <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities, + if they are present, to ship given data to a printer + attached to the terminal. + + Note that the <STRONG>mcprint</STRONG> code has no way to do flow control + with the printer or to know how much buffering it has. + Your application is responsible for keeping the rate of + writes to the printer below its continuous throughput rate + (typically about half of its nominal cps rating). Dot- + matrix printers and 6-page-per-minute lasers can typically + handle 80cps, so a good conservative rule of thumb is to + sleep for a second after shipping each 80-character line. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The <STRONG>mcprint</STRONG> function returns <STRONG>ERR</STRONG> if the write operation + aborted for some reason. In this case, errno will contain + either an error associated with <STRONG>write(2)</STRONG> or one of the + following: + + ENODEV + Capabilities for printer redirection do not exist. + + ENOMEM + Couldn't allocate sufficient memory to buffer the + printer write. + + When <STRONG>mcprint</STRONG> succeeds, it returns the number of characters + actually sent to the printer. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <STRONG>mcprint</STRONG> call was designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and is not + found in SVr4 curses, 4.4BSD curses, or any other previous + version of curses. + + +</PRE> +<H2>BUGS</H2><PRE> + Padding in the <STRONG>mc5p</STRONG>, <STRONG>mc4</STRONG> and <STRONG>mc5</STRONG> capabilities will not be + interpreted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_printw.3x.html b/doc/html/man/curs_printw.3x.html new file mode 100644 index 000000000000..f845852dec40 --- /dev/null +++ b/doc/html/man/curs_printw.3x.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_printw.3x,v 1.20 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_printw 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_printw 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG>, <STRONG>mvwprintw</STRONG>, <STRONG>vwprintw</STRONG>, <STRONG>vw_printw</STRONG> + - print formatted output in <STRONG>curses</STRONG> windows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>printw(const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>wprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>mvprintw(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> + <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>vwprintw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>var-</STRONG> + <STRONG>glist);</STRONG> + <STRONG>int</STRONG> <STRONG>vw_printw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>var-</STRONG> + <STRONG>glist);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>printw</STRONG>, <STRONG>wprintw</STRONG>, <STRONG>mvprintw</STRONG> and <STRONG>mvwprintw</STRONG> routines are + analogous to <STRONG>printf</STRONG> [see <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>]. In effect, the + string that would be output by <STRONG>printf</STRONG> is output instead as + though <STRONG>waddstr</STRONG> were used on the given window. + + The <STRONG>vwprintw</STRONG> and <STRONG>wv_printw</STRONG> routines are analogous to + <STRONG>vprintf</STRONG> [see <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>] and perform a <STRONG>wprintw</STRONG> using a + variable argument list. The third argument is a <STRONG>va_list</STRONG>, + a pointer to a list of arguments, as defined in + <STRONG><stdarg.h></STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <STRONG>ERR</STRONG> upon failure + and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion. + + X/Open defines no error conditions. In this implementa- + tion, an error may be returned if it cannot allocate + enough memory for the buffer used to format the results. + It will return an error if the window pointer is null. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. The function <STRONG>vwprintw</STRONG> is marked TO BE WITHDRAWN, + and is to be replaced by a function <STRONG>vw_printw</STRONG> using the + <STRONG><stdarg.h></STRONG> interface. The Single Unix Specification, Ver- + sion 2 states that <STRONG>vw_printw</STRONG> is preferred to <STRONG>vwprintw</STRONG> + since the latter requires including <STRONG><varargs.h></STRONG>, which + cannot be used in the same file as <STRONG><stdarg.h></STRONG>. This im- + plementation uses <STRONG><stdarg.h></STRONG> for both, because that header + is included in <STRONG><curses.h</STRONG>>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>, <STRONG>vprintf(3)</STRONG> + + + + <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_refresh.3x.html b/doc/html/man/curs_refresh.3x.html new file mode 100644 index 000000000000..78988f5070ee --- /dev/null +++ b/doc/html/man/curs_refresh.3x.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_refresh.3x,v 1.15 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_refresh 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_refresh 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>doupdate</STRONG>, <STRONG>redrawwin</STRONG>, <STRONG>refresh</STRONG>, <STRONG>wnoutrefresh</STRONG>, <STRONG>wredrawln</STRONG>, + <STRONG>wrefresh</STRONG> - refresh <STRONG>curses</STRONG> windows and lines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>refresh(void);</STRONG> + <STRONG>int</STRONG> <STRONG>wrefresh(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>wnoutrefresh(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>doupdate(void);</STRONG> + <STRONG>int</STRONG> <STRONG>redrawwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>wredrawln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>beg_line,</STRONG> <STRONG>int</STRONG> <STRONG>num_lines);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>refresh</STRONG> and <STRONG>wrefresh</STRONG> routines (or <STRONG>wnoutrefresh</STRONG> and + <STRONG>doupdate</STRONG>) must be called to get actual output to the ter- + minal, as other routines merely manipulate data struc- + tures. The routine <STRONG>wrefresh</STRONG> copies the named window to + the physical terminal screen, taking into account what is + already there to do optimizations. The <STRONG>refresh</STRONG> routine is + the same, using <STRONG>stdscr</STRONG> as the default window. Unless + <STRONG>leaveok</STRONG> has been enabled, the physical cursor of the ter- + minal is left at the location of the cursor for that win- + dow. + + The <STRONG>wnoutrefresh</STRONG> and <STRONG>doupdate</STRONG> routines allow multiple up- + dates with more efficiency than <STRONG>wrefresh</STRONG> alone. In addi- + tion to all the window structures, <STRONG>curses</STRONG> keeps two data + structures representing the terminal screen: a physical + screen, describing what is actually on the screen, and a + virtual screen, describing what the programmer wants to + have on the screen. + + The routine <STRONG>wrefresh</STRONG> works by first calling <STRONG>wnoutrefresh</STRONG>, + which copies the named window to the virtual screen, and + then calling <STRONG>doupdate</STRONG>, which compares the virtual screen + to the physical screen and does the actual update. If the + programmer wishes to output several windows at once, a se- + ries of calls to <STRONG>wrefresh</STRONG> results in alternating calls to + <STRONG>wnoutrefresh</STRONG> and <STRONG>doupdate</STRONG>, causing several bursts of out- + put to the screen. By first calling <STRONG>wnoutrefresh</STRONG> for each + window, it is then possible to call <STRONG>doupdate</STRONG> once, result- + ing in only one burst of output, with fewer total charac- + ters transmitted and less CPU time used. If the <EM>win</EM> argu- + ment to <STRONG>wrefresh</STRONG> is the global variable <STRONG>curscr</STRONG>, the screen + is immediately cleared and repainted from scratch. + + The phrase "copies the named window to the virtual screen" + above is ambiguous. What actually happens is that all + <EM>touched</EM> (changed) lines in the window are copied to the + virtual screen. This affects programs that use overlap- + ping windows; it means that if two windows overlap, you + can refresh them in either order and the overlap region + will be modified only when it is explicitly changed. (But + see the section on <STRONG>PORTABILITY</STRONG> below for a warning about + exploiting this behavior.) + + The <STRONG>wredrawln</STRONG> routine indicates to <STRONG>curses</STRONG> that some screen + lines are corrupted and should be thrown away before any- + thing is written over them. It touches the indicated + lines (marking them changed). The routine <STRONG>redrawwin</STRONG>() + touches the entire window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <STRONG>ERR</STRONG> upon failure, + and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion. + + X/Open does not define any error conditions. In this im- + plementation + + <STRONG>wnoutrefresh</STRONG> + returns an error if the window pointer is + null, or if the window is really a pad. + + <STRONG>wredrawln</STRONG> + returns an error if the associated call to + <STRONG>touchln</STRONG> returns an error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>refresh</STRONG> and <STRONG>redrawwin</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + Whether <STRONG>wnoutrefresh()</STRONG> copies to the virtual screen the + entire contents of a window or just its changed portions + has never been well-documented in historic curses versions + (including SVr4). It might be unwise to rely on either + behavior in programs that might have to be linked with + other curses implementations. Instead, you can do an ex- + plicit <STRONG>touchwin()</STRONG> before the <STRONG>wnoutrefresh()</STRONG> call to guar- + antee an entire-contents copy anywhere. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html new file mode 100644 index 000000000000..40cb95234f92 --- /dev/null +++ b/doc/html/man/curs_scanw.3x.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_scanw.3x,v 1.17 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_scanw 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_scanw 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG>, <STRONG>mvwscanw</STRONG>, <STRONG>vwscanw</STRONG>, <STRONG>vw_scanw</STRONG> - con- + vert formatted input from a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>scanw(char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>wscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>mvscanw(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>vw_scanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG> + <STRONG>int</STRONG> <STRONG>vwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to + <STRONG>scanf</STRONG> [see <STRONG><A HREF="scanf.3.html">scanf(3)</A></STRONG>]. The effect of these routines is as + though <STRONG>wgetstr</STRONG> were called on the window, and the result- + ing line used as input for <STRONG><A HREF="sscanf.3.html">sscanf(3)</A></STRONG>. Fields which do not + map to a variable in the <EM>fmt</EM> field are lost. + + The <STRONG>vwscanw</STRONG> and <STRONG>vw_scanw</STRONG> routines are analogous to <STRONG>vscanf</STRONG>. + They perform a <STRONG>wscanw</STRONG> using a variable argument list. The + third argument is a <EM>va</EM><STRONG>_</STRONG><EM>list</EM>, a pointer to a list of argu- + ments, as defined in <STRONG><stdarg.h></STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> on failure and an integer equal to the + number of fields scanned on success. + + Applications may use the return value from the <STRONG>scanw</STRONG>, + <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG> and <STRONG>mvwscanw</STRONG> routines to determine the + number of fields which were mapped in the call. + + Functions with a "mv" prefix first perform a cursor move- + ment using <STRONG>wmove</STRONG>, and return an error if the position is + outside the window, or if the window pointer is null. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. The function <STRONG>vwscanw</STRONG> is marked TO BE WITHDRAWN, + and is to be replaced by a function <STRONG>vw_scanw</STRONG> using the + <STRONG><stdarg.h></STRONG> interface. The Single Unix Specification, Ver- + sion 2 states that <STRONG>vw_scanw</STRONG> is preferred to <STRONG>vwscanw</STRONG> since + the latter requires including <STRONG><varargs.h></STRONG>, which cannot be + used in the same file as <STRONG><stdarg.h></STRONG>. This implementation + uses <STRONG><stdarg.h></STRONG> for both, because that header is included + in <STRONG><curses.h</STRONG>>. + + Both XSI and The Single Unix Specification, Version 2 + state that these functions return ERR or OK. Since the + underlying <STRONG>scanf</STRONG> can return the number of items scanned, + and the SVr4 code was documented to use this feature, this + is probably an editing error which was introduced in XSI, + rather than being done intentionally. Portable applica- + tions should only test if the return value is ERR, since + the OK value (zero) is likely to be misleading. One pos- + sible way to get useful results would be to use a "%n" + conversion at the end of the format string to ensure that + something was processed. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>, <STRONG><A HREF="scanf.3.html">scanf(3)</A></STRONG> + + + + <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html new file mode 100644 index 000000000000..d2931e13473a --- /dev/null +++ b/doc/html/man/curs_scr_dump.3x.html @@ -0,0 +1,137 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_scr_dump.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_scr_dump 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_scr_dump 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a + <STRONG>curses</STRONG> screen from (to) a file + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG> + <STRONG>int</STRONG> <STRONG>scr_restore(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG> + <STRONG>int</STRONG> <STRONG>scr_init(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG> + <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>scr_dump</STRONG> routine dumps the current contents of the + virtual screen to the file <EM>filename</EM>. + + The <STRONG>scr_restore</STRONG> routine sets the virtual screen to the + contents of <EM>filename</EM>, which must have been written using + <STRONG>scr_dump</STRONG>. The next call to <STRONG>doupdate</STRONG> restores the screen + to the way it looked in the dump file. + + The <STRONG>scr_init</STRONG> routine reads in the contents of <EM>filename</EM> and + uses them to initialize the <STRONG>curses</STRONG> data structures about + what the terminal currently has on its screen. If the da- + ta is determined to be valid, <STRONG>curses</STRONG> bases its next update + of the screen on this information rather than clearing the + screen and starting from scratch. <STRONG>scr_init</STRONG> is used after + <STRONG>initscr</STRONG> or a <STRONG>system</STRONG> call to share the screen with another + process which has done a <STRONG>scr_dump</STRONG> after its <STRONG>endwin</STRONG> call. + The data is declared invalid if the terminfo capabilities + <STRONG>rmcup</STRONG> and <STRONG>nrrmc</STRONG> exist; also if the terminal has been writ- + ten to since the preceding <STRONG>scr_dump</STRONG> call. + + The <STRONG>scr_set</STRONG> routine is a combination of <STRONG>scr_restore</STRONG> and + <STRONG>scr_init</STRONG>. It tells the program that the information in + <EM>filename</EM> is what is currently on the screen, and also what + the program wants on the screen. This can be thought of + as a screen inheritance function. + + To read (write) a window from (to) a file, use the <STRONG>getwin</STRONG> + and <STRONG>putwin</STRONG> routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>]. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> + upon success. + + X/Open defines no error conditions. In this implementa- + tion, each will return an error if the file cannot be + opened. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG>, and <STRONG>scr_restore</STRONG> may be + macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4, describes these func- + tions (adding the const qualifiers). + + The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data + is also considered invalid "if the time-stamp of the tty + is old" but do not define "old". + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, + <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="system.3.html">system(3)</A></STRONG> + + + + <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_scroll.3x.html b/doc/html/man/curs_scroll.3x.html new file mode 100644 index 000000000000..856b9f55804b --- /dev/null +++ b/doc/html/man/curs_scroll.3x.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_scroll.3x,v 1.15 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_scroll 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_scroll 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG> <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>scroll</STRONG>, <STRONG>scrl</STRONG>, <STRONG>wscrl</STRONG> - scroll a <STRONG>curses</STRONG> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>scroll(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>scrl(int</STRONG> <STRONG>n);</STRONG> + <STRONG>int</STRONG> <STRONG>wscrl(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>scroll</STRONG> routine scrolls the window up one line. This + involves moving the lines in the window data structure. + As an optimization, if the scrolling region of the window + is the entire screen, the physical screen may be scrolled + at the same time. + + For positive <EM>n</EM>, the <STRONG>scrl</STRONG> and <STRONG>wscrl</STRONG> routines scroll the + window up <EM>n</EM> lines (line <EM>i</EM>+<EM>n</EM> becomes <EM>i</EM>); otherwise scroll + the window down <EM>n</EM> lines. This involves moving the lines + in the window character image structure. The current cur- + sor position is not changed. + + For these functions to work, scrolling must be enabled via + <STRONG>scrollok</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4 only + specifies "an integer value other than <STRONG>ERR</STRONG>") upon success- + ful completion. + + X/Open defines no error conditions. + + This implementation returns an error if the window pointer + is null, or if scrolling is not enabled in the window, + e.g., with <STRONG>scrollok</STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>scrl</STRONG> and <STRONG>scroll</STRONG> may be macros. + + The SVr4 documentation says that the optimization of phys- + ically scrolling immediately if the scroll region is the + entire screen "is" performed, not "may be" performed. + This implementation deliberately does not guarantee that + this will occur, to leave open the possibility of smarter + optimization of multiple scroll actions on the next up- + date. + + Neither the SVr4 nor the XSI documentation specify whether + the current attribute or current color-pair of blanks gen- + erated by the scroll function is zeroed. Under this im- + plementation it is. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html new file mode 100644 index 000000000000..54e4f7a04d7b --- /dev/null +++ b/doc/html/man/curs_slk.3x.html @@ -0,0 +1,235 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_slk.3x,v 1.22 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_slk 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_slk 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>slk_init</STRONG>, <STRONG>slk_set</STRONG>, <STRONG>slk_wset</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_noutrefresh</STRONG>, + <STRONG>slk_label</STRONG>, <STRONG>slk_clear</STRONG>, <STRONG>slk_restore</STRONG>, <STRONG>slk_touch</STRONG>, <STRONG>slk_attron</STRONG>, + <STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG>, <STRONG>slk_attr_on</STRONG>, <STRONG>slk_attr_set</STRONG>, + <STRONG>slk_attr_off</STRONG>, <STRONG>slk_attr</STRONG>, <STRONG>slk_color</STRONG> - <STRONG>curses</STRONG> soft label + routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>slk_init(int</STRONG> <STRONG>fmt);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_set(int</STRONG> <STRONG>labnum,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>int</STRONG> <STRONG>fmt);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_refresh(void);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_noutrefresh(void);</STRONG> + <STRONG>char</STRONG> <STRONG>*slk_label(int</STRONG> <STRONG>labnum);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_clear(void);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_restore(void);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_touch(void);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attron(const</STRONG> <STRONG>chtype</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attroff(const</STRONG> <STRONG>chtype</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attrset(const</STRONG> <STRONG>chtype</STRONG> <STRONG>attrs);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attr_on(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attr_off(const</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG> <STRONG>opts);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attr_set(const</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>color_pair,</STRONG> + <STRONG>void*</STRONG> <STRONG>opts);</STRONG> + <STRONG>attr_t</STRONG> <STRONG>slk_attr(void);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_color(short</STRONG> <STRONG>color_pair);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_wset(int</STRONG> <STRONG>labnum,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*label,</STRONG> <STRONG>int</STRONG> <STRONG>fmt);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The slk* functions manipulate the set of soft function-key + labels that exist on many terminals. For those terminals + that do not have soft labels, <STRONG>curses</STRONG> takes over the bottom + line of <STRONG>stdscr</STRONG>, reducing the size of <STRONG>stdscr</STRONG> and the vari- + able <STRONG>LINES</STRONG>. <STRONG>curses</STRONG> standardizes on eight labels of up to + eight characters each. In addition to this, the ncurses + implementation supports a mode where it simulates 12 la- + bels of up to five characters each. This is useful for + today's PC-like enduser devices. ncurses simulates this + mode by taking over up to two lines at the bottom of the + screen; it does not try to use any hardware support for + this mode. + + The <STRONG>slk_init</STRONG> routine must be called before <STRONG>initscr</STRONG> or + <STRONG>newterm</STRONG> is called. If <STRONG>initscr</STRONG> eventually uses a line from + <STRONG>stdscr</STRONG> to emulate the soft labels, then <EM>fmt</EM> determines how + the labels are arranged on the screen: + + <STRONG>0</STRONG> indicates a 3-2-3 arrangement of the labels. + + <STRONG>1</STRONG> indicates a 4-4 arrangement + + <STRONG>2</STRONG> indicates the PC-like 4-4-4 mode. + + <STRONG>3</STRONG> is again the PC-like 4-4-4 mode, but in addition + an index line is generated, helping the user to + identify the key numbers easily. + + The <STRONG>slk_set</STRONG> routine (and the <STRONG>slk_wset</STRONG> routine for the + wide-character library) has three parameters: + + <EM>labnum</EM> + is the label number, from <STRONG>1</STRONG> to <STRONG>8</STRONG> (12 for <EM>fmt</EM> + in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>); + + <EM>label</EM> + is be the string to put on the label, up to + eight (five for <EM>fmt</EM> in <STRONG>slk_init</STRONG> is <STRONG>2</STRONG> or <STRONG>3</STRONG>) + characters in length. A null string or a null + pointer sets up a blank label. + + <EM>fmt</EM> is either <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>, indicating whether the + label is to be left-justified, centered, or + right-justified, respectively, within the la- + bel. + + The <STRONG>slk_refresh</STRONG> and <STRONG>slk_noutrefresh</STRONG> routines correspond to + the <STRONG>wrefresh</STRONG> and <STRONG>wnoutrefresh</STRONG> routines. + + The <STRONG>slk_label</STRONG> routine returns the current label for label + number <EM>labnum</EM>, with leading and trailing blanks stripped. + + The <STRONG>slk_clear</STRONG> routine clears the soft labels from the + screen. + + The <STRONG>slk_restore</STRONG> routine restores the soft labels to the + screen after a <STRONG>slk_clear</STRONG> has been performed. + + The <STRONG>slk_touch</STRONG> routine forces all the soft labels to be + output the next time a <STRONG>slk_noutrefresh</STRONG> is performed. + + The <STRONG>slk_attron</STRONG>, <STRONG>slk_attrset</STRONG>, <STRONG>slk_attroff</STRONG> and <STRONG>slk_attr</STRONG> rou- + tines correspond to <STRONG>attron</STRONG>, <STRONG>attrset</STRONG>, <STRONG>attroff</STRONG> and <STRONG>attr_get</STRONG>. + They have an effect only if soft labels are simulated on + the bottom line of the screen. The default highlight for + soft keys is A_STANDOUT (as in System V curses, which does + not document this fact). + + The <STRONG>slk_color</STRONG> routine corresponds to <STRONG>color_set</STRONG>. It has an + effect only if soft labels are simulated on the bottom + line of the screen. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <STRONG>ERR</STRONG> upon failure and OK (SVr4 speci- + fies only "an integer value other than <STRONG>ERR</STRONG>") upon success- + ful completion. + + X/Open defines no error conditions. In this implementa- + tion + + <STRONG>slk_attr</STRONG> + returns the attribute used for the soft keys. + + <STRONG>slk_attroff</STRONG>, <STRONG>slk_attron</STRONG>, <STRONG>slk_clear</STRONG>, + <STRONG>slk_noutrefresh</STRONG>, <STRONG>slk_refresh</STRONG>, <STRONG>slk_touch</STRONG> + return an error if the terminal or the soft- + keys were not initialized. + + <STRONG>slk_attrset</STRONG> + returns an error if the terminal or the soft- + keys were not initialized. + + <STRONG>slk_attr_set</STRONG> + returns an error if the terminal or the soft- + keys were not initialized, or the color pair + is outside the range 0..COLOR_PAIRS-1, or opts + is not null. + + <STRONG>slk_color</STRONG> + returns an error if the terminal or the soft- + keys were not initialized, or the color pair + is outside the range 0..COLOR_PAIRS-1. + + <STRONG>slk_init</STRONG> + returns an error if the format parameter is + outside the range 0..3. + + <STRONG>slk_label</STRONG> + returns <STRONG>NULL</STRONG> on error. + + <STRONG>slk_set</STRONG> + returns an error if the terminal or the soft- + keys were not initialized, or the <EM>labnum</EM> pa- + rameter is outside the range of label counts, + or if the format parameter is outside the + range 0..2, or if memory for the labels cannot + be allocated. + + +</PRE> +<H2>NOTES</H2><PRE> + Most applications would use <STRONG>slk_noutrefresh</STRONG> because a <STRONG>wre-</STRONG> + <STRONG>fresh</STRONG> is likely to follow soon. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4, describes these func- + tions. It changes the argument type of the attribute-ma- + nipulation functions <STRONG>slk_attron</STRONG>, <STRONG>slk_attroff</STRONG>, <STRONG>slk_attrset</STRONG> + to be <STRONG>attr_t</STRONG>, and adds <STRONG>const</STRONG> qualifiers. The format codes + <STRONG>2</STRONG> and <STRONG>3</STRONG> for <STRONG>slk_init()</STRONG> and the function <STRONG>slk_attr</STRONG> are spe- + cific to ncurses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_re-</STRONG> + <STRONG><A HREF="curs_refresh.3x.html">fresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_sp_funcs.3x.html b/doc/html/man/curs_sp_funcs.3x.html new file mode 100644 index 000000000000..a11947a74abd --- /dev/null +++ b/doc/html/man/curs_sp_funcs.3x.html @@ -0,0 +1,285 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_sp_funcs.3x,v 1.5 2010/12/04 18:38:55 tom Exp @ + * *************************************************************************** + * *************************************************************************** + * *************************************************************************** +--> +<HTML> +<HEAD> +<TITLE>curs_sp_funcs 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_sp_funcs 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + new_prescr - <STRONG>curses</STRONG> screen-pointer extension + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>assume_default_colors_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>baudrate_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>beep_sp(SCREEN*);</STRONG> + <STRONG>bool</STRONG> <STRONG>can_change_color_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>cbreak_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>color_content_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*);</STRONG> + <STRONG>int</STRONG> <STRONG>curs_set_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>define_key_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>def_prog_mode_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>def_shell_mode_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>delay_output_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>doupdate_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>echo_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>endwin_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>erasechar_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>filter_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>flash_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>flushinp_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>get_escdelay_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>getmouse_sp(SCREEN*,</STRONG> <STRONG>MEVENT*);</STRONG> + <STRONG>WINDOW*</STRONG> <STRONG>getwin_sp(SCREEN*,</STRONG> <STRONG>FILE*);</STRONG> + <STRONG>int</STRONG> <STRONG>halfdelay_sp(SCREEN*);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_colors_sp(SCREEN*);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_ic_sp(SCREEN*);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_il_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>has_key_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_mouse_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>init_color_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short);</STRONG> + <STRONG>int</STRONG> <STRONG>init_pair_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short,</STRONG> <STRONG>short);</STRONG> + <STRONG>int</STRONG> <STRONG>intrflush_sp(SCREEN*,</STRONG> <STRONG>WINDOW*,</STRONG> <STRONG>bool);</STRONG> + <STRONG>bool</STRONG> <STRONG>isendwin_sp(SCREEN*);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_term_resized_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>char*</STRONG> <STRONG>keybound_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>key_defined_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keyname_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>keyok_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>bool);</STRONG> + <STRONG>char</STRONG> <STRONG>killchar_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>mcprint_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>mouseinterval_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>mmask_t</STRONG> <STRONG>mousemask_sp(SCREEN*,</STRONG> <STRONG>mmask_t,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>mvcur_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>napms_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>WINDOW*</STRONG> <STRONG>newpad_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>SCREEN*</STRONG> <STRONG>new_prescr(void);</STRONG> + <STRONG>SCREEN*</STRONG> <STRONG>newterm_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>FILE</STRONG> <STRONG>*,</STRONG> <STRONG>FILE</STRONG> <STRONG>*);</STRONG> + <STRONG>WINDOW*</STRONG> <STRONG>newwin_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>nl_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>nocbreak_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>noecho_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>nofilter_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>nonl_sp(SCREEN*);</STRONG> + <STRONG>void</STRONG> <STRONG>noqiflush_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>noraw_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>pair_content_sp(SCREEN*,</STRONG> <STRONG>short,</STRONG> <STRONG>short*,</STRONG> <STRONG>short*);</STRONG> + <STRONG>void</STRONG> <STRONG>qiflush_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>raw_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>reset_prog_mode_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>reset_shell_mode_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>resetty_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>resize_term_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>resizeterm_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>restartterm_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>ripoffline_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>int</STRONG> <STRONG>(*)(WINDOW*,</STRONG> <STRONG>int));</STRONG> + <STRONG>int</STRONG> <STRONG>savetty_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>scr_init_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>scr_restore_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>scr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>TERMINAL*</STRONG> <STRONG>set_curterm_sp(SCREEN*,</STRONG> <STRONG>TERMINAL*);</STRONG> + <STRONG>int</STRONG> <STRONG>set_escdelay_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>set_tabsize_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attroff_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attron_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attr_set_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void*);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attrset_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>chtype);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_attr_sp((SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_clear_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_color_sp(SCREEN*,</STRONG> <STRONG>short);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_init_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_label_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_noutrefresh_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_refresh_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_restore_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_set_sp(SCREEN*,</STRONG> <STRONG>int,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>slk_touch_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>start_color_sp(SCREEN*);</STRONG> + <STRONG>attr_t</STRONG> <STRONG>term_attrs_sp(SCREEN*);</STRONG> + <STRONG>chtype</STRONG> <STRONG>termattrs_sp(SCREEN*);</STRONG> + <STRONG>char*</STRONG> <STRONG>termname_sp(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>typeahead_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char*</STRONG> <STRONG>unctrl_sp(SCREEN*,</STRONG> <STRONG>chtype);</STRONG> + <STRONG>int</STRONG> <STRONG>ungetch_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>ungetmouse_sp(SCREEN*,MEVENT</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>unget_wch_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>wchar_t);</STRONG> + <STRONG>int</STRONG> <STRONG>use_default_colors_sp(SCREEN*);</STRONG> + <STRONG>void</STRONG> <STRONG>use_env_sp(SCREEN*,</STRONG> <STRONG>bool);</STRONG> + <STRONG>int</STRONG> <STRONG>use_legacy_coding_sp(SCREEN*,</STRONG> <STRONG>int);</STRONG> + <STRONG>int</STRONG> <STRONG>vid_attr_sp(SCREEN*,</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>vidattr_sp(SCREEN*,</STRONG> <STRONG>chtype);</STRONG> + <STRONG>int</STRONG> <STRONG>vid_puts_sp(SCREEN*,</STRONG> <STRONG>attr_t,</STRONG> <STRONG>short,</STRONG> <STRONG>void</STRONG> <STRONG>*,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG> + <STRONG>int</STRONG> <STRONG>vidputs_sp(SCREEN*,</STRONG> <STRONG>chtype,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG> + <STRONG>wchar_t*</STRONG> <STRONG>wunctrl_sp(SCREEN*,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*);</STRONG> + + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + + <STRONG>int</STRONG> <STRONG>new_form_sp(SCREEN*,</STRONG> <STRONG>FIELD</STRONG> <STRONG>**);</STRONG> + + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + + <STRONG>int</STRONG> <STRONG>new_menu_sp(SCREEN*,</STRONG> <STRONG>ITEM</STRONG> <STRONG>**);</STRONG> + + <STRONG>#include</STRONG> <STRONG><panel.h></STRONG> + + <STRONG>int</STRONG> <STRONG>ceiling_panel(SCREEN*);</STRONG> + <STRONG>PANEL*</STRONG> <STRONG>ground_panel(SCREEN*);</STRONG> + <STRONG>int</STRONG> <STRONG>update_panels_sp(SCREEN*);</STRONG> + + <STRONG>#include</STRONG> <STRONG><term.h></STRONG> + + <STRONG>int</STRONG> <STRONG>del_curterm_sp(SCREEN*,</STRONG> <STRONG>TERMINAL</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>putp_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>tgetflag_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>tgetent_sp(SCREEN*,</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>tgetnum_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>char*</STRONG> <STRONG>tgetstr_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>char</STRONG> <STRONG>**);</STRONG> + <STRONG>int</STRONG> <STRONG>tigetflag_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>tigetnum_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>char*</STRONG> <STRONG>tigetstr_sp(SCREEN*,</STRONG> <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>tputs_sp(SCREEN*,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*,</STRONG> <STRONG>int,</STRONG> <STRONG>NCURSES_SP_OUTC);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This implementation can be configured to provide a set of + functions which improve the ability to manage multiple + screens. This feature can be added to any of the configu- + rations supported by ncurses; it adds new entrypoints + without changing the meaning of any of the existing ones. + + + <STRONG>IMPROVED</STRONG> <STRONG>FUNCTIONS</STRONG> + Most of the functions are new versions of existing func- + tions. A parameter is added at the front of the parameter + list. It is a SCREEN pointer. + + The existing functions all use the current screen, which + is a static variable. The extended functions use the + specified screen, thereby reducing the number of variables + which must be modified to update multiple screens. + + <STRONG>NEW</STRONG> <STRONG>FUNCTIONS</STRONG> + Here are the new functions: + + ceiling_panel + this returns a pointer to the topmost panel in the + given screen. + + ground_panel + this returns a pointer to the lowest panel in the + given screen. + + new_prescr + when creating a new screen, the library uses static + variables which have been preset, e.g., by + <STRONG><A HREF="use_env.3x.html">use_env(3x)</A></STRONG>, <STRONG><A HREF="filter.3x.html">filter(3x)</A></STRONG>, etc. With the screen-point- + er extension, there are situations where it must cre- + ate a current screen before the unextended library + does. The <STRONG>new_prescr</STRONG> function is used internally to + handle these cases. It is also provided as an entry- + point to allow applications to customize the library + initialization. + + +</PRE> +<H2>NOTES</H2><PRE> + This extension introduces some new names: + + NCURSES_SP_FUNCS + This is set to the library patch-level number. In + the unextended library, this is zero (0), to make it + useful for checking if the extension is provided. + + NCURSES_SP_NAME + The new functions are named using the macro <EM>NCURS-</EM> + <EM>ES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>NAME</EM>, which hides the actual implementation. + Currently this adds a "_sp" suffix to the name of the + unextended function. This manual page indexes the + extensions showing the full name. However the proper + usage of these functions uses the macro, to provide + for the possibility of changing the naming convention + for specific library configurations. + + NCURSES_SP_OUTC + This is a new function-pointer type to use in the + screen-pointer functions where an <EM>NCURSES</EM><STRONG>_</STRONG><EM>OUTC</EM> is + used in the unextended library. + + NCURSES_OUTC + This is a function-pointer type used for the cases + where a function passes characters to the output + stream, e.g., <STRONG><A HREF="vidputs.3x.html">vidputs(3x)</A></STRONG>. + + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on ncurses ex- + tensions be conditioned using <EM>NCURSES</EM><STRONG>_</STRONG><EM>SP</EM><STRONG>_</STRONG><EM>FUNCS</EM>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html new file mode 100644 index 000000000000..960cc2a4a7c1 --- /dev/null +++ b/doc/html/man/curs_termattrs.3x.html @@ -0,0 +1,161 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_termattrs.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_termattrs 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_termattrs 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>, + <STRONG>killwchar</STRONG>, <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> - + <STRONG>curses</STRONG> environment query routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG> + <STRONG>char</STRONG> <STRONG>erasechar(void);</STRONG> + <STRONG>int</STRONG> <STRONG>erasewchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_ic(void);</STRONG> + <STRONG>bool</STRONG> <STRONG>has_il(void);</STRONG> + <STRONG>char</STRONG> <STRONG>killchar(void);</STRONG> + <STRONG>int</STRONG> <STRONG>killwchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG> + <STRONG>char</STRONG> <STRONG>*longname(void);</STRONG> + <STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG> + <STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG> + <STRONG>char</STRONG> <STRONG>*termname(void);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>baudrate</STRONG> routine returns the output speed of the ter- + minal. The number returned is in bits per second, for + example <STRONG>9600</STRONG>, and is an integer. + + The <STRONG>erasechar</STRONG> routine returns the user's current erase + character. + + The <STRONG>erasewchar</STRONG> routine stores the current erase character + in the location referenced by <EM>ch</EM>. If no erase character + has been defined, the routine fails and the location ref- + erenced by <EM>ch</EM> is not changed. + + The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and + delete- character capabilities. + + The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and + delete-line capabilities, or can simulate them using + scrolling regions. This might be used to determine if it + would be appropriate to turn on physical scrolling using + <STRONG>scrollok</STRONG>. + + The <STRONG>killchar</STRONG> routine returns the user's current line kill + character. + + The <STRONG>killwchar</STRONG> routine stores the current line-kill charac- + ter in the location referenced by <EM>ch</EM>. If no line-kill + character has been defined, the routine fails and the + location referenced by <EM>ch</EM> is not changed. + + The <STRONG>longname</STRONG> routine returns a pointer to a static area + containing a verbose description of the current terminal. + The maximum length of a verbose description is 128 charac- + ters. It is defined only after the call to <STRONG>initscr</STRONG> or + <STRONG>newterm</STRONG>. The area is overwritten by each call to <STRONG>newterm</STRONG> + and is not restored by <STRONG>set_term</STRONG>, so the value should be + saved between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be + used with multiple terminals. + + If a given terminal does not support a video attribute + that an application program is trying to use, <STRONG>curses</STRONG> may + substitute a different video attribute for it. The + <STRONG>termattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a logical <STRONG>OR</STRONG> of + all video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG> + and <EM>WA</EM><STRONG>_</STRONG> constants respectively. This information is use- + ful when a <STRONG>curses</STRONG> program needs complete control over the + appearance of the screen. + + The <STRONG>termname</STRONG> routine returns the terminal name used by + <STRONG>setupterm</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error. + + Routines that return an integer return <STRONG>ERR</STRONG> upon failure + and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <STRONG>termattrs</STRONG> may be a macro. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. It changes the return type of <STRONG>termattrs</STRONG> to the new + type <STRONG>attr_t</STRONG>. Most versions of curses truncate the result + returned by <STRONG>termname</STRONG> to 14 characters. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html new file mode 100644 index 000000000000..f62fc0ca997f --- /dev/null +++ b/doc/html/man/curs_termcap.3x.html @@ -0,0 +1,191 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_termcap.3x,v 1.26 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_termcap 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_termcap 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>PC</STRONG>, <STRONG>UP</STRONG>, <STRONG>BC</STRONG>, <STRONG>ospeed</STRONG>, <STRONG>tgetent</STRONG>, <STRONG>tgetflag</STRONG>, <STRONG>tgetnum</STRONG>, <STRONG>tgetstr</STRONG>, + <STRONG>tgoto</STRONG>, <STRONG>tputs</STRONG> - direct <STRONG>curses</STRONG> interface to the terminfo + capability database + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>#include</STRONG> <STRONG><term.h></STRONG> + + <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>PC;</STRONG> + <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>UP;</STRONG> + <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>BC;</STRONG> + <STRONG>extern</STRONG> <STRONG>short</STRONG> <STRONG>ospeed;</STRONG> + + <STRONG>int</STRONG> <STRONG>tgetent(char</STRONG> <STRONG>*bp,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*name);</STRONG> + <STRONG>int</STRONG> <STRONG>tgetflag(char</STRONG> <STRONG>*id);</STRONG> + <STRONG>int</STRONG> <STRONG>tgetnum(char</STRONG> <STRONG>*id);</STRONG> + <STRONG>char</STRONG> <STRONG>*tgetstr(char</STRONG> <STRONG>*id,</STRONG> <STRONG>char</STRONG> <STRONG>**area);</STRONG> + <STRONG>char</STRONG> <STRONG>*tgoto(const</STRONG> <STRONG>char</STRONG> <STRONG>*cap,</STRONG> <STRONG>int</STRONG> <STRONG>col,</STRONG> <STRONG>int</STRONG> <STRONG>row);</STRONG> + <STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>affcnt,</STRONG> <STRONG>int</STRONG> <STRONG>(*putc)(int));</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines are included as a conversion aid for pro- + grams that use the <EM>termcap</EM> library. Their parameters are + the same and the routines are emulated using the <EM>terminfo</EM> + database. Thus, they can only be used to query the capa- + bilities of entries for which a terminfo entry has been + compiled. + + The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns + 1 on success, 0 if there is no such entry, and -1 if the + terminfo database could not be found. The emulation ig- + nores the buffer pointer <EM>bp</EM>. + + The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze- + ro if it is not available. + + The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1 + if it is not available. + + The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or + zero if it is not available. Use <STRONG>tputs</STRONG> to output the re- + turned string. The return value will also be copied to + the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will be + updated to point past the null ending this value. + + Only the first two characters of the <STRONG>id</STRONG> parameter of <STRONG>tget-</STRONG> + <STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups. + + The <STRONG>tgoto</STRONG> routine instantiates the parameters into the + given capability. The output from this routine is to be + passed to <STRONG>tputs</STRONG>. + + The <STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + manual page. It can retrieve capabilities by either term- + cap or terminfo name. + + The variables <STRONG>PC</STRONG>, <STRONG>UP</STRONG> and <STRONG>BC</STRONG> are set by <STRONG>tgetent</STRONG> to the ter- + minfo entry's data for <STRONG>pad_char</STRONG>, <STRONG>cursor_up</STRONG> and + <STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by + ncurses. <STRONG>PC</STRONG> is used in the <STRONG>tdelay_output</STRONG> function. <STRONG>BC</STRONG> is + used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set + by ncurses in a system-specific coding to reflect the ter- + minal speed. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except where explicitly noted, routines that return an in- + teger return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only specifies + "an integer value other than <STRONG>ERR</STRONG>") upon successful comple- + tion. + + Routines that return pointers return <STRONG>NULL</STRONG> on error. + + +</PRE> +<H2>BUGS</H2><PRE> + If you call <STRONG>tgetstr</STRONG> to fetch <STRONG>ca</STRONG> or any other parameterized + string, be aware that it will be returned in terminfo no- + tation, not the older and not-quite-compatible termcap no- + tation. This will not cause problems if all you do with + it is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo- + style strings as terminfo. (The <STRONG>tgoto</STRONG> function, if con- + figured to support termcap, will check if the string is + indeed terminfo-style by looking for "%p" parameters or + "$<..>" delays, and invoke a termcap-style parser if the + string does not appear to be terminfo). + + Because terminfo conventions for representing padding in + string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG> + will put out a literal "50" rather than busy-waiting for + 50 milliseconds. Cope with it. + + Note that termcap has nothing analogous to terminfo's <STRONG>sgr</STRONG> + string. One consequence of this is that termcap applica- + tions assume me (terminfo <STRONG>sgr0</STRONG>) does not reset the alter- + nate character set. This implementation checks for, and + modifies the data shown to the termcap interface to accom- + modate termcap's limitation in this respect. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. However, they are marked TO BE WITHDRAWN and may + be removed in future versions. + + Neither the XSI Curses standard nor the SVr4 man pages + documented the return values of <STRONG>tgetent</STRONG> correctly, though + all three were in fact returned ever since SVr1. In par- + ticular, an omission in the XSI Curses documentation has + been misinterpreted to mean that <STRONG>tgetent</STRONG> returns <STRONG>OK</STRONG> or + <STRONG>ERR</STRONG>. Because the purpose of these functions is to provide + compatibility with the <EM>termcap</EM> library, that is a defect + in XCurses, Issue 4, Version 2 rather than in ncurses. + + External variables are provided for support of certain + termcap applications. However, termcap applications' use + of those variables is poorly documented, e.g., not distin- + guishing between input and output. In particular, some + applications are reported to declare and/or modify <STRONG>ospeed</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="putc.3.html">putc(3)</A></STRONG>. + + + + <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html new file mode 100644 index 000000000000..9a640e9f8bc4 --- /dev/null +++ b/doc/html/man/curs_terminfo.3x.html @@ -0,0 +1,363 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1999-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_terminfo.3x,v 1.35 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_terminfo 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_terminfo 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>del_curterm</STRONG>, <STRONG>mvcur</STRONG>, <STRONG>putp</STRONG>, <STRONG>restartterm</STRONG>, <STRONG>set_curterm</STRONG>, + <STRONG>setterm</STRONG>, <STRONG>setupterm</STRONG>, <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG>, <STRONG>tiparm</STRONG>, + <STRONG>tparm</STRONG>, <STRONG>tputs</STRONG>, <STRONG>vid_attr</STRONG>, <STRONG>vid_puts</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>vidputs</STRONG> - + <STRONG>curses</STRONG> interfaces to terminfo database + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>#include</STRONG> <STRONG><term.h></STRONG> + + <STRONG>int</STRONG> <STRONG>setupterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fildes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>setterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>);</STRONG> + <STRONG>TERMINAL</STRONG> <STRONG>*set_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>nterm</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>del_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>oterm</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>restartterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fildes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG> + <STRONG>char</STRONG> <STRONG>*tparm(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> + <STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>affcnt</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG> + <STRONG>int</STRONG> <STRONG>putp(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>vidputs(chtype</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG> + <STRONG>int</STRONG> <STRONG>vidattr(chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>vid_puts(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(char));</STRONG> + <STRONG>int</STRONG> <STRONG>vid_attr(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>mvcur(int</STRONG> <EM>oldrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>oldcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>newrow</EM>, int <EM>newcol</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>tigetflag(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>tigetnum(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG> + <STRONG>char</STRONG> <STRONG>*tigetstr(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG> + <STRONG>char</STRONG> <STRONG>*tiparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These low-level routines must be called by programs that + have to deal directly with the <STRONG>terminfo</STRONG> database to handle + certain terminal capabilities, such as programming func- + tion keys. For all other functionality, <STRONG>curses</STRONG> routines + are more suitable and their use is recommended. + + Initially, <STRONG>setupterm</STRONG> should be called. Note that <STRONG>se-</STRONG> + <STRONG>tupterm</STRONG> is automatically called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>. + This defines the set of terminal-dependent variables + [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and + <STRONG>columns</STRONG> are initialized by <STRONG>setupterm</STRONG> as follows: + + If <STRONG>use_env(FALSE)</STRONG> has been called, values for <STRONG>lines</STRONG> + and <STRONG>columns</STRONG> specified in <STRONG>terminfo</STRONG> are used. + + Otherwise, if the environment variables <STRONG>LINES</STRONG> and + <STRONG>COLUMNS</STRONG> exist, their values are used. If these en- + vironment variables do not exist and the program is + running in a window, the current window size is + used. Otherwise, if the environment variables do + not exist, the values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> speci- + fied in the <STRONG>terminfo</STRONG> database are used. + + The header files <STRONG>curses.h</STRONG> and <STRONG>term.h</STRONG> should be included + (in this order) to get the definitions for these strings, + numbers, and flags. Parameterized strings should be + passed through <STRONG>tparm</STRONG> to instantiate them. All <STRONG>terminfo</STRONG> + strings [including the output of <STRONG>tparm</STRONG>] should be printed + with <STRONG>tputs</STRONG> or <STRONG>putp</STRONG>. Call the <STRONG>reset_shell_mode</STRONG> to restore + the tty modes before exiting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>]. Pro- + grams which use cursor addressing should output <STRONG>en-</STRONG> + <STRONG>ter_ca_mode</STRONG> upon startup and should output <STRONG>exit_ca_mode</STRONG> + before exiting. Programs desiring shell escapes should + call + + <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the shell + is called and should output <STRONG>enter_ca_mode</STRONG> and call <STRONG>re-</STRONG> + <STRONG>set_prog_mode</STRONG> after returning from the shell. + + The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, ini- + tializing the <STRONG>terminfo</STRONG> structures, but does not set up the + output virtualization structures used by <STRONG>curses</STRONG>. The ter- + minal type is the character string <EM>term</EM>; if <EM>term</EM> is null, + the environment variable <STRONG>TERM</STRONG> is used. All output is to + file descriptor <STRONG>fildes</STRONG> which is initialized for output. + If <EM>errret</EM> is not null, then <STRONG>setupterm</STRONG> returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG> + and stores a status value in the integer pointed to by <EM>er-</EM> + <EM>rret</EM>. A return value of <STRONG>OK</STRONG> combined with status of <STRONG>1</STRONG> in + <EM>errret</EM> is normal. If <STRONG>ERR</STRONG> is returned, examine <EM>errret</EM>: + + <STRONG>1</STRONG> means that the terminal is hardcopy, cannot be + used for curses applications. + + <STRONG>0</STRONG> means that the terminal could not be found, or + that it is a generic type, having too little + information for curses applications to run. + + <STRONG>-1</STRONG> means that the <STRONG>terminfo</STRONG> database could not be + found. + + If <EM>errret</EM> is null, <STRONG>setupterm</STRONG> prints an error message upon + finding an error and exits. Thus, the simplest call is: + + <STRONG>setupterm((char</STRONG> <STRONG>*)0,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0);</STRONG>, + + which uses all the defaults and sends the output to <STRONG>std-</STRONG> + <STRONG>out</STRONG>. + + The <STRONG>setterm</STRONG> routine is being replaced by <STRONG>setupterm</STRONG>. The + call: + + <STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG> + + provides the same functionality as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>. The + <STRONG>setterm</STRONG> routine is included here for BSD compatibility, + and is not recommended for new programs. + + The <STRONG>set_curterm</STRONG> routine sets the variable <STRONG>cur_term</STRONG> to + <EM>nterm</EM>, and makes all of the <STRONG>terminfo</STRONG> boolean, numeric, and + string variables use the values from <EM>nterm</EM>. It returns + the old value of <STRONG>cur_term</STRONG>. + + The <STRONG>del_curterm</STRONG> routine frees the space pointed to by + <EM>oterm</EM> and makes it available for further use. If <EM>oterm</EM> is + the same as <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG> + boolean, numeric, and string variables thereafter may re- + fer to invalid memory locations until another <STRONG>setupterm</STRONG> + has been called. + + The <STRONG>restartterm</STRONG> routine is similar to <STRONG>setupterm</STRONG> and + <STRONG>initscr</STRONG>, except that it is called after restoring memory + to a previous state (for example, when reloading a game + saved as a core image dump). It assumes that the windows + and the input and output options are the same as when mem- + ory was saved, but the terminal type and baud rate may be + different. Accordingly, it saves various tty state bits, + calls <STRONG>setupterm</STRONG>, and then restores the bits. + + The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame- + ters <EM>pi</EM>. A pointer is returned to the result of <EM>str</EM> with + the parameters applied. + + <STRONG>tiparm</STRONG> is a newer form of <STRONG>tparm</STRONG> which uses <EM><stdarg.h></EM> + rather than a fixed-parameter list. Its numeric parame- + ters are integers (int) rather than longs. + + The <STRONG>tputs</STRONG> routine applies padding information to the + string <EM>str</EM> and outputs it. The <EM>str</EM> must be a terminfo + string variable or the return value from <STRONG>tparm</STRONG>, <STRONG>tgetstr</STRONG>, + or <STRONG>tgoto</STRONG>. <EM>affcnt</EM> is the number of lines affected, or 1 if + not applicable. <EM>putc</EM> is a <STRONG>putchar</STRONG>-like routine to which + the characters are passed, one at a time. + + The <STRONG>putp</STRONG> routine calls <STRONG>tputs(</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>putchar)</STRONG>. Note that + the output of <STRONG>putp</STRONG> always goes to <STRONG>stdout</STRONG>, not to the + <EM>fildes</EM> specified in <STRONG>setupterm</STRONG>. + + The <STRONG>vidputs</STRONG> routine displays the string on the terminal in + the video attribute mode <EM>attrs</EM>, which is any combination + of the attributes listed in <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. The characters + are passed to the <STRONG>putchar</STRONG>-like routine <EM>putc</EM>. + + The <STRONG>vidattr</STRONG> routine is like the <STRONG>vidputs</STRONG> routine, except + that it outputs through <STRONG>putchar</STRONG>. + + The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines correspond to vidattr + and vidputs, respectively. They use a set of arguments + for representing the video attributes plus color, i.e., + one of type attr_t for the attributes and one of short for + the color_pair number. The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines + are designed to use the attribute constants with the <EM>WA</EM><STRONG>_</STRONG> + prefix. The opts argument is reserved for future use. + Currently, applications must provide a null pointer for + that argument. + + The <STRONG>mvcur</STRONG> routine provides low-level cursor motion. It + takes effect immediately (rather than at the next re- + fresh). + + The <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG> and <STRONG>tigetstr</STRONG> routines return the + value of the capability corresponding to the <STRONG>terminfo</STRONG> <EM>cap-</EM> + <EM>name</EM> passed to them, such as <STRONG>xenl</STRONG>. + + The <STRONG>tigetflag</STRONG> routine returns the value <STRONG>-1</STRONG> if <EM>capname</EM> is + not a boolean capability, or <STRONG>0</STRONG> if it is canceled or absent + from the terminal description. + + The <STRONG>tigetnum</STRONG> routine returns the value <STRONG>-2</STRONG> if <EM>capname</EM> is + not a numeric capability, or <STRONG>-1</STRONG> if it is canceled or ab- + sent from the terminal description. + + The <STRONG>tigetstr</STRONG> routine returns the value <STRONG>(char</STRONG> <STRONG>*)-1</STRONG> if <EM>cap-</EM> + <EM>name</EM> is not a string capability, or <STRONG>0</STRONG> if it is canceled or + absent from the terminal description. + + The <EM>capname</EM> for each capability is given in the table col- + umn entitled <EM>capname</EM> code in the capabilities section of + <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + <STRONG>char</STRONG> <STRONG>*boolnames[]</STRONG>, <STRONG>*boolcodes[]</STRONG>, <STRONG>*boolfnames[]</STRONG> + + <STRONG>char</STRONG> <STRONG>*numnames[]</STRONG>, <STRONG>*numcodes[]</STRONG>, <STRONG>*numfnames[]</STRONG> + + <STRONG>char</STRONG> <STRONG>*strnames[]</STRONG>, <STRONG>*strcodes[]</STRONG>, <STRONG>*strfnames[]</STRONG> + + These null-terminated arrays contain the <EM>capnames</EM>, the + <STRONG>termcap</STRONG> codes, and the full C names, for each of the <STRONG>ter-</STRONG> + <STRONG>minfo</STRONG> variables. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <STRONG>ERR</STRONG> upon failure + and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than + <STRONG>ERR</STRONG>") upon successful completion, unless otherwise noted + in the preceding routine descriptions. + + Routines that return pointers always return <STRONG>NULL</STRONG> on error. + + X/Open defines no error conditions. In this implementa- + tion + + <STRONG>del_curterm</STRONG> + returns an error if its terminal parameter is + null. + + <STRONG>putp</STRONG> calls <STRONG>tputs</STRONG>, returning the same error-codes. + + <STRONG>restartterm</STRONG> + returns an error if the associated call to <STRONG>se-</STRONG> + <STRONG>tupterm</STRONG> returns an error. + + <STRONG>setupterm</STRONG> + returns an error if it cannot allocate enough + memory, or create the initial windows (stdscr, + curscr, newscr). Other error conditions are + documented above. + + <STRONG>tputs</STRONG> + returns an error if the string parameter is + null. It does not detect I/O errors: X/Open + states that <STRONG>tputs</STRONG> ignores the return value of + the output function <EM>putc</EM>. + + +</PRE> +<H2>NOTES</H2><PRE> + The <STRONG>setupterm</STRONG> routine should be used in place of <STRONG>setterm</STRONG>. + It may be useful when you want to test for terminal capa- + bilities without committing to the allocation of storage + involved in <STRONG>initscr</STRONG>. + + Note that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The function <STRONG>setterm</STRONG> is not described by X/Open and must + be considered non-portable. All other functions are as + described by X/Open. + + <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>. + This is not part of X/Open Curses, but is assumed by some + applications. + + In System V Release 4, <STRONG>set_curterm</STRONG> has an <STRONG>int</STRONG> return type + and returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>. We have chosen to implement the + X/Open Curses semantics. + + In System V Release 4, the third argument of <STRONG>tputs</STRONG> has the + type <STRONG>int</STRONG> <STRONG>(*putc)(char)</STRONG>. + + At least one implementation of X/Open Curses (Solaris) re- + turns a value other than OK/ERR from <STRONG>tputs</STRONG>. That returns + the length of the string, and does no error-checking. + + X/Open Curses prototypes <STRONG>tparm</STRONG> with a fixed number of pa- + rameters, rather than a variable argument list. This im- + plementation uses a variable argument list, but can be + configured to use the fixed-parameter list. Portable ap- + plications should provide 9 parameters after the format; + zeroes are fine for this purpose. + + In response to comments by Thomas E. Dickey, X/Open Curses + Issue 7 proposed the <STRONG>tiparam</STRONG> function in mid-2009. + + X/Open notes that after calling <STRONG>mvcur</STRONG>, the curses state + may not match the actual terminal state, and that an ap- + plication should touch and refresh the window before re- + suming normal curses calls. Both ncurses and System V Re- + lease 4 curses implement <STRONG>mvcur</STRONG> using the SCREEN data allo- + cated in either <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>. So though it is docu- + mented as a terminfo function, <STRONG>mvcur</STRONG> is really a curses + function which is not well specified. + + X/Open states that the old location must be given for + <STRONG>mvcur</STRONG>. This implementation allows the caller to use -1's + for the old ordinates. In that case, the old location is + unknown. + + Extended terminal capability names, e.g., as defined by + <STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not stored in the arrays described in this + section. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG>curs_term-</STRONG> + <STRONG><A HREF="curs_termcap.3x.html">cap(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="putc.3.html">putc(3)</A></STRONG>, + <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + + + + <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_threads.3x.html b/doc/html/man/curs_threads.3x.html new file mode 100644 index 000000000000..394544a3b76f --- /dev/null +++ b/doc/html/man/curs_threads.3x.html @@ -0,0 +1,634 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_threads.3x,v 1.18 2010/12/04 18:38:55 tom Exp @ + * *************************************************************************** + * *************************************************************************** +--> +<HTML> +<HEAD> +<TITLE>curs_threads 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_threads 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>use_screen</STRONG>, <STRONG>use_window</STRONG> - <STRONG>curses</STRONG> thread support + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>typedef</STRONG> <STRONG>int</STRONG> <STRONG>(*NCURSES_WINDOW_CB)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG> + <STRONG>typedef</STRONG> <STRONG>int</STRONG> <STRONG>(*NCURSES_SCREEN_CB)(SCREEN</STRONG> <STRONG>*,</STRONG> <STRONG>void</STRONG> <STRONG>*);</STRONG> + <STRONG>int</STRONG> <STRONG>get_escdelay(void);</STRONG> + <STRONG>int</STRONG> <STRONG>set_escdelay(int</STRONG> <STRONG>size);</STRONG> + <STRONG>int</STRONG> <STRONG>set_tabsize(int</STRONG> <STRONG>size);</STRONG> + <STRONG>int</STRONG> <STRONG>use_screen(SCREEN</STRONG> <STRONG>*scr,</STRONG> <STRONG>NCURSES_WINDOW_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG> + <STRONG>*data);</STRONG> + <STRONG>int</STRONG> <STRONG>use_window(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>NCURSES_SCREEN_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG> + <STRONG>*data);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This implementation can be configured to provide rudimen- + tary support for multi-threaded applications. This makes + a different set of libraries, e.g., <EM>libncursest</EM> since the + binary interfaces are different. + + Rather than modify the interfaces to pass a thread speci- + fier to each function, it adds a few functions which can + be used in any configuration which hide the mutex's needed + to prevent concurrent use of the global variables when + configured for threading. + + In addition to forcing access to members of the <STRONG>WINDOW</STRONG> + structure to be via functions (see <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>), it + makes functions of the common global variables, e.g., COL- + ORS, COLOR_PAIRS, COLS, ESCDELAY, LINES, TABSIZE curscr, + newscr and ttytype. Those variables are maintained as + read-only values, stored in the <STRONG>SCREEN</STRONG> structure. + + Even this is not enough to make a thread-safe application + using curses. A multi-threaded application would be ex- + pected to have threads updating separate windows (within + the same device), or updating on separate screens (on dif- + ferent devices). Also, a few of the global variables are + considered writable by some applications. The functions + described here address these special situations. + + The ESCDELAY and TABSIZE global variables are modified by + some applications. To modify them in any configuration, + use the <STRONG>set_escdelay</STRONG> or <STRONG>set_tabsize</STRONG> functions. Other + global variables are not modifiable. + + The <STRONG>get_escdelay</STRONG> function returns the value for ESCDELAY. + + The <STRONG>use_window</STRONG> and <STRONG>use_screen</STRONG> functions provide coarse + granularity mutexes for their respective <STRONG>WINDOW</STRONG> and <STRONG>SCREEN</STRONG> + parameters, and call a user-supplied function, passing it + a <EM>data</EM> parameter, and returning the value from the user- + supplied function to the application. + + <STRONG>USAGE</STRONG> + All of the ncurses library functions assume that the lo- + cale is not altered during operation. In addition, they + use data which is maintained within a hierarchy of scopes. + + <STRONG>o</STRONG> global data, e.g., used in the low-level terminfo + or termcap interfaces. + + <STRONG>o</STRONG> terminal data, e.g., associated with a call to + <EM>set</EM><STRONG>_</STRONG><EM>curterm</EM>. The terminal data are initialized + when screens are created. + + <STRONG>o</STRONG> screen data, e.g., associated with a call to + <EM>newterm</EM> or <EM>initscr</EM>. + + <STRONG>o</STRONG> window data, e.g., associated with a call to <EM>newwin</EM> + or <EM>subwin</EM>. Windows are associated with screens. + Pads are not necessarily associated with a particu- + lar screen. + + Most curses applications operate on one or more + windows within a single screen. + + <STRONG>o</STRONG> reentrant, i.e., it uses only the data passed as + parameters. + + This table lists the scope of data used for each symbol in + the ncurses library when it is configured to support + threading: + + Symbol Scope + ------------------------------------------------------------- + BC global + COLORS screen (readonly) + COLOR_PAIR reentrant + COLOR_PAIRS screen (readonly) + COLS screen (readonly) + ESCDELAY screen (readonly, see <EM>set</EM><STRONG>_</STRONG><EM>escdelay</EM>) + LINES screen (readonly) + PAIR_NUMBER reentrant + PC global + SP global + TABSIZE screen (readonly) + UP global + acs_map screen (readonly) + add_wch window (stdscr) + add_wchnstr window (stdscr) + add_wchstr window (stdscr) + addch window (stdscr) + addchnstr window (stdscr) + addchstr window (stdscr) + addnstr window (stdscr) + addnwstr window (stdscr) + addstr window (stdscr) + addwstr window (stdscr) + assume_default_colors screen + attr_get window (stdscr) + attr_off window (stdscr) + attr_on window (stdscr) + attr_set window (stdscr) + attroff window (stdscr) + attron window (stdscr) + attrset window (stdscr) + baudrate screen + beep screen + bkgd window (stdscr) + bkgdset window (stdscr) + bkgrnd window (stdscr) + bkgrndset window (stdscr) + boolcodes global (readonly) + boolfnames global (readonly) + boolnames global (readonly) + border window (stdscr) + + border_set window (stdscr) + box window (stdscr) + box_set window (stdscr) + can_change_color terminal + cbreak screen + chgat window (stdscr) + clear window (stdscr) + clearok window + clrtobot window (stdscr) + clrtoeol window (stdscr) + color_content screen + color_set window (stdscr) + copywin window locks(source, target) + cur_term terminal + curs_set screen + curscr screen (readonly) + curses_version global (readonly) + def_prog_mode terminal + def_shell_mode terminal + define_key screen + del_curterm screen + delay_output screen + delch window (stdscr) + deleteln window (stdscr) + delscreen global locks(screenlist, screen) + delwin global locks(windowlist) + derwin screen + doupdate screen + dupwin screen locks(window) + echo screen + echo_wchar window (stdscr) + echochar window (stdscr) + endwin screen + erase window (stdscr) + erasechar window (stdscr) + erasewchar window (stdscr) + filter global + flash terminal + flushinp screen + get_wch screen (input-operation) + get_wstr screen (input-operation) + getattrs window + getbegx window + getbegy window + getbkgd window + getbkgrnd window + getcchar reentrant + getch screen (input-operation) + getcurx window + getcury window + getmaxx window + getmaxy window + getmouse screen (input-operation) + getn_wstr screen (input-operation) + getnstr screen (input-operation) + getparx window + getpary window + getstr screen (input-operation) + getwin screen (input-operation) + halfdelay screen + has_colors terminal + has_ic terminal + has_il terminal + has_key screen + hline window (stdscr) + hline_set window (stdscr) + + idcok window + idlok window + immedok window + in_wch window (stdscr) + in_wchnstr window (stdscr) + in_wchstr window (stdscr) + inch window (stdscr) + inchnstr window (stdscr) + inchstr window (stdscr) + init_color screen + init_pair screen + initscr global locks(screenlist) + innstr window (stdscr) + innwstr window (stdscr) + ins_nwstr window (stdscr) + ins_wch window (stdscr) + ins_wstr window (stdscr) + insch window (stdscr) + insdelln window (stdscr) + insertln window (stdscr) + insnstr window (stdscr) + insstr window (stdscr) + instr window (stdscr) + intrflush terminal + inwstr window (stdscr) + is_cleared window + is_idcok window + is_idlok window + is_immedok window + is_keypad window + is_leaveok window + is_linetouched window + is_nodelay window + is_notimeout window + is_scrollok window + is_syncok window + is_term_resized terminal + is_wintouched window + isendwin screen + key_defined screen + key_name global (static data) + keybound screen + keyname global (static data) + keyok screen + keypad window + killchar terminal + killwchar terminal + leaveok window + longname screen + mcprint terminal + meta screen + mouse_trafo window (stdscr) + mouseinterval screen + mousemask screen + move window (stdscr) + mvadd_wch window (stdscr) + mvadd_wchnstr window (stdscr) + mvadd_wchstr window (stdscr) + mvaddch window (stdscr) + mvaddchnstr window (stdscr) + mvaddchstr window (stdscr) + mvaddnstr window (stdscr) + mvaddnwstr window (stdscr) + mvaddstr window (stdscr) + mvaddwstr window (stdscr) + mvchgat window (stdscr) + + mvcur screen + mvdelch window (stdscr) + mvderwin window (stdscr) + mvget_wch screen (input-operation) + mvget_wstr screen (input-operation) + mvgetch screen (input-operation) + mvgetn_wstr screen (input-operation) + mvgetnstr screen (input-operation) + mvgetstr screen (input-operation) + mvhline window (stdscr) + mvhline_set window (stdscr) + mvin_wch window (stdscr) + mvin_wchnstr window (stdscr) + mvin_wchstr window (stdscr) + mvinch window (stdscr) + mvinchnstr window (stdscr) + mvinchstr window (stdscr) + mvinnstr window (stdscr) + mvinnwstr window (stdscr) + mvins_nwstr window (stdscr) + mvins_wch window (stdscr) + mvins_wstr window (stdscr) + mvinsch window (stdscr) + mvinsnstr window (stdscr) + mvinsstr window (stdscr) + mvinstr window (stdscr) + mvinwstr window (stdscr) + mvprintw window (stdscr) + mvscanw screen + mvvline window (stdscr) + mvvline_set window (stdscr) + mvwadd_wch window + mvwadd_wchnstr window + mvwadd_wchstr window + mvwaddch window + mvwaddchnstr window + mvwaddchstr window + mvwaddnstr window + mvwaddnwstr window + mvwaddstr window + mvwaddwstr window + mvwchgat window + mvwdelch window + mvwget_wch screen (input-operation) + mvwget_wstr screen (input-operation) + mvwgetch screen (input-operation) + mvwgetn_wstr screen (input-operation) + mvwgetnstr screen (input-operation) + mvwgetstr screen (input-operation) + mvwhline window + mvwhline_set window + mvwin window + mvwin_wch window + mvwin_wchnstr window + mvwin_wchstr window + mvwinch window + mvwinchnstr window + mvwinchstr window + mvwinnstr window + mvwinnwstr window + mvwins_nwstr window + mvwins_wch window + mvwins_wstr window + mvwinsch window + mvwinsnstr window + mvwinsstr window + + mvwinstr window + mvwinwstr window + mvwprintw window + mvwscanw screen + mvwvline window + mvwvline_set window + napms reentrant + newpad global locks(windowlist) + newscr screen (readonly) + newterm global locks(screenlist) + newwin global locks(windowlist) + nl screen + nocbreak screen + nodelay window + noecho screen + nofilter global + nonl screen + noqiflush terminal + noraw screen + notimeout window + numcodes global (readonly) + numfnames global (readonly) + numnames global (readonly) + ospeed global + overlay window locks(source, target) + overwrite window locks(source, target) + pair_content screen + pecho_wchar screen + pechochar screen + pnoutrefresh screen + prefresh screen + printw window + putp global + putwin window + qiflush terminal + raw screen + redrawwin window + refresh screen + reset_prog_mode screen + reset_shell_mode screen + resetty terminal + resize_term screen locks(windowlist) + resizeterm screen + restartterm screen + ripoffline global (static data) + savetty terminal + scanw screen + scr_dump screen + scr_init screen + scr_restore screen + scr_set screen + scrl window (stdscr) + scroll window + scrollok window + set_curterm screen + set_escdelay screen + set_tabsize screen + set_term global locks(screenlist, screen) + setcchar reentrant + setscrreg window (stdscr) + setupterm global + slk_attr screen + slk_attr_off screen + slk_attr_on screen + slk_attr_set screen + slk_attroff screen + + slk_attron screen + slk_attrset screen + slk_clear screen + slk_color screen + slk_init screen + slk_label screen + slk_noutrefresh screen + slk_refresh screen + slk_restore screen + slk_set screen + slk_touch screen + slk_wset screen + standend window + standout window + start_color screen + stdscr screen (readonly) + strcodes global (readonly) + strfnames global (readonly) + strnames global (readonly) + subpad window + subwin window + syncok window + term_attrs screen + termattrs screen + termname terminal + tgetent global + tgetflag global + tgetnum global + tgetstr global + tgoto global + tigetflag terminal + tigetnum terminal + tigetstr terminal + timeout window (stdscr) + touchline window + touchwin window + tparm global (static data) + tputs screen + trace global (static data) + ttytype screen (readonly) + typeahead screen + unctrl screen + unget_wch screen (input-operation) + ungetch screen (input-operation) + ungetmouse screen (input-operation) + untouchwin window + use_default_colors screen + use_env global (static data) + use_extended_names global (static data) + use_legacy_coding screen + use_screen global locks(screenlist, screen) + use_window global locks(windowlist, window) + vid_attr screen + vid_puts screen + vidattr screen + vidputs screen + vline window (stdscr) + vline_set window (stdscr) + vw_printw window + vw_scanw screen + vwprintw window + vwscanw screen + wadd_wch window + wadd_wchnstr window + wadd_wchstr window + waddch window + + waddchnstr window + waddchstr window + waddnstr window + waddnwstr window + waddstr window + waddwstr window + wattr_get window + wattr_off window + wattr_on window + wattr_set window + wattroff window + wattron window + wattrset window + wbkgd window + wbkgdset window + wbkgrnd window + wbkgrndset window + wborder window + wborder_set window + wchgat window + wclear window + wclrtobot window + wclrtoeol window + wcolor_set window + wcursyncup screen (affects window plus parents) + wdelch window + wdeleteln window + wecho_wchar window + wechochar window + wenclose window + werase window + wget_wch screen (input-operation) + wget_wstr screen (input-operation) + wgetbkgrnd window + wgetch screen (input-operation) + wgetn_wstr screen (input-operation) + wgetnstr screen (input-operation) + wgetparent window + wgetscrreg window + wgetstr screen (input-operation) + whline window + whline_set window + win_wch window + win_wchnstr window + win_wchstr window + winch window + winchnstr window + winchstr window + winnstr window + winnwstr window + wins_nwstr window + wins_wch window + wins_wstr window + winsch window + winsdelln window + winsertln window + winsnstr window + winsstr window + winstr window + winwstr window + wmouse_trafo window + wmove window + wnoutrefresh screen + wprintw window + wredrawln window + wrefresh screen + + wresize window locks(windowlist) + wscanw screen + wscrl window + wsetscrreg window + wstandend window + wstandout window + wsyncdown screen (affects window plus parents) + wsyncup screen (affects window plus parents) + wtimeout window + wtouchln window + wunctrl global (static data) + wvline window + wvline_set window + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These functions all return TRUE or FALSE, except as noted. + + +</PRE> +<H2>NOTES</H2><PRE> + Both a macro and a function are provided for each name. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on ncurses ex- + tensions be conditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html new file mode 100644 index 000000000000..9ba1bc6c21a4 --- /dev/null +++ b/doc/html/man/curs_touch.3x.html @@ -0,0 +1,144 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_touch.3x,v 1.14 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_touch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_touch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>touchwin</STRONG>, <STRONG>touchline</STRONG>, <STRONG>untouchwin</STRONG>, <STRONG>wtouchln</STRONG>, <STRONG>is_linetouched</STRONG>, + <STRONG>is_wintouched</STRONG> - <STRONG>curses</STRONG> refresh control routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>int</STRONG> <STRONG>touchwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>touchline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>start,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG> + <STRONG>int</STRONG> <STRONG>untouchwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>wtouchln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>int</STRONG> <STRONG>changed);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_linetouched(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>line);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_wintouched(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away all opti- + mization information about which parts of the window have + been touched, by pretending that the entire window has + been drawn on. This is sometimes necessary when using + overlapping windows, since a change to one window affects + the other window, but the records of which lines have been + changed in the other window do not reflect the change. + The routine <STRONG>touchline</STRONG> only pretends that <EM>count</EM> lines have + been changed, beginning with line <EM>start</EM>. + + The <STRONG>untouchwin</STRONG> routine marks all lines in the window as + unchanged since the last call to <STRONG>wrefresh</STRONG>. + + The <STRONG>wtouchln</STRONG> routine makes <EM>n</EM> lines in the window, starting + at line <EM>y</EM>, look as if they have (<EM>changed</EM><STRONG>=1</STRONG>) or have not + (<EM>changed</EM><STRONG>=0</STRONG>) been changed since the last call to <STRONG>wrefresh</STRONG>. + + The <STRONG>is_linetouched</STRONG> and <STRONG>is_wintouched</STRONG> routines return <STRONG>TRUE</STRONG> + if the specified line/window was modified since the last + call to <STRONG>wrefresh</STRONG>; otherwise they return <STRONG>FALSE</STRONG>. In addi- + tion, <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> if <EM>line</EM> is not valid for + the given window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an + integer value other than <STRONG>ERR</STRONG> upon successful completion, + unless otherwise noted in the preceding routine descrip- + tions. + + X/Open does not define any error conditions. In this im- + plementation + + <STRONG>is_linetouched</STRONG> + returns an error if the window pointer is + null, or if the line number is outside the + window. Note that ERR is distinct from TRUE + and FALSE, which are the normal return values + of this function. + + <STRONG>wtouchln</STRONG> + returns an error if the window pointer is + null, or if the line number is outside the + window. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(std-</STRONG> + <STRONG>scr)</STRONG>. This will not work under ncurses. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>wtouchln</STRONG> may be macros. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html new file mode 100644 index 000000000000..3705fdabf4a3 --- /dev/null +++ b/doc/html/man/curs_trace.3x.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2000-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_trace.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_trace 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_trace 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>_tracef</STRONG>, <STRONG>_tracedump</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>, + <STRONG>_nc_tracebits</STRONG>, <STRONG>_tracecchar_t</STRONG>, <STRONG>_tracecchar_t2</STRONG>, <STRONG>_tracechar</STRONG>, + <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_tracemouse</STRONG>, <STRONG>trace</STRONG> - <STRONG>curses</STRONG> + debugging routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*format,</STRONG> <STRONG>...);</STRONG> + <STRONG>void</STRONG> <STRONG>_tracedump(const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <STRONG>attr);</STRONG> + <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG> + <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*string);</STRONG> + <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*string);</STRONG> + <STRONG>char</STRONG> <STRONG>*_tracechar(int</STRONG> <STRONG>ch);</STRONG> + <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG> + <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*event);</STRONG> + <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <STRONG>param);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>trace</STRONG> routines are used for debugging the ncurses li- + braries, as well as applications which use the ncurses li- + braries. These functions are normally available only with + the debugging library <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>, but may be compiled + into any model (shared, static, profile) by defining the + symbol <STRONG>TRACE</STRONG>. Additionally, some functions are only + available with the wide-character configuration of the li- + braries. + + The principal parts of this interface are the <STRONG>trace</STRONG> rou- + tine which selectively enables different tracing features, + and the <STRONG>_tracef</STRONG> routine which writes formatted data to the + <EM>trace</EM> file. + + Calling <STRONG>trace</STRONG> with a nonzero parameter opens the file + <STRONG>trace</STRONG> in the current directory for output. The parameter + is formed by OR'ing values from the list of <STRONG>TRACE_</STRONG><EM>xxx</EM> def- + initions in <STRONG><curses.h></STRONG>. These include: + + TRACE_DISABLE + turn off tracing. + + TRACE_TIMES + trace user and system times of updates. + + TRACE_TPUTS + trace tputs calls. + + TRACE_UPDATE + trace update actions, old & new screens. + + TRACE_MOVE + trace cursor movement and scrolling. + + TRACE_CHARPUT + trace all character outputs. + + TRACE_ORDINARY + trace all update actions. The old and new screen + contents are written to the trace file for each re- + fresh. + + TRACE_CALLS + trace all curses calls. The parameters for each call + are traced, as well as return values. + + TRACE_VIRTPUT + trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>. + + TRACE_IEVENT + trace low-level input processing, including timeouts. + + TRACE_BITS + trace state of TTY control bits. + + TRACE_ICALLS + trace internal/nested calls. + + TRACE_CCALLS + trace per-character calls. + + TRACE_DATABASE + trace read/write of terminfo/termcap data. + + TRACE_ATTRS + trace changes to video attributes and colors. + + TRACE_MAXIMUM + maximum trace level, enables all of the separate + trace features. + + Some tracing features are enabled whenever the <STRONG>trace</STRONG> pa- + rameter is nonzero. Some features overlap. The specific + names are used as a guideline. + + These functions check the <STRONG>NCURSES_TRACE</STRONG> environment vari- + able, to set the tracing feature as if <STRONG>trace</STRONG> was called: + filter, initscr, new_prescr, newterm, nofilter, + ripoffline, setupterm, slk_init, tgetent + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines which return a value are designed to be used as + parameters to the <STRONG>_tracef</STRONG> routine. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are not part of the XSI interface. Some + other curses implementations are known to have similar, + undocumented features, but they are not compatible with + ncurses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html new file mode 100644 index 000000000000..8181efa432f3 --- /dev/null +++ b/doc/html/man/curs_util.3x.html @@ -0,0 +1,266 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_util.3x,v 1.32 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_util 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_util 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>, + <STRONG>nofilter</STRONG>, <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>wunctrl</STRONG> - miscellaneous + <STRONG>curses</STRONG> utility routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG> + <STRONG>wchar_t</STRONG> <STRONG>*wunctrl(cchar_t</STRONG> <STRONG>*c);</STRONG> + <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG> + <STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <STRONG>w);</STRONG> + <STRONG>void</STRONG> <STRONG>filter(void);</STRONG> + <STRONG>void</STRONG> <STRONG>nofilter(void);</STRONG> + <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <STRONG>f);</STRONG> + <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>FILE</STRONG> <STRONG>*filep);</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*filep);</STRONG> + <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <STRONG>ms);</STRONG> + <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>unctrl</STRONG> routine returns a character string which is a + printable representation of the character <EM>c</EM>, ignoring at- + tributes. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no- + tation. Printing characters are displayed as is. The + corresponding <STRONG>wunctrl</STRONG> returns a printable representation + of a wide character. + + The <STRONG>keyname</STRONG> routine returns a character string correspond- + ing to the key <EM>c</EM>: + + <STRONG>o</STRONG> Printable characters are displayed as themselves, + e.g., a one-character string containing the key. + + <STRONG>o</STRONG> Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> nota- + tion. + + <STRONG>o</STRONG> DEL (character 127) is displayed as <STRONG>^?</STRONG>. + + <STRONG>o</STRONG> Values above 128 are either meta characters (if the + screen has not been initialized, or if <STRONG>meta</STRONG> has + been called with a TRUE parameter), shown in the + <STRONG>M-</STRONG><EM>X</EM> notation, or are displayed as themselves. In + the latter case, the values may not be printable; + this follows the X/Open specification. + + <STRONG>o</STRONG> Values above 256 may be the names of the names of + function keys. + + <STRONG>o</STRONG> Otherwise (if there is no corresponding name) the + function returns null, to denote an error. X/Open + also lists an "UNKNOWN KEY" return value, which + some implementations return rather than null. + + The corresponding <STRONG>key_name</STRONG> returns a character string cor- + responding to the wide-character value <EM>w</EM>. The two func- + tions do not return the same set of strings; the latter + returns null where the former would display a meta charac- + ter. + + The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG> + or <STRONG>newterm</STRONG> are called. The effect is that, during those + calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>, + <STRONG>cud</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are disabled; and the <STRONG>home</STRONG> + string is set to the value of <STRONG>cr</STRONG>. + + The <STRONG>nofilter</STRONG> routine cancels the effect of a preceding + <STRONG>filter</STRONG> call. That allows the caller to initialize a + screen on a different device, using a different value of + <STRONG>$TERM</STRONG>. The limitation arises because the <STRONG>filter</STRONG> routine + modifies the in-memory copy of the terminal information. + + The <STRONG>use_env</STRONG> routine, if used, is called before <STRONG>initscr</STRONG> or + <STRONG>newterm</STRONG> are called. When called with <STRONG>FALSE</STRONG> as an argu- + ment, the values of <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the + <EM>terminfo</EM> database will be used, even if environment vari- + ables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> (used by default) are set, or if + <STRONG>curses</STRONG> is running in a window (in which case default be- + havior would be to use the window size if <STRONG>LINES</STRONG> and + <STRONG>COLUMNS</STRONG> are not set). Note that setting <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> + overrides the corresponding size which may be obtained + from the operating system. + + The <STRONG>putwin</STRONG> routine writes all data associated with window + <EM>win</EM> into the file to which <EM>filep</EM> points. This information + can be later retrieved using the <STRONG>getwin</STRONG> function. + + The <STRONG>getwin</STRONG> routine reads window related data stored in the + file by <STRONG>putwin</STRONG>. The routine then creates and initializes + a new window using that data. It returns a pointer to the + new window. + + The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause + in output. This routine should not be used extensively + because padding characters are used rather than a CPU + pause. If no padding character is specified, this uses + <STRONG>napms</STRONG> to perform the delay. + + The <STRONG>flushinp</STRONG> routine throws away any typeahead that has + been typed by the user and has not yet been read by the + program. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>flushinp</STRONG>, routines that return an integer re- + turn <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in- + teger value other than <STRONG>ERR</STRONG>") upon successful completion. + + Routines that return pointers return <STRONG>NULL</STRONG> on error. + + X/Open does not define any error conditions. In this im- + plementation + + <STRONG>flushinp</STRONG> + returns an error if the terminal was not initial- + ized. + + <STRONG>meta</STRONG> returns an error if the terminal was not initial- + ized. + + <STRONG>putwin</STRONG> + returns an error if the associated <STRONG>fwrite</STRONG> calls + return an error. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a + null pointer if unsuccessful, but does not define any er- + ror conditions. This implementation checks for three cas- + es: + + <STRONG>o</STRONG> the parameter is a 7-bit US-ASCII code. This is + the case that X/Open Curses documented. + + <STRONG>o</STRONG> the parameter is in the range 128-159, i.e., a C1 + control code. If <STRONG>use_legacy_coding</STRONG> has been called + with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns the parameter, + i.e., a one-character string with the parameter as + the first character. Otherwise, it returns ``~@'', + ``~A'', etc., analogous to ``^@'', ``^A'', C0 con- + trols. + + X/Open Curses does not document whether <STRONG>unctrl</STRONG> can + be called before initializing curses. This imple- + mentation permits that, and returns the ``~@'', + etc., values in that case. + + <STRONG>o</STRONG> parameter values outside the 0 to 255 range. <STRONG>unc-</STRONG> + <STRONG>trl</STRONG> returns a null pointer. + + The SVr4 documentation describes the action of <STRONG>filter</STRONG> only + in the vaguest terms. The description here is adapted + from the XSI Curses standard (which erroneously fails to + describe the disabling of <STRONG>cuu</STRONG>). + + The strings returned by <STRONG>unctrl</STRONG> in this implementation are + determined at compile time, showing C1 controls from the + upper-128 codes with a `~' prefix rather than `^'. Other + implementations have different conventions. For example, + they may show both sets of control characters with `^', + and strip the parameter to 7 bits. Or they may ignore C1 + controls and treat all of the upper-128 codes as print- + able. This implementation uses 8 bits but does not modify + the string to reflect locale. The <STRONG>use_legacy_coding</STRONG> func- + tion allows the caller to change the output of <STRONG>unctrl</STRONG>. + + Likewise, the <STRONG>meta</STRONG> function allows the caller to change + the output of <STRONG>keyname</STRONG>, i.e., it determines whether to use + the `M-' prefix for ``meta'' keys (codes in the range 128 + to 255). Both <STRONG>use_legacy_coding</STRONG> and <STRONG>meta</STRONG> succeed only af- + ter curses is initialized. X/Open Curses does not docu- + ment the treatment of codes 128 to 159. When treating + them as ``meta'' keys (or if <STRONG>keyname</STRONG> is called before ini- + tializing curses), this implementation returns strings + ``M-^@'', ``M-^A'', etc. + + The <STRONG>keyname</STRONG> function may return the names of user-defined + string capabilities which are defined in the terminfo en- + try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>. This implementation auto- + matically assigns at run-time keycodes to user-defined + strings which begin with "k". The keycodes start at + KEY_MAX, but are not guaranteed to be the same value for + different runs because user-defined codes are merged from + all terminal descriptions which have been loaded. The + <STRONG>use_extended_names</STRONG> function controls whether this data is + loaded when the terminal description is read by the li- + brary. + + The <STRONG>nofilter</STRONG> routine is specific to ncurses. It was not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on ncurses ex- + tensions be conditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_ker-</STRONG> + <STRONG><A HREF="curs_kernel.3x.html">nel(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG>lega-</STRONG> + <STRONG><A HREF="legacy_coding.3x.html">cy_coding(3x)</A></STRONG>. + + + + <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_variables.3x.html b/doc/html/man/curs_variables.3x.html new file mode 100644 index 000000000000..3cca3feef6a5 --- /dev/null +++ b/doc/html/man/curs_variables.3x.html @@ -0,0 +1,164 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_variables.3x,v 1.4 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_variables 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_variables 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>, + <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG> + <STRONG>int</STRONG> <STRONG>COLORS;</STRONG> + <STRONG>int</STRONG> <STRONG>COLS;</STRONG> + <STRONG>int</STRONG> <STRONG>ESCDELAY;</STRONG> + <STRONG>int</STRONG> <STRONG>LINES;</STRONG> + <STRONG>int</STRONG> <STRONG>TABSIZE;</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>curscr;</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>newscr;</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This page summarizes variables provided by the <STRONG>curses</STRONG> li- + brary. A more complete description is given in the <STRONG>curs-</STRONG> + <STRONG><A HREF="ncurses.3x.html">es(3x)</A></STRONG> manual page. + + Depending on the configuration, these may be actual vari- + ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>) which provide + read-only access to <EM>curses</EM>'s state. In either case, ap- + plications should treat them as read-only to avoid confus- + ing the library. + + <STRONG>COLOR_PAIRS</STRONG> + After initializing curses, this variable contains the num- + ber of color pairs which the terminal can support. Usual- + ly the number of color pairs will be the product <STRONG>COL-</STRONG> + <STRONG>ORS</STRONG>*<STRONG>COLORS</STRONG>, however this is not always true: + + <STRONG>o</STRONG> a few terminals use HLS colors, which do not follow + this rule + + <STRONG>o</STRONG> terminals supporting a large number of colors are lim- + ited by the number of color pairs that can be repre- + sented in a <EM>signed</EM> <EM>short</EM> value. + + <STRONG>COLORS</STRONG> + After initializing curses, this variable contains the num- + ber of colors which the terminal can support. + + <STRONG>COLS</STRONG> + After initializing curses, this variable contains the + width of the screen, i.e., the number of columns. + + <STRONG>ESCDELAY</STRONG> + This variable holds the number of milliseconds to wait af- + ter reading an escape character, to distinguish between an + individual escape character entered on the keyboard from + escape sequences sent by cursor- and function-keys (see + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + <STRONG>LINES</STRONG> + After initializing curses, this variable contains the + height of the screen, i.e., the number of lines. + + <STRONG>TABSIZE</STRONG> + This variable holds the number of columns used by the + <EM>curses</EM> library when converting a tab character to spaces + as it adds the tab to a window (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>. + + <STRONG>The</STRONG> <STRONG>Current</STRONG> <STRONG>Screen</STRONG> + This implementation of curses uses a special window <STRONG>curscr</STRONG> + to record its updates to the terminal screen. + + <STRONG>The</STRONG> <STRONG>New</STRONG> <STRONG>Screen</STRONG> + This implementation of curses uses a special window <STRONG>newscr</STRONG> + to hold updates to the terminal screen before applying + them to <STRONG>curscr</STRONG>. + + <STRONG>The</STRONG> <STRONG>Standard</STRONG> <STRONG>Screen</STRONG> + Upon initializing curses, a default window called <STRONG>stdscr</STRONG>, + which is the size of the terminal screen, is created. + Many curses functions use this window. + + +</PRE> +<H2>NOTES</H2><PRE> + The curses library is initialized using either + <STRONG><A HREF="initscr.3x.html">initscr(3x)</A></STRONG>, or <STRONG><A HREF="newterm.3x.html">newterm(3x)</A></STRONG>. + + If <STRONG>curses</STRONG> is configured to use separate curses/terminfo + libraries, most of these variables reside in the curses + library. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + ESCDELAY and TABSIZE are extensions, not provided in most + other implementations of curses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG>termin-</STRONG> + <STRONG><A HREF="terminfo.3x.html">fo(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + + + <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/curs_window.3x.html b/doc/html/man/curs_window.3x.html new file mode 100644 index 000000000000..d3d4ef4ae6e1 --- /dev/null +++ b/doc/html/man/curs_window.3x.html @@ -0,0 +1,216 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_window.3x,v 1.17 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_window 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_window 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>newwin</STRONG>, <STRONG>delwin</STRONG>, <STRONG>mvwin</STRONG>, <STRONG>subwin</STRONG>, <STRONG>derwin</STRONG>, <STRONG>mvderwin</STRONG>, <STRONG>dupwin</STRONG>, + <STRONG>wsyncup</STRONG>, <STRONG>syncok</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>wsyncdown</STRONG> - create <STRONG>curses</STRONG> + windows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>WINDOW</STRONG> <STRONG>*newwin(int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG> <STRONG>int</STRONG> <STRONG>begin_y,</STRONG> + <STRONG>int</STRONG> <STRONG>begin_x);</STRONG> + <STRONG>int</STRONG> <STRONG>delwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>mvwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*subwin(WINDOW</STRONG> <STRONG>*orig,</STRONG> <STRONG>int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG> + <STRONG>int</STRONG> <STRONG>begin_y,</STRONG> <STRONG>int</STRONG> <STRONG>begin_x);</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*derwin(WINDOW</STRONG> <STRONG>*orig,</STRONG> <STRONG>int</STRONG> <STRONG>nlines,</STRONG> <STRONG>int</STRONG> <STRONG>ncols,</STRONG> + <STRONG>int</STRONG> <STRONG>begin_y,</STRONG> <STRONG>int</STRONG> <STRONG>begin_x);</STRONG> + <STRONG>int</STRONG> <STRONG>mvderwin(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>par_y,</STRONG> <STRONG>int</STRONG> <STRONG>par_x);</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*dupwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>void</STRONG> <STRONG>wsyncup(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>syncok(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>bool</STRONG> <STRONG>bf);</STRONG> + <STRONG>void</STRONG> <STRONG>wcursyncup(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>void</STRONG> <STRONG>wsyncdown(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Calling <STRONG>newwin</STRONG> creates and returns a pointer to a new win- + dow with the given number of lines and columns. The upper + left-hand corner of the window is at line <EM>begin</EM>_<EM>y</EM>, column + <EM>begin</EM>_<EM>x</EM>. If either <EM>nlines</EM> or <EM>ncols</EM> is zero, they default + to <STRONG>LINES</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>y</EM> and <STRONG>COLS</STRONG> <STRONG>-</STRONG> <EM>begin</EM>_<EM>x</EM>. A new full-screen + window is created by calling <STRONG>newwin(0,0,0,0)</STRONG>. + + Calling <STRONG>delwin</STRONG> deletes the named window, freeing all memo- + ry associated with it (it does not actually erase the win- + dow's screen image). Subwindows must be deleted before + the main window can be deleted. + + Calling <STRONG>mvwin</STRONG> moves the window so that the upper left-hand + corner is at position (<EM>x</EM>, <EM>y</EM>). If the move would cause the + window to be off the screen, it is an error and the window + is not moved. Moving subwindows is allowed, but should be + avoided. + + Calling <STRONG>subwin</STRONG> creates and returns a pointer to a new win- + dow with the given number of lines, <EM>nlines</EM>, and columns, + <EM>ncols</EM>. The window is at position (<EM>begin</EM>_<EM>y</EM>, <EM>begin</EM>_<EM>x</EM>) on + the screen. (This position is relative to the screen, and + not to the window <EM>orig</EM>.) The window is made in the middle + of the window <EM>orig</EM>, so that changes made to one window + will affect both windows. The subwindow shares memory + with the window <EM>orig</EM>. When using this routine, it is nec- + essary to call <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before call- + ing <STRONG>wrefresh</STRONG> on the subwindow. + + Calling <STRONG>derwin</STRONG> is the same as calling <STRONG>subwin,</STRONG> except that + <EM>begin</EM>_<EM>y</EM> and <EM>begin</EM>_<EM>x</EM> are relative to the origin of the win- + dow <EM>orig</EM> rather than the screen. There is no difference + between the subwindows and the derived windows. + + Calling <STRONG>mvderwin</STRONG> moves a derived window (or subwindow) in- + side its parent window. The screen-relative parameters of + the window are not changed. This routine is used to dis- + play different parts of the parent window at the same + physical position on the screen. + + Calling <STRONG>dupwin</STRONG> creates an exact duplicate of the window + <EM>win</EM>. + + Calling <STRONG>wsyncup</STRONG> touches all locations in ancestors of <EM>win</EM> + that are changed in <EM>win</EM>. If <STRONG>syncok</STRONG> is called with second + argument <STRONG>TRUE</STRONG> then <STRONG>wsyncup</STRONG> is called automatically whenev- + er there is a change in the window. + + The <STRONG>wsyncdown</STRONG> routine touches each location in <EM>win</EM> that + has been touched in any of its ancestor windows. This + routine is called by <STRONG>wrefresh</STRONG>, so it should almost never + be necessary to call it manually. + + The routine <STRONG>wcursyncup</STRONG> updates the current cursor position + of all the ancestors of the window to reflect the current + cursor position of the window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return the integer <STRONG>ERR</STRONG> up- + on failure and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value + other than <STRONG>ERR</STRONG>") upon successful completion. + + Routines that return pointers return <STRONG>NULL</STRONG> on error. + + X/Open defines no error conditions. In this implementa- + tion + + <STRONG>delwin</STRONG> + returns an error if the window pointer is + null, or if the window is the parent of anoth- + er window. + + This implementation also maintains a list of + windows, and checks that the pointer passed to + <STRONG>delwin</STRONG> is one that it created, returning an + error if it was not.. + + <STRONG>mvderwin</STRONG> + returns an error if the window pointer is + null, or if some part of the window would be + placed off-screen. + + <STRONG>mvwin</STRONG> + returns an error if the window pointer is + null, or if the window is really a pad, or if + some part of the window would be placed off- + screen. + + <STRONG>syncok</STRONG> + returns an error if the window pointer is + null. + + +</PRE> +<H2>NOTES</H2><PRE> + If many small changes are made to the window, the <STRONG>wsyncup</STRONG> + option could degrade performance. + + Note that <STRONG>syncok</STRONG> may be a macro. + + +</PRE> +<H2>BUGS</H2><PRE> + The subwindow functions (<EM>subwin</EM>, <EM>derwin</EM>, <EM>mvderwin</EM>, <STRONG>wsyn-</STRONG> + <STRONG>cup</STRONG>, <STRONG>wsyncdown</STRONG>, <STRONG>wcursyncup</STRONG>, <STRONG>syncok</STRONG>) are flaky, incomplete- + ly implemented, and not well tested. + + The System V curses documentation is very unclear about + what <STRONG>wsyncup</STRONG> and <STRONG>wsyncdown</STRONG> actually do. It seems to imply + that they are only supposed to touch exactly those lines + that are affected by ancestor changes. The language here, + and the behavior of the <STRONG>curses</STRONG> implementation, is pat- + terned on the XPG4 curses standard. The weaker XPG4 spec + may result in slower updates. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> + <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG> + + + + <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/default_colors.3x.html b/doc/html/man/default_colors.3x.html new file mode 100644 index 000000000000..f0e44e2fc608 --- /dev/null +++ b/doc/html/man/default_colors.3x.html @@ -0,0 +1,180 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1997,1999,2000,2005 + * @Id: default_colors.3x,v 1.23 2011/01/03 21:52:27 Tim.van.der.Molen Exp @ +--> +<HTML> +<HEAD> +<TITLE>default_colors 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>default_colors 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG> <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>use_default_colors</STRONG>, <STRONG>assume_default_colors</STRONG> - use terminal's + default colors + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>use_default_colors(void);</STRONG> + <STRONG>int</STRONG> <STRONG>assume_default_colors(int</STRONG> <STRONG>fg,</STRONG> <STRONG>int</STRONG> <STRONG>bg);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> and <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> func- + tions are extensions to the curses library. They are used + with terminals that support ISO 6429 color, or equivalent. + These terminals allow the application to reset color to an + unspecified default value (e.g., with SGR 39 or SGR 49). + + Applications that paint a colored background over the + whole screen do not take advantage of SGR 39 and SGR 49. + Some applications are designed to work with the default + background, using colors only for text. For example, + there are several implementations of the <STRONG>ls</STRONG> program which + use colors to denote different file types or permissions. + These "color ls" programs do not necessarily modify the + background color, typically using only the <EM>setaf</EM> terminfo + capability to set the foreground color. Full-screen + applications that use default colors can achieve similar + visual effects. + + The first function, <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> tells the curses + library to assign terminal default foreground/background + colors to color number -1. So init_pair(x,COLOR_RED,-1) + will initialize pair x as red on default background and + init_pair(x,-1,COLOR_BLUE) will initialize pair x as + default foreground on blue. + + The other, <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> is a refinement which + tells which colors to paint for color pair 0. This func- + tion recognizes a special color number -1, which denotes + the default terminal color. + + The following are equivalent: + <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors();</EM> + <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors(-1,-1);</EM> + + These are ncurses extensions. For other curses implemen- + tations, color number -1 does not mean anything, just as + for ncurses before a successful call of <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>col-</EM> + <EM>ors()</EM> or <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM>. + + Other curses implementations do not allow an application + to modify color pair 0. They assume that the background + is COLOR_BLACK, but do not ensure that the color pair 0 is + painted to match the assumption. If your application does + not use either <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> or <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>col-</EM> + <EM>ors()</EM> ncurses will paint a white foreground (text) with + black background for color pair 0. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> + on success. They will fail if either the terminal does + not support the <EM>orig</EM><STRONG>_</STRONG><EM>pair</EM> or <EM>orig</EM><STRONG>_</STRONG><EM>colors</EM> capability. If + the <EM>initialize</EM><STRONG>_</STRONG><EM>pair</EM> capability is not found, this causes + an error as well. + + +</PRE> +<H2>NOTES</H2><PRE> + Associated with this extension, the <STRONG>init_pair</STRONG> function + accepts negative arguments to specify default foreground + or background colors. + + The <EM>use</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> function was added to support + <EM>ded</EM>. This is a full-screen application which uses curses + to manage only part of the screen. The bottom portion of + the screen, which is of adjustable size, is left uncolored + to display the results from shell commands. The top por- + tion of the screen colors filenames using a scheme like + the "color ls" programs. Attempting to manage the back- + ground color of the screen for this application would give + unsatisfactory results for a variety of reasons. This + extension was devised after noting that color xterm (and + similar programs) provides a background color which does + not necessarily correspond to any of the ANSI colors. + While a special terminfo entry could be constructed using + nine colors, there was no mechanism provided within curses + to account for the related <EM>orig</EM><STRONG>_</STRONG><EM>pair</EM> and <EM>back</EM><STRONG>_</STRONG><EM>color</EM><STRONG>_</STRONG><EM>erase</EM> + capabilities. + + The <EM>assume</EM><STRONG>_</STRONG><EM>default</EM><STRONG>_</STRONG><EM>colors()</EM> function was added to solve a + different problem: support for applications which would + use environment variables and other configuration to + bypass curses' notion of the terminal's default colors, + setting specific values. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG><A HREF="ded.1.html">ded(1)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (from an analysis of the requirements for + color xterm for XFree86 3.1.2C, February 1996). + + + + <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html new file mode 100644 index 000000000000..8556833bd017 --- /dev/null +++ b/doc/html/man/define_key.3x.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1997 + * @Id: define_key.3x,v 1.14 2010/12/04 18:49:20 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>define_key 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>define_key 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>define_key</STRONG> - define a keycode + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>define_key(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition,</STRONG> <STRONG>int</STRONG> <STRONG>keycode);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to define keycodes with their corresponding + control strings, so that the ncurses library will inter- + pret them just as it would the predefined codes in the + terminfo database. + + If the given string is null, any existing definition for + the keycode is removed. Similarly, if the given keycode + is negative or zero, any existing string for the given + definition is removed. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The keycode must be greater than zero, and the string non- + null, otherwise ERR is returned. ERR may also be returned + if there is insufficient memory to allocate the data to + store the definition. If no error is detected, OK is + returned. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form.3x.html b/doc/html/man/form.3x.html new file mode 100644 index 000000000000..38f14c49e809 --- /dev/null +++ b/doc/html/man/form.3x.html @@ -0,0 +1,258 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form.3x,v 1.24 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form</STRONG> - curses extension for programming forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>form</STRONG> library provides terminal-independent facilities + for composing form screens on character-cell terminals. + The library includes: field routines, which create and + modify form fields; and form routines, which group fields + into forms, display forms on the screen, and handle inter- + action with the user. + + The <STRONG>form</STRONG> library uses the <STRONG>curses</STRONG> libraries. To use the + <STRONG>form</STRONG> library, link with the options <STRONG>-lform</STRONG> <STRONG>-lcurses</STRONG>. + + Your program should set up the locale, e.g., + + <STRONG>setlocale(LC_ALL,</STRONG> <STRONG>"");</STRONG> + + so that input/output processing will work. + + A curses initialization routine such as <STRONG>initscr</STRONG> must be + called before using any of these functions. + + <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Field</STRONG> <STRONG>Attributes</STRONG> + The <STRONG>form</STRONG> library maintains a default value for field + attributes. You can get or set this default by calling + the appropriate <STRONG>set_</STRONG> or retrieval routine with a <STRONG>NULL</STRONG> + field pointer. Changing this default with a <STRONG>set_</STRONG> function + affects future field creations, but does not change the + rendering of fields already created. + + <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG> + The following table lists each <STRONG>form</STRONG> routine and the name + of the manual page on which it is described. + + <STRONG>curses</STRONG> Routine Name Manual Page Name + ------------------------------------------------- + current_field <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> + data_ahead <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG> + data_behind <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG> + dup_field <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> + dynamic_field_info <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> + field_arg <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> + field_back <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + field_buffer <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> + field_count <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> + field_fore <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + field_index <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> + field_info <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> + field_init <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + field_just <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> + field_opts <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> + field_opts_off <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> + field_opts_on <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> + field_pad <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + field_status <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> + field_term <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + field_type <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> + + field_userptr <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG> + form_driver <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG> + form_fields <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> + form_init <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + form_opts <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> + form_opts_off <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> + form_opts_on <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> + form_page <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> + form_request_by_name <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG> + form_request_name <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG> + form_sub <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> + form_term <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + form_userptr <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> + form_win <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> + free_field <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> + free_fieldtype <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> + free_form <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> + link_field <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> + link_fieldtype <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> + move_field <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> + new_field <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> + new_fieldtype <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> + new_form <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> + new_page <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG> + pos_form_cursor <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG> + post_form <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG> + scale_form <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> + set_current_field <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> + set_field_back <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + set_field_buffer <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> + set_field_fore <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + set_field_init <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + set_field_just <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> + set_field_opts <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> + set_field_pad <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + set_field_status <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> + set_field_term <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + set_field_type <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> + set_field_userptr <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG> + set_fieldtype_arg <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> + set_fieldtype_choice <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> + set_form_fields <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> + set_form_init <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + set_form_opts <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> + set_form_page <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> + set_form_sub <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> + set_form_term <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + set_form_userptr <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> + set_form_win <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> + set_max_field <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> + set_new_page <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG> + unpost_form <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error, and + set errno to the corresponding error-code returned by + functions returning an integer. Routines that return an + integer return one of the following error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_CONNECTED</STRONG> + The field is already connected to a form. + + <STRONG>E_INVALID_FIELD</STRONG> + Contents of a field are not valid. + + <STRONG>E_NOT_CONNECTED</STRONG> + No fields are connected to the form. + + <STRONG>E_NOT_POSTED</STRONG> + The form has not been posted. + + <STRONG>E_NO_ROOM</STRONG> + Form is too large for its window. + + <STRONG>E_POSTED</STRONG> + The form is already posted. + + <STRONG>E_REQUEST_DENIED</STRONG> + The form driver could not process the request. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_UNKNOWN_COMMAND</STRONG> + The form driver code saw an unknown request code. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + files <STRONG><curses.h></STRONG> and <STRONG><eti.h></STRONG>. + + In your library list, libform.a should be before libn- + curses.a; that is, you want to say `-lform -lncurses', not + the other way around (which would give you a link error + using most linkers). + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for ncurses + by Eric S. Raymond. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_cursor.3x.html b/doc/html/man/form_cursor.3x.html new file mode 100644 index 000000000000..04de65a5b470 --- /dev/null +++ b/doc/html/man/form_cursor.3x.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_cursor.3x,v 1.8 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_cursor 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_cursor 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG> <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_cursor</STRONG> - position a form window cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int pos_form_cursor(FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>pos_form_cursor</STRONG> restores the cursor to the + position required for the forms driver to continue pro- + cessing requests. This is useful after <STRONG>curses</STRONG> routines + have been called to do screen-painting in response to a + form operation. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + This routine returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_NOT_POSTED</STRONG> + The form has not been posted. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_data.3x.html b/doc/html/man/form_data.3x.html new file mode 100644 index 000000000000..f181a9a37169 --- /dev/null +++ b/doc/html/man/form_data.3x.html @@ -0,0 +1,104 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_data.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_data 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_data 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG> <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_data</STRONG> - test for off-screen data in given forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + bool data_ahead(const FORM *form); + bool data_behind(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>data_ahead</STRONG> tests whether there is off-screen + data ahead in the given form. It returns TRUE (1) or + FALSE (0). + + The function <STRONG>data_behind</STRONG> tests whether there is off-screen + data behind in the given form. It returns TRUE (1) or + FALSE (0). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html new file mode 100644 index 000000000000..ab9a263787d9 --- /dev/null +++ b/doc/html/man/form_driver.3x.html @@ -0,0 +1,375 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_driver.3x,v 1.22 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_driver 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_driver 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG> <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_driver</STRONG> - command-processing loop of the form system + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int form_driver(FORM *form, int c); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Once a form has been posted (displayed), you should funnel + input events to it through <STRONG>form_driver</STRONG>. This routine has + three major input cases: + + <STRONG>o</STRONG> The input is a form navigation request. Navigation + request codes are constants defined in <STRONG><form.h></STRONG>, which + are distinct from the key- and character codes + returned by <STRONG>wgetch</STRONG>. + + <STRONG>o</STRONG> The input is a printable character. Printable charac- + ters (which must be positive, less than 256) are + checked according to the program's locale settings. + + <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with + an mouse event. + + The form driver requests are as follows: + + REQ_NEXT_PAGE + Move to the next page. + + REQ_PREV_PAGE + Move to the previous page. + + REQ_FIRST_PAGE + Move to the first page. + + REQ_LAST_PAGE + Move to the last field. + + + REQ_NEXT_FIELD + Move to the next field. + + REQ_PREV_FIELD + Move to the previous field. + + REQ_FIRST_FIELD + Move to the first field. + + REQ_LAST_FIELD + Move to the last field. + + REQ_SNEXT_FIELD + Move to the sorted next field. + + REQ_SPREV_FIELD + Move to the sorted previous field. + + REQ_SFIRST_FIELD + Move to the sorted first field. + + REQ_SLAST_FIELD + Move to the sorted last field. + + REQ_LEFT_FIELD + Move left to a field. + + REQ_RIGHT_FIELD + Move right to a field. + + REQ_UP_FIELD + Move up to a field. + + REQ_DOWN_FIELD + Move down to a field. + + + REQ_NEXT_CHAR + Move to the next char. + + REQ_PREV_CHAR + Move to the previous char. + + REQ_NEXT_LINE + Move to the next line. + + REQ_PREV_LINE + Move to the previous line. + + REQ_NEXT_WORD + Move to the next word. + + REQ_PREV_WORD + Move to the previous word. + + REQ_BEG_FIELD + Move to the beginning of the field. + + REQ_END_FIELD + Move to the end of the field. + + REQ_BEG_LINE + Move to the beginning of the line. + + REQ_END_LINE + Move to the end of the line. + + REQ_LEFT_CHAR + Move left in the field. + + REQ_RIGHT_CHAR + Move right in the field. + + REQ_UP_CHAR + Move up in the field. + + REQ_DOWN_CHAR + Move down in the field. + + + REQ_NEW_LINE + Insert or overlay a new line. + + REQ_INS_CHAR + Insert a blank at the cursor. + + REQ_INS_LINE + Insert a blank line at the cursor. + + REQ_DEL_CHAR + Delete character at the cursor. + + REQ_DEL_PREV + Delete character before the cursor. + + REQ_DEL_LINE + Delete line at the cursor. + + REQ_DEL_WORD + Delete blank-delimited word at the cursor. + + REQ_CLR_EOL + Clear to end of line from cursor. + + REQ_CLR_EOF + Clear to end of field from cursor. + + REQ_CLR_FIELD + Clear the entire field. + + REQ_OVL_MODE + Enter overlay mode. + + REQ_INS_MODE + Enter insert mode. + + + REQ_SCR_FLINE + Scroll the field forward a line. + + REQ_SCR_BLINE + Scroll the field backward a line. + + REQ_SCR_FPAGE + Scroll the field forward a page. + + REQ_SCR_BPAGE + Scroll the field backward a page. + + REQ_SCR_FHPAGE + Scroll the field forward half a page. + + REQ_SCR_BHPAGE + Scroll the field backward half a page. + + + REQ_SCR_FCHAR + Scroll the field forward a character. + + REQ_SCR_BCHAR + Scroll the field backward a character. + + REQ_SCR_HFLINE + Horizontal scroll the field forward a line. + + REQ_SCR_HBLINE + Horizontal scroll the field backward a line. + + REQ_SCR_HFHALF + Horizontal scroll the field forward half a line. + + REQ_SCR_HBHALF + Horizontal scroll the field backward half a line. + + + REQ_VALIDATION + Validate field. + + REQ_NEXT_CHOICE + Display next field choice. + + REQ_PREV_CHOICE + Display previous field choice. + + If the second argument is a printable character, the + driver places it in the current position in the current + field. If it is one of the forms requests listed above, + that request is executed. + + <STRONG>MOUSE</STRONG> <STRONG>HANDLING</STRONG> + If the second argument is the KEY_MOUSE special key, the + associated mouse event is translated into one of the above + pre-defined requests. Currently only clicks in the user + window (e.g., inside the form display area or the decora- + tion window) are handled. + + If you click above the display region of the form: + + a REQ_PREV_FIELD is generated for a single click, + + a REQ_PREV_PAGE is generated for a double-click and + + a REQ_FIRST_FIELD is generated for a triple-click. + + If you click below the display region of the form: + + a REQ_NEXT_FIELD is generated for a single click, + + a REQ_NEXT_PAGE is generated for a double-click and + + a REQ_LAST_FIELD is generated for a triple-click. + + If you click at an field inside the display area of the + form: + + <STRONG>o</STRONG> the form cursor is positioned to that field. + + <STRONG>o</STRONG> If you double-click a field, the form cursor is + positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is + returned. This return value makes sense, because a + double click usually means that an field-specific + action should be returned. It is exactly the pur- + pose of this return value to signal that an appli- + cation specific command should be executed. + + <STRONG>o</STRONG> If a translation into a request was done, + <STRONG>form_driver</STRONG> returns the result of this request. + + If you clicked outside the user window or the mouse event + could not be translated into a form request an + <STRONG>E_REQUEST_DENIED</STRONG> is returned. + + <STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG> + If the second argument is neither printable nor one of the + above pre-defined form requests, the driver assumes it is + an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG> + <STRONG>MAND</STRONG>. Application-defined commands should be defined rel- + ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre- + defined requests. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>form_driver</STRONG> returns one of the following error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NOT_POSTED</STRONG> + The form has not been posted. + + <STRONG>E_INVALID_FIELD</STRONG> + Contents of field is invalid. + + <STRONG>E_REQUEST_DENIED</STRONG> + The form driver could not process the request. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_UNKNOWN_COMMAND</STRONG> + The form driver code saw an unknown request code. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="getch.3x.html">getch(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + files <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field.3x.html b/doc/html/man/form_field.3x.html new file mode 100644 index 000000000000..0e7f82140884 --- /dev/null +++ b/doc/html/man/form_field.3x.html @@ -0,0 +1,142 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field</STRONG> - make and break connections between fields and + forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_form_fields(FORM *form, FIELD **fields); + FIELD **form_fields(const FORM *form); + int field_count(const FORM *form); + int move_field(FIELD *field, int frow, int fcol); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_form_fields</STRONG> changes the field pointer + array of the given <EM>form</EM>. The array must be terminated by + a <STRONG>NULL</STRONG>. + + The function <STRONG>form_fields</STRONG> returns the field array of the + given form. + + The function <STRONG>field_count</STRONG> returns the count of fields in + <EM>form</EM>. + + The function <STRONG>move_field</STRONG> moves the given field (which must + be disconnected) to a specified location on the screen. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + The function <STRONG>form_fields</STRONG> returns a pointer (which may be + <STRONG>NULL</STRONG>). It does not set errno. + + The function <STRONG>field_count</STRONG> returns <STRONG>ERR</STRONG> if the <EM>form</EM> parameter + is <STRONG>NULL</STRONG>. + + The functions <STRONG>set_form_fields</STRONG> and <STRONG>move_field</STRONG> return one of + the following codes on error: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_CONNECTED</STRONG> + The field is already connected to a form. + + <STRONG>E_POSTED</STRONG> + The form is already posted. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + The SVr4 forms library documentation specifies the + <STRONG>field_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_attributes.3x.html b/doc/html/man/form_field_attributes.3x.html new file mode 100644 index 000000000000..36b93e5d8a03 --- /dev/null +++ b/doc/html/man/form_field_attributes.3x.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_attributes 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_attributes 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_attributes</STRONG> - color and attribute control for + form fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_field_fore(FIELD *field, chtype attr); + chtype field_fore(const FIELD *field); + int set_field_back(FIELD *field, chtype attr); + chtype field_back(const FIELD *field); + int set_field_pad(FIELD *field, int pad); + int field_pad(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_field_fore</STRONG> sets the foreground attribute + of <EM>field</EM>. This is the highlight used to display the field + contents. The function <STRONG>field_fore</STRONG> returns the foreground + attribute. The default is <STRONG>A_STANDOUT</STRONG>. + + The function <STRONG>set_field_back</STRONG> sets the background attribute + of <EM>form</EM>. This is the highlight used to display the extent + fields in the form. The function <STRONG>field_back</STRONG> returns the + background attribute. The default is <STRONG>A_NORMAL</STRONG>. + + The function <STRONG>set_field_pad</STRONG> sets the character used to fill + the field. The function <STRONG>field_pad</STRONG> returns the given + form's pad character. The default is a blank. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_buffer.3x.html b/doc/html/man/form_field_buffer.3x.html new file mode 100644 index 000000000000..fe6b531f44d8 --- /dev/null +++ b/doc/html/man/form_field_buffer.3x.html @@ -0,0 +1,179 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_buffer.3x,v 1.19 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_buffer 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_buffer 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_buffer</STRONG> - field buffer control + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + + int set_field_buffer(FIELD *field, int buf, const char + *value); + char *field_buffer(const FIELD *field, int buffer); + int set_field_status(FIELD *field, bool status); + bool field_status(const FIELD *field); + int set_max_field(FIELD *field, int max); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_field_buffer</STRONG> sets the numbered buffer of + the given field to contain a given string: + + <STRONG>o</STRONG> Buffer 0 is the displayed value of the field. + + <STRONG>o</STRONG> Other numbered buffers may be allocated by applica- + tions through the <STRONG>nbuf</STRONG> argument of (see + <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>) but are not manipulated by the + forms library. + + The function <STRONG>field_buffer</STRONG> returns a pointer to the con- + tents of the given numbered buffer: + + <STRONG>o</STRONG> The buffer contents always have the same length, + and are padded with trailing spaces as needed to + ensure this length is the same. + + <STRONG>o</STRONG> The buffer may contain leading spaces, depending on + how it was set. + + <STRONG>o</STRONG> The buffer contents are set with <STRONG>set_field_buffer</STRONG>, + or as a side effect of any editing operations on + the corresponding field. + + <STRONG>o</STRONG> Editing operations are based on the <EM>window</EM> which + displays the field, rather than a <EM>string</EM>. The win- + dow contains only printable characters, and is + filled with blanks. If you want the raw data, you + must write your own routine that copies the value + out of the buffer and removes the leading and + trailing spaces. + + <STRONG>o</STRONG> Because editing operations change the content of + the buffer to correspond to the window, you should + not rely on using buffers for long-term storage of + form data. + + The function <STRONG>set_field_status</STRONG> sets the associated status + flag of <EM>field</EM>; <STRONG>field_status</STRONG> gets the current value. The + status flag is set to a nonzero value whenever the field + changes. + + The function <STRONG>set_max_field</STRONG> sets the maximum size for a + dynamic field. An argument of 0 turns off any maximum + size threshold for that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The <STRONG>field_buffer</STRONG> function returns NULL on error. It sets + errno according to their success: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + The <STRONG>field_status</STRONG> function returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>. + + The remaining routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file + + When configured for wide characters, <STRONG>field_buffer</STRONG> returns + a pointer to temporary storage (allocated and freed by the + library). The application should not attempt to modify + the data. It will be freed on the next call to + <STRONG>field_buffer</STRONG> to return the same buffer. <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_info.3x.html b/doc/html/man/form_field_info.3x.html new file mode 100644 index 000000000000..eec555631901 --- /dev/null +++ b/doc/html/man/form_field_info.3x.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_info.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_info 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_info 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_info</STRONG> - retrieve field characteristics + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int field_info(const FIELD *field, int *rows, int *cols, + int *frow, int *fcol, int *nrow, int *nbuf); + int dynamic_field_info(const FIELD *field, int *rows, int + *cols, int *max); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>field_info</STRONG> returns the sizes and other + attributes passed in to the field at its creation time. + The attributes are: height, width, row of upper-left cor- + ner, column of upper-left corner, number off-screen rows, + and number of working buffers. + + The function <STRONG>dynamic_field_info</STRONG> returns the actual size of + the field, and its maximum possible size. If the field + has no size limit, the location addressed by the third + argument will be set to 0. A field can be made dynamic by + turning off the <STRONG>O_STATIC</STRONG> option with <STRONG>field_opts_off</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + A null (zero pointer) is accepted for any of the return + values, to ignore that value. Not all implementations + allow this, e.g., Solaris 2.7 does not. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_just.3x.html b/doc/html/man/form_field_just.3x.html new file mode 100644 index 000000000000..62dab7569dce --- /dev/null +++ b/doc/html/man/form_field_just.3x.html @@ -0,0 +1,119 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_just.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_just 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_just 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_just</STRONG> - retrieve field characteristics + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_field_just(FIELD *field, int justification); + int field_just(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_field_just</STRONG> sets the justification + attribute of a field; <STRONG>field_just</STRONG> returns a field's justi- + fication attribute. The attribute may be one of NO_JUSTI- + FICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>field_just</STRONG> returns one of: NO_JUSTIFICATION, + JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER. + + The function <STRONG>set_field_just</STRONG> returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_new.3x.html b/doc/html/man/form_field_new.3x.html new file mode 100644 index 000000000000..66b8d80669a6 --- /dev/null +++ b/doc/html/man/form_field_new.3x.html @@ -0,0 +1,150 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_new.3x,v 1.18 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_new 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_new 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_new</STRONG> - create and destroy form fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + FIELD *new_field(int height, int width, + int toprow, int leftcol, + int offscreen, int nbuffers); + FIELD *dup_field(FIELD *field, int toprow, int leftcol); + FIELD *link_field(FIELD *field, int toprow, int leftcol); + int free_field(FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>new_field</STRONG> allocates a new field and initial- + izes it from the parameters given: height, width, row of + upper-left corner, column of upper-left corner, number + off-screen rows, and number of additional working buffers. + + The function <STRONG>dup_field</STRONG> duplicates a field at a new loca- + tion. Most attributes (including current contents, size, + validation type, buffer count, growth threshold, justifi- + cation, foreground, background, pad character, options, + and user pointer) are copied. Field status and the field + page bit are not copied. + + The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but the new + field shares buffers with its parent. Attribute data is + separate. + + The function <STRONG>free_field</STRONG> de-allocates storage associated + with a field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG> + on error. They set errno according to their success: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred, e.g., malloc failure. + + The function <STRONG>free_field</STRONG> returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_CONNECTED</STRONG> + field is connected. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + It may be unwise to count on the set of attributes copied + by <STRONG>dup_field</STRONG> being portable; the System V forms library + documents are not very explicit about what gets copied and + what does not. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html new file mode 100644 index 000000000000..5463815aa617 --- /dev/null +++ b/doc/html/man/form_field_opts.3x.html @@ -0,0 +1,168 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_opts.3x,v 1.16 2010/12/04 18:41:07 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_opts 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_opts 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_opts</STRONG> - set and get field options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_field_opts(FIELD *field, Field_Options opts); + int field_opts_on(FIELD *field, Field_Options opts); + int field_opts_off(FIELD *field, Field_Options opts); + Field_Options field_opts(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_field_opts</STRONG> sets all the given field's + option bits (field option bits may be logically-OR'ed + together). + + The function <STRONG>field_opts_on</STRONG> turns on the given option bits, + and leaves others alone. + + The function <STRONG>field_opts_off</STRONG> turns off the given option + bits, and leaves others alone. + + The function <STRONG>field_opts</STRONG> returns the field's current option + bits. + + The following options are defined (all are on by default): + + O_VISIBLE + The field is displayed. If this option is off, dis- + play of the field is suppressed. + + O_ACTIVE + The field is visited during processing. If this + option is off, the field will not be reachable by + navigation keys. Please notice that an invisible + field appears to be inactive also. + + O_PUBLIC + The field contents are displayed as data is entered. + + O_EDIT + The field can be edited. + + O_WRAP + Words that do not fit on a line are wrapped to the + next line. Words are blank-separated. + + O_BLANK + The field is cleared whenever a character is entered + at the first position. + + O_AUTOSKIP + Skip to the next field when this one fills. + + O_NULLOK + Allow a blank field. + + O_STATIC + Field buffers are fixed to field's original size. + Turn this option off to create a dynamic field. + + O_PASSOK + Validate field only if modified by user. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>field_opts</STRONG>, each routine returns one of the + following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_CURRENT</STRONG> + The field is the current field. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_userptr.3x.html b/doc/html/man/form_field_userptr.3x.html new file mode 100644 index 000000000000..787e672f0a32 --- /dev/null +++ b/doc/html/man/form_field_userptr.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_userptr.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_userptr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_userptr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG> <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_userptr</STRONG> - associate application data with a + form field + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_field_userptr(FIELD *field, void*userptr); + void *field_userptr(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every form field has a field that can be used to hold + application-specific data (that is, the form-driver code + leaves it alone). These functions get and set that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>field_userptr</STRONG> returns a pointer (which may be + <STRONG>NULL</STRONG>). It does not set errno. + + The function <STRONG>set_field_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + The user pointer is a void pointer. We chose not to leave + it as a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_field_validation.3x.html b/doc/html/man/form_field_validation.3x.html new file mode 100644 index 000000000000..e810402edcf6 --- /dev/null +++ b/doc/html/man/form_field_validation.3x.html @@ -0,0 +1,195 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_field_validation.3x,v 1.20 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_field_validation 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_field_validation 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_field_validation</STRONG> - data type validation for fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_field_type(FIELD *field, FIELDTYPE *type, ...); + FIELDTYPE *field_type(const FIELD *field); + void *field_arg(const FIELD *field); + + FIELDTYPE *TYPE_ALNUM; + FIELDTYPE *TYPE_ALPHA; + FIELDTYPE *TYPE_ENUM; + FIELDTYPE *TYPE_INTEGER; + FIELDTYPE *TYPE_NUMERIC; + FIELDTYPE *TYPE_REGEXP; + FIELDTYPE *TYPE_IPV4; + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_field_type</STRONG> declares a data type for a + given form field. This is the type checked by validation + functions. The predefined types are as follows: + + TYPE_ALNUM + Alphanumeric data. Requires a third <STRONG>int</STRONG> argument, a + minimum field width. + + TYPE_ALPHA + Character data. Requires a third <STRONG>int</STRONG> argument, a + minimum field width. + + TYPE_ENUM + Accept one of a specified set of strings. Requires a + third <STRONG>(char</STRONG> <STRONG>**)</STRONG> argument pointing to a string list; a + fourth <STRONG>int</STRONG> flag argument to enable case-sensitivity; + and a fifth <STRONG>int</STRONG> flag argument specifying whether a + partial match must be a unique one (if this flag is + off, a prefix matches the first of any set of more + than one list elements with that prefix). Please + notice that the string list is copied. So you may use + a list that lives in automatic variables on the + stack. + + TYPE_INTEGER + Integer data, parsable to an integer by <STRONG>atoi(3)</STRONG>. + Requires a third <STRONG>int</STRONG> argument controlling the preci- + sion, a fourth <STRONG>long</STRONG> argument constraining minimum + value, and a fifth <STRONG>long</STRONG> constraining maximum value. + If the maximum value is less than or equal to the + minimum value, the range is simply ignored. On return + the field buffer is formatted according to the <STRONG>printf</STRONG> + format specification ".*ld", where the '*' is + replaced by the precision argument. For details of + the precision handling see <STRONG>printf's</STRONG> man-page. + + TYPE_NUMERIC + Numeric data (may have a decimal-point part). + Requires a third <STRONG>int</STRONG> argument controlling the preci- + sion, a fourth <STRONG>double</STRONG> argument constraining minimum + value, and a fifth <STRONG>double</STRONG> constraining maximum value. + If your system supports locales, the decimal point + character to be used must be the one specified by + your locale. If the maximum value is less than or + equal to the minimum value, the range is simply + ignored. On return the field buffer is formatted + according to the <STRONG>printf</STRONG> format specification ".*f", + where the '*' is replaced by the precision argument. + For details of the precision handling see <STRONG>printf's</STRONG> + man-page. + + TYPE_REGEXP + Regular expression data. Requires a regular expres- + sion <STRONG>(char</STRONG> <STRONG>*)</STRONG> third argument; the data is valid if + the regular expression matches it. Regular expres- + sions are in the format of <STRONG>regcomp</STRONG> and <STRONG>regexec</STRONG>. + Please notice that the regular expression must match + the whole field. If you have for example an eight + character wide field, a regular expression "^[0-9]*$" + always means that you have to fill all eight posi- + tions with digits. If you want to allow fewer digits, + you may use for example "^[0-9]* *$" which is good + for trailing spaces (up to an empty field), or "^ + *[0-9]* *$" which is good for leading and trailing + spaces around the digits. + + TYPE_IPV4 + An Internet Protocol Version 4 address. This requires + no additional argument. It is checked whether or not + the buffer has the form a.b.c.d, where a,b,c and d + are numbers between 0 and 255. Trailing blanks in the + buffer are ignored. The address itself is not vali- + dated. Please note that this is an ncurses extension. + This field type may not be available in other curses + implementations. + + It is possible to set up new programmer-defined field + types. See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The functions <STRONG>field_type</STRONG> and <STRONG>field_arg</STRONG> return <STRONG>NULL</STRONG> on + error. The function <STRONG>set_field_type</STRONG> returns one of the fol- + lowing: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_fieldtype.3x.html b/doc/html/man/form_fieldtype.3x.html new file mode 100644 index 000000000000..7f195ee37a8c --- /dev/null +++ b/doc/html/man/form_fieldtype.3x.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_fieldtype.3x,v 1.16 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_fieldtype 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_fieldtype 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_fieldtype</STRONG> - define validation-field types + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + FIELDTYPE *new_fieldtype( + bool (* const field_check)(FIELD *, const void *), + bool (* const char_check)(int, const void *)); + int free_fieldtype(FIELDTYPE *fieldtype); + int set_fieldtype_arg( + FIELDTYPE *fieldtype, + void *(* const make_arg)(va_list *), + void *(* const copy_arg)(const void *), + void (* const free_arg)(void *)); + int set_fieldtype_choice( + FIELDTYPE *fieldtype, + bool (* const next_choice)(FIELD *, const void *), + bool (* const prev_choice)(FIELD *, const void *)); + FIELDTYPE *link_fieldtype(FIELDTYPE *type1, + FIELDTYPE *type2); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>new_fieldtype</STRONG> creates a new field type usable + for data validation. You supply it with <EM>field</EM><STRONG>_</STRONG><EM>check</EM>, a + predicate to check the validity of an entered data string + whenever the user attempts to leave a field. The (FIELD + *) argument is passed in so the validation predicate can + see the field's buffer, sizes and other attributes; the + second argument is an argument-block structure, about + which more below. + + You also supply <STRONG>new_fieldtype</STRONG> with <EM>char</EM><STRONG>_</STRONG><EM>check</EM>, a function + to validate input characters as they are entered; it will + be passed the character to be checked and a pointer to an + argument-block structure. + + The function <STRONG>free_fieldtype</STRONG> frees the space allocated for + a given validation type. + + The function <STRONG>set_fieldtype_arg</STRONG> associates three storage- + management functions with a field type. The <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> + function is automatically applied to the list of arguments + you give <STRONG>set_field_type</STRONG> when attaching validation to a + field; its job is to bundle these into an allocated argu- + ment-block object which can later be passed to validation + predicated. The other two hook arguments should copy and + free argument-block structures. They will be used by the + forms-driver code. You must supply the <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> function, + the other two are optional, you may supply NULL for them. + In this case it is assumed that <EM>make</EM><STRONG>_</STRONG><EM>arg</EM> does not allocate + memory but simply loads the argument into a single scalar + value. + + The function <STRONG>link_fieldtype</STRONG> creates a new field type from + the two given types. They are connected by an logical + 'OR'. + + The form driver requests <STRONG>REQ_NEXT_CHOICE</STRONG> and + <STRONG>REQ_PREV_CHOICE</STRONG> assume that the possible values of a field + form an ordered set, and provide the forms user with a way + to move through the set. The <STRONG>set_fieldtype_choice</STRONG> func- + tion allows forms programmers to define successor and + predecessor functions for the field type. These functions + take the field pointer and an argument-block structure as + arguments. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The pointer-valued routines return NULL on error. They + set errno according to their success: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred, e.g., malloc failure. + + The integer-valued routines return one of the following + codes on error: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_CONNECTED</STRONG> + The field is already connected to a form. + + <STRONG>E_CURRENT</STRONG> + The field is the current field. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + All of the <STRONG>(char</STRONG> <STRONG>*)</STRONG> arguments of these functions should + actually be <STRONG>(void</STRONG> <STRONG>*)</STRONG>. The type has been left uncorrected + for strict compatibility with System V. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_hook.3x.html b/doc/html/man/form_hook.3x.html new file mode 100644 index 000000000000..369c164b9965 --- /dev/null +++ b/doc/html/man/form_hook.3x.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_hook 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_hook 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applica- + tions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_field_init(FORM *form, Form_Hook func); + Form_Hook field_init(const FORM *form); + int set_field_term(FORM *form, Form_Hook func); + Form_Hook field_term(const FORM *form); + int set_form_init(FORM *form, Form_Hook func); + Form_Hook form_init(const FORM *form); + int set_form_term(FORM *form, Form_Hook func); + Form_Hook form_term(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions make it possible to set hook functions to + be called at various points in the automatic processing of + input event codes by <STRONG>form_driver</STRONG>. + + The function <STRONG>set_field_init</STRONG> sets a hook to be called at + form-post time and each time the selected field changes + (after the change). <STRONG>field_init</STRONG> returns the current field + init hook, if any (<STRONG>NULL</STRONG> if there is no such hook). + + The function <STRONG>set_field_term</STRONG> sets a hook to be called at + form-unpost time and each time the selected field changes + (before the change). <STRONG>field_term</STRONG> returns the current field + term hook, if any (<STRONG>NULL</STRONG> if there is no such hook). + + The function <STRONG>set_form_init</STRONG> sets a hook to be called at + form-post time and just after a page change once it is + posted. <STRONG>form_init</STRONG> returns the current form init hook, if + any (<STRONG>NULL</STRONG> if there is no such hook). + + The function <STRONG>set_form_term</STRONG> sets a hook to be called at + form-unpost time and just before a page change once it is + posted. <STRONG>form_init</STRONG> returns the current form term hook, if + any (<STRONG>NULL</STRONG> if there is no such hook). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error. Other + routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_new.3x.html b/doc/html/man/form_new.3x.html new file mode 100644 index 000000000000..d73547a5f063 --- /dev/null +++ b/doc/html/man/form_new.3x.html @@ -0,0 +1,132 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_new.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_new 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_new 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_new</STRONG> - create and destroy forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + FORM *new_form(FIELD **fields); + int free_form(FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>new_form</STRONG> creates a new form connected to a + specified field pointer array (which must be <STRONG>NULL</STRONG>-termi- + nated). + + The function <STRONG>free_form</STRONG> disconnects <EM>form</EM> from its field + array and frees the storage allocated for the form. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>new_form</STRONG> returns <STRONG>NULL</STRONG> on error. It sets + errno according to the function's success: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_CONNECTED</STRONG> + The field is already connected to a form. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred, e.g., malloc failure. + + The function <STRONG>free_form</STRONG> returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The form has already been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_new_page.3x.html b/doc/html/man/form_new_page.3x.html new file mode 100644 index 000000000000..be9d1154cee1 --- /dev/null +++ b/doc/html/man/form_new_page.3x.html @@ -0,0 +1,119 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_new_page.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_new_page 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_new_page 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG> <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_new_page</STRONG> - form pagination functions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_new_page(FIELD *field, bool new_page_flag); + bool new_page(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_new_page</STRONG> sets or resets a flag marking + the given field as the beginning of a new page on its + form. + + The function <STRONG>new_page</STRONG> is a predicate which tests if a + given field marks a page beginning on its form. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>new_page</STRONG> returns <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>. + + The function <STRONG>set_new_page</STRONG> return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_CONNECTED</STRONG> + The given field is already connected to a form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_opts.3x.html b/doc/html/man/form_opts.3x.html new file mode 100644 index 000000000000..78d57fd73746 --- /dev/null +++ b/doc/html/man/form_opts.3x.html @@ -0,0 +1,134 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_opts 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_opts 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_opts</STRONG> - set and get form options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_form_opts(FORM *form, Field_Options opts); + int form_opts_on(FORM *form, Field_Options opts); + int form_opts_off(FORM *form, Field_Options opts); + Field_Options form_opts(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_form_opts</STRONG> sets all the given form's + option bits (form option bits may be logically-OR'ed + together). + + The function <STRONG>form_opts_on</STRONG> turns on the given option bits, + and leaves others alone. + + The function <STRONG>form_opts_off</STRONG> turns off the given option + bits, and leaves others alone. + + The function <STRONG>form_opts</STRONG> returns the form's current option + bits. + + The following options are defined (all are on by default): + + O_NL_OVERLOAD + Overload the <STRONG>REQ_NEW_LINE</STRONG> forms driver request so + that calling it at the end of a field goes to the + next field. + + O_BS_OVERLOAD + Overload the <STRONG>REQ_DEL_PREV</STRONG> forms driver request so + that calling it at the beginning of a field goes to + the previous field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol- + lowing: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_page.3x.html b/doc/html/man/form_page.3x.html new file mode 100644 index 000000000000..2168af1ffaec --- /dev/null +++ b/doc/html/man/form_page.3x.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_page.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_page 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_page 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_page</STRONG> - set and get form page number + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_current_field(FORM *form, FIELD *field); + FIELD *current_field(const FORM *); + int set_form_page(FORM *form, int n); + int form_page(const FORM *form); + int field_index(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of + the given form; <STRONG>current_field</STRONG> returns the current field of + the given form. + + The function <STRONG>set_form_page</STRONG> sets the form's page number + (goes to page <EM>n</EM> of the form). + + The function <STRONG>form_page</STRONG> returns the form's current page + number. + + The function <STRONG>field_index</STRONG> returns the index of the field in + the field array of the form it is connected to. It returns + <STRONG>ERR</STRONG> if the argument is the null pointer or the field is + not connected. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>form_page</STRONG>, each routine returns one of the fol- + lowing: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_INVALID_FIELD</STRONG> + Contents of a field are not valid. + + <STRONG>E_REQUEST_DENIED</STRONG> + The form driver could not process the request. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_post.3x.html b/doc/html/man/form_post.3x.html new file mode 100644 index 000000000000..1e7e71432e9c --- /dev/null +++ b/doc/html/man/form_post.3x.html @@ -0,0 +1,136 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_post.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_post 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_post 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG> <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_post</STRONG> - write or erase forms from associated subwin- + dows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int post_form(FORM *form); + int unpost_form(FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>post_form</STRONG> displays a form to its associated + subwindow. To trigger physical display of the subwindow, + use <STRONG>refresh</STRONG> or some equivalent <STRONG>curses</STRONG> routine (the + implicit <STRONG>doupdate</STRONG> triggered by an <STRONG>curses</STRONG> input request + will do). + + The function <STRONG>unpost_form</STRONG> erases form from its associated + subwindow. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NOT_POSTED</STRONG> + The form has not been posted. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the form. + + <STRONG>E_NO_ROOM</STRONG> + Form is too large for its window. + + <STRONG>E_POSTED</STRONG> + The form has already been posted. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_requestname.3x.html b/doc/html/man/form_requestname.3x.html new file mode 100644 index 000000000000..8400063f3a9c --- /dev/null +++ b/doc/html/man/form_requestname.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_requestname.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_requestname 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_requestname 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG> <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_requestname</STRONG> - handle printable form request names + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + const char *form_request_name(int request); + int form_request_by_name(const char *name); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>form_request_name</STRONG> returns the printable name + of a form request code. + The function <STRONG>form_request_by_name</STRONG> searches in the name-ta- + ble for a request with the given name and returns its + request code. Otherwise E_NO_MATCH is returned. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>form_request_name</STRONG> returns <STRONG>NULL</STRONG> on error and sets errno to + <STRONG>E_BAD_ARGUMENT</STRONG>. + <STRONG>form_request_by_name</STRONG> returns <STRONG>E_NO_MATCH</STRONG> on error. It does + not set errno. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_userptr.3x.html b/doc/html/man/form_userptr.3x.html new file mode 100644 index 000000000000..189fca2961ad --- /dev/null +++ b/doc/html/man/form_userptr.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_userptr.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_userptr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_userptr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_userptr</STRONG> - associate application data with a form item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_form_userptr(FORM *form, void *userptr); + void* form_userptr(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every form and every form item has a field that can be + used to hold application-specific data (that is, the form- + driver code leaves it alone). These functions get and set + the form user pointer field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>form_userptr</STRONG> returns a pointer (which may be + <STRONG>NULL</STRONG>). It does not set errno. + + The function <STRONG>set_form_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + The user pointer is a void pointer. We chose not to leave + it as a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_variables.3x.html b/doc/html/man/form_variables.3x.html new file mode 100644 index 000000000000..5d252d97e28d --- /dev/null +++ b/doc/html/man/form_variables.3x.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_variables.3x,v 1.3 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_variables 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_variables 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG> <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>TYPE_ALNUM</STRONG>, <STRONG>TYPE_ALPHA</STRONG>, <STRONG>TYPE_ENUM</STRONG>, <STRONG>TYPE_INTEGER</STRONG>, + <STRONG>TYPE_IPV4</STRONG>, <STRONG>TYPE_NUMERIC</STRONG>, <STRONG>TYPE_REGEXP</STRONG> - form system global + variables + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALNUM;</STRONG> + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ALPHA;</STRONG> + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_ENUM;</STRONG> + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_INTEGER;</STRONG> + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_IPV4;</STRONG> + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_NUMERIC;</STRONG> + <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG> <STRONG>TYPE_REGEXP;</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These are building blocks for the form library, defining + fields that can be created using <STRONG><A HREF="set_fieldtype.3x.html">set_fieldtype(3x)</A></STRONG>. Each + provides functions for field- and character-validation, + according to the given datatype. + + <STRONG>TYPE_ALNUM</STRONG> + This holds alphanumeric data. + + <STRONG>TYPE_ALPHA</STRONG> + This holds alphabetic data. + + <STRONG>TYPE_ENUM</STRONG> + This holds an enumerated type. + + <STRONG>TYPE_INTEGER</STRONG> + This holds a decimal integer. + + <STRONG>TYPE_IPV4</STRONG> + This holds an IPv4 internet address, e.g., "127.0.0.1". + + <STRONG>TYPE_NUMERIC</STRONG> + This holds a decimal number, with optional sign and deci- + mal point. + + <STRONG>TYPE_REGEXP</STRONG> + This holds a regular expression. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <STRONG>TYPE_IPV4</STRONG> variable is an extension not provided by + older implementations of the form library. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + + + <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/form_win.3x.html b/doc/html/man/form_win.3x.html new file mode 100644 index 000000000000..9baa68f82c15 --- /dev/null +++ b/doc/html/man/form_win.3x.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: form_win.3x,v 1.13 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>form_win 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>form_win 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>form_win</STRONG> - make and break form window and subwindow asso- + ciations + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><form.h></STRONG> + int set_form_win(FORM *form, WINDOW *win); + WINDOW *form_win(const FORM *form); + int set_form_sub(FORM *form, WINDOW *sub); + WINDOW *form_sub(const FORM *form); + int scale_form(const FORM *form, int *rows, int *columns); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every form has an associated pair of <STRONG>curses</STRONG> windows. The + form window displays any title and border associated with + the window; the form subwindow displays the items of the + form that are currently available for selection. + + The first four functions get and set those windows. It is + not necessary to set either window; by default, the driver + code uses <STRONG>stdscr</STRONG> for both. + + In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated + as though it were <STRONG>stsdcr</STRONG>. A form argument of <STRONG>NULL</STRONG> is + treated as a request to change the system default form + window or subwindow. + + The function <STRONG>scale_form</STRONG> returns the minimum size required + for the subwindow of <EM>form</EM>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou- + tines that return an integer return one of the following + error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The form has already been posted. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><form.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/index.html b/doc/html/man/index.html new file mode 100644 index 000000000000..64a832f213e7 --- /dev/null +++ b/doc/html/man/index.html @@ -0,0 +1,67 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.0//EN"> +<!-- + $Id: index.html,v 1.4 2010/01/09 20:36:50 tom Exp $ + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + --> +<HTML> +<HEAD> +<TITLE>NCURSES – Manual Pages</TITLE> +<LINK REV=MADE HREF="mailto:dickey@invisible-island.net"> +</HEAD> +<BODY> +<HR> +<ul> +<li>Programs: +<ul> +<li><a href = "captoinfo.1m.html">captoinfo – convert a termcap description into a terminfo description</a> +<li><a href = "clear.1.html">clear – clear the terminal screen</a> +<li><a href = "infocmp.1m.html">infocmp – compare or print out terminfo descriptions</a> +<li><a href = "infotocap.1m.html">infotocap – convert a terminfo description into a termcap description</a> +<li><a href = "tabs.1.html">tabs – set tabs on a terminal</a> +<li><a href = "tic.1m.html">tic – the terminfo entry-description compiler</a> +<li><a href = "toe.1m.html">toe – table of (terminfo) entries</a> +<li><a href = "tput.1.html">tput – initialize a terminal or query terminfo database</a> +<li><a href = "tset.1.html">tset – terminal initialization</a> +</ul> +<li>Libraries: +<ul> +<li><a href = "ncurses.3x.html">ncurses – CRT screen handling and optimization package</a> +<li><a href = "panel.3x.html">panel- panel stack extension for curses</a> +<li><a href = "form.3x.html">form – curses extension for programming forms</a> +<li><a href = "menu.3x.html">menu – curses extension for programming menus</a> +</ul> +<li>File formats: +<ul> +<li><a href = "terminfo.5.html">terminfo – terminal capability data base</a> +<li><a href = "term.5.html">term – format of compiled term file.</a> +<li><a href = "term.7.html">term – conventions for naming terminal types</a> +</ul> +</ul> +</BODY> +</HTML> diff --git a/doc/html/man/infocmp.1m.html b/doc/html/man/infocmp.1m.html new file mode 100644 index 000000000000..c68f477552a1 --- /dev/null +++ b/doc/html/man/infocmp.1m.html @@ -0,0 +1,444 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: infocmp.1m,v 1.46 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>infocmp 1m</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>infocmp 1m</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>infocmp</STRONG> - compare or print out <EM>terminfo</EM> descriptions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>infocmp</STRONG> [<STRONG>-1CEFGILTUVcdegilnpqrtux</STRONG>] + [<STRONG>-v</STRONG> <EM>n</EM>] [<STRONG>-s</STRONG> <STRONG>d</STRONG>| <STRONG>i</STRONG>| <STRONG>l</STRONG>| <STRONG>c</STRONG>] [<STRONG>-R</STRONG> <STRONG>subset</STRONG>] + [<STRONG>-w</STRONG> <EM>width</EM>] [<STRONG>-A</STRONG> <EM>directory</EM>] [<STRONG>-B</STRONG> <EM>directory</EM>] + [<EM>termname</EM>...] + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>infocmp</STRONG> can be used to compare a binary <STRONG>terminfo</STRONG> entry + with other terminfo entries, rewrite a <STRONG>terminfo</STRONG> descrip- + tion to take advantage of the <STRONG>use=</STRONG> terminfo field, or + print out a <STRONG>terminfo</STRONG> description from the binary file + (<STRONG>term</STRONG>) in a variety of formats. In all cases, the boolean + fields will be printed first, followed by the numeric + fields, followed by the string fields. + + <STRONG>Default</STRONG> <STRONG>Options</STRONG> + If no options are specified and zero or one <EM>termnames</EM> are + specified, the <STRONG>-I</STRONG> option will be assumed. If more than + one <EM>termname</EM> is specified, the <STRONG>-d</STRONG> option will be assumed. + + <STRONG>Comparison</STRONG> <STRONG>Options</STRONG> <STRONG>[-d]</STRONG> <STRONG>[-c]</STRONG> <STRONG>[-n]</STRONG> + <STRONG>infocmp</STRONG> compares the <STRONG>terminfo</STRONG> description of the first + terminal <EM>termname</EM> with each of the descriptions given by + the entries for the other terminal's <EM>termnames</EM>. If a + capability is defined for only one of the terminals, the + value returned will depend on the type of the capability: + <STRONG>F</STRONG> for boolean variables, <STRONG>-1</STRONG> for integer variables, and + <STRONG>NULL</STRONG> for string variables. + + The <STRONG>-d</STRONG> option produces a list of each capability that is + different between two entries. This option is useful to + show the difference between two entries, created by dif- + ferent people, for the same or similar terminals. + + The <STRONG>-c</STRONG> option produces a list of each capability that is + common between two entries. Capabilities that are not set + are ignored. This option can be used as a quick check to + see if the <STRONG>-u</STRONG> option is worth using. + + The <STRONG>-n</STRONG> option produces a list of each capability that is + in neither entry. If no <EM>termnames</EM> are given, the environ- + ment variable <STRONG>TERM</STRONG> will be used for both of the <EM>termnames</EM>. + This can be used as a quick check to see if anything was + left out of a description. + + <STRONG>Source</STRONG> <STRONG>Listing</STRONG> <STRONG>Options</STRONG> <STRONG>[-I]</STRONG> <STRONG>[-L]</STRONG> <STRONG>[-C]</STRONG> <STRONG>[-r]</STRONG> + The <STRONG>-I</STRONG>, <STRONG>-L</STRONG>, and <STRONG>-C</STRONG> options will produce a source listing + for each terminal named. + + <STRONG>-I</STRONG> use the <STRONG>terminfo</STRONG> names + <STRONG>-L</STRONG> use the long C variable name listed in <<STRONG>term.h</STRONG>> + <STRONG>-C</STRONG> use the <STRONG>termcap</STRONG> names + <STRONG>-r</STRONG> when using <STRONG>-C</STRONG>, put out all capabilities in <STRONG>termcap</STRONG> form + + If no <EM>termnames</EM> are given, the environment variable <STRONG>TERM</STRONG> + will be used for the terminal name. + + The source produced by the <STRONG>-C</STRONG> option may be used directly + as a <STRONG>termcap</STRONG> entry, but not all parameterized strings can + be changed to the <STRONG>termcap</STRONG> format. <STRONG>infocmp</STRONG> will attempt to + convert most of the parameterized information, and any- + thing not converted will be plainly marked in the output + and commented out. These should be edited by hand. + + All padding information for strings will be collected + together and placed at the beginning of the string where + <STRONG>termcap</STRONG> expects it. Mandatory padding (padding informa- + tion with a trailing '/') will become optional. + + All <STRONG>termcap</STRONG> variables no longer supported by <STRONG>terminfo</STRONG>, but + which are derivable from other <STRONG>terminfo</STRONG> variables, will be + output. Not all <STRONG>terminfo</STRONG> capabilities will be translated; + only those variables which were part of <STRONG>termcap</STRONG> will nor- + mally be output. Specifying the <STRONG>-r</STRONG> option will take off + this restriction, allowing all capabilities to be output + in <EM>termcap</EM> form. + + Note that because padding is collected to the beginning of + the capability, not all capabilities are output. Manda- + tory padding is not supported. Because <STRONG>termcap</STRONG> strings + are not as flexible, it is not always possible to convert + a <STRONG>terminfo</STRONG> string capability into an equivalent <STRONG>termcap</STRONG> + format. A subsequent conversion of the <STRONG>termcap</STRONG> file back + into <STRONG>terminfo</STRONG> format will not necessarily reproduce the + original <STRONG>terminfo</STRONG> source. + + Some common <STRONG>terminfo</STRONG> parameter sequences, their <STRONG>termcap</STRONG> + equivalents, and some terminal types which commonly have + such sequences, are: + + <STRONG>terminfo</STRONG> <STRONG>termcap</STRONG> Representative Terminals + --------------------------------------------------------------- + <STRONG>%p1%c</STRONG> <STRONG>%.</STRONG> adm + <STRONG>%p1%d</STRONG> <STRONG>%d</STRONG> hp, ANSI standard, vt100 + <STRONG>%p1%'x'%+%c</STRONG> <STRONG>%+x</STRONG> concept + <STRONG>%i</STRONG> <STRONG>%i</STRONG>q ANSI standard, vt100 + <STRONG>%p1%?%'x'%>%t%p1%'y'%+%;</STRONG> <STRONG>%>xy</STRONG> concept + <STRONG>%p2</STRONG> is printed before <STRONG>%p1</STRONG> <STRONG>%r</STRONG> hp + + <STRONG>Use=</STRONG> <STRONG>Option</STRONG> <STRONG>[-u]</STRONG> + The <STRONG>-u</STRONG> option produces a <STRONG>terminfo</STRONG> source description of + the first terminal <EM>termname</EM> which is relative to the sum + of the descriptions given by the entries for the other + terminals <EM>termnames</EM>. It does this by analyzing the dif- + ferences between the first <EM>termname</EM> and the other + <EM>termnames</EM> and producing a description with <STRONG>use=</STRONG> fields for + the other terminals. In this manner, it is possible to + retrofit generic terminfo entries into a terminal's + description. Or, if two similar terminals exist, but were + coded at different times or by different people so that + each description is a full description, using <STRONG>infocmp</STRONG> will + show what can be done to change one description to be rel- + ative to the other. + + A capability will get printed with an at-sign (@) if it no + longer exists in the first <EM>termname</EM>, but one of the other + <EM>termname</EM> entries contains a value for it. A capability's + value gets printed if the value in the first <EM>termname</EM> is + not found in any of the other <EM>termname</EM> entries, or if the + first of the other <EM>termname</EM> entries that has this capabil- + ity gives a different value for the capability than that + in the first <EM>termname</EM>. + + The order of the other <EM>termname</EM> entries is significant. + Since the terminfo compiler <STRONG>tic</STRONG> does a left-to-right scan + of the capabilities, specifying two <STRONG>use=</STRONG> entries that con- + tain differing entries for the same capabilities will pro- + duce different results depending on the order that the + entries are given in. <STRONG>infocmp</STRONG> will flag any such incon- + sistencies between the other <EM>termname</EM> entries as they are + found. + + Alternatively, specifying a capability <EM>after</EM> a <STRONG>use=</STRONG> entry + that contains that capability will cause the second speci- + fication to be ignored. Using <STRONG>infocmp</STRONG> to recreate a + description can be a useful check to make sure that every- + thing was specified correctly in the original source + description. + + Another error that does not cause incorrect compiled + files, but will slow down the compilation time, is speci- + fying extra <STRONG>use=</STRONG> fields that are superfluous. <STRONG>infocmp</STRONG> + will flag any other <EM>termname</EM> <EM>use=</EM> fields that were not + needed. + + <STRONG>Changing</STRONG> <STRONG>Databases</STRONG> <STRONG>[-A</STRONG> <EM>directory</EM>] [-B <EM>directory</EM>] + The location of the compiled <STRONG>terminfo</STRONG> database is taken + from the environment variable <STRONG>TERMINFO</STRONG> . If the variable + is not defined, or the terminal is not found in that loca- + tion, the system <STRONG>terminfo</STRONG> database, in <STRONG>/usr/share/ter-</STRONG> + <STRONG>minfo</STRONG>, will be used. The options <STRONG>-A</STRONG> and <STRONG>-B</STRONG> may be used to + override this location. The <STRONG>-A</STRONG> option will set <STRONG>TERMINFO</STRONG> + for the first <EM>termname</EM> and the <STRONG>-B</STRONG> option will set <STRONG>TERMINFO</STRONG> + for the other <EM>termnames</EM>. With this, it is possible to + compare descriptions for a terminal with the same name + located in two different databases. This is useful for + comparing descriptions for the same terminal created by + different people. + + <STRONG>Other</STRONG> <STRONG>Options</STRONG> + <STRONG>-1</STRONG> causes the fields to be printed out one to a line. + Otherwise, the fields will be printed several to a + line to a maximum width of 60 characters. + + <STRONG>-a</STRONG> tells <STRONG>infocmp</STRONG> to retain commented-out capabilities + rather than discarding them. Capabilities are com- + mented by prefixing them with a period. + + <STRONG>-E</STRONG> Dump the capabilities of the given terminal as + tables, needed in the C initializer for a TERMTYPE + structure (the terminal capability structure in the + <STRONG><term.h></STRONG>). This option is useful for preparing ver- + sions of the curses library hardwired for a given + terminal type. The tables are all declared static, + and are named according to the type and the name of + the corresponding terminal entry. + + Before ncurses 5.0, the split between the <STRONG>-e</STRONG> and <STRONG>-E</STRONG> + options was not needed; but support for extended + names required making the arrays of terminal capabil- + ities separate from the TERMTYPE structure. + + <STRONG>-e</STRONG> Dump the capabilities of the given terminal as a C + initializer for a TERMTYPE structure (the terminal + capability structure in the <STRONG><term.h></STRONG>). This option + is useful for preparing versions of the curses + library hardwired for a given terminal type. + + <STRONG>-F</STRONG> compare terminfo files. This assumes that two fol- + lowing arguments are filenames. The files are + searched for pairwise matches between entries, with + two entries considered to match if any of their names + do. The report printed to standard output lists + entries with no matches in the other file, and + entries with more than one match. For entries with + exactly one match it includes a difference report. + Normally, to reduce the volume of the report, use + references are not resolved before looking for dif- + ferences, but resolution can be forced by also speci- + fying <STRONG>-r</STRONG>. + + <STRONG>-f</STRONG> Display complex terminfo strings which contain + if/then/else/endif expressions indented for readabil- + ity. + + <STRONG>-G</STRONG> Display constant literals in decimal form rather than + their character equivalents. + + <STRONG>-g</STRONG> Display constant character literals in quoted form + rather than their decimal equivalents. + + <STRONG>-i</STRONG> Analyze the initialization (<STRONG>is1</STRONG>, <STRONG>is2</STRONG>, <STRONG>is3</STRONG>), and reset + (<STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>), strings in the entry. For each + string, the code tries to analyze it into actions in + terms of the other capabilities in the entry, certain + X3.64/ISO 6429/ECMA-48 capabilities, and certain DEC + VT-series private modes (the set of recognized spe- + cial sequences has been selected for completeness + over the existing terminfo database). Each report + line consists of the capability name, followed by a + colon and space, followed by a printable expansion of + the capability string with sections matching recog- + nized actions translated into {}-bracketed descrip- + tions. Here is a list of the DEC/ANSI special + sequences recognized: i. + + Action Meaning + ----------------------------------------- + RIS full reset + SC save cursor + RC restore cursor + LL home-down + RSR reset scroll region + ----------------------------------------- + DECSTR soft reset (VT320) + S7C1T 7-bit controls (VT220) + ----------------------------------------- + ISO DEC G0 enable DEC graphics for G0 + ISO UK G0 enable UK chars for G0 + ISO US G0 enable US chars for G0 + ISO DEC G1 enable DEC graphics for G1 + ISO UK G1 enable UK chars for G1 + ISO US G1 enable US chars for G1 + ----------------------------------------- + DECPAM application keypad mode + DECPNM normal keypad mode + DECANSI enter ANSI mode + ----------------------------------------- + ECMA[+-]AM keyboard action mode + ECMA[+-]IRM insert replace mode + ECMA[+-]SRM send receive mode + ECMA[+-]LNM linefeed mode + ----------------------------------------- + DEC[+-]CKM application cursor keys + DEC[+-]ANM set VT52 mode + DEC[+-]COLM 132-column mode + + DEC[+-]SCLM smooth scroll + DEC[+-]SCNM reverse video mode + DEC[+-]OM origin mode + DEC[+-]AWM wraparound mode + DEC[+-]ARM auto-repeat mode + + It also recognizes a SGR action corresponding to + ANSI/ISO 6429/ECMA Set Graphics Rendition, with the + values NORMAL, BOLD, UNDERLINE, BLINK, and REVERSE. + All but NORMAL may be prefixed with `+' (turn on) or + `-' (turn off). + + An SGR0 designates an empty highlight sequence (equivalent + to {SGR:NORMAL}). + + <STRONG>-l</STRONG> Set output format to terminfo. + + <STRONG>-p</STRONG> Ignore padding specifications when comparing strings. + + <STRONG>-q</STRONG> Make the comparison listing shorter by omitting sub- + headings, and using "-" for absent capabilities, "@" + for canceled rather than "NULL". + + <STRONG>-R</STRONG><EM>subset</EM> + Restrict output to a given subset. This option is + for use with archaic versions of terminfo like those + on SVr1, Ultrix, or HP/UX that do not support the + full set of SVR4/XSI Curses terminfo; and variants + such as AIX that have their own extensions incompati- + ble with SVr4/XSI. Available terminfo subsets are + "SVr1", "Ultrix", "HP", and "AIX"; see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + for details. You can also choose the subset "BSD" + which selects only capabilities with termcap equiva- + lents recognized by 4.4BSD. + + <STRONG>-s</STRONG> <EM>[d|i|l|c]</EM> + The <STRONG>-s</STRONG> option sorts the fields within each type + according to the argument below: + + <STRONG>d</STRONG> leave fields in the order that they are stored + in the <EM>terminfo</EM> database. + + <STRONG>i</STRONG> sort by <EM>terminfo</EM> name. + + <STRONG>l</STRONG> sort by the long C variable name. + + <STRONG>c</STRONG> sort by the <EM>termcap</EM> name. + + If the <STRONG>-s</STRONG> option is not given, the fields printed out + will be sorted alphabetically by the <STRONG>terminfo</STRONG> name + within each type, except in the case of the <STRONG>-C</STRONG> or the + <STRONG>-L</STRONG> options, which cause the sorting to be done by the + <STRONG>termcap</STRONG> name or the long C variable name, respec- + tively. + + <STRONG>-T</STRONG> eliminates size-restrictions on the generated text. + This is mainly useful for testing and analysis, since + the compiled descriptions are limited (e.g., 1023 for + termcap, 4096 for terminfo). + + <STRONG>-t</STRONG> tells <STRONG>tic</STRONG> to discard commented-out capabilities. + Normally when translating from terminfo to termcap, + untranslatable capabilities are commented-out. + + <STRONG>-U</STRONG> tells <STRONG>infocmp</STRONG> to not post-process the data after + parsing the source file. This feature helps when + comparing the actual contents of two source files, + since it excludes the inferences that <STRONG>infocmp</STRONG> makes + to fill in missing data. + + <STRONG>-V</STRONG> reports the version of ncurses which was used in this + program, and exits. + + <STRONG>-v</STRONG> <EM>n</EM> prints out tracing information on standard error as + the program runs. Higher values of n induce greater + verbosity. + + <STRONG>-w</STRONG> <EM>width</EM> + changes the output to <EM>width</EM> characters. + + <STRONG>-x</STRONG> print information for user-defined capabilities. + These are extensions to the terminfo repertoire which + can be loaded using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo Compiled terminal description + database. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + The <STRONG>-E</STRONG>, <STRONG>-F</STRONG>, <STRONG>-G</STRONG>, <STRONG>-R</STRONG>, <STRONG>-T</STRONG>, <STRONG>-V</STRONG>, <STRONG>-a</STRONG>, <STRONG>-e</STRONG>, <STRONG>-f</STRONG>, <STRONG>-g</STRONG>, <STRONG>-i</STRONG>, <STRONG>-l</STRONG>, <STRONG>-p</STRONG>, <STRONG>-q</STRONG> + and <STRONG>-t</STRONG> options are not supported in SVr4 curses. + + The <STRONG>-r</STRONG> option's notion of `termcap' capabilities is System + V Release 4's. Actual BSD curses versions will have a + more restricted set. To see only the 4.4BSD set, use <STRONG>-r</STRONG> + <STRONG>-RBSD</STRONG>. + + +</PRE> +<H2>BUGS</H2><PRE> + The <STRONG>-F</STRONG> option of <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> should be a <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> mode. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>, <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>, + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + +</PRE> +<H2>AUTHOR</H2><PRE> + Eric S. Raymond <esr@snark.thyrsus.com> and + Thomas E. Dickey <dickey@invisible-island.net> + + + + <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/infotocap.1m.html b/doc/html/man/infotocap.1m.html new file mode 100644 index 000000000000..a8c7267ad682 --- /dev/null +++ b/doc/html/man/infotocap.1m.html @@ -0,0 +1,115 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1999-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: infotocap.1m,v 1.11 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>infotocap 1m</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>infotocap 1m</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG> <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>infotocap</STRONG> - convert a <EM>terminfo</EM> description into a <EM>termcap</EM> + description + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>infotocap</STRONG> [<STRONG>-v</STRONG><EM>n</EM> <EM>width</EM>] [<STRONG>-V</STRONG>] [<STRONG>-1</STRONG>] [<STRONG>-w</STRONG> <EM>width</EM>] <EM>file</EM> . . . + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>infotocap</STRONG> looks in each given text <EM>file</EM> for <STRONG>terminfo</STRONG> + descriptions. For each terminfo description found, an + equivalent <STRONG>termcap</STRONG> description is written to standard out- + put. Terminfo <STRONG>use</STRONG> capabilities are translated directly to + termcap <STRONG>tc</STRONG> capabilities. + + <STRONG>-v</STRONG> print out tracing information on standard error as + the program runs. + + <STRONG>-V</STRONG> print out the version of the program in use on stan- + dard error and exit. + + <STRONG>-1</STRONG> cause the fields to print out one to a line. Other- + wise, the fields will be printed several to a line to + a maximum width of 60 characters. + + <STRONG>-w</STRONG> change the output to <EM>width</EM> characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo Compiled terminal description + database. + + +</PRE> +<H2>NOTES</H2><PRE> + This utility is actually a link to <EM>tic</EM>, running in <EM>-C</EM> + mode. You can use other <EM>tic</EM> options such as <STRONG>-f</STRONG> and <STRONG>-x</STRONG>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + +</PRE> +<H2>AUTHOR</H2><PRE> + Eric S. Raymond <esr@snark.thyrsus.com> and + Thomas E. Dickey <dickey@invisible-island.net> + + + + <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/key_defined.3x.html b/doc/html/man/key_defined.3x.html new file mode 100644 index 000000000000..ee6126b9bd74 --- /dev/null +++ b/doc/html/man/key_defined.3x.html @@ -0,0 +1,103 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2003-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 2003 + * @Id: key_defined.3x,v 1.6 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>key_defined 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>key_defined 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>key_defined</STRONG> - check if a keycode is defined + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>key_defined(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to determine if a string is currently bound to + any keycode. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + If the string is bound to a keycode, its value (greater + than zero) is returned. If no keycode is bound, zero is + returned. If the string conflicts with longer strings + which are bound to keys, -1 is returned. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/keybound.3x.html b/doc/html/man/keybound.3x.html new file mode 100644 index 000000000000..5b54466bd900 --- /dev/null +++ b/doc/html/man/keybound.3x.html @@ -0,0 +1,105 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1999-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1999 + * @Id: keybound.3x,v 1.8 2010/12/04 18:49:20 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>keybound 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>keybound 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>keybound</STRONG> - return definition of keycode + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to determine the string which is defined in + the terminfo for specific keycodes. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The <EM>keycode</EM> parameter must be greater than zero, else NULL + is returned. If it does not correspond to a defined key, + then NULL is returned. The <EM>count</EM> parameter is used to + allow the application to iterate through multiple defini- + tions, counting from zero. When successful, the function + returns a string which must be freed by the caller. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/keyok.3x.html b/doc/html/man/keyok.3x.html new file mode 100644 index 000000000000..d2b0be1719c2 --- /dev/null +++ b/doc/html/man/keyok.3x.html @@ -0,0 +1,105 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1997 + * @Id: keyok.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>keyok 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>keyok 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>keyok</STRONG> - enable or disable a keycode + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to disable specific keycodes, rather than use + the <EM>keypad</EM> function to disable all keycodes. Keys that + have been disabled can be re-enabled. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The keycode must be greater than zero, else ERR is + returned. If it does not correspond to a defined key, + then ERR is returned. If the <EM>enable</EM> parameter is true, + then the key must have been disabled, and vice versa. + Otherwise, the function returns OK. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/legacy_coding.3x.html b/doc/html/man/legacy_coding.3x.html new file mode 100644 index 000000000000..03eea8b6cc2a --- /dev/null +++ b/doc/html/man/legacy_coding.3x.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2005-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey + * @Id: legacy_coding.3x,v 1.4 2010/12/04 18:49:20 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>legacy_coding 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>legacy_coding 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG> <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>use_legacy_coding</STRONG> - use terminal's default colors + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>use_legacy_coding(int</STRONG> <STRONG>level);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <EM>use</EM><STRONG>_</STRONG><EM>legacy</EM><STRONG>_</STRONG><EM>coding()</EM> function is an extension to the + curses library. It allows the caller to change the result + of <STRONG>unctrl</STRONG>, and suppress related checks within the library + that would normally cause nonprinting characters to be + rendered in visible form. This affects only 8-bit charac- + ters. + + The <EM>level</EM> parameter controls the result: + + 0 the library functions normally, rendering non- + printing characters as described in <STRONG>unctrl</STRONG>. + + 1 the library ignores <STRONG>isprintf</STRONG> for codes in the + range 160-255. + + 2 the library ignores <STRONG>isprintf</STRONG> for codes in the + range 128-255. It also modifies the output of + <STRONG>unctrl</STRONG>, showing codes in the range 128-159 as + is. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + If the screen has not been initialized, or the <EM>level</EM> + parameter is out of range, the function returns <STRONG>ERR</STRONG>. Oth- + erwise, it returns the previous level: <STRONG>0</STRONG>, <STRONG>1</STRONG> or <STRONG>2</STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + This routine is specific to ncurses. It was not supported + on Version 7, BSD or System V implementations. It is rec- + ommended that any code depending on ncurses extensions be + conditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG>unctrl</STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (to support lynx's font-switching feature). + + + + <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu.3x.html b/doc/html/man/menu.3x.html new file mode 100644 index 000000000000..1e6d95a2f037 --- /dev/null +++ b/doc/html/man/menu.3x.html @@ -0,0 +1,241 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu.3x,v 1.21 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu</STRONG> - curses extension for programming menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>menu</STRONG> library provides terminal-independent facilities + for composing menu systems on character-cell terminals. + The library includes: item routines, which create and mod- + ify menu items; and menu routines, which group items into + menus, display menus on the screen, and handle interaction + with the user. + + The <STRONG>menu</STRONG> library uses the <STRONG>curses</STRONG> libraries, and a curses + initialization routine such as <STRONG>initscr</STRONG> must be called + before using any of these functions. To use the <STRONG>menu</STRONG> + library, link with the options <STRONG>-lmenu</STRONG> <STRONG>-lcurses</STRONG>. + + <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Item</STRONG> <STRONG>Attributes</STRONG> + The <STRONG>menu</STRONG> library maintains a default value for item + attributes. You can get or set this default by calling + the appropriate <STRONG>get_</STRONG> or <STRONG>set_</STRONG> routine with a <STRONG>NULL</STRONG> item + pointer. Changing this default with a <STRONG>set_</STRONG> function + affects future item creations, but does not change the + rendering of items already created. + + <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG> + The following table lists each <STRONG>menu</STRONG> routine and the name + of the manual page on which it is described. + + <STRONG>curses</STRONG> Routine Name Manual Page Name + -------------------------------------------- + current_item <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + free_item <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> + free_menu <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG> + item_count <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> + item_description <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG> + item_index <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + item_init <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + item_name <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG> + item_opts <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> + item_opts_off <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> + item_opts_on <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> + item_term <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + item_userptr <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG> + item_value <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG> + item_visible <STRONG><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></STRONG> + menu_back <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + menu_driver <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> + menu_fore <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + menu_format <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> + menu_grey <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + menu_init <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + menu_items <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> + menu_mark <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> + menu_opts <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> + menu_opts_off <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> + menu_opts_on <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> + menu_pad <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + menu_pattern <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> + + menu_request_by_name <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> + menu_request_name <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> + menu_spacing <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> + menu_sub <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> + menu_term <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + menu_userptr <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> + menu_win <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> + new_item <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> + new_menu <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG> + pos_menu_cursor <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG> + post_menu <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> + scale_menu <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> + set_current_item <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + set_item_init <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + set_item_opts <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> + set_item_term <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + set_item_userptr <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG> + set_item_value <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG> + set_menu_back <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + set_menu_fore <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + set_menu_format <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> + set_menu_grey <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + set_menu_init <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + set_menu_items <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> + set_menu_mark <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> + set_menu_opts <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> + set_menu_pad <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + set_menu_pattern <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> + set_menu_spacing <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> + set_menu_sub <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> + set_menu_term <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + set_menu_userptr <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> + set_menu_win <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> + set_top_row <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + top_row <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + unpost_menu <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou- + tines that return an integer return one of the following + error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NO_MATCH</STRONG> + Character failed to match. + + <STRONG>E_NO_ROOM</STRONG> + Menu is too large for its window. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + <STRONG>E_NOT_POSTED</STRONG> + The menu has not been posted. + + <STRONG>E_NOT_SELECTABLE</STRONG> + The designated item cannot be selected. + + <STRONG>E_POSTED</STRONG> + The menu is already posted. + + <STRONG>E_REQUEST_DENIED</STRONG> + The menu driver could not process the request. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_UNKNOWN_COMMAND</STRONG> + The menu driver code saw an unknown request code. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + files <STRONG><curses.h></STRONG> and <STRONG><eti.h></STRONG>. + + In your library list, libmenu.a should be before libn- + curses.a; that is, you want to say `-lmenu -lncurses', not + the other way around (which would usually give a link- + error). + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for ncurses + by Eric S. Raymond. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_attributes.3x.html b/doc/html/man/menu_attributes.3x.html new file mode 100644 index 000000000000..c02a4ab38de5 --- /dev/null +++ b/doc/html/man/menu_attributes.3x.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_attributes 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_attributes 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_attributes</STRONG> - color and attribute control for menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_fore(MENU *menu, chtype attr); + chtype menu_fore(const MENU *menu); + int set_menu_back(MENU *menu, chtype attr); + chtype menu_back(const MENU *menu); + int set_menu_grey(MENU *menu, chtype attr); + chtype menu_grey(const MENU *menu); + int set_menu_pad(MENU *menu, int pad); + int menu_pad(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_menu_fore</STRONG> sets the foreground attribute + of <EM>menu</EM>. This is the highlight used for selected menu + items. <STRONG>menu_fore</STRONG> returns the foreground attribute. The + default is <STRONG>A_REVERSE</STRONG>. + + The function <STRONG>set_menu_back</STRONG> sets the background attribute + of <EM>menu</EM>. This is the highlight used for selectable (but + not currently selected) menu items. The function + <STRONG>menu_back</STRONG> returns the background attribute. The default + is <STRONG>A_NORMAL</STRONG>. + + The function <STRONG>set_menu_grey</STRONG> sets the grey attribute of + <EM>menu</EM>. This is the highlight used for un-selectable menu + items in menus that permit more than one selection. The + function <STRONG>menu_grey</STRONG> returns the grey attribute. The + default is <STRONG>A_UNDERLINE</STRONG>. + + The function <STRONG>set_menu_pad</STRONG> sets the character used to fill + the space between the name and description parts of a menu + item. <STRONG>menu_pad</STRONG> returns the given menu's pad character. + The default is a blank. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_cursor.3x.html b/doc/html/man/menu_cursor.3x.html new file mode 100644 index 000000000000..be4f42998807 --- /dev/null +++ b/doc/html/man/menu_cursor.3x.html @@ -0,0 +1,117 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_cursor.3x,v 1.8 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_cursor 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_cursor 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG> <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_cursor</STRONG> - position a menu's cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int pos_menu_cursor(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>pos_menu_cursor</STRONG> restores the cursor to the + current position associated with the menu's selected item. + This is useful after <STRONG>curses</STRONG> routines have been called to + do screen-painting in response to a menu select. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + This routine returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_NOT_POSTED</STRONG> + The menu has not been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html new file mode 100644 index 000000000000..f2b6c16c715f --- /dev/null +++ b/doc/html/man/menu_driver.3x.html @@ -0,0 +1,255 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_driver 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_driver 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_driver</STRONG> - command-processing loop of the menu system + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int menu_driver(MENU *menu, int c); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Once a menu has been posted (displayed), you should funnel + input events to it through <STRONG>menu_driver</STRONG>. This routine has + three major input cases: + + <STRONG>o</STRONG> The input is a form navigation request. Navigation + request codes are constants defined in <STRONG><form.h></STRONG>, which + are distinct from the key- and character codes + returned by <STRONG>wgetch</STRONG>. + + <STRONG>o</STRONG> The input is a printable character. Printable charac- + ters (which must be positive, less than 256) are + checked according to the program's locale settings. + + <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with + an mouse event. + + The menu driver requests are as follows: + + REQ_LEFT_ITEM + Move left to an item. + + REQ_RIGHT_ITEM + Move right to an item. + + REQ_UP_ITEM + Move up to an item. + + REQ_DOWN_ITEM + Move down to an item. + + REQ_SCR_ULINE + Scroll up a line. + + REQ_SCR_DLINE + Scroll down a line. + + REQ_SCR_DPAGE + Scroll down a page. + + REQ_SCR_UPAGE + Scroll up a page. + + REQ_FIRST_ITEM + Move to the first item. + + REQ_LAST_ITEM + Move to the last item. + + REQ_NEXT_ITEM + Move to the next item. + + REQ_PREV_ITEM + Move to the previous item. + + REQ_TOGGLE_ITEM + Select/deselect an item. + + REQ_CLEAR_PATTERN + Clear the menu pattern buffer. + + REQ_BACK_PATTERN + Delete the previous character from the pattern + buffer. + + REQ_NEXT_MATCH + Move to the next item matching the pattern match. + + REQ_PREV_MATCH + Move to the previous item matching the pattern match. + + If the second argument is a printable character, the code + appends it to the pattern buffer and attempts to move to + the next item matching the new pattern. If there is no + such match, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG> and deletes the + appended character from the buffer. + + If the second argument is one of the above pre-defined + requests, the corresponding action is performed. + + <STRONG>MOUSE</STRONG> <STRONG>HANDLING</STRONG> + If the second argument is the KEY_MOUSE special key, the + associated mouse event is translated into one of the above + pre-defined requests. Currently only clicks in the user + window (e.g., inside the menu display area or the decora- + tion window) are handled. + + If you click above the display region of the menu: + + <STRONG>o</STRONG> a REQ_SCR_ULINE is generated for a single click, + + <STRONG>o</STRONG> a REQ_SCR_UPAGE is generated for a double-click and + + <STRONG>o</STRONG> a REQ_FIRST_ITEM is generated for a triple-click. + + If you click below the display region of the menu: + + <STRONG>o</STRONG> a REQ_SCR_DLINE is generated for a single click, + + <STRONG>o</STRONG> a REQ_SCR_DPAGE is generated for a double-click and + + <STRONG>o</STRONG> a REQ_LAST_ITEM is generated for a triple-click. + + If you click at an item inside the display area of the + menu: + + <STRONG>o</STRONG> the menu cursor is positioned to that item. + + <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is gen- + erated and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return + value makes sense, because a double click usually + means that an item-specific action should be returned. + It is exactly the purpose of this return value to sig- + nal that an application specific command should be + executed. + + <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG> + returns the result of this request. + + If you clicked outside the user window or the mouse event + could not be translated into a menu request an + <STRONG>E_REQUEST_DENIED</STRONG> is returned. + + <STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG> + If the second argument is neither printable nor one of the + above pre-defined menu requests or KEY_MOUSE, the drive + assumes it is an application-specific command and returns + <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands should be + defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of + these pre-defined requests. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>menu_driver</STRONG> return one of the following error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NOT_POSTED</STRONG> + The menu has not been posted. + + <STRONG>E_UNKNOWN_COMMAND</STRONG> + The menu driver code saw an unknown request code. + + <STRONG>E_NO_MATCH</STRONG> + Character failed to match. + + <STRONG>E_REQUEST_DENIED</STRONG> + The menu driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>, <STRONG><A HREF="getch.3x.html">getch(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + files <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. The sup- + port for mouse events is ncurses specific. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_format.3x.html b/doc/html/man/menu_format.3x.html new file mode 100644 index 000000000000..c419406c35e4 --- /dev/null +++ b/doc/html/man/menu_format.3x.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_format.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_format 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_format 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_format</STRONG> - set and get menu sizes + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_format(MENU *menu, int rows, int cols); + void menu_format(const MENU *menu, int *rows, int *cols); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_menu_format</STRONG> sets the maximum display size + of the given menu. If this size is too small to display + all menu items, the menu will be made scrollable. If this + size is larger than the menus subwindow and the subwindow + is too small to display all menu items, <STRONG>post_menu()</STRONG> will + fail. + + The default format is 16 rows, 1 column. Calling + <STRONG>set_menu_format</STRONG> with a null menu pointer will change this + default. A zero row or column argument to <STRONG>set_menu_format</STRONG> + is interpreted as a request not to change the current + value. + + The function <STRONG>menu_format</STRONG> returns the maximum-size con- + straints for the given menu into the storage addressed by + <STRONG>rows</STRONG> and <STRONG>cols</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The menu is already posted. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_hook.3x.html b/doc/html/man/menu_hook.3x.html new file mode 100644 index 000000000000..6a57ac7f8c72 --- /dev/null +++ b/doc/html/man/menu_hook.3x.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_hook 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_hook 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_hook</STRONG> - set hooks for automatic invocation by applica- + tions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_item_init(MENU *menu, Menu_Hook func); + Menu_Hook item_init(const MENU *menu); + int set_item_term(MENU *menu, Menu_Hook func); + Menu_Hook item_term(const MENU *menu); + int set_menu_init(MENU *menu, Menu_Hook func); + Menu_Hook menu_init(const MENU *menu); + int set_menu_term(MENU *menu, Menu_Hook func); + Menu_Hook menu_term(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions make it possible to set hook functions to + be called at various points in the automatic processing of + input event codes by <STRONG>menu_driver</STRONG>. + + The function <STRONG>set_item_init</STRONG> sets a hook to be called at + menu-post time and each time the selected item changes + (after the change). <STRONG>item_init</STRONG> returns the current item + init hook, if any (<STRONG>NULL</STRONG> if there is no such hook). + + The function <STRONG>set_item_term</STRONG> sets a hook to be called at + menu-unpost time and each time the selected item changes + (before the change). <STRONG>item_term</STRONG> returns the current item + term hook, if any (<STRONG>NULL</STRONG> if there is no such hook). + + The function <STRONG>set_menu_init</STRONG> sets a hook to be called at + menu-post time and just after the top row on the menu + changes once it is posted. <STRONG>menu_init</STRONG> returns the current + menu init hook, if any (<STRONG>NULL</STRONG> if there is no such hook). + + The function <STRONG>set_menu_term</STRONG> sets a hook to be called at + menu-unpost time and just before the top row on the menu + changes once it is posted. <STRONG>menu_term</STRONG> returns the current + menu term hook, if any (<STRONG>NULL</STRONG> if there is no such hook). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error. Other + routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_items.3x.html b/doc/html/man/menu_items.3x.html new file mode 100644 index 000000000000..322247a68118 --- /dev/null +++ b/doc/html/man/menu_items.3x.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_items.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_items 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_items 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_items</STRONG> - make and break connections between items and + menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_items(MENU *menu, ITEM **items); + ITEM **menu_items(const MENU *menu); + int item_count(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_menu_items</STRONG> changes the item pointer array + of the given <EM>menu</EM>. The array must be terminated by a + <STRONG>NULL</STRONG>. + + The function <STRONG>menu_items</STRONG> returns the item array of the + given menu. + + The function <STRONG>item_count</STRONG> returns the count of items in + <EM>menu</EM>. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + The function <STRONG>menu_items</STRONG> returns a pointer (which may be + <STRONG>NULL</STRONG>). It does not set errno. + + The function <STRONG>item_count</STRONG> returns <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> + error return value) if its <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. + + The function <STRONG>set_menu_items</STRONG> returns one of the following + codes on error: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + <STRONG>E_POSTED</STRONG> + The menu is already posted. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The SVr4 menu library documentation specifies the + <STRONG>item_count</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_items.3x.html">menu_items(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_mark.3x.html b/doc/html/man/menu_mark.3x.html new file mode 100644 index 000000000000..bdeaec695844 --- /dev/null +++ b/doc/html/man/menu_mark.3x.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_mark.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_mark 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_mark 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_mark</STRONG> - get and set the menu mark string + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_mark(MENU *menu, const char *mark); + const char *menu_mark(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + In order to make menu selections visible on older termi- + nals without highlighting or color capability, the menu + library marks selected items in a menu with a prefix + string. + + The function <STRONG>set_menu_mark</STRONG> sets the mark string for the + given menu. Calling <STRONG>set_menu_mark</STRONG> with a null menu item + will abolish the mark string. Note that changing the + length of the mark string for a menu while the menu is + posted is likely to produce unhelpful behavior. + + The default string is "-" (a dash). Calling <STRONG>set_menu_mark</STRONG> + with a non-<STRONG>NULL</STRONG> menu argument will change this default. + + The function <STRONG>menu_mark</STRONG> returns the menu's mark string (or + <STRONG>NULL</STRONG> if there is none). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>menu_mark</STRONG> returns a pointer (which may be + <STRONG>NULL</STRONG>). It does not set errno. + + The function <STRONG>set_menu_mark</STRONG> may return the following error + codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_new.3x.html b/doc/html/man/menu_new.3x.html new file mode 100644 index 000000000000..fde5fcc17edf --- /dev/null +++ b/doc/html/man/menu_new.3x.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_new.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_new 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_new 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG> <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_new</STRONG> - create and destroy menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + MENU *new_menu(ITEM **items); + int free_menu(MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>new_menu</STRONG> creates a new menu connected to a + specified item pointer array (which must be <STRONG>NULL</STRONG>-termi- + nated). + + The function <STRONG>free_menu</STRONG> disconnects <EM>menu</EM> from its item + array and frees the storage allocated for the menu. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>new_menu</STRONG> returns <STRONG>NULL</STRONG> on error. It sets + errno according to the function's failure: + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred, e.g., malloc failure. + + The function <STRONG>free_menu</STRONG> returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The menu has already been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_new.3x.html">menu_new(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_opts.3x.html b/doc/html/man/menu_opts.3x.html new file mode 100644 index 000000000000..7853d4e62bc8 --- /dev/null +++ b/doc/html/man/menu_opts.3x.html @@ -0,0 +1,148 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_opts.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_opts 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_opts 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_opts</STRONG> - set and get menu options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_opts(MENU *menu, Menu_Options opts); + int menu_opts_on(MENU *menu, Menu_Options opts); + int menu_opts_off(MENU *menu, Menu_Options opts); + Menu_Options menu_opts(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_menu_opts</STRONG> sets all the given menu's + option bits (menu option bits may be logically-OR'ed + together). + + The function <STRONG>menu_opts_on</STRONG> turns on the given option bits, + and leaves others alone. + + The function <STRONG>menu_opts_off</STRONG> turns off the given option + bits, and leaves others alone. + + The function <STRONG>menu_opts</STRONG> returns the menu's current option + bits. + + The following options are defined (all are on by default): + + O_ONEVALUE + Only one item can be selected for this menu. + + O_SHOWDESC + Display the item descriptions when the menu is + posted. + + O_ROWMAJOR + Display the menu in row-major order. + + O_IGNORECASE + Ignore the case when pattern-matching. + + O_SHOWMATCH + Move the cursor to within the item name while pat- + tern-matching. + + O_NONCYCLIC + Don't wrap around next-item and previous-item, + requests to the other end of the menu. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol- + lowing: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_POSTED</STRONG> + The menu is already posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html new file mode 100644 index 000000000000..88e6cdb9534d --- /dev/null +++ b/doc/html/man/menu_pattern.3x.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_pattern 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_pattern 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_pattern</STRONG> - get and set a menu's pattern buffer + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_pattern(MENU *menu, const char *pattern); + char *menu_pattern(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu has an associated pattern match buffer. As + input events that are printable characters come in, they + are appended to this match buffer and tested for a match, + as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>. + + The function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer for + the given menu and tries to find the first matching item. + If it succeeds, that item becomes current; if not, the + current item does not change. + + The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of + the given <EM>menu</EM>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG> + if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. Otherwise, it is a pointer + to a string which is empty if no pattern has been set. It + does not set errno. + + The function <STRONG>set_menu_pattern</STRONG> may return the following + error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to menu. + + <STRONG>E_NO_MATCH</STRONG> + Character failed to match. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_post.3x.html b/doc/html/man/menu_post.3x.html new file mode 100644 index 000000000000..b8715f230690 --- /dev/null +++ b/doc/html/man/menu_post.3x.html @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_post.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_post 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_post 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_post</STRONG> - write or erase menus from associated subwin- + dows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int post_menu(MENU *menu); + int unpost_menu(MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>post_menu</STRONG> displays a menu to its associated + subwindow. To trigger physical display of the subwindow, + use <STRONG>refresh</STRONG> or some equivalent <STRONG>curses</STRONG> routine (the + implicit <STRONG>doupdate</STRONG> triggered by an <STRONG>curses</STRONG> input request + will do). <STRONG>post_menu</STRONG> resets the selection status of all + items. + + The function <STRONG>unpost_menu</STRONG> erases menu from its associated + subwindow. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The menu has already been posted. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NO_ROOM</STRONG> + Menu is too large for its window. You should consider + to use <STRONG>set_menu_format()</STRONG> to solve the problem. + + <STRONG>E_NOT_POSTED</STRONG> + The menu has not been posted. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_requestname.3x.html b/doc/html/man/menu_requestname.3x.html new file mode 100644 index 000000000000..54926fd2d1c0 --- /dev/null +++ b/doc/html/man/menu_requestname.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_requestname.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_requestname 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_requestname 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_requestname</STRONG> - handle printable menu request names + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + const char *menu_request_name(int request); + int menu_request_by_name(const char *name); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>menu_request_name</STRONG> returns the printable name + of a menu request code. + The function <STRONG>menu_request_by_name</STRONG> searches in the name-ta- + ble for a request with the given name and returns its + request code. Otherwise E_NO_MATCH is returned. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>menu_request_name</STRONG> returns <STRONG>NULL</STRONG> on error and sets errno to + <STRONG>E_BAD_ARGUMENT</STRONG>. + <STRONG>menu_request_by_name</STRONG> returns <STRONG>E_NO_MATCH</STRONG> on error. It does + not set errno. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_spacing.3x.html b/doc/html/man/menu_spacing.3x.html new file mode 100644 index 000000000000..82e857562fdf --- /dev/null +++ b/doc/html/man/menu_spacing.3x.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2004,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_spacing 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_spacing 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_spacing</STRONG> - Control spacing between menu items. + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_spacing(MENU *menu, + int spc_description, + int spc_rows, + int spc_columns); + int menu_spacing(const MENU *menu, + int* spc_description, + int* spc_rows, + int* spc_columns); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_menu_spacing</STRONG> sets the spacing information + for the menu. Its parameter <STRONG>spc_description</STRONG> controls the + number of spaces between an item name and an item descrip- + tion. It must not be larger than <STRONG>TABSIZE</STRONG>. The menu sys- + tem puts in the middle of this spacing area the pad char- + acter. The remaining parts are filled with spaces. The + <STRONG>spc_rows</STRONG> parameter controls the number of rows that are + used for an item. It must not be larger than 3. The menu + system inserts the blank lines between item rows, these + lines will contain the pad character in the appropriate + positions. The <STRONG>spc_columns</STRONG> parameter controls the number + of blanks between columns of items. It must not be larger + than TABSIZE. A value of 0 for all the spacing values + resets them to the default, which is 1 for all of them. + The function <STRONG>menu_spacing</STRONG> passes back the spacing info for + the menu. If a pointer is NULL, this specific info is + simply not returned. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Both routines return <STRONG>E_OK</STRONG> on success. <STRONG>set_menu_spacing</STRONG> + may return <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGU-</STRONG> + <STRONG>MENT</STRONG> if one of the spacing values is out of range. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_userptr.3x.html b/doc/html/man/menu_userptr.3x.html new file mode 100644 index 000000000000..be4f7d0d555f --- /dev/null +++ b/doc/html/man/menu_userptr.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_userptr.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_userptr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_userptr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_userptr</STRONG> - associate application data with a menu item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_userptr(MENU *menu, void *userptr); + void *menu_userptr(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu and every menu item has a field that can be + used to hold application-specific data (that is, the menu- + driver code leaves it alone). These functions get and set + the menu user pointer field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>menu_userptr</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It + does not set errno. + + <STRONG>set_menu_userptr</STRONG> returns <STRONG>E_OK</STRONG> (success). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The user pointer is a void pointer. We chose not to leave + it as a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/menu_win.3x.html b/doc/html/man/menu_win.3x.html new file mode 100644 index 000000000000..64e685edfb11 --- /dev/null +++ b/doc/html/man/menu_win.3x.html @@ -0,0 +1,139 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_win.3x,v 1.11 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_win 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_win 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_win</STRONG> - make and break menu window and subwindow asso- + ciations + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_win(MENU *menu, WINDOW *win); + WINDOW *menu_win(const MENU *menu); + int set_menu_sub(MENU *menu, WINDOW *sub); + WINDOW *menu_sub(const MENU *menu); + int scale_menu(const MENU *menu, int *rows, int *columns); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu has an associated pair of <STRONG>curses</STRONG> windows. The + menu window displays any title and border associated with + the window; the menu subwindow displays the items of the + menu that are currently available for selection. + + The first four functions get and set those windows. It is + not necessary to set either window; by default, the driver + code uses <STRONG>stdscr</STRONG> for both. + + In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated + as though it were <STRONG>stsdcr</STRONG>. A menu argument of <STRONG>NULL</STRONG> is + treated as a request to change the system default menu + window or subwindow. + + The function <STRONG>scale_menu</STRONG> returns the minimum size required + for the subwindow of <EM>menu</EM>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou- + tines that return an integer return one of the following + error codes: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The menu has already been posted. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_current.3x.html b/doc/html/man/mitem_current.3x.html new file mode 100644 index 000000000000..d496682c7224 --- /dev/null +++ b/doc/html/man/mitem_current.3x.html @@ -0,0 +1,146 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_current.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_current 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_current 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_current</STRONG> - set and get current_menu_item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_current_item(MENU *menu, const ITEM *item); + ITEM *current_item(const MENU *menu); + int set_top_row(MENU *menu, int row); + int top_row(const MENU *menu); + int item_index(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_current_item</STRONG> sets the current item (the + item on which the menu cursor is positioned). <STRONG>cur-</STRONG> + <STRONG>rent_item</STRONG> returns a pointer to the current item in the + given menu. + + The function <STRONG>set_top_row</STRONG> sets the top row of the menu to + show the given row (the top row is initially 0, and is + reset to this value whenever the <STRONG>O_ROWMAJOR</STRONG> option is tog- + gled). The item leftmost on the given row becomes cur- + rent. The function <STRONG>top_row</STRONG> returns the number of the top + menu row being displayed. + + The function <STRONG>item_index</STRONG> returns the (zero-origin) index of + <EM>item</EM> in the menu's item pointer list. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <STRONG>current_item</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It + does not set errno. + + <STRONG>top_row</STRONG> and <STRONG>item_index</STRONG> return <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> + error value) if their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. + + <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the follow- + ing: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_BAD_STATE</STRONG> + Routine was called from an initialization or termina- + tion function. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The SVr4 menu library documentation specifies the <STRONG>top_row</STRONG> + and <STRONG>index_item</STRONG> error value as -1 (which is the value of + <STRONG>ERR</STRONG>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_name.3x.html b/doc/html/man/mitem_name.3x.html new file mode 100644 index 000000000000..e596bbf2fab4 --- /dev/null +++ b/doc/html/man/mitem_name.3x.html @@ -0,0 +1,107 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_name.3x,v 1.8 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_name 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_name 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG> <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_name</STRONG> - get menu item name and description fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + const char *item_name(const ITEM *item); + const char *item_description(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>item_name</STRONG> returns the name part of the given + item. + The function <STRONG>item_description</STRONG> returns the description part + of the given item. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return a pointer (which may be <STRONG>NULL</STRONG>). They + do not set errno. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_name.3x.html">mitem_name(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html new file mode 100644 index 000000000000..4b6e1f378ba4 --- /dev/null +++ b/doc/html/man/mitem_new.3x.html @@ -0,0 +1,134 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_new.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_new 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_new 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_new</STRONG> - create and destroy menu items + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + ITEM *new_item(const char *name, const char *description); + int free_item(ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>new_item</STRONG> allocates a new item and initializes + it from the <STRONG>name</STRONG> and <STRONG>description</STRONG> pointers. Please notice + that the item stores only the pointers to the name and + description. Those pointers must be valid during the life- + time of the item. So you should be very careful with names + or descriptions allocated on the stack of some routines. + The function <STRONG>free_item</STRONG> de-allocates an item. Please notice + that it is the responsibility of the application to + release the memory for the name or the description of the + item. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>new_item</STRONG> returns <STRONG>NULL</STRONG> on error. It sets + errno according to the function's failure: + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred, e.g., malloc failure. + + The function <STRONG>free_item</STRONG> returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_CONNECTED</STRONG> + Item is connected to a menu. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_new.3x.html">mitem_new(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_opts.3x.html b/doc/html/man/mitem_opts.3x.html new file mode 100644 index 000000000000..27d44a5b0f9e --- /dev/null +++ b/doc/html/man/mitem_opts.3x.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_opts 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_opts 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_opts</STRONG> - set and get menu item options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_item_opts(ITEM *item, Item_Options opts); + int item_opts_on(ITEM *item, Item_Options opts); + int item_opts_off(ITEM *item, Item_Options opts); + Item_Options item_opts(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_item_opts</STRONG> sets all the given item's + option bits (menu option bits may be logically-OR'ed + together). + + The function <STRONG>item_opts_on</STRONG> turns on the given option bits, + and leaves others alone. + + The function <STRONG>item_opts_off</STRONG> turns off the given option + bits, and leaves others alone. + + The function <STRONG>item_opts</STRONG> returns the item's current option + bits. + + There is only one defined option bit mask, <STRONG>O_SELECTABLE</STRONG>. + When this is on, the item may be selected during menu pro- + cessing. This option defaults to on. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <STRONG>item_opts</STRONG>, each routine returns one of the fol- + lowing: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_userptr.3x.html b/doc/html/man/mitem_userptr.3x.html new file mode 100644 index 000000000000..5cc957efc98c --- /dev/null +++ b/doc/html/man/mitem_userptr.3x.html @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_userptr.3x,v 1.11 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_userptr 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_userptr 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG> <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_userptr</STRONG> - associate application data with a menu + item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_item_userptr(ITEM *item, void *userptr); + void *item_userptr(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu item has a field that can be used to hold + application-specific data (that is, the menu-driver code + leaves it alone). These functions get and set that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>item_userptr</STRONG> returns a pointer (possibly + <STRONG>NULL</STRONG>). It does not set errno. + + The <STRONG>set_item_userptr</STRONG> always returns <STRONG>E_OK</STRONG> (success). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The user pointer is a void pointer. We chose not to leave + it as a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_value.3x.html b/doc/html/man/mitem_value.3x.html new file mode 100644 index 000000000000..e68a2b0a3b10 --- /dev/null +++ b/doc/html/man/mitem_value.3x.html @@ -0,0 +1,117 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_value.3x,v 1.10 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_value 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_value 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG> <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_value</STRONG> - set and get menu item values + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_item_value(ITEM *item, bool value); + bool item_value(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + If you turn off the menu option <STRONG>O_ONEVALUE</STRONG> (e.g., with + <STRONG>set_menu_opts</STRONG> or <STRONG>menu_opts_off</STRONG>; see <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>), the + menu becomes multi-valued; that is, more than one item may + simultaneously be selected. + + In a multi_valued menu, you can used <STRONG>set_item_value</STRONG> to + select the given menu item (second argument <STRONG>TRUE</STRONG>) or dese- + lect it (second argument <STRONG>FALSE</STRONG>). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <STRONG>set_item_value</STRONG> returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_REQUEST_DENIED</STRONG> + The menu driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/mitem_visible.3x.html b/doc/html/man/mitem_visible.3x.html new file mode 100644 index 000000000000..52cdbdbe2b10 --- /dev/null +++ b/doc/html/man/mitem_visible.3x.html @@ -0,0 +1,100 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: mitem_visible.3x,v 1.7 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>mitem_visible 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>mitem_visible 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></STRONG> <STRONG><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>mitem_visible</STRONG> - check visibility of a menu item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + bool item_visible(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + A menu item is visible when it is in the portion of a + posted menu that is mapped onto the screen (if the menu is + scrollable, in particular, this portion will be smaller + than the whole menu). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html new file mode 100644 index 000000000000..57f28a07111c --- /dev/null +++ b/doc/html/man/ncurses.3x.html @@ -0,0 +1,1267 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: ncurses.3x,v 1.103 2011/02/05 23:21:29 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>ncurses 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>ncurses 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>ncurses</STRONG> - CRT screen handling and optimization package + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>ncurses</STRONG> library routines give the user a terminal- + independent method of updating character screens with rea- + sonable optimization. This implementation is ``new + curses'' (ncurses) and is the approved replacement for + 4.4BSD classic curses, which has been discontinued. This + describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + The <STRONG>ncurses</STRONG> library emulates the curses library of System + V Release 4 UNIX, and XPG4 (X/Open Portability Guide) + curses (also known as XSI curses). XSI stands for X/Open + System Interfaces Extension. The <STRONG>ncurses</STRONG> library is + freely redistributable in source form. Differences from + the SVr4 curses are summarized under the <STRONG>EXTENSIONS</STRONG> and + <STRONG>PORTABILITY</STRONG> sections below and described in detail in the + respective <STRONG>EXTENSIONS</STRONG>, <STRONG>PORTABILITY</STRONG> and <STRONG>BUGS</STRONG> sections of + individual man pages. + + The <STRONG>ncurses</STRONG> library also provides many useful extensions, + i.e., features which cannot be implemented by a simple + add-on library but which require access to the internals + of the library. + + A program using these routines must be linked with the + <STRONG>-lncurses</STRONG> option, or (if it has been generated) with the + debugging library <STRONG>-lncurses_g</STRONG>. (Your system integrator + may also have installed these libraries under the names + <STRONG>-lcurses</STRONG> and <STRONG>-lcurses_g</STRONG>.) The ncurses_g library generates + trace logs (in a file called 'trace' in the current direc- + tory) that describe curses actions. See also the section + on <STRONG>ALTERNATE</STRONG> <STRONG>CONFIGURATIONS</STRONG>. + + The <STRONG>ncurses</STRONG> package supports: overall screen, window and + pad manipulation; output to windows and pads; reading ter- + minal input; control over terminal and <STRONG>curses</STRONG> input and + output options; environment query routines; color manipu- + lation; use of soft label keys; terminfo capabilities; and + access to low-level terminal-manipulation routines. + + The library uses the locale which the calling program has + initialized. That is normally done with <STRONG>setlocale</STRONG>: + + <STRONG>setlocale(LC_ALL,</STRONG> <STRONG>"");</STRONG> + + If the locale is not initialized, the library assumes that + characters are printable as in ISO-8859-1, to work with + certain legacy programs. You should initialize the locale + and not rely on specific details of the library when the + locale has not been setup. + + The function <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> must be called to initial- + ize the library before any of the other routines that deal + with windows and screens are used. The routine <STRONG>endwin</STRONG> + must be called before exiting. + + To get character-at-a-time input without echoing (most + interactive, screen oriented programs want this), the fol- + lowing sequence should be used: + + <STRONG>initscr();</STRONG> <STRONG>cbreak();</STRONG> <STRONG>noecho();</STRONG> + + Most programs would additionally use the sequence: + + <STRONG>nonl();</STRONG> + <STRONG>intrflush(stdscr,</STRONG> <STRONG>FALSE);</STRONG> + <STRONG>keypad(stdscr,</STRONG> <STRONG>TRUE);</STRONG> + + Before a <STRONG>curses</STRONG> program is run, the tab stops of the ter- + minal should be set and its initialization strings, if + defined, must be output. This can be done by executing + the <STRONG>tput</STRONG> <STRONG>init</STRONG> command after the shell environment variable + <STRONG>TERM</STRONG> has been exported. <STRONG>tset(1)</STRONG> is usually responsible + for doing this. [See <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for further details.] + + The <STRONG>ncurses</STRONG> library permits manipulation of data struc- + tures, called <EM>windows</EM>, which can be thought of as two- + dimensional arrays of characters representing all or part + of a CRT screen. A default window called <STRONG>stdscr</STRONG>, which is + the size of the terminal screen, is supplied. Others may + be created with <STRONG>newwin</STRONG>. + + Note that <STRONG>curses</STRONG> does not handle overlapping windows, + that's done by the <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> library. This means that you + can either use <STRONG>stdscr</STRONG> or divide the screen into tiled win- + dows and not using <STRONG>stdscr</STRONG> at all. Mixing the two will + result in unpredictable, and undesired, effects. + + Windows are referred to by variables declared as <STRONG>WINDOW</STRONG> <STRONG>*</STRONG>. + These data structures are manipulated with routines + described here and elsewhere in the <STRONG>ncurses</STRONG> manual pages. + Among those, the most basic routines are <STRONG>move</STRONG> and <STRONG>addch</STRONG>. + More general versions of these routines are included with + names beginning with <STRONG>w</STRONG>, allowing the user to specify a + window. The routines not beginning with <STRONG>w</STRONG> affect <STRONG>stdscr</STRONG>. + + After using routines to manipulate a window, <STRONG>refresh</STRONG> is + called, telling <STRONG>curses</STRONG> to make the user's CRT screen look + like <STRONG>stdscr</STRONG>. The characters in a window are actually of + type <STRONG>chtype</STRONG>, (character and attribute data) so that other + information about the character may also be stored with + each character. + + Special windows called <EM>pads</EM> may also be manipulated. + These are windows which are not constrained to the size of + the screen and whose contents need not be completely dis- + played. See <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> for more information. + + In addition to drawing characters on the screen, video + attributes and colors may be supported, causing the char- + acters to show up in such modes as underlined, in reverse + video, or in color on terminals that support such display + enhancements. Line drawing characters may be specified to + be output. On input, <STRONG>curses</STRONG> is also able to translate + arrow and function keys that transmit escape sequences + into single values. The video attributes, line drawing + characters, and input values use names, defined in + <STRONG><curses.h></STRONG>, such as <STRONG>A_REVERSE</STRONG>, <STRONG>ACS_HLINE</STRONG>, and <STRONG>KEY_LEFT</STRONG>. + + If the environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> are set, or + if the program is executing in a window environment, line + and column information in the environment will override + information read by <EM>terminfo</EM>. This would affect a program + running in an AT&T 630 layer, for example, where the size + of a screen is changeable (see <STRONG>ENVIRONMENT</STRONG>). + + If the environment variable <STRONG>TERMINFO</STRONG> is defined, any pro- + gram using <STRONG>curses</STRONG> checks for a local terminal definition + before checking in the standard place. For example, if + <STRONG>TERM</STRONG> is set to <STRONG>att4424</STRONG>, then the compiled terminal defini- + tion is found in + + <STRONG>/usr/share/terminfo/a/att4424</STRONG>. + + (The <STRONG>a</STRONG> is copied from the first letter of <STRONG>att4424</STRONG> to avoid + creation of huge directories.) However, if <STRONG>TERMINFO</STRONG> is + set to <STRONG>$HOME/myterms</STRONG>, <STRONG>curses</STRONG> first checks + + <STRONG>$HOME/myterms/a/att4424</STRONG>, + + and if that fails, it then checks + + <STRONG>/usr/share/terminfo/a/att4424</STRONG>. + + This is useful for developing experimental definitions or + when write permission in <STRONG>/usr/share/terminfo</STRONG> is not avail- + able. + + The integer variables <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> are defined in + <STRONG><curses.h></STRONG> and will be filled in by <STRONG>initscr</STRONG> with the size + of the screen. The constants <STRONG>TRUE</STRONG> and <STRONG>FALSE</STRONG> have the val- + ues <STRONG>1</STRONG> and <STRONG>0</STRONG>, respectively. + + The <STRONG>curses</STRONG> routines also define the <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> variable + <STRONG>curscr</STRONG> which is used for certain low-level operations like + clearing and redrawing a screen containing garbage. The + <STRONG>curscr</STRONG> can be used in only a few routines. + + <STRONG>Routine</STRONG> <STRONG>and</STRONG> <STRONG>Argument</STRONG> <STRONG>Names</STRONG> + Many <STRONG>curses</STRONG> routines have two or more versions. The rou- + tines prefixed with <STRONG>w</STRONG> require a window argument. The rou- + tines prefixed with <STRONG>p</STRONG> require a pad argument. Those with- + out a prefix generally use <STRONG>stdscr</STRONG>. + + The routines prefixed with <STRONG>mv</STRONG> require a <EM>y</EM> and <EM>x</EM> coordinate + to move to before performing the appropriate action. The + <STRONG>mv</STRONG> routines imply a call to <STRONG>move</STRONG> before the call to the + other routine. The coordinate <EM>y</EM> always refers to the row + (of the window), and <EM>x</EM> always refers to the column. The + upper left-hand corner is always (0,0), not (1,1). + + The routines prefixed with <STRONG>mvw</STRONG> take both a window argument + and <EM>x</EM> and <EM>y</EM> coordinates. The window argument is always + specified before the coordinates. + + In each case, <EM>win</EM> is the window affected, and <EM>pad</EM> is the + pad affected; <EM>win</EM> and <EM>pad</EM> are always pointers to type <STRONG>WIN-</STRONG> + <STRONG>DOW</STRONG>. + + Option setting routines require a Boolean flag <EM>bf</EM> with the + value <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>; <EM>bf</EM> is always of type <STRONG>bool</STRONG>. Most of + the data types used in the library routines, such as <STRONG>WIN-</STRONG> + <STRONG>DOW</STRONG>, <STRONG>SCREEN</STRONG>, <STRONG>bool</STRONG>, and <STRONG>chtype</STRONG> are defined in <STRONG><curses.h></STRONG>. + Types used for the terminfo routines such as <STRONG>TERMINAL</STRONG> are + defined in <STRONG><term.h></STRONG>. + + This manual page describes functions which may appear in + any configuration of the library. There are two common + configurations of the library: + + ncurses + the "normal" library, which handles 8-bit + characters. The normal (8-bit) library stores + characters combined with attributes in <STRONG>chtype</STRONG> + data. + + Attributes alone (no corresponding character) + may be stored in <STRONG>chtype</STRONG> or the equivalent + <STRONG>attr_t</STRONG> data. In either case, the data is + stored in something like an integer. + + Each cell (row and column) in a <STRONG>WINDOW</STRONG> is + stored as a <STRONG>chtype</STRONG>. + + ncursesw + the so-called "wide" library, which handles + multibyte characters (see the section on + <STRONG>ALTERNATE</STRONG> <STRONG>CONFIGURATIONS</STRONG>). The "wide" library + includes all of the calls from the "normal" + library. It adds about one third more calls + using data types which store multibyte charac- + ters: + + <STRONG>cchar_t</STRONG> + corresponds to <STRONG>chtype</STRONG>. However it is a + structure, because more data is stored + than can fit into an integer. The char- + acters are large enough to require a full + integer value - and there may be more + than one character per cell. The video + attributes and color are stored in sepa- + rate fields of the structure. + + Each cell (row and column) in a <STRONG>WINDOW</STRONG> is + stored as a <STRONG>cchar_t</STRONG>. + + <STRONG>wchar_t</STRONG> + stores a "wide" character. Like <STRONG>chtype</STRONG>, + this may be an integer. + + <STRONG>wint_t</STRONG> + stores a <STRONG>wchar_t</STRONG> or <STRONG>WEOF</STRONG> - not the same, + though both may have the same size. + + The "wide" library provides new functions + which are analogous to functions in the "nor- + mal" library. There is a naming convention + which relates many of the normal/wide vari- + ants: a "_w" is inserted into the name. For + example, <STRONG>waddch</STRONG> becomes <STRONG>wadd_wch</STRONG>. + + + <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG> + The following table lists each <STRONG>curses</STRONG> routine and the name + of the manual page on which it is described. Routines + flagged with `*' are ncurses-specific, not described by + XPG4 or present in SVr4. + + + <STRONG>curses</STRONG> Routine Name Manual Page Name + -------------------------------------------- + COLOR_PAIR <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + PAIR_NUMBER <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + _nc_free_and_exit <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>* + + _nc_freeall <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>* + _nc_tracebits <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _traceattr <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _traceattr2 <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _tracechar <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _tracechtype <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _tracechtype2 <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _tracedump <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _tracef <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + _tracemouse <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + add_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + add_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + add_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + addch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + addchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + addchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + addnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + addnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + addstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + addwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + assume_default_colors <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>* + attr_get <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + attr_off <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + attr_on <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + attr_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + attroff <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + attron <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + attrset <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + baudrate <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + beep <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> + bkgd <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + bkgdset <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + bkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + bkgrndset <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + border <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + border_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + box <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + box_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + can_change_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + cbreak <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + chgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + clear <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + clearok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + clrtobot <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + clrtoeol <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + color_content <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + color_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + copywin <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> + curs_set <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + curses_version <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>* + def_prog_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + def_shell_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + define_key <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>* + del_curterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + delay_output <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + delch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> + deleteln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + delscreen <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + delwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + derwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + doupdate <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + dupwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + echo <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + echo_wchar <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + echochar <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + + endwin <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + erase <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + erasechar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + erasewchar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + filter <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + flash <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> + flushinp <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + get_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> + get_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + getattrs <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + getbegx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getbegy <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getbegyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> + getbkgd <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + getbkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + getcchar <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> + getch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> + getcurx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getcury <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getmaxx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getmaxy <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getmaxyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> + getmouse <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + getn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + getnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + getparx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getpary <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>* + getparyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> + getstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + getsyx <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + getwin <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + getyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> + halfdelay <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + has_colors <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + has_ic <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + has_il <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + has_key <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>* + hline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + hline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + idcok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + idlok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + immedok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + in_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> + in_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + in_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + inch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> + inchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + inchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + init_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + init_pair <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + initscr <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + innstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + innwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + ins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + ins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> + ins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + insch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> + insdelln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + insertln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + insnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + insstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + instr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + intrflush <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + inwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + is_cleared <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + + is_idcok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_idlok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_immedok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_keypad <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_leaveok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_linetouched <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + is_nodelay <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_notimeout <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_scrollok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_syncok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>* + is_term_resized <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>* + is_wintouched <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + isendwin <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + key_defined <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>* + key_name <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + keybound <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>* + keyname <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + keyok <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>* + keypad <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + killchar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + killwchar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + leaveok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + longname <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + mcprint <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>* + meta <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + mouse_trafo <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + mouseinterval <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + mousemask <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + move <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG> + mvadd_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + mvadd_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + mvadd_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + mvaddch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + mvaddchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + mvaddchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + mvaddnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + mvaddnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + mvaddstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + mvaddwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + mvchgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + mvcur <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + mvdelch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> + mvderwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + mvget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> + mvget_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + mvgetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> + mvgetn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + mvgetnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + mvgetstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + mvhline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + mvhline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + mvin_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> + mvin_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + mvin_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + mvinch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> + mvinchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + mvinchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + mvinnstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + mvinnwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + mvins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + mvins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> + mvins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + mvinsch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> + mvinsnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + mvinsstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + + mvinstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + mvinwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + mvprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + mvscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + mvvline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + mvvline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + mvwadd_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + mvwadd_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + mvwadd_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + mvwaddch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + mvwaddchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + mvwaddchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + mvwaddnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + mvwaddnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + mvwaddstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + mvwaddwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + mvwchgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + mvwdelch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> + mvwget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> + mvwget_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + mvwgetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> + mvwgetn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + mvwgetnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + mvwgetstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + mvwhline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + mvwhline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + mvwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + mvwin_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> + mvwin_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + mvwin_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + mvwinch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> + mvwinchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + mvwinchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + mvwinnstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + mvwinnwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + mvwins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + mvwins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> + mvwins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + mvwinsch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> + mvwinsnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + mvwinsstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + mvwinstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + mvwinwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + mvwprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + mvwscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + mvwvline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + mvwvline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + napms <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + newpad <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> + newterm <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + newwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + nl <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + nocbreak <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + nodelay <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + noecho <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + nofilter <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>* + nonl <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + noqiflush <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + noraw <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + notimeout <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + overlay <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> + overwrite <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> + pair_content <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + pechochar <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> + pnoutrefresh <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> + + prefresh <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> + printw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + putp <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + putwin <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + qiflush <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + raw <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + redrawwin <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + refresh <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + reset_prog_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + reset_shell_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + resetty <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + resizeterm <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>* + restartterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + ripoffline <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + savetty <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + scanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + scr_dump <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> + scr_init <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> + scr_restore <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> + scr_set <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> + scrl <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG> + scroll <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG> + scrollok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + set_curterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + set_term <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + setcchar <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG> + setscrreg <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + setsyx <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> + setterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + setupterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + slk_attr <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>* + slk_attr_off <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_attr_on <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_attr_set <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_attroff <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_attron <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_attrset <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_clear <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_color <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_init <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_label <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_noutrefresh <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_refresh <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_restore <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_set <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + slk_touch <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> + standend <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + standout <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + start_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> + subpad <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> + subwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + syncok <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + term_attrs <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + termattrs <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + termname <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> + tgetent <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + tgetflag <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + tgetnum <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + tgetstr <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + tgoto <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + tigetflag <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + tigetnum <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + tigetstr <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + timeout <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + touchline <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + + touchwin <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + tparm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + tputs <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> + tputs <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + trace <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>* + typeahead <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + unctrl <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + unget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> + ungetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> + ungetmouse <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + untouchwin <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + use_default_colors <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>* + use_env <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + use_extended_names <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>* + use_legacy_coding <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>* + vid_attr <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + vid_puts <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + vidattr <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + vidputs <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> + vline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + vline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + vw_printw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + vw_scanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + vwprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + vwscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + wadd_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + wadd_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + wadd_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + waddch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + waddchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + waddchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> + waddnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + waddnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + waddstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> + waddwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> + wattr_get <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wattr_off <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wattr_on <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wattr_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wattroff <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wattron <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wattrset <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wbkgd <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + wbkgdset <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> + wbkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + wbkgrndset <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + wborder <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + wborder_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + wchgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wclear <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + wclrtobot <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + wclrtoeol <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + wcolor_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wcursyncup <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + wdelch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG> + wdeleteln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + wecho_wchar <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG> + wechochar <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG> + wenclose <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + werase <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG> + wget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> + wget_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + wgetbkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG> + wgetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> + wgetn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> + + wgetnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + wgetstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> + whline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + whline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + win_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> + win_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + win_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> + winch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> + winchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + winchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> + winnstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + winnwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + wins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + wins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> + wins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> + winsch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> + winsdelln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + winsertln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG> + winsnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + winsstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> + winstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> + winwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> + wmouse_trafo <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>* + wmove <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG> + wnoutrefresh <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + wprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG> + wredrawln <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + wrefresh <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG> + wresize <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>* + wscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> + wscrl <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG> + wsetscrreg <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> + wstandend <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wstandout <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> + wsyncdown <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + wsyncup <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG> + wtimeout <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> + wtouchln <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> + wunctrl <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> + wvline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> + wvline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <STRONG>ERR</STRONG> upon failure + and an integer value other than <STRONG>ERR</STRONG> upon successful com- + pletion, unless otherwise noted in the routine descrip- + tions. + + All macros return the value of the <STRONG>w</STRONG> version, except + <STRONG>setscrreg</STRONG>, <STRONG>wsetscrreg</STRONG>, <STRONG>getyx</STRONG>, <STRONG>getbegyx</STRONG>, and <STRONG>getmaxyx</STRONG>. The + return values of <STRONG>setscrreg</STRONG>, <STRONG>wsetscrreg</STRONG>, <STRONG>getyx</STRONG>, <STRONG>getbegyx</STRONG>, + and <STRONG>getmaxyx</STRONG> are undefined (i.e., these should not be used + as the right-hand side of assignment statements). + + Routines that return pointers return <STRONG>NULL</STRONG> on error. + + +</PRE> +<H2>ENVIRONMENT</H2><PRE> + The following environment symbols are useful for customiz- + ing the runtime behavior of the <STRONG>ncurses</STRONG> library. The most + important ones have been already discussed in detail. + + BAUDRATE + The debugging library checks this environment symbol + when the application has redirected output to a file. + The symbol's numeric value is used for the baudrate. + If no value is found, <STRONG>ncurses</STRONG> uses 9600. This allows + testers to construct repeatable test-cases that take + into account costs that depend on baudrate. + + CC When set, change occurrences of the command_character + (i.e., the <STRONG>cmdch</STRONG> capability) of the loaded terminfo + entries to the value of this symbol. Very few ter- + minfo entries provide this feature. + + Because this name is also used in development envi- + ronments to represent the C compiler's name, <STRONG>ncurses</STRONG> + ignores it if it does not happen to be a single char- + acter. + + COLUMNS + Specify the width of the screen in characters. + Applications running in a windowing environment usu- + ally are able to obtain the width of the window in + which they are executing. If neither the <STRONG>COLUMNS</STRONG> + value nor the terminal's screen size is available, + <STRONG>ncurses</STRONG> uses the size which may be specified in the + terminfo database (i.e., the <STRONG>cols</STRONG> capability). + + It is important that your application use a correct + size for the screen. This is not always possible + because your application may be running on a host + which does not honor NAWS (Negotiations About Window + Size), or because you are temporarily running as + another user. However, setting <STRONG>COLUMNS</STRONG> and/or <STRONG>LINES</STRONG> + overrides the library's use of the screen size + obtained from the operating system. + + Either <STRONG>COLUMNS</STRONG> or <STRONG>LINES</STRONG> symbols may be specified + independently. This is mainly useful to circumvent + legacy misfeatures of terminal descriptions, e.g., + xterm which commonly specifies a 65 line screen. For + best results, <STRONG>lines</STRONG> and <STRONG>cols</STRONG> should not be specified + in a terminal description for terminals which are run + as emulations. + + Use the <STRONG>use_env</STRONG> function to disable all use of exter- + nal environment (including system calls) to determine + the screen size. + + ESCDELAY + Specifies the total time, in milliseconds, for which + ncurses will await a character sequence, e.g., a + function key. The default value, 1000 milliseconds, + is enough for most uses. However, it is made a vari- + able to accommodate unusual applications. + + The most common instance where you may wish to change + this value is to work with slow hosts, e.g., running + on a network. If the host cannot read characters + rapidly enough, it will have the same effect as if + the terminal did not send characters rapidly enough. + The library will still see a timeout. + + Note that xterm mouse events are built up from char- + acter sequences received from the xterm. If your + application makes heavy use of multiple-clicking, you + may wish to lengthen this default value because the + timeout applies to the composed multi-click event as + well as the individual clicks. + + In addition to the environment variable, this imple- + mentation provides a global variable with the same + name. Portable applications should not rely upon the + presence of ESCDELAY in either form, but setting the + environment variable rather than the global variable + does not create problems when compiling an applica- + tion. + + HOME Tells <STRONG>ncurses</STRONG> where your home directory is. That is + where it may read and write auxiliary terminal + descriptions: + + $HOME/.termcap + $HOME/.terminfo + + LINES + Like COLUMNS, specify the height of the screen in + characters. See COLUMNS for a detailed description. + + MOUSE_BUTTONS_123 + This applies only to the OS/2 EMX port. It specifies + the order of buttons on the mouse. OS/2 numbers a + 3-button mouse inconsistently from other platforms: + + 1 = left + 2 = right + 3 = middle. + + This symbol lets you customize the mouse. The symbol + must be three numeric digits 1-3 in any order, e.g., + 123 or 321. If it is not specified, <STRONG>ncurses</STRONG> uses + 132. + + NCURSES_ASSUMED_COLORS + Override the compiled-in assumption that the termi- + nal's default colors are white-on-black (see + <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>). You may set the foreground and + background color values with this environment vari- + able by proving a 2-element list: foreground,back- + ground. For example, to tell ncurses to not assume + anything about the colors, set this to "-1,-1". To + make it green-on-black, set it to "2,0". Any posi- + tive value from zero to the terminfo <STRONG>max_colors</STRONG> value + is allowed. + + NCURSES_GPM_TERMS + This applies only to ncurses configured to use the + GPM interface. + + If present, the environment variable is a list of one + or more terminal names against which the TERM envi- + ronment variable is matched. Setting it to an empty + value disables the GPM interface; using the built-in + support for xterm, etc. + + If the environment variable is absent, ncurses will + attempt to open GPM if TERM contains "linux". + + NCURSES_NO_HARD_TABS + <STRONG>Ncurses</STRONG> may use tabs as part of the cursor movement + optimization. In some cases, your terminal driver + may not handle these properly. Set this environment + variable to disable the feature. You can also adjust + your <STRONG>stty</STRONG> settings to avoid the problem. + + NCURSES_NO_MAGIC_COOKIES + Some terminals use a magic-cookie feature which + requires special handling to make highlighting and + other video attributes display properly. You can + suppress the highlighting entirely for these termi- + nals by setting this environment variable. + + NCURSES_NO_PADDING + Most of the terminal descriptions in the terminfo + database are written for real "hardware" terminals. + Many people use terminal emulators which run in a + windowing environment and use curses-based applica- + tions. Terminal emulators can duplicate all of the + important aspects of a hardware terminal, but they do + not have the same limitations. The chief limitation + of a hardware terminal from the standpoint of your + application is the management of dataflow, i.e., tim- + ing. Unless a hardware terminal is interfaced into a + terminal concentrator (which does flow control), it + (or your application) must manage dataflow, prevent- + ing overruns. The cheapest solution (no hardware + cost) is for your program to do this by pausing after + operations that the terminal does slowly, such as + clearing the display. + + As a result, many terminal descriptions (including + the vt100) have delay times embedded. You may wish + to use these descriptions, but not want to pay the + performance penalty. + + Set the NCURSES_NO_PADDING symbol to disable all but + mandatory padding. Mandatory padding is used as a + part of special control sequences such as <EM>flash</EM>. + + NCURSES_NO_SETBUF + Normally <STRONG>ncurses</STRONG> enables buffered output during ter- + minal initialization. This is done (as in SVr4 + curses) for performance reasons. For testing pur- + poses, both of <STRONG>ncurses</STRONG> and certain applications, this + feature is made optional. Setting the + NCURSES_NO_SETBUF variable disables output buffering, + leaving the output in the original (usually line + buffered) mode. + + NCURSES_NO_UTF8_ACS + During initialization, the <STRONG>ncurses</STRONG> library checks for + special cases where VT100 line-drawing (and the cor- + responding alternate character set capabilities) + described in the terminfo are known to be missing. + Specifically, when running in a UTF-8 locale, the + Linux console emulator and the GNU screen program + ignore these. Ncurses checks the TERM environment + variable for these. For other special cases, you + should set this environment variable. Doing this + tells ncurses to use Unicode values which correspond + to the VT100 line-drawing glyphs. That works for the + special cases cited, and is likely to work for termi- + nal emulators. + + When setting this variable, you should set it to a + nonzero value. Setting it to zero (or to a nonnum- + ber) disables the special check for "linux" and + "screen". + + As an alternative to the environment variable, + ncurses checks for an extended terminfo capability + <STRONG>U8</STRONG>. This is a numeric capability which can be com- + piled using <STRONG>tic</STRONG> <STRONG>-x</STRONG>. For example + + # linux console, if patched to provide working + # VT100 shift-in/shift-out, with corresponding font. + linux-vt100|linux console with VT100 line-graphics, + U8#0, use=linux, + + # uxterm with vt100Graphics resource set to false + xterm-utf8|xterm relying on UTF-8 line-graphics, + U8#1, use=xterm, + + The name "U8" is chosen to be two characters, to per- + mit it to be used by applications that use ncurses' + termcap interface. + + NCURSES_TRACE + During initialization, the <STRONG>ncurses</STRONG> debugging library + checks the NCURSES_TRACE symbol. If it is defined, + to a numeric value, <STRONG>ncurses</STRONG> calls the <STRONG>trace</STRONG> function, + using that value as the argument. + + The argument values, which are defined in <STRONG>curses.h</STRONG>, + provide several types of information. When running + with traces enabled, your application will write the + file <STRONG>trace</STRONG> to the current directory. + + TERM Denotes your terminal type. Each terminal type is + distinct, though many are similar. + + TERMCAP + If the <STRONG>ncurses</STRONG> library has been configured with <EM>term-</EM> + <EM>cap</EM> support, <STRONG>ncurses</STRONG> will check for a terminal's + description in termcap form if it is not available in + the terminfo database. + + The TERMCAP symbol contains either a terminal + description (with newlines stripped out), or a file + name telling where the information denoted by the + TERM symbol exists. In either case, setting it + directs <STRONG>ncurses</STRONG> to ignore the usual place for this + information, e.g., /etc/termcap. + + TERMINFO + Overrides the directory in which <STRONG>ncurses</STRONG> searches for + your terminal description. This is the simplest, but + not the only way to change the list of directories. + The complete list of directories in order follows: + + <STRONG>o</STRONG> the last directory to which <STRONG>ncurses</STRONG> wrote, if + any, is searched first + + <STRONG>o</STRONG> the directory specified by the TERMINFO symbol + + <STRONG>o</STRONG> $HOME/.terminfo + + <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS symbol + + <STRONG>o</STRONG> one or more directories whose names are config- + ured and compiled into the ncurses library, e.g., + /usr/share/terminfo + + TERMINFO_DIRS + Specifies a list of directories to search for termi- + nal descriptions. The list is separated by colons + (i.e., ":") on Unix, semicolons on OS/2 EMX. All of + the terminal descriptions are in terminfo form, which + makes a subdirectory named for the first letter of + the terminal names therein. + + TERMPATH + If TERMCAP does not hold a file name then <STRONG>ncurses</STRONG> + checks the TERMPATH symbol. This is a list of file- + names separated by spaces or colons (i.e., ":") on + Unix, semicolons on OS/2 EMX. If the TERMPATH symbol + is not set, <STRONG>ncurses</STRONG> looks in the files /etc/termcap, + /usr/share/misc/termcap and $HOME/.termcap, in that + order. + + The library may be configured to disregard the following + variables when the current user is the superuser (root), + or if the application uses setuid or setgid permissions: + $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME. + + +</PRE> +<H2>ALTERNATE CONFIGURATIONS</H2><PRE> + Several different configurations are possible, depending + on the configure script options used when building + <STRONG>ncurses</STRONG>. There are a few main options whose effects are + visible to the applications developer using <STRONG>ncurses</STRONG>: + + --disable-overwrite + The standard include for <STRONG>ncurses</STRONG> is as noted in <STRONG>SYN-</STRONG> + <STRONG>OPSIS</STRONG>: + + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + This option is used to avoid filename conflicts when + <STRONG>ncurses</STRONG> is not the main implementation of curses of + the computer. If <STRONG>ncurses</STRONG> is installed disabling + overwrite, it puts its headers in a subdirectory, + e.g., + + <STRONG>#include</STRONG> <STRONG><ncurses/curses.h></STRONG> + + It also omits a symbolic link which would allow you + to use <STRONG>-lcurses</STRONG> to build executables. + + --enable-widec + The configure script renames the library and (if the + <STRONG>--disable-overwrite</STRONG> option is used) puts the header + files in a different subdirectory. All of the + library names have a "w" appended to them, i.e., + instead of + + <STRONG>-lncurses</STRONG> + + you link with + + <STRONG>-lncursesw</STRONG> + + You must also define <STRONG>_XOPEN_SOURCE_EXTENDED</STRONG> when com- + piling for the wide-character library to use the + extended (wide-character) functions. The <STRONG>curses.h</STRONG> + file which is installed for the wide-character + library is designed to be compatible with the normal + library's header. Only the size of the <STRONG>WINDOW</STRONG> struc- + ture differs, and very few applications require more + than a pointer to <STRONG>WINDOW</STRONG>s. If the headers are + installed allowing overwrite, the wide-character + library's headers should be installed last, to allow + applications to be built using either library from + the same set of headers. + + --with-shared + + --with-normal + + --with-debug + + --with-profile + The shared and normal (static) library names differ + by their suffixes, e.g., <STRONG>libncurses.so</STRONG> and + <STRONG>libncurses.a</STRONG>. The debug and profiling libraries add + a "_g" and a "_p" to the root names respectively, + e.g., <STRONG>libncurses_g.a</STRONG> and <STRONG>libncurses_p.a</STRONG>. + + --with-trace + The <STRONG>trace</STRONG> function normally resides in the debug + library, but it is sometimes useful to configure this + in the shared library. Configure scripts should + check for the function's existence rather than assum- + ing it is always in the debug library. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/tabset + directory containing initialization files for the + terminal capability database /usr/share/terminfo ter- + minal capability database + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> and related pages whose names begin "curs_" + for detailed routine descriptions. + <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + The <STRONG>ncurses</STRONG> library can be compiled with an option + (<STRONG>-DUSE_GETCAP</STRONG>) that falls back to the old-style /etc/term- + cap file if the terminal setup code cannot find a terminfo + entry corresponding to <STRONG>TERM</STRONG>. Use of this feature is not + recommended, as it essentially includes an entire termcap + compiler in the <STRONG>ncurses</STRONG> startup code, at significant cost + in core and startup cycles. + + The <STRONG>ncurses</STRONG> library includes facilities for capturing + mouse events on certain terminals (including xterm). See + the <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> manual page for details. + + The <STRONG>ncurses</STRONG> library includes facilities for responding to + window resizing events, e.g., when running in an xterm. + See the <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> and <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> manual pages for + details. In addition, the library may be configured with + a SIGWINCH handler. + + The <STRONG>ncurses</STRONG> library extends the fixed set of function key + capabilities of terminals by allowing the application + designer to define additional key sequences at runtime. + See the <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>, and <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> man- + ual pages for details. + + The <STRONG>ncurses</STRONG> library can exploit the capabilities of termi- + nals which implement the ISO-6429 SGR 39 and SGR 49 con- + trols, which allow an application to reset the terminal to + its original foreground and background colors. From the + users' perspective, the application is able to draw col- + ored text on a background whose color is set indepen- + dently, providing better control over color contrasts. + See the <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG> manual page for details. + + The <STRONG>ncurses</STRONG> library includes a function for directing + application output to a printer attached to the terminal + device. See the <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> manual page for details. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <STRONG>ncurses</STRONG> library is intended to be BASE-level confor- + mant with XSI Curses. The EXTENDED XSI Curses functional- + ity (including color support) is supported. + + A small number of local differences (that is, individual + differences between the XSI Curses and <STRONG>ncurses</STRONG> calls) are + described in <STRONG>PORTABILITY</STRONG> sections of the library man + pages. + + This implementation also contains several extensions: + + <STRONG>o</STRONG> The routine <STRONG>has_key</STRONG> is not part of XPG4, nor is it + present in SVr4. See the <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> manual page + for details. + + <STRONG>o</STRONG> The routine <STRONG>slk_attr</STRONG> is not part of XPG4, nor is it + present in SVr4. See the <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> manual page for + details. + + <STRONG>o</STRONG> The routines <STRONG>getmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousein-</STRONG> + <STRONG>terval</STRONG>, and <STRONG>wenclose</STRONG> relating to mouse interfacing are + not part of XPG4, nor are they present in SVr4. See + the <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> manual page for details. + + <STRONG>o</STRONG> The routine <STRONG>mcprint</STRONG> was not present in any previous + curses implementation. See the <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> manual + page for details. + + <STRONG>o</STRONG> The routine <STRONG>wresize</STRONG> is not part of XPG4, nor is it + present in SVr4. See the <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> manual page for + details. + + <STRONG>o</STRONG> The WINDOW structure's internal details can be hidden + from application programs. See <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> for + the discussion of <STRONG>is_scrollok</STRONG>, etc. + + <STRONG>o</STRONG> This implementation can be configured to provide rudi- + mentary support for multi-threaded applications. See + <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> for details. + + <STRONG>o</STRONG> This implementation can also be configured to provide + a set of functions which improve the ability to manage + multiple screens. See <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> for details. + + In historic curses versions, delays embedded in the capa- + bilities <STRONG>cr</STRONG>, <STRONG>ind</STRONG>, <STRONG>cub1</STRONG>, <STRONG>ff</STRONG> and <STRONG>tab</STRONG> activated corresponding + delay bits in the UNIX tty driver. In this implementa- + tion, all padding is done by sending NUL bytes. This + method is slightly more expensive, but narrows the inter- + face to the UNIX kernel significantly and increases the + package's portability correspondingly. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><curses.h></STRONG> automatically includes the + header files <STRONG><stdio.h></STRONG> and <STRONG><unctrl.h></STRONG>. + + If standard output from a <STRONG>ncurses</STRONG> program is re-directed + to something which is not a tty, screen updates will be + directed to standard error. This was an undocumented fea- + ture of AT&T System V Release 3 curses. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. + Based on pcurses by Pavel Curtis. + + + + <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/ncurses5-config.1.html b/doc/html/man/ncurses5-config.1.html new file mode 100644 index 000000000000..4ead0ebc8c45 --- /dev/null +++ b/doc/html/man/ncurses5-config.1.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: MKncu_config.in,v 1.3 2010/03/06 22:29:17 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>ncurses5-config 1</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>ncurses5-config 1</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="ncurses5-config.1.html">ncurses5-config(1)</A></STRONG> <STRONG><A HREF="ncurses5-config.1.html">ncurses5-config(1)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + ncurses5-config - helper script for ncurses libraries + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>ncurses5-config</STRONG> [<EM>options</EM>] + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is a shell script which simplifies configuring appli- + cations against a particular set of ncurses libraries. + + +</PRE> +<H2>OPTIONS</H2><PRE> + <STRONG>--prefix</STRONG> + echos the package-prefix of ncurses + + <STRONG>--exec-prefix</STRONG> + echos the executable-prefix of ncurses + + <STRONG>--cflags</STRONG> + echos the C compiler flags needed to compile with + ncurses + + <STRONG>--libs</STRONG> echos the libraries needed to link with ncurses + + <STRONG>--version</STRONG> + echos the release+patchdate version of ncurses + + <STRONG>--abi-version</STRONG> + echos the ABI version of ncurses + + <STRONG>--mouse-version</STRONG> + echos the mouse-interface version of ncurses + + <STRONG>--bindir</STRONG> + echos the directory containing ncurses programs + + <STRONG>--datadir</STRONG> + echos the directory containing ncurses data + + <STRONG>--includedir</STRONG> + echos the directory containing ncurses header files + + <STRONG>--libdir</STRONG> + echos the directory containing ncurses libraries + + <STRONG>--mandir</STRONG> + echos the directory containing ncurses manpages + + <STRONG>--terminfo</STRONG> + echos the $TERMINFO terminfo database path, e.g., + /usr/share/terminfo + + <STRONG>--terminfo-dirs</STRONG> + echos the $TERMINFO_DIRS directory list, e.g., + /usr/local/ncurses/lib/terminfo:/usr/share/terminfo + + <STRONG>--termpath</STRONG> + echos the $TERMPATH termcap list, if support for + termcap is configured. + + <STRONG>--help</STRONG> prints this message + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="ncurses5-config.1.html">ncurses5-config(1)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/panel.3x.html b/doc/html/man/panel.3x.html new file mode 100644 index 000000000000..216839e31574 --- /dev/null +++ b/doc/html/man/panel.3x.html @@ -0,0 +1,241 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: panel.3x,v 1.17 2010/10/02 23:22:44 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>panel 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>panel 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + panel - panel stack extension for curses + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><panel.h></STRONG> + + <STRONG>cc</STRONG> <STRONG>[flags]</STRONG> <STRONG>sourcefiles</STRONG> <STRONG>-lpanel</STRONG> <STRONG>-lncurses</STRONG> + + <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*win)</STRONG> + <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>void</STRONG> <STRONG>update_panels();</STRONG> + <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*window)</STRONG> + <STRONG>int</STRONG> <STRONG>move_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>int</STRONG> <STRONG>starty,</STRONG> <STRONG>int</STRONG> <STRONG>startx)</STRONG> + <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>int</STRONG> <STRONG>set_panel_userptr(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*ptr)</STRONG> + <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG> + <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*pan)</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Panels are <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> windows with the added feature of + depth. Panel functions allow the use of stacked windows + and ensure the proper portions of each window and the + curses <STRONG>stdscr</STRONG> window are hidden or displayed when panels + are added, moved, modified or removed. The set of cur- + rently visible panels is the stack of panels. The <STRONG>stdscr</STRONG> + window is beneath all panels, and is not considered part + of the stack. + + A window is associated with every panel. The panel rou- + tines enable you to create, move, hide, and show panels, + as well as position a panel at any desired location in the + stack. + + Panel routines are a functional layer added to <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, + make only high-level curses calls, and work anywhere ter- + minfo curses does. + + +</PRE> +<H2>FUNCTIONS</H2><PRE> + <STRONG>new_panel(win)</STRONG> + allocates a <STRONG>PANEL</STRONG> structure, associates it with + <STRONG>win</STRONG>, places the panel on the top of the stack + (causes it to be displayed above any other + panel) and returns a pointer to the new panel. + + <STRONG>update_panels()</STRONG> + refreshes the virtual screen to reflect the rela- + tions between the panels in the stack, but does not + call doupdate() to refresh the physical screen. + Use this function and not <STRONG>wrefresh</STRONG> or <STRONG>wnoutrefresh</STRONG>. + <STRONG>update_panels</STRONG> may be called more than once before a + call to doupdate(), but doupdate() is the function + responsible for updating the physical screen. + + <STRONG>del_panel(pan)</STRONG> + removes the given panel from the stack and deallo- + cates the <STRONG>PANEL</STRONG> structure (but not its associated + window). + + <STRONG>hide_panel(pan)</STRONG> + removes the given panel from the panel stack and + thus hides it from view. The <STRONG>PANEL</STRONG> structure is not + lost, merely removed from the stack. + + <STRONG>panel_hidden(pan)</STRONG> + returns TRUE if the panel is in the panel stack, + FALSE if it is not. If the panel is a null + pointer, return ERR. + + <STRONG>show_panel(pan)</STRONG> + makes a hidden panel visible by placing it on top + of the panels in the panel stack. See COMPATIBILITY + below. + + <STRONG>top_panel(pan)</STRONG> + puts the given visible panel on top of all panels + in the stack. See COMPATIBILITY below. + + <STRONG>bottom_panel(pan)</STRONG> + puts panel at the bottom of all panels. + + <STRONG>move_panel(pan,starty,startx)</STRONG> + moves the given panel window so that its upper-left + corner is at <STRONG>starty</STRONG>, <STRONG>startx</STRONG>. It does not change + the position of the panel in the stack. Be sure to + use this function, not <STRONG>mvwin()</STRONG>, to move a panel + window. + + <STRONG>replace_panel(pan,window)</STRONG> + replaces the current window of panel with <STRONG>window</STRONG> + (useful, for example if you want to resize a panel; + if you're using <STRONG>ncurses</STRONG>, you can call <STRONG>replace_panel</STRONG> + on the output of <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>). It does not change + the position of the panel in the stack. + + <STRONG>panel_above(pan)</STRONG> + returns a pointer to the panel above pan. If the + panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer + to the bottom panel in the stack. + + <STRONG>panel_below(pan)</STRONG> + returns a pointer to the panel just below pan. If + the panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a + pointer to the top panel in the stack. + + <STRONG>set_panel_userptr(pan,ptr)</STRONG> + sets the panel's user pointer. + + <STRONG>panel_userptr(pan)</STRONG> + returns the user pointer for a given panel. + + <STRONG>panel_window(pan)</STRONG> + returns a pointer to the window of the given panel. + + +</PRE> +<H2>DIAGNOSTICS</H2><PRE> + Each routine that returns a pointer returns <STRONG>NULL</STRONG> if an + error occurs. Each routine that returns an int value + returns <STRONG>OK</STRONG> if it executes successfully and <STRONG>ERR</STRONG> if not. + + +</PRE> +<H2>COMPATIBILITY</H2><PRE> + Reasonable care has been taken to ensure compatibility + with the native panel facility introduced in SVr3.2 + (inspection of the SVr4 manual pages suggests the + programming interface is unchanged). The <STRONG>PANEL</STRONG> data + structures are merely similar. The programmer is cau- + tioned not to directly use <STRONG>PANEL</STRONG> fields. + + The functions <STRONG>show_panel()</STRONG> and <STRONG>top_panel()</STRONG> are identical + in this implementation, and work equally well with dis- + played or hidden panels. In the native System V implemen- + tation, <STRONG>show_panel()</STRONG> is intended for making a hidden panel + visible (at the top of the stack) and <STRONG>top_panel()</STRONG> is + intended for making an already-visible panel move to the + top of the stack. You are cautioned to use the correct + function to ensure compatibility with native panel + libraries. + + +</PRE> +<H2>NOTE</H2><PRE> + In your library list, libpanel.a should be before libn- + curses.a; that is, you want to say `-lpanel -lncurses', + not the other way around (which would usually give a link- + error). + + +</PRE> +<H2>FILES</H2><PRE> + panel.h interface for the panels library + + libpanel.a the panels library itself + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + +</PRE> +<H2>AUTHOR</H2><PRE> + Originally written by Warren Tucker <wht@n4hgf.mt- + park.ga.us>, primarily to assist in porting u386mon to + systems without a native panels library. Repackaged for + ncurses by Zeyd ben-Halim. + + + + <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/resizeterm.3x.html b/doc/html/man/resizeterm.3x.html new file mode 100644 index 000000000000..d675ee3acd03 --- /dev/null +++ b/doc/html/man/resizeterm.3x.html @@ -0,0 +1,141 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1996-2005 + * @Id: resizeterm.3x,v 1.14 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>resizeterm 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>resizeterm 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>is_term_resized</STRONG>, <STRONG>resize_term</STRONG>, <STRONG>resizeterm</STRONG> - change the + curses terminal size + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG> + <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG> + <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It provides + callers with a hook into the <STRONG>ncurses</STRONG> data to resize win- + dows, primarily for use by programs running in an X Window + terminal (e.g., xterm). The function <STRONG>resizeterm</STRONG> resizes + the standard and current windows to the specified dimen- + sions, and adjusts other bookkeeping data used by the + <STRONG>ncurses</STRONG> library that record the window dimensions. + + Most of the work is done by the inner function + <STRONG>resize_term</STRONG>. The outer function <STRONG>resizeterm</STRONG> adds bookkeep- + ing for the SIGWINCH handler. When resizing the windows, + <STRONG>resize_term</STRONG> blank-fills the areas that are extended. The + calling application should fill in these areas with appro- + priate data. The <STRONG>resize_term</STRONG> function attempts to resize + all windows. However, due to the calling convention of + pads, it is not possible to resize these without addi- + tional interaction with the application. + + A support function <STRONG>is_term_resized</STRONG> is provided so that + applications can check if the <STRONG>resize_term</STRONG> function would + modify the window structures. It returns TRUE if the win- + dows would be modified, and FALSE otherwise. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except as notes, these function return the integer <STRONG>ERR</STRONG> + upon failure and <STRONG>OK</STRONG> on success. They will fail if either + of the dimensions are less than or equal to zero, or if an + error occurs while (re)allocating memory for the windows. + + +</PRE> +<H2>NOTES</H2><PRE> + While these functions are intended to be used to support a + signal handler (i.e., for SIGWINCH), care should be taken + to avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG> + <STRONG>loc</STRONG> may have been interrupted, since it uses those func- + tions. + + If ncurses is configured to supply its own SIGWINCH han- + dler, the <STRONG>resizeterm</STRONG> function ungetch's a <STRONG>KEY_RESIZE</STRONG> which + will be read on the next call to <STRONG>getch</STRONG>. This is used to + alert an application that the screen size has changed, and + that it should repaint special features such as pads that + cannot be done automatically. + + If the environment variables <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set, + this overrides the library's use of the window size + obtained from the operating system. Thus, even if a SIG- + WINCH is received, no screen size change may be recorded. + In that case, no <STRONG>KEY_RESIZE</STRONG> is queued for the next call to + <STRONG>getch</STRONG>; an <STRONG>ERR</STRONG> will be returned instead. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (from an equivalent function written in 1988 + for BSD curses). + + + + <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/tabs.1.html b/doc/html/man/tabs.1.html new file mode 100644 index 000000000000..7fb8d39db562 --- /dev/null +++ b/doc/html/man/tabs.1.html @@ -0,0 +1,171 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2008-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: tabs.1,v 1.8 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>tabs 1</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>tabs 1</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG> <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>tabs</STRONG> - set tabs on a terminal + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>tabs</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahuUV</STRONG>] <EM>file...</EM> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>tabs</STRONG> program clears and sets tab-stops on the termi- + nal. This uses the terminfo <EM>clear</EM><STRONG>_</STRONG><EM>all</EM><STRONG>_</STRONG><EM>tabs</EM> and <EM>set</EM><STRONG>_</STRONG><EM>tab</EM> + capabilities. If either is absent, <STRONG>tabs</STRONG> is unable to + clear/set tab-stops. The terminal should be configured to + use hard tabs, e.g., + + stty tab0 + + +</PRE> +<H2>OPTIONS</H2><PRE> + <STRONG>General</STRONG> <STRONG>Options</STRONG> + <STRONG>-T</STRONG><EM>name</EM> + Tell <STRONG>tabs</STRONG> which terminal type to use. If this option + is not given, <STRONG>tabs</STRONG> will use the <STRONG>$TERM</STRONG> environment + variable. If that is not set, it will use the + <EM>ansi+tabs</EM> entry. + + <STRONG>-d</STRONG> The debugging option shows a ruler line, followed by + two data lines. The first data line shows the + expected tab-stops marked with asterisks. The second + data line shows the actual tab-stops, marked with + asterisks. + + <STRONG>-n</STRONG> This option tells <STRONG>tabs</STRONG> to check the options and run + any debugging option, but not to modify the terminal + settings. + + The <STRONG>tabs</STRONG> program processes a single list of tab stops. + The last option to be processed which defines a list is + the one that determines the list to be processed. + + <STRONG>Implicit</STRONG> <STRONG>Lists</STRONG> + Use a single number as an option, e.g., "<STRONG>-5</STRONG>" to set tabs + at the given interval (in this case 1, 6, 11, 16, 21, + etc.). Tabs are repeated up to the right margin of the + screen. + + Use "<STRONG>-0</STRONG>" to clear all tabs. + + Use "<STRONG>-8</STRONG>" to set tabs to the standard interval. + + <STRONG>Explicit</STRONG> <STRONG>Lists</STRONG> + An explicit list can be defined after the options (this + does not use a "-"). The values in the list must be in + increasing numeric order, and greater than zero. They are + separated by a comma or a blank, for example, + + tabs 1,6,11,16,21 + tabs 1 6 11 16 21 + Use a '+' to treat a number as an increment relative to + the previous value, e.g., + + tabs 1,+5,+5,+5,+5 + which is equivalent to the 1,6,11,16,21 example. + + <STRONG>Predefined</STRONG> <STRONG>Tab-Stops</STRONG> + X/Open defines several predefined lists of tab stops. + + <STRONG>-a</STRONG> Assembler, IBM S/370, first format + + <STRONG>-a2</STRONG> Assembler, IBM S/370, second format + + <STRONG>-c</STRONG> COBOL, normal format + + <STRONG>-c2</STRONG> COBOL compact format + + <STRONG>-c3</STRONG> COBOL compact format extended + + <STRONG>-f</STRONG> FORTRAN + + <STRONG>-p</STRONG> PL/I + + <STRONG>-s</STRONG> SNOBOL + + <STRONG>-u</STRONG> UNIVAC 1100 Assembler + + +</PRE> +<H2>PORTABILITY</H2><PRE> + X/Open describes a <STRONG>+m</STRONG> option, to set a terminal's left- + margin. Very few of the entries in the terminal database + provide this capability. + + The <STRONG>-d</STRONG> (debug) and <STRONG>-n</STRONG> (no-op) options are extensions not + provided by other implementations. + + Documentation for other implementations states that there + is a limit on the number of tab stops. While some termi- + nals may not accept an arbitrary number of tab stops, this + implementation will attempt to set tab stops up to the + right margin of the screen, if the given list happens to + be that long. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/term.5.html b/doc/html/man/term.5.html new file mode 100644 index 000000000000..73ecbb297d79 --- /dev/null +++ b/doc/html/man/term.5.html @@ -0,0 +1,308 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: term.5,v 1.21 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>term 5</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>term 5</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="term.5.html">term(5)</A></STRONG> <STRONG><A HREF="term.5.html">term(5)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + term - format of compiled term file. + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>term</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>STORAGE</STRONG> <STRONG>LOCATION</STRONG> + Compiled terminfo descriptions are placed under the direc- + tory <STRONG>/usr/share/terminfo</STRONG>. Two configurations are sup- + ported (when building the ncurses libraries): + + <STRONG>directory</STRONG> <STRONG>tree</STRONG> + A two-level scheme is used to avoid a linear search + of a huge UNIX system directory: <STRONG>/usr/share/ter-</STRONG> + <STRONG>minfo/c/name</STRONG> where <EM>name</EM> is the name of the terminal, + and <EM>c</EM> is the first character of <EM>name</EM>. Thus, <EM>act4</EM> can + be found in the file <STRONG>/usr/share/terminfo/a/act4</STRONG>. + Synonyms for the same terminal are implemented by + multiple links to the same compiled file. + + <STRONG>hashed</STRONG> <STRONG>database</STRONG> + Using Berkeley database, two types of records are + stored: the terminfo data in the same format as + stored in a directory tree with the terminfo's pri- + mary name as a key, and records containing only + aliases pointing to the primary name. + + If built to write hashed databases, ncurses can still + read terminfo databases organized as a directory + tree, but cannot write entries into the directory + tree. It can write (or rewrite) entries in the + hashed database. + + ncurses distinguishes the two cases in the TERMINFO + and TERMINFO_DIRS environment variable by assuming a + directory tree for entries that correspond to an + existing directory, and hashed database otherwise. + + <STRONG>STORAGE</STRONG> <STRONG>FORMAT</STRONG> + The format has been chosen so that it will be the same on + all hardware. An 8 or more bit byte is assumed, but no + assumptions about byte ordering or sign extension are + made. + + The compiled file is created with the <STRONG>tic</STRONG> program, and + read by the routine <EM>setupterm</EM>. The file is divided into + six parts: the header, terminal names, boolean flags, num- + bers, strings, and string table. + + The header section begins the file. This section contains + six short integers in the format described below. These + integers are + + (1) the magic number (octal 0432); + + (2) the size, in bytes, of the names section; + + (3) the number of bytes in the boolean section; + + (4) the number of short integers in the numbers sec- + tion; + + (5) the number of offsets (short integers) in the + strings section; + + (6) the size, in bytes, of the string table. + + Short integers are stored in two 8-bit bytes. The first + byte contains the least significant 8 bits of the value, + and the second byte contains the most significant 8 bits. + (Thus, the value represented is 256*second+first.) The + value -1 is represented by the two bytes 0377, 0377; other + negative values are illegal. This value generally means + that the corresponding capability is missing from this + terminal. Note that this format corresponds to the hard- + ware of the VAX and PDP-11 (that is, little-endian + machines). Machines where this does not correspond to the + hardware must read the integers as two bytes and compute + the little-endian value. + + The terminal names section comes next. It contains the + first line of the terminfo description, listing the vari- + ous names for the terminal, separated by the `|' charac- + ter. The section is terminated with an ASCII NUL charac- + ter. + + The boolean flags have one byte for each flag. This byte + is either 0 or 1 as the flag is present or absent. The + capabilities are in the same order as the file <term.h>. + + Between the boolean section and the number section, a null + byte will be inserted, if necessary, to ensure that the + number section begins on an even byte (this is a relic of + the PDP-11's word-addressed architecture, originally + designed in to avoid IOT traps induced by addressing a + word on an odd byte boundary). All short integers are + aligned on a short word boundary. + + The numbers section is similar to the flags section. Each + capability takes up two bytes, and is stored as a little- + endian short integer. If the value represented is -1, the + capability is taken to be missing. + + The strings section is also similar. Each capability is + stored as a short integer, in the format above. A value + of -1 means the capability is missing. Otherwise, the + value is taken as an offset from the beginning of the + string table. Special characters in ^X or \c notation are + stored in their interpreted form, not the printing repre- + sentation. Padding information $<nn> and parameter infor- + mation %x are stored intact in uninterpreted form. + + The final section is the string table. It contains all + the values of string capabilities referenced in the string + section. Each string is null terminated. + + <STRONG>EXTENDED</STRONG> <STRONG>STORAGE</STRONG> <STRONG>FORMAT</STRONG> + The previous section describes the conventional terminfo + binary format. With some minor variations of the offsets + (see PORTABILITY), the same binary format is used in all + modern UNIX systems. Each system uses a predefined set of + boolean, number or string capabilities. + + The ncurses libraries and applications support extended + terminfo binary format, allowing users to define capabili- + ties which are loaded at runtime. This extension is made + possible by using the fact that the other implementations + stop reading the terminfo data when they have reached the + end of the size given in the header. ncurses checks the + size, and if it exceeds that due to the predefined data, + continues to parse according to its own scheme. + + First, it reads the extended header (5 short integers): + + (1) count of extended boolean capabilities + + (2) count of extended numeric capabilities + + (3) count of extended string capabilities + + (4) size of the extended string table in bytes. + + (5) last offset of the extended string table in + bytes. + + Using the counts and sizes, ncurses allocates arrays and + reads data for the extended capabilties in the same order + as the header information. + + The extended string table contains values for string capa- + bilities. After the end of these values, it contains the + names for each of the extended capabilities in order, + e.g., booleans, then numbers and finally strings. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + Note that it is possible for <EM>setupterm</EM> to expect a differ- + ent set of capabilities than are actually present in the + file. Either the database may have been updated since + <EM>setupterm</EM> has been recompiled (resulting in extra unrecog- + nized entries in the file) or the program may have been + recompiled more recently than the database was updated + (resulting in missing entries). The routine <EM>setupterm</EM> + must be prepared for both possibilities - this is why the + numbers and sizes are included. Also, new capabilities + must always be added at the end of the lists of boolean, + number, and string capabilities. + + Despite the consistent use of little-endian for numbers + and the otherwise self-describing format, it is not wise + to count on portability of binary terminfo entries between + commercial UNIX versions. The problem is that there are + at least three versions of terminfo (under HP-UX, AIX, and + OSF/1) which diverged from System V terminfo after SVr1, + and have added extension capabilities to the string table + that (in the binary format) collide with System V and XSI + Curses extensions. See <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for detailed discus- + sion of terminfo source compatibility issues. + + +</PRE> +<H2>EXAMPLE</H2><PRE> + As an example, here is a hex dump of the description for + the Lear-Siegler ADM-3, a popular though rather stupid + early terminal: + + adm3a|lsi adm3a, + am, + cols#80, lines#24, + bel=^G, clear= 32$<1>, cr=^M, cub1=^H, cud1=^J, + cuf1=^L, cup=\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K, + home=^^, ind=^J, + + 0000 1a 01 10 00 02 00 03 00 82 00 31 00 61 64 6d 33 ........ ..1.adm3 + 0010 61 7c 6c 73 69 20 61 64 6d 33 61 00 00 01 50 00 a|lsi ad m3a...P. + 0020 ff ff 18 00 ff ff 00 00 02 00 ff ff ff ff 04 00 ........ ........ + 0030 ff ff ff ff ff ff ff ff 0a 00 25 00 27 00 ff ff ........ ..%.'... + 0040 29 00 ff ff ff ff 2b 00 ff ff 2d 00 ff ff ff ff ).....+. ..-..... + 0050 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0060 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0070 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0080 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0090 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00a0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00b0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00c0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00d0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00e0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00f0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0100 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0110 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0120 ff ff ff ff ff ff 2f 00 07 00 0d 00 1a 24 3c 31 ....../. .....$<1 + 0130 3e 00 1b 3d 25 70 31 25 7b 33 32 7d 25 2b 25 63 >..=%p1% {32}%+%c + 0140 25 70 32 25 7b 33 32 7d 25 2b 25 63 00 0a 00 1e %p2%{32} %+%c.... + 0150 00 08 00 0c 00 0b 00 0a 00 ........ . + + + +</PRE> +<H2>LIMITS</H2><PRE> + Some limitations: total compiled entries cannot exceed + 4096 bytes. The name field cannot exceed 128 bytes. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo/*/* compiled terminal capability data + base + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Thomas E. Dickey + extended terminfo format for ncurses 5.0 + hashed database support for ncurses 5.6 + + Eric S. Raymond + + + + <STRONG><A HREF="term.5.html">term(5)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/term.7.html b/doc/html/man/term.7.html new file mode 100644 index 000000000000..4c944a1c5bcb --- /dev/null +++ b/doc/html/man/term.7.html @@ -0,0 +1,251 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: term.7,v 1.22 2010/12/04 18:41:07 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>term 7</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>term 7</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="term.7.html">term(7)</A></STRONG> <STRONG><A HREF="term.7.html">term(7)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + term - conventions for naming terminal types + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The environment variable <STRONG>TERM</STRONG> should normally contain the + type name of the terminal, console or display-device type + you are using. This information is critical for all + screen-oriented programs, including your editor and + mailer. + + A default <STRONG>TERM</STRONG> value will be set on a per-line basis by + either <STRONG>/etc/inittab</STRONG> (e.g., System-V-like UNIXes) or + <STRONG>/etc/ttys</STRONG> (BSD UNIXes). This will nearly always suffice + for workstation and microcomputer consoles. + + If you use a dialup line, the type of device attached to + it may vary. Older UNIX systems pre-set a very dumb ter- + minal type like `dumb' or `dialup' on dialup lines. Newer + ones may pre-set `vt100', reflecting the prevalence of DEC + VT100-compatible terminals and personal-computer emula- + tors. + + Modern telnets pass your <STRONG>TERM</STRONG> environment variable from + the local side to the remote one. There can be problems + if the remote terminfo or termcap entry for your type is + not compatible with yours, but this situation is rare and + can almost always be avoided by explicitly exporting + `vt100' (assuming you are in fact using a VT100-superset + console, terminal, or terminal emulator.) + + In any case, you are free to override the system <STRONG>TERM</STRONG> set- + ting to your taste in your shell profile. The <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> + utility may be of assistance; you can give it a set of + rules for deducing or requesting a terminal type based on + the tty device and baud rate. + + Setting your own <STRONG>TERM</STRONG> value may also be useful if you have + created a custom entry incorporating options (such as + visual bell or reverse-video) which you wish to override + the system default type for your line. + + Terminal type descriptions are stored as files of capabil- + ity data underneath /usr/share/terminfo. To browse a list + of all terminal names recognized by the system, do + + toe | more + + from your shell. These capability files are in a binary + format optimized for retrieval speed (unlike the old text- + based <STRONG>termcap</STRONG> format they replace); to examine an entry, + you must use the <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> command. Invoke it as fol- + lows: + + infocmp <EM>entry</EM><STRONG>_</STRONG><EM>name</EM> + + where <EM>entry</EM><STRONG>_</STRONG><EM>name</EM> is the name of the type you wish to exam- + ine (and the name of its capability file the subdirectory + of /usr/share/terminfo named for its first letter). This + command dumps a capability file in the text format + described by <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + The first line of a <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> description gives the + names by which terminfo knows a terminal, separated by `|' + (pipe-bar) characters with the last name field terminated + by a comma. The first name field is the type's <EM>primary</EM> + <EM>name</EM>, and is the one to use when setting <STRONG>TERM</STRONG>. The last + name field (if distinct from the first) is actually a + description of the terminal type (it may contain blanks; + the others must be single words). Name fields between the + first and last (if present) are aliases for the terminal, + usually historical names retained for compatibility. + + There are some conventions for how to choose terminal pri- + mary names that help keep them informative and unique. + Here is a step-by-step guide to naming terminals that also + explains how to parse them: + + First, choose a root name. The root will consist of a + lower-case letter followed by up to seven lower-case let- + ters or digits. You need to avoid using punctuation char- + acters in root names, because they are used and inter- + preted as filenames and shell meta-characters (such as !, + $, *, ?, etc.) embedded in them may cause odd and unhelp- + ful behavior. The slash (/), or any other character that + may be interpreted by anyone's file system (\, $, [, ]), + is especially dangerous (terminfo is platform-independent, + and choosing names with special characters could someday + make life difficult for users of a future port). The dot + (.) character is relatively safe as long as there is at + most one per root name; some historical terminfo names use + it. + + The root name for a terminal or workstation console type + should almost always begin with a vendor prefix (such as + <STRONG>hp</STRONG> for Hewlett-Packard, <STRONG>wy</STRONG> for Wyse, or <STRONG>att</STRONG> for AT&T ter- + minals), or a common name of the terminal line (<STRONG>vt</STRONG> for the + VT series of terminals from DEC, or <STRONG>sun</STRONG> for Sun Microsys- + tems workstation consoles, or <STRONG>regent</STRONG> for the ADDS Regent + series. You can list the terminfo tree to see what pre- + fixes are already in common use. The root name prefix + should be followed when appropriate by a model number; + thus <STRONG>vt100</STRONG>, <STRONG>hp2621</STRONG>, <STRONG>wy50</STRONG>. + + The root name for a PC-Unix console type should be the OS + name, i.e., <STRONG>linux</STRONG>, <STRONG>bsdos</STRONG>, <STRONG>freebsd</STRONG>, <STRONG>netbsd</STRONG>. It should <EM>not</EM> + be <STRONG>console</STRONG> or any other generic that might cause confusion + in a multi-platform environment! If a model number fol- + lows, it should indicate either the OS release level or + the console driver release level. + + The root name for a terminal emulator (assuming it does + not fit one of the standard ANSI or vt100 types) should be + the program name or a readily recognizable abbreviation of + it (i.e., <STRONG>versaterm</STRONG>, <STRONG>ctrm</STRONG>). + + Following the root name, you may add any reasonable number + of hyphen-separated feature suffixes. + + 2p Has two pages of memory. Likewise 4p, 8p, etc. + + mc Magic-cookie. Some terminals (notably older Wyses) + can only support one attribute without magic-cookie + lossage. Their base entry is usually paired with + another that has this suffix and uses magic cookies + to support multiple attributes. + + -am Enable auto-margin (right-margin wraparound). + + -m Mono mode - suppress color support. + + -na No arrow keys - termcap ignores arrow keys which are + actually there on the terminal, so the user can use + the arrow keys locally. + + -nam No auto-margin - suppress am capability. + + -nl No labels - suppress soft labels. + + -nsl No status line - suppress status line. + + -pp Has a printer port which is used. + + -rv Terminal in reverse video mode (black on white). + + -s Enable status line. + + -vb Use visible bell (flash) rather than beep. + + -w Wide; terminal is in 132 column mode. + + Conventionally, if your terminal type is a variant + intended to specify a line height, that suffix should go + first. So, for a hypothetical FuBarCo model 2317 terminal + in 30-line mode with reverse video, best form would be + <STRONG>fubar-30-rv</STRONG> (rather than, say, `fubar-rv-30'). + + Terminal types that are written not as standalone entries, + but rather as components to be plugged into other entries + via <STRONG>use</STRONG> capabilities, are distinguished by using embedded + plus signs rather than dashes. + + Commands which use a terminal type to control display + often accept a -T option that accepts a terminal name + argument. Such programs should fall back on the <STRONG>TERM</STRONG> + environment variable when no -T option is specified. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + For maximum compatibility with older System V UNIXes, + names and aliases should be unique within the first 14 + characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo/?/* + compiled terminal capability data base + + /etc/inittab + tty line initialization (AT&T-like UNIXes) + + /etc/ttys + tty line initialization (BSD-like UNIXes) + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>. + + + + <STRONG><A HREF="term.7.html">term(7)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/term_variables.3x.html b/doc/html/man/term_variables.3x.html new file mode 100644 index 000000000000..bc1f9baba8b4 --- /dev/null +++ b/doc/html/man/term_variables.3x.html @@ -0,0 +1,165 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: term_variables.3x,v 1.2 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>term_variables 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>term_variables 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>SP</STRONG>, <STRONG>acs_map</STRONG>, <STRONG>boolcodes</STRONG>, <STRONG>boolfnames</STRONG>, <STRONG>boolnames</STRONG>, <STRONG>cur_term</STRONG>, + <STRONG>numcodes</STRONG>, <STRONG>numfnames</STRONG>, <STRONG>numnames</STRONG>, <STRONG>strcodes</STRONG>, <STRONG>strfnames</STRONG>, + <STRONG>strnames</STRONG>, <STRONG>ttytype</STRONG> - <STRONG>curses</STRONG> terminfo global variables + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>#include</STRONG> <STRONG><term.h></STRONG> + + <STRONG>chtype</STRONG> <STRONG>acs_map[];</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolcodes;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolfnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolnames;</STRONG> + <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numcodes;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numfnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strcodes;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strfnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strnames;</STRONG> + <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This page summarizes variables provided by the <STRONG>curses</STRONG> li- + brary's low-level terminfo interface. A more complete de- + scription is given in the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page. + + Depending on the configuration, these may be actual vari- + ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>) which provide + read-only access to <EM>curses</EM>'s state. In either case, ap- + plications should treat them as read-only to avoid confus- + ing the library. + + <STRONG>Alternate</STRONG> <STRONG>Character</STRONG> <STRONG>Set</STRONG> <STRONG>Mapping</STRONG> + After initializing the curses or terminfo interfaces, the + <STRONG>acs_map</STRONG> array holds information used to translate cells + with the <STRONG>A_ALTCHARSET</STRONG> video attribute into line-drawing + characters. + + The encoding of the information in this array has changed + periodically. Application developers need only know that + it is used for the "ACS_" constants in <curses.h>. + + The comparable data for the wide-character library is a + private variable. + + <STRONG>Current</STRONG> <STRONG>Terminal</STRONG> <STRONG>Data</STRONG> + After initializing the curses or terminfo interfaces, the + <STRONG>cur_term</STRONG> contains data describing the current terminal. + This variable is also set as a side-effect of <STRONG><A HREF="set_term.3x.html">set_term(3x)</A></STRONG> + and <STRONG><A HREF="delscreen.3x.html">delscreen(3x)</A></STRONG>. + + It is possible to save a value of <STRONG>cur_term</STRONG> for subsequent + use as a parameter to <STRONG>set_term</STRONG>, for switching between + screens. Alternatively, one can save the return value + from <STRONG>newterm</STRONG> or <STRONG>setupterm</STRONG> to reuse in <STRONG>set_term</STRONG>. + + <STRONG>Terminfo</STRONG> <STRONG>Names</STRONG> + The <STRONG><A HREF="tic.1.html">tic(1)</A></STRONG> and <STRONG><A HREF="infocmp.1.html">infocmp(1)</A></STRONG> programs use lookup tables for + the long and short names of terminfo capabilities, as well + as the corresponding names for termcap capabilities. + These are available to other applications, though the + hash-tables are not available. + + The long terminfo capability names use a "l" (ell) in + their names: boolfnames numfnames strfnames + + These are the short names for terminfo capabilities: bool- + names, numnames, and strnames. + + These are the corresponding names used for termcap de- + scriptions: boolcodes, numcodes, and strcodes. + + <STRONG>Terminal</STRONG> <STRONG>Type</STRONG> + On initialization of the curses or terminfo interfaces, + <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The low-level terminfo interface is initialized using <STRONG>se-</STRONG> + <STRONG><A HREF="setupterm.3x.html">tupterm(3x)</A></STRONG>. The upper-level curses interface uses the + low-level terminfo interface, internally. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + X/Open Curses does not describe any of these except for + <STRONG>cur_term</STRONG>. (The inclusion of <STRONG>cur_term</STRONG> appears to be an + oversight, since other comparable low-level information is + omitted by X/Open). + + Other implementations may have comparable variables. Some + implementations provide the variables in their libraries, + but omit them from the header files. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG>termin-</STRONG> + <STRONG><A HREF="terminfo.3x.html">fo(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + + + <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html new file mode 100644 index 000000000000..445f3c54b72a --- /dev/null +++ b/doc/html/man/terminfo.5.html @@ -0,0 +1,2375 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + * DO NOT EDIT THIS FILE BY HAND! + * It is generated from terminfo.head, Caps, and terminfo.tail. + * Note: this must be run through tbl before nroff. + * The magic cookie on the first line triggers this under some man programs. + **************************************************************************** + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: terminfo.head,v 1.18 2010/07/31 16:08:48 tom Exp @ + * Head of terminfo man page ends here + * @Id: terminfo.tail,v 1.53 2010/12/04 18:38:55 tom Exp @ + * Beginning of terminfo.tail file + * This file is part of ncurses. + * See "terminfo.head" for copyright. + *.in -2 + *.in +2 + *.in -2 + *.in +2 + *.TH +--> +<HTML> +<HEAD> +<TITLE>terminfo 5 File Formats</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>terminfo 5 File Formats</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> File Formats <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + terminfo - terminal capability data base + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + /usr/share/terminfo/*/* + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <EM>Terminfo</EM> is a data base describing terminals, used by + screen-oriented programs such as <STRONG><A HREF="nvi.1.html">nvi(1)</A></STRONG>, <STRONG><A HREF="rogue.1.html">rogue(1)</A></STRONG> and + libraries such as <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. <EM>Terminfo</EM> describes termi- + nals by giving a set of capabilities which they have, by + specifying how to perform screen operations, and by speci- + fying padding requirements and initialization sequences. + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + Entries in <EM>terminfo</EM> consist of a sequence of `,' separated + fields (embedded commas may be escaped with a backslash or + notated as \054). White space after the `,' separator is + ignored. The first entry for each terminal gives the + names which are known for the terminal, separated by `|' + characters. The first name given is the most common + abbreviation for the terminal, the last name given should + be a long name fully identifying the terminal, and all + others are understood as synonyms for the terminal name. + All names but the last should be in lower case and contain + no blanks; the last name may well contain upper case and + blanks for readability. + + Lines beginning with a `#' in the first column are treated + as comments. While comment lines are legal at any point, + the output of <STRONG>captoinfo</STRONG> and <STRONG>infotocap</STRONG> (aliases for <STRONG>tic</STRONG>) + will move comments so they occur only between entries. + + Newlines and leading tabs may be used for formatting + entries for readability. These are removed from parsed + entries. The <STRONG>infocmp</STRONG> <STRONG>-f</STRONG> option relies on this to format + if-then-else expressions: the result can be read by <STRONG>tic</STRONG>. + + Terminal names (except for the last, verbose entry) should + be chosen using the following conventions. The particular + piece of hardware making up the terminal should have a + root name, thus ``hp2621''. This name should not contain + hyphens. Modes that the hardware can be in, or user pref- + erences, should be indicated by appending a hyphen and a + mode suffix. Thus, a vt100 in 132 column mode would be + vt100-w. The following suffixes should be used where pos- + sible: + + + <STRONG>Suffix</STRONG> <STRONG>Meaning</STRONG> <STRONG>Example</STRONG> + -<EM>nn</EM> Number of lines on the screen aaa-60 + -<EM>n</EM>p Number of pages of memory c100-4p + -am With automargins (usually the default) vt100-am + -m Mono mode; suppress color ansi-m + -mc Magic cookie; spaces when highlighting wy30-mc + -na No arrow keys (leave them in local) c100-na + -nam Without automatic margins vt100-nam + -nl No status line att4415-nl + -ns No status line hp2626-ns + -rv Reverse video c100-rv + -s Enable status line vt100-s + + -vb Use visible bell instead of beep wy370-vb + -w Wide mode (> 80 columns, usually 132) vt100-w + + For more on terminal naming conventions, see the <STRONG>term(7)</STRONG> + manual page. + + <STRONG>Capabilities</STRONG> + The following is a complete table of the capabilities + included in a terminfo description block and available to + terminfo-using code. In each line of the table, + + The <STRONG>variable</STRONG> is the name by which the programmer (at the + terminfo level) accesses the capability. + + The <STRONG>capname</STRONG> is the short name used in the text of the + database, and is used by a person updating the database. + Whenever possible, capnames are chosen to be the same as + or similar to the ANSI X3.64-1979 standard (now superseded + by ECMA-48, which uses identical or very similar names). + Semantics are also intended to match those of the specifi- + cation. + + The termcap code is the old <STRONG>termcap</STRONG> capability name (some + capabilities are new, and have names which termcap did not + originate). + + Capability names have no hard length limit, but an infor- + mal limit of 5 characters has been adopted to keep them + short and to allow the tabs in the source file <STRONG>Caps</STRONG> to + line up nicely. + + Finally, the description field attempts to convey the + semantics of the capability. You may find some codes in + the description field: + + (P) indicates that padding may be specified + + #[1-9] in the description field indicates that the string + is passed through tparm with parms as given (#<EM>i</EM>). + + (P*) indicates that padding may vary in proportion to + the number of lines affected + + (#<EM>i</EM>) indicates the <EM>i</EM>th parameter. + + + These are the boolean capabilities: + + + <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> + <STRONG>Booleans</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> + auto_left_margin bw bw cub1 wraps from col- + umn 0 to last column + auto_right_margin am am terminal has auto- + matic margins + back_color_erase bce ut screen erased with + background color + can_change ccc cc terminal can re- + define existing col- + ors + ceol_standout_glitch xhp xs standout not erased + by overwriting (hp) + col_addr_glitch xhpa YA only positive motion + for hpa/mhpa caps + + + cpi_changes_res cpix YF changing character + pitch changes reso- + lution + cr_cancels_micro_mode crxm YB using cr turns off + micro mode + dest_tabs_magic_smso xt xt tabs destructive, + magic so char + (t1061) + eat_newline_glitch xenl xn newline ignored + after 80 cols (con- + cept) + erase_overstrike eo eo can erase over- + strikes with a blank + generic_type gn gn generic line type + hard_copy hc hc hardcopy terminal + hard_cursor chts HC cursor is hard to + see + has_meta_key km km Has a meta key + (i.e., sets 8th-bit) + has_print_wheel daisy YC printer needs opera- + tor to change char- + acter set + has_status_line hs hs has extra status + line + hue_lightness_saturation hls hl terminal uses only + HLS color notation + (Tektronix) + insert_null_glitch in in insert mode distin- + guishes nulls + lpi_changes_res lpix YG changing line pitch + changes resolution + memory_above da da display may be + retained above the + screen + memory_below db db display may be + retained below the + screen + move_insert_mode mir mi safe to move while + in insert mode + move_standout_mode msgr ms safe to move while + in standout mode + needs_xon_xoff nxon nx padding will not + work, xon/xoff + required + no_esc_ctlc xsb xb beehive (f1=escape, + f2=ctrl C) + no_pad_char npc NP pad character does + not exist + non_dest_scroll_region ndscr ND scrolling region is + non-destructive + non_rev_rmcup nrrmc NR smcup does not + reverse rmcup + over_strike os os terminal can over- + strike + prtr_silent mc5i 5i printer will not + echo on screen + row_addr_glitch xvpa YD only positive motion + for vpa/mvpa caps + semi_auto_right_margin sam YE printing in last + column causes cr + status_line_esc_ok eslok es escape can be used + on the status line + tilde_glitch hz hz cannot print ~'s + (hazeltine) + + + transparent_underline ul ul underline character + overstrikes + xon_xoff xon xo terminal uses + xon/xoff handshaking + + These are the numeric capabilities: + + + <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> + <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> + columns cols co number of columns in + a line + init_tabs it it tabs initially every + # spaces + label_height lh lh rows in each label + label_width lw lw columns in each + label + lines lines li number of lines on + screen or page + lines_of_memory lm lm lines of memory if > + line. 0 means varies + magic_cookie_glitch xmc sg number of blank + characters left by + smso or rmso + max_attributes ma ma maximum combined + attributes terminal + can handle + max_colors colors Co maximum number of + colors on screen + max_pairs pairs pa maximum number of + color-pairs on the + screen + maximum_windows wnum MW maximum number of + defineable windows + no_color_video ncv NC video attributes + that cannot be used + with colors + num_labels nlab Nl number of labels on + screen + padding_baud_rate pb pb lowest baud rate + where padding needed + virtual_terminal vt vt virtual terminal + number (CB/unix) + width_status_line wsl ws number of columns in + status line + + The following numeric capabilities are present in the + SVr4.0 term structure, but are not yet documented in the + man page. They came in with SVr4's printer support. + + + <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> + <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> + bit_image_entwining bitwin Yo number of passes for + each bit-image row + bit_image_type bitype Yp type of bit-image + device + buffer_capacity bufsz Ya numbers of bytes + buffered before + printing + buttons btns BT number of buttons on + mouse + dot_horz_spacing spinh Yc spacing of dots hor- + izontally in dots + per inch + + dot_vert_spacing spinv Yb spacing of pins ver- + tically in pins per + inch + max_micro_address maddr Yd maximum value in + micro_..._address + max_micro_jump mjump Ye maximum value in + parm_..._micro + micro_col_size mcs Yf character step size + when in micro mode + micro_line_size mls Yg line step size when + in micro mode + number_of_pins npins Yh numbers of pins in + print-head + output_res_char orc Yi horizontal resolu- + tion in units per + line + output_res_horz_inch orhi Yk horizontal resolu- + tion in units per + inch + output_res_line orl Yj vertical resolution + in units per line + output_res_vert_inch orvi Yl vertical resolution + in units per inch + print_rate cps Ym print rate in char- + acters per second + wide_char_size widcs Yn character step size + when in double wide + mode + + These are the string capabilities: + + + <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> + <STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> + acs_chars acsc ac graphics charset + pairs, based on + vt100 + back_tab cbt bt back tab (P) + bell bel bl audible signal + (bell) (P) + carriage_return cr cr carriage return (P*) + (P*) + change_char_pitch cpi ZA Change number of + characters per inch + to #1 + change_line_pitch lpi ZB Change number of + lines per inch to #1 + change_res_horz chr ZC Change horizontal + resolution to #1 + change_res_vert cvr ZD Change vertical res- + olution to #1 + change_scroll_region csr cs change region to + line #1 to line #2 + (P) + char_padding rmp rP like ip but when in + insert mode + clear_all_tabs tbc ct clear all tab stops + (P) + clear_margins mgc MC clear right and left + soft margins + clear_screen clear cl clear screen and + home cursor (P*) + clr_bol el1 cb Clear to beginning + of line + + + clr_eol el ce clear to end of line + (P) + clr_eos ed cd clear to end of + screen (P*) + column_address hpa ch horizontal position + #1, absolute (P) + command_character cmdch CC terminal settable + cmd character in + prototype !? + create_window cwin CW define a window #1 + from #2,#3 to #4,#5 + cursor_address cup cm move to row #1 + columns #2 + cursor_down cud1 do down one line + cursor_home home ho home cursor (if no + cup) + cursor_invisible civis vi make cursor invisi- + ble + cursor_left cub1 le move left one space + cursor_mem_address mrcup CM memory relative cur- + sor addressing, move + to row #1 columns #2 + cursor_normal cnorm ve make cursor appear + normal (undo + civis/cvvis) + cursor_right cuf1 nd non-destructive + space (move right + one space) + cursor_to_ll ll ll last line, first + column (if no cup) + cursor_up cuu1 up up one line + cursor_visible cvvis vs make cursor very + visible + define_char defc ZE Define a character + #1, #2 dots wide, + descender #3 + delete_character dch1 dc delete character + (P*) + delete_line dl1 dl delete line (P*) + dial_phone dial DI dial number #1 + dis_status_line dsl ds disable status line + display_clock dclk DK display clock + down_half_line hd hd half a line down + ena_acs enacs eA enable alternate + char set + enter_alt_charset_mode smacs as start alternate + character set (P) + enter_am_mode smam SA turn on automatic + margins + enter_blink_mode blink mb turn on blinking + enter_bold_mode bold md turn on bold (extra + bright) mode + enter_ca_mode smcup ti string to start pro- + grams using cup + enter_delete_mode smdc dm enter delete mode + enter_dim_mode dim mh turn on half-bright + mode + enter_doublewide_mode swidm ZF Enter double-wide + mode + enter_draft_quality sdrfq ZG Enter draft-quality + mode + enter_insert_mode smir im enter insert mode + enter_italics_mode sitm ZH Enter italic mode + enter_leftward_mode slm ZI Start leftward car- + riage motion + + enter_micro_mode smicm ZJ Start micro-motion + mode + enter_near_letter_quality snlq ZK Enter NLQ mode + enter_normal_quality snrmq ZL Enter normal-quality + mode + enter_protected_mode prot mp turn on protected + mode + enter_reverse_mode rev mr turn on reverse + video mode + enter_secure_mode invis mk turn on blank mode + (characters invisi- + ble) + enter_shadow_mode sshm ZM Enter shadow-print + mode + enter_standout_mode smso so begin standout mode + enter_subscript_mode ssubm ZN Enter subscript mode + enter_superscript_mode ssupm ZO Enter superscript + mode + enter_underline_mode smul us begin underline mode + enter_upward_mode sum ZP Start upward car- + riage motion + enter_xon_mode smxon SX turn on xon/xoff + handshaking + erase_chars ech ec erase #1 characters + (P) + exit_alt_charset_mode rmacs ae end alternate char- + acter set (P) + exit_am_mode rmam RA turn off automatic + margins + exit_attribute_mode sgr0 me turn off all + attributes + exit_ca_mode rmcup te strings to end pro- + grams using cup + exit_delete_mode rmdc ed end delete mode + exit_doublewide_mode rwidm ZQ End double-wide mode + exit_insert_mode rmir ei exit insert mode + exit_italics_mode ritm ZR End italic mode + exit_leftward_mode rlm ZS End left-motion mode + exit_micro_mode rmicm ZT End micro-motion + mode + exit_shadow_mode rshm ZU End shadow-print + mode + exit_standout_mode rmso se exit standout mode + exit_subscript_mode rsubm ZV End subscript mode + exit_superscript_mode rsupm ZW End superscript mode + exit_underline_mode rmul ue exit underline mode + exit_upward_mode rum ZX End reverse charac- + ter motion + exit_xon_mode rmxon RX turn off xon/xoff + handshaking + fixed_pause pause PA pause for 2-3 sec- + onds + flash_hook hook fh flash switch hook + flash_screen flash vb visible bell (may + not move cursor) + form_feed ff ff hardcopy terminal + page eject (P*) + from_status_line fsl fs return from status + line + goto_window wingo WG go to window #1 + hangup hup HU hang-up phone + init_1string is1 i1 initialization + string + init_2string is2 is initialization + string + + init_3string is3 i3 initialization + string + init_file if if name of initializa- + tion file + init_prog iprog iP path name of program + for initialization + initialize_color initc Ic initialize color #1 + to (#2,#3,#4) + initialize_pair initp Ip Initialize color + pair #1 to + fg=(#2,#3,#4), + bg=(#5,#6,#7) + insert_character ich1 ic insert character (P) + insert_line il1 al insert line (P*) + insert_padding ip ip insert padding after + inserted character + key_a1 ka1 K1 upper left of keypad + key_a3 ka3 K3 upper right of key- + pad + key_b2 kb2 K2 center of keypad + key_backspace kbs kb backspace key + key_beg kbeg @1 begin key + key_btab kcbt kB back-tab key + key_c1 kc1 K4 lower left of keypad + key_c3 kc3 K5 lower right of key- + pad + key_cancel kcan @2 cancel key + key_catab ktbc ka clear-all-tabs key + key_clear kclr kC clear-screen or + erase key + key_close kclo @3 close key + key_command kcmd @4 command key + key_copy kcpy @5 copy key + key_create kcrt @6 create key + key_ctab kctab kt clear-tab key + key_dc kdch1 kD delete-character key + key_dl kdl1 kL delete-line key + key_down kcud1 kd down-arrow key + key_eic krmir kM sent by rmir or smir + in insert mode + key_end kend @7 end key + key_enter kent @8 enter/send key + key_eol kel kE clear-to-end-of-line + key + key_eos ked kS clear-to-end-of- + screen key + key_exit kext @9 exit key + key_f0 kf0 k0 F0 function key + key_f1 kf1 k1 F1 function key + key_f10 kf10 k; F10 function key + key_f11 kf11 F1 F11 function key + key_f12 kf12 F2 F12 function key + key_f13 kf13 F3 F13 function key + key_f14 kf14 F4 F14 function key + key_f15 kf15 F5 F15 function key + key_f16 kf16 F6 F16 function key + key_f17 kf17 F7 F17 function key + key_f18 kf18 F8 F18 function key + key_f19 kf19 F9 F19 function key + key_f2 kf2 k2 F2 function key + key_f20 kf20 FA F20 function key + key_f21 kf21 FB F21 function key + key_f22 kf22 FC F22 function key + key_f23 kf23 FD F23 function key + key_f24 kf24 FE F24 function key + + key_f25 kf25 FF F25 function key + key_f26 kf26 FG F26 function key + key_f27 kf27 FH F27 function key + key_f28 kf28 FI F28 function key + key_f29 kf29 FJ F29 function key + key_f3 kf3 k3 F3 function key + key_f30 kf30 FK F30 function key + key_f31 kf31 FL F31 function key + key_f32 kf32 FM F32 function key + key_f33 kf33 FN F33 function key + key_f34 kf34 FO F34 function key + key_f35 kf35 FP F35 function key + key_f36 kf36 FQ F36 function key + key_f37 kf37 FR F37 function key + key_f38 kf38 FS F38 function key + key_f39 kf39 FT F39 function key + key_f4 kf4 k4 F4 function key + key_f40 kf40 FU F40 function key + key_f41 kf41 FV F41 function key + key_f42 kf42 FW F42 function key + key_f43 kf43 FX F43 function key + key_f44 kf44 FY F44 function key + key_f45 kf45 FZ F45 function key + key_f46 kf46 Fa F46 function key + key_f47 kf47 Fb F47 function key + key_f48 kf48 Fc F48 function key + key_f49 kf49 Fd F49 function key + key_f5 kf5 k5 F5 function key + key_f50 kf50 Fe F50 function key + key_f51 kf51 Ff F51 function key + key_f52 kf52 Fg F52 function key + key_f53 kf53 Fh F53 function key + key_f54 kf54 Fi F54 function key + key_f55 kf55 Fj F55 function key + key_f56 kf56 Fk F56 function key + key_f57 kf57 Fl F57 function key + key_f58 kf58 Fm F58 function key + key_f59 kf59 Fn F59 function key + key_f6 kf6 k6 F6 function key + key_f60 kf60 Fo F60 function key + key_f61 kf61 Fp F61 function key + key_f62 kf62 Fq F62 function key + key_f63 kf63 Fr F63 function key + key_f7 kf7 k7 F7 function key + key_f8 kf8 k8 F8 function key + key_f9 kf9 k9 F9 function key + key_find kfnd @0 find key + key_help khlp %1 help key + key_home khome kh home key + key_ic kich1 kI insert-character key + key_il kil1 kA insert-line key + key_left kcub1 kl left-arrow key + key_ll kll kH lower-left key (home + down) + key_mark kmrk %2 mark key + key_message kmsg %3 message key + key_move kmov %4 move key + key_next knxt %5 next key + key_npage knp kN next-page key + key_open kopn %6 open key + key_options kopt %7 options key + key_ppage kpp kP previous-page key + key_previous kprv %8 previous key + key_print kprt %9 print key + key_redo krdo %0 redo key + + key_reference kref &1 reference key + key_refresh krfr &2 refresh key + key_replace krpl &3 replace key + key_restart krst &4 restart key + key_resume kres &5 resume key + key_right kcuf1 kr right-arrow key + key_save ksav &6 save key + key_sbeg kBEG &9 shifted begin key + key_scancel kCAN &0 shifted cancel key + key_scommand kCMD *1 shifted command key + key_scopy kCPY *2 shifted copy key + key_screate kCRT *3 shifted create key + key_sdc kDC *4 shifted delete-char- + acter key + key_sdl kDL *5 shifted delete-line + key + key_select kslt *6 select key + key_send kEND *7 shifted end key + key_seol kEOL *8 shifted clear-to- + end-of-line key + key_sexit kEXT *9 shifted exit key + key_sf kind kF scroll-forward key + key_sfind kFND *0 shifted find key + key_shelp kHLP #1 shifted help key + key_shome kHOM #2 shifted home key + key_sic kIC #3 shifted insert-char- + acter key + key_sleft kLFT #4 shifted left-arrow + key + key_smessage kMSG %a shifted message key + key_smove kMOV %b shifted move key + key_snext kNXT %c shifted next key + key_soptions kOPT %d shifted options key + key_sprevious kPRV %e shifted previous key + key_sprint kPRT %f shifted print key + key_sr kri kR scroll-backward key + key_sredo kRDO %g shifted redo key + key_sreplace kRPL %h shifted replace key + key_sright kRIT %i shifted right-arrow + key + key_srsume kRES %j shifted resume key + key_ssave kSAV !1 shifted save key + key_ssuspend kSPD !2 shifted suspend key + key_stab khts kT set-tab key + key_sundo kUND !3 shifted undo key + key_suspend kspd &7 suspend key + key_undo kund &8 undo key + key_up kcuu1 ku up-arrow key + keypad_local rmkx ke leave 'key- + board_transmit' mode + keypad_xmit smkx ks enter 'key- + board_transmit' mode + lab_f0 lf0 l0 label on function + key f0 if not f0 + lab_f1 lf1 l1 label on function + key f1 if not f1 + lab_f10 lf10 la label on function + key f10 if not f10 + lab_f2 lf2 l2 label on function + key f2 if not f2 + lab_f3 lf3 l3 label on function + key f3 if not f3 + lab_f4 lf4 l4 label on function + key f4 if not f4 + + + lab_f5 lf5 l5 label on function + key f5 if not f5 + lab_f6 lf6 l6 label on function + key f6 if not f6 + lab_f7 lf7 l7 label on function + key f7 if not f7 + lab_f8 lf8 l8 label on function + key f8 if not f8 + lab_f9 lf9 l9 label on function + key f9 if not f9 + label_format fln Lf label format + label_off rmln LF turn off soft labels + label_on smln LO turn on soft labels + meta_off rmm mo turn off meta mode + meta_on smm mm turn on meta mode + (8th-bit on) + micro_column_address mhpa ZY Like column_address + in micro mode + micro_down mcud1 ZZ Like cursor_down in + micro mode + micro_left mcub1 Za Like cursor_left in + micro mode + micro_right mcuf1 Zb Like cursor_right in + micro mode + micro_row_address mvpa Zc Like row_address #1 + in micro mode + micro_up mcuu1 Zd Like cursor_up in + micro mode + newline nel nw newline (behave like + cr followed by lf) + order_of_pins porder Ze Match software bits + to print-head pins + orig_colors oc oc Set all color pairs + to the original ones + orig_pair op op Set default pair to + its original value + pad_char pad pc padding char + (instead of null) + parm_dch dch DC delete #1 characters + (P*) + parm_delete_line dl DL delete #1 lines (P*) + parm_down_cursor cud DO down #1 lines (P*) + parm_down_micro mcud Zf Like parm_down_cur- + sor in micro mode + parm_ich ich IC insert #1 characters + (P*) + parm_index indn SF scroll forward #1 + lines (P) + parm_insert_line il AL insert #1 lines (P*) + parm_left_cursor cub LE move #1 characters + to the left (P) + parm_left_micro mcub Zg Like parm_left_cur- + sor in micro mode + parm_right_cursor cuf RI move #1 characters + to the right (P*) + parm_right_micro mcuf Zh Like parm_right_cur- + sor in micro mode + parm_rindex rin SR scroll back #1 lines + (P) + parm_up_cursor cuu UP up #1 lines (P*) + parm_up_micro mcuu Zi Like parm_up_cursor + in micro mode + pkey_key pfkey pk program function key + #1 to type string #2 + + + pkey_local pfloc pl program function key + #1 to execute string + #2 + pkey_xmit pfx px program function key + #1 to transmit + string #2 + plab_norm pln pn program label #1 to + show string #2 + print_screen mc0 ps print contents of + screen + prtr_non mc5p pO turn on printer for + #1 bytes + prtr_off mc4 pf turn off printer + prtr_on mc5 po turn on printer + pulse pulse PU select pulse dialing + quick_dial qdial QD dial number #1 with- + out checking + remove_clock rmclk RC remove clock + repeat_char rep rp repeat char #1 #2 + times (P*) + req_for_input rfi RF send next input char + (for ptys) + reset_1string rs1 r1 reset string + reset_2string rs2 r2 reset string + reset_3string rs3 r3 reset string + reset_file rf rf name of reset file + restore_cursor rc rc restore cursor to + position of last + save_cursor + row_address vpa cv vertical position #1 + absolute (P) + save_cursor sc sc save current cursor + position (P) + scroll_forward ind sf scroll text up (P) + scroll_reverse ri sr scroll text down (P) + select_char_set scs Zj Select character + set, #1 + set_attributes sgr sa define video + attributes #1-#9 + (PG9) + set_background setb Sb Set background color + #1 + set_bottom_margin smgb Zk Set bottom margin at + current line + set_bottom_margin_parm smgbp Zl Set bottom margin at + line #1 or (if smgtp + is not given) #2 + lines from bottom + set_clock sclk SC set clock, #1 hrs #2 + mins #3 secs + set_color_pair scp sp Set current color + pair to #1 + set_foreground setf Sf Set foreground color + #1 + set_left_margin smgl ML set left soft margin + at current column. + See smgl. (ML is not + in BSD termcap). + set_left_margin_parm smglp Zm Set left (right) + margin at column #1 + set_right_margin smgr MR set right soft mar- + gin at current col- + umn + set_right_margin_parm smgrp Zn Set right margin at + column #1 + + set_tab hts st set a tab in every + row, current columns + set_top_margin smgt Zo Set top margin at + current line + set_top_margin_parm smgtp Zp Set top (bottom) + margin at row #1 + set_window wind wi current window is + lines #1-#2 cols + #3-#4 + start_bit_image sbim Zq Start printing bit + image graphics + start_char_set_def scsd Zr Start character set + definition #1, with + #2 characters in the + set + stop_bit_image rbim Zs Stop printing bit + image graphics + stop_char_set_def rcsd Zt End definition of + character set #1 + subscript_characters subcs Zu List of subscript- + able characters + superscript_characters supcs Zv List of superscript- + able characters + tab ht ta tab to next 8-space + hardware tab stop + these_cause_cr docr Zw Printing any of + these characters + causes CR + to_status_line tsl ts move to status line, + column #1 + tone tone TO select touch tone + dialing + underline_char uc uc underline char and + move past it + up_half_line hu hu half a line up + user0 u0 u0 User string #0 + user1 u1 u1 User string #1 + user2 u2 u2 User string #2 + user3 u3 u3 User string #3 + user4 u4 u4 User string #4 + user5 u5 u5 User string #5 + user6 u6 u6 User string #6 + user7 u7 u7 User string #7 + user8 u8 u8 User string #8 + user9 u9 u9 User string #9 + wait_tone wait WA wait for dial-tone + xoff_character xoffc XF XOFF character + xon_character xonc XN XON character + zero_motion zerom Zx No motion for subse- + quent character + + The following string capabilities are present in the + SVr4.0 term structure, but were originally not documented + in the man page. + + + <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> + <STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> + alt_scancode_esc scesa S8 Alternate escape + for scancode emu- + lation + bit_image_carriage_return bicr Yv Move to beginning + of same row + bit_image_newline binel Zz Move to next row + of the bit image + + bit_image_repeat birep Xy Repeat bit image + cell #1 #2 times + char_set_names csnm Zy Produce #1'th item + from list of char- + acter set names + code_set_init csin ci Init sequence for + multiple codesets + color_names colornm Yw Give name for + color #1 + define_bit_image_region defbi Yx Define rectan- + gualar bit image + region + device_type devt dv Indicate lan- + guage/codeset sup- + port + display_pc_char dispc S1 Display PC charac- + ter #1 + end_bit_image_region endbi Yy End a bit-image + region + enter_pc_charset_mode smpch S2 Enter PC character + display mode + enter_scancode_mode smsc S4 Enter PC scancode + mode + exit_pc_charset_mode rmpch S3 Exit PC character + display mode + exit_scancode_mode rmsc S5 Exit PC scancode + mode + get_mouse getm Gm Curses should get + button events, + parameter #1 not + documented. + key_mouse kmous Km Mouse event has + occurred + mouse_info minfo Mi Mouse status + information + pc_term_options pctrm S6 PC terminal + options + pkey_plab pfxl xl Program function + key #1 to type + string #2 and show + string #3 + req_mouse_pos reqmp RQ Request mouse + position + scancode_escape scesc S7 Escape for scan- + code emulation + set0_des_seq s0ds s0 Shift to codeset 0 + (EUC set 0, ASCII) + set1_des_seq s1ds s1 Shift to codeset 1 + set2_des_seq s2ds s2 Shift to codeset 2 + set3_des_seq s3ds s3 Shift to codeset 3 + set_a_background setab AB Set background + color to #1, using + ANSI escape + set_a_foreground setaf AF Set foreground + color to #1, using + ANSI escape + set_color_band setcolor Yz Change to ribbon + color #1 + set_lr_margin smglr ML Set both left and + right margins to + #1, #2. (ML is + not in BSD term- + cap). + set_page_length slines YZ Set page length to + #1 lines + + set_tb_margin smgtb MT Sets both top and + bottom margins to + #1, #2 + + The XSI Curses standard added these. They are some + post-4.1 versions of System V curses, e.g., Solaris 2.5 + and IRIX 6.x. The <STRONG>ncurses</STRONG> termcap names for them are + invented; according to the XSI Curses standard, they have + no termcap names. If your compiled terminfo entries use + these, they may not be binary-compatible with System V + terminfo entries after SVr4.1; beware! + + + <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> + <STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> + enter_horizontal_hl_mode ehhlm Xh Enter horizontal + highlight mode + enter_left_hl_mode elhlm Xl Enter left highlight + mode + enter_low_hl_mode elohlm Xo Enter low highlight + mode + enter_right_hl_mode erhlm Xr Enter right high- + light mode + enter_top_hl_mode ethlm Xt Enter top highlight + mode + enter_vertical_hl_mode evhlm Xv Enter vertical high- + light mode + set_a_attributes sgr1 sA Define second set of + video attributes + #1-#6 + set_pglen_inch slengthsL YI Set page length + to #1 hundredth of + an inch + + <STRONG>A</STRONG> <STRONG>Sample</STRONG> <STRONG>Entry</STRONG> + The following entry, describing an ANSI-standard terminal, + is representative of what a <STRONG>terminfo</STRONG> entry for a modern + terminal typically looks like. + + ansi|ansi/pc-term compatible with color, + mc5i, + colors#8, ncv#3, pairs#64, + cub=\E[%p1%dD, cud=\E[%p1%dB, cuf=\E[%p1%dC, + cuu=\E[%p1%dA, dch=\E[%p1%dP, dl=\E[%p1%dM, + ech=\E[%p1%dX, el1=\E[1K, hpa=\E[%p1%dG, ht=\E[I, + ich=\E[%p1%d@, il=\E[%p1%dL, indn=\E[%p1%dS, .indn=\E[%p1%dT, + kbs=^H, kcbt=\E[Z, kcub1=\E[D, kcud1=\E[B, + kcuf1=\E[C, kcuu1=\E[A, kf1=\E[M, kf10=\E[V, + kf11=\E[W, kf12=\E[X, kf2=\E[N, kf3=\E[O, kf4=\E[P, + kf5=\E[Q, kf6=\E[R, kf7=\E[S, kf8=\E[T, kf9=\E[U, + kich1=\E[L, mc4=\E[4i, mc5=\E[5i, nel=\r\E[S, + op=\E[37;40m, rep=%p1%c\E[%p2%{1}%-%db, + rin=\E[%p1%dT, s0ds=\E(B, s1ds=\E)B, s2ds=\E*B, + s3ds=\E+B, setab=\E[4%p1%dm, setaf=\E[3%p1%dm, + setb=\E[4%?%p1%{1}%=%t4%e%p1%{3}%=%t6%e%p1%{4}%=%t1%e%p1%{6}%=%t3%e%p1%d%;m, + setf=\E[3%?%p1%{1}%=%t4%e%p1%{3}%=%t6%e%p1%{4}%=%t1%e%p1%{6}%=%t3%e%p1%d%;m, + sgr=\E[0;10%?%p1%t;7%;%?%p2%t;4%;%?%p3%t;7%;%?%p4%t;5%;%?%p6%t;1%;%?%p7%t;8%;%?%p8%t;11%;%?%p9%t;12%;m, + sgr0=\E[0;10m, tbc=\E[2g, u6=\E[%d;%dR, u7=\E[6n, + u8=\E[?%[;0123456789]c, u9=\E[c, vpa=\E[%p1%dd, + + Entries may continue onto multiple lines by placing white + space at the beginning of each line except the first. + Comments may be included on lines beginning with ``#''. + Capabilities in <EM>terminfo</EM> are of three types: Boolean capa- + bilities which indicate that the terminal has some partic- + ular feature, numeric capabilities giving the size of the + terminal or the size of particular delays, and string + capabilities, which give a sequence which can be used to + perform particular terminal operations. + + + <STRONG>Types</STRONG> <STRONG>of</STRONG> <STRONG>Capabilities</STRONG> + All capabilities have names. For instance, the fact that + ANSI-standard terminals have <EM>automatic</EM> <EM>margins</EM> (i.e., an + automatic return and line-feed when the end of a line is + reached) is indicated by the capability <STRONG>am</STRONG>. Hence the + description of ansi includes <STRONG>am</STRONG>. Numeric capabilities are + followed by the character `#' and then a positive value. + Thus <STRONG>cols</STRONG>, which indicates the number of columns the ter- + minal has, gives the value `80' for ansi. Values for + numeric capabilities may be specified in decimal, octal or + hexadecimal, using the C programming language conventions + (e.g., 255, 0377 and 0xff or 0xFF). + + Finally, string valued capabilities, such as <STRONG>el</STRONG> (clear to + end of line sequence) are given by the two-character code, + an `=', and then a string ending at the next following + `,'. + + A number of escape sequences are provided in the string + valued capabilities for easy encoding of characters there. + Both <STRONG>\E</STRONG> and <STRONG>\e</STRONG> map to an ESCAPE character, <STRONG>^x</STRONG> maps to a + control-x for any appropriate x, and the sequences <STRONG>\n</STRONG> <STRONG>\l</STRONG> + <STRONG>\r</STRONG> <STRONG>\t</STRONG> <STRONG>\b</STRONG> <STRONG>\f</STRONG> <STRONG>\s</STRONG> give a newline, line-feed, return, tab, + backspace, form-feed, and space. Other escapes include <STRONG>\^</STRONG> + for <STRONG>^</STRONG>, <STRONG>\\</STRONG> for <STRONG>\</STRONG>, <STRONG>\</STRONG>, for comma, <STRONG>\:</STRONG> for <STRONG>:</STRONG>, and <STRONG>\0</STRONG> for null. + (<STRONG>\0</STRONG> will produce \200, which does not terminate a string + but behaves as a null character on most terminals, provid- + ing CS7 is specified. See <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>.) Finally, characters + may be given as three octal digits after a <STRONG>\</STRONG>. + + A delay in milliseconds may appear anywhere in a string + capability, enclosed in $<..> brackets, as in <STRONG>el</STRONG>=\EK$<5>, + and padding characters are supplied by <EM>tputs</EM> to provide + this delay. The delay must be a number with at most one + decimal place of precision; it may be followed by suffixes + `*' or '/' or both. A `*' indicates that the padding + required is proportional to the number of lines affected + by the operation, and the amount given is the per- + affected-unit padding required. (In the case of insert + character, the factor is still the number of <EM>lines</EM> + affected.) Normally, padding is advisory if the device + has the <STRONG>xon</STRONG> capability; it is used for cost computation + but does not trigger delays. A `/' suffix indicates that + the padding is mandatory and forces a delay of the given + number of milliseconds even on devices for which <STRONG>xon</STRONG> is + present to indicate flow control. + + Sometimes individual capabilities must be commented out. + To do this, put a period before the capability name. For + example, see the second <STRONG>ind</STRONG> in the example above. + + + <STRONG>Fetching</STRONG> <STRONG>Compiled</STRONG> <STRONG>Descriptions</STRONG> + If the environment variable TERMINFO is set, it is inter- + preted as the pathname of a directory containing the com- + piled description you are working on. Only that directory + is searched. + + If TERMINFO is not set, the <STRONG>ncurses</STRONG> version of the ter- + minfo reader code will instead look in the directory + <STRONG>$HOME/.terminfo</STRONG> for a compiled description. If it fails + to find one there, and the environment variable TER- + MINFO_DIRS is set, it will interpret the contents of that + variable as a list of colon- separated directories to be + searched (an empty entry is interpreted as a command to + search <EM>/usr/share/terminfo</EM>). If no description is found + in any of the TERMINFO_DIRS directories, the fetch fails. + + If neither TERMINFO nor TERMINFO_DIRS is set, the last + place tried will be the system terminfo directory, + <EM>/usr/share/terminfo</EM>. + + (Neither the <STRONG>$HOME/.terminfo</STRONG> lookups nor TERMINFO_DIRS + extensions are supported under stock System V ter- + minfo/curses.) + + + <STRONG>Preparing</STRONG> <STRONG>Descriptions</STRONG> + We now outline how to prepare descriptions of terminals. + The most effective way to prepare a terminal description + is by imitating the description of a similar terminal in + <EM>terminfo</EM> and to build up a description gradually, using + partial descriptions with <EM>vi</EM> or some other screen-oriented + program to check that they are correct. Be aware that a + very unusual terminal may expose deficiencies in the abil- + ity of the <EM>terminfo</EM> file to describe it or bugs in the + screen-handling code of the test program. + + To get the padding for insert line right (if the terminal + manufacturer did not document it) a severe test is to edit + a large file at 9600 baud, delete 16 or so lines from the + middle of the screen, then hit the `u' key several times + quickly. If the terminal messes up, more padding is usu- + ally needed. A similar test can be used for insert char- + acter. + + + <STRONG>Basic</STRONG> <STRONG>Capabilities</STRONG> + The number of columns on each line for the terminal is + given by the <STRONG>cols</STRONG> numeric capability. If the terminal is + a CRT, then the number of lines on the screen is given by + the <STRONG>lines</STRONG> capability. If the terminal wraps around to the + beginning of the next line when it reaches the right mar- + gin, then it should have the <STRONG>am</STRONG> capability. If the termi- + nal can clear its screen, leaving the cursor in the home + position, then this is given by the <STRONG>clear</STRONG> string capabil- + ity. If the terminal overstrikes (rather than clearing a + position when a character is struck over) then it should + have the <STRONG>os</STRONG> capability. If the terminal is a printing + terminal, with no soft copy unit, give it both <STRONG>hc</STRONG> and <STRONG>os</STRONG>. + (<STRONG>os</STRONG> applies to storage scope terminals, such as TEKTRONIX + 4010 series, as well as hard copy and APL terminals.) If + there is a code to move the cursor to the left edge of the + current row, give this as <STRONG>cr</STRONG>. (Normally this will be car- + riage return, control M.) If there is a code to produce + an audible signal (bell, beep, etc) give this as <STRONG>bel</STRONG>. + + If there is a code to move the cursor one position to the + left (such as backspace) that capability should be given + as <STRONG>cub1</STRONG>. Similarly, codes to move to the right, up, and + down should be given as <STRONG>cuf1</STRONG>, <STRONG>cuu1</STRONG>, and <STRONG>cud1</STRONG>. These local + cursor motions should not alter the text they pass over, + for example, you would not normally use `<STRONG>cuf1</STRONG>= ' because + the space would erase the character moved over. + + A very important point here is that the local cursor + motions encoded in <EM>terminfo</EM> are undefined at the left and + top edges of a CRT terminal. Programs should never + attempt to backspace around the left edge, unless <STRONG>bw</STRONG> is + given, and never attempt to go up locally off the top. In + order to scroll text up, a program will go to the bottom + left corner of the screen and send the <STRONG>ind</STRONG> (index) string. + + To scroll text down, a program goes to the top left corner + of the screen and sends the <STRONG>ri</STRONG> (reverse index) string. + The strings <STRONG>ind</STRONG> and <STRONG>ri</STRONG> are undefined when not on their + respective corners of the screen. + + Parameterized versions of the scrolling sequences are <STRONG>indn</STRONG> + and <STRONG>rin</STRONG> which have the same semantics as <STRONG>ind</STRONG> and <STRONG>ri</STRONG> except + that they take one parameter, and scroll that many lines. + They are also undefined except at the appropriate edge of + the screen. + + The <STRONG>am</STRONG> capability tells whether the cursor sticks at the + right edge of the screen when text is output, but this + does not necessarily apply to a <STRONG>cuf1</STRONG> from the last column. + The only local motion which is defined from the left edge + is if <STRONG>bw</STRONG> is given, then a <STRONG>cub1</STRONG> from the left edge will + move to the right edge of the previous row. If <STRONG>bw</STRONG> is not + given, the effect is undefined. This is useful for draw- + ing a box around the edge of the screen, for example. If + the terminal has switch selectable automatic margins, the + <EM>terminfo</EM> file usually assumes that this is on; i.e., <STRONG>am</STRONG>. + If the terminal has a command which moves to the first + column of the next line, that command can be given as <STRONG>nel</STRONG> + (newline). It does not matter if the command clears the + remainder of the current line, so if the terminal has no + <STRONG>cr</STRONG> and <STRONG>lf</STRONG> it may still be possible to craft a working <STRONG>nel</STRONG> + out of one or both of them. + + These capabilities suffice to describe hard-copy and + "glass-tty" terminals. Thus the model 33 teletype is + described as + + 33|tty33|tty|model 33 teletype, + bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, + + while the Lear Siegler ADM-3 is described as + + adm3|3|lsi adm3, + am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, + ind=^J, lines#24, + + + <STRONG>Parameterized</STRONG> <STRONG>Strings</STRONG> + Cursor addressing and other strings requiring parameters + in the terminal are described by a parameterized string + capability, with <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG> like escapes <STRONG>%x</STRONG> in it. For + example, to address the cursor, the <STRONG>cup</STRONG> capability is + given, using two parameters: the row and column to address + to. (Rows and columns are numbered from zero and refer to + the physical screen visible to the user, not to any unseen + memory.) If the terminal has memory relative cursor + addressing, that can be indicated by <STRONG>mrcup</STRONG>. + + The parameter mechanism uses a stack and special <STRONG>%</STRONG> codes + to manipulate it. Typically a sequence will push one of + the parameters onto the stack and then print it in some + format. Print (e.g., "%d") is a special case. Other + operations, including "%t" pop their operand from the + stack. It is noted that more complex operations are often + necessary, e.g., in the <STRONG>sgr</STRONG> string. + + The <STRONG>%</STRONG> encodings have the following meanings: + + + %% outputs `%' + + %<EM>[[</EM>:<EM>]flags][width[.precision]][</EM>doxXs<EM>]</EM> + as in <STRONG>printf</STRONG>, flags are [-+#] and space. Use a `:' + to allow the next character to be a `-' flag, avoid- + ing interpreting "%-" as an operator. + + %c print pop() like %c in <STRONG>printf</STRONG> + + %s print pop() like %s in <STRONG>printf</STRONG> + + %p[1-9] + push <EM>i</EM>'th parameter + + %P[a-z] + set dynamic variable [a-z] to pop() + + %g[a-z] + get dynamic variable [a-z] and push it + + %P[A-Z] + set static variable [a-z] to pop() + + %g[A-Z] + get static variable [a-z] and push it + + The terms "static" and "dynamic" are misleading. + Historically, these are simply two different sets of + variables, whose values are not reset between calls + to <STRONG>tparm</STRONG>. However, that fact is not documented in + other implementations. Relying on it will adversely + impact portability to other implementations. + + %'<EM>c</EM>' char constant <EM>c</EM> + + %{<EM>nn</EM>} + integer constant <EM>nn</EM> + + %l push strlen(pop) + + %+ %- %* %/ %m + arithmetic (%m is mod): push(pop() op pop()) + + %& %| %^ + bit operations (AND, OR and exclusive-OR): push(pop() + op pop()) + + %= %> %< + logical operations: push(pop() op pop()) + + %A, %O + logical AND and OR operations (for conditionals) + + %! %~ + unary operations (logical and bit complement): + push(op pop()) + + %i add 1 to first two parameters (for ANSI terminals) + + %? <EM>expr</EM> %t <EM>thenpart</EM> %e <EM>elsepart</EM> %; + This forms an if-then-else. The %e <EM>elsepart</EM> is + optional. Usually the %? <EM>expr</EM> part pushes a value + onto the stack, and %t pops it from the stack, test- + ing if it is nonzero (true). If it is zero (false), + control passes to the %e (else) part. + + It is possible to form else-if's a la Algol 68: + %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; + + where ci are conditions, bi are bodies. + + Use the <STRONG>-f</STRONG> option of <STRONG>tic</STRONG> or <STRONG>infocmp</STRONG> to see the struc- + ture of if-then-else's. Some strings, e.g., <STRONG>sgr</STRONG> can + be very complicated when written on one line. The <STRONG>-f</STRONG> + option splits the string into lines with the parts + indented. + + Binary operations are in postfix form with the operands in + the usual order. That is, to get x-5 one would use + "%gx%{5}%-". %P and %g variables are persistent across + escape-string evaluations. + + Consider the HP2645, which, to get to row 3 and column 12, + needs to be sent \E&a12c03Y padded for 6 milliseconds. + Note that the order of the rows and columns is inverted + here, and that the row and column are printed as two dig- + its. Thus its <STRONG>cup</STRONG> capability is "cup=6\E&%p2%2dc%p1%2dY". + + The Microterm ACT-IV needs the current row and column sent + preceded by a <STRONG>^T</STRONG>, with the row and column simply encoded + in binary, "cup=^T%p1%c%p2%c". Terminals which use "%c" + need to be able to backspace the cursor (<STRONG>cub1</STRONG>), and to + move the cursor up one line on the screen (<STRONG>cuu1</STRONG>). This is + necessary because it is not always safe to transmit <STRONG>\n</STRONG> <STRONG>^D</STRONG> + and <STRONG>\r</STRONG>, as the system may change or discard them. (The + library routines dealing with terminfo set tty modes so + that tabs are never expanded, so \t is safe to send. This + turns out to be essential for the Ann Arbor 4080.) + + A final example is the LSI ADM-3a, which uses row and col- + umn offset by a blank character, thus "cup=\E=%p1%' + '%+%c%p2%' '%+%c". After sending `\E=', this pushes the + first parameter, pushes the ASCII value for a space (32), + adds them (pushing the sum on the stack in place of the + two previous values) and outputs that value as a charac- + ter. Then the same is done for the second parameter. + More complex arithmetic is possible using the stack. + + + <STRONG>Cursor</STRONG> <STRONG>Motions</STRONG> + If the terminal has a fast way to home the cursor (to very + upper left corner of screen) then this can be given as + <STRONG>home</STRONG>; similarly a fast way of getting to the lower left- + hand corner can be given as <STRONG>ll</STRONG>; this may involve going up + with <STRONG>cuu1</STRONG> from the home position, but a program should + never do this itself (unless <STRONG>ll</STRONG> does) because it can make + no assumption about the effect of moving up from the home + position. Note that the home position is the same as + addressing to (0,0): to the top left corner of the screen, + not of memory. (Thus, the \EH sequence on HP terminals + cannot be used for <STRONG>home</STRONG>.) + + If the terminal has row or column absolute cursor address- + ing, these can be given as single parameter capabilities + <STRONG>hpa</STRONG> (horizontal position absolute) and <STRONG>vpa</STRONG> (vertical posi- + tion absolute). Sometimes these are shorter than the more + general two parameter sequence (as with the hp2645) and + can be used in preference to <STRONG>cup</STRONG>. If there are + parameterized local motions (e.g., move <EM>n</EM> spaces to the + right) these can be given as <STRONG>cud</STRONG>, <STRONG>cub</STRONG>, <STRONG>cuf</STRONG>, and <STRONG>cuu</STRONG> with a + single parameter indicating how many spaces to move. + These are primarily useful if the terminal does not have + <STRONG>cup</STRONG>, such as the TEKTRONIX 4025. + + If the terminal needs to be in a special mode when running + a program that uses these capabilities, the codes to enter + and exit this mode can be given as <STRONG>smcup</STRONG> and <STRONG>rmcup</STRONG>. This + arises, for example, from terminals like the Concept with + more than one page of memory. If the terminal has only + memory relative cursor addressing and not screen relative + cursor addressing, a one screen-sized window must be fixed + into the terminal for cursor addressing to work properly. + This is also used for the TEKTRONIX 4025, where <STRONG>smcup</STRONG> sets + the command character to be the one used by terminfo. If + the <STRONG>smcup</STRONG> sequence will not restore the screen after an + <STRONG>rmcup</STRONG> sequence is output (to the state prior to outputting + <STRONG>rmcup</STRONG>), specify <STRONG>nrrmc</STRONG>. + + + <STRONG>Area</STRONG> <STRONG>Clears</STRONG> + If the terminal can clear from the current position to the + end of the line, leaving the cursor where it is, this + should be given as <STRONG>el</STRONG>. If the terminal can clear from the + beginning of the line to the current position inclusive, + leaving the cursor where it is, this should be given as + <STRONG>el1</STRONG>. If the terminal can clear from the current position + to the end of the display, then this should be given as + <STRONG>ed</STRONG>. <STRONG>Ed</STRONG> is only defined from the first column of a line. + (Thus, it can be simulated by a request to delete a large + number of lines, if a true <STRONG>ed</STRONG> is not available.) + + + <STRONG>Insert/delete</STRONG> <STRONG>line</STRONG> <STRONG>and</STRONG> <STRONG>vertical</STRONG> <STRONG>motions</STRONG> + If the terminal can open a new blank line before the line + where the cursor is, this should be given as <STRONG>il1</STRONG>; this is + done only from the first position of a line. The cursor + must then appear on the newly blank line. If the terminal + can delete the line which the cursor is on, then this + should be given as <STRONG>dl1</STRONG>; this is done only from the first + position on the line to be deleted. Versions of <STRONG>il1</STRONG> and + <STRONG>dl1</STRONG> which take a single parameter and insert or delete + that many lines can be given as <STRONG>il</STRONG> and <STRONG>dl</STRONG>. + + If the terminal has a settable scrolling region (like the + vt100) the command to set this can be described with the + <STRONG>csr</STRONG> capability, which takes two parameters: the top and + bottom lines of the scrolling region. The cursor position + is, alas, undefined after using this command. + + It is possible to get the effect of insert or delete line + using <STRONG>csr</STRONG> on a properly chosen region; the <STRONG>sc</STRONG> and <STRONG>rc</STRONG> (save + and restore cursor) commands may be useful for ensuring + that your synthesized insert/delete string does not move + the cursor. (Note that the <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> library does this + synthesis automatically, so you need not compose + insert/delete strings for an entry with <STRONG>csr</STRONG>). + + Yet another way to construct insert and delete might be to + use a combination of index with the memory-lock feature + found on some terminals (like the HP-700/90 series, which + however also has insert/delete). + + Inserting lines at the top or bottom of the screen can + also be done using <STRONG>ri</STRONG> or <STRONG>ind</STRONG> on many terminals without a + true insert/delete line, and is often faster even on ter- + minals with those features. + + The boolean <STRONG>non_dest_scroll_region</STRONG> should be set if each + scrolling window is effectively a view port on a screen- + sized canvas. To test for this capability, create a + scrolling region in the middle of the screen, write some- + thing to the bottom line, move the cursor to the top of + the region, and do <STRONG>ri</STRONG> followed by <STRONG>dl1</STRONG> or <STRONG>ind</STRONG>. If the data + scrolled off the bottom of the region by the <STRONG>ri</STRONG> re- + appears, then scrolling is non-destructive. System V and + XSI Curses expect that <STRONG>ind</STRONG>, <STRONG>ri</STRONG>, <STRONG>indn</STRONG>, and <STRONG>rin</STRONG> will simu- + late destructive scrolling; their documentation cautions + you not to define <STRONG>csr</STRONG> unless this is true. This <STRONG>curses</STRONG> + implementation is more liberal and will do explicit erases + after scrolling if <STRONG>ndstr</STRONG> is defined. + + If the terminal has the ability to define a window as part + of memory, which all commands affect, it should be given + as the parameterized string <STRONG>wind</STRONG>. The four parameters are + the starting and ending lines in memory and the starting + and ending columns in memory, in that order. + + If the terminal can retain display memory above, then the + <STRONG>da</STRONG> capability should be given; if display memory can be + retained below, then <STRONG>db</STRONG> should be given. These indicate + that deleting a line or scrolling may bring non-blank + lines up from below or that scrolling back with <STRONG>ri</STRONG> may + bring down non-blank lines. + + + <STRONG>Insert/Delete</STRONG> <STRONG>Character</STRONG> + There are two basic kinds of intelligent terminals with + respect to insert/delete character which can be described + using <EM>terminfo.</EM> The most common insert/delete character + operations affect only the characters on the current line + and shift characters off the end of the line rigidly. + Other terminals, such as the Concept 100 and the Perkin + Elmer Owl, make a distinction between typed and untyped + blanks on the screen, shifting upon an insert or delete + only to an untyped blank on the screen which is either + eliminated, or expanded to two untyped blanks. You can + determine the kind of terminal you have by clearing the + screen and then typing text separated by cursor motions. + Type "abc def" using local cursor motions (not spaces) + between the "abc" and the "def". Then position the cursor + before the "abc" and put the terminal in insert mode. If + typing characters causes the rest of the line to shift + rigidly and characters to fall off the end, then your ter- + minal does not distinguish between blanks and untyped + positions. If the "abc" shifts over to the "def" which + then move together around the end of the current line and + onto the next as you insert, you have the second type of + terminal, and should give the capability <STRONG>in</STRONG>, which stands + for "insert null". While these are two logically separate + attributes (one line versus multi-line insert mode, and + special treatment of untyped spaces) we have seen no ter- + minals whose insert mode cannot be described with the sin- + gle attribute. + + Terminfo can describe both terminals which have an insert + mode, and terminals which send a simple sequence to open a + blank position on the current line. Give as <STRONG>smir</STRONG> the + sequence to get into insert mode. Give as <STRONG>rmir</STRONG> the + sequence to leave insert mode. Now give as <STRONG>ich1</STRONG> any + sequence needed to be sent just before sending the + character to be inserted. Most terminals with a true + insert mode will not give <STRONG>ich1</STRONG>; terminals which send a + sequence to open a screen position should give it here. + + If your terminal has both, insert mode is usually prefer- + able to <STRONG>ich1</STRONG>. Technically, you should not give both + unless the terminal actually requires both to be used in + combination. Accordingly, some non-curses applications + get confused if both are present; the symptom is doubled + characters in an update using insert. This requirement is + now rare; most <STRONG>ich</STRONG> sequences do not require previous smir, + and most smir insert modes do not require <STRONG>ich1</STRONG> before each + character. Therefore, the new <STRONG>curses</STRONG> actually assumes + this is the case and uses either <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> or <STRONG>ich</STRONG>/<STRONG>ich1</STRONG> as + appropriate (but not both). If you have to write an entry + to be used under new curses for a terminal old enough to + need both, include the <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> sequences in <STRONG>ich1</STRONG>. + + If post insert padding is needed, give this as a number of + milliseconds in <STRONG>ip</STRONG> (a string option). Any other sequence + which may need to be sent after an insert of a single + character may also be given in <STRONG>ip</STRONG>. If your terminal needs + both to be placed into an `insert mode' and a special code + to precede each inserted character, then both <STRONG>smir</STRONG>/<STRONG>rmir</STRONG> + and <STRONG>ich1</STRONG> can be given, and both will be used. The <STRONG>ich</STRONG> + capability, with one parameter, <EM>n</EM>, will repeat the effects + of <STRONG>ich1</STRONG> <EM>n</EM> times. + + If padding is necessary between characters typed while not + in insert mode, give this as a number of milliseconds + padding in <STRONG>rmp</STRONG>. + + It is occasionally necessary to move around while in + insert mode to delete characters on the same line (e.g., + if there is a tab after the insertion position). If your + terminal allows motion while in insert mode you can give + the capability <STRONG>mir</STRONG> to speed up inserting in this case. + Omitting <STRONG>mir</STRONG> will affect only speed. Some terminals + (notably Datamedia's) must not have <STRONG>mir</STRONG> because of the way + their insert mode works. + + Finally, you can specify <STRONG>dch1</STRONG> to delete a single charac- + ter, <STRONG>dch</STRONG> with one parameter, <EM>n</EM>, to delete <EM>n</EM> <EM>characters,</EM> + and delete mode by giving <STRONG>smdc</STRONG> and <STRONG>rmdc</STRONG> to enter and exit + delete mode (any mode the terminal needs to be placed in + for <STRONG>dch1</STRONG> to work). + + A command to erase <EM>n</EM> characters (equivalent to outputting + <EM>n</EM> blanks without moving the cursor) can be given as <STRONG>ech</STRONG> + with one parameter. + + + <STRONG>Highlighting,</STRONG> <STRONG>Underlining,</STRONG> <STRONG>and</STRONG> <STRONG>Visible</STRONG> <STRONG>Bells</STRONG> + If your terminal has one or more kinds of display + attributes, these can be represented in a number of dif- + ferent ways. You should choose one display form as <EM>stand-</EM> + <EM>out</EM> <EM>mode</EM>, representing a good, high contrast, easy-on-the- + eyes, format for highlighting error messages and other + attention getters. (If you have a choice, reverse video + plus half-bright is good, or reverse video alone.) The + sequences to enter and exit standout mode are given as + <STRONG>smso</STRONG> and <STRONG>rmso</STRONG>, respectively. If the code to change into + or out of standout mode leaves one or even two blank + spaces on the screen, as the TVI 912 and Teleray 1061 do, + then <STRONG>xmc</STRONG> should be given to tell how many spaces are left. + + Codes to begin underlining and end underlining can be + given as <STRONG>smul</STRONG> and <STRONG>rmul</STRONG> respectively. If the terminal has + a code to underline the current character and move the + cursor one space to the right, such as the Microterm Mime, + this can be given as <STRONG>uc</STRONG>. + + Other capabilities to enter various highlighting modes + include <STRONG>blink</STRONG> (blinking) <STRONG>bold</STRONG> (bold or extra bright) <STRONG>dim</STRONG> + (dim or half-bright) <STRONG>invis</STRONG> (blanking or invisible text) + <STRONG>prot</STRONG> (protected) <STRONG>rev</STRONG> (reverse video) <STRONG>sgr0</STRONG> (turn off <EM>all</EM> + attribute modes) <STRONG>smacs</STRONG> (enter alternate character set + mode) and <STRONG>rmacs</STRONG> (exit alternate character set mode). + Turning on any of these modes singly may or may not turn + off other modes. + + If there is a sequence to set arbitrary combinations of + modes, this should be given as <STRONG>sgr</STRONG> (set attributes), tak- + ing 9 parameters. Each parameter is either 0 or nonzero, + as the corresponding attribute is on or off. The 9 param- + eters are, in order: standout, underline, reverse, blink, + dim, bold, blank, protect, alternate character set. Not + all modes need be supported by <STRONG>sgr</STRONG>, only those for which + corresponding separate attribute commands exist. + + For example, the DEC vt220 supports most of the modes: + + + <STRONG>tparm</STRONG> <STRONG>parameter</STRONG> <STRONG>attribute</STRONG> <STRONG>escape</STRONG> <STRONG>sequence</STRONG> + + none none \E[0m + p1 standout \E[0;1;7m + p2 underline \E[0;4m + p3 reverse \E[0;7m + p4 blink \E[0;5m + p5 dim not available + p6 bold \E[0;1m + p7 invis \E[0;8m + p8 protect not used + p9 altcharset ^O (off) ^N (on) + + We begin each escape sequence by turning off any existing + modes, since there is no quick way to determine whether + they are active. Standout is set up to be the combination + of reverse and bold. The vt220 terminal has a protect + mode, though it is not commonly used in sgr because it + protects characters on the screen from the host's era- + sures. The altcharset mode also is different in that it + is either ^O or ^N, depending on whether it is off or on. + If all modes are turned on, the resulting sequence is + \E[0;1;4;5;7;8m^N. + + Some sequences are common to different modes. For exam- + ple, ;7 is output when either p1 or p3 is true, that is, + if either standout or reverse modes are turned on. + + Writing out the above sequences, along with their depen- + dencies yields + + + <STRONG>sequence</STRONG> <STRONG>when</STRONG> <STRONG>to</STRONG> <STRONG>output</STRONG> <STRONG>terminfo</STRONG> <STRONG>translation</STRONG> + + \E[0 always \E[0 + ;1 if p1 or p6 %?%p1%p6%|%t;1%; + ;4 if p2 %?%p2%|%t;4%; + ;5 if p4 %?%p4%|%t;5%; + + ;7 if p1 or p3 %?%p1%p3%|%t;7%; + ;8 if p7 %?%p7%|%t;8%; + m always m + ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; + + Putting this all together into the sgr sequence gives: + + sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p1%p3%|%t;7%; + %?%p4%t;5%;%?%p7%t;8%;m%?%p9%t\016%e\017%;, + + Remember that if you specify sgr, you must also specify + sgr0. Also, some implementations rely on sgr being given + if sgr0 is, Not all terminfo entries necessarily have an + sgr string, however. Many terminfo entries are derived + from termcap entries which have no sgr string. The only + drawback to adding an sgr string is that termcap also + assumes that sgr0 does not exit alternate character set + mode. + + Terminals with the ``magic cookie'' glitch (<STRONG>xmc</STRONG>) deposit + special ``cookies'' when they receive mode-setting + sequences, which affect the display algorithm rather than + having extra bits for each character. Some terminals, + such as the HP 2621, automatically leave standout mode + when they move to a new line or the cursor is addressed. + Programs using standout mode should exit standout mode + before moving the cursor or sending a newline, unless the + <STRONG>msgr</STRONG> capability, asserting that it is safe to move in + standout mode, is present. + + If the terminal has a way of flashing the screen to indi- + cate an error quietly (a bell replacement) then this can + be given as <STRONG>flash</STRONG>; it must not move the cursor. + + If the cursor needs to be made more visible than normal + when it is not on the bottom line (to make, for example, a + non-blinking underline into an easier to find block or + blinking underline) give this sequence as <STRONG>cvvis</STRONG>. If there + is a way to make the cursor completely invisible, give + that as <STRONG>civis</STRONG>. The capability <STRONG>cnorm</STRONG> should be given which + undoes the effects of both of these modes. + + If your terminal correctly generates underlined characters + (with no special codes needed) even though it does not + overstrike, then you should give the capability <STRONG>ul</STRONG>. If a + character overstriking another leaves both characters on + the screen, specify the capability <STRONG>os</STRONG>. If overstrikes are + erasable with a blank, then this should be indicated by + giving <STRONG>eo</STRONG>. + + + <STRONG>Keypad</STRONG> <STRONG>and</STRONG> <STRONG>Function</STRONG> <STRONG>Keys</STRONG> + If the terminal has a keypad that transmits codes when the + keys are pressed, this information can be given. Note + that it is not possible to handle terminals where the key- + pad only works in local (this applies, for example, to the + unshifted HP 2621 keys). If the keypad can be set to + transmit or not transmit, give these codes as <STRONG>smkx</STRONG> and + <STRONG>rmkx</STRONG>. Otherwise the keypad is assumed to always transmit. + The codes sent by the left arrow, right arrow, up arrow, + down arrow, and home keys can be given as <STRONG>kcub1,</STRONG> <STRONG>kcuf1,</STRONG> + <STRONG>kcuu1,</STRONG> <STRONG>kcud1,</STRONG> and <STRONG>khome</STRONG> respectively. If there are func- + tion keys such as f0, f1, ..., f10, the codes they send + can be given as <STRONG>kf0,</STRONG> <STRONG>kf1,</STRONG> <STRONG>...,</STRONG> <STRONG>kf10</STRONG>. If these keys have + labels other than the default f0 through f10, the labels + can be given as <STRONG>lf0,</STRONG> <STRONG>lf1,</STRONG> <STRONG>...,</STRONG> <STRONG>lf10</STRONG>. The codes + transmitted by certain other special keys can be given: + <STRONG>kll</STRONG> (home down), <STRONG>kbs</STRONG> (backspace), <STRONG>ktbc</STRONG> (clear all tabs), + <STRONG>kctab</STRONG> (clear the tab stop in this column), <STRONG>kclr</STRONG> (clear + screen or erase key), <STRONG>kdch1</STRONG> (delete character), <STRONG>kdl1</STRONG> + (delete line), <STRONG>krmir</STRONG> (exit insert mode), <STRONG>kel</STRONG> (clear to end + of line), <STRONG>ked</STRONG> (clear to end of screen), <STRONG>kich1</STRONG> (insert + character or enter insert mode), <STRONG>kil1</STRONG> (insert line), <STRONG>knp</STRONG> + (next page), <STRONG>kpp</STRONG> (previous page), <STRONG>kind</STRONG> (scroll for- + ward/down), <STRONG>kri</STRONG> (scroll backward/up), <STRONG>khts</STRONG> (set a tab stop + in this column). In addition, if the keypad has a 3 by 3 + array of keys including the four arrow keys, the other + five keys can be given as <STRONG>ka1</STRONG>, <STRONG>ka3</STRONG>, <STRONG>kb2</STRONG>, <STRONG>kc1</STRONG>, and <STRONG>kc3</STRONG>. + These keys are useful when the effects of a 3 by 3 direc- + tional pad are needed. + + Strings to program function keys can be given as <STRONG>pfkey</STRONG>, + <STRONG>pfloc</STRONG>, and <STRONG>pfx</STRONG>. A string to program screen labels should + be specified as <STRONG>pln</STRONG>. Each of these strings takes two + parameters: the function key number to program (from 0 to + 10) and the string to program it with. Function key num- + bers out of this range may program undefined keys in a + terminal dependent manner. The difference between the + capabilities is that <STRONG>pfkey</STRONG> causes pressing the given key + to be the same as the user typing the given string; <STRONG>pfloc</STRONG> + causes the string to be executed by the terminal in local; + and <STRONG>pfx</STRONG> causes the string to be transmitted to the com- + puter. + + The capabilities <STRONG>nlab</STRONG>, <STRONG>lw</STRONG> and <STRONG>lh</STRONG> define the number of pro- + grammable screen labels and their width and height. If + there are commands to turn the labels on and off, give + them in <STRONG>smln</STRONG> and <STRONG>rmln</STRONG>. <STRONG>smln</STRONG> is normally output after one + or more pln sequences to make sure that the change becomes + visible. + + + <STRONG>Tabs</STRONG> <STRONG>and</STRONG> <STRONG>Initialization</STRONG> + If the terminal has hardware tabs, the command to advance + to the next tab stop can be given as <STRONG>ht</STRONG> (usually control + I). A ``back-tab'' command which moves leftward to the + preceding tab stop can be given as <STRONG>cbt</STRONG>. By convention, if + the teletype modes indicate that tabs are being expanded + by the computer rather than being sent to the terminal, + programs should not use <STRONG>ht</STRONG> or <STRONG>cbt</STRONG> even if they are + present, since the user may not have the tab stops prop- + erly set. If the terminal has hardware tabs which are + initially set every <EM>n</EM> spaces when the terminal is powered + up, the numeric parameter <STRONG>it</STRONG> is given, showing the number + of spaces the tabs are set to. This is normally used by + the <EM>tset</EM> command to determine whether to set the mode for + hardware tab expansion, and whether to set the tab stops. + If the terminal has tab stops that can be saved in non- + volatile memory, the terminfo description can assume that + they are properly set. + + Other capabilities include <STRONG>is1</STRONG>, <STRONG>is2</STRONG>, and <STRONG>is3</STRONG>, initializa- + tion strings for the terminal, <STRONG>iprog</STRONG>, the path name of a + program to be run to initialize the terminal, and <STRONG>if</STRONG>, the + name of a file containing long initialization strings. + These strings are expected to set the terminal into modes + consistent with the rest of the terminfo description. + They are normally sent to the terminal, by the <EM>init</EM> option + of the <EM>tput</EM> program, each time the user logs in. They + will be printed in the following order: + + run the program + <STRONG>iprog</STRONG> + + output <STRONG>is1</STRONG> <STRONG>is2</STRONG> + + set the margins using + <STRONG>mgc</STRONG>, <STRONG>smgl</STRONG> and <STRONG>smgr</STRONG> + + set tabs using + <STRONG>tbc</STRONG> and <STRONG>hts</STRONG> + + print the file + <STRONG>if</STRONG> + + and finally + output <STRONG>is3</STRONG>. + + Most initialization is done with <STRONG>is2</STRONG>. Special terminal + modes can be set up without duplicating strings by putting + the common sequences in <STRONG>is2</STRONG> and special cases in <STRONG>is1</STRONG> and + <STRONG>is3</STRONG>. + + A set of sequences that does a harder reset from a totally + unknown state can be given as <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rf</STRONG> and <STRONG>rs3</STRONG>, analo- + gous to <STRONG>is1</STRONG> <STRONG>,</STRONG> <STRONG>is2</STRONG> <STRONG>,</STRONG> <STRONG>if</STRONG> and <STRONG>is3</STRONG> respectively. These + strings are output by the <EM>reset</EM> program, which is used + when the terminal gets into a wedged state. Commands are + normally placed in <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG> <STRONG>rs3</STRONG> and <STRONG>rf</STRONG> only if they pro- + duce annoying effects on the screen and are not necessary + when logging in. For example, the command to set the + vt100 into 80-column mode would normally be part of <STRONG>is2</STRONG>, + but it causes an annoying glitch of the screen and is not + normally needed since the terminal is usually already in + 80 column mode. + + The <EM>reset</EM> program writes strings including <STRONG>iprog</STRONG>, etc., in + the same order as the <EM>init</EM> program, using <STRONG>rs1</STRONG>, etc., + instead of <STRONG>is1</STRONG>, etc. If any of <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, or <STRONG>rf</STRONG> reset + capability strings are missing, the <EM>reset</EM> program falls + back upon the corresponding initialization capability + string. + + If there are commands to set and clear tab stops, they can + be given as <STRONG>tbc</STRONG> (clear all tab stops) and <STRONG>hts</STRONG> (set a tab + stop in the current column of every row). If a more com- + plex sequence is needed to set the tabs than can be + described by this, the sequence can be placed in <STRONG>is2</STRONG> or + <STRONG>if</STRONG>. + + <STRONG>Delays</STRONG> <STRONG>and</STRONG> <STRONG>Padding</STRONG> + Many older and slower terminals do not support either + XON/XOFF or DTR handshaking, including hard copy terminals + and some very archaic CRTs (including, for example, DEC + VT100s). These may require padding characters after cer- + tain cursor motions and screen changes. + + If the terminal uses xon/xoff handshaking for flow control + (that is, it automatically emits ^S back to the host when + its input buffers are close to full), set <STRONG>xon</STRONG>. This capa- + bility suppresses the emission of padding. You can also + set it for memory-mapped console devices effectively that + do not have a speed limit. Padding information should + still be included so that routines can make better deci- + sions about relative costs, but actual pad characters will + not be transmitted. + + If <STRONG>pb</STRONG> (padding baud rate) is given, padding is suppressed + at baud rates below the value of <STRONG>pb</STRONG>. If the entry has no + padding baud rate, then whether padding is emitted or not + is completely controlled by <STRONG>xon</STRONG>. + + If the terminal requires other than a null (zero) charac- + ter as a pad, then this can be given as <STRONG>pad</STRONG>. Only the + first character of the <STRONG>pad</STRONG> string is used. + + + <STRONG>Status</STRONG> <STRONG>Lines</STRONG> + Some terminals have an extra `status line' which is not + normally used by software (and thus not counted in the + terminal's <STRONG>lines</STRONG> capability). + + The simplest case is a status line which is cursor- + addressable but not part of the main scrolling region on + the screen; the Heathkit H19 has a status line of this + kind, as would a 24-line VT100 with a 23-line scrolling + region set up on initialization. This situation is indi- + cated by the <STRONG>hs</STRONG> capability. + + Some terminals with status lines need special sequences to + access the status line. These may be expressed as a + string with single parameter <STRONG>tsl</STRONG> which takes the cursor to + a given zero-origin column on the status line. The capa- + bility <STRONG>fsl</STRONG> must return to the main-screen cursor positions + before the last <STRONG>tsl</STRONG>. You may need to embed the string + values of <STRONG>sc</STRONG> (save cursor) and <STRONG>rc</STRONG> (restore cursor) in <STRONG>tsl</STRONG> + and <STRONG>fsl</STRONG> to accomplish this. + + The status line is normally assumed to be the same width + as the width of the terminal. If this is untrue, you can + specify it with the numeric capability <STRONG>wsl</STRONG>. + + A command to erase or blank the status line may be speci- + fied as <STRONG>dsl</STRONG>. + + The boolean capability <STRONG>eslok</STRONG> specifies that escape + sequences, tabs, etc., work ordinarily in the status line. + + The <STRONG>ncurses</STRONG> implementation does not yet use any of these + capabilities. They are documented here in case they ever + become important. + + + <STRONG>Line</STRONG> <STRONG>Graphics</STRONG> + Many terminals have alternate character sets useful for + forms-drawing. Terminfo and <STRONG>curses</STRONG> build in support for + the drawing characters supported by the VT100, with some + characters from the AT&T 4410v1 added. This alternate + character set may be specified by the <STRONG>acsc</STRONG> capability. + + + <STRONG>Glyph</STRONG> <STRONG>ACS</STRONG> <STRONG>Ascii</STRONG> <STRONG>VT100</STRONG> + <STRONG>Name</STRONG> <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Name</STRONG> + UK pound sign ACS_STERLING f } + arrow pointing down ACS_DARROW v . + arrow pointing left ACS_LARROW < , + arrow pointing right ACS_RARROW > + + arrow pointing up ACS_UARROW ^ - + board of squares ACS_BOARD # h + bullet ACS_BULLET o ~ + checker board (stipple) ACS_CKBOARD : a + degree symbol ACS_DEGREE \ f + diamond ACS_DIAMOND + ` + greater-than-or-equal-to ACS_GEQUAL > z + greek pi ACS_PI * { + horizontal line ACS_HLINE - q + lantern symbol ACS_LANTERN # i + large plus or crossover ACS_PLUS + n + less-than-or-equal-to ACS_LEQUAL < y + + lower left corner ACS_LLCORNER + m + lower right corner ACS_LRCORNER + j + not-equal ACS_NEQUAL ! | + plus/minus ACS_PLMINUS # g + scan line 1 ACS_S1 ~ o + scan line 3 ACS_S3 - p + scan line 7 ACS_S7 - r + scan line 9 ACS_S9 _ s + solid square block ACS_BLOCK # 0 + tee pointing down ACS_TTEE + w + tee pointing left ACS_RTEE + u + tee pointing right ACS_LTEE + t + tee pointing up ACS_BTEE + v + upper left corner ACS_ULCORNER + l + upper right corner ACS_URCORNER + k + vertical line ACS_VLINE | x + + The best way to define a new device's graphics set is to + add a column to a copy of this table for your terminal, + giving the character which (when emitted between + <STRONG>smacs</STRONG>/<STRONG>rmacs</STRONG> switches) will be rendered as the correspond- + ing graphic. Then read off the VT100/your terminal char- + acter pairs right to left in sequence; these become the + ACSC string. + + + <STRONG>Color</STRONG> <STRONG>Handling</STRONG> + Most color terminals are either `Tektronix-like' or `HP- + like'. Tektronix-like terminals have a predefined set of + N colors (where N usually 8), and can set character-cell + foreground and background characters independently, mixing + them into N * N color-pairs. On HP-like terminals, the + use must set each color pair up separately (foreground and + background are not independently settable). Up to M + color-pairs may be set up from 2*M different colors. + ANSI-compatible terminals are Tektronix-like. + + Some basic color capabilities are independent of the color + method. The numeric capabilities <STRONG>colors</STRONG> and <STRONG>pairs</STRONG> specify + the maximum numbers of colors and color-pairs that can be + displayed simultaneously. The <STRONG>op</STRONG> (original pair) string + resets foreground and background colors to their default + values for the terminal. The <STRONG>oc</STRONG> string resets all colors + or color-pairs to their default values for the terminal. + Some terminals (including many PC terminal emulators) + erase screen areas with the current background color + rather than the power-up default background; these should + have the boolean capability <STRONG>bce</STRONG>. + + To change the current foreground or background color on a + Tektronix-type terminal, use <STRONG>setaf</STRONG> (set ANSI foreground) + and <STRONG>setab</STRONG> (set ANSI background) or <STRONG>setf</STRONG> (set foreground) + and <STRONG>setb</STRONG> (set background). These take one parameter, the + color number. The SVr4 documentation describes only + <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>; the XPG4 draft says that "If the terminal + supports ANSI escape sequences to set background and fore- + ground, they should be coded as <STRONG>setaf</STRONG> and <STRONG>setab</STRONG>, respec- + tively. If the terminal supports other escape sequences + to set background and foreground, they should be coded as + <STRONG>setf</STRONG> and <STRONG>setb</STRONG>, respectively. The <EM>vidputs()</EM> function and + the refresh functions use <STRONG>setaf</STRONG> and <STRONG>setab</STRONG> if they are + defined." + + The <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> and <STRONG>setf</STRONG>/<STRONG>setb</STRONG> capabilities take a single + numeric argument each. Argument values 0-7 of <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> + are portably defined as follows (the middle column is the + symbolic #define available in the header for the <STRONG>curses</STRONG> or + <STRONG>ncurses</STRONG> libraries). The terminal hardware is free to map + these as it likes, but the RGB values indicate normal + locations in color space. + + + <STRONG>Color</STRONG> <STRONG>#define</STRONG> <STRONG>Value</STRONG> <STRONG>RGB</STRONG> + black <STRONG>COLOR_BLACK</STRONG> 0 0, 0, 0 + red <STRONG>COLOR_RED</STRONG> 1 max,0,0 + green <STRONG>COLOR_GREEN</STRONG> 2 0,max,0 + yellow <STRONG>COLOR_YELLOW</STRONG> 3 max,max,0 + blue <STRONG>COLOR_BLUE</STRONG> 4 0,0,max + magenta <STRONG>COLOR_MAGENTA</STRONG> 5 max,0,max + cyan <STRONG>COLOR_CYAN</STRONG> 6 0,max,max + white <STRONG>COLOR_WHITE</STRONG> 7 max,max,max + + The argument values of <STRONG>setf</STRONG>/<STRONG>setb</STRONG> historically correspond + to a different mapping, i.e., + + <STRONG>Color</STRONG> <STRONG>#define</STRONG> <STRONG>Value</STRONG> <STRONG>RGB</STRONG> + black <STRONG>COLOR_BLACK</STRONG> 0 0, 0, 0 + blue <STRONG>COLOR_BLUE</STRONG> 1 0,0,max + green <STRONG>COLOR_GREEN</STRONG> 2 0,max,0 + cyan <STRONG>COLOR_CYAN</STRONG> 3 0,max,max + red <STRONG>COLOR_RED</STRONG> 4 max,0,0 + magenta <STRONG>COLOR_MAGENTA</STRONG> 5 max,0,max + yellow <STRONG>COLOR_YELLOW</STRONG> 6 max,max,0 + white <STRONG>COLOR_WHITE</STRONG> 7 max,max,max + It is important to not confuse the two sets of color capa- + bilities; otherwise red/blue will be interchanged on the + display. + + On an HP-like terminal, use <STRONG>scp</STRONG> with a color-pair number + parameter to set which color pair is current. + + On a Tektronix-like terminal, the capability <STRONG>ccc</STRONG> may be + present to indicate that colors can be modified. If so, + the <STRONG>initc</STRONG> capability will take a color number (0 to <STRONG>colors</STRONG> + - 1)and three more parameters which describe the color. + These three parameters default to being interpreted as RGB + (Red, Green, Blue) values. If the boolean capability <STRONG>hls</STRONG> + is present, they are instead as HLS (Hue, Lightness, Satu- + ration) indices. The ranges are terminal-dependent. + + On an HP-like terminal, <STRONG>initp</STRONG> may give a capability for + changing a color-pair value. It will take seven parame- + ters; a color-pair number (0 to <STRONG>max_pairs</STRONG> - 1), and two + triples describing first background and then foreground + colors. These parameters must be (Red, Green, Blue) or + (Hue, Lightness, Saturation) depending on <STRONG>hls</STRONG>. + + On some color terminals, colors collide with highlights. + You can register these collisions with the <STRONG>ncv</STRONG> capability. + This is a bit-mask of attributes not to be used when col- + ors are enabled. The correspondence with the attributes + understood by <STRONG>curses</STRONG> is as follows: + + + <STRONG>Attribute</STRONG> <STRONG>Bit</STRONG> <STRONG>Decimal</STRONG> + A_STANDOUT 0 1 + A_UNDERLINE 1 2 + A_REVERSE 2 4 + A_BLINK 3 8 + A_DIM 4 16 + A_BOLD 5 32 + A_INVIS 6 64 + A_PROTECT 7 128 + A_ALTCHARSET 8 256 + + For example, on many IBM PC consoles, the underline + attribute collides with the foreground color blue and is + not available in color mode. These should have an <STRONG>ncv</STRONG> + capability of 2. + + SVr4 curses does nothing with <STRONG>ncv</STRONG>, ncurses recognizes it + and optimizes the output in favor of colors. + + + <STRONG>Miscellaneous</STRONG> + If the terminal requires other than a null (zero) charac- + ter as a pad, then this can be given as pad. Only the + first character of the pad string is used. If the termi- + nal does not have a pad character, specify npc. Note that + ncurses implements the termcap-compatible <STRONG>PC</STRONG> variable; + though the application may set this value to something + other than a null, ncurses will test <STRONG>npc</STRONG> first and use + napms if the terminal has no pad character. + + If the terminal can move up or down half a line, this can + be indicated with <STRONG>hu</STRONG> (half-line up) and <STRONG>hd</STRONG> (half-line + down). This is primarily useful for superscripts and sub- + scripts on hard-copy terminals. If a hard-copy terminal + can eject to the next page (form feed), give this as <STRONG>ff</STRONG> + (usually control L). + + If there is a command to repeat a given character a given + number of times (to save time transmitting a large number + of identical characters) this can be indicated with the + parameterized string <STRONG>rep</STRONG>. The first parameter is the + character to be repeated and the second is the number of + times to repeat it. Thus, tparm(repeat_char, 'x', 10) is + the same as `xxxxxxxxxx'. + + If the terminal has a settable command character, such as + the TEKTRONIX 4025, this can be indicated with <STRONG>cmdch</STRONG>. A + prototype command character is chosen which is used in all + capabilities. This character is given in the <STRONG>cmdch</STRONG> capa- + bility to identify it. The following convention is sup- + ported on some UNIX systems: The environment is to be + searched for a <STRONG>CC</STRONG> variable, and if found, all occurrences + of the prototype character are replaced with the character + in the environment variable. + + Terminal descriptions that do not represent a specific + kind of known terminal, such as <EM>switch</EM>, <EM>dialup</EM>, <EM>patch</EM>, and + <EM>network</EM>, should include the <STRONG>gn</STRONG> (generic) capability so + that programs can complain that they do not know how to + talk to the terminal. (This capability does not apply to + <EM>virtual</EM> terminal descriptions for which the escape + sequences are known.) + + If the terminal has a ``meta key'' which acts as a shift + key, setting the 8th bit of any character transmitted, + this fact can be indicated with <STRONG>km</STRONG>. Otherwise, software + will assume that the 8th bit is parity and it will usually + be cleared. If strings exist to turn this ``meta mode'' + on and off, they can be given as <STRONG>smm</STRONG> and <STRONG>rmm</STRONG>. + + If the terminal has more lines of memory than will fit on + the screen at once, the number of lines of memory can be + indicated with <STRONG>lm</STRONG>. A value of <STRONG>lm</STRONG>#0 indicates that the + number of lines is not fixed, but that there is still more + memory than fits on the screen. + + If the terminal is one of those supported by the UNIX vir- + tual terminal protocol, the terminal number can be given + as <STRONG>vt</STRONG>. + + Media copy strings which control an auxiliary printer con- + nected to the terminal can be given as <STRONG>mc0</STRONG>: print the con- + tents of the screen, <STRONG>mc4</STRONG>: turn off the printer, and <STRONG>mc5</STRONG>: + turn on the printer. When the printer is on, all text + sent to the terminal will be sent to the printer. It is + undefined whether the text is also displayed on the termi- + nal screen when the printer is on. A variation <STRONG>mc5p</STRONG> takes + one parameter, and leaves the printer on for as many char- + acters as the value of the parameter, then turns the + printer off. The parameter should not exceed 255. All + text, including <STRONG>mc4</STRONG>, is transparently passed to the + printer while an <STRONG>mc5p</STRONG> is in effect. + + + <STRONG>Glitches</STRONG> <STRONG>and</STRONG> <STRONG>Braindamage</STRONG> + Hazeltine terminals, which do not allow `~' characters to + be displayed should indicate <STRONG>hz</STRONG>. + + Terminals which ignore a line-feed immediately after an <STRONG>am</STRONG> + wrap, such as the Concept and vt100, should indicate <STRONG>xenl</STRONG>. + + If <STRONG>el</STRONG> is required to get rid of standout (instead of + merely writing normal text on top of it), <STRONG>xhp</STRONG> should be + given. + + Teleray terminals, where tabs turn all characters moved + over to blanks, should indicate <STRONG>xt</STRONG> (destructive tabs). + Note: the variable indicating this is now + `dest_tabs_magic_smso'; in older versions, it was tel- + eray_glitch. This glitch is also taken to mean that it is + not possible to position the cursor on top of a ``magic + cookie'', that to erase standout mode it is instead neces- + sary to use delete and insert line. The ncurses implemen- + tation ignores this glitch. + + The Beehive Superbee, which is unable to correctly trans- + mit the escape or control C characters, has <STRONG>xsb</STRONG>, indicat- + ing that the f1 key is used for escape and f2 for control + C. (Only certain Superbees have this problem, depending + on the ROM.) Note that in older terminfo versions, this + capability was called `beehive_glitch'; it is now + `no_esc_ctl_c'. + + Other specific terminal problems may be corrected by + adding more capabilities of the form <STRONG>x</STRONG><EM>x</EM>. + + + <STRONG>Similar</STRONG> <STRONG>Terminals</STRONG> + If there are two very similar terminals, one (the variant) + can be defined as being just like the other (the base) + with certain exceptions. In the definition of the vari- + ant, the string capability <STRONG>use</STRONG> can be given with the name + of the base terminal. The capabilities given before <STRONG>use</STRONG> + override those in the base type named by <STRONG>use</STRONG>. If there + are multiple <STRONG>use</STRONG> capabilities, they are merged in reverse + order. That is, the rightmost <STRONG>use</STRONG> reference is processed + first, then the one to its left, and so forth. Capabili- + ties given explicitly in the entry override those brought + in by <STRONG>use</STRONG> references. + + A capability can be canceled by placing <STRONG>xx@</STRONG> to the left of + the use reference that imports it, where <EM>xx</EM> is the capa- + bility. For example, the entry + + 2621-nl, smkx@, rmkx@, use=2621, + + defines a 2621-nl that does not have the <STRONG>smkx</STRONG> or <STRONG>rmkx</STRONG> + capabilities, and hence does not turn on the function key + labels when in visual mode. This is useful for different + modes for a terminal, or for different user preferences. + + + <STRONG>Pitfalls</STRONG> <STRONG>of</STRONG> <STRONG>Long</STRONG> <STRONG>Entries</STRONG> + Long terminfo entries are unlikely to be a problem; to + date, no entry has even approached terminfo's 4096-byte + string-table maximum. Unfortunately, the termcap transla- + tions are much more strictly limited (to 1023 bytes), thus + termcap translations of long terminfo entries can cause + problems. + + The man pages for 4.3BSD and older versions of <STRONG>tgetent()</STRONG> + instruct the user to allocate a 1024-byte buffer for the + termcap entry. The entry gets null-terminated by the + termcap library, so that makes the maximum safe length for + a termcap entry 1k-1 (1023) bytes. Depending on what the + application and the termcap library being used does, and + where in the termcap file the terminal type that <STRONG>tgetent()</STRONG> + is searching for is, several bad things can happen. + + Some termcap libraries print a warning message or exit if + they find an entry that's longer than 1023 bytes; others + do not; others truncate the entries to 1023 bytes. Some + application programs allocate more than the recommended 1K + for the termcap entry; others do not. + + Each termcap entry has two important sizes associated with + it: before "tc" expansion, and after "tc" expansion. "tc" + is the capability that tacks on another termcap entry to + the end of the current one, to add on its capabilities. + If a termcap entry does not use the "tc" capability, then + of course the two lengths are the same. + + The "before tc expansion" length is the most important + one, because it affects more than just users of that par- + ticular terminal. This is the length of the entry as it + exists in /etc/termcap, minus the backslash-newline pairs, + which <STRONG>tgetent()</STRONG> strips out while reading it. Some termcap + libraries strip off the final newline, too (GNU termcap + does not). Now suppose: + + * a termcap entry before expansion is more than 1023 + bytes long, + + * and the application has only allocated a 1k buffer, + + * and the termcap library (like the one in BSD/OS 1.1 + and GNU) reads the whole entry into the buffer, no + matter what its length, to see if it is the entry it + wants, + + * and <STRONG>tgetent()</STRONG> is searching for a terminal type that + either is the long entry, appears in the termcap file + after the long entry, or does not appear in the file + at all (so that <STRONG>tgetent()</STRONG> has to search the whole + termcap file). + + Then <STRONG>tgetent()</STRONG> will overwrite memory, perhaps its stack, + and probably core dump the program. Programs like telnet + are particularly vulnerable; modern telnets pass along + values like the terminal type automatically. The results + are almost as undesirable with a termcap library, like + SunOS 4.1.3 and Ultrix 4.4, that prints warning messages + when it reads an overly long termcap entry. If a termcap + library truncates long entries, like OSF/1 3.0, it is + immune to dying here but will return incorrect data for + the terminal. + + The "after tc expansion" length will have a similar effect + to the above, but only for people who actually set TERM to + that terminal type, since <STRONG>tgetent()</STRONG> only does "tc" expan- + sion once it is found the terminal type it was looking + for, not while searching. + + In summary, a termcap entry that is longer than 1023 bytes + can cause, on various combinations of termcap libraries + and applications, a core dump, warnings, or incorrect + operation. If it is too long even before "tc" expansion, + it will have this effect even for users of some other ter- + minal types and users whose TERM variable does not have a + termcap entry. + + When in -C (translate to termcap) mode, the <STRONG>ncurses</STRONG> imple- + mentation of <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> issues warning messages when the pre- + tc length of a termcap translation is too long. The -c + (check) option also checks resolved (after tc expansion) + lengths. + + <STRONG>Binary</STRONG> <STRONG>Compatibility</STRONG> + It is not wise to count on portability of binary terminfo + entries between commercial UNIX versions. The problem is + that there are at least two versions of terminfo (under + HP-UX and AIX) which diverged from System V terminfo after + SVr1, and have added extension capabilities to the string + table that (in the binary format) collide with System V + and XSI Curses extensions. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + Some SVr4 <STRONG>curses</STRONG> implementations, and all previous to + SVr4, do not interpret the %A and %O operators in parame- + ter strings. + + SVr4/XPG4 do not specify whether <STRONG>msgr</STRONG> licenses movement + while in an alternate-character-set mode (such modes may, + among other things, map CR and NL to characters that do + not trigger local motions). The <STRONG>ncurses</STRONG> implementation + ignores <STRONG>msgr</STRONG> in <STRONG>ALTCHARSET</STRONG> mode. This raises the possi- + bility that an XPG4 implementation making the opposite + interpretation may need terminfo entries made for <STRONG>ncurses</STRONG> + to have <STRONG>msgr</STRONG> turned off. + + The <STRONG>ncurses</STRONG> library handles insert-character and insert- + character modes in a slightly non-standard way to get bet- + ter update efficiency. See the <STRONG>Insert/Delete</STRONG> <STRONG>Character</STRONG> + subsection above. + + The parameter substitutions for <STRONG>set_clock</STRONG> and <STRONG>dis-</STRONG> + <STRONG>play_clock</STRONG> are not documented in SVr4 or the XSI Curses + standard. They are deduced from the documentation for the + AT&T 505 terminal. + + Be careful assigning the <STRONG>kmous</STRONG> capability. The <STRONG>ncurses</STRONG> + wants to interpret it as <STRONG>KEY_MOUSE</STRONG>, for use by terminals + and emulators like xterm that can return mouse-tracking + information in the keyboard-input stream. + + Different commercial ports of terminfo and curses support + different subsets of the XSI Curses standard and (in some + cases) different extension sets. Here is a summary, accu- + rate as of October 1995: + + <STRONG>SVR4,</STRONG> <STRONG>Solaris,</STRONG> <STRONG>ncurses</STRONG> -- These support all SVr4 capabili- + ties. + + <STRONG>SGI</STRONG> -- Supports the SVr4 set, adds one undocumented + extended string capability (<STRONG>set_pglen</STRONG>). + + <STRONG>SVr1,</STRONG> <STRONG>Ultrix</STRONG> -- These support a restricted subset of ter- + minfo capabilities. The booleans end with <STRONG>xon_xoff</STRONG>; the + numerics with <STRONG>width_status_line</STRONG>; and the strings with + <STRONG>prtr_non</STRONG>. + + <STRONG>HP/UX</STRONG> -- Supports the SVr1 subset, plus the SVr[234] + numerics <STRONG>num_labels</STRONG>, <STRONG>label_height</STRONG>, <STRONG>label_width</STRONG>, plus func- + tion keys 11 through 63, plus <STRONG>plab_norm</STRONG>, <STRONG>label_on</STRONG>, and + <STRONG>label_off</STRONG>, plus some incompatible extensions in the string + table. + + <STRONG>AIX</STRONG> -- Supports the SVr1 subset, plus function keys 11 + through 63, plus a number of incompatible string table + extensions. + + <STRONG>OSF</STRONG> -- Supports both the SVr4 set and the AIX extensions. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo/?/* files containing terminal + descriptions + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>. + <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. + Based on pcurses by Pavel Curtis. + + + + <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/tic.1m.html b/doc/html/man/tic.1m.html new file mode 100644 index 000000000000..9b246b5d2379 --- /dev/null +++ b/doc/html/man/tic.1m.html @@ -0,0 +1,330 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: tic.1m,v 1.47 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>tic 1m</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>tic 1m</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>tic</STRONG> - the <EM>terminfo</EM> entry-description compiler + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>tic</STRONG> [<STRONG>-1CGILNTUVacfgrstx</STRONG>] [<STRONG>-e</STRONG> <EM>names</EM>] [<STRONG>-o</STRONG> <EM>dir</EM>] [<STRONG>-R</STRONG> <EM>subset</EM>] + [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-w</STRONG>[<EM>n</EM>]] <EM>file</EM> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The command <STRONG>tic</STRONG> translates a <STRONG>terminfo</STRONG> file from source + format into compiled format. The compiled format is nec- + essary for use with the library routines in <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. + + The results are normally placed in the system terminfo + directory <STRONG>/usr/share/terminfo</STRONG>. There are two ways to + change this behavior. + + First, you may override the system default by setting the + variable <STRONG>TERMINFO</STRONG> in your shell environment to a valid + (existing) directory name. + + Secondly, if <STRONG>tic</STRONG> cannot get access to <EM>/usr/share/terminfo</EM> + or your TERMINFO directory, it looks for the directory + <EM>$HOME/.terminfo</EM>; if that directory exists, the entry is + placed there. + + Libraries that read terminfo entries are expected to check + for a TERMINFO directory first, look at <EM>$HOME/.terminfo</EM> if + TERMINFO is not set, and finally look in <EM>/usr/share/ter-</EM> + <EM>minfo</EM>. + + <STRONG>-1</STRONG> restricts the output to a single column + + <STRONG>-a</STRONG> tells <STRONG>tic</STRONG> to retain commented-out capabilities + rather than discarding them. Capabilities are com- + mented by prefixing them with a period. This sets + the <STRONG>-x</STRONG> option, because it treats the commented-out + entries as user-defined names. If the source is + termcap, accept the 2-character names required by + version 6. Otherwise these are ignored. + + <STRONG>-C</STRONG> Force source translation to termcap format. Note: + this differs from the <STRONG>-C</STRONG> option of <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> in + that it does not merely translate capability names, + but also translates terminfo strings to termcap + format. Capabilities that are not translatable are + left in the entry under their terminfo names but + commented out with two preceding dots. + + <STRONG>-c</STRONG> tells <STRONG>tic</STRONG> to only check <EM>file</EM> for errors, including + syntax problems and bad use links. If you specify + <STRONG>-C</STRONG> (<STRONG>-I</STRONG>) with this option, the code will print warn- + ings about entries which, after use resolution, are + more than 1023 (4096) bytes long. Due to a fixed + buffer length in older termcap libraries (and a + documented limit in terminfo), these entries may + cause core dumps. + + <STRONG>-e</STRONG> <EM>names</EM> + Limit writes and translations to the following + comma-separated list of terminals. If any name or + alias of a terminal matches one of the names in the + list, the entry will be written or translated as + normal. Otherwise no output will be generated for + it. The option value is interpreted as a file con- + taining the list if it contains a '/'. (Note: + depending on how tic was compiled, this option may + require <STRONG>-I</STRONG> or <STRONG>-C</STRONG>.) + + <STRONG>-f</STRONG> Display complex terminfo strings which contain + if/then/else/endif expressions indented for read- + ability. + + <STRONG>-G</STRONG> Display constant literals in decimal form rather + than their character equivalents. + + <STRONG>-g</STRONG> Display constant character literals in quoted form + rather than their decimal equivalents. + + <STRONG>-I</STRONG> Force source translation to terminfo format. + + <STRONG>-L</STRONG> Force source translation to terminfo format using + the long C variable names listed in <<STRONG>term.h</STRONG>> + + <STRONG>-N</STRONG> Disable smart defaults. Normally, when translating + from termcap to terminfo, the compiler makes a num- + ber of assumptions about the defaults of string + capabilities <STRONG>reset1_string</STRONG>, <STRONG>carriage_return</STRONG>, <STRONG>cur-</STRONG> + <STRONG>sor_left</STRONG>, <STRONG>cursor_down</STRONG>, <STRONG>scroll_forward</STRONG>, <STRONG>tab</STRONG>, <STRONG>new-</STRONG> + <STRONG>line</STRONG>, <STRONG>key_backspace</STRONG>, <STRONG>key_left</STRONG>, and <STRONG>key_down</STRONG>, then + attempts to use obsolete termcap capabilities to + deduce correct values. It also normally suppresses + output of obsolete termcap capabilities such as <STRONG>bs</STRONG>. + This option forces a more literal translation that + also preserves the obsolete capabilities. + + <STRONG>-o</STRONG><EM>dir</EM> Write compiled entries to given directory. Over- + rides the TERMINFO environment variable. + + <STRONG>-R</STRONG><EM>subset</EM> + Restrict output to a given subset. This option is + for use with archaic versions of terminfo like + those on SVr1, Ultrix, or HP/UX that do not support + the full set of SVR4/XSI Curses terminfo; and out- + right broken ports like AIX 3.x that have their own + extensions incompatible with SVr4/XSI. Available + subsets are "SVr1", "Ultrix", "HP", "BSD" and + "AIX"; see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for details. + + <STRONG>-r</STRONG> Force entry resolution (so there are no remaining + tc capabilities) even when doing translation to + termcap format. This may be needed if you are + preparing a termcap file for a termcap library + (such as GNU termcap through version 1.3 or BSD + termcap through 4.3BSD) that does not handle multi- + ple tc capabilities per entry. + + <STRONG>-s</STRONG> Summarize the compile by showing the directory into + which entries are written, and the number of + entries which are compiled. + + <STRONG>-T</STRONG> eliminates size-restrictions on the generated text. + This is mainly useful for testing and analysis, + since the compiled descriptions are limited (e.g., + 1023 for termcap, 4096 for terminfo). + + <STRONG>-t</STRONG> tells <STRONG>tic</STRONG> to discard commented-out capabilities. + Normally when translating from terminfo to termcap, + untranslatable capabilities are commented-out. + + <STRONG>-U</STRONG> tells <STRONG>tic</STRONG> to not post-process the data after parsing + the source file. Normally, it infers data which is + commonly missing in older terminfo data, or in term- + caps. + + <STRONG>-V</STRONG> reports the version of ncurses which was used in this + program, and exits. + + <STRONG>-v</STRONG><EM>n</EM> specifies that (verbose) output be written to stan- + dard error trace information showing <STRONG>tic</STRONG>'s progress. + The optional parameter <EM>n</EM> is a number from 1 to 10, + inclusive, indicating the desired level of detail of + information. If <EM>n</EM> is omitted, the default level is + 1. If <EM>n</EM> is specified and greater than 1, the level + of detail is increased. + + <STRONG>-w</STRONG><EM>n</EM> specifies the width of the output. The parameter is + optional. If it is omitted, it defaults to 60. + + <STRONG>-x</STRONG> Treat unknown capabilities as user-defined. That is, + if you supply a capability name which <STRONG>tic</STRONG> does not + recognize, it will infer its type (boolean, number or + string) from the syntax and make an extended table + entry for that. User-defined capability strings + whose name begins with ``k'' are treated as function + keys. + + <EM>file</EM> contains one or more <STRONG>terminfo</STRONG> terminal descriptions + in source format [see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. Each description + in the file describes the capabilities of a particu- + lar terminal. + + The debug flag levels are as follows: + + 1 Names of files created and linked + + 2 Information related to the ``use'' facility + + 3 Statistics from the hashing algorithm + + 5 String-table memory allocations + + 7 Entries into the string-table + + 8 List of tokens encountered by scanner + + 9 All values computed in construction of the hash ta- + ble + + If the debug level <EM>n</EM> is not given, it is taken to be one. + + All but one of the capabilities recognized by <STRONG>tic</STRONG> are doc- + umented in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. The exception is the <STRONG>use</STRONG> capabil- + ity. + + When a <STRONG>use</STRONG>=<EM>entry</EM>-<EM>name</EM> field is discovered in a terminal + entry currently being compiled, <STRONG>tic</STRONG> reads in the binary + from <STRONG>/usr/share/terminfo</STRONG> to complete the entry. (Entries + created from <EM>file</EM> will be used first. If the environment + variable <STRONG>TERMINFO</STRONG> is set, that directory is searched + instead of <STRONG>/usr/share/terminfo</STRONG>.) <STRONG>tic</STRONG> duplicates the capa- + bilities in <EM>entry</EM>-<EM>name</EM> for the current entry, with the + exception of those capabilities that explicitly are + defined in the current entry. + + When an entry, e.g., <STRONG>entry_name_1</STRONG>, contains a + <STRONG>use=</STRONG><EM>entry</EM>_<EM>name</EM>_<EM>2</EM> field, any canceled capabilities in + <EM>entry</EM>_<EM>name</EM>_<EM>2</EM> must also appear in <STRONG>entry_name_1</STRONG> before <STRONG>use=</STRONG> + for these capabilities to be canceled in <STRONG>entry_name_1</STRONG>. + + If the environment variable <STRONG>TERMINFO</STRONG> is set, the compiled + results are placed there instead of <STRONG>/usr/share/terminfo</STRONG>. + + Total compiled entries cannot exceed 4096 bytes. The name + field cannot exceed 512 bytes. Terminal names exceeding + the maximum alias length (32 characters on systems with + long filenames, 14 characters otherwise) will be truncated + to the maximum alias length and a warning message will be + printed. + + +</PRE> +<H2>COMPATIBILITY</H2><PRE> + There is some evidence that historic <STRONG>tic</STRONG> implementations + treated description fields with no whitespace in them as + additional aliases or short names. This <STRONG>tic</STRONG> does not do + that, but it does warn when description fields may be + treated that way and check them for dangerous characters. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + Unlike the stock SVr4 <STRONG>tic</STRONG> command, this implementation can + actually compile termcap sources. In fact, entries in + terminfo and termcap syntax can be mixed in a single + source file. See <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for the list of termcap + names taken to be equivalent to terminfo names. + + The SVr4 manual pages are not clear on the resolution + rules for <STRONG>use</STRONG> capabilities. This implementation of <STRONG>tic</STRONG> + will find <STRONG>use</STRONG> targets anywhere in the source file, or any- + where in the file tree rooted at <STRONG>TERMINFO</STRONG> (if <STRONG>TERMINFO</STRONG> is + defined), or in the user's <EM>$HOME/.terminfo</EM> directory (if + it exists), or (finally) anywhere in the system's file + tree of compiled entries. + + The error messages from this <STRONG>tic</STRONG> have the same format as + GNU C error messages, and can be parsed by GNU Emacs's + compile facility. + + The <STRONG>-C</STRONG>, <STRONG>-G</STRONG>, <STRONG>-I</STRONG>, <STRONG>-N</STRONG>, <STRONG>-R</STRONG>, <STRONG>-T</STRONG>, <STRONG>-V</STRONG>, <STRONG>-a</STRONG>, <STRONG>-e</STRONG>, <STRONG>-f</STRONG>, <STRONG>-g</STRONG>, <STRONG>-o</STRONG>, <STRONG>-r</STRONG>, + <STRONG>-s</STRONG>, <STRONG>-t</STRONG> and <STRONG>-x</STRONG> options are not supported under SVr4. The + SVr4 <STRONG>-c</STRONG> mode does not report bad use links. + + System V does not compile entries to or read entries from + your <EM>$HOME/.terminfo</EM> directory unless TERMINFO is explic- + itly set to it. + + +</PRE> +<H2>FILES</H2><PRE> + <STRONG>/usr/share/terminfo/?/*</STRONG> + Compiled terminal description database. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>, <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>, + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + +</PRE> +<H2>AUTHOR</H2><PRE> + Eric S. Raymond <esr@snark.thyrsus.com> and + Thomas E. Dickey <dickey@invisible-island.net> + + + + <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/toe.1m.html b/doc/html/man/toe.1m.html new file mode 100644 index 000000000000..b948480e0c93 --- /dev/null +++ b/doc/html/man/toe.1m.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: toe.1m,v 1.23 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>toe 1m</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>toe 1m</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>toe</STRONG> - table of (terminfo) entries + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>toe</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahuUV</STRONG>] <EM>file...</EM> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + With no options, <STRONG>toe</STRONG> lists all available terminal types by + primary name with descriptions. File arguments specify + the directories to be scanned; if no such arguments are + given, your default terminfo directory is scanned. If you + also specify the <STRONG>-h</STRONG> option, a directory header will be + issued as each directory is entered. + + There are other options intended for use by terminfo file + maintainers: + + <STRONG>-a</STRONG> report on all of the terminal databases which + ncurses would search, rather than only the first + one that it finds. + + <STRONG>-u</STRONG> <EM>file</EM> + says to write a report to the standard output, + listing dependencies in the given terminfo/termcap + source file. The report condenses the `use' rela- + tion: each line consists of the primary name of a + terminal that has use capabilities, followed by a + colon, followed by the whitespace-separated primary + names of all terminals which occur in those use + capabilities, followed by a newline + + <STRONG>-U</STRONG> <EM>file</EM> + says to write a report to the standard output, + listing reverse dependencies in the given ter- + minfo/termcap source file. The report reverses the + `use' relation: each line consists of the primary + name of a terminal that occurs in use capabilities, + followed by a colon, followed by the whitespace- + separated primary names of all terminals which + depend on it, followed by a newline. + + <STRONG>-v</STRONG><EM>n</EM> specifies that (verbose) output be written to stan- + dard error, showing <STRONG>toe</STRONG>'s progress. The optional + parameter <EM>n</EM> is a number from 1 to 10, interpreted + as for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>. + + <STRONG>-V</STRONG> reports the version of ncurses which was used in + this program, and exits. + + +</PRE> +<H2>FILES</H2><PRE> + <STRONG>/usr/share/terminfo/?/*</STRONG> + Compiled terminal description database. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>, + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/tput.1.html b/doc/html/man/tput.1.html new file mode 100644 index 000000000000..e702f7bacef6 --- /dev/null +++ b/doc/html/man/tput.1.html @@ -0,0 +1,343 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: tput.1,v 1.29 2010/12/04 18:41:07 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>tput 1</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>tput 1</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>tput</STRONG>, <STRONG>reset</STRONG> - initialize a terminal or query terminfo + database + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <EM>capname</EM> [<EM>parms</EM> ... ] + <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>init</STRONG> + <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>reset</STRONG> + <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>longname</STRONG> + <STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<</STRONG> + <STRONG>tput</STRONG> <STRONG>-V</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>tput</STRONG> utility uses the <STRONG>terminfo</STRONG> database to make the + values of terminal-dependent capabilities and information + available to the shell (see <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>), to initialize or reset + the terminal, or return the long name of the requested + terminal type. The result depends upon the capability's + type: + + string + <STRONG>tput</STRONG> writes the string to the standard output. + No trailing newline is supplied. + + integer + <STRONG>tput</STRONG> writes the decimal value to the standard + output, with a trailing newline. + + boolean + <STRONG>tput</STRONG> simply sets the exit code (<STRONG>0</STRONG> for TRUE if + the terminal has the capability, <STRONG>1</STRONG> for FALSE + if it does not), and writes nothing to the + standard output. + + Before using a value returned on the standard output, the + application should test the exit code (e.g., <STRONG>$?</STRONG>, see + <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>) to be sure it is <STRONG>0</STRONG>. (See the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> and <STRONG>DIAG-</STRONG> + <STRONG>NOSTICS</STRONG> sections.) For a complete list of capabilities + and the <EM>capname</EM> associated with each, see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + <STRONG>-T</STRONG><EM>type</EM> indicates the <EM>type</EM> of terminal. Normally this + option is unnecessary, because the default is taken + from the environment variable <STRONG>TERM</STRONG>. If <STRONG>-T</STRONG> is spec- + ified, then the shell variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> + will be ignored,and the operating system will not + be queried for the actual screen size. + + <EM>capname</EM> + indicates the capability from the <STRONG>terminfo</STRONG> + database. When <STRONG>termcap</STRONG> support is compiled in, the + <STRONG>termcap</STRONG> name for the capability is also accepted. + + <EM>parms</EM> If the capability is a string that takes parame- + ters, the arguments <EM>parms</EM> will be instantiated into + the string. + + Most parameters are numbers. Only a few terminfo + capabilities require string parameters; <STRONG>tput</STRONG> uses a + table to decide which to pass as strings. Normally + <STRONG>tput</STRONG> uses <STRONG>tparm</STRONG> (3x) to perform the substitution. + If no parameters are given for the capability, <STRONG>tput</STRONG> + writes the string without performing the + substitution. + + <STRONG>-S</STRONG> allows more than one capability per invocation of + <STRONG>tput</STRONG>. The capabilities must be passed to <STRONG>tput</STRONG> from + the standard input instead of from the command line + (see example). Only one <EM>capname</EM> is allowed per + line. The <STRONG>-S</STRONG> option changes the meaning of the <STRONG>0</STRONG> + and <STRONG>1</STRONG> boolean and string exit codes (see the EXIT + CODES section). + + Again, <STRONG>tput</STRONG> uses a table and the presence of param- + eters in its input to decide whether to use <STRONG>tparm</STRONG> + (3x), and how to interpret the parameters. + + <STRONG>-V</STRONG> reports the version of ncurses which was used in + this program, and exits. + + <STRONG>init</STRONG> If the <STRONG>terminfo</STRONG> database is present and an entry + for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM>, above), + the following will occur: + + (1) if present, the terminal's initialization + strings will be output as detailed in the + <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> section on <EM>Tabs</EM> <EM>and</EM> <EM>Initializa-</EM> + <EM>tion</EM>, + + (2) any delays (e.g., newline) specified in the + entry will be set in the tty driver, + + (3) tabs expansion will be turned on or off + according to the specification in the entry, + and + + (4) if tabs are not expanded, standard tabs will + be set (every 8 spaces). + + If an entry does not contain the information needed + for any of the four above activities, that activity + will silently be skipped. + + <STRONG>reset</STRONG> Instead of putting out initialization strings, the + terminal's reset strings will be output if present + (<STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>). If the reset strings are not + present, but initialization strings are, the ini- + tialization strings will be output. Otherwise, + <STRONG>reset</STRONG> acts identically to <STRONG>init</STRONG>. + + <STRONG>longname</STRONG> + If the <STRONG>terminfo</STRONG> database is present and an entry + for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM> above), + then the long name of the terminal will be put out. + The long name is the last name in the first line of + the terminal's description in the <STRONG>terminfo</STRONG> database + [see <STRONG><A HREF="term.5.html">term(5)</A></STRONG>]. + + If <STRONG>tput</STRONG> is invoked by a link named <STRONG>reset</STRONG>, this has the + same effect as <STRONG>tput</STRONG> <STRONG>reset</STRONG>. See <STRONG>tset</STRONG> for comparison, which + has similar behavior. + + +</PRE> +<H2>EXAMPLES</H2><PRE> + <STRONG>tput</STRONG> <STRONG>init</STRONG> + Initialize the terminal according to the type of ter- + minal in the environmental variable <STRONG>TERM</STRONG>. This com- + mand should be included in everyone's .profile after + the environmental variable <STRONG>TERM</STRONG> has been exported, as + illustrated on the <STRONG><A HREF="profile.5.html">profile(5)</A></STRONG> manual page. + + <STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG> + Reset an AT&T 5620 terminal, overriding the type of + terminal in the environmental variable <STRONG>TERM</STRONG>. + + <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>0</STRONG> <STRONG>0</STRONG> + Send the sequence to move the cursor to row <STRONG>0</STRONG>, column + <STRONG>0</STRONG> (the upper left corner of the screen, usually known + as the "home" cursor position). + + <STRONG>tput</STRONG> <STRONG>clear</STRONG> + Echo the clear-screen sequence for the current termi- + nal. + + <STRONG>tput</STRONG> <STRONG>cols</STRONG> + Print the number of columns for the current terminal. + + <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>cols</STRONG> + Print the number of columns for the 450 terminal. + + <STRONG>bold=`tput</STRONG> <STRONG>smso`</STRONG> <STRONG>offbold=`tput</STRONG> <STRONG>rmso`</STRONG> + Set the shell variables <STRONG>bold</STRONG>, to begin stand-out mode + sequence, and <STRONG>offbold</STRONG>, to end standout mode sequence, + for the current terminal. This might be followed by + a prompt: <STRONG>echo</STRONG> <STRONG>"${bold}Please</STRONG> <STRONG>type</STRONG> <STRONG>in</STRONG> <STRONG>your</STRONG> <STRONG>name:</STRONG> + <STRONG>${offbold}\c"</STRONG> + + <STRONG>tput</STRONG> <STRONG>hc</STRONG> + Set exit code to indicate if the current terminal is + a hard copy terminal. + + <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG> + Send the sequence to move the cursor to row 23, col- + umn 4. + + <STRONG>tput</STRONG> <STRONG>cup</STRONG> + Send the terminfo string for cursor-movement, with no + parameters substituted. + + <STRONG>tput</STRONG> <STRONG>longname</STRONG> + Print the long name from the <STRONG>terminfo</STRONG> database for + the type of terminal specified in the environmental + variable <STRONG>TERM</STRONG>. + + <STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<!</STRONG> + <STRONG>></STRONG> <STRONG>clear</STRONG> + <STRONG>></STRONG> <STRONG>cup</STRONG> <STRONG>10</STRONG> <STRONG>10</STRONG> + <STRONG>></STRONG> <STRONG>bold</STRONG> + <STRONG>></STRONG> <STRONG>!</STRONG> + + This example shows <STRONG>tput</STRONG> processing several capabili- + ties in one invocation. It clears the screen, moves + the cursor to position 10, 10 and turns on bold + (extra bright) mode. The list is terminated by an + exclamation mark (<STRONG>!</STRONG>) on a line by itself. + + +</PRE> +<H2>FILES</H2><PRE> + <STRONG>/usr/share/terminfo</STRONG> + compiled terminal description database + + <STRONG>/usr/share/tabset/*</STRONG> + tab settings for some terminals, in a format appro- + priate to be output to the terminal (escape + sequences that set margins and tabs); for more + information, see the "Tabs and Initialization" sec- + tion of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> + + +</PRE> +<H2>EXIT CODES</H2><PRE> + If the <STRONG>-S</STRONG> option is used, <STRONG>tput</STRONG> checks for errors from each + line, and if any errors are found, will set the exit code + to 4 plus the number of lines with errors. If no errors + are found, the exit code is <STRONG>0</STRONG>. No indication of which + line failed can be given so exit code <STRONG>1</STRONG> will never appear. + Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation. + If the <STRONG>-S</STRONG> option is not used, the exit code depends on the + type of <EM>capname</EM>: + + <EM>boolean</EM> + a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE. + + <EM>string</EM> a value of <STRONG>0</STRONG> is set if the <EM>capname</EM> is defined + for this terminal <EM>type</EM> (the value of <EM>capname</EM> + is returned on standard output); a value of <STRONG>1</STRONG> + is set if <EM>capname</EM> is not defined for this ter- + minal <EM>type</EM> (nothing is written to standard + output). + + <EM>integer</EM> + a value of <STRONG>0</STRONG> is always set, whether or not + <EM>capname</EM> is defined for this terminal <EM>type</EM>. To + determine if <EM>capname</EM> is defined for this ter- + minal <EM>type</EM>, the user must test the value writ- + ten to standard output. A value of <STRONG>-1</STRONG> means + that <EM>capname</EM> is not defined for this terminal + <EM>type</EM>. + + <EM>other</EM> <STRONG>reset</STRONG> or <STRONG>init</STRONG> may fail to find their respec- + tive files. In that case, the exit code is + set to 4 + <STRONG>errno</STRONG>. + + Any other exit code indicates an error; see the DIAGNOS- + TICS section. + + +</PRE> +<H2>DIAGNOSTICS</H2><PRE> + <STRONG>tput</STRONG> prints the following error messages and sets the cor- + responding exit codes. + + + exit code error message + --------------------------------------------------------------------- + <STRONG>0</STRONG> (<EM>capname</EM> is a numeric variable that is not specified in + the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> database for this terminal type, e.g. + <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>lines</STRONG> and <STRONG>tput</STRONG> <STRONG>-T2621</STRONG> <STRONG>xmc</STRONG>) + <STRONG>1</STRONG> no error message is printed, see the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> section. + <STRONG>2</STRONG> usage error + <STRONG>3</STRONG> unknown terminal <EM>type</EM> or no <STRONG>terminfo</STRONG> database + <STRONG>4</STRONG> unknown <STRONG>terminfo</STRONG> capability <EM>capname</EM> + <STRONG>>4</STRONG> error occurred in -S + --------------------------------------------------------------------- + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <STRONG>longname</STRONG> and <STRONG>-S</STRONG> options, and the parameter-substitu- + tion features used in the <STRONG>cup</STRONG> example, are not supported + in BSD curses or in AT&T/USL curses before SVr4. + + X/Open documents only the operands for <STRONG>clear</STRONG>, <STRONG>init</STRONG> and + <STRONG>reset</STRONG>. In this implementation, <STRONG>clear</STRONG> is part of the <EM>cap-</EM> + <EM>name</EM> support. Other implementations of <STRONG>tput</STRONG> on SVr4-based + systems such as Solaris, IRIX64 and HPUX as well as others + such as AIX and Tru64 provide support for <EM>capname</EM> + operands. A few platforms such as FreeBSD and NetBSD rec- + ognize termcap names rather than terminfo capability names + in their respective <STRONG>tput</STRONG> commands. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/tset.1.html b/doc/html/man/tset.1.html new file mode 100644 index 000000000000..fe3d63ffb590 --- /dev/null +++ b/doc/html/man/tset.1.html @@ -0,0 +1,334 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: tset.1,v 1.25 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>tset 1</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>tset 1</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>tset</STRONG>, <STRONG>reset</STRONG> - terminal initialization + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>tset</STRONG> [<STRONG>-IQVcqrsw</STRONG>] [<STRONG>-</STRONG>] [<STRONG>-e</STRONG> <EM>ch</EM>] [<STRONG>-i</STRONG> <EM>ch</EM>] [<STRONG>-k</STRONG> <EM>ch</EM>] [<STRONG>-m</STRONG> <EM>mapping</EM>] + [<EM>terminal</EM>] + <STRONG>reset</STRONG> [<STRONG>-IQVcqrsw</STRONG>] [<STRONG>-</STRONG>] [<STRONG>-e</STRONG> <EM>ch</EM>] [<STRONG>-i</STRONG> <EM>ch</EM>] [<STRONG>-k</STRONG> <EM>ch</EM>] [<STRONG>-m</STRONG> <EM>mapping</EM>] + [<EM>terminal</EM>] + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <STRONG>Tset</STRONG> initializes terminals. <STRONG>Tset</STRONG> first determines the + type of terminal that you are using. This determination + is done as follows, using the first terminal type found. + + 1. The <STRONG>terminal</STRONG> argument specified on the command line. + + 2. The value of the <STRONG>TERM</STRONG> environmental variable. + + 3. (BSD systems only.) The terminal type associated with + the standard error output device in the <EM>/etc/ttys</EM> file. + (On System-V-like UNIXes and systems using that conven- + tion, <EM>getty</EM> does this job by setting <STRONG>TERM</STRONG> according to the + type passed to it by <EM>/etc/inittab</EM>.) + + 4. The default terminal type, ``unknown''. + + If the terminal type was not specified on the command- + line, the <STRONG>-m</STRONG> option mappings are then applied (see the + section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more information). + Then, if the terminal type begins with a question mark + (``?''), the user is prompted for confirmation of the ter- + minal type. An empty response confirms the type, or, + another type can be entered to specify a new type. Once + the terminal type has been determined, the terminfo entry + for the terminal is retrieved. If no terminfo entry is + found for the type, the user is prompted for another ter- + minal type. + + Once the terminfo entry is retrieved, the window size, + backspace, interrupt and line kill characters (among many + other things) are set and the terminal and tab initializa- + tion strings are sent to the standard error output. + Finally, if the erase, interrupt and line kill characters + have changed, or are not set to their default values, + their values are displayed to the standard error output. + Use the <STRONG>-c</STRONG> or <STRONG>-w</STRONG> option to select only the window sizing + versus the other initialization. If neither option is + given, both are assumed. + + When invoked as <STRONG>reset</STRONG>, <STRONG>tset</STRONG> sets cooked and echo modes, + turns off cbreak and raw modes, turns on newline transla- + tion and resets any unset special characters to their + default values before doing the terminal initialization + described above. This is useful after a program dies + leaving a terminal in an abnormal state. Note, you may + have to type + + <STRONG><LF>reset<LF></STRONG> + + (the line-feed character is normally control-J) to get the + terminal to work, as carriage-return may no longer work in + the abnormal state. Also, the terminal will often not + echo the command. + + The options are as follows: + + <STRONG>-c</STRONG> Set control characters and modes. <STRONG>-e</STRONG> Set the erase + character to <EM>ch</EM>. + + <STRONG>-I</STRONG> Do not send the terminal or tab initialization + strings to the terminal. + + <STRONG>-i</STRONG> Set the interrupt character to <EM>ch</EM>. + + <STRONG>-k</STRONG> Set the line kill character to <EM>ch</EM>. + + <STRONG>-m</STRONG> Specify a mapping from a port type to a terminal. + See the section <STRONG>TERMINAL</STRONG> <STRONG>TYPE</STRONG> <STRONG>MAPPING</STRONG> for more infor- + mation. + + <STRONG>-Q</STRONG> Do not display any values for the erase, interrupt + and line kill characters. Normally <STRONG>tset</STRONG> displays the + values for control characters which differ from the + system's default values. + + <STRONG>-q</STRONG> The terminal type is displayed to the standard out- + put, and the terminal is not initialized in any way. + The option `-' by itself is equivalent but archaic. + + <STRONG>-r</STRONG> Print the terminal type to the standard error output. + + <STRONG>-s</STRONG> Print the sequence of shell commands to initialize + the environment variable <STRONG>TERM</STRONG> to the standard output. + See the section <STRONG>SETTING</STRONG> <STRONG>THE</STRONG> <STRONG>ENVIRONMENT</STRONG> for details. + + <STRONG>-V</STRONG> reports the version of ncurses which was used in this + program, and exits. + + <STRONG>-w</STRONG> Resize the window to match the size deduced via + <STRONG>setupterm</STRONG>. Normally this has no effect, unless + <STRONG>setupterm</STRONG> is not able to detect the window size. + + The arguments for the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG> options may either be + entered as actual characters or by using the `hat' nota- + tion, i.e., control-h may be specified as ``^H'' or + ``^h''. + + +</PRE> +<H2>SETTING THE ENVIRONMENT</H2><PRE> + It is often desirable to enter the terminal type and + information about the terminal's capabilities into the + shell's environment. This is done using the <STRONG>-s</STRONG> option. + + When the <STRONG>-s</STRONG> option is specified, the commands to enter the + information into the shell's environment are written to + the standard output. If the <STRONG>SHELL</STRONG> environmental variable + ends in ``csh'', the commands are for <STRONG>csh</STRONG>, otherwise, they + are for <STRONG>sh</STRONG>. Note, the <STRONG>csh</STRONG> commands set and unset the + shell variable <STRONG>noglob</STRONG>, leaving it unset. The following + line in the <STRONG>.login</STRONG> or <STRONG>.profile</STRONG> files will initialize the + environment correctly: + + eval `tset -s options ... ` + + +</PRE> +<H2>TERMINAL TYPE MAPPING</H2><PRE> + When the terminal is not hardwired into the system (or the + current system information is incorrect) the terminal type + derived from the <EM>/etc/ttys</EM> file or the <STRONG>TERM</STRONG> environmental + variable is often something generic like <STRONG>network</STRONG>, <STRONG>dialup</STRONG>, + or <STRONG>unknown</STRONG>. When <STRONG>tset</STRONG> is used in a startup script it is + often desirable to provide information about the type of + terminal used on such ports. + + The purpose of the <STRONG>-m</STRONG> option is to map from some set of + conditions to a terminal type, that is, to tell <STRONG>tset</STRONG> ``If + I'm on this port at a particular speed, guess that I'm on + that kind of terminal''. + + The argument to the <STRONG>-m</STRONG> option consists of an optional port + type, an optional operator, an optional baud rate specifi- + cation, an optional colon (``:'') character and a terminal + type. The port type is a string (delimited by either the + operator or the colon character). The operator may be any + combination of ``>'', ``<'', ``@'', and ``!''; ``>'' means + greater than, ``<'' means less than, ``@'' means equal to + and ``!'' inverts the sense of the test. The baud rate is + specified as a number and is compared with the speed of + the standard error output (which should be the control + terminal). The terminal type is a string. + + If the terminal type is not specified on the command line, + the <STRONG>-m</STRONG> mappings are applied to the terminal type. If the + port type and baud rate match the mapping, the terminal + type specified in the mapping replaces the current type. + If more than one mapping is specified, the first applica- + ble mapping is used. + + For example, consider the following mapping: + <STRONG>dialup>9600:vt100</STRONG>. The port type is dialup , the operator + is >, the baud rate specification is 9600, and the termi- + nal type is vt100. The result of this mapping is to spec- + ify that if the terminal type is <STRONG>dialup</STRONG>, and the baud rate + is greater than 9600 baud, a terminal type of <STRONG>vt100</STRONG> will + be used. + + If no baud rate is specified, the terminal type will match + any baud rate. If no port type is specified, the terminal + type will match any port type. For example, <STRONG>-m</STRONG> + <STRONG>dialup:vt100</STRONG> <STRONG>-m</STRONG> <STRONG>:?xterm</STRONG> will cause any dialup port, + regardless of baud rate, to match the terminal type vt100, + and any non-dialup port type to match the terminal type + ?xterm. Note, because of the leading question mark, the + user will be queried on a default port as to whether they + are actually using an xterm terminal. + + No whitespace characters are permitted in the <STRONG>-m</STRONG> option + argument. Also, to avoid problems with meta-characters, + it is suggested that the entire <STRONG>-m</STRONG> option argument be + placed within single quote characters, and that <STRONG>csh</STRONG> users + insert a backslash character (``\'') before any exclama- + tion marks (``!''). + + +</PRE> +<H2>HISTORY</H2><PRE> + The <STRONG>tset</STRONG> command appeared in BSD 3.0. The <STRONG>ncurses</STRONG> imple- + mentation was lightly adapted from the 4.4BSD sources for + a terminfo environment by Eric S. Raymond <esr@snark.thyr- + sus.com>. + + +</PRE> +<H2>COMPATIBILITY</H2><PRE> + The <STRONG>tset</STRONG> utility has been provided for backward-compati- + bility with BSD environments (under most modern UNIXes, + <STRONG>/etc/inittab</STRONG> and <STRONG><A HREF="getty.1.html">getty(1)</A></STRONG> can set <STRONG>TERM</STRONG> appropriately for + each dial-up line; this obviates what was <STRONG>tset</STRONG>'s most + important use). This implementation behaves like 4.4BSD + tset, with a few exceptions specified here. + + The <STRONG>-S</STRONG> option of BSD tset no longer works; it prints an + error message to stderr and dies. The <STRONG>-s</STRONG> option only sets + <STRONG>TERM</STRONG>, not <STRONG>TERMCAP</STRONG>. Both these changes are because the + <STRONG>TERMCAP</STRONG> variable is no longer supported under terminfo- + based <STRONG>ncurses</STRONG>, which makes <STRONG>tset</STRONG> <STRONG>-S</STRONG> useless (we made it die + noisily rather than silently induce lossage). + + There was an undocumented 4.4BSD feature that invoking + tset via a link named `TSET` (or via any other name begin- + ning with an upper-case letter) set the terminal to use + upper-case only. This feature has been omitted. + + The <STRONG>-A</STRONG>, <STRONG>-E</STRONG>, <STRONG>-h</STRONG>, <STRONG>-u</STRONG> and <STRONG>-v</STRONG> options were deleted from the + <STRONG>tset</STRONG> utility in 4.4BSD. None of them were documented in + 4.3BSD and all are of limited utility at best. The <STRONG>-a</STRONG>, + <STRONG>-d</STRONG>, and <STRONG>-p</STRONG> options are similarly not documented or useful, + but were retained as they appear to be in widespread use. + It is strongly recommended that any usage of these three + options be changed to use the <STRONG>-m</STRONG> option instead. The <STRONG>-n</STRONG> + option remains, but has no effect. The <STRONG>-adnp</STRONG> options are + therefore omitted from the usage summary above. + + It is still permissible to specify the <STRONG>-e</STRONG>, <STRONG>-i</STRONG>, and <STRONG>-k</STRONG> + options without arguments, although it is strongly recom- + mended that such usage be fixed to explicitly specify the + character. + + As of 4.4BSD, executing <STRONG>tset</STRONG> as <STRONG>reset</STRONG> no longer implies + the <STRONG>-Q</STRONG> option. Also, the interaction between the - option + and the <EM>terminal</EM> argument in some historic implementations + of <STRONG>tset</STRONG> has been removed. + + +</PRE> +<H2>ENVIRONMENT</H2><PRE> + The <STRONG>tset</STRONG> command uses these environment variables: + + SHELL + tells <STRONG>tset</STRONG> whether to initialize <STRONG>TERM</STRONG> using <STRONG>sh</STRONG> or <STRONG>csh</STRONG> + syntax. + + TERM Denotes your terminal type. Each terminal type is + distinct, though many are similar. + + TERMCAP + may denote the location of a termcap database. If it + is not an absolute pathname, e.g., begins with a `/', + <STRONG>tset</STRONG> removes the variable from the environment before + looking for the terminal description. + + +</PRE> +<H2>FILES</H2><PRE> + /etc/ttys + system port name to terminal type mapping database + (BSD versions only). + + /usr/share/terminfo + terminal capability database + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="csh.1.html">csh(1)</A></STRONG>, <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>, <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="tty.4.html">tty(4)</A></STRONG>, ter- + <STRONG><A HREF="minfo.5.html">minfo(5)</A></STRONG>, <STRONG><A HREF="ttys.5.html">ttys(5)</A></STRONG>, <STRONG><A HREF="environ.7.html">environ(7)</A></STRONG> + + This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226). + + + + <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/html/man/wresize.3x.html b/doc/html/man/wresize.3x.html new file mode 100644 index 000000000000..dff5834db79c --- /dev/null +++ b/doc/html/man/wresize.3x.html @@ -0,0 +1,108 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * Author: Thomas E. Dickey 1996 + * @Id: wresize.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>wresize 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>wresize 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>wresize</STRONG> - resize a curses window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>wresize(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It reallo- + cates storage for an <STRONG>ncurses</STRONG> window to adjust its dimen- + sions to the specified values. If either dimension is + larger than the current values, the window's data is + filled with blanks that have the current background rendi- + tion (as set by <STRONG>wbkgdset</STRONG>) merged into them. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function returns the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> + on success. It will fail if either of the dimensions less + than or equal to zero, or if an error occurs while + (re)allocating memory for the window. + + +</PRE> +<H2>NOTES</H2><PRE> + The only restriction placed on the dimensions is that they + be greater than zero. The dimensions are not compared to + <STRONG>curses</STRONG> screen dimensions to simplify the logic of + <STRONG>resizeterm</STRONG>. The caller must ensure that the window's + dimensions fit within the actual screen dimensions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (from an equivalent function written in 1988 + for BSD curses). + + + + <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |