diff options
Diffstat (limited to 'doc/html/man')
134 files changed, 3258 insertions, 2854 deletions
diff --git a/doc/html/man/adacurses-config.1.html b/doc/html/man/adacurses-config.1.html index 74b58a1..e5b5770 100644 --- a/doc/html/man/adacurses-config.1.html +++ b/doc/html/man/adacurses-config.1.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 2010-2011,2014 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 * @@ -27,7 +27,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: MKada_config.in,v 1.5 2011/03/26 14:44:51 tom Exp @ + * @Id: MKada_config.in,v 1.8 2014/06/07 19:32:52 tom Exp @ --> <HTML> <HEAD> @@ -78,21 +78,72 @@ <STRONG>--help</STRONG> prints a list of the <STRONG>adacurses-config</STRONG> script's options. + If no options are given, <STRONG>adacurses-config</STRONG> prints the com- + bination of <STRONG>--cflags</STRONG> and <STRONG>--libs</STRONG> that <STRONG>gnatmake</STRONG> expects (see + example). + + +</PRE> +<H2>EXAMPLE</H2><PRE> + For example, supposing that you want to compile the "Hello + World!" program for AdaCurses. Make a file named + "hello.adb": + with Terminal_Interface.Curses; use Terminal_Interface.Curses; + + procedure Hello is + + Visibility : Cursor_Visibility := Invisible; + done : Boolean := False; + c : Key_Code; + + begin + + Init_Screen; + Set_Echo_Mode (False); + + Set_Cursor_Visibility (Visibility); + Set_Timeout_Mode (Standard_Window, Non_Blocking, 0); + + Move_Cursor (Line => Lines / 2, Column => (Columns - 12) / 2); + Add (Str => "Hello World!"); + + while not done loop + + c := Get_Keystroke (Standard_Window); + case c is + when Character'Pos ('q') => done := True; + when others => null; + end case; + + Nap_Milli_Seconds (50); + + end loop; + + End_Windows; + + end Hello; + + Then, using + gnatmake `adacurses-config --cflags` hello -largs + `adacurses-config --libs` + + or (simpler): + gnatmake hello `adacurses-config` + + you will compile and link the program. + </PRE> <H2>SEE ALSO</H2><PRE> <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> - This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/captoinfo.1m.html b/doc/html/man/captoinfo.1m.html index aeacdd3..a5bc1a4 100644 --- a/doc/html/man/captoinfo.1m.html +++ b/doc/html/man/captoinfo.1m.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -87,8 +87,8 @@ </PRE> <H2>FILES</H2><PRE> - /usr/share/terminfo Compiled terminal description - database. + /usr/share/terminfo Compiled terminal description data- + base. </PRE> @@ -101,7 +101,6 @@ has not mistakenly translated a completely unknown and random capability and/or syntax error. - Nonstd Std From Terminfo name name capability ----------------------------------------------- @@ -116,8 +115,8 @@ 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 @@ -139,7 +138,6 @@ bilities for forms drawing, designed to take advantage of the IBM PC high-half graphics. They were as follows: - Cap Graphic ----------------------------- G2 upper left @@ -182,7 +180,6 @@ font0 s0ds font1 s1ds font2 s2ds - font3 s3ds Additionally, the AIX <EM>box1</EM> capability will be automati- @@ -208,7 +205,7 @@ <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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). </PRE> @@ -221,9 +218,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/clear.1.html b/doc/html/man/clear.1.html index 138806f..e642e6b 100644 --- a/doc/html/man/clear.1.html +++ b/doc/html/man/clear.1.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: clear.1,v 1.10 2013/06/22 22:22:11 tom Exp @ --> <HTML> <HEAD> @@ -57,9 +57,11 @@ </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> clears your screen if this is possible, including + its scrollback buffer (if the extended "E3" capability is + defined). <STRONG>clear</STRONG> looks in the environment for the terminal + type and then in the <STRONG>terminfo</STRONG> database to determine how to + clear the screen. <STRONG>clear</STRONG> ignores any command-line parameters that may be present. @@ -69,16 +71,13 @@ <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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_add_wch.3x.html b/doc/html/man/curs_add_wch.3x.html index 77ed34d..3e39b08 100644 --- a/doc/html/man/curs_add_wch.3x.html +++ b/doc/html/man/curs_add_wch.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2001-2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 2001-2011,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_add_wch.3x,v 1.15 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -77,17 +77,17 @@ 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. + 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> + 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. + <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, @@ -99,11 +99,10 @@ 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 + Like <STRONG><A HREF="curs_addch.3x.html">curs_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>. - + line-drawing set as <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>. <EM>Name</EM> <EM>Unicode</EM> <EM>Default</EM> <EM>Description</EM> ---------------------------------------------------------------- @@ -111,8 +110,8 @@ 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 @@ -144,7 +143,6 @@ 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 @@ -172,7 +170,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success. @@ -217,16 +215,13 @@ </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_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>putwc(3)</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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index 0f676ce..435ef83 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2005,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_add_wchstr.3x,v 1.10 2012/11/03 22:54:43 tom Exp @ --> <HTML> <HEAD> @@ -47,7 +47,7 @@ </PRE> <H2>NAME</H2><PRE> - <STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>, + <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 @@ -69,39 +69,42 @@ </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. + These functions copy the (null-terminated) array of com- + plex characters <EM>wchstr</EM> into the window image structure + starting at the current cursor position. The four func- + tions 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 functions work + faster than <STRONG>waddnstr</STRONG>. On the other hand: -</PRE> -<H2>NOTES</H2><PRE> - All functions except <STRONG>wadd_wchnstr</STRONG> may be macros. + <STRONG>o</STRONG> they do not perform checking (such as for the newline, + backspace, or carriage return characters), + + <STRONG>o</STRONG> they do not advance the current cursor position, + + <STRONG>o</STRONG> they do not expand other control characters to ^-es- + capes, and + + <STRONG>o</STRONG> they truncate the string if it crosses the right mar- + gin, rather than wrapping it around to the new line. + + These functions 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>RETURN VALUES</H2><PRE> - All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on - success. +<H2>RETURN VALUE</H2><PRE> + All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> + on success. + + 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 @@ -109,23 +112,28 @@ </PRE> +<H2>NOTES</H2><PRE> + All functions except <STRONG>wadd_wchnstr</STRONG> may be macros. + + +</PRE> <H2>PORTABILITY</H2><PRE> - All these entry points are described in the XSI Curses - standard, Issue 4. + 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>, <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_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. + + Comparable functions in the narrow-character (ncurses) li- + brary are described in <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_addch.3x.html b/doc/html/man/curs_addch.3x.html index af56711..1095e14 100644 --- a/doc/html/man/curs_addch.3x.html +++ b/doc/html/man/curs_addch.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 1998-2011,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: curs_addch.3x,v 1.33 2014/05/24 19:47:41 tom Exp @ --> <HTML> <HEAD> @@ -70,20 +70,34 @@ 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. + <STRONG>putchar</STRONG> in <STRONG>stdio(3)</STRONG>. If the advance is at the right mar- + gin: + + <STRONG>o</STRONG> The cursor automatically wraps to the beginning of the + next line. + + <STRONG>o</STRONG> At the bottom of the current scrolling region, and if + <STRONG>scrollok</STRONG> is enabled, the scrolling region is scrolled + up one line. + + <STRONG>o</STRONG> If <STRONG>scrollok</STRONG> is not enabled, writing a character at the + lower right margin succeeds. However, an error is + returned because it is not possible to wrap to a new + 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. + appropriately within the window: + + <STRONG>o</STRONG> Backspace moves the cursor one character left; at the + left edge of a window it does nothing. + + <STRONG>o</STRONG> 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. + + <STRONG>o</STRONG> Tabs are considered 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> @@ -112,9 +126,8 @@ 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. - + replacement for it. The names are taken from VT100 nomen- + clature. <EM>Name</EM> <EM>Default</EM> <EM>Description</EM> -------------------------------------------------- @@ -202,7 +215,7 @@ <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>. + <STRONG>putc(3)</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>. @@ -212,9 +225,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index e886139..b4664ac 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_addchstr.3x,v 1.16 2012/11/03 22:54:43 tom Exp @ --> <HTML> <HEAD> @@ -62,62 +62,63 @@ <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> + <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. + These functions copy the (null-terminated) <EM>chstr</EM> array in- + to the window image structure starting at the current cur- + sor position. The four functions with <EM>n</EM> as the last argu- + ment 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 functions work + faster than <STRONG>waddnstr</STRONG>. On the other hand: + + <STRONG>o</STRONG> they do not perform checking (such as for the newline, + backspace, or carriage return characters), + + <STRONG>o</STRONG> they do not advance the current cursor position, + + <STRONG>o</STRONG> they do not expand other control characters to ^-es- + capes, and + + <STRONG>o</STRONG> they truncate the string if it crosses the right mar- + gin, rather than wrapping 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. +<H2>RETURN VALUE</H2><PRE> + All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> + on success. - X/Open does not define any error conditions. This imple- + 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 + 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. + All functions except <STRONG>waddchnstr</STRONG> may be macros. </PRE> <H2>PORTABILITY</H2><PRE> - These entry points are described in the XSI Curses stan- + 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>. + <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. - Comparable functions in the wide-character (ncursesw) li- + 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>. @@ -125,9 +126,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index d89503c..ad755d8 100644 --- a/doc/html/man/curs_addstr.3x.html +++ b/doc/html/man/curs_addstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_addstr.3x,v 1.17 2012/11/03 22:57:31 tom Exp @ --> <HTML> <HEAD> @@ -68,26 +68,32 @@ </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. + These functions write the (null-terminated) character + string <EM>str</EM> on the given window. It is similar to calling + <STRONG>waddch</STRONG> once for each character in the string. + + The <EM>mv</EM> functions perform cursor movement once, before + writing any characters. Thereafter, the cursor is ad- + vanced as a side-effect of writing to the window. + + The four functions with <EM>n</EM> as the last argument write at + most <EM>n</EM> characters, or until a terminating null is reached. + If <EM>n</EM> is -1, then the entire string will be added. </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. + All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> + on success. 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. + mentation returns an error + + <STRONG>o</STRONG> if the window pointer is null or + + <STRONG>o</STRONG> if the string pointer is null or + + <STRONG>o</STRONG> 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 @@ -96,16 +102,13 @@ </PRE> <H2>NOTES</H2><PRE> - Note that all of these routines except <STRONG>waddstr</STRONG> and - <STRONG>waddnstr</STRONG> may be macros. + All of these functions except <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. + These functions are described in the XSI Curses standard, + Issue 4. </PRE> @@ -117,9 +120,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_addwstr.3x.html b/doc/html/man/curs_addwstr.3x.html index 99ab802..74a237d 100644 --- a/doc/html/man/curs_addwstr.3x.html +++ b/doc/html/man/curs_addwstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_addwstr.3x,v 1.11 2012/11/03 22:57:31 tom Exp @ --> <HTML> <HEAD> @@ -68,43 +68,51 @@ </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 + These functions write the characters of the (null-termi- + nated) <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 <EM>mv</EM> functions perform cursor movement once, before + writing any characters. Thereafter, the cursor is ad- + vanced 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. + The four functions with <EM>n</EM> as the last argument write at + most <EM>n</EM> <STRONG>wchar_t</STRONG> characters, or until a terminating null is + reached. If <EM>n</EM> is -1, then the entire string will be + added. </PRE> -<H2>RETURN VALUES</H2><PRE> - All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on - success. +<H2>RETURN VALUE</H2><PRE> + All functions 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 + X/Open does not define any error conditions. This imple- + mentation returns an error + + <STRONG>o</STRONG> if the window pointer is null or + + <STRONG>o</STRONG> if the string pointer is null or + + <STRONG>o</STRONG> if the corresponding calls to <STRONG>wadd_wch</STRONG> return an er- + ror. + + 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. + All of these functions 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. + These functions are described in the XSI Curses standard, + Issue 4. </PRE> @@ -116,9 +124,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html index 23a1573..012815d 100644 --- a/doc/html/man/curs_attr.3x.html +++ b/doc/html/man/curs_attr.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2013 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: curs_attr.3x,v 1.39 2013/09/21 20:39:49 Sven.Joachim Exp @ --> <HTML> <HEAD> @@ -148,19 +148,36 @@ 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> + <EM>Name</EM> <EM>Description</EM> + ------------------------------------------------------------ + <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_ITALIC</STRONG> Italics (non-X/Open extension) + <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> + + These video attributes are supported by <STRONG>attr_on</STRONG> and relat- + ed functions (which also support the attributes recognized + by <STRONG>attron</STRONG>, etc.): + + <EM>Name</EM> <EM>Description</EM> + ----------------------------------------- + <STRONG>WA_HORIZONTAL</STRONG> Horizontal highlight + <STRONG>WA_LEFT</STRONG> Left highlight + <STRONG>WA_LOW</STRONG> Low highlight + <STRONG>WA_RIGHT</STRONG> Right highlight + <STRONG>WA_TOP</STRONG> Top highlight + <STRONG>WA_VERTICAL</STRONG> Vertical highlight + + For consistency The following macro is the reverse of <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>: @@ -202,33 +219,44 @@ correctly manipulate all other highlights (specifically, <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>). + This implementation provides the <STRONG>A_ITALIC</STRONG> attribute for + terminals which have the <EM>enter</EM><STRONG>_</STRONG><EM>italics</EM><STRONG>_</STRONG><EM>mode</EM> (sitm) and <EM>ex-</EM> + <EM>it</EM><STRONG>_</STRONG><EM>italics</EM><STRONG>_</STRONG><EM>mode</EM> (ritm) capabilities. Italics are not men- + tioned in X/Open Curses. Unlike the other video at- + tributes, <STRONG>I_ITALIC</STRONG> is unrelated to the <EM>set</EM><STRONG>_</STRONG><EM>attributes</EM> ca- + pabilities. This implementation makes the assumption that + <EM>exit</EM><STRONG>_</STRONG><EM>attribute</EM><STRONG>_</STRONG><EM>mode</EM> may also reset italics. + 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 + highlight macros prefixed with <STRONG>WA_</STRONG>. The older macros have + direct counterparts in the newer set of names: + + <EM>Name</EM> <EM>Description</EM> + ------------------------------------------------------------ + <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 + + 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 + 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. + <STRONG>TICAL</STRONG> (and corresponding <STRONG>WA_</STRONG> macros for each). As of Au- + gust 2013, no known terminal provides these highlights + (i.e., via the <STRONG>sgr1</STRONG> capability). </PRE> @@ -259,9 +287,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_beep.3x.html b/doc/html/man/curs_beep.3x.html index e450ce2..6abcd73 100644 --- a/doc/html/man/curs_beep.3x.html +++ b/doc/html/man/curs_beep.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * @@ -98,9 +98,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html index 56f5cb9..8778b6a 100644 --- a/doc/html/man/curs_bkgd.3x.html +++ b/doc/html/man/curs_bkgd.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2003,2010 Free Software Foundation, Inc. * @@ -123,9 +123,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html index 5dc6fdb..835661a 100644 --- a/doc/html/man/curs_bkgrnd.3x.html +++ b/doc/html/man/curs_bkgrnd.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_bkgrnd.3x,v 1.5 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -102,7 +102,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a value. @@ -120,9 +120,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_border.3x.html b/doc/html/man/curs_border.3x.html index 880d59b..8910aec 100644 --- a/doc/html/man/curs_border.3x.html +++ b/doc/html/man/curs_border.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -154,9 +154,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_border_set.3x.html b/doc/html/man/curs_border_set.3x.html index c64a816..e5f97be 100644 --- a/doc/html/man/curs_border_set.3x.html +++ b/doc/html/man/curs_border_set.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 2002-2011,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_border_set.3x,v 1.11 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -154,7 +154,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> Upon successful completion, these functions return <STRONG>OK</STRONG>. Otherwise, they return <STRONG>ERR</STRONG>. @@ -176,9 +176,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index ca581c2..9391054 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -138,9 +138,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_color.3x.html b/doc/html/man/curs_color.3x.html index 39a7318..b385da4 100644 --- a/doc/html/man/curs_color.3x.html +++ b/doc/html/man/curs_color.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_color.3x,v 1.36 2014/11/16 00:44:29 tom Exp @ --> <HTML> <HEAD> @@ -104,28 +104,54 @@ 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 + These limits apply to color values and color pairs. Val- + ues outside these limits are not legal, and may result in + a runtime error: + + <STRONG>o</STRONG> <STRONG>COLORS</STRONG> corresponds to the terminal database's <STRONG>max_col-</STRONG> + <STRONG>ors</STRONG> capability, which is typically a signed 16-bit in- + teger (see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>). + + <STRONG>o</STRONG> color values are expected to be in the range <STRONG>0</STRONG> to <STRONG>COL-</STRONG> + <STRONG>ORS-1</STRONG>, inclusive (including <STRONG>0</STRONG> and <STRONG>COLORS-1</STRONG>). + + <STRONG>o</STRONG> a special color value <STRONG>-1</STRONG> is used in certain extended + functions to denote the <EM>default</EM> <EM>color</EM> (see <STRONG>use_de-</STRONG> + <STRONG>fault_colors</STRONG>). + + <STRONG>o</STRONG> <STRONG>COLOR_PAIRS</STRONG> corresponds to the terminal database's + <STRONG>max_pairs</STRONG> capability, which is typically a signed + 16-bit integer (see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>). + + <STRONG>o</STRONG> legal color pair values are in the range <STRONG>1</STRONG> to <STRONG>COL-</STRONG> + <STRONG>OR_PAIRS-1</STRONG>, inclusive. + + <STRONG>o</STRONG> color pair <STRONG>0</STRONG> is special; it denotes "no color". + + Color pair <STRONG>0</STRONG> is assumed to be white on black, but is + actually whatever the terminal implements before color + is initialized. It cannot be modified by the applica- + tion. + + 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 first argument must be a legal color pair value. + 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 back- + ground. - <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. + <STRONG>o</STRONG> The second and third arguments must be legal color + values. 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 + As an extension, ncurses allows you to set color pair <STRONG>0</STRONG> 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. @@ -133,44 +159,46 @@ 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 + red, green, and blue components). The first argument must + be a legal color value; default colors are not allowed + here. (See the section <STRONG>Colors</STRONG> for the default color in- + dex.) Each of the last three arguments must be a value in + the range <STRONG>0</STRONG> through <STRONG>1000</STRONG>. 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- + 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 + 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 <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>. + 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 first argument must be a legal color + value, i.e., <STRONG>0</STRONG> through <STRONG>COLORS-1</STRONG>, inclusive. The values + that are stored at the addresses pointed to by the last + three arguments are in the range <STRONG>0</STRONG> (no component) through + <STRONG>1000</STRONG> (maximum amount of component), inclusive. + + 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 first argument must be a legal color + value, i.e., in the range <STRONG>1</STRONG> through <STRONG>COLOR_PAIRS-1</STRONG>, inclu- + sive. The values that are stored at the addresses pointed + to by the second and third arguments are in the range <STRONG>0</STRONG> + through <STRONG>COLORS</STRONG>, inclusive. <STRONG>Colors</STRONG> In <STRONG><curses.h></STRONG> the following macros are defined. These are @@ -198,10 +226,10 @@ 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- + the range <STRONG>0</STRONG> to COLORS-1 (except for the default colors ex- + tension), or use color pairs outside the range <STRONG>0</STRONG> to <STRONG>COL-</STRONG> + <STRONG>OR_PAIRS-1</STRONG>. Color values used in <STRONG>init_color</STRONG> must be in + the range <STRONG>0</STRONG> to <STRONG>1000</STRONG>. 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. @@ -277,9 +305,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_delch.3x.html b/doc/html/man/curs_delch.3x.html index 174b17d..8e70fa3 100644 --- a/doc/html/man/curs_delch.3x.html +++ b/doc/html/man/curs_delch.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_deleteln.3x.html b/doc/html/man/curs_deleteln.3x.html index 5015849..f300930 100644 --- a/doc/html/man/curs_deleteln.3x.html +++ b/doc/html/man/curs_deleteln.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -118,9 +118,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_extend.3x.html b/doc/html/man/curs_extend.3x.html index a90ccd7..c9f3930 100644 --- a/doc/html/man/curs_extend.3x.html +++ b/doc/html/man/curs_extend.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1999-2006,2010 Free Software Foundation, Inc. * @@ -103,9 +103,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_get_wch.3x.html b/doc/html/man/curs_get_wch.3x.html index 0b2373e..ed90a95 100644 --- a/doc/html/man/curs_get_wch.3x.html +++ b/doc/html/man/curs_get_wch.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_get_wch.3x,v 1.8 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -122,7 +122,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</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 @@ -147,9 +147,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 5775678..4ce3cd2 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_get_wstr.3x,v 1.9 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -118,7 +118,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> All of these functions return <STRONG>OK</STRONG> upon successful comple- tion. Otherwise, they return <STRONG>ERR</STRONG>. @@ -158,9 +158,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index 22cb819..170d910 100644 --- a/doc/html/man/curs_getcchar.3x.html +++ b/doc/html/man/curs_getcchar.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2001-2009,2010 Free Software Foundation, Inc. * + * Copyright (c) 2001-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_getcchar.3x,v 1.16 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -128,7 +128,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</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. @@ -143,16 +143,13 @@ </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>wcwidth(3)</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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html index 2bdcdc4..a0c57c3 100644 --- a/doc/html/man/curs_getch.3x.html +++ b/doc/html/man/curs_getch.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: curs_getch.3x,v 1.39 2014/05/24 20:16:31 tom Exp @ --> <HTML> <HEAD> @@ -76,14 +76,24 @@ 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 <STRONG>echo</STRONG> is enabled, and the window is not a pad, then the + character will also be echoed into the designated window + according to the following rules: + + <STRONG>o</STRONG> If the character is the current erase character, 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. + + <STRONG>o</STRONG> If the character value is any other <STRONG>KEY_</STRONG> define, the + user is alerted with a <STRONG>beep</STRONG> call. + + <STRONG>o</STRONG> If the character is a carriage-return, and if <STRONG>nl</STRONG> is + enabled, it is translated to a line-feed after echo- + ing. + + <STRONG>o</STRONG> 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 @@ -93,7 +103,7 @@ 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 + 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. @@ -110,15 +120,14 @@ 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 @@ -169,6 +178,7 @@ 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 @@ -180,7 +190,6 @@ 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 @@ -233,21 +242,18 @@ 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>ungetch</STRONG> + returns ERR 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. + <STRONG>wgetch</STRONG> + returns ERR 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 @@ -321,7 +327,7 @@ 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- + <STRONG>read(2)</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. @@ -351,9 +357,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_getstr.3x.html b/doc/html/man/curs_getstr.3x.html index 222f00b..c6a1947 100644 --- a/doc/html/man/curs_getstr.3x.html +++ b/doc/html/man/curs_getstr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * @@ -147,9 +147,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html index 7a37716..f5b379f 100644 --- a/doc/html/man/curs_getyx.3x.html +++ b/doc/html/man/curs_getyx.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -123,9 +123,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_in_wch.3x.html b/doc/html/man/curs_in_wch.3x.html index 1535e51..55fea90 100644 --- a/doc/html/man/curs_in_wch.3x.html +++ b/doc/html/man/curs_in_wch.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * @@ -101,9 +101,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html index e394e90..6abefa4 100644 --- a/doc/html/man/curs_in_wchstr.3x.html +++ b/doc/html/man/curs_in_wchstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_in_wchstr.3x,v 1.9 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -90,7 +90,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> Upon successful completion, these functions return <STRONG>OK</STRONG>. Otherwise, they return <STRONG>ERR</STRONG>. @@ -116,9 +116,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_inch.3x.html b/doc/html/man/curs_inch.3x.html index 43c6159..6157c4a 100644 --- a/doc/html/man/curs_inch.3x.html +++ b/doc/html/man/curs_inch.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -110,9 +110,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index 73a78fc..bff908d 100644 --- a/doc/html/man/curs_inchstr.3x.html +++ b/doc/html/man/curs_inchstr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -125,9 +125,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_initscr.3x.html b/doc/html/man/curs_initscr.3x.html index 5c4364d..ddbd933 100644 --- a/doc/html/man/curs_initscr.3x.html +++ b/doc/html/man/curs_initscr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2013,2014 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_initscr.3x,v 1.20 2014/03/01 22:31:22 tom Exp @ --> <HTML> <HEAD> @@ -86,22 +86,34 @@ 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. + <STRONG>newterm</STRONG>'s arguments are + + <STRONG>o</STRONG> the <EM>type</EM> of the terminal to be used in place of <STRONG>$TERM</STRONG>, + + <STRONG>o</STRONG> a file pointer for output to the terminal, and + + <STRONG>o</STRONG> another file pointer for input from the terminal + + If the <EM>type</EM> parameter 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 + + <STRONG>o</STRONG> restores tty modes, + + <STRONG>o</STRONG> moves the cursor to the lower left-hand corner of the + screen and + + <STRONG>o</STRONG> resets the terminal into the proper non-visual mode. + + Calling <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> after a temporary escape caus- + es 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> @@ -128,8 +140,17 @@ 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. + tion + + <STRONG>o</STRONG> <STRONG>endwin</STRONG> returns an error if the terminal was not ini- + tialized. + + <STRONG>o</STRONG> <STRONG>newterm</STRONG> returns an error if it cannot allocate the da- + ta structures for the screen, or for the top-level + windows within the screen, i.e., <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, or + <STRONG>stdscr</STRONG>. + + <STRONG>o</STRONG> <STRONG>set_term</STRONG> returns no error. </PRE> @@ -139,29 +160,34 @@ </PRE> <H2>PORTABILITY</H2><PRE> - These functions are described in the XSI Curses standard, + 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 + 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. + If the TERM variable is missing or empty, <STRONG>initscr</STRONG> uses the + value "unknown", which normally corresponds to a terminal + entry with the <EM>generic</EM> (<EM>gn</EM>) capability. Generic entries + are detected by <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> and cannot be used for full- + screen operation. Other implementations may handle a + missing/empty TERM variable differently. + </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_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> + <STRONG><A HREF="curs_variables.3x.html">ables(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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_inopts.3x.html b/doc/html/man/curs_inopts.3x.html index d851642..f5112af 100644 --- a/doc/html/man/curs_inopts.3x.html +++ b/doc/html/man/curs_inopts.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_inopts.3x,v 1.18 2013/07/20 19:42:02 tom Exp @ --> <HTML> <HEAD> @@ -135,7 +135,7 @@ 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- + er [see <STRONG>termio(7)</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, @@ -168,7 +168,7 @@ 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> + characters will not be done [see <STRONG>termio(7)</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 @@ -185,7 +185,7 @@ 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 + 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> @@ -229,33 +229,64 @@ ty, set echo or noecho explicitly just after initializa- tion, even if your program remains in cooked mode. + When <STRONG>keypad</STRONG> is first enabled, ncurses loads the key-defi- + nitions for the current terminal description. If the ter- + minal description includes extended string capabilities, + e.g., from using the <STRONG>-x</STRONG> option of tic, then ncurses also + defines keys for the capabilities whose names begin with + "k". The corresponding keycodes are generated and (de- + pending on previous loads of terminal descriptions) may + differ from one execution of a program to the next. The + generated keycodes are recognized by the <STRONG>keyname</STRONG> function + (which will then return a name beginning with "k" denoting + the terminfo capability name rather than "K", used for + curses key-names). On the other hand, an application can + use <STRONG>define_key</STRONG> to establish a specific keycode for a given + string. This makes it possible for an application to + check for an extended capability's presence with <EM>tigetstr</EM>, + and reassign the keycode to match its own needs. + + Low-level applications can use <STRONG>tigetstr</STRONG> to obtain the def- + inition of any particular string capability. Higher-level + applications which use the curses <STRONG>wgetch</STRONG> and similar func- + tions to return keycodes rely upon the order in which the + strings are loaded. If more than one key definition has + the same string value, then <STRONG>wgetch</STRONG> can return only one + keycode. Most curses implementations (including ncurses) + load key definitions in the order defined by the array of + string capability names. The last key to be loaded deter- + mines the keycode which will be returned. In ncurses, you + may also have extended capabilities interpreted as key + definitions. These are loaded after the predefined keys, + and if a capability's value is the same as a previously- + loaded key definition, the later definition is the one + used. + </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> + 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 + 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="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="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG>termio(7)</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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_ins_wch.3x.html b/doc/html/man/curs_ins_wch.3x.html index 2b3714c..5298a87 100644 --- a/doc/html/man/curs_ins_wch.3x.html +++ b/doc/html/man/curs_ins_wch.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * @@ -96,9 +96,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_ins_wstr.3x.html b/doc/html/man/curs_ins_wstr.3x.html index 5f7cee6..4383e55 100644 --- a/doc/html/man/curs_ins_wstr.3x.html +++ b/doc/html/man/curs_ins_wstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2005,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_ins_wstr.3x,v 1.7 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -102,7 +102,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> Upon successful completion, these functions return OK. Otherwise, they return ERR. @@ -121,9 +121,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_insch.3x.html b/doc/html/man/curs_insch.3x.html index f8c833e..2c3d2c2 100644 --- a/doc/html/man/curs_insch.3x.html +++ b/doc/html/man/curs_insch.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -109,9 +109,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index 7a61648..1627840 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -123,9 +123,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 0f32d58..8ba394a 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -115,9 +115,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index 223c398..1336672 100644 --- a/doc/html/man/curs_inwstr.3x.html +++ b/doc/html/man/curs_inwstr.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 2002-2010,2012 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_inwstr.3x,v 1.8 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -87,7 +87,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</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 @@ -107,9 +107,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_kernel.3x.html b/doc/html/man/curs_kernel.3x.html index a2e247c..6a229bc 100644 --- a/doc/html/man/curs_kernel.3x.html +++ b/doc/html/man/curs_kernel.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * @@ -198,9 +198,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 5a86252..5451ff7 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2007,2010 Free Software Foundation, Inc. * @@ -113,9 +113,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_memleaks.3x.html b/doc/html/man/curs_memleaks.3x.html index 540ea93..ecac055 100644 --- a/doc/html/man/curs_memleaks.3x.html +++ b/doc/html/man/curs_memleaks.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2008,2010 Free Software Foundation, Inc. * @@ -103,9 +103,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html index d640680..355acea 100644 --- a/doc/html/man/curs_mouse.3x.html +++ b/doc/html/man/curs_mouse.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2013,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: curs_mouse.3x,v 1.40 2014/10/10 09:31:18 tom Exp @ --> <HTML> <HEAD> @@ -59,13 +59,12 @@ <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>typedef</STRONG> <STRONG>struct</STRONG> <STRONG>{</STRONG> + <STRONG>short</STRONG> <STRONG>id;</STRONG> <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>}</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> @@ -98,7 +97,6 @@ Here are the mouse event type masks which may be defined: - <EM>Name</EM> <EM>Description</EM> --------------------------------------------------------------------- BUTTON1_PRESSED mouse button 1 down @@ -111,11 +109,10 @@ 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 @@ -140,7 +137,7 @@ REPORT_MOUSE_POSITION report mouse movement --------------------------------------------------------------------- - Once a class of mouse events have been made visible in a + Once a class of mouse events has 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 @@ -271,11 +268,18 @@ 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. + The <STRONG>ALL_MOUSE_EVENTS</STRONG> class does not include <STRONG>RE-</STRONG> + <STRONG>PORT_MOUSE_POSITION</STRONG>. They are distinct. For example, in + xterm, wheel/scrolling mice send position reports as a se- + quence of presses of buttons 4 or 5 without matching but- + ton-releases. + </PRE> <H2>BUGS</H2><PRE> @@ -310,9 +314,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_move.3x.html b/doc/html/man/curs_move.3x.html index d78178d..93f4251 100644 --- a/doc/html/man/curs_move.3x.html +++ b/doc/html/man/curs_move.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -97,9 +97,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_opaque.3x.html b/doc/html/man/curs_opaque.3x.html index 6d01f2e..979d3e1 100644 --- a/doc/html/man/curs_opaque.3x.html +++ b/doc/html/man/curs_opaque.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2007-2009,2010 Free Software Foundation, Inc. * + * Copyright (c) 2007-2013,2014 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_opaque.3x,v 1.11 2014/03/15 19:24:23 tom Exp @ --> <HTML> <HEAD> @@ -69,6 +69,7 @@ <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>wgetdelay(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> @@ -76,7 +77,7 @@ <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: + "opaque" if the symbol <STRONG>NCURSES_OPAQUE</STRONG> is defined: <STRONG>is_cleared</STRONG> returns the value set in <STRONG>clearok</STRONG> @@ -116,6 +117,9 @@ <STRONG>is_syncok</STRONG> returns the value set in <STRONG>syncok</STRONG> + <STRONG>wgetdelay</STRONG> + returns the delay timeout as set in <STRONG>wtimeout</STRONG>. + <STRONG>wgetparent</STRONG> returns the parent WINDOW pointer for subwindows, or NULL for windows having no parent. @@ -153,9 +157,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html index 9be94d9..815036b 100644 --- a/doc/html/man/curs_outopts.3x.html +++ b/doc/html/man/curs_outopts.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -226,9 +226,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index 69ed0fc..68ed40b 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_overlay.3x,v 1.17 2013/04/06 23:48:51 tom Exp @ --> <HTML> <HEAD> @@ -72,7 +72,7 @@ (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 + trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. As 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- @@ -114,9 +114,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_pad.3x.html b/doc/html/man/curs_pad.3x.html index ca16cf4..dab1515 100644 --- a/doc/html/man/curs_pad.3x.html +++ b/doc/html/man/curs_pad.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * @@ -176,9 +176,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_print.3x.html b/doc/html/man/curs_print.3x.html index 11b64a7..8001a62 100644 --- a/doc/html/man/curs_print.3x.html +++ b/doc/html/man/curs_print.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -113,9 +113,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_printw.3x.html b/doc/html/man/curs_printw.3x.html index f845852..feb45a5 100644 --- a/doc/html/man/curs_printw.3x.html +++ b/doc/html/man/curs_printw.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -69,12 +69,12 @@ </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 + analogous to <STRONG>printf</STRONG> [see <STRONG>printf(3)</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 + <STRONG>vprintf</STRONG> [see <STRONG>printf(3)</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>. @@ -111,16 +111,13 @@ </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="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG>printf(3)</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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_refresh.3x.html b/doc/html/man/curs_refresh.3x.html index 78988f5..3610c5e 100644 --- a/doc/html/man/curs_refresh.3x.html +++ b/doc/html/man/curs_refresh.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * @@ -162,9 +162,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index 40cb952..9c072a3 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -66,9 +66,9 @@ </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 + <STRONG>scanf</STRONG> [see <STRONG>scanf(3)</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 + ing line used as input for <STRONG>sscanf(3)</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>. @@ -118,16 +118,13 @@ </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="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>scanf(3)</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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index d2931e1..9e696c1 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -122,16 +122,13 @@ </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_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>system(3)</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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_scroll.3x.html b/doc/html/man/curs_scroll.3x.html index 856b9f5..9b44335 100644 --- a/doc/html/man/curs_scroll.3x.html +++ b/doc/html/man/curs_scroll.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -123,9 +123,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html index 54e4f7a..b8c42f7 100644 --- a/doc/html/man/curs_slk.3x.html +++ b/doc/html/man/curs_slk.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -227,9 +227,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_sp_funcs.3x.html b/doc/html/man/curs_sp_funcs.3x.html index a11947a..7c84eb7 100644 --- a/doc/html/man/curs_sp_funcs.3x.html +++ b/doc/html/man/curs_sp_funcs.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2010 Free Software Foundation, Inc. * + * Copyright (c) 2010,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_sp_funcs.3x,v 1.6 2013/06/22 17:53:59 tom Exp @ * *************************************************************************** * *************************************************************************** * *************************************************************************** @@ -131,7 +131,7 @@ <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_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> @@ -193,16 +193,15 @@ 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. - + 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- + 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 + 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. @@ -210,22 +209,22 @@ Here are the new functions: ceiling_panel - this returns a pointer to the topmost panel in the + this returns a pointer to the topmost panel in the given screen. ground_panel - this returns a pointer to the lowest panel in the + 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- + when creating a new screen, the library uses static + variables which have been preset, e.g., by + <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(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 + 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 + point to allow applications to customize the library initialization. @@ -234,37 +233,36 @@ 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 + 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. + 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 + unextended function. This manual page indexes the extensions showing the full name. However the proper - usage of these functions uses the macro, to provide + 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 + 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>. - + This is a function-pointer type used for the cases + where a function passes characters to the output + stream, e.g., <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(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- + 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>. @@ -277,9 +275,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html index 960cc2a..db264b3 100644 --- a/doc/html/man/curs_termattrs.3x.html +++ b/doc/html/man/curs_termattrs.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -111,11 +111,11 @@ 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 + substitute a different video attribute for it. The <STRONG>ter-</STRONG> + <STRONG>mattrs</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 useful + 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 @@ -153,9 +153,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html index f62fc0c..7960750 100644 --- a/doc/html/man/curs_termcap.3x.html +++ b/doc/html/man/curs_termcap.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_termcap.3x,v 1.30 2013/01/19 15:58:48 tom Exp @ --> <HTML> <HEAD> @@ -79,39 +79,62 @@ 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>. + <STRONG>INITIALIZATION</STRONG> + The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns: + 1 on success, + + 0 if there is no such entry (or that it is a generic + type, having too little information for curses ap- + plications to run), and + + -1 if the terminfo database could not be found. + + This differs from the <EM>termcap</EM> library in two ways: + + <STRONG>o</STRONG> The emulation ignores the buffer pointer <EM>bp</EM>. The + <EM>termcap</EM> library would store a copy of the terminal + description in the area referenced by this pointer. + However, ncurses stores its terminal descriptions + in compiled binary form, which is not the same + thing. + + <STRONG>o</STRONG> There is a difference in return codes. The <EM>termcap</EM> + library does not check if the terminal description + is marked with the <EM>generic</EM> capability, or if the + terminal description has cursor-addressing. + + <STRONG>CAPABILITY</STRONG> <STRONG>VALUES</STRONG> 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 + 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 + 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 + <STRONG>FORMATTING</STRONG> <STRONG>CAPABILITIES</STRONG> + 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> + 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. + <STRONG>GLOBAL</STRONG> <STRONG>VARIABLES</STRONG> 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 + <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 + 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. @@ -119,7 +142,7 @@ </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 + 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. @@ -129,63 +152,82 @@ </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- + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + guishing between input and output. In particular, some applications are reported to declare and/or modify <STRONG>ospeed</STRONG>. + The comment that only the first two characters of the <STRONG>id</STRONG> + parameter are used escapes many application developers. + The original BSD 4.2 termcap library (and historical + relics thereof) did not require a trailing null NUL on the + parameter name passed to <STRONG>tgetstr</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetflag</STRONG>. + Some applications assume that the termcap interface does + not require the trailing NUL for the parameter name. Tak- + ing into account these issues: + + <STRONG>o</STRONG> As a special case, <STRONG>tgetflag</STRONG> matched against a single- + character identifier provided that was at the end of + the terminal description. You should not rely upon + this behavior in portable programs. This implementa- + tion disallows matches against single-character capa- + bility names. + + <STRONG>o</STRONG> This implementation disallows matches by the termcap + interface against extended capability names which are + longer than two characters. + </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="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>putc(3)</STRONG>. + + http://invisible-island.net/ncurses/tctest.html <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html index 9a640e9..dd85e35 100644 --- a/doc/html/man/curs_terminfo.3x.html +++ b/doc/html/man/curs_terminfo.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1999-2008,2010 Free Software Foundation, Inc. * + * Copyright (c) 1999-2011,2013 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 * @@ -27,7 +27,12 @@ * 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 @ + * @Id: curs_terminfo.3x,v 1.43 2013/07/20 19:29:59 tom Exp @ + * *************************************************************************** + * *************************************************************************** + * *************************************************************************** + * *************************************************************************** + * *************************************************************************** --> <HTML> <HEAD> @@ -68,7 +73,7 @@ <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_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>)(int));</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> @@ -85,38 +90,51 @@ tion keys. For all other functionality, <STRONG>curses</STRONG> routines are more suitable and their use is recommended. + <STRONG>Initialization</STRONG> 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. + [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. + + Each initialization routine provides applications with the + terminal capabilities either directly (via header defini- + tions), or by special functions. The header files <STRONG>curs-</STRONG> + <STRONG>es.h</STRONG> and <STRONG>term.h</STRONG> should be included (in this order) to get + the definitions for these strings, numbers, and flags. + + The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and <STRONG>columns</STRONG> are initialized + by <STRONG>setupterm</STRONG> as follows: + + <STRONG>o</STRONG> 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. + + <STRONG>o</STRONG> Otherwise, if the environment variables <STRONG>LINES</STRONG> and <STRONG>COL-</STRONG> + <STRONG>UMNS</STRONG> exist, their values are used. If these environ- + ment variables do not exist and the program is running + in a window, the current window size is used. Other- + wise, if the environment variables do not exist, the + values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the <STRONG>terminfo</STRONG> + database are used. + + 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 <STRONG>reset_shell_mode</STRONG> to restore the tty modes before ex- + iting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>]. + + Programs which use cursor addressing should + + <STRONG>o</STRONG> output <STRONG>enter_ca_mode</STRONG> upon startup and + + <STRONG>o</STRONG> output <STRONG>exit_ca_mode</STRONG> before exiting. + + Programs which execute shell subprocesses should + + <STRONG>o</STRONG> call <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before + the shell is called and + + <STRONG>o</STRONG> output <STRONG>enter_ca_mode</STRONG> and call <STRONG>reset_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 @@ -129,54 +147,74 @@ <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>1</STRONG> means that the terminal is hardcopy, cannot be used + for curses applications. + + <STRONG>setupterm</STRONG> determines if the entry is a hardcopy type + by checking the <EM>hc</EM> (<EM>hardcopy</EM>) capability. - <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>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. + <STRONG>setupterm</STRONG> determines if the entry is a generic type + by checking the <EM>gn</EM> (<EM>generic</EM>) capability. - If <EM>errret</EM> is null, <STRONG>setupterm</STRONG> prints an error message upon + <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> + 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: + The <STRONG>setterm</STRONG> routine was 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 + <STRONG>setterm</STRONG> routine is provided for BSD compatibility, and is + not recommended for new programs. + + <STRONG>The</STRONG> <STRONG>Terminal</STRONG> <STRONG>State</STRONG> + The <STRONG>setupterm</STRONG> routine stores its information about the + terminal in a <STRONG>TERMINAL</STRONG> structure pointed to by the global + variable <STRONG>cur_term</STRONG>. If it detects an error, or decides + that the terminal is unsuitable (hardcopy or generic), it + discards this information, making it not available to ap- + plications. + + If <STRONG>setupterm</STRONG> is called repeatedly for the same terminal + type, it will reuse the information. It maintains only + one copy of a given terminal's capabilities in memory. If + it is called for different terminal types, <STRONG>setupterm</STRONG> allo- + cates new storage for each set of terminal capabilities. + + The <STRONG>set_curterm</STRONG> routine sets <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> + 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. - + <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). <STRONG>restartterm</STRONG> assumes that the + windows and the input and output options are the same as + when memory was saved, but the terminal type and baud rate + may be different. Accordingly, <STRONG>restartterm</STRONG> saves various + tty state bits, calls <STRONG>setupterm</STRONG>, and then restores the + bits. + + <STRONG>Formatting</STRONG> <STRONG>Output</STRONG> 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. @@ -185,6 +223,7 @@ rather than a fixed-parameter list. Its numeric parame- ters are integers (int) rather than longs. + <STRONG>Output</STRONG> <STRONG>Functions</STRONG> 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>, @@ -218,36 +257,48 @@ takes effect immediately (rather than at the next re- fresh). + <STRONG>Terminal</STRONG> <STRONG>Capability</STRONG> <STRONG>Functions</STRONG> 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>. + <EM>name</EM> passed to them, such as <STRONG>xenl</STRONG>. The <EM>capname</EM> for each + capability is given in the table column entitled <EM>capname</EM> + code in the capabilities section of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + These routines return special values to denote errors. + + The <STRONG>tigetflag</STRONG> routine returns + + <STRONG>-1</STRONG> if <EM>capname</EM> is not a boolean capability, or - 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. + <STRONG>0</STRONG> if it is canceled or absent from the terminal de- + scription. - 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>tigetnum</STRONG> routine returns - 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. + <STRONG>-2</STRONG> if <EM>capname</EM> is not a numeric capability, or - 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>-1</STRONG> if it is canceled or absent from the terminal de- + scription. + The <STRONG>tigetstr</STRONG> routine returns + + <STRONG>(char</STRONG> <STRONG>*)-1</STRONG> + if <EM>capname</EM> is not a string capability, or + + <STRONG>0</STRONG> if it is canceled or absent from the terminal de- + scription. + + <STRONG>Terminal</STRONG> <STRONG>Capability</STRONG> <STRONG>Names</STRONG> + These null-terminated arrays contain the short terminfo + names ("codes"), the <STRONG>termcap</STRONG> names, and the long terminfo + names ("fnames") for each of the predefined <STRONG>terminfo</STRONG> vari- + ables: <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> @@ -261,49 +312,64 @@ X/Open defines no error conditions. In this implementa- tion - <STRONG>del_curterm</STRONG> - returns an error if its terminal parameter is - null. + <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>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>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>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. + <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>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 + X/Open notes that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros. + + 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 + <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. + If configured to use the terminal-driver, e.g., for the + MinGW port, + + <STRONG>o</STRONG> <STRONG>setupterm</STRONG> interprets a missing/empty TERM variable as + the special value "unknown". + + <STRONG>o</STRONG> <STRONG>setupterm</STRONG> allows explicit use of the the windows con- + sole driver by checking if $TERM is set to "#win32con" + or an abbreviation of that string. + + Older versions of <STRONG>ncurses</STRONG> assumed that the file descriptor + passed to <STRONG>setupterm</STRONG> from <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> uses buffered + I/O, and would write to the corresponding stream. In ad- + dition to the limitation that the terminal was left in + block-buffered mode on exit (like SystemV curses), it was + problematic because <STRONG>ncurses</STRONG> did not allow a reliable way + to cleanup on receiving SIGTSTP. The current version uses + output buffers managed directly by <STRONG>ncurses</STRONG>. Some of the + low-level functions described in this manual page write to + the standard output. They are not signal-safe. The high- + level functions in <STRONG>ncurses</STRONG> use alternate versions of these + functions using the more reliable buffering scheme. + 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. @@ -323,12 +389,12 @@ 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. + Issue 7 proposed the <STRONG>tiparm</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- + suming normal curses calls. Both <STRONG>ncurses</STRONG> 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 @@ -339,15 +405,18 @@ for the old ordinates. In that case, the old location is unknown. + Other implementions may not declare the capability name + arrays. Some provide them without declaring them. X/Open + does not specify them. + 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. + <STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not stored in the arrays described here. </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="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>putc(3)</STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> @@ -355,9 +424,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_threads.3x.html b/doc/html/man/curs_threads.3x.html index 394544a..3879982 100644 --- a/doc/html/man/curs_threads.3x.html +++ b/doc/html/man/curs_threads.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2008,2010 Free Software Foundation, Inc. * + * Copyright (c) 2008-2012,2014 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_threads.3x,v 1.20 2014/03/15 19:25:28 tom Exp @ * *************************************************************************** * *************************************************************************** --> @@ -61,9 +61,9 @@ <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>int</STRONG> <STRONG>use_screen(SCREEN</STRONG> <STRONG>*scr,</STRONG> <STRONG>NCURSES_SCREEN_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>int</STRONG> <STRONG>use_window(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>NCURSES_WINDOW_CB</STRONG> <STRONG>func,</STRONG> <STRONG>void</STRONG> <STRONG>*data);</STRONG> @@ -552,6 +552,7 @@ wget_wstr screen (input-operation) wgetbkgrnd window wgetch screen (input-operation) + wgetdelay window wgetn_wstr screen (input-operation) wgetnstr screen (input-operation) wgetparent window @@ -582,8 +583,8 @@ wnoutrefresh screen wprintw window wredrawln window - wrefresh screen + wrefresh screen wresize window locks(windowlist) wscanw screen wscrl window @@ -626,9 +627,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index 9ba1bc6..e3d7cd5 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -136,9 +136,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html index 3705fda..55890d2 100644 --- a/doc/html/man/curs_trace.3x.html +++ b/doc/html/man/curs_trace.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2000-2009,2010 Free Software Foundation, Inc. * @@ -178,9 +178,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index 8181efa..5499bd4 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -1,7 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- + * t **************************************************************************** - * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2013 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 * @@ -27,7 +28,7 @@ * 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 @ + * @Id: curs_util.3x,v 1.37 2013/07/20 19:43:45 tom Exp @ --> <HTML> <HEAD> @@ -48,8 +49,8 @@ </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 + <STRONG>nofilter</STRONG>, <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>use_tioctl</STRONG>, <STRONG>wunctrl</STRONG> - + miscellaneous <STRONG>curses</STRONG> utility routines </PRE> @@ -63,6 +64,7 @@ <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>void</STRONG> <STRONG>use_tioctl(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> @@ -122,16 +124,66 @@ <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>use_env</STRONG> routine, if used, should be called before + <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called (because those compute the + screen size). It modifies the way <STRONG>ncurses</STRONG> treats environ- + ment variables when determining the screen size. + + <STRONG>o</STRONG> Normally ncurses looks first at the terminal database + for the screen size. + + If <STRONG>use_env</STRONG> was called with <STRONG>FALSE</STRONG> for parameter, it + stops here unless If <STRONG>use_tioctl</STRONG> was also called with + <STRONG>TRUE</STRONG> for parameter. + + <STRONG>o</STRONG> Then it asks for the screen size via operating system + calls. If successful, it overrides the values from + the terminal database. + + <STRONG>o</STRONG> Finally (unless <STRONG>use_env</STRONG> was called with <STRONG>FALSE</STRONG> parame- + ter), ncurses examines the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> environ- + ment variables, using a value in those to override the + results from the operating system or terminal data- + base. + + Ncurses also updates the screen size in response to + SIGWINCH, unless overridden by the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> + environment variables, + + The <STRONG>use_tioctl</STRONG> routine, if used, should be called before + <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called (because those compute the + screen size). After <STRONG>use_tioctl</STRONG> is called with <STRONG>TRUE</STRONG> as an + argument, ncurses modifies the last step in its computa- + tion of screen size as follows: + + <STRONG>o</STRONG> checks if the <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> environment variables + are set to a number greater than zero. + + <STRONG>o</STRONG> for each, ncurses updates the corresponding environ- + ment variable with the value that it has obtained via + operating system call or from the terminal database. + + <STRONG>o</STRONG> ncurses re-fetches the value of the environment vari- + ables so that it is still the environment variables + which set the screen size. + + The <STRONG>use_env</STRONG> and <STRONG>use_tioctl</STRONG> routines combine as summarized + here: + + <EM>use</EM><STRONG>_</STRONG><EM>env</EM> <EM>use</EM><STRONG>_</STRONG><EM>tioctl</EM> <EM>Summary</EM> + ---------------------------------------------------------------- + TRUE FALSE This is the default behavior. ncurses + uses operating system calls unless over- + ridden by $LINES or $COLUMNS environment + variables. + TRUE TRUE ncurses updates $LINES and $COLUMNS + based on operating system calls. + + FALSE TRUE ncurses ignores $LINES and $COLUMNS, us- + es operating system calls to obtain + size. + FALSE FALSE ncurses relies on the terminal database + to determine size. 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 @@ -191,60 +243,60 @@ 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. + the first character. Otherwise, it returns "~@", + "~A", etc., analogous to "^@", "^A", C0 controls. - 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. + 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>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 + 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- + 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- + 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 after + curses is initialized. X/Open Curses does not document + the treatment of codes 128 to 159. When treating them as + "meta" keys (or if <STRONG>keyname</STRONG> is called before initializing + 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. + The <STRONG>nofilter</STRONG> and <STRONG>use_tioctl</STRONG> 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 extensions be conditioned using + NCURSES_VERSION. </PRE> @@ -258,9 +310,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_variables.3x.html b/doc/html/man/curs_variables.3x.html index 3cca3fe..49151a0 100644 --- a/doc/html/man/curs_variables.3x.html +++ b/doc/html/man/curs_variables.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2010 Free Software Foundation, Inc. * + * Copyright (c) 2010,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_variables.3x,v 1.6 2013/12/21 18:41:32 tom Exp @ --> <HTML> <HEAD> @@ -73,10 +73,10 @@ <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. + ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> and + <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>) which provide read-only access to <EM>curs-</EM> + <EM>es</EM>'s state. In either case, applications should treat + them as read-only to avoid confusing the library. <STRONG>COLOR_PAIRS</STRONG> After initializing curses, this variable contains the num- @@ -133,7 +133,7 @@ </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>. + <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, or <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>. If <STRONG>curses</STRONG> is configured to use separate curses/terminfo libraries, most of these variables reside in the curses @@ -148,17 +148,14 @@ </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="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(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><A HREF="term_variables.3x.html">term_variables(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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/curs_window.3x.html b/doc/html/man/curs_window.3x.html index d3d4ef4..a28edd6 100644 --- a/doc/html/man/curs_window.3x.html +++ b/doc/html/man/curs_window.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2014 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: curs_window.3x,v 1.18 2014/03/01 23:36:38 tom Exp @ --> <HTML> <HEAD> @@ -56,13 +56,16 @@ <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>WINDOW</STRONG> <STRONG>*newwin(</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>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>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>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> @@ -76,10 +79,16 @@ <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>. + 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- @@ -95,13 +104,11 @@ 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. + the screen. The subwindow shares memory with the window + <EM>orig</EM>, so that changes made to one window will affect both + windows. When using this routine, it is necessary to call + <STRONG>touchwin</STRONG> or <STRONG>touchline</STRONG> on <EM>orig</EM> before calling <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- @@ -143,30 +150,50 @@ 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. + <STRONG>delwin</STRONG> + returns an error if the window pointer is null, or if + the window is the parent of another window. + + <STRONG>derwin</STRONG> + returns an error if the parent window pointer is + null, or if any of its ordinates or dimensions is + negative, or if the resulting window does not fit in- + side the parent window. + + <STRONG>dupwin</STRONG> + returns an error if the window pointer is null. + + 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. - 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>newwin</STRONG> + will fail if either of its beginning ordinates is + negative, or if either the number of lines or columns + is negative. - <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>syncok</STRONG> + returns an error if the window pointer is null. - <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>subwin</STRONG> + returns an error if the parent window pointer is + null, or if any of its ordinates or dimensions is + negative, or if the resulting window does not fit in- + side the parent window. - <STRONG>syncok</STRONG> - returns an error if the window pointer is - null. + The functions which return a window pointer may also fail + if there is insufficient memory for its data structures. + Any of these functions will fail if the screen has not + been initialized, i.e., with <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>. </PRE> @@ -208,9 +235,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/default_colors.3x.html b/doc/html/man/default_colors.3x.html index f0e44e2..bbf894d 100644 --- a/doc/html/man/default_colors.3x.html +++ b/doc/html/man/default_colors.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * @@ -159,7 +159,7 @@ </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>. + <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG>ded(1)</STRONG>. </PRE> @@ -172,9 +172,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index 8556833..350b0b9 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * @@ -103,9 +103,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form.3x.html b/doc/html/man/form.3x.html index 86e3317..e93461e 100644 --- a/doc/html/man/form.3x.html +++ b/doc/html/man/form.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: form.3x,v 1.25 2014/08/16 20:31:45 tom Exp @ --> <HTML> <HEAD> @@ -213,46 +213,40 @@ </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- + 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 + 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 + 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 + 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.9 (patch 20110404). + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for + detailed descriptions of the entry points. + + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_cursor.3x.html b/doc/html/man/form_cursor.3x.html index 04de65a..d253da3 100644 --- a/doc/html/man/form_cursor.3x.html +++ b/doc/html/man/form_cursor.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -110,9 +110,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_data.3x.html b/doc/html/man/form_data.3x.html index f181a9a..d4bb796 100644 --- a/doc/html/man/form_data.3x.html +++ b/doc/html/man/form_data.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -96,9 +96,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html index ab9a263..b2359d6 100644 --- a/doc/html/man/form_driver.3x.html +++ b/doc/html/man/form_driver.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * @@ -342,7 +342,7 @@ </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>. + <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="curs_getch.3x.html">curs_getch(3x)</A></STRONG>. </PRE> @@ -367,9 +367,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field.3x.html b/doc/html/man/form_field.3x.html index 0e7f821..71a0122 100644 --- a/doc/html/man/form_field.3x.html +++ b/doc/html/man/form_field.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2012 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: form_field.3x,v 1.11 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -78,7 +78,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> The function <STRONG>form_fields</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does not set errno. @@ -134,9 +134,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_attributes.3x.html b/doc/html/man/form_field_attributes.3x.html index 36b93e5..d31e03b 100644 --- a/doc/html/man/form_field_attributes.3x.html +++ b/doc/html/man/form_field_attributes.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -122,9 +122,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_buffer.3x.html b/doc/html/man/form_field_buffer.3x.html index fe6b531..d87bd34 100644 --- a/doc/html/man/form_field_buffer.3x.html +++ b/doc/html/man/form_field_buffer.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -151,8 +151,8 @@ 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>. + the data. It will be freed on the next call to <STRONG>field_buf-</STRONG> + <STRONG>fer</STRONG> to return the same buffer. <STRONG><curses.h></STRONG>. </PRE> @@ -171,9 +171,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_info.3x.html b/doc/html/man/form_field_info.3x.html index eec5556..6a3c259 100644 --- a/doc/html/man/form_field_info.3x.html +++ b/doc/html/man/form_field_info.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -121,9 +121,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_just.3x.html b/doc/html/man/form_field_just.3x.html index 62dab75..99da169 100644 --- a/doc/html/man/form_field_just.3x.html +++ b/doc/html/man/form_field_just.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -111,9 +111,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_new.3x.html b/doc/html/man/form_field_new.3x.html index 66b8d80..5081eaa 100644 --- a/doc/html/man/form_field_new.3x.html +++ b/doc/html/man/form_field_new.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -142,9 +142,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html index 5463815..b515c46 100644 --- a/doc/html/man/form_field_opts.3x.html +++ b/doc/html/man/form_field_opts.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: form_field_opts.3x,v 1.17 2014/07/26 21:21:57 tom Exp @ --> <HTML> <HEAD> @@ -75,11 +75,8 @@ 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. + The following standard options are defined (all are on by + default): O_ACTIVE The field is visited during processing. If this @@ -87,43 +84,54 @@ 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_AUTOSKIP + Skip to the next field when this one fills. O_BLANK - The field is cleared whenever a character is entered + 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_EDIT + The field can be edited. O_NULLOK Allow a blank field. + O_PASSOK + Validate field only if modified by user. + + O_PUBLIC + The field contents are displayed as data is entered. + O_STATIC - Field buffers are fixed to field's original size. + 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. + O_VISIBLE + The field is displayed. If this option is off, dis- + play of the field is suppressed. + + O_WRAP + Words that do not fit on a line are wrapped to the + next line. Words are blank-separated. + + One extension option is defined (extensions are off by + default): + + O_DYNAMIC_JUSTIFY + Permit dynamic fields to be justified, like static + fields. </PRE> <H2>RETURN VALUE</H2><PRE> - Except for <STRONG>field_opts</STRONG>, each routine returns one of the + 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- + Routine detected an incorrect or out-of-range argu- ment. <STRONG>E_CURRENT</STRONG> @@ -135,7 +143,7 @@ </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="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>. <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>. </PRE> @@ -146,13 +154,13 @@ </PRE> <H2>PORTABILITY</H2><PRE> - These routines emulate the System V forms library. They + 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 + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. @@ -160,9 +168,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_userptr.3x.html b/doc/html/man/form_field_userptr.3x.html index 787e672..04701ad 100644 --- a/doc/html/man/form_field_userptr.3x.html +++ b/doc/html/man/form_field_userptr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_field_validation.3x.html b/doc/html/man/form_field_validation.3x.html index e810402..51a6d55 100644 --- a/doc/html/man/form_field_validation.3x.html +++ b/doc/html/man/form_field_validation.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -187,9 +187,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_fieldtype.3x.html b/doc/html/man/form_fieldtype.3x.html index 7f195ee..e5d76b2 100644 --- a/doc/html/man/form_fieldtype.3x.html +++ b/doc/html/man/form_fieldtype.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -112,8 +112,8 @@ <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 + tion allows forms programmers to define successor and pre- + decessor functions for the field type. These functions take the field pointer and an argument-block structure as arguments. @@ -182,9 +182,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_hook.3x.html b/doc/html/man/form_hook.3x.html index 369c164..7a5c6b5 100644 --- a/doc/html/man/form_hook.3x.html +++ b/doc/html/man/form_hook.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -130,9 +130,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_new.3x.html b/doc/html/man/form_new.3x.html index d73547a..8bcc990 100644 --- a/doc/html/man/form_new.3x.html +++ b/doc/html/man/form_new.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -124,9 +124,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_new_page.3x.html b/doc/html/man/form_new_page.3x.html index be9d115..c2a03cc 100644 --- a/doc/html/man/form_new_page.3x.html +++ b/doc/html/man/form_new_page.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -111,9 +111,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_opts.3x.html b/doc/html/man/form_opts.3x.html index 78d57fd..c4094f9 100644 --- a/doc/html/man/form_opts.3x.html +++ b/doc/html/man/form_opts.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -126,9 +126,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_page.3x.html b/doc/html/man/form_page.3x.html index 2168af1..54372ff 100644 --- a/doc/html/man/form_page.3x.html +++ b/doc/html/man/form_page.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -131,9 +131,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_post.3x.html b/doc/html/man/form_post.3x.html index 1e7e714..a54bc4b 100644 --- a/doc/html/man/form_post.3x.html +++ b/doc/html/man/form_post.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -128,9 +128,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_requestname.3x.html b/doc/html/man/form_requestname.3x.html index 8400063..32313e0 100644 --- a/doc/html/man/form_requestname.3x.html +++ b/doc/html/man/form_requestname.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_userptr.3x.html b/doc/html/man/form_userptr.3x.html index 189fca2..01d2c7a 100644 --- a/doc/html/man/form_userptr.3x.html +++ b/doc/html/man/form_userptr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_variables.3x.html b/doc/html/man/form_variables.3x.html index 5d252d9..d1c738c 100644 --- a/doc/html/man/form_variables.3x.html +++ b/doc/html/man/form_variables.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2010 Free Software Foundation, Inc. * + * Copyright (c) 2010,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: form_variables.3x,v 1.4 2013/06/22 17:58:32 tom Exp @ --> <HTML> <HEAD> @@ -68,7 +68,7 @@ </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 + fields that can be created using <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>. Each provides functions for field- and character-validation, according to the given datatype. @@ -110,9 +110,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/form_win.3x.html b/doc/html/man/form_win.3x.html index 9baa68f..4d1156c 100644 --- a/doc/html/man/form_win.3x.html +++ b/doc/html/man/form_win.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -131,9 +131,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/index.html b/doc/html/man/index.html index 64a832f..c93d1f8 100644 --- a/doc/html/man/index.html +++ b/doc/html/man/index.html @@ -1,8 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.0//EN"> <!-- - $Id: index.html,v 1.4 2010/01/09 20:36:50 tom Exp $ + $Id: index.html,v 1.7 2013/06/07 20:12:36 tom Exp $ **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2013 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 * @@ -29,39 +28,83 @@ * 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> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> + +<html> +<head> + <meta name="generator" content= + "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org"> + + <title>NCURSES – Manual Pages</title> + <link rev="MADE" href="mailto:dickey@invisible-island.net"> + <meta http-equiv="Content-Type" content= + "text/html; charset=us-ascii"> +</head> + +<body> + <ul> + <li>Programs: + + <ul> + <li><a href="captoinfo.1m.html">captoinfo – convert a + termcap description into a terminfo description</a></li> + + <li><a href="clear.1.html">clear – clear the terminal + screen</a></li> + + <li><a href="infocmp.1m.html">infocmp – compare or + print out terminfo descriptions</a></li> + + <li><a href="infotocap.1m.html">infotocap – convert a + terminfo description into a termcap description</a></li> + + <li><a href="tabs.1.html">tabs – set tabs on a + terminal</a></li> + + <li><a href="tic.1m.html">tic – the terminfo + entry-description compiler</a></li> + + <li><a href="toe.1m.html">toe – table of (terminfo) + entries</a></li> + + <li><a href="tput.1.html">tput – initialize a + terminal or query terminfo database</a></li> + + <li><a href="tset.1.html">tset – terminal + initialization</a></li> + </ul> + </li> + + <li>Libraries: + + <ul> + <li><a href="ncurses.3x.html">ncurses – CRT screen + handling and optimization package</a></li> + + <li><a href="panel.3x.html">panel- panel stack extension + for curses</a></li> + + <li><a href="form.3x.html">form – curses extension + for programming forms</a></li> + + <li><a href="menu.3x.html">menu – curses extension + for programming menus</a></li> + </ul> + </li> + + <li>File formats: + + <ul> + <li><a href="terminfo.5.html">terminfo – terminal + capability data base</a></li> + + <li><a href="term.5.html">term – format of compiled + term file.</a></li> + + <li><a href="term.7.html">term – conventions for + naming terminal types</a></li> + </ul> + </li> + </ul> +</body> +</html> diff --git a/doc/html/man/infocmp.1m.html b/doc/html/man/infocmp.1m.html index 553e385..443938b 100644 --- a/doc/html/man/infocmp.1m.html +++ b/doc/html/man/infocmp.1m.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2013,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: infocmp.1m,v 1.54 2014/03/29 23:18:29 tom Exp @ --> <HTML> <HEAD> @@ -53,7 +53,7 @@ </PRE> <H2>SYNOPSIS</H2><PRE> - <STRONG>infocmp</STRONG> [<STRONG>-1CEFGILTUVcdegilnpqrtux</STRONG>] + <STRONG>infocmp</STRONG> [<STRONG>-1CDEFGIKLTUVcdegilnpqrtux</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>...] @@ -72,76 +72,91 @@ <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. + 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>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- + 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>-c</STRONG> option produces a list of each capability that is + common between two or more 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. + The <STRONG>-n</STRONG> option produces a list of each capability that is + in none of the given entries. If no <EM>termnames</EM> are given, + the environment 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 + 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 + <STRONG>-K</STRONG> modifies the <STRONG>-C</STRONG> option, improving BSD-compatibility. - If no <EM>termnames</EM> are given, the environment variable <STRONG>TERM</STRONG> + 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 + 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 + 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- + For best results when converting to <STRONG>termcap</STRONG> format, you + should use both <STRONG>-C</STRONG> and <STRONG>-r</STRONG>. Normally a termcap description + is limited to 1023 bytes. infocmp trims away less essen- + tial parts to make it fit. If you are converting to one + of the (rare) termcap implementations which accept an + unlimited size of termcap, you may want to add the <STRONG>-T</STRONG> + option. More often however, you must help the termcap + implementation, and trim excess whitespace (use the <STRONG>-0</STRONG> + option for that). + + 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. + 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. Normally you would use both the <STRONG>-C</STRONG> and + <STRONG>-r</STRONG> options. The actual format used incorporates some + improvements for escaped characters from terminfo format. + For a stricter BSD-compatible translation, use the <STRONG>-K</STRONG> + option rather than <STRONG>-C</STRONG>. 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 + 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 + 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 @@ -154,66 +169,77 @@ <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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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. + Like other <STRONG>ncurses</STRONG> utilities, infocmp looks for the termi- + nal descriptions in several places. You can use the <STRONG>TER-</STRONG> + <STRONG>MINFO</STRONG> and <STRONG>TERMINFO_DIRS</STRONG> environment variables to override + the compiled-in default list of places to search (see + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> for details). + + You can also use the options <STRONG>-A</STRONG> and <STRONG>-B</STRONG> to override the + list of places to search when comparing terminal descrip- + tions: + + <STRONG>o</STRONG> The <STRONG>-A</STRONG> option sets the location for the first <EM>termname</EM> + + <STRONG>o</STRONG> The <STRONG>-B</STRONG> option sets the location for the other + <EM>termnames</EM>. + + Using these options, it is possible to compare descrip- + tions for a terminal with the same name located in two + different databases. For instance, you can use this fea- + ture for comparing descriptions for the same terminal cre- + ated by different people. <STRONG>Other</STRONG> <STRONG>Options</STRONG> + <STRONG>-0</STRONG> causes the fields to be printed on one line, without + wrapping. + <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. @@ -222,67 +248,71 @@ rather than discarding them. Capabilities are com- mented by prefixing them with a period. + <STRONG>-D</STRONG> tells <STRONG>infocmp</STRONG> to print the database locations that it + knows about, and exit. + <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 + 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 + 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 + <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 + <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- + 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 + <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 + <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 + (<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 + 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 + 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 @@ -310,21 +340,20 @@ 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 + 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}). + An SGR0 designates an empty highlight sequence + (equivalent to {SGR:NORMAL}). <STRONG>-l</STRONG> Set output format to terminfo. @@ -398,18 +427,19 @@ </PRE> <H2>FILES</H2><PRE> - /usr/share/terminfo Compiled terminal description - database. + /usr/share/terminfo Compiled terminal description data- + base. </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>-0</STRONG>, <STRONG>-1</STRONG>, <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> + 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>. @@ -420,10 +450,12 @@ </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="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.9 (patch 20110404). + http://invisible-island.net/ncurses/tctest.html + + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). </PRE> @@ -436,9 +468,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/infotocap.1m.html b/doc/html/man/infotocap.1m.html index a143e45..13b3ff9 100644 --- a/doc/html/man/infotocap.1m.html +++ b/doc/html/man/infotocap.1m.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -80,8 +80,8 @@ </PRE> <H2>FILES</H2><PRE> - /usr/share/terminfo Compiled terminal description - database. + /usr/share/terminfo Compiled terminal description data- + base. </PRE> @@ -94,7 +94,7 @@ <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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). </PRE> @@ -107,9 +107,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/key_defined.3x.html b/doc/html/man/key_defined.3x.html index ee6126b..ab7f294 100644 --- a/doc/html/man/key_defined.3x.html +++ b/doc/html/man/key_defined.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2003-2006,2010 Free Software Foundation, Inc. * @@ -95,9 +95,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/keybound.3x.html b/doc/html/man/keybound.3x.html index 5b54466..483604b 100644 --- a/doc/html/man/keybound.3x.html +++ b/doc/html/man/keybound.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1999-2008,2010 Free Software Foundation, Inc. * @@ -97,9 +97,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/keyok.3x.html b/doc/html/man/keyok.3x.html index d2b0be1..e76104c 100644 --- a/doc/html/man/keyok.3x.html +++ b/doc/html/man/keyok.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -97,9 +97,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/legacy_coding.3x.html b/doc/html/man/legacy_coding.3x.html index 03eea8b..0d1d5a4 100644 --- a/doc/html/man/legacy_coding.3x.html +++ b/doc/html/man/legacy_coding.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2005-2006,2010 Free Software Foundation, Inc. * @@ -110,9 +110,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu.3x.html b/doc/html/man/menu.3x.html index adfde4c..533bd8f 100644 --- a/doc/html/man/menu.3x.html +++ b/doc/html/man/menu.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: menu.3x,v 1.22 2014/08/16 20:32:08 tom Exp @ --> <HTML> <HEAD> @@ -196,46 +196,40 @@ </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- + 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- + 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 + 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 + 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.9 (patch 20110404). + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for + detailed descriptions of the entry points. + + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_attributes.3x.html b/doc/html/man/menu_attributes.3x.html index c02a4ab..7d34713 100644 --- a/doc/html/man/menu_attributes.3x.html +++ b/doc/html/man/menu_attributes.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -131,9 +131,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_cursor.3x.html b/doc/html/man/menu_cursor.3x.html index be4f429..d070b5d 100644 --- a/doc/html/man/menu_cursor.3x.html +++ b/doc/html/man/menu_cursor.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -109,9 +109,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index f2b6c16..fea9c2b 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * @@ -119,8 +119,8 @@ Clear the menu pattern buffer. REQ_BACK_PATTERN - Delete the previous character from the pattern - buffer. + Delete the previous character from the pattern buf- + fer. REQ_NEXT_MATCH Move to the next item matching the pattern match. @@ -128,20 +128,20 @@ 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 + 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 + 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 + 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- + 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: @@ -160,32 +160,32 @@ <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 + 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- + <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 + 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 + nal that an application specific command should be executed. - <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG> + <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 + 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 + 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 + defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-defined requests. @@ -199,7 +199,7 @@ System error occurred (see <STRONG>errno</STRONG>). <STRONG>E_BAD_ARGUMENT</STRONG> - Routine detected an incorrect or out-of-range argu- + Routine detected an incorrect or out-of-range argu- ment. <STRONG>E_BAD_STATE</STRONG> @@ -221,7 +221,7 @@ </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>. + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>. </PRE> @@ -232,14 +232,14 @@ </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- + 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 + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. @@ -247,9 +247,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_format.3x.html b/doc/html/man/menu_format.3x.html index c419406..cfa1335 100644 --- a/doc/html/man/menu_format.3x.html +++ b/doc/html/man/menu_format.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -125,9 +125,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_hook.3x.html b/doc/html/man/menu_hook.3x.html index 6a57ac7..73b872b 100644 --- a/doc/html/man/menu_hook.3x.html +++ b/doc/html/man/menu_hook.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -130,9 +130,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_items.3x.html b/doc/html/man/menu_items.3x.html index 322247a..8a9d145 100644 --- a/doc/html/man/menu_items.3x.html +++ b/doc/html/man/menu_items.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2010,2012 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: menu_items.3x,v 1.10 2012/11/03 23:03:59 tom Exp @ --> <HTML> <HEAD> @@ -74,7 +74,7 @@ </PRE> -<H2>RETURN VALUES</H2><PRE> +<H2>RETURN VALUE</H2><PRE> The function <STRONG>menu_items</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does not set errno. @@ -130,9 +130,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_mark.3x.html b/doc/html/man/menu_mark.3x.html index bdeaec6..e202dea 100644 --- a/doc/html/man/menu_mark.3x.html +++ b/doc/html/man/menu_mark.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -123,9 +123,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_new.3x.html b/doc/html/man/menu_new.3x.html index fde5fcc..be298ad 100644 --- a/doc/html/man/menu_new.3x.html +++ b/doc/html/man/menu_new.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -121,9 +121,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_opts.3x.html b/doc/html/man/menu_opts.3x.html index 7853d4e..410102c 100644 --- a/doc/html/man/menu_opts.3x.html +++ b/doc/html/man/menu_opts.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -140,9 +140,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index 88e6cdb..4d8d8c5 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * @@ -130,9 +130,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_post.3x.html b/doc/html/man/menu_post.3x.html index b8715f2..e8e0962 100644 --- a/doc/html/man/menu_post.3x.html +++ b/doc/html/man/menu_post.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -130,9 +130,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_requestname.3x.html b/doc/html/man/menu_requestname.3x.html index 54926fd..755098e 100644 --- a/doc/html/man/menu_requestname.3x.html +++ b/doc/html/man/menu_requestname.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_spacing.3x.html b/doc/html/man/menu_spacing.3x.html index 82e8575..7f1350f 100644 --- a/doc/html/man/menu_spacing.3x.html +++ b/doc/html/man/menu_spacing.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -121,9 +121,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_userptr.3x.html b/doc/html/man/menu_userptr.3x.html index be4f7d0..a825557 100644 --- a/doc/html/man/menu_userptr.3x.html +++ b/doc/html/man/menu_userptr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/menu_win.3x.html b/doc/html/man/menu_win.3x.html index 64e685e..4a69617 100644 --- a/doc/html/man/menu_win.3x.html +++ b/doc/html/man/menu_win.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -131,9 +131,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_current.3x.html b/doc/html/man/mitem_current.3x.html index d496682..d82a270 100644 --- a/doc/html/man/mitem_current.3x.html +++ b/doc/html/man/mitem_current.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -138,9 +138,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_name.3x.html b/doc/html/man/mitem_name.3x.html index e596bbf..2c00402 100644 --- a/doc/html/man/mitem_name.3x.html +++ b/doc/html/man/mitem_name.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -99,9 +99,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_new.3x.html b/doc/html/man/mitem_new.3x.html index 4b6e1f3..01c58f7 100644 --- a/doc/html/man/mitem_new.3x.html +++ b/doc/html/man/mitem_new.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -126,9 +126,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_opts.3x.html b/doc/html/man/mitem_opts.3x.html index 27d44a5..5c544fd 100644 --- a/doc/html/man/mitem_opts.3x.html +++ b/doc/html/man/mitem_opts.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -118,9 +118,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_userptr.3x.html b/doc/html/man/mitem_userptr.3x.html index 5cc957e..ebc3aff 100644 --- a/doc/html/man/mitem_userptr.3x.html +++ b/doc/html/man/mitem_userptr.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -104,9 +104,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_value.3x.html b/doc/html/man/mitem_value.3x.html index e68a2b0..145b6bc 100644 --- a/doc/html/man/mitem_value.3x.html +++ b/doc/html/man/mitem_value.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -109,9 +109,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/mitem_visible.3x.html b/doc/html/man/mitem_visible.3x.html index 52cdbdb..b85f445 100644 --- a/doc/html/man/mitem_visible.3x.html +++ b/doc/html/man/mitem_visible.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** @@ -92,9 +92,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html index 576b1a1..7569e4d 100644 --- a/doc/html/man/ncurses.3x.html +++ b/doc/html/man/ncurses.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 1998-2013,2014 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: ncurses.3x,v 1.119 2014/08/09 20:54:30 tom Exp @ --> <HTML> <HEAD> @@ -60,10 +60,10 @@ <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.9 (patch 20110404). + sonable optimization. This implementation is "new curses" + (ncurses) and is the approved replacement for 4.4BSD clas- + sic curses, which has been discontinued. This describes + <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). The <STRONG>ncurses</STRONG> library emulates the curses library of System V Release 4 UNIX, and XPG4 (X/Open Portability Guide) @@ -150,48 +150,48 @@ 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>. + 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 + 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. + 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- + 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 + 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 + 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 + 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 + 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 + 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 + 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>, @@ -200,119 +200,117 @@ <STRONG>/usr/share/terminfo/a/att4424</STRONG>. - This is useful for developing experimental definitions or + 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 + 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 + 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 + 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- + 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 + 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 + 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 + 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 + 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 + 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> + 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 + 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 + 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 + 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 + 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- + 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- + 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>, + 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, + 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 + 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 + 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>* @@ -376,9 +374,9 @@ 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> @@ -442,9 +440,9 @@ 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>* @@ -508,9 +506,9 @@ 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> @@ -574,9 +572,9 @@ 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> @@ -640,9 +638,9 @@ 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>* @@ -656,6 +654,7 @@ 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>* + use_tioctl <STRONG><A HREF="curs_util.3x.html">curs_util(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> @@ -706,8 +705,8 @@ 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> @@ -752,11 +751,14 @@ </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- + 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. + As a general rule, routines check for null pointers passed + as parameters, and handle this as an error. + 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>, @@ -772,53 +774,57 @@ 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- + (i.e., the <STRONG>cmdch</STRONG> capability) of the loaded terminfo + entries to the value of this variable. 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> + 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. + BAUDRATE + The debugging library checks this environment vari- + able when the application has redirected output to a + file. The variable'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. + 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 + 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> + 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., + 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 + 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. + nal environment (but not including system calls) to + determine the screen size. Use the <STRONG>use_tioctl</STRONG> func- + tion to update <STRONG>COLUMNS</STRONG> or <STRONG>LINES</STRONG> to match the screen + size obtained from system calls or the terminal data- + base. ESCDELAY Specifies the total time, in milliseconds, for which @@ -858,234 +864,305 @@ LINES Like COLUMNS, specify the height of the screen in - characters. See COLUMNS for a detailed description. + 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 + 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. + This variable lets you customize the mouse. The + variable 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- + 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_CONSOLE2 + This applies only to the MinGW port of ncurses. + + The <STRONG>Console2</STRONG> program's handling of the Microsoft Con- + sole API call <STRONG>CreateConsoleScreenBuffer</STRONG> is defective. + Applications which use this will hang. However, it + is possible to simulate the action of this call by + mapping coordinates, explicitly saving and restoring + the original screen contents. Setting the environ- + ment variable <STRONG>NCGDB</STRONG> has the same effect. + NCURSES_GPM_TERMS - This applies only to ncurses configured to use the + 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 + 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 + 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 + <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 + NCURSES_NO_MAGIC_COOKIE 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- + 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 + 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 + 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 + 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 + 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 + 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>. + Set the NCURSES_NO_PADDING environment variable 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. + This setting is obsolete. Before changes + + <STRONG>o</STRONG> started with 5.9 patch 20120825 and + + <STRONG>o</STRONG> continued though 5.9 patch 20130126 + + <STRONG>ncurses</STRONG> enabled buffered output during terminal ini- + tialization. This was done (as in SVr4 curses) for + performance reasons. For testing purposes, both of + <STRONG>ncurses</STRONG> and certain applications, this feature was + made optional. Setting the NCURSES_NO_SETBUF vari- + able disabled output buffering, leaving the output in + the original (usually line buffered) mode. + + In the current implementation, ncurses performs its + own buffering and does not require this workaround. + It does not modify the buffering of the standard out- + put. + + The reason for the change was to make the behavior + for interrupts and other signals more robust. One + drawback is that certain nonconventional programs + would mix ordinary stdio calls with ncurses calls and + (usually) work. This is no longer possible since + ncurses is not using the buffered standard output but + its own output (to the same file descriptor). As a + special case, the low-level calls such as <STRONG>putp</STRONG> still + use the standard output. But high-level curses calls + do not. 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 + 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 + 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- + 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, + U8#0, use=linux, # uxterm with vt100Graphics resource set to false xterm-utf8|xterm relying on UTF-8 line-graphics, - U8#1, use=xterm, + 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' + 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 + During initialization, the <STRONG>ncurses</STRONG> debugging library + checks the NCURSES_TRACE environment variable. 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 + TERM Denotes your terminal type. Each terminal type is distinct, though many are similar. + <STRONG>TERM</STRONG> is commonly set by terminal emulators to help + applications find a workable terminal description. + Some of those choose a popular approximation, e.g., + "ansi", "vt100", "xterm" rather than an exact fit. + Not infrequently, your application will have problems + with that approach, e.g., incorrect function-key def- + initions. + + If you set <STRONG>TERM</STRONG> in your environment, it has no effect + on the operation of the terminal emulator. It only + affects the way applications work within the termi- + nal. Likewise, as a general rule (<STRONG>xterm</STRONG> being a rare + exception), terminal emulators which allow you to + specify <STRONG>TERM</STRONG> as a parameter or configuration value do + not change their behavior to match that setting. + 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 + <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. + The TERMCAP environment variable contains either a + terminal description (with newlines stripped out), or + a file name telling where the information denoted by + the TERM environment variable 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. + 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 + <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> the directory specified by the TERMINFO environ- + ment variable <STRONG>o</STRONG> $HOME/.terminfo - <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS symbol + <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS environ- + ment variable + + <STRONG>o</STRONG> one or more directories whose names are config- + ured and compiled into the ncurses library, i.e., - <STRONG>o</STRONG> one or more directories whose names are config- - ured and compiled into the ncurses library, e.g., - /usr/share/terminfo + <STRONG>o</STRONG> /usr/local/ncurses/share/ter- + minfo:/usr/share/terminfo (corresponding to + the TERMINFO_DIRS variable) + + <STRONG>o</STRONG> /usr/share/terminfo (corresponding to the + TERMINFO variable) 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. + 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. Normally these are stored in a directory tree, + using subdirectories named by the first letter of the + terminal names therein. + + If <STRONG>ncurses</STRONG> is built with a hashed database, then each + entry in this list can also be the path of the corre- + sponding database file. + + If <STRONG>ncurses</STRONG> is built with a support for reading term- + cap files directly, then an entry in this list may be + the path of a termcap file. 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 + If TERMCAP does not hold a file name then <STRONG>ncurses</STRONG> + checks the TERMPATH environment variable. This is a + list of filenames separated by spaces or colons + (i.e., ":") on Unix, semicolons on OS/2 EMX. + + If the TERMPATH environment variable 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. + 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 + 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> + 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, + 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 + 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 + 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., + library names have a "w" appended to them, i.e., instead of <STRONG>-lncurses</STRONG> @@ -1095,18 +1172,29 @@ <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 + 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 + 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-pthread + The configure script renames the library. All of the + library names have a "t" appended to them (before any + "w" added by <STRONG>--enable-widec</STRONG>). + + The global variables such as <STRONG>LINES</STRONG> are replaced by + macros to allow read-only access. At the same time, + setter-functions are provided to set these values. + Some applications (very few) may require changes to + work with this convention. + --with-shared --with-normal @@ -1114,16 +1202,16 @@ --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>. + The shared and normal (static) library names differ + by their suffixes, e.g., <STRONG>libncurses.so</STRONG> and <STRONG>libn-</STRONG> + <STRONG>curses.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 + 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 + in the shared library. Configure scripts should check for the function's existence rather than assum- ing it is always in the debug library. @@ -1131,14 +1219,14 @@ </PRE> <H2>FILES</H2><PRE> /usr/share/tabset - directory containing initialization files for the + 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_" + <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> @@ -1148,52 +1236,61 @@ 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 + 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>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 + 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. + 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- + 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. + 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 + 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- + 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 + 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. + Unlike other implementations, this one checks parameters + such as pointers to WINDOW structures to ensure they are + not null. The main reason for providing this behavior is + to guard against programmer error. The standard interface + does not provide a way for the library to tell an applica- + tion which of several possible errors were detected. + Relying on this (or some other) extension will adversely + affect the portability of curses applications. + This implementation also contains several extensions: <STRONG>o</STRONG> The routine <STRONG>has_key</STRONG> is not part of XPG4, nor is it @@ -1227,31 +1324,31 @@ <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. + 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- + 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 + 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 + 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 + 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. + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. @@ -1259,9 +1356,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/ncurses5-config.1.html b/doc/html/man/ncurses5-config.1.html index 2169bb9..badc7ca 100644 --- a/doc/html/man/ncurses5-config.1.html +++ b/doc/html/man/ncurses5-config.1.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 2010 Free Software Foundation, Inc. * @@ -105,10 +105,11 @@ <STRONG>--terminfo-dirs</STRONG> echos the $TERMINFO_DIRS directory list, e.g., - /usr/local/ncurses/lib/terminfo:/usr/share/terminfo + /usr/local/ncurses/share/terminfo:/usr/share/ter- + minfo <STRONG>--termpath</STRONG> - echos the $TERMPATH termcap list, if support for + echos the $TERMPATH termcap list, if support for termcap is configured. <STRONG>--help</STRONG> prints this message @@ -118,16 +119,13 @@ <H2>SEE ALSO</H2><PRE> <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> - This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/panel.3x.html b/doc/html/man/panel.3x.html index c73e241..00fdf76 100644 --- a/doc/html/man/panel.3x.html +++ b/doc/html/man/panel.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * @@ -174,35 +174,35 @@ </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 + 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- + 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 program- + ming interface is unchanged). The <STRONG>PANEL</STRONG> data structures + are merely similar. The programmer is cautioned 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 + 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', + 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). @@ -218,14 +218,14 @@ <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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). </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 + 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. @@ -233,9 +233,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/resizeterm.3x.html b/doc/html/man/resizeterm.3x.html index d675ee3..658cc75 100644 --- a/doc/html/man/resizeterm.3x.html +++ b/doc/html/man/resizeterm.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2013 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 * @@ -27,8 +27,8 @@ * 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 @ + * Author: Thomas E. Dickey 1996-on + * @Id: resizeterm.3x,v 1.17 2013/06/22 20:41:54 tom Exp @ --> <HTML> <HEAD> @@ -69,28 +69,29 @@ 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. + <STRONG>ncurses</STRONG> library that record the window dimensions such as + the <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> variables. - Most of the work is done by the inner function + 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 + 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- + 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 + 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 + Except as noted, these functions 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. @@ -98,29 +99,27 @@ </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- + 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 + If ncurses is configured to supply its own SIGWINCH han- + dler, the <STRONG>resizeterm</STRONG> function <STRONG>ungetch</STRONG>'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 + 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. + 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. </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>. + <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="wresize.3x.html">wresize(3x)</A></STRONG>. </PRE> @@ -133,9 +132,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/tabs.1.html b/doc/html/man/tabs.1.html index a8781ac..e56ee4f 100644 --- a/doc/html/man/tabs.1.html +++ b/doc/html/man/tabs.1.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2008-2009,2010 Free Software Foundation, Inc. * + * Copyright (c) 2008-2011,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: tabs.1,v 1.11 2013/06/22 18:11:57 tom Exp @ --> <HTML> <HEAD> @@ -52,7 +52,7 @@ </PRE> <H2>SYNOPSIS</H2><PRE> - <STRONG>tabs</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahuUV</STRONG>] <EM>file...</EM> + <STRONG>tabs</STRONG> [<EM>options</EM>]] <EM>[tabstop-list]</EM> </PRE> @@ -85,14 +85,17 @@ 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 + <STRONG>-V</STRONG> reports the version of ncurses which was used in this + program, and exits. + + 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 + 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. @@ -100,17 +103,18 @@ 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 + 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 + 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> @@ -137,18 +141,18 @@ </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 + 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 + 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- + 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 + implementation will attempt to set tab stops up to the + right margin of the screen, if the given list happens to be that long. @@ -156,16 +160,13 @@ <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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/term.5.html b/doc/html/man/term.5.html index 73ecbb2..ced0a35 100644 --- a/doc/html/man/term.5.html +++ b/doc/html/man/term.5.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -300,9 +300,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/term.7.html b/doc/html/man/term.7.html index 4c944a1..10b2db5 100644 --- a/doc/html/man/term.7.html +++ b/doc/html/man/term.7.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * + * 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: term.7,v 1.23 2011/12/17 23:32:17 tom Exp @ --> <HTML> <HEAD> @@ -85,9 +85,9 @@ 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. + created a custom entry incorporating options (such as vis- + ual 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 @@ -243,9 +243,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/term_variables.3x.html b/doc/html/man/term_variables.3x.html index bc1f9ba..931d95f 100644 --- a/doc/html/man/term_variables.3x.html +++ b/doc/html/man/term_variables.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2010 Free Software Foundation, Inc. * + * Copyright (c) 2011,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: term_variables.3x,v 1.4 2013/12/21 22:17:39 tom Exp @ --> <HTML> <HEAD> @@ -99,8 +99,8 @@ <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>. + This variable is also set as a side-effect of <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> + and <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(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 @@ -108,7 +108,7 @@ 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 <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> and <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</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 @@ -130,8 +130,8 @@ </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 + The low-level terminfo interface is initialized using + <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>. The upper-level curses interface uses the low-level terminfo interface, internally. @@ -149,17 +149,14 @@ </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="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><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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index 0340f50..6e10145 100644 --- a/doc/html/man/terminfo.5.html +++ b/doc/html/man/terminfo.5.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t * DO NOT EDIT THIS FILE BY HAND! @@ -6,7 +6,7 @@ * 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. * + * Copyright (c) 1998-2012,2013 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 * @@ -32,9 +32,9 @@ * 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 @ + * @Id: terminfo.head,v 1.21 2013/03/09 22:11:36 tom Exp @ * Head of terminfo man page ends here - * @Id: terminfo.tail,v 1.53 2010/12/04 18:38:55 tom Exp @ + * @Id: terminfo.tail,v 1.68 2013/11/09 15:20:48 tom Exp @ * Beginning of terminfo.tail file * This file is part of ncurses. * See "terminfo.head" for copyright. @@ -73,12 +73,12 @@ </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 + screen-oriented programs such as <STRONG>nvi(1)</STRONG>, <STRONG>rogue(1)</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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). Entries in <EM>terminfo</EM> consist of a sequence of `,' separated fields (embedded commas may be escaped with a backslash or @@ -106,14 +106,13 @@ 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 + 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 @@ -126,14 +125,14 @@ -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> + <STRONG>Predefined</STRONG> <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, @@ -176,133 +175,134 @@ 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- + <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- + auto_right_margin am am terminal has auto- matic margins - back_color_erase bce ut screen erased with + back_color_erase bce ut screen erased with background color - can_change ccc cc terminal can re- + can_change ccc cc terminal can re- define existing col- ors - ceol_standout_glitch xhp xs standout not erased + ceol_standout_glitch xhp xs standout not erased by overwriting (hp) - col_addr_glitch xhpa YA only positive motion + col_addr_glitch xhpa YA only positive motion for hpa/mhpa caps - cpi_changes_res cpix YF changing character + + cpi_changes_res cpix YF changing character pitch changes reso- lution - cr_cancels_micro_mode crxm YB using cr turns off + cr_cancels_micro_mode crxm YB using cr turns off micro mode - dest_tabs_magic_smso xt xt tabs destructive, + dest_tabs_magic_smso xt xt tabs destructive, magic so char (t1061) - eat_newline_glitch xenl xn newline ignored + eat_newline_glitch xenl xn newline ignored after 80 cols (con- cept) - erase_overstrike eo eo can erase over- + 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 + 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 + has_meta_key km km Has a meta key (i.e., sets 8th-bit) - has_print_wheel daisy YC printer needs opera- + has_print_wheel daisy YC printer needs opera- tor to change char- acter set - has_status_line hs hs has extra status + has_status_line hs hs has extra status line - hue_lightness_saturation hls hl terminal uses only + hue_lightness_saturation hls hl terminal uses only HLS color notation (Tektronix) - insert_null_glitch in in insert mode distin- + insert_null_glitch in in insert mode distin- guishes nulls - lpi_changes_res lpix YG changing line pitch + lpi_changes_res lpix YG changing line pitch changes resolution - memory_above da da display may be + memory_above da da display may be retained above the screen - memory_below db db display may be + memory_below db db display may be retained below the screen - move_insert_mode mir mi safe to move while + move_insert_mode mir mi safe to move while in insert mode - move_standout_mode msgr ms safe to move while + move_standout_mode msgr ms safe to move while in standout mode - needs_xon_xoff nxon nx padding will not + needs_xon_xoff nxon nx padding will not work, xon/xoff required - no_esc_ctlc xsb xb beehive (f1=escape, + no_esc_ctlc xsb xb beehive (f1=escape, f2=ctrl C) - no_pad_char npc NP pad character does + no_pad_char npc NP pad character does not exist - non_dest_scroll_region ndscr ND scrolling region is + non_dest_scroll_region ndscr ND scrolling region is non-destructive - non_rev_rmcup nrrmc NR smcup does not + non_rev_rmcup nrrmc NR smcup does not reverse rmcup - over_strike os os terminal can over- + over_strike os os terminal can over- strike - prtr_silent mc5i 5i printer will not + prtr_silent mc5i 5i printer will not echo on screen - row_addr_glitch xvpa YD only positive motion + row_addr_glitch xvpa YD only positive motion for vpa/mvpa caps - semi_auto_right_margin sam YE printing in last + semi_auto_right_margin sam YE printing in last column causes cr - status_line_esc_ok eslok es escape can be used + status_line_esc_ok eslok es escape can be used on the status line - tilde_glitch hz hz cannot print ~'s + tilde_glitch hz hz cannot print ~'s (hazeltine) - transparent_underline ul ul underline character + transparent_underline ul ul underline character overstrikes - xon_xoff xon xo terminal uses + 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 + <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 + init_tabs it it tabs initially every # spaces - label_height lh lh rows in each label - label_width lw lw columns in each + label_height lh lh rows in each label + label_width lw lw columns in each label - lines lines li number of lines on + lines lines li number of lines on screen or page - lines_of_memory lm lm lines of memory if > + lines_of_memory lm lm lines of memory if > line. 0 means varies - magic_cookie_glitch xmc sg number of blank + magic_cookie_glitch xmc sg number of blank characters left by smso or rmso - max_attributes ma ma maximum combined + max_attributes ma ma maximum combined attributes terminal can handle - max_colors colors Co maximum number of + max_colors colors Co maximum number of colors on screen - max_pairs pairs pa maximum number of + max_pairs pairs pa maximum number of color-pairs on the screen - maximum_windows wnum MW maximum number of + maximum_windows wnum MW maximum number of defineable windows - no_color_video ncv NC video attributes + no_color_video ncv NC video attributes that cannot be used with colors - num_labels nlab Nl number of labels on + num_labels nlab Nl number of labels on screen - padding_baud_rate pb pb lowest baud rate + padding_baud_rate pb pb lowest baud rate where padding needed - virtual_terminal vt vt virtual terminal + virtual_terminal vt vt virtual terminal number (CB/unix) - width_status_line wsl ws number of columns in + width_status_line wsl ws number of columns in status line The following numeric capabilities are present in the @@ -310,47 +310,47 @@ 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 + <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 + bit_image_type bitype Yp type of bit-image device - buffer_capacity bufsz Ya numbers of bytes + buffer_capacity bufsz Ya numbers of bytes buffered before printing - buttons btns BT number of buttons on + buttons btns BT number of buttons on mouse - dot_horz_spacing spinh Yc spacing of dots hor- + dot_horz_spacing spinh Yc spacing of dots hor- izontally in dots per inch - dot_vert_spacing spinv Yb spacing of pins ver- + dot_vert_spacing spinv Yb spacing of pins ver- tically in pins per inch - max_micro_address maddr Yd maximum value in + max_micro_address maddr Yd maximum value in micro_..._address - max_micro_jump mjump Ye maximum value in + max_micro_jump mjump Ye maximum value in parm_..._micro - micro_col_size mcs Yf character step size + micro_col_size mcs Yf character step size when in micro mode - micro_line_size mls Yg line step size when + micro_line_size mls Yg line step size when in micro mode - number_of_pins npins Yh numbers of pins in + number_of_pins npins Yh numbers of pins in print-head - output_res_char orc Yi horizontal resolu- + output_res_char orc Yi horizontal resolu- tion in units per line - output_res_horz_inch orhi Yk horizontal resolu- + output_res_horz_inch orhi Yk horizontal resolu- tion in units per inch - output_res_line orl Yj vertical resolution + output_res_line orl Yj vertical resolution in units per line - output_res_vert_inch orvi Yl vertical resolution + output_res_vert_inch orvi Yl vertical resolution in units per inch - print_rate cps Ym print rate in char- + print_rate cps Ym print rate in char- acters per second - wide_char_size widcs Yn character step size + wide_char_size widcs Yn character step size when in double wide mode @@ -402,8 +402,8 @@ 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_address cup cm move to row #1 col- + umns #2 cursor_down cud1 do down one line cursor_home home ho home cursor (if no cup) @@ -904,8 +904,8 @@ 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 + The following string capabilities are present in the + SVr4.0 term structure, but were originally not documented in the man page. @@ -989,13 +989,14 @@ 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! + The XSI Curses standard added these hardcopy capabili- + ties. They were used in some post-4.1 versions of System + V curses, e.g., Solaris 2.5 and IRIX 6.x. Except for <STRONG>YI</STRONG>, + the <STRONG>ncurses</STRONG> termcap names for them are invented. Accord- + ing 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> @@ -1015,123 +1016,210 @@ 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 + set_pglen_inch slengthYI Set page length to + #1 hundredth of an + inch (some implemen- + tations use sL for + termcap). + + <STRONG>User-Defined</STRONG> <STRONG>Capabilities</STRONG> + The preceding section listed the <EM>predefined</EM> capabilities. + They deal with some special features for terminals no + longer (or possibly never) produced. Occasionally there + are special features of newer terminals which are awkward + or impossible to represent by reusing the predefined capa- + bilities. + + <STRONG>ncurses</STRONG> addresses this limitation by allowing user-defined + capabilities. The <STRONG>tic</STRONG> and <STRONG>infocmp</STRONG> programs provide the <STRONG>-x</STRONG> + option for this purpose. When <STRONG>-x</STRONG> is set, <STRONG>tic</STRONG> treats + unknown capabilities as user-defined. That is, if <STRONG>tic</STRONG> + encounters a capability name which it does not recognize, + it infers its type (boolean, number or string) from the + syntax and makes an extended table entry for that capabil- + ity. The <STRONG>use_extended_names</STRONG> function makes this informa- + tion conditionally available to applications. The ncurses + library provides the data leaving most of the behavior to + applications: + + <STRONG>o</STRONG> User-defined capability strings whose name begins with + "k" are treated as function keys. + + <STRONG>o</STRONG> The types (boolean, number, string) determined by <STRONG>tic</STRONG> + can be inferred by successful calls on <STRONG>tigetflag</STRONG>, etc. + + <STRONG>o</STRONG> If the capability name happens to be two characters, + the capability is also available through the termcap + interface. + + While termcap is said to be extensible because it does not + use a predefined set of capabilities, in practice it has + been limited to the capabilities defined by terminfo + implementations. As a rule, user-defined capabilities + intended for use by termcap applications should be limited + to booleans and numbers to avoid running past the 1023 + byte limit assumed by termcap implementations and their + applications. In particular, providing extended sets of + function keys (past the 60 numbered keys and the handful + of special named keys) is best done using the longer names + available using terminfo. <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 + 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. - + ansi|ansi/pc-term compatible with color, + am, mc5i, mir, msgr, + colors#8, cols#80, it#8, lines#24, ncv#3, pairs#64, + acsc=+\020\,\021-\030.^Y0\333`\004a\261f\370g\361h\260 + j\331k\277l\332m\300n\305o~p\304q\304r\304s_t\303 + u\264v\301w\302x\263y\363z\362{\343|\330}\234~\376, + bel=^G, blink=\E[5m, bold=\E[1m, cbt=\E[Z, clear=\E[H\E[J, + cr=^M, cub=\E[%p1%dD, cub1=\E[D, cud=\E[%p1%dB, cud1=\E[B, + cuf=\E[%p1%dC, cuf1=\E[C, cup=\E[%i%p1%d;%p2%dH, + cuu=\E[%p1%dA, cuu1=\E[A, dch=\E[%p1%dP, dch1=\E[P, + dl=\E[%p1%dM, dl1=\E[M, ech=\E[%p1%dX, ed=\E[J, el=\E[K, + el1=\E[1K, home=\E[H, hpa=\E[%i%p1%dG, ht=\E[I, hts=\EH, + ich=\E[%p1%d@, il=\E[%p1%dL, il1=\E[L, ind=^J, + indn=\E[%p1%dS, invis=\E[8m, kbs=^H, kcbt=\E[Z, kcub1=\E[D, + kcud1=\E[B, kcuf1=\E[C, kcuu1=\E[A, khome=\E[H, kich1=\E[L, + mc4=\E[4i, mc5=\E[5i, nel=\r\E[S, op=\E[39;49m, + rep=%p1%c\E[%p2%{1}%-%db, rev=\E[7m, rin=\E[%p1%dT, + rmacs=\E[10m, rmpch=\E[10m, rmso=\E[m, rmul=\E[m, + s0ds=\E(B, s1ds=\E)B, s2ds=\E*B, s3ds=\E+B, + setab=\E[4%p1%dm, setaf=\E[3%p1%dm, + sgr=\E[0;10%?%p1%t;7%; + %?%p2%t;4%; + %?%p3%t;7%; + %?%p4%t;5%; + %?%p6%t;1%; + %?%p7%t;8%; + %?%p9%t;11%;m, + sgr0=\E[0;10m, smacs=\E[11m, smpch=\E[11m, smso=\E[7m, + smul=\E[4m, tbc=\E[3g, u6=\E[%i%d;%dR, u7=\E[6n, + u8=\E[?%[;0123456789]c, u9=\E[c, vpa=\E[%i%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: + + <STRONG>o</STRONG> Boolean capabilities which indicate that the terminal + has some particular feature, + + <STRONG>o</STRONG> numeric capabilities giving the size of the terminal + or the size of particular delays, and + + <STRONG>o</STRONG> 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 + 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 + 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 + 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 + 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 - `,'. + an "=", and then a string ending at the next following + ",". - A number of escape sequences are provided in the string + 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 + 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>o</STRONG> <STRONG>\^</STRONG> for <STRONG>^</STRONG>, + + <STRONG>o</STRONG> <STRONG>\\</STRONG> for <STRONG>\</STRONG>, + + <STRONG>o</STRONG> <STRONG>\</STRONG>, for comma, + + <STRONG>o</STRONG> <STRONG>\:</STRONG> for <STRONG>:</STRONG>, + + <STRONG>o</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 termi- + nals, providing CS7 is specified. See <STRONG>stty(1)</STRONG>. + + The reason for this quirk is to maintain binary com- + patibility of the compiled terminfo files with other + implementations, e.g., the SVr4 systems, which docu- + ment this. Compiled terminfo files use null-termi- + nated strings, with no lengths. Modifying this would + require a new binary format, which would not work with + other implementations. + + 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 + "*" 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 + 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 + 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.) + The <STRONG>ncurses</STRONG> library searches for terminal descriptions in + several places. It uses only the first description found. + The library has a compiled-in list of places to search + which can be overridden by environment variables. Before + starting to search, <STRONG>ncurses</STRONG> eliminates duplicates in its + search list. + <STRONG>o</STRONG> If the environment variable TERMINFO is set, it is + interpreted as the pathname of a directory containing + the compiled description you are working on. Only + that directory is searched. + + <STRONG>o</STRONG> If TERMINFO is not set, <STRONG>ncurses</STRONG> will instead look in + the directory <STRONG>$HOME/.terminfo</STRONG> for a compiled descrip- + tion. + + <STRONG>o</STRONG> Next, if the environment variable TERMINFO_DIRS is + set, <STRONG>ncurses</STRONG> will interpret the contents of that vari- + able as a list of colon-separated directories (or + database files) to be searched. + + An empty directory name (i.e., if the variable begins + or ends with a colon, or contains adacent colons) is + interpreted as the system location <EM>/usr/share/ter-</EM> + <EM>minfo</EM>. + + <STRONG>o</STRONG> Finally, <STRONG>ncurses</STRONG> searches these compiled-in locations: + + <STRONG>o</STRONG> a list of directories + (/usr/local/ncurses/share/terminfo:/usr/share/ter- + minfo), and + + <STRONG>o</STRONG> the system terminfo directory, <EM>/usr/share/terminfo</EM> + (the compiled-in default). <STRONG>Preparing</STRONG> <STRONG>Descriptions</STRONG> We now outline how to prepare descriptions of terminals. @@ -1147,12 +1235,11 @@ 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 + 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 @@ -1178,7 +1265,7 @@ 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 + 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 @@ -1190,137 +1277,135 @@ 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 + 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 + 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 + 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> + 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 + "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, + 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, - + 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 + Cursor addressing and other strings requiring parameters + in the terminal are described by a parameterized string + capability, with <EM>printf</EM>-like escapes such as <EM>%x</EM> 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 + 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 + 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: + <STRONG>%%</STRONG> outputs "%" - %% 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- + <STRONG>%</STRONG><EM>[[</EM>:<EM>]flags][width[.precision]][</EM><STRONG>doxXs</STRONG><EM>]</EM> + as in <STRONG>printf</STRONG>, flags are <EM>[-+#]</EM> and <EM>space</EM>. 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> + <STRONG>%s</STRONG> print pop() like %s in <STRONG>printf</STRONG> - %p[1-9] + <STRONG>%p</STRONG><EM>[1-9]</EM> push <EM>i</EM>'th parameter - %P[a-z] - set dynamic variable [a-z] to pop() + <STRONG>%P</STRONG><EM>[a-z]</EM> + set dynamic variable <EM>[a-z]</EM> to pop() - %g[a-z] - get dynamic variable [a-z] and push it + <STRONG>%g</STRONG><EM>[a-z]/</EM> + get dynamic variable <EM>[a-z]</EM> and push it - %P[A-Z] - set static variable [a-z] to pop() + <STRONG>%P</STRONG><EM>[A-Z]</EM> + set static variable <EM>[a-z]</EM> to <EM>pop()</EM> - %g[A-Z] - get static variable [a-z] and push it + <STRONG>%g</STRONG><EM>[A-Z]</EM> + get static variable <EM>[a-z]</EM> 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 + 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> + <STRONG>%'</STRONG><EM>c</EM><STRONG>'</STRONG> char constant <EM>c</EM> - %{<EM>nn</EM>} + <STRONG>%{</STRONG><EM>nn</EM><STRONG>}</STRONG> integer constant <EM>nn</EM> - %l push strlen(pop) + <STRONG>%l</STRONG> push strlen(pop) - %+ %- %* %/ %m - arithmetic (%m is mod): push(pop() op pop()) + <STRONG>%+</STRONG>, <STRONG>%-</STRONG>, <STRONG>%*</STRONG>, <STRONG>%/</STRONG>, <STRONG>%m</STRONG> + arithmetic (%m is mod): <EM>push(pop()</EM> <EM>op</EM> <EM>pop())</EM> - %& %| %^ - bit operations (AND, OR and exclusive-OR): push(pop() - op pop()) + <STRONG>%&</STRONG>, <STRONG>%|</STRONG>, <STRONG>%^</STRONG> + bit operations (AND, OR and exclusive-OR): <EM>push(pop()</EM> + <EM>op</EM> <EM>pop())</EM> - %= %> %< - logical operations: push(pop() op pop()) + <STRONG>%=</STRONG>, <STRONG>%></STRONG>, <STRONG>%<</STRONG> + logical operations: <EM>push(pop()</EM> <EM>op</EM> <EM>pop())</EM> - %A, %O + <STRONG>%A</STRONG>, <STRONG>%O</STRONG> logical AND and OR operations (for conditionals) - %! %~ - unary operations (logical and bit complement): + <STRONG>%!</STRONG>, <STRONG>%~</STRONG> + unary operations (logical and bit complement): push(op pop()) - %i add 1 to first two parameters (for ANSI terminals) + <STRONG>%i</STRONG> 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. + <STRONG>%?</STRONG> <EM>expr</EM> <STRONG>%t</STRONG> <EM>thenpart</EM> <STRONG>%e</STRONG> <EM>elsepart</EM> <STRONG>%;</STRONG> + This forms an if-then-else. The <STRONG>%e</STRONG> <EM>elsepart</EM> is + optional. Usually the <STRONG>%?</STRONG> <EM>expr</EM> part pushes a value + onto the stack, and <STRONG>%t</STRONG> pops it from the stack, test- + ing if it is nonzero (true). If it is zero (false), + control passes to the <STRONG>%e</STRONG> (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 %; + <STRONG>%?</STRONG> c1 <STRONG>%t</STRONG> b1 <STRONG>%e</STRONG> c2 <STRONG>%t</STRONG> b2 <STRONG>%e</STRONG> c3 <STRONG>%t</STRONG> b3 <STRONG>%e</STRONG> c4 <STRONG>%t</STRONG> b4 <STRONG>%e</STRONG> <STRONG>%;</STRONG> where ci are conditions, bi are bodies. @@ -1332,7 +1417,7 @@ 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 + "%gx%{5}%-". <STRONG>%P</STRONG> and <STRONG>%g</STRONG> variables are persistent across escape-string evaluations. Consider the HP2645, which, to get to row 3 and column 12, @@ -1342,241 +1427,238 @@ 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 + 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 + 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. + '%+%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 + 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 + 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 + 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. + general two parameter sequence (as with the hp2645) and + can be used in preference to <STRONG>cup</STRONG>. If there are parameter- + ized 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 + 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. + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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- + 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 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> + 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 + 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 + 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 + 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 + 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 clear- + ing 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 posi- + tion 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 terminal 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 terminals whose insert + mode cannot be described with the single 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 + 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 charac- + ter 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 + 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 + 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 + 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> + 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 + in insert mode, give this as a number of milliseconds pad- + ding 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 + 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> + 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- + 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, + 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 spa- + ces 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 @@ -1605,19 +1687,18 @@ 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> - <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) + 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 @@ -1637,23 +1718,21 @@ 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> - <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%; + \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%;, + sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p4%t;5%; + %?%p1%p3%|%t;7%;%?%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 @@ -1664,8 +1743,8 @@ 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 + 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 @@ -1695,7 +1774,6 @@ 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 @@ -1704,27 +1782,57 @@ 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. + + 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>o</STRONG> <STRONG>kll</STRONG> (home down), + + <STRONG>o</STRONG> <STRONG>kbs</STRONG> (backspace), + + <STRONG>o</STRONG> <STRONG>ktbc</STRONG> (clear all tabs), + + <STRONG>o</STRONG> <STRONG>kctab</STRONG> (clear the tab stop in this column), + + <STRONG>o</STRONG> <STRONG>kclr</STRONG> (clear screen or erase key), + + <STRONG>o</STRONG> <STRONG>kdch1</STRONG> (delete character), + + <STRONG>o</STRONG> <STRONG>kdl1</STRONG> (delete line), + + <STRONG>o</STRONG> <STRONG>krmir</STRONG> (exit insert mode), + + <STRONG>o</STRONG> <STRONG>kel</STRONG> (clear to end of line), + + <STRONG>o</STRONG> <STRONG>ked</STRONG> (clear to end of screen), + + <STRONG>o</STRONG> <STRONG>kich1</STRONG> (insert character or enter insert mode), + + <STRONG>o</STRONG> <STRONG>kil1</STRONG> (insert line), + + <STRONG>o</STRONG> <STRONG>knp</STRONG> (next page), + + <STRONG>o</STRONG> <STRONG>kpp</STRONG> (previous page), + + <STRONG>o</STRONG> <STRONG>kind</STRONG> (scroll forward/down), + + <STRONG>o</STRONG> <STRONG>kri</STRONG> (scroll backward/up), + + <STRONG>o</STRONG> <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 use- + ful when the effects of a 3 by 3 directional 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 @@ -1746,12 +1854,11 @@ 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 + I). A "back-tab" command which moves leftward to the pre- + ceding 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 @@ -1851,9 +1958,8 @@ 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 + 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). @@ -1883,110 +1989,105 @@ 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 + 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 + 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 + <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 + 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 + 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. + 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 + 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 + 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 + <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 + 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 + 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 + 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 + <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 @@ -1997,7 +2098,7 @@ 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 + 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> @@ -2009,132 +2110,137 @@ 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 + bilities; otherwise red/blue will be interchanged on the display. - On an HP-like terminal, use <STRONG>scp</STRONG> with a color-pair number + 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, + 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. + - 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> + (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 + 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. + 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 + 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> + <STRONG>Attribute</STRONG> <STRONG>Bit</STRONG> <STRONG>Decimal</STRONG> <STRONG>Set</STRONG> <STRONG>by</STRONG> + A_STANDOUT 0 1 sgr + A_UNDERLINE 1 2 sgr + A_REVERSE 2 4 sgr + A_BLINK 3 8 sgr + A_DIM 4 16 sgr + A_BOLD 5 32 sgr + A_INVIS 6 64 sgr + A_PROTECT 7 128 sgr + A_ALTCHARSET 8 256 sgr + A_HORIZONTAL 9 512 sgr1 + A_LEFT 10 1024 sgr1 + A_LOW 11 2048 sgr1 + A_RIGHT 12 4096 sgr1 + A_TOP 13 8192 sgr1 + A_VERTICAL 14 16384 sgr1 + A_ITALIC 15 32768 sitm + + 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 + 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- + 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 + 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 + 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> + 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 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 + 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 + 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 + 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 + <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 + 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>. + 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 + 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 + 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 + 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 + 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 + 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> @@ -2147,10 +2253,10 @@ 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- + "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- + 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. @@ -2159,13 +2265,12 @@ 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'. + 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) @@ -2183,14 +2288,13 @@ the use reference that imports it, where <EM>xx</EM> is the capa- bility. For example, the entry - 2621-nl, smkx@, rmkx@, use=2621, + 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 @@ -2229,21 +2333,21 @@ libraries strip off the final newline, too (GNU termcap does not). Now suppose: - * a termcap entry before expansion is more than 1023 - bytes long, + <STRONG>o</STRONG> a termcap entry before expansion is more than 1023 + bytes long, - * and the application has only allocated a 1k buffer, + <STRONG>o</STRONG> 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, + <STRONG>o</STRONG> 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). + <STRONG>o</STRONG> 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 @@ -2288,61 +2392,72 @@ </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- + Searching for terminal descriptions in <STRONG>$HOME/.terminfo</STRONG> and + TERMINFO_DIRS is not supported by older implementations. + + 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> + 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- + 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> + 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 + 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 + 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 + X/Open Curses does not mention italics. Portable applica- + tions must assume that numeric capabilities are signed + 16-bit values. This includes the <EM>no</EM><STRONG>_</STRONG><EM>color</EM><STRONG>_</STRONG><EM>video</EM> (ncv) + capability. The 32768 mask value used for italics with + ncv can be confused with an absent or cancelled ncv. If + italics should work with colors, then the ncv value must + be specified, even if it is zero. + + 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 + <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>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] + <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 + 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 + <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. + <STRONG>OSF</STRONG> -- Supports both the SVr4 set and the AIX extensions. </PRE> @@ -2353,7 +2468,7 @@ </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="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>printf(3)</STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>. <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>. @@ -2367,9 +2482,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/tic.1m.html b/doc/html/man/tic.1m.html index 9d05671..870c06f 100644 --- a/doc/html/man/tic.1m.html +++ b/doc/html/man/tic.1m.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2013,2014 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: tic.1m,v 1.60 2014/05/24 22:00:11 tom Exp @ --> <HTML> <HEAD> @@ -52,60 +52,135 @@ </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> + <STRONG>tic</STRONG> [<STRONG>-01CDGIKLNTUVacfgrstx</STRONG>] [<STRONG>-e</STRONG> <EM>names</EM>] [<STRONG>-o</STRONG> <EM>dir</EM>] [<STRONG>-R</STRONG> <EM>sub-</EM> + <EM>set</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 + The <STRONG>tic</STRONG> command 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>. + As described in <STRONG><A HREF="term.5.html">term(5)</A></STRONG>, the database may be either a + directory tree (one file per terminal entry) or a hashed + database (one record per entry). The <STRONG>tic</STRONG> command writes + only one type of entry, depending on how it was built: + + <STRONG>o</STRONG> For directory trees, the top-level directory, e.g., + /usr/share/terminfo, specifies the location of the + database. + + <STRONG>o</STRONG> For hashed databases, a filename is needed. If the + given file is not found by that name, but can be found + by adding the suffix ".db", then that is used. + + The default name for the hashed database is the same + as the default directory name (only adding a ".db" + suffix). + + In either case (directory or hashed database), <STRONG>tic</STRONG> will + create the container if it does not exist. For a direc- + tory, this would be the "terminfo" leaf, versus a "ter- + minfo.db" file. + The results are normally placed in the system terminfo - directory <STRONG>/usr/share/terminfo</STRONG>. There are two ways to - change this behavior. + database <STRONG>/usr/share/terminfo</STRONG>. The compiled terminal + description can be placed in a different terminfo data- + base. There are two ways to achieve this: - First, you may override the system default by setting the - variable <STRONG>TERMINFO</STRONG> in your shell environment to a valid - (existing) directory name. + <STRONG>o</STRONG> First, you may override the system default either by + using the <STRONG>-o</STRONG> option, or by setting the variable <STRONG>TER-</STRONG> + <STRONG>MINFO</STRONG> in your shell environment to a valid database + location. - 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. + <STRONG>o</STRONG> Secondly, if <STRONG>tic</STRONG> cannot write in <EM>/usr/share/terminfo</EM> + or the location specified using your TERMINFO vari- + able, it looks for the directory <EM>$HOME/.terminfo</EM> (or + hashed database <EM>$HOME/.terminfo.db)</EM>; if that location + 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>. + in succession + + <STRONG>o</STRONG> a location specified with the TERMINFO environment + variable, + + <STRONG>o</STRONG> <EM>$HOME/.terminfo</EM>, + + <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS environment + variable, + + <STRONG>o</STRONG> a compiled-in list of directories + (/usr/local/ncurses/share/terminfo:/usr/share/ter- + minfo), and + + <STRONG>o</STRONG> the system terminfo database (<EM>/usr/share/terminfo</EM>). + + <STRONG>OPTIONS</STRONG> + <STRONG>-0</STRONG> restricts the output to a single line <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 + 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 + <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 + 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. + left in the entry under their terminfo names but + commented out with two preceding dots. The actual + format used incorporates some improvements for + escaped characters from terminfo format. For a + stricter BSD-compatible translation, add the <STRONG>-K</STRONG> + option. + + If this is combined with <STRONG>-c</STRONG>, <STRONG>tic</STRONG> makes additional + checks to report cases where the terminfo values do + not have an exact equivalent in termcap form. For + example: + + <STRONG>o</STRONG> <STRONG>sgr</STRONG> usually will not convert, because termcap + lacks the ability to work with more than two + parameters, and because termcap lacks many of + the arithmetic/logical operators used in ter- + minfo. + + <STRONG>o</STRONG> capabilities with more than one delay or with + delays before the end of the string will not + convert completely. <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. + buffer length in older termcap libraries, as well + as buggy checking for the buffer length (and a doc- + umented limit in terminfo), these entries may cause + core dumps with other implementations. + + <STRONG>tic</STRONG> checks string capabilities to ensure that those + with parameters will be valid expressions. It does + this check only for the predefined string capabili- + ties; those which are defined with the <STRONG>-x</STRONG> option + are ignored. + + <STRONG>-D</STRONG> tells <STRONG>tic</STRONG> to print the database locations that it + knows about, and exit. The first location shown is + the one to which it would write compiled terminal + descriptions. If <STRONG>tic</STRONG> is not able to find a + writable database location according to the rules + summarized above, it will print a diagnostic and + exit with an error rather than printing a list of + database locations. <STRONG>-e</STRONG> <EM>names</EM> Limit writes and translations to the following @@ -130,128 +205,133 @@ <STRONG>-I</STRONG> Force source translation to terminfo format. - <STRONG>-L</STRONG> Force source translation to terminfo format using + <STRONG>-K</STRONG> Suppress some longstanding ncurses extensions to + termcap format, e.g., "\s" for space. + + <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 + 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 + 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>-o</STRONG><EM>dir</EM> Write compiled entries to given database location. + Overrides 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 + 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- + 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 + 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>-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 pre- + paring 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 multiple 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>-s</STRONG> Summarize the compile by showing the database loca- + tion 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., + 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. + <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- + <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 + <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. + The debug flag levels are as follows: - <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. + 1 Names of files created and linked + + 2 Information related to the "use" facility - <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. + 3 Statistics from the hashing algorithm - The debug flag levels are as follows: + 5 String-table memory allocations - 1 Names of files created and linked + 7 Entries into the string-table - 2 Information related to the ``use'' facility + 8 List of tokens encountered by scanner - 3 Statistics from the hashing algorithm + 9 All values computed in construction of the + hash table - 5 String-table memory allocations + If the debug level <EM>n</EM> is not given, it is taken to be + one. - 7 Entries into the string-table + <STRONG>-w</STRONG><EM>n</EM> specifies the width of the output. The parameter is + optional. If it is omitted, it defaults to 60. - 8 List of tokens encountered by scanner + <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. - 9 All values computed in construction of the hash ta- - ble + <STRONG>PARAMETERS</STRONG> + <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 descrip- + tion in the file describes the capabilities of a + particular terminal. - If the debug level <EM>n</EM> is not given, it is taken to be one. + If <EM>file</EM> is "-", then the data is read from the + standard input. The <EM>file</EM> parameter may also be the + path of a character-device. + <STRONG>PROCESSING</STRONG> 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 + 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. <STRONG>tic</STRONG> duplicates the + capabilities 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> + 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 @@ -266,35 +346,35 @@ 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. + 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> + Unlike the SVr4 <STRONG>tic</STRONG> command, this implementation can actu- + ally compile termcap sources. In fact, entries in ter- + minfo 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. + 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> database (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 + 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. + The <STRONG>-0</STRONG>, <STRONG>-1</STRONG>, <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- + System V does not compile entries to or read entries from + your <EM>$HOME/.terminfo</EM> database unless TERMINFO is explic- itly set to it. @@ -306,10 +386,10 @@ </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>. + <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="term.5.html">term(5)</A></STRONG>. <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. - This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). </PRE> @@ -322,9 +402,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/toe.1m.html b/doc/html/man/toe.1m.html index 925d390..3404f25 100644 --- a/doc/html/man/toe.1m.html +++ b/doc/html/man/toe.1m.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: toe.1m,v 1.26 2012/01/01 00:40:51 tom Exp @ --> <HTML> <HEAD> @@ -52,7 +52,7 @@ </PRE> <H2>SYNOPSIS</H2><PRE> - <STRONG>toe</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahuUV</STRONG>] <EM>file...</EM> + <STRONG>toe</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahsuUV</STRONG>] <EM>file...</EM> </PRE> @@ -71,6 +71,14 @@ ncurses would search, rather than only the first one that it finds. + If the <STRONG>-s</STRONG> is also given, <STRONG>toe</STRONG> adds a column to the + report, showing (like <STRONG>conflict(1)</STRONG>) which entries + which belong to a given terminal database. An "*" + marks entries which differ, and "+" marks equiva- + lent entries. + + <STRONG>-s</STRONG> sort the output by the entry names. + <STRONG>-u</STRONG> <EM>file</EM> says to write a report to the standard output, listing dependencies in the given terminfo/termcap @@ -111,16 +119,13 @@ <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.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/tput.1.html b/doc/html/man/tput.1.html index c04914f..17eccfe 100644 --- a/doc/html/man/tput.1.html +++ b/doc/html/man/tput.1.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2011,2012 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 * @@ -28,7 +28,7 @@ * 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 @ + * @Id: tput.1,v 1.32 2012/07/14 21:06:45 tom Exp @ --> <HTML> <HEAD> @@ -66,7 +66,7 @@ <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 + available to the shell (see <STRONG>sh(1)</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: @@ -87,7 +87,7 @@ 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>sh(1)</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>. @@ -95,54 +95,53 @@ 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. + will also be ignored. <EM>capname</EM> - indicates the capability from the <STRONG>terminfo</STRONG> - database. When <STRONG>termcap</STRONG> support is compiled in, the + indicates the capability from the <STRONG>terminfo</STRONG> data- + base. 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- + <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 + 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. + <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. + writes the string without performing the substitu- + tion. - <STRONG>-S</STRONG> allows more than one capability per invocation of + <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 + (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> + 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 + <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 + <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> + (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 + (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 + (3) tabs expansion will be turned on or off according to the specification in the entry, and @@ -153,22 +152,22 @@ 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> 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), + 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 + 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. @@ -177,13 +176,13 @@ <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 + 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. + illustrated on the <STRONG>profile(5)</STRONG> manual page. <STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG> - Reset an AT&T 5620 terminal, overriding the type of + 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> @@ -263,29 +262,29 @@ type of <EM>capname</EM>: <EM>boolean</EM> - a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE. + 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> + <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 + 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 + 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- + 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 + 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 + <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- + Any other exit code indicates an error; see the DIAGNOS- TICS section. @@ -294,11 +293,10 @@ <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>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 @@ -310,34 +308,43 @@ </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 + 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> + 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. + such as AIX and Tru64 provide support for <EM>capname</EM> oper- + ands. + + A few platforms such as FreeBSD and NetBSD recognize term- + cap names rather than terminfo capability names in their + respective <STRONG>tput</STRONG> commands. + + Most implementations which provide support for <EM>capname</EM> op- + erands use the <EM>tparm</EM> function to expand parameters in it. + That function expects a mixture of numeric and string + parameters, requiring <STRONG>tput</STRONG> to know which type to use. + This implementation uses a table to determine that for the + standard <EM>capname</EM> operands, and an internal library func- + tion to analyze nonstandard <EM>capname</EM> operands. Other + implementations may simply guess that an operand contain- + ing only digits is intended to be a number. </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>. + <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG>stty(1)</STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>. - This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/tset.1.html b/doc/html/man/tset.1.html index 2b86f9f..5852c79 100644 --- a/doc/html/man/tset.1.html +++ b/doc/html/man/tset.1.html @@ -1,7 +1,7 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2011,2013 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 * @@ -27,7 +27,7 @@ * 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 @ + * @Id: tset.1,v 1.29 2013/12/21 22:15:53 tom Exp @ --> <HTML> <HEAD> @@ -74,14 +74,14 @@ 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''. + 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, + ("?"), the user is prompted for confirmation of the termi- + nal 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 @@ -116,8 +116,9 @@ 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>-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. @@ -126,36 +127,35 @@ <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. + <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 + <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 + 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. + <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. + 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>-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''. + entered as actual characters or by using the `hat' nota- + tion, i.e., control-h may be specified as "^H" or "^h". </PRE> @@ -167,7 +167,7 @@ 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 + 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 @@ -187,21 +187,21 @@ 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 + 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''. + 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 + 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. + 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 @@ -232,8 +232,8 @@ 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 (``!''). + insert a backslash character ("\") before any exclamation + marks ("!"). </PRE> @@ -248,14 +248,14 @@ <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 + <STRONG>/etc/inittab</STRONG> and <STRONG>getty(1)</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>TERM</STRONG>, not <STRONG>TERMCAP</STRONG>. Both of 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). @@ -316,19 +316,16 @@ </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> + <STRONG>csh(1)</STRONG>, <STRONG>sh(1)</STRONG>, <STRONG>stty(1)</STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG>tty(4)</STRONG>, + <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG>ttys(5)</STRONG>, <STRONG>environ(7)</STRONG> - This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20110404). + This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220). <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> diff --git a/doc/html/man/wresize.3x.html b/doc/html/man/wresize.3x.html index dff5834..7c2dff5 100644 --- a/doc/html/man/wresize.3x.html +++ b/doc/html/man/wresize.3x.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * @@ -100,9 +100,6 @@ <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> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> |