diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man')
107 files changed, 17192 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/captoinfo.1m.html b/ncurses-5.2/doc/html/man/captoinfo.1m.html new file mode 100644 index 0000000..806aec5 --- /dev/null +++ b/ncurses-5.2/doc/html/man/captoinfo.1m.html @@ -0,0 +1,190 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>captoinfo</B> - convert a <I>termcap</I> description into a <I>terminfo</I> + description + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>captoinfo</B> [<B>-v</B><I>n</I> <I>width</I>] [<B>-V</B>] [<B>-1</B>] [<B>-w</B> <I>width</I>] <I>file</I> . . . + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>captoinfo</B> looks in <I>file</I> for <B>termcap</B> descriptions. For + each one found, an equivalent <B>terminfo</B> description is + written to standard output. Termcap <B>tc</B> capabilities are + translated directly to terminfo <B>use</B> capabilities. + + If no <I>file</I> is given, then the environment variable <B>TERMCAP</B> + is used for the filename or entry. If <B>TERMCAP</B> is a full + pathname to a file, only the terminal whose name is + specified in the environment variable <B>TERM</B> is extracted + from that file. If the environment variable <B>TERMCAP</B> is + not set, then the file <B>/usr/share/terminfo</B> is read. + + <B>-v</B> print out tracing information on standard error as + the program runs. + + <B>-V</B> print out the version of the program in use on + standard error and exit. + + <B>-1</B> cause the fields to print out one to a line. + Otherwise, the fields will be printed several to a + line to a maximum width of 60 characters. + + <B>-w</B> change the output to <I>width</I> characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo Compiled terminal description + database. + + +</PRE> +<H2>TRANSLATIONS FROM NONSTANDARD CAPABILITIES</H2><PRE> + Some obsolete nonstandard capabilities will automatically + be translated into standard (SVr4/XSI Curses) terminfo + capabilities by <B>captoinfo</B>. Whenever one of these + automatic translations is done, the program will issue an + notification to stderr, inviting the user to check that it + has not mistakenly translated a completely unknown and + random capability and/or syntax error. + + Nonstd Std From Terminfo + name name capability + ----------------------------------------------- + BO mr AT&T enter_reverse_mode + CI vi AT&T cursor_invisible + CV ve AT&T cursor_normal + DS mh AT&T enter_dim_mode + EE me AT&T exit_attribute_mode + + FE LF AT&T label_on + FL LO AT&T label_off + XS mk AT&T enter_secure_mode + EN @7 XENIX key_end + GE ae XENIX exit_alt_charset_mode + GS as XENIX enter_alt_charset_mode + HM kh XENIX key_home + LD kL XENIX key_dl + PD kN XENIX key_npage + PN po XENIX prtr_off + PS pf XENIX prtr_on + PU kP XENIX key_ppage + RT @8 XENIX kent + UP ku XENIX kcuu1 + KA k; Tek key_f10 + KB F1 Tek key_f11 + KC F2 Tek key_f12 + KD F3 Tek key_f13 + KE F4 Tek key_f14 + KF F5 Tek key_f15 + BC Sb Tek set_background + FC Sf Tek set_foreground + HS mh Iris enter_dim_mode + + XENIX termcap also used to have a set of extension + capabilities for forms drawing, designed to take advantage + of the IBM PC high-half graphics. They were as follows: + + Cap Graphic + ----------------------------- + G2 upper left + G3 lower left + G1 upper right + G4 lower right + GR pointing right + GL pointing left + GU pointing up + GD pointing down + GH horizontal line + GV vertical line + GC intersection + G6 upper left + G7 lower left + G5 upper right + G8 lower right + Gr tee pointing right + Gr tee pointing left + Gu tee pointing up + Gd tee pointing down + Gh horizontal line + Gv vertical line + Gc intersection + GG acs magic cookie count + + If the single-line capabilities occur in an entry, they + will automatically be composed into an <B>acsc</B> string. The + double-line capabilities and <B>GG</B> are discarded with a + warning message. + + IBM's AIX has a terminfo facility descended from SVr1 + terminfo but incompatible with the SVr4 format. The + following AIX extensions are automatically translated: + + IBM XSI + ------------- + ksel kslt + kbtab kcbt + font0 s0ds + font1 s1ds + font2 s2ds + font3 s3ds + + Additionally, the AIX <B>box1</B> capability will be + automatically translated to an <B>acsc</B> string. + + Hewlett-Packard's terminfo library supports two + nonstandard terminfo capabilities <B>meml</B> (memory lock) and + <B>memu</B> (memory unlock). These will be discarded with a + warning message. + + +</PRE> +<H2>NOTES</H2><PRE> + This utility is actually a link to <B><A HREF="tic.1m.html">tic(1m)</A></B>, running in <I>-I</I> + mode. You can use other <I>tic</I> options such as <B>-f</B> and <B>-x</B>. + + The trace option isn't identical to SVr4's. Under SVr4, + instead of following the -v with a trace level n, you + repeat it n times. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B> + + +</PRE> +<H2>AUTHOR</H2><PRE> + Eric S. Raymond <esr@snark.thyrsus.com> + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/clear.1.html b/ncurses-5.2/doc/html/man/clear.1.html new file mode 100644 index 0000000..fad1c20 --- /dev/null +++ b/ncurses-5.2/doc/html/man/clear.1.html @@ -0,0 +1,74 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>clear</B> - clear the terminal screen + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>clear</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>clear</B> clears your screen if this is possible. It looks in + the environment for the terminal type and then in the <B>ter-</B> + <B>minfo</B> database to figure out how to clear the screen. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="tput.1.html">tput(1)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_addch.3x.html b/ncurses-5.2/doc/html/man/curs_addch.3x.html new file mode 100644 index 0000000..74fdef6 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_addch.3x.html @@ -0,0 +1,189 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>addch</B>, <B>waddch</B>, <B>mvaddch</B>, <B>mvwaddch</B>, <B>echochar</B>, <B>wechochar</B> - + add a character (with attributes) to a <B>curses</B> window, then + advance the cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>addch(chtype</B> <B>ch);</B> + <B>int</B> <B>waddch(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>mvaddch(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>mvwaddch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>echochar(chtype</B> <B>ch);</B> + <B>int</B> <B>wechochar(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>addch</B>, <B>waddch</B>, <B>mvaddch</B> and <B>mvwaddch</B> routines put the + character <I>ch</I> into the given window at its current window + position, which is then advanced. They are analogous to + <B>putchar</B> in <B><A HREF="stdio.3.html">stdio(3)</A></B>. 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 <B>scrollok</B> is enabled, the scrolling region is + scrolled up one line. + + If <I>ch</I> 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 <B>clrtoeol</B>, 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. + + If <I>ch</I> is any control character other than tab, newline, or + backspace, it is drawn in <B>^</B><I>X</I> notation. Calling <B>winch</B> + after adding a control character does not return the char- + acter itself, but instead returns the ^-representation of + the control character. + + Video attributes can be combined with a character argument + passed to <B>addch</B> or related functions by logical-ORing them + into the character. (Thus, text, including attributes, + can be copied from one place to another using <B>inch</B> and + <B>addch</B>.). See the <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> page for values of prede- + fined video attribute constants that can be usefully OR'ed + into characters. + + The <B>echochar</B> and <B>wechochar</B> routines are equivalent to a + call to <B>addch</B> followed by a call to <B>refresh</B>, or a call to + <B>waddch</B> followed by a call to <B>wrefresh</B>. The knowledge that + only a single character is being output is used and, for + non-control characters, a considerable performance gain + may be seen by using these routines instead of their + equivalents. + + <B>Line</B> <B>Graphics</B> + The following variables may be used to add line drawing + characters to the screen with routines of the <B>addch</B> fam- + ily. The default character listed below is used if the + <B>acsc</B> capability doesn't define a terminal-specific + replacement for it (but see the EXTENSIONS section below). + The names are taken from VT100 nomenclature. + + <I>Name</I> <I>Default</I> <I>Description</I> + -------------------------------------------------- + ACS_BLOCK # solid square block + ACS_BOARD # board of squares + ACS_BTEE + bottom tee + ACS_BULLET o bullet + ACS_CKBOARD : checker board (stipple) + ACS_DARROW v arrow pointing down + ACS_DEGREE ' degree symbol + ACS_DIAMOND + diamond + ACS_GEQUAL > greater-than-or-equal-to + ACS_HLINE - horizontal line + ACS_LANTERN # lantern symbol + ACS_LARROW < arrow pointing left + ACS_LEQUAL < less-than-or-equal-to + ACS_LLCORNER + lower left-hand corner + ACS_LRCORNER + lower right-hand corner + ACS_LTEE + left tee + ACS_NEQUAL ! not-equal + ACS_PI * greek pi + ACS_PLMINUS # plus/minus + ACS_PLUS + plus + ACS_RARROW > arrow pointing right + ACS_RTEE + right tee + ACS_S1 - scan line 1 + ACS_S3 - scan line 3 + ACS_S7 - scan line 7 + ACS_S9 _ scan line 9 + ACS_STERLING f pound-sterling symbol + ACS_TTEE + top tee + ACS_UARROW ^ arrow pointing up + ACS_ULCORNER + upper left-hand corner + ACS_URCORNER + upper right-hand corner + ACS_VLINE | vertical line + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and <B>OK</B> on + success (the SVr4 manuals specify only "an integer value + other than <B>ERR</B>") upon successful completion, unless other- + wise noted in the preceding routine descriptions. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>addch</B>, <B>mvaddch</B>, <B>mvwaddch</B>, and <B>echochar</B> may be + macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these functions are described in the XSI Curses stan- + dard, Issue 4. The defaults specified for forms-drawing + characters apply in the POSIX locale. + + Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL, ACS_GEQUAL, + ACS_PI, ACS_NEQUAL, ACS_STERLING) were not documented in + any publicly released System V. However, many publicly + available terminfos include <B>acsc</B> strings in which their + key characters (pryz{|}) are embedded, and a second-hand + list of their character descriptions has come to light. + The ACS-prefixed names for them were invented for + <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B>, <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B>, <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>, + <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, <B><A HREF="putc.3S.html">putc(3S)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_addchstr.3x.html b/ncurses-5.2/doc/html/man/curs_addchstr.3x.html new file mode 100644 index 0000000..43f244d --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_addchstr.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>addchstr</B>, <B>addchnstr</B>, <B>waddchstr</B>, <B>waddchnstr</B>, <B>mvaddchstr</B>, + <B>mvaddchnstr</B>, <B>mvwaddchstr</B>, <B>mvwaddchnstr</B> - add a string of + characters (and attributes) to a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>addchstr(const</B> <B>chtype</B> <B>*chstr);</B> + <B>int</B> <B>addchnstr(const</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>waddchstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>*chstr);</B> + <B>int</B> <B>waddchnstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvaddchstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B> <B>*chstr);</B> + <B>int</B> <B>mvaddchnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwaddchstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B> + <B>*chstr);</B> + <B>int</B> <B>mvwaddchnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B> + <B>*chstr,</B> <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines copy <I>chstr</I> into the window image structure + at and after the current cursor position. The four rou- + tines with <I>n</I> as the last argument copy at most <I>n</I> elements, + but no more than will fit on the line. If <B>n</B>=<B>-1</B> then the + whole string is copied, to the maximum number of charac- + ters that will fit on the line. + + The window cursor is <I>not</I> advanced, and these routines work + faster than <B>waddnstr</B>. On the other hand, they don't per- + form any kind of checking (such as for the newline, + backspace, or carriage return characters), they don't + advance the current cursor position, they don't expand + other control characters to ^-escapes, and they truncate + the string if it crosses the right margin, rather then + wrapping it around to the new line. + + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and <B>OK</B> on + success (the SVr4 manuals specify only "an integer value + other than <B>ERR</B>") upon successful completion, unless other- + wise noted in the preceding routine descriptions. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <B>waddchnstr</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these entry points are described in the XSI Curses + standard, Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_addstr.3x.html b/ncurses-5.2/doc/html/man/curs_addstr.3x.html new file mode 100644 index 0000000..e83e795 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_addstr.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>addstr</B>, <B>addnstr</B>, <B>waddstr</B>, <B>waddnstr</B>, <B>mvaddstr</B>, <B>mvaddnstr</B>, + <B>mvwaddstr</B>, <B>mvwaddnstr</B> - add a string of characters to a + <B>curses</B> window and advance cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>addstr(const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>addnstr(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>waddstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>waddnstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvaddstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvaddnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwaddstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvwaddnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B> + <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines write the characters of the (null-termi- + nated) character string <I>str</I> on the given window. It is + similar to calling <B>waddch</B> once for each character in the + string. The four routines with <I>n</I> as the last argument + write at most <I>n</I> characters. If <I>n</I> is -1, then the entire + string will be added. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and <B>OK</B> on + success (the SVr4 manuals specify only "an integer value + other than <B>ERR</B>") upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all of these routines except <B>waddstr</B> and + <B>waddnstr</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these entry points are described in the XSI Curses + standard, Issue 4. The XSI errors EILSEQ and EOVERFLOW, + associated with extended-level conformance, are not yet + detected. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>. + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_attr.3x.html b/ncurses-5.2/doc/html/man/curs_attr.3x.html new file mode 100644 index 0000000..6c2df3d --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_attr.3x.html @@ -0,0 +1,186 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>attroff</B>, <B>wattroff</B>, <B>attron</B>, <B>wattron</B>, <B>attrset</B>, <B>wattrset</B>, + <B>color_set</B>, <B>wcolor_set</B>, <B>standend</B>, <B>wstandend</B>, <B>standout</B>, + <B>wstandout</B>, <B>attr_get</B>, <B>wattr_get</B>, <B>attr_off</B>, <B>wattr_off</B>, + <B>attr_on</B>, <B>wattr_on</B>, <B>attr_set</B>, <B>wattr_set</B>, <B>chgat</B>, <B>wchgat</B>, + <B>mvchgat</B>, <B>mvwchgat</B>, <B>PAIR_NUMBER</B> - <B>curses</B> character and win- + dow attribute control routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>int</B> <B>attroff(int</B> <B>attrs);</B> + <B>int</B> <B>wattroff(WINDOW</B> <B>*win,</B> <B>int</B> <B>attrs);</B> + <B>int</B> <B>attron(int</B> <B>attrs);</B> + <B>int</B> <B>wattron(WINDOW</B> <B>*win,</B> <B>int</B> <B>attrs);</B> + <B>int</B> <B>attrset(int</B> <B>attrs);</B> + <B>int</B> <B>wattrset(WINDOW</B> <B>*win,</B> <B>int</B> <B>attrs);</B> + <B>int</B> <B>color_set(short</B> <B>color_pair_number,</B> <B>void*</B> <B>opts);</B> + <B>int</B> <B>wcolor_set(WINDOW</B> <B>*win,</B> <B>short</B> <B>color_pair_number,</B> + <B>void*</B> <B>opts);</B> + <B>int</B> <B>standend(void);</B> + <B>int</B> <B>wstandend(WINDOW</B> <B>*win);</B> + <B>int</B> <B>standout(void);</B> + <B>int</B> <B>wstandout(WINDOW</B> <B>*win);</B> + <B>int</B> <B>attr_get(attr_t</B> <B>*attrs,</B> <B>short</B> <B>*pair,</B> <B>void</B> <B>*opts);</B> + <B>int</B> <B>wattr_get(WINDOW</B> <B>*win,</B> <B>attr_t</B> <B>*attrs,</B> <B>short</B> <B>*pair,</B> + <B>void</B> <B>*opts);</B> + <B>int</B> <B>attr_off(attr_t</B> <B>attrs,</B> <B>void</B> <B>*opts);</B> + <B>int</B> <B>wattr_off(WINDOW</B> <B>*win,</B> <B>attr_t</B> <B>attrs,</B> <B>void</B> <B>*opts);</B> + <B>int</B> <B>attr_on(attr_t</B> <B>attrs,</B> <B>void</B> <B>*opts);</B> + <B>int</B> <B>wattr_on(WINDOW</B> <B>*win,</B> <B>attr_t</B> <B>attrs,</B> <B>void</B> <B>*opts);</B> + <B>int</B> <B>attr_set(attr_t</B> <B>attrs,</B> <B>short</B> <B>pair,</B> <B>void</B> <B>*opts);</B> + <B>int</B> <B>wattr_set(WINDOW</B> <B>*win,</B> <B>attr_t</B> <B>attrs,</B> <B>short</B> <B>pair,</B> <B>void</B> + <B>*opts);</B> + <B>int</B> <B>chgat(int</B> <B>n,</B> <B>attr_t</B> <B>attr,</B> <B>short</B> <B>color,</B> + <B>const</B> <B>void</B> <B>*opts)</B> + <B>int</B> <B>wchgat(WINDOW</B> <B>*win,</B> <B>int</B> <B>n,</B> <B>attr_t</B> <B>attr,</B> + <B>short</B> <B>color,</B> <B>const</B> <B>void</B> <B>*opts)</B> + <B>int</B> <B>mvchgat(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>int</B> <B>n,</B> <B>attr_t</B> <B>attr,</B> + <B>short</B> <B>color,</B> <B>const</B> <B>void</B> <B>*opts)</B> + <B>int</B> <B>mvwchgat(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>int</B> <B>n,</B> + <B>attr_t</B> <B>attr,</B> <B>short</B> <B>color,</B> <B>const</B> <B>void</B> <B>*opts)</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines manipulate the current attributes of the + named window. The current attributes of a window apply to + all characters that are written into the window with <B>wad-</B> + <B>dch</B>, <B>waddstr</B> and <B>wprintw</B>. Attributes are a property of + the character, and move with the character through any + scrolling and insert/delete line/character operations. To + the extent possible, they are displayed as appropriate + modifications to the graphic rendition of characters put + on the screen. + + The routine <B>attrset</B> sets the current attributes of the + given window to <I>attrs</I>. The routine <B>attroff</B> turns off the + named attributes without turning any other attributes on + or off. The routine <B>attron</B> turns on the named attributes + without affecting any others. The routine <B>standout</B> is the + same as <B>attron(A_STANDOUT)</B>. The routine <B>standend</B> is the + same as <B>attrset(A_NORMAL)</B> or <B>attrset(0)</B>, that is, it turns + off all attributes. + + The routine <B>color_set</B> sets the current color of the given + window to the foreground/background combination described + by the color_pair_number. The parameter opts is reserved + for future use, applications must supply a null pointer. + + The routine <B>wattr_get</B> returns the current attribute and + color pair for the given window; <B>attr_get</B> returns the cur- + rent attribute and color pair for <B>stdscr</B>. The remaining + <B>attr_</B>* functions operate exactly like the corresponding + <B>attr</B>* functions, except that they take arguments of type + <B>attr_t</B> rather than <B>int</B>. + + The routine <B>chgat</B> changes the attributes of a given number + of characters starting at the current cursor location of + <B>stdscr</B>. It does not update the cursor and does not per- + form wrapping. A character count of -1 or greater than + the remaining window width means to change attributes all + the way to the end of the current line. The <B>wchgat</B> func- + tion generalizes this to any window; the <B>mvwchgat</B> function + does a cursor move before acting. In these functions, the + color argument is a color-pair index (as in the first + argument of <I>init</I><B>_</B><I>pair</I>, see <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B>). The <B>opts</B> + argument is not presently used, but is reserved for the + future (leave it <B>NULL</B>). + + <B>Attributes</B> + The following video attributes, defined in <B><curses.h></B>, can + be passed to the routines <B>attron</B>, <B>attroff</B>, and <B>attrset</B>, or + OR'ed with the characters passed to <B>addch</B>. + + <B>A_NORMAL</B> Normal display (no highlight) + <B>A_STANDOUT</B> Best highlighting mode of the terminal. + <B>A_UNDERLINE</B> Underlining + <B>A_REVERSE</B> Reverse video + <B>A_BLINK</B> Blinking + <B>A_DIM</B> Half bright + <B>A_BOLD</B> Extra bright or bold + <B>A_PROTECT</B> Protected mode + <B>A_INVIS</B> Invisible or blank mode + <B>A_ALTCHARSET</B> Alternate character set + <B>A_CHARTEXT</B> Bit-mask to extract a character + <B>COLOR_PAIR(</B><I>n</I><B>)</B> Color-pair number <I>n</I> + + The following macro is the reverse of <B>COLOR_PAIR(</B><I>n</I><B>)</B>: + + <B>PAIR_NUMBER(</B><I>attrs</I>) Returns the pair number associated + with the <B>COLOR_PAIR(</B><I>n</I><B>)</B> attribute. + + The return values of many of these routines are not mean- + ingful (they are implemented as macro-expanded assignments + and simply return their argument). The SVr4 manual page + claims (falsely) that these routines always return <B>1</B>. + + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>attroff</B>, <B>wattroff</B>, <B>attron</B>, <B>wattron</B>, <B>attrset</B>, + <B>wattrset</B>, <B>standend</B> and <B>standout</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + All these functions are supported in the XSI Curses stan- + dard, Issue 4. The standard defined the dedicated type + for highlights, <B>attr_t</B>, which is not defined in SVr4 + curses. The functions taking <B>attr_t</B> arguments are not sup- + ported under SVr4. + + The XSI Curses standard states that whether the tradi- + tional functions <B>attron</B>/<B>attroff</B>/<B>attrset</B> can manipulate + attributes other than <B>A_BLINK</B>, <B>A_BOLD</B>, <B>A_DIM</B>, <B>A_REVERSE</B>, + <B>A_STANDOUT</B>, or <B>A_UNDERLINE</B> is "unspecified". Under this + implementation as well as SVr4 curses, these functions + correctly manipulate all other highlights (specifically, + <B>A_ALTCHARSET</B>, <B>A_PROTECT</B>, and <B>A_INVIS</B>). + + XSI Curses added the new entry points, <B>attr_get</B>, <B>attr_on</B>, + <B>attr_off</B>, <B>attr_set</B>, <B>wattr_on</B>, <B>wattr_off</B>, <B>wattr_get</B>, + <B>wattr_set</B>. These are intended to work with a new series + of highlight macros prefixed with <B>WA_</B>. + + <B>WA_NORMAL</B> Normal display (no highlight) + <B>WA_STANDOUT</B> Best highlighting mode of the terminal. + <B>WA_UNDERLINE</B> Underlining + <B>WA_REVERSE</B> Reverse video + <B>WA_BLINK</B> Blinking + <B>WA_DIM</B> Half bright + <B>WA_BOLD</B> Extra bright or bold + <B>WA_ALTCHARSET</B> Alternate character set + + The XSI curses standard specifies that each pair of corre- + sponding <B>A_</B> and <B>WA_</B>-using functions operates on the same + current-highlight information. + + The XSI standard extended conformance level adds new high- + lights <B>A_HORIZONTAL</B>, <B>A_LEFT</B>, <B>A_LOW</B>, <B>A_RIGHT</B>, <B>A_TOP</B>, <B>A_VER-</B> + <B>TICAL</B> (and corresponding <B>WA_</B> macros for each) which this + curses does not yet support. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>, <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B>, + <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_beep.3x.html b/ncurses-5.2/doc/html/man/curs_beep.3x.html new file mode 100644 index 0000000..516cd68 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_beep.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>beep</B>, <B>flash</B> - <B>curses</B> bell and screen flash routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>beep(void);</B> + <B>int</B> <B>flash(void);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>beep</B> and <B>flash</B> routines are used to alert the terminal + user. The routine <B>beep</B> sounds an audible alarm on the + terminal, if possible; otherwise it flashes the screen + (visible bell). The routine <B>flash</B> flashes the screen, and + if that is not possible, sounds the alert. If neither + alert is possible, nothing happens. Nearly all terminals + have an audible alert (bell or beep), but only some can + flash the screen. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <B>OK</B> if they succeed in beeping or + flashing, <B>ERR</B> otherwise. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + SVr4's beep and flash routines always returned <B>OK</B>, so it + was not possible to tell when the beep or flash failed. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are defined in the XSI Curses standard, + Issue 4. Like SVr4, it specifies that they always return + <B>OK</B>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_bkgd.3x.html b/ncurses-5.2/doc/html/man/curs_bkgd.3x.html new file mode 100644 index 0000000..d498f46 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_bkgd.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>bkgdset</B>, <B>wbkgdset</B>, <B>bkgd</B>, <B>wbkgd</B>, <B>getbkgd</B> - <B>curses</B> window + background manipulation routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>void</B> <B>bkgdset(const</B> <B>chtype</B> <B>ch);</B> + <B>void</B> <B>wbkgdset(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>bkgd(const</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>wbkgd(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>ch);</B> + <B>chtype</B> <B>getbkgd(WINDOW</B> <B>*win);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>bkgdset</B> and <B>wbkgdset</B> routines manipulate the back- + ground of the named window. The window background is a + <B>chtype</B> consisting of any combination of attributes (i.e., + rendition) and a character. The attribute part of the + background is combined (OR'ed) with all non-blank charac- + ters that are written into the window with <B>waddch</B>. Both + the character and attribute parts of the background are + combined with the blank characters. The background + becomes a property of the character and moves with the + character through any scrolling and insert/delete + line/character operations. + + To the extent possible on a particular terminal, the + attribute part of the background is displayed as the + graphic rendition of the character put on the screen. + + The <B>bkgd</B> and <B>wbkgd</B> functions set the background property + of the current or specified window and then apply this + setting to every character position in that window: + + The rendition of every character on the screen is + changed to the new background rendition. + + Wherever the former background character appears, + it is changed to the new background character. + + The <B>getbkgd</B> function returns the given window's current + background character/attribute pair. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The routines <B>bkgd</B> and <B>wbkgd</B> return the integer <B>OK</B>. The + SVr4.0 manual says "or a non-negative integer if <B>immedok</B> + is set", but this appears to be an error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>bkgdset</B> and <B>bkgd</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The draft does not include <B>const</B> qualifiers on + the arguments. The standard specifies that <B>bkgd</B> and <B>wbkgd</B> + return <B>ERR</B>, on failure. but gives no failure conditions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_border.3x.html b/ncurses-5.2/doc/html/man/curs_border.3x.html new file mode 100644 index 0000000..44f6e43 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_border.3x.html @@ -0,0 +1,135 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>border</B>, <B>wborder</B>, <B>box</B>, <B>hline</B>, <B>whline</B>, <B>vline</B>, <B>wvline</B>, <B>mvh-</B> + <B>line</B>, <B>mvwhline</B>, <B>mvvline</B>, <B>mvwvline</B> - create <B>curses</B> borders, + horizontal and vertical lines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>int</B> <B>border(chtype</B> <B>ls,</B> <B>chtype</B> <B>rs,</B> <B>chtype</B> <B>ts,</B> <B>chtype</B> <B>bs,</B> + <B>chtype</B> <B>tl,</B> <B>chtype</B> <B>tr,</B> <B>chtype</B> <B>bl,</B> <B>chtype</B> <B>br);</B> + <B>int</B> <B>wborder(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ls,</B> <B>chtype</B> <B>rs,</B> + <B>chtype</B> <B>ts,</B> <B>chtype</B> <B>bs,</B> <B>chtype</B> <B>tl,</B> <B>chtype</B> <B>tr,</B> + <B>chtype</B> <B>bl,</B> <B>chtype</B> <B>br);</B> + <B>int</B> <B>box(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>verch,</B> <B>chtype</B> <B>horch);</B> + <B>int</B> <B>hline(chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>whline(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>vline(chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>wvline(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>mvhline(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>mvwhline(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvvline(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwvline(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>border</B>, <B>wborder</B> and <B>box</B> routines draw a box around the + edges of a window. The argument <I>ls</I> is a character and + attributes used for the left side of the border, <I>rs</I> - + right side, <I>ts</I> - top side, <I>bs</I> - bottom side, <I>tl</I> - top + left-hand corner, <I>tr</I> - top right-hand corner, <I>bl</I> - bottom + left-hand corner, and <I>br</I> - bottom right-hand corner. If + any of these arguments is zero, then the following default + values (defined in <B>curses.h</B>) are used instead: <B>ACS_VLINE</B>, + <B>ACS_VLINE</B>, <B>ACS_HLINE</B>, <B>ACS_HLINE</B>, <B>ACS_ULCORNER</B>, + <B>ACS_URCORNER</B>, <B>ACS_LLCORNER</B>, <B>ACS_LRCORNER</B>. + + <B>box(</B><I>win</I><B>,</B> <I>verch</I><B>,</B> <I>horch</I><B>)</B> is a shorthand for the following + call: <B>wborder(</B><I>win</I><B>,</B> <I>verch</I><B>,</B> <I>verch</I><B>,</B> <I>horch</I><B>,</B> <I>horch</I><B>,</B> <B>0,</B> <B>0,</B> <B>0,</B> + <B>0)</B>. + + The <B>hline</B> and <B>whline</B> functions draw a horizontal (left to + right) line using <I>ch</I> starting at the current cursor posi- + tion in the window. The current cursor position is not + changed. The line is at most <I>n</I> characters long, or as + many as fit into the window. + + The <B>vline</B> and <B>wvline</B> functions draw a vertical (top to + bottom) line using <I>ch</I> starting at the current cursor posi- + tion in the window. The current cursor position is not + changed. The line is at most <I>n</I> characters long, or as + many as fit into the window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>OK</B>. The SVr4.0 manual + says "or a non-negative integer if <B>immedok</B> is set", but + this appears to be an error. + + +</PRE> +<H2>NOTES</H2><PRE> + The borders generated by these functions are <I>inside</I> bor- + ders (this is also true of SVr4 curses, though the fact is + not documented). + + Note that <B>border</B> and <B>box</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. Additional functions <B>mvhline</B>, <B>mvvline</B>, <B>mvwhline</B>, + and <B>mvwvline</B> are described there which this implementation + does not yet support. The standard specifies that they + return <B>ERR</B> on failure, but specifies no error conditions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_clear.3x.html b/ncurses-5.2/doc/html/man/curs_clear.3x.html new file mode 100644 index 0000000..1a874f2 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_clear.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>erase</B>, <B>werase</B>, <B>clear</B>, <B>wclear</B>, <B>clrtobot</B>, <B>wclrtobot</B>, <B>clr-</B> + <B>toeol</B>, <B>wclrtoeol</B> - clear all or part of a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#</B> <B>include</B> <B><curses.h></B> + + <B>int</B> <B>erase(void);</B> + <B>int</B> <B>werase(WINDOW</B> <B>*win);</B> + <B>int</B> <B>clear(void);</B> + <B>int</B> <B>wclear(WINDOW</B> <B>*win);</B> + <B>int</B> <B>clrtobot(void);</B> + <B>int</B> <B>wclrtobot(WINDOW</B> <B>*win);</B> + <B>int</B> <B>clrtoeol(void);</B> + <B>int</B> <B>wclrtoeol(WINDOW</B> <B>*win);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>erase</B> and <B>werase</B> routines copy blanks to every posi- + tion in the window, clearing the screen. + + The <B>clear</B> and <B>wclear</B> routines are like <B>erase</B> and <B>werase</B>, + but they also call <B>clearok</B>, so that the screen is cleared + completely on the next call to <B>wrefresh</B> for that window + and repainted from scratch. + + The <B>clrtobot</B> and <B>wclrtobot</B> routines erase from the cursor + to the end of screen. That is, they erase all lines below + the cursor in the window. Also, the current line to the + right of the cursor, inclusive, is erased. + + The <B>clrtoeol</B> and <B>wclrtoeol</B> routines erase the current line + to the right of the cursor, inclusive, to the end of the + current line. + + Blanks created by erasure have the current background ren- + dition (as set by <B>wbkgdset</B>) merged into them. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>OK</B>. The SVr4.0 manual + says "or a non-negative integer if <B>immedok</B> is set", but + this appears to be an error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>erase</B>, <B>werase</B>, <B>clear</B>, <B>wclear</B>, <B>clrtobot</B>, and <B>clr-</B> + <B>toeol</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <B>ERR</B> on + failure, but specifies no error conditions. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B> or + <B>clear(stdscr)</B>. This will not work under ncurses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_color.3x.html b/ncurses-5.2/doc/html/man/curs_color.3x.html new file mode 100644 index 0000000..b24a83c --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_color.3x.html @@ -0,0 +1,242 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>start_color</B>, <B>init_pair</B>, <B>init_color</B>, <B>has_colors</B>, + <B>can_change_color</B>, <B>color_content</B>, <B>pair_content</B>, <B>COLOR_PAIR</B> + - <B>curses</B> color manipulation routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#</B> <B>include</B> <B><curses.h></B> + <B>int</B> <B>start_color(void);</B> + <B>int</B> <B>init_pair(short</B> <B>pair,</B> <B>short</B> <B>f,</B> <B>short</B> <B>b);</B> + <B>int</B> <B>init_color(short</B> <B>color,</B> <B>short</B> <B>r,</B> <B>short</B> <B>g,</B> <B>short</B> <B>b);</B> + <B>bool</B> <B>has_colors(void);</B> + <B>bool</B> <B>can_change_color(void);</B> + <B>int</B> <B>color_content(short</B> <B>color,</B> <B>short</B> <B>*r,</B> <B>short</B> <B>*g,</B> <B>short</B> + <B>*b);</B> + <B>int</B> <B>pair_content(short</B> <B>pair,</B> <B>short</B> <B>*f,</B> <B>short</B> <B>*b);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>Overview</B> + <B>curses</B> support color attributes on terminals with that + capability. To use these routines <B>start_color</B> must be + called, usually right after <B>initscr</B>. Colors are always + used in pairs (referred to as color-pairs). A color-pair + consists of a foreground color (for characters) and a + background color (for the blank field on which the charac- + ters are displayed). A programmer initializes a color- + pair with the routine <B>init_pair</B>. After it has been ini- + tialized, <B>COLOR_PAIR</B>(<I>n</I>), a macro defined in <B><curses.h></B>, + can be used as a new video attribute. + + If a terminal is capable of redefining colors, the pro- + grammer can use the routine <B>init_color</B> to change the defi- + nition of a color. The routines <B>has_colors</B> and + <B>can_change_color</B> return <B>TRUE</B> or <B>FALSE</B>, depending on + whether the terminal has color capabilities and whether + the programmer can change the colors. The routine + <B>color_content</B> allows a programmer to extract the amounts + of red, green, and blue components in an initialized + color. The routine <B>pair_content</B> allows a programmer to + find out how a given color-pair is currently defined. + + <B>Routine</B> <B>Descriptions</B> + The <B>start_color</B> routine requires no arguments. It must be + called if the programmer wants to use colors, and before + any other color manipulation routine is called. It is + good practice to call this routine right after <B>initscr</B>. + <B>start_color</B> initializes eight basic colors (black, red, + green, yellow, blue, magenta, cyan, and white), and two + global variables, <B>COLORS</B> and <B>COLOR_PAIRS</B> (respectively + defining the maximum number of colors and color-pairs the + terminal can support). It also restores the colors on the + terminal to the values they had when the terminal was just + turned on. + + The <B>init_pair</B> 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: + + - The value of the first argument must be between <B>1</B> and + <B>COLOR_PAIRS-1</B>. + + - The value of the second and third arguments must be + between 0 and <B>COLORS</B> (the 0 color pair is wired to + white on black and cannot be changed). + + If the color-pair was previously initialized, the screen + is refreshed and all occurrences of that color-pair is + changed to the new definition. + + As an extension, ncurses allows you to set color pair 0 + via the <B>assume_default_colors</B> routine, or to specify the + use of default colors (color number <B>-1</B>) if you first + invoke the <B>use_default_colors</B> routine. + + The <B>init_color</B> 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 <B>0</B> and <B>COLORS</B>. (See the section + <B>Colors</B> for the default color index.) Each of the last + three arguments must be a value between 0 and 1000. When + <B>init_color</B> is used, all occurrences of that color on the + screen immediately change to the new definition. + + The <B>has_colors</B> routine requires no arguments. It returns + <B>TRUE</B> if the terminal can manipulate colors; otherwise, it + returns <B>FALSE</B>. This routine facilitates writing terminal- + independent programs. For example, a programmer can use + it to decide whether to use color or some other video + attribute. + + The <B>can_change_color</B> routine requires no arguments. It + returns <B>TRUE</B> if the terminal supports colors and can + change their definitions; other, it returns <B>FALSE</B>. This + routine facilitates writing terminal-independent programs. + + The <B>color_content</B> 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 <B>short</B>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 <B>COLORS</B>. The values that are stored at the + addresses pointed to by the last three arguments are + between 0 (no component) and 1000 (maximum amount of com- + ponent). + + The <B>pair_content</B> 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 <B>short</B>s for storing the foreground and the background + color numbers. The value of the first argument must be + between 1 and <B>COLOR_PAIRS-1</B>. The values that are stored + at the addresses pointed to by the second and third argu- + ments are between 0 and <B>COLORS</B>. + + <B>Colors</B> + In <B><curses.h></B> the following macros are defined. These are + the default colors. <B>curses</B> also assumes that <B>COLOR_BLACK</B> + is the default background color for all terminals. + + <B>COLOR_BLACK</B> + <B>COLOR_RED</B> + <B>COLOR_GREEN</B> + <B>COLOR_YELLOW</B> + <B>COLOR_BLUE</B> + <B>COLOR_MAGENTA</B> + <B>COLOR_CYAN</B> + <B>COLOR_WHITE</B> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The routines <B>can_change_color()</B> and <B>has_colors()</B> return + <B>TRUE</B> or <B>FALSE</B>. + + All other routines return the integer <B>ERR</B> upon failure and + an <B>OK</B> (SVr4 specifies only "an integer value other than + <B>ERR</B>") upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + In the <I>ncurses</I> implementation, there is a separate color + activation flag, color palette, color pairs table, and + associated COLORS and COLOR_PAIRS counts for each screen; + the <B>start_color</B> function only affects the current screen. + The SVr4/XSI interface is not really designed with this in + mind, and historical implementations may use a single + shared color palette. + + Note that setting an implicit background color via a color + pair affects only character cells that a character write + operation explicitly touches. To change the background + color used when parts of a window are blanked by erasing + or scrolling operations, see <B><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></B>. + + Several caveats apply on 386 and 486 machines with VGA- + compatible graphics: + + - COLOR_YELLOW is actually brown. To get yellow, use + COLOR_YELLOW combined with the <B>A_BOLD</B> attribute. + + - The A_BLINK attribute should in theory cause the + background to go bright. This often fails to work, + and even some cards for which it mostly works (such + as the Paradise and compatibles) do the wrong thing + when you try to set a bright "yellow" background (you + get a blinking yellow foreground instead). + + - Color RGB values are not settable. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + This implementation satisfies XSI Curses's minimum maxi- + mums for <B>COLORS</B> and <B>COLOR_PAIRS</B>. + + The <B>init_pair</B> routine accepts negative values of fore- + ground and background color to support the + <B>use_default_colors</B> extension, but only if that routine has + been first invoked. + + The assumption that <B>COLOR_BLACK</B> is the default background + color for all terminals can be modified using the + <B>assume_default_colors</B> extension, + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B>, <B>default_col-</B> + <B><A HREF="ors.3x.html">ors(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_delch.3x.html b/ncurses-5.2/doc/html/man/curs_delch.3x.html new file mode 100644 index 0000000..8d37648 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_delch.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>delch</B>, <B>wdelch</B>, <B>mvdelch</B>, <B>mvwdelch</B> - delete character under + the cursor in a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>delch(void);</B> + <B>int</B> <B>wdelch(WINDOW</B> <B>*win);</B> + <B>int</B> <B>mvdelch(int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>int</B> <B>mvwdelch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines delete the character under the cursor; all + characters to the right of the cursor on the same line are + moved to the left one position and the last character on + the line is filled with a blank. The cursor position does + not change (after moving to <I>y</I>, <I>x</I>, if specified). (This + does not imply use of the hardware delete character fea- + ture.) + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and an <B>OK</B> + (SVr4 specifies only "an integer value other than <B>ERR</B>") + upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>delch</B>, <B>mvdelch</B>, and <B>mvwdelch</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <B>ERR</B> on + failure, but specifies no error conditions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_deleteln.3x.html b/ncurses-5.2/doc/html/man/curs_deleteln.3x.html new file mode 100644 index 0000000..62cb0a4 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_deleteln.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>deleteln</B>, <B>wdeleteln</B>, <B>insdelln</B>, <B>winsdelln</B>, <B>insertln</B>, <B>win-</B> + <B>sertln</B> - delete and insert lines in a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>deleteln(void);</B> + <B>int</B> <B>wdeleteln(WINDOW</B> <B>*win);</B> + <B>int</B> <B>insdelln(int</B> <B>n);</B> + <B>int</B> <B>winsdelln(WINDOW</B> <B>*win,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>insertln(void);</B> + <B>int</B> <B>winsertln(WINDOW</B> <B>*win);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>deleteln</B> and <B>wdeleteln</B> routines delete the line under + the cursor in the window; all lines below the current line + are moved up one line. The bottom line of the window is + cleared. The cursor position does not change. + + The <B>insdelln</B> and <B>winsdelln</B> routines, for positive <I>n</I>, + insert <I>n</I> lines into the specified window above the current + line. The <I>n</I> bottom lines are lost. For negative <I>n</I>, + delete <I>n</I> lines (starting with the one under the cursor), + and move the remaining lines up. The bottom <I>n</I> lines are + cleared. The current cursor position remains the same. + + The <B>insertln</B> and <B>insertln</B> routines, insert a blank line + above the current line and the bottom line is lost. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and an <B>OK</B> + (SVr4 specifies only "an integer value other than <B>ERR</B>") + upon successful completion. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <B>ERR</B> on + failure, but specifies no error conditions. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all but <B>winsdelln</B> may be macros. + + These routines do not require a hardware line delete or + insert feature in the terminal. In fact, they won't use + hardware line delete/insert unless <B>idlok(...,</B> <B>TRUE)</B> has + been set on the current window. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_extend.3x.html b/ncurses-5.2/doc/html/man/curs_extend.3x.html new file mode 100644 index 0000000..a91102e --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_extend.3x.html @@ -0,0 +1,78 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>curs_extend</B>: <B>curses_version</B>, <B>use_extended_names</B> - miscel- + laneous curses extensions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>const</B> <B>char</B> <B>*</B> <B>curses_version(void);</B> + <B>int</B> <B>use_extended_names(bool</B> <B>enable);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions are extensions to the curses library which + do not fit easily into other categories. + + Use <I>curses</I><B>_</B><I>version()</I> to get the version number, including + patch level of the library, e.g., <B>5.0.19991023</B> + + The <I>use</I><B>_</B><I>extended</I><B>_</B><I>names()</I> function controls whether the + calling application is able to use user-defined or non- + standard names which may be compiled into the terminfo + description, i.e., via the terminfo or termcap interfaces. + Normally these names are available for use, since the + essential descision is made by using the <B>-x</B> option of <I>tic</I> + to compile extended terminal definitions. However you can + disable this feature to ensure compatiblity with other + implementations of curses + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B>, <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>, <B><A HREF="curs_print.3x.html">curs_print(3x)</A></B>, + <B><A HREF="default_colors.3x.html">default_colors(3x)</A></B>, <B><A HREF="define_key.3x.html">define_key(3x)</A></B>, <B><A HREF="keybound.3x.html">keybound(3x)</A></B>, + <B><A HREF="keyok.3x.html">keyok(3x)</A></B>, <B><A HREF="resizeterm.3x.html">resizeterm(3x)</A></B>, <B><A HREF="wresize.3x.html">wresize(3x)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_getch.3x.html b/ncurses-5.2/doc/html/man/curs_getch.3x.html new file mode 100644 index 0000000..833b88e --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_getch.3x.html @@ -0,0 +1,296 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>getch</B>, <B>wgetch</B>, <B>mvgetch</B>, <B>mvwgetch</B>, <B>ungetch</B>, <B>has_key</B> - get + (or push back) characters from <B>curses</B> terminal keyboard + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>getch(void);</B> + <B>int</B> <B>wgetch(WINDOW</B> <B>*win);</B> + <B>int</B> <B>mvgetch(int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>int</B> <B>mvwgetch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>int</B> <B>ungetch(int</B> <B>ch);</B> + <B>int</B> <B>has_key(int</B> <B>ch);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>getch</B>, <B>wgetch</B>, <B>mvgetch</B> and <B>mvwgetch</B>, routines read a + character from the window. In no-delay mode, if no input + is waiting, the value <B>ERR</B> is returned. In delay mode, the + program waits until the system passes text through to the + program. Depending on the setting of <B>cbreak</B>, this is + after one character (cbreak mode), or after the first new- + line (nocbreak mode). In half-delay mode, the program + waits until a character is typed or the specified timeout + has been reached. + + Unless <B>noecho</B> 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 + <B>delch</B> had been called. If the character value is any + other <B>KEY_</B> define, the user is alerted with a <B>beep</B> call. + Otherwise the character is simply output to the screen. + + If the window is not a pad, and it has been moved or modi- + fied since the last call to <B>wrefresh</B>, <B>wrefresh</B> will be + called before another character is read. + + If <B>keypad</B> is <B>TRUE</B>, and a function key is pressed, the + token for that function key is returned instead of the raw + characters. Possible function keys are defined in + <B><curses.h></B> as macros with values outside the range of + 8-bit characters whose names begin with <B>KEY_.</B> Thus, a + variable intended to hold the return value of a function + key must be of short size or larger. + + When a character that could be the beginning of a function + key is received (which, on modern terminals, means an + escape character), <B>curses</B> sets a timer. If the remainder + of the sequence does not come in within the designated + time, the character is passed through; otherwise, the + function key value is returned. For this reason, many + terminals experience a delay between the time a user + presses the escape key and the escape is returned to the + program. + + The <B>ungetch</B> routine places <I>ch</I> back onto the input queue to + be returned by the next call to <B>wgetch</B>. Note that there + is, in effect, just one input queue for all windows. + + + <B>Function</B> <B>Keys</B> + The following function keys, defined in <B><curses.h></B>, might + be returned by <B>getch</B> if <B>keypad</B> has been enabled. Note + that not all of these are necessarily supported on any + particular terminal. + + <I>Name</I> <I>Key</I> <I>name</I> + + KEY_BREAK Break key + KEY_DOWN The four arrow keys ... + KEY_UP + KEY_LEFT + KEY_RIGHT + KEY_HOME Home key (upward+left arrow) + KEY_BACKSPACE Backspace + KEY_F0 Function keys; space for 64 keys + is reserved. + KEY_F(<I>n</I>) For 0 <= <I>n</I> <= 63 + KEY_DL Delete line + KEY_IL Insert line + KEY_DC Delete character + KEY_IC Insert char or enter insert mode + KEY_EIC Exit insert char mode + KEY_CLEAR Clear screen + KEY_EOS Clear to end of screen + KEY_EOL Clear to end of line + KEY_SF Scroll 1 line forward + KEY_SR Scroll 1 line backward (reverse) + KEY_NPAGE Next page + KEY_PPAGE Previous page + KEY_STAB Set tab + KEY_CTAB Clear tab + KEY_CATAB Clear all tabs + KEY_ENTER Enter or send + KEY_SRESET Soft (partial) reset + KEY_RESET Reset or hard reset + KEY_PRINT Print or copy + KEY_LL Home down or bottom (lower left). + KEY_A1 Upper left of keypad + KEY_A3 Upper right of keypad + KEY_B2 Center of keypad + KEY_C1 Lower left of keypad + KEY_C3 Lower right of keypad + KEY_BTAB Back tab key + KEY_BEG Beg(inning) key + KEY_CANCEL Cancel key + + KEY_CLOSE Close key + KEY_COMMAND Cmd (command) key + KEY_COPY Copy key + KEY_CREATE Create key + KEY_END End key + KEY_EXIT Exit key + KEY_FIND Find key + KEY_HELP Help key + KEY_MARK Mark key + KEY_MESSAGE Message key + KEY_MOUSE Mouse event read + KEY_MOVE Move key + KEY_NEXT Next object key + KEY_OPEN Open key + KEY_OPTIONS Options key + KEY_PREVIOUS Previous object key + KEY_REDO Redo key + KEY_REFERENCE Ref(erence) key + KEY_REFRESH Refresh key + KEY_REPLACE Replace key + KEY_RESIZE Screen resized + KEY_RESTART Restart key + KEY_RESUME Resume key + KEY_SAVE Save key + KEY_SBEG Shifted beginning key + KEY_SCANCEL Shifted cancel key + KEY_SCOMMAND Shifted command key + KEY_SCOPY Shifted copy key + KEY_SCREATE Shifted create key + KEY_SDC Shifted delete char key + KEY_SDL Shifted delete line key + KEY_SELECT Select key + KEY_SEND Shifted end key + KEY_SEOL Shifted clear line key + KEY_SEXIT Shifted exit key + KEY_SFIND Shifted find key + KEY_SHELP Shifted help key + KEY_SHOME Shifted home key + KEY_SIC Shifted input key + KEY_SLEFT Shifted left arrow key + KEY_SMESSAGE Shifted message key + KEY_SMOVE Shifted move key + KEY_SNEXT Shifted next key + KEY_SOPTIONS Shifted options key + KEY_SPREVIOUS Shifted prev key + KEY_SPRINT Shifted print key + KEY_SREDO Shifted redo key + KEY_SREPLACE Shifted replace key + KEY_SRIGHT Shifted right arrow + KEY_SRSUME Shifted resume key + KEY_SSAVE Shifted save key + KEY_SSUSPEND Shifted suspend key + KEY_SUNDO Shifted undo key + + KEY_SUSPEND Suspend key + KEY_UNDO Undo key + + Keypad is arranged like this: + + +-----+------+-------+ + | <B>A1</B> | <B>up</B> | <B>A3</B> | + +-----+------+-------+ + |<B>left</B> | <B>B2</B> | <B>right</B> | + +-----+------+-------+ + | <B>C1</B> | <B>down</B> | <B>C3</B> | + +-----+------+-------+ + The <B>has_key</B> routine takes a key value from the above list, + and returns TRUE or FALSE according as the current termi- + nal type recognizes a key with that value. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and an + integer value other than <B>ERR</B> (<B>OK</B> in the case of ungetch()) + upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Use of the escape key by a programmer for a single charac- + ter function is discouraged, as it will cause a delay of + up to one second while the keypad code looks for a follow- + ing function-key sequence. + + When using <B>getch</B>, <B>wgetch</B>, <B>mvgetch</B>, or <B>mvwgetch</B>, nocbreak + mode (<B>nocbreak</B>) and echo mode (<B>echo</B>) should not be used at + the same time. Depending on the state of the tty driver + when each character is typed, the program may produce + undesirable results. + + Note that <B>getch</B>, <B>mvgetch</B>, and <B>mvwgetch</B> may be macros. + + Historically, the set of keypad macros was largely defined + by the extremely function-key-rich keyboard of the AT&T + 7300, aka 3B1, aka Safari 4. Modern personal computers + usually have only a small subset of these. IBM PC-style + consoles typically support little more than <B>KEY_UP</B>, + <B>KEY_DOWN</B>, <B>KEY_LEFT</B>, <B>KEY_RIGHT</B>, <B>KEY_HOME</B>, <B>KEY_END</B>, + <B>KEY_NPAGE</B>, <B>KEY_PPAGE</B>, and function keys 1 through 12. The + Ins key is usually mapped to <B>KEY_IC</B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The *get* functions are described in the XSI Curses stan- + dard, Issue 4. They read single-byte characters only. + The standard specifies that they return <B>ERR</B> on failure, + but specifies no error conditions. + + The echo behavior of these functions on input of <B>KEY_</B> or + backspace characters was not specified in the SVr4 docu- + mentation. This description is adopted from the XSI + Curses standard. + + The behavior of <B>getch</B> and friends in the presence of han- + dled signals is unspecified in the SVr4 and XSI Curses + documentation. Under historical curses implementations, + it varied depending on whether the operating system's + implementation of handled signal receipt interrupts a + <B><A HREF="read.2.html">read(2)</A></B> call in progress or not, and also (in some imple- + mentations) depending on whether an input timeout or non- + blocking mode hsd been set. + + Programmers concerned about portability should be prepared + for either of two cases: (a) signal receipt does not + interrupt <B>getch</B>; (b) signal receipt interrupts <B>getch</B> and + causes it to return ERR with <B>errno</B> set to <B>EINTR</B>. Under + the <B>ncurses</B> implementation, handled signals never inter- + rupt <B>getch</B>. + + The <B>has_key</B> function is unique to <B>ncurses</B>. We recommend + that any code using it be conditionalized on the + <B>NCURSES_VERSION</B> feature macro. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B>, <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>, + <B><A HREF="curs_move.3x.html">curs_move(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>. <B><A HREF="resizeterm.3x.html">resizeterm(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_getstr.3x.html b/ncurses-5.2/doc/html/man/curs_getstr.3x.html new file mode 100644 index 0000000..19c8ce1 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_getstr.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>getstr</B>, <B>getnstr</B>, <B>wgetstr</B>, <B>wgetnstr</B>, <B>mvgetstr</B>, <B>mvgetnstr</B>, + <B>mvwgetstr</B>, <B>mvwgetnstr</B> - accept character strings from + <B>curses</B> terminal keyboard + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>getstr(char</B> <B>*str);</B> + <B>int</B> <B>getnstr(char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>wgetstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>wgetnstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvgetstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvwgetstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvgetnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwgetnstr(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>getstr</B> is equivalent to a series of calls to + <B>getch</B>, until a newline or carriage return is received (the + terminating character is not included in the returned + string). The resulting value is placed in the area + pointed to by the character pointer <I>str</I>. + + <B>wgetnstr</B> reads at most <I>n</I> characters, thus preventing a + possible overflow of the input buffer. Any attempt to + enter more characters (other than the terminating newline + or carriage return) causes a beep. Function keys also + cause a beep and are ignored. The <B>getnstr</B> function reads + from the <I>stdscr</I> default window. + + The user's erase and kill characters are interpreted. If + keypad mode is on for the window, <B>KEY_LEFT</B> and + <B>KEY_BACKSPACE</B> are both considered equivalent to the user's + kill character. + + Characters input are echoed only if <B>echo</B> is currently on. + In that case, backspace is echoed as deletion of the pre- + vious character (typically a left motion). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and an <B>OK</B> + (SVr4 specifies only "an integer value other than <B>ERR</B>") + upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>getstr</B>, <B>mvgetstr</B>, and <B>mvwgetstr</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. They read single-byte characters only. The + standard specifies that they return <B>ERR</B> on failure, but + the single error condition <B>EOVERFLOW</B> associated with + extended-level conformance is not yet returned (the XSI + curses support for multi-byte characters is not yet pre- + sent). + + SVr3 and early SVr4 curses implementations did not reject + function keys; the SVr4.0 documentation claimed that "spe- + cial keys" (such as function keys, "home" key, "clear" + key, <I>etc</I>.) are interpreted" without giving details. It + lied. In fact, the `character' value appended to the + string by those implementations was predictable but not + useful (being, in fact, the low-order eight bits of the + key's KEY_ value). + + The functions <B>getnstr</B>, <B>mvgetnstr</B>, and <B>mvwgetnstr</B> were pre- + sent but not documented in SVr4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_getyx.3x.html b/ncurses-5.2/doc/html/man/curs_getyx.3x.html new file mode 100644 index 0000000..562d710 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_getyx.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>getyx</B>, <B>getparyx</B>, <B>getbegyx</B>, <B>getmaxyx</B> - get <B>curses</B> cursor + and window coordinates + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>void</B> <B>getyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>void</B> <B>getparyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>void</B> <B>getbegyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>void</B> <B>getmaxyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>getyx</B> macro places the current cursor position of the + given window in the two integer variables <I>y</I> and <I>x</I>. + + If <I>win</I> is a subwindow, the <B>getparyx</B> macro places the + beginning coordinates of the subwindow relative to the + parent window into two integer variables <I>y</I> and <I>x</I>. Other- + wise, <B>-1</B> is placed into <I>y</I> and <I>x</I>. + + Like <B>getyx</B>, the <B>getbegyx</B> and <B>getmaxyx</B> macros store the + current beginning coordinates and size of the specified + window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The return values of these macros are undefined (<I>i</I>.<I>e</I>., + they should not be used as the right-hand side of assign- + ment statements). + + +</PRE> +<H2>NOTES</H2><PRE> + All of these interfaces are macros and that "<B>&</B>" is not + necessary before the variables <I>y</I> and <I>x</I>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_inch.3x.html b/ncurses-5.2/doc/html/man/curs_inch.3x.html new file mode 100644 index 0000000..2c4b22a --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_inch.3x.html @@ -0,0 +1,78 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>inch</B>, <B>winch</B>, <B>mvinch</B>, <B>mvwinch</B> - get a character and + attributes from a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>chtype</B> <B>inch(void);</B> + <B>chtype</B> <B>winch(WINDOW</B> <B>*win);</B> + <B>chtype</B> <B>mvinch(int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>chtype</B> <B>mvwinch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return the character, of type <B>chtype</B>, at + the current position in the named window. If any + attributes are set for that position, their values are + OR'ed into the value returned. Constants defined in + <B><curses.h></B> can be used with the <B>&</B> (logical AND) operator + to extract the character or attributes alone. + + + <B>Attributes</B> + The following bit-masks may be AND-ed with characters + returned by <B>winch</B>. + + <B>A_CHARTEXT</B> Bit-mask to extract character + <B>A_ATTRIBUTES</B> Bit-mask to extract attributes + <B>A_COLOR</B> Bit-mask to extract color-pair field information + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all of these routines may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_inchstr.3x.html b/ncurses-5.2/doc/html/man/curs_inchstr.3x.html new file mode 100644 index 0000000..5688c02 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_inchstr.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>inchstr</B>, <B>inchnstr</B>, <B>winchstr</B>, <B>winchnstr</B>, <B>mvinchstr</B>, + <B>mvinchnstr</B>, <B>mvwinchstr</B>, <B>mvwinchnstr</B> - get a string of + characters (and attributes) from a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>inchstr(chtype</B> <B>*chstr);</B> + <B>int</B> <B>inchnstr(chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>winchstr(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>*chstr);</B> + <B>int</B> <B>winchnstr(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvinchstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr);</B> + <B>int</B> <B>mvinchnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwinchstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr);</B> + <B>int</B> <B>mvwinchnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr,</B> + <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return a NULL-terminated array of <B>chtype</B> + quantities, starting at the current cursor position in the + named window and ending at the right margin of the window. + The four functions with <I>n</I> as the last argument, return a + leading substring at most <I>n</I> characters long (exclusive of + the trailing (chtype)0). Constants defined in <B><curses.h></B> + can be used with the <B>&</B> (logical AND) operator to extract + the character or the attribute alone from any position in + the <I>chstr</I> [see <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>]. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and an + integer value other than <B>ERR</B> upon successful completion + (the number of characters retrieved, exclusive of the + trailing 0). + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <B>winchnstr</B> may be macros. + SVr4 does not document whether the result string is 0-ter- + minated; it does not document whether a length limit argu- + ment includes any trailing 0; and it does not document the + meaning of the return value. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. It is no more specific than the SVr4 documenta- + tion on the trailing 0. It does specify that the success- + ful return of the functions is <B>OK</B>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>. + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_initscr.3x.html b/ncurses-5.2/doc/html/man/curs_initscr.3x.html new file mode 100644 index 0000000..81be73b --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_initscr.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>initscr</B>, <B>newterm</B>, <B>endwin</B>, <B>isendwin</B>, <B>set_term</B>, <B>delscreen</B> - + <B>curses</B> screen initialization and manipulation routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>WINDOW</B> <B>*initscr(void);</B> + <B>int</B> <B>endwin(void);</B> + <B>bool</B> <B>isendwin(void);</B> + <B>SCREEN</B> <B>*newterm(const</B> <B>char</B> <B>*type,</B> <B>FILE</B> <B>*outfd,</B> <B>FILE</B> + <B>*infd);</B> + <B>SCREEN</B> <B>*set_term(SCREEN</B> <B>*new);</B> + <B>void</B> <B>delscreen(SCREEN*</B> <B>sp);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>initscr</B> is normally the first <B>curses</B> routine to call when + initializing a program. A few special routines sometimes + need to be called before it; these are <B>slk_init</B>, <B>filter</B>, + <B>ripoffline</B>, <B>use_env</B>. For multiple-terminal applications, + <B>newterm</B> may be called before <B>initscr</B>. + + The initscr code determines the terminal type and initial- + izes all <B>curses</B> data structures. <B>initscr</B> also causes the + first call to <B>refresh</B> to clear the screen. If errors + occur, <B>initscr</B> writes an appropriate error message to + standard error and exits; otherwise, a pointer is returned + to <B>stdscr</B>. + + A program that outputs to more than one terminal should + use the <B>newterm</B> routine for each terminal instead of + <B>initscr</B>. A program that needs to inspect capabilities, so + it can continue to run in a line-oriented mode if the ter- + minal cannot support a screen-oriented program, would also + use <B>newterm</B>. The routine <B>newterm</B> should be called once + for each terminal. It returns a variable of type <B>SCREEN</B> <B>*</B> + which should be saved as a reference to that terminal. + The arguments are the <I>type</I> of the terminal to be used in + place of <B>$TERM</B>, a file pointer for output to the terminal, + and another file pointer for input from the terminal (if + <I>type</I> is <B>NULL</B>, <B>$TERM</B> will be used). The program must also + call <B>endwin</B> for each terminal being used before exiting + from <B>curses</B>. If <B>newterm</B> is called more than once for the + same terminal, the first terminal referred to must be the + last one for which <B>endwin</B> is called. + + A program should always call <B>endwin</B> before exiting or + escaping from <B>curses</B> mode temporarily. This routine + restores 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 <B>refresh</B> or <B>doupdate</B> after + a temporary escape causes the program to resume visual + mode. + + The <B>isendwin</B> routine returns <B>TRUE</B> if <B>endwin</B> has been + called without any subsequent calls to <B>wrefresh</B>, and <B>FALSE</B> + otherwise. + + The <B>set_term</B> routine is used to switch between different + terminals. The screen reference <B>new</B> becomes the new cur- + rent terminal. The previous terminal is returned by the + routine. This is the only routine which manipulates + <B>SCREEN</B> pointers; all other routines affect only the cur- + rent terminal. + + The <B>delscreen</B> routine frees storage associated with the + <B>SCREEN</B> data structure. The <B>endwin</B> routine does not do + this, so <B>delscreen</B> should be called after <B>endwin</B> if a par- + ticular <B>SCREEN</B> is no longer needed. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>endwin</B> returns the integer <B>ERR</B> upon failure and <B>OK</B> upon + successful completion. + + Routines that return pointers always return <B>NULL</B> on error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>initscr</B> and <B>newterm</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. It specifies that portable applications must not + call <B>initscr</B> more than once. + + Old versions of curses, e.g., BSD 4.4, may have returned a + null pointer from <B>initscr</B> when an error is detected, + rather than exiting. It is safe but redundant to check + the return value of <B>initscr</B> in XSI Curses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, + <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>, <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_inopts.3x.html b/ncurses-5.2/doc/html/man/curs_inopts.3x.html new file mode 100644 index 0000000..13ec59c --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_inopts.3x.html @@ -0,0 +1,242 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>cbreak</B>, <B>nocbreak</B>, <B>echo</B>, <B>noecho</B>, <B>halfdelay</B>, <B>intrflush</B>, <B>key-</B> + <B>pad</B>, <B>meta</B>, <B>nodelay</B>, <B>notimeout</B>, <B>raw</B>, <B>noraw</B>, <B>noqiflush</B>, + <B>qiflush</B>, <B>timeout</B>, <B>wtimeout</B>, <B>typeahead</B> - <B>curses</B> input + options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>cbreak(void);</B> + <B>int</B> <B>nocbreak(void);</B> + <B>int</B> <B>echo(void);</B> + <B>int</B> <B>noecho(void);</B> + <B>int</B> <B>halfdelay(int</B> <B>tenths);</B> + <B>int</B> <B>intrflush(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>keypad(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>meta(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>nodelay(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>raw(void);</B> + <B>int</B> <B>noraw(void);</B> + <B>void</B> <B>noqiflush(void);</B> + <B>void</B> <B>qiflush(void);</B> + <B>int</B> <B>notimeout(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>void</B> <B>timeout(int</B> <B>delay);</B> + <B>void</B> <B>wtimeout(WINDOW</B> <B>*win,</B> <B>int</B> <B>delay);</B> + <B>int</B> <B>typeahead(int</B> <B>fd);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Normally, the tty driver buffers typed characters until a + newline or carriage return is typed. The <B>cbreak</B> routine + disables line buffering and erase/kill character-process- + ing (interrupt and flow control characters are unaf- + fected), making characters typed by the user immediately + available to the program. The <B>nocbreak</B> routine returns + the terminal to normal (cooked) mode. + + Initially the terminal may or may not be in <B>cbreak</B> mode, + as the mode is inherited; therefore, a program should call + <B>cbreak</B> or <B>nocbreak</B> explicitly. Most interactive programs + using <B>curses</B> set the <B>cbreak</B> mode. Note that <B>cbreak</B> over- + rides <B>raw</B>. [See <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> for a discussion of how + these routines interact with <B>echo</B> and <B>noecho</B>.] + + The <B>echo</B> and <B>noecho</B> routines control whether characters + typed by the user are echoed by <B>getch</B> as they are typed. + Echoing by the tty driver is always disabled, but ini- + tially <B>getch</B> is in echo mode, so characters typed are + echoed. Authors of most interactive programs prefer to do + their own echoing in a controlled area of the screen, or + not to echo at all, so they disable echoing by calling + <B>noecho</B>. [See <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> for a discussion of how these + routines interact with <B>cbreak</B> and <B>nocbreak</B>.] + + The <B>halfdelay</B> routine is used for half-delay mode, which + is similar to <B>cbreak</B> mode in that characters typed by the + user are immediately available to the program. However, + after blocking for <I>tenths</I> tenths of seconds, ERR is + returned if nothing has been typed. The value of <B>tenths</B> + must be a number between 1 and 255. Use <B>nocbreak</B> to leave + half-delay mode. + + If the <B>intrflush</B> option is enabled, (<I>bf</I> is <B>TRUE</B>), when an + interrupt key is pressed on the keyboard (interrupt, + break, quit) all output in the tty driver queue will be + flushed, giving the effect of faster response to the + interrupt, but causing <B>curses</B> to have the wrong idea of + what is on the screen. Disabling (<I>bf</I> is <B>FALSE</B>), the + option prevents the flush. The default for the option is + inherited from the tty driver settings. The window argu- + ment is ignored. + + The <B>keypad</B> option enables the keypad of the user's termi- + nal. If enabled (<I>bf</I> is <B>TRUE</B>), the user can press a func- + tion key (such as an arrow key) and <B>wgetch</B> returns a sin- + gle value representing the function key, as in <B>KEY_LEFT</B>. + If disabled (<I>bf</I> is <B>FALSE</B>), <B>curses</B> does not treat function + keys specially and the program has to interpret the escape + sequences itself. If the keypad in the terminal can be + turned on (made to transmit) and off (made to work + locally), turning on this option causes the terminal key- + pad to be turned on when <B>wgetch</B> is called. The default + value for keypad is false. + + Initially, whether the terminal returns 7 or 8 significant + bits on input depends on the control mode of the tty + driver [see <B><A HREF="termio.7.html">termio(7)</A></B>]. To force 8 bits to be returned, + invoke <B>meta</B>(<I>win</I>, <B>TRUE</B>); this is equivalent, under POSIX, + to setting the CS8 flag on the terminal. To force 7 bits + to be returned, invoke <B>meta</B>(<I>win</I>, <B>FALSE</B>); this is equiva- + lent, under POSIX, to setting the CS8 flag on the termi- + nal. The window argument, <I>win</I>, is always ignored. If the + terminfo capabilities <B>smm</B> (meta_on) and <B>rmm</B> (meta_off) are + defined for the terminal, <B>smm</B> is sent to the terminal when + <B>meta</B>(<I>win</I>, <B>TRUE</B>) is called and <B>rmm</B> is sent when <B>meta</B>(<I>win</I>, + <B>FALSE</B>) is called. + + The <B>nodelay</B> option causes <B>getch</B> to be a non-blocking call. + If no input is ready, <B>getch</B> returns <B>ERR</B>. If disabled (<I>bf</I> + is <B>FALSE</B>), <B>getch</B> waits until a key is pressed. + + While interpreting an input escape sequence, <B>wgetch</B> sets a + timer while waiting for the next character. If <B>notime-</B> + <B>out(</B><I>win</I>, <B>TRUE</B>) is called, then <B>wgetch</B> does not set a + timer. The purpose of the timeout is to differentiate + between sequences received from a function key and those + typed by a user. + + The <B>raw</B> and <B>noraw</B> routines place the terminal into or out + of raw mode. Raw mode is similar to <B>cbreak</B> mode, in that + characters typed are immediately passed through to the + user program. The differences are that in raw mode, the + interrupt, quit, suspend, and flow control characters are + all passed through uninterpreted, instead of generating a + signal. The behavior of the BREAK key depends on other + bits in the tty driver that are not set by <B>curses</B>. + + When the <B>noqiflush</B> routine is used, normal flush of input + and output queues associated with the <B>INTR</B>, <B>QUIT</B> and <B>SUSP</B> + characters will not be done [see <B><A HREF="termio.7.html">termio(7)</A></B>]. When <B>qiflush</B> + is called, the queues will be flushed when these control + characters are read. You may want to call <B>noqiflush()</B> in + a signal handler if you want output to continue as though + the interrupt had not occurred, after the handler exits. + + The <B>timeout</B> and <B>wtimeout</B> routines set blocking or non- + blocking read for a given window. If <I>delay</I> is negative, + blocking read is used (<I>i</I>.<I>e</I>., waits indefinitely for + input). If <I>delay</I> is zero, then non-blocking read is used + (<I>i</I>.<I>e</I>., read returns <B>ERR</B> if no input is waiting). If <I>delay</I> + is positive, then read blocks for <I>delay</I> milliseconds, and + returns <B>ERR</B> if there is still no input. Hence, these rou- + tines provide the same functionality as <B>nodelay</B>, plus the + additional capability of being able to block for only + <I>delay</I> milliseconds (where <I>delay</I> is positive). + + The <B>curses</B> 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 <B>refresh</B> or <B>doupdate</B> + is called again. This allows faster response to commands + typed in advance. Normally, the input FILE pointer passed + to <B>newterm</B>, or <B>stdin</B> in the case that <B>initscr</B> was used, + will be used to do this typeahead checking. The <B>typeahead</B> + routine specifies that the file descriptor <I>fd</I> is to be + used to check for typeahead instead. If <I>fd</I> is -1, then no + typeahead checking is done. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines that return an integer return <B>ERR</B> upon fail- + ure and OK (SVr4 specifies only "an integer value other + than <B>ERR</B>") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + The ncurses library obeys the XPG4 standard and the his- + torical practice of the AT&T curses implementations, in + that the echo bit is cleared when curses initializes the + terminal state. BSD curses differed from this slightly; + it left the echo bit on at initialization, but the BSD <B>raw</B> + call turned it off as a side-effect. For best portabil- + ity, set echo or noecho explicitly just after initializa- + tion, even if your program remains in cooked mode. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>echo</B>, <B>noecho</B>, <B>halfdelay</B>, <B>intrflush</B>, <B>meta</B>, <B>node-</B> + <B>lay</B>, <B>notimeout</B>, <B>noqiflush</B>, <B>qiflush</B>, <B>timeout</B>, and <B>wtimeout</B> + may be macros. + + The <B>noraw</B> and <B>nocbreak</B> calls follow historical practice in + that they attempt to restore to normal (`cooked') mode + from raw and cbreak modes respectively. Mixing raw/noraw + and cbreak/nocbreak calls leads to tty driver control + states that are hard to predict or understand; it is not + recommended. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="termio.7.html">termio(7)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_insch.3x.html b/ncurses-5.2/doc/html/man/curs_insch.3x.html new file mode 100644 index 0000000..5a1610b --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_insch.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>insch</B>, <B>winsch</B>, <B>mvinsch</B>, <B>mvwinsch</B> - insert a character + before cursor in a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>insch(chtype</B> <B>ch);</B> + <B>int</B> <B>winsch(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>mvinsch(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch);</B> + <B>int</B> <B>mvwinsch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines, insert the character <I>ch</I> before the charac- + ter under the cursor. All characters to the right of the + cursor are moved one space to the right, with the possi- + bility of the rightmost character on the line being lost. + The insertion operation does not change the cursor posi- + tion. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines that return an integer return <B>ERR</B> upon fail- + ure and OK (SVr4 specifies only "an integer value other + than <B>ERR</B>") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + + +</PRE> +<H2>NOTES</H2><PRE> + These routines do not necessarily imply use of a hardware + insert character feature. + + Note that <B>insch</B>, <B>mvinsch</B>, and <B>mvwinsch</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_insstr.3x.html b/ncurses-5.2/doc/html/man/curs_insstr.3x.html new file mode 100644 index 0000000..2349cbc --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_insstr.3x.html @@ -0,0 +1,135 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>insstr</B>, <B>insnstr</B>, <B>winsstr</B>, <B>winsnstr</B>, <B>mvinsstr</B>, <B>mvinsnstr</B>, + <B>mvwinsstr</B>, <B>mvwinsnstr</B> - insert string before cursor in a + <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>int</B> <B>insstr(const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>insnstr(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>winsstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>winsnstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvinsstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvinsnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwinsstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvwinsnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B> + <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines insert a character string (as many charac- + ters as will fit on the line) before the character under + the cursor. All characters to the right of the cursor are + shifted right, with the possibility of the rightmost char- + acters on the line being lost. The cursor position does + not change (after moving to <I>y</I>, <I>x</I>, if specified). The four + routines with <I>n</I> as the last argument insert a leading sub- + string of at most <I>n</I> characters. If <I>n</I><=0, then the entire + string is inserted. + + If a character in <I>str</I> is a tab, newline, carriage return + or backspace, the cursor is moved appropriately within the + window. A newline also does a <B>clrtoeol</B> before moving. + Tabs are considered to be at every eighth column. If a + character in <I>str</I> is another control character, it is drawn + in the <B>^</B><I>X</I> notation. Calling <B>winch</B> after adding a control + character (and moving to it, if necessary) does not return + the control character, but instead returns a character in + the ^-representation of the control character. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines that return an integer return <B>ERR</B> upon fail- + ure and OK (SVr4 specifies only "an integer value other + than <B>ERR</B>") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all but <B>winsnstr</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4, which adds const qualifiers to the arguments. + The XSI Curses error conditions <B>EILSEQ</B> and <B>EILOVERFLOW</B> + associated with extended-level conformance are not yet + detected (this implementation does not yet support XPG4 + multi-byte characters). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B>, <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_instr.3x.html b/ncurses-5.2/doc/html/man/curs_instr.3x.html new file mode 100644 index 0000000..3074639 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_instr.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>instr</B>, <B>innstr</B>, <B>winstr</B>, <B>winnstr</B>, <B>mvinstr</B>, <B>mvinnstr</B>, <B>mvwin-</B> + <B>str</B>, <B>mvwinnstr</B> - get a string of characters from a <B>curses</B> + window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>instr(char</B> <B>*str);</B> + <B>int</B> <B>innstr(char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>winstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>winnstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvinstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvinnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> + <B>int</B> <B>mvwinstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>mvwinnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> + <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines return a string of characters in <I>str</I>, + extracted starting at the current cursor position in the + named window. Attributes are stripped from the charac- + ters. The four functions with <I>n</I> as the last argument + return a leading substring at most <I>n</I> characters long + (exclusive of the trailing NUL). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All of the functions return <B>ERR</B> upon failure, or the num- + ber of characters actually read into the string. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <B>winnstr</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses error conditions <B>EILSEQ</B> and <B>EILOVERFLOW</B> + associated with extended-level conformance are not yet + detected (this implementation does not yet support XPG4 + multi-byte characters). SVr4 does not document whether a + length limit includes or excludes the trailing NUL. + + The ncurses library extends the XSI description by allow- + ing a negative value for <I>n</I>. In this case, the functions + return the string ending at the right margin. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_kernel.3x.html b/ncurses-5.2/doc/html/man/curs_kernel.3x.html new file mode 100644 index 0000000..094f396 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_kernel.3x.html @@ -0,0 +1,188 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>def_prog_mode</B>, <B>def_shell_mode</B>, <B>reset_prog_mode</B>, + <B>reset_shell_mode</B>, <B>resetty</B>, <B>savetty</B>, <B>getsyx</B>, <B>setsyx</B>, <B>ripof-</B> + <B>fline</B>, <B>curs_set</B>, <B>napms</B> - low-level <B>curses</B> routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>def_prog_mode(void);</B> + <B>int</B> <B>def_shell_mode(void);</B> + <B>int</B> <B>reset_prog_mode(void);</B> + <B>int</B> <B>reset_shell_mode(void);</B> + <B>int</B> <B>resetty(void);</B> + <B>int</B> <B>savetty(void);</B> + <B>void</B> <B>getsyx(int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>void</B> <B>setsyx(int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>int</B> <B>ripoffline(int</B> <B>line,</B> <B>int</B> <B>(*init)(WINDOW</B> <B>*,</B> <B>int));</B> + <B>int</B> <B>curs_set(int</B> <B>visibility);</B> + <B>int</B> <B>napms(int</B> <B>ms);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The following routines give low-level access to various + <B>curses</B> capabilities. Theses routines typically are used + inside library routines. + + The <B>def_prog_mode</B> and <B>def_shell_mode</B> routines save the + current terminal modes as the "program" (in <B>curses</B>) or + "shell" (not in <B>curses</B>) state for use by the + <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines. This is + done automatically by <B>initscr</B>. There is one such save + area for each screen context allocated by <B>newterm()</B>. + + The <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines restore + the terminal to "program" (in <B>curses</B>) or "shell" (out of + <B>curses</B>) state. These are done automatically by <B>endwin</B> + and, after an <B>endwin</B>, by <B>doupdate</B>, so they normally are + not called. + + The <B>resetty</B> and <B>savetty</B> routines save and restore the + state of the terminal modes. <B>savetty</B> saves the current + state in a buffer and <B>resetty</B> restores the state to what + it was at the last call to <B>savetty</B>. + + The <B>getsyx</B> routine returns the current coordinates of the + virtual screen cursor in <I>y</I> and <I>x</I>. If <B>leaveok</B> is currently + <B>TRUE</B>, then <B>-1</B>,<B>-1</B> is returned. If lines have been removed + from the top of the screen, using <B>ripoffline</B>, <I>y</I> and <I>x</I> + include these lines; therefore, <I>y</I> and <I>x</I> should be used + only as arguments for <B>setsyx</B>. + + The <B>setsyx</B> routine sets the virtual screen cursor to <I>y</I>, <I>x</I>. + If <I>y</I> and <I>x</I> are both <B>-1</B>, then <B>leaveok</B> is set. The two rou- + tines <B>getsyx</B> and <B>setsyx</B> are designed to be used by a + library routine, which manipulates <B>curses</B> windows but does + not want to change the current position of the program's + cursor. The library routine would call <B>getsyx</B> at the + beginning, do its manipulation of its own windows, do a + <B>wnoutrefresh</B> on its windows, call <B>setsyx</B>, and then call + <B>doupdate</B>. + + The <B>ripoffline</B> routine provides access to the same facil- + ity that <B>slk_init</B> [see <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>] uses to reduce the + size of the screen. <B>ripoffline</B> must be called before + <B>initscr</B> or <B>newterm</B> is called. If <I>line</I> is positive, a line + is removed from the top of <B>stdscr</B>; if <I>line</I> is negative, a + line is removed from the bottom. When this is done inside + <B>initscr</B>, the routine <B>init</B> (supplied by the user) is called + with two arguments: a window pointer to the one-line win- + dow that has been allocated and an integer with the number + of columns in the window. Inside this initialization rou- + tine, the integer variables <B>LINES</B> and <B>COLS</B> (defined in + <B><curses.h></B>) are not guaranteed to be accurate and <B>wrefresh</B> + or <B>doupdate</B> must not be called. It is allowable to call + <B>wnoutrefresh</B> during the initialization routine. + + <B>ripoffline</B> can be called up to five times before calling + <B>initscr</B> or <B>newterm</B>. + + The <B>curs_set</B> routine sets the cursor state is set to + invisible, normal, or very visible for <B>visibility</B> equal to + <B>0</B>, <B>1</B>, or <B>2</B> respectively. If the terminal supports the + <I>visibility</I> requested, the previous <I>cursor</I> state is + returned; otherwise, <B>ERR</B> is returned. + + The <B>napms</B> routine is used to sleep for <I>ms</I> milliseconds. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>curs_set</B>, these routines always return <B>OK</B>. + <B>curs_set</B> returns the previous cursor state, or <B>ERR</B> if the + requested <I>visibility</I> is not supported. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>getsyx</B> is a macro, so <B>&</B> is not necessary before + the variables <I>y</I> and <I>x</I>. + + Older SVr4 man pages warn that the return value of + <B>curs_set</B> "is currently incorrect". This implementation + gets it right, but it may be unwise to count on the cor- + rectness of the return value anywhere else. + + Both ncurses and SVr4 will call <B>curs_set</B> in <B>endwin</B> if + <B>curs_set</B> has been called to make the cursor other than + normal, i.e., either visible or very visible. There is no + way for ncurses to determine the initial cursor state to + restore that. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The functions <B>setsyx</B> and <B>getsyx</B> are not described in the + XSI Curses standard, Issue 4. All other functions are as + described in XSI Curses. + + The SVr4 documentation describes <B>setsyx</B> and <B>getsyx</B> as hav- + ing return type int. This is misleading, as they are + macros with no documented semantics for the return value. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>, + <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B>, <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_mouse.3x.html b/ncurses-5.2/doc/html/man/curs_mouse.3x.html new file mode 100644 index 0000000..6e1ca87 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_mouse.3x.html @@ -0,0 +1,242 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>getmouse</B>, <B>ungetmouse</B>, <B>mousemask</B>, <B>wenclose</B>, <B>mouse_trafo</B>, + <B>wmouse_trafo</B>, <B>mouseinterval</B> - mouse interface through + curses + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>typedef</B> <B>unsigned</B> <B>long</B> <B>mmask_t;</B> + + <B>typedef</B> <B>struct</B> + <B>{</B> + <B>short</B> <B>id;</B> <I>/*</I> <I>ID</I> <I>to</I> <I>distinguish</I> <I>multiple</I> <I>devices</I> <I>*/</I> + <B>int</B> <B>x,</B> <B>y,</B> <B>z;</B> <I>/*</I> <I>event</I> <I>coordinates</I> <I>*/</I> + <B>mmask_t</B> <B>bstate;</B> <I>/*</I> <I>button</I> <I>state</I> <I>bits</I> <I>*/</I> + <B>}</B> + <B>MEVENT;</B> + <B>int</B> <B>getmouse(MEVENT</B> <B>*event);</B> + <B>int</B> <B>ungetmouse(MEVENT</B> <B>*event);</B> + <B>mmask_t</B> <B>mousemask(mmask_t</B> <B>newmask,</B> <B>mmask_t</B> <B>*oldmask);</B> + <B>bool</B> <B>wenclose(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>bool</B> <B>mouse_trafo(int*</B> <B>pY,</B> <B>int*</B> <B>pX,</B> <B>bool</B> <B>to_screen);</B> + <B>bool</B> <B>wmouse_trafo(const</B> <B>WINDOW*</B> <B>win,</B> <B>int*</B> <B>pY,</B> <B>int*</B> <B>pX,</B> + <B>bool</B> <B>to_screen);</B> + <B>int</B> <B>mouseinterval(int</B> <B>erval);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions provide an interface to mouse events from + <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>. Mouse events are represented by <B>KEY_MOUSE</B> + pseudo-key values in the <B>wgetch</B> input stream. + + To make mouse events visible, use the <B>mousemask</B> function. + This will set the mouse events to be reported. By + default, no mouse events are reported. The function will + return a mask to indicate which of the specified mouse + events can be reported; on complete failure it returns 0. + If oldmask is non-NULL, this function fills the indicated + location with the previous value of the given window's + mouse event mask. + + As a side effect, setting a zero mousemask may turn off + the mouse pointer; setting a nonzero mask may turn it on. + Whether this happens is device-dependent. + + Here are the mouse event type masks: + + <I>Name</I> <I>Description</I> + --------------------------------------------------------------------- + BUTTON1_PRESSED mouse button 1 down + BUTTON1_RELEASED mouse button 1 up + BUTTON1_CLICKED mouse button 1 clicked + BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked + BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked + + BUTTON2_PRESSED mouse button 2 down + BUTTON2_RELEASED mouse button 2 up + BUTTON2_CLICKED mouse button 2 clicked + BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked + BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked + BUTTON3_PRESSED mouse button 3 down + BUTTON3_RELEASED mouse button 3 up + BUTTON3_CLICKED mouse button 3 clicked + BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked + BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked + BUTTON4_PRESSED mouse button 4 down + BUTTON4_RELEASED mouse button 4 up + BUTTON4_CLICKED mouse button 4 clicked + BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked + BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked + BUTTON_SHIFT shift was down during button state change + BUTTON_CTRL control was down during button state change + BUTTON_ALT alt was down during button state change + ALL_MOUSE_EVENTS report all button state changes + REPORT_MOUSE_POSITION report mouse movement + + Once a class of mouse events have been made visible in a + window, calling the <B>wgetch</B> function on that window may + return <B>KEY_MOUSE</B> as an indicator that a mouse event has + been queued. To read the event data and pop the event off + the queue, call <B>getmouse</B>. This function will return <B>OK</B> if + a mouse event is actually visible in the given window, <B>ERR</B> + otherwise. When <B>getmouse</B> returns <B>OK</B>, the data deposited + as y and x in the event structure coordinates will be + screen-relative character-cell coordinates. The returned + state mask will have exactly one bit set to indicate the + event type. + + The <B>ungetmouse</B> function behaves analogously to <B>ungetch</B>. + It pushes a <B>KEY_MOUSE</B> event onto the input queue, and + associates with that event the given state data and + screen-relative character-cell coordinates. + + The <B>wenclose</B> function tests whether a given pair of + screen-relative character-cell coordinates is enclosed by + a given window, returning TRUE if it is and FALSE other- + wise. It is useful for determining what subset of the + screen windows enclose the location of a mouse event. + + The <B>wmouse_trafo</B> function transforms a given pair of coor- + dinates from stdscr-relative coordinates to screen-rela- + tive coordinates or vice versa. Please remember, that + stdscr-relative coordinates are not always identical to + screen-relative coordinates due to the mechanism to + reserve lines on top or bottom of the screen for other + purposes (ripoff() call, see also slk_... functions). If + the parameter <B>to_screen</B> is <B>TRUE</B>, the pointers <B>pY,</B> <B>pX</B> must + reference the coordinates of a location inside the window + <B>win</B>. They are converted to screen-relative coordinates and + returned through the pointers. If the conversion was suc- + cessful, the function returns <B>TRUE</B>. If one of the parame- + ters was NULL or the location is not inside the window, + <B>FALSE</B> is returned. If <B>to_screen</B> is <B>FALSE</B>, the pointers <B>pY,</B> + <B>pX</B> must reference screen-relative coordinates. They are + converted to stdscr-relative coordinates if the window <B>win</B> + encloses this point. In this case the function returns + <B>TRUE</B>. If one of the parameters is NULL or the point is not + inside the window, <B>FALSE</B> is returned. Please notice, that + the referenced coordinates are only replaced by the con- + verted coordinates if the transformation was successful. + + The <B>mouseinterval</B> function sets the maximum time (in thou- + sands of a second) that can elapse between press and + release events in order for them to be recognized as a + click. This function returns the previous interval value. + The default is one fifth of a second. + + Note that mouse events will be ignored when input is in + cooked mode, and will cause an error beep when cooked mode + is being simulated in a window by a function such as <B>get-</B> + <B>str</B> that expects a linefeed for input-loop termination. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>getmouse</B>, <B>ungetmouse</B> and <B>mouseinterval</B> return the integer + <B>ERR</B> upon failure or <B>OK</B> upon successful completion. <B>mouse-</B> + <B>mask</B> returns the mask of reportable events. <B>wenclose</B> and + <B>wmouse_trafo</B> are boolean functions returning <B>TRUE</B> or <B>FALSE</B> + depending on their test result. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These calls were designed for <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>, and are not + found in SVr4 curses, 4.4BSD curses, or any other previous + version of curses. + + The feature macro <B>NCURSES_MOUSE_VERSION</B> is provided so the + preprocessor can be used to test whether these features + are present (its value is 1). If the interface is + changed, the value of <B>NCURSES_MOUSE_VERSION</B> will be incre- + mented. + + The order of the <B>MEVENT</B> structure members is not guaran- + teed. Additional fields may be added to the structure in + the future. + + Under <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>, these calls are implemented using + either xterm's built-in mouse-tracking API or Alessandro + Rubini's gpm server. If you are using something other + than xterm and there is no gpm daemon running on your + machine, mouse events will not be visible to <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B> + (and the <B>wmousemask</B> function will always return <B>0</B>). + + The z member in the event structure is not presently used. + It is intended for use with touch screens (which may be + pressure-sensitive) or with 3D-mice/trackballs/power + gloves. + + +</PRE> +<H2>BUGS</H2><PRE> + Mouse events under xterm will not in fact be ignored dur- + ing cooked mode, if they have been enabled by <B>wmousemask</B>. + Instead, the xterm mouse report sequence will appear in + the string read. + + Mouse events under xterm will not be detected correctly in + a window with its keypad bit off, since they are inter- + preted as a variety of function key. Your terminfo + description must have <B>kmous</B> set to "\E[M" (the beginning + of the response from xterm for mouse clicks). + + Because there are no standard terminal responses that + would serve to identify terminals which support the xterm + mouse protocol, <B>ncurses</B> assumes that if your $DISPLAY + environment variable is set, and <B>kmous</B> is defined in the + terminal description, then the terminal may send mouse + events. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_move.3x.html b/ncurses-5.2/doc/html/man/curs_move.3x.html new file mode 100644 index 0000000..7a73e48 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_move.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>move</B>, <B>wmove</B> - move <B>curses</B> window cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>move(int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>int</B> <B>wmove(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines move the cursor associated with the window + to line <I>y</I> and column <I>x</I>. This routine does not move the + physical cursor of the terminal until <B>refresh</B> is called. + The position specified is relative to the upper left-hand + corner of the window, which is (0,0). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <B>ERR</B> upon failure and OK (SVr4 speci- + fies only "an integer value other than <B>ERR</B>") upon success- + ful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>move</B> may be a macro. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that if (y,x) is within a + multi-column character, the cursor is moved to the first + column of that character; however, this implementation + does not yet support the extended-level XSI multi-byte + characters. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_outopts.3x.html b/ncurses-5.2/doc/html/man/curs_outopts.3x.html new file mode 100644 index 0000000..a7a0a45 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_outopts.3x.html @@ -0,0 +1,188 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>clearok</B>, <B>idlok</B>, <B>idcok</B> <B>immedok</B>, <B>leaveok</B>, <B>setscrreg</B>, + <B>wsetscrreg</B>, <B>scrollok</B>, <B>nl</B>, <B>nonl</B> - <B>curses</B> output options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>clearok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>idlok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>void</B> <B>idcok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>void</B> <B>immedok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>leaveok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>setscrreg(int</B> <B>top,</B> <B>int</B> <B>bot);</B> + <B>int</B> <B>wsetscrreg(WINDOW</B> <B>*win,</B> <B>int</B> <B>top,</B> <B>int</B> <B>bot);</B> + <B>int</B> <B>scrollok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>int</B> <B>nl(void);</B> + <B>int</B> <B>nonl(void);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines set options that change the style of output + within <B>curses</B>. All options are initially <B>FALSE</B>, unless + otherwise stated. It is not necessary to turn these + options off before calling <B>endwin</B>. + + If <B>clearok</B> is called with <B>TRUE</B> as argument, the next call + to <B>wrefresh</B> with this window will clear the screen com- + pletely and redraw the entire screen from scratch. This + is useful when the contents of the screen are uncertain, + or in some cases for a more pleasing visual effect. If + the <I>win</I> argument to <B>clearok</B> is the global variable <B>curscr</B>, + the next call to <B>wrefresh</B> with any window causes the + screen to be cleared and repainted from scratch. + + If <B>idlok</B> is called with <B>TRUE</B> as second argument, <B>curses</B> + considers using the hardware insert/delete line feature of + terminals so equipped. Calling <B>idlok</B> with <B>FALSE</B> as second + argument disables use of line insertion and deletion. + This option should be enabled only if the application + needs insert/delete line, for example, for a screen edi- + tor. It is disabled by default because insert/delete line + tends to be visually annoying when used in applications + where it isn't really needed. If insert/delete line can- + not be used, <B>curses</B> redraws the changed portions of all + lines. + + If <B>idcok</B> is called with <B>FALSE</B> as second argument, <B>curses</B> + no longer considers using the hardware insert/delete char- + acter feature of terminals so equipped. Use of character + insert/delete is enabled by default. Calling <B>idcok</B> with + <B>TRUE</B> as second argument re-enables use of character inser- + tion and deletion. + + If <B>immedok</B> is called with <B>TRUE</B> <B>as</B> <B>argument</B>, any change in + the window image, such as the ones caused by <B>waddch,</B> + <B>wclrtobot,</B> <B>wscrl</B>, <I>etc</I>., automatically cause a call to <B>wre-</B> + <B>fresh</B>. However, it may degrade performance considerably, + due to repeated calls to <B>wrefresh</B>. It is disabled by + default. + + Normally, the hardware cursor is left at the location of + the window cursor being refreshed. The <B>leaveok</B> option + allows the cursor to be left wherever the update happens + to leave it. It is useful for applications where the cur- + sor is not used, since it reduces the need for cursor + motions. If possible, the cursor is made invisible when + this option is enabled. + + The <B>setscrreg</B> and <B>wsetscrreg</B> routines allow the applica- + tion programmer to set a software scrolling region in a + window. <I>top</I> and <I>bot</I> are the line numbers of the top and + bottom margin of the scrolling region. (Line 0 is the top + line of the window.) If this option and <B>scrollok</B> are + enabled, an attempt to move off the bottom margin line + causes all lines in the scrolling region to scroll one + line in the direction of the first line. Only the text of + the window is scrolled. (Note that this has nothing to do + with the use of a physical scrolling region capability in + the terminal, like that in the VT100. If <B>idlok</B> is enabled + and the terminal has either a scrolling region or + insert/delete line capability, they will probably be used + by the output routines.) + + The <B>scrollok</B> option controls what happens when the cursor + of a window is moved off the edge of the window or + scrolling region, either as a result of a newline action + on the bottom line, or typing the last character of the + last line. If disabled, (<I>bf</I> is <B>FALSE</B>), the cursor is left + on the bottom line. If enabled, (<I>bf</I> is <B>TRUE</B>), the window + is scrolled up one line (Note that in order to get the + physical scrolling effect on the terminal, it is also nec- + essary to call <B>idlok</B>). + + The <B>nl</B> and <B>nonl</B> routines control whether the underlying + display device translates the return key into newline on + input, and whether it translates newline into return and + line-feed on output (in either case, the call <B>addch('\n')</B> + does the equivalent of return and line feed on the virtual + screen). Initially, these translations do occur. If you + disable them using <B>nonl</B>, <B>curses</B> will be able to make bet- + ter use of the line-feed capability, resulting in faster + cursor motion. Also, <B>curses</B> will then be able to detect + the return key. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The functions <B>setscrreg</B> and <B>wsetscrreg</B> return <B>OK</B> upon suc- + cess and <B>ERR</B> upon failure. All other routines that return + an integer always return <B>OK</B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. + + The XSI Curses standard is ambiguous on the question of + whether <B>raw</B>() should disable the CRLF translations con- + trolled by <B>nl</B>() and <B>nonl</B>(). BSD curses did turn off these + translations; AT&T curses (at least as late as SVr1) did + not. We choose to do so, on the theory that a programmer + requesting raw input wants a clean (ideally 8-bit clean) + connection that the operating system does not mess with. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B> or <B>clear(std-</B> + <B>scr)</B>. This will not work under ncurses. + + Earlier System V curses implementations specified that + with <B>scrollok</B> enabled, any window modification triggering + a scroll also forced a physical refresh. XSI Curses does + not require this, and <B>ncurses</B> avoids doing it in order to + perform better vertical-motion optimization at <B>wrefresh</B> + time. + + The XSI Curses standard does not mention that the cursor + should be made invisible as a side-effect of <B>leaveok</B>. + SVr4 curses documentation does this, but the code does + not. Use <B>curs_set</B> to make the cursor invisible. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>clearok</B>, <B>leaveok</B>, <B>scrollok</B>, <B>idcok</B>, <B>nl</B>, <B>nonl</B> and + <B>setscrreg</B> may be macros. + + The <B>immedok</B> routine is useful for windows that are used as + terminal emulators. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>, <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B>, + <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_overlay.3x.html b/ncurses-5.2/doc/html/man/curs_overlay.3x.html new file mode 100644 index 0000000..d2af67a --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_overlay.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>overlay</B>, <B>overwrite</B>, <B>copywin</B> - overlay and manipulate over- + lapped <B>curses</B> windows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>overlay(const</B> <B>WINDOW</B> <B>*srcwin,</B> <B>WINDOW</B> <B>*dstwin);</B> + <B>int</B> <B>overwrite(const</B> <B>WINDOW</B> <B>*srcwin,</B> <B>WINDOW</B> <B>*dstwin);</B> + <B>int</B> <B>copywin(WINDOW</B> <B>*srcwin,</B> <B>WINDOW</B> <B>*dstwin,</B> <B>int</B> <B>sminrow,</B> + <B>int</B> <B>smincol,</B> <B>int</B> <B>dminrow,</B> <B>int</B> <B>dmincol,</B> <B>int</B> <B>dmaxrow,</B> + <B>int</B> <B>dmaxcol,</B> <B>int</B> <B>overlay);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>overlay</B> and <B>overwrite</B> routines overlay <I>srcwin</I> on top + of <I>dstwin</I>. <I>scrwin</I> and <I>dstwin</I> are not required to be the + same size; only text where the two windows overlap is + copied. The difference is that <B>overlay</B> is non-destructive + (blanks are not copied) whereas <B>overwrite</B> is destructive. + + The <B>copywin</B> routine provides a finer granularity of con- + trol over the <B>overlay</B> and <B>overwrite</B> routines. Like in the + <B>prefresh</B> routine, a rectangle is specified in the destina- + tion window, (<I>dminrow</I>, <I>dmincol</I>) and (<I>dmaxrow</I>, <I>dmaxcol</I>), + and the upper-left-corner coordinates of the source win- + dow, (<I>sminrow</I>, <I>smincol</I>). If the argument <I>overlay</I> is <B>true</B>, + then copying is non-destructive, as in <B>overlay</B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <B>ERR</B> upon failure, + and <B>OK</B> (SVr4 only specifies "an integer value other than + <B>ERR</B>") upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>overlay</B> and <B>overwrite</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these functions + (adding the const qualifiers). It further specifies their + behavior in the presence of characters with multi-byte + renditions (not yet supported in this implementation). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_pad.3x.html b/ncurses-5.2/doc/html/man/curs_pad.3x.html new file mode 100644 index 0000000..6172c57 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_pad.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>newpad</B>, <B>subpad</B>, <B>prefresh</B>, <B>pnoutrefresh</B>, <B>pechochar</B> - create + and display <B>curses</B> pads + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>WINDOW</B> <B>*newpad(int</B> <B>nlines,</B> <B>int</B> <B>ncols);</B> + <B>WINDOW</B> <B>*subpad(WINDOW</B> <B>*orig,</B> <B>int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> + <B>int</B> <B>begin_y,</B> <B>int</B> <B>begin_x);</B> + <B>int</B> <B>prefresh(WINDOW</B> <B>*pad,</B> <B>int</B> <B>pminrow,</B> <B>int</B> <B>pmincol,</B> + <B>int</B> <B>sminrow,</B> <B>int</B> <B>smincol,</B> <B>int</B> <B>smaxrow,</B> <B>int</B> <B>smaxcol);</B> + <B>int</B> <B>pnoutrefresh(WINDOW</B> <B>*pad,</B> <B>int</B> <B>pminrow,</B> <B>int</B> <B>pmincol,</B> + <B>int</B> <B>sminrow,</B> <B>int</B> <B>smincol,</B> <B>int</B> <B>smaxrow,</B> <B>int</B> <B>smaxcol);</B> + <B>int</B> <B>pechochar(WINDOW</B> <B>*pad,</B> <B>chtype</B> <B>ch);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>newpad</B> routine creates and returns a pointer to a new + pad data structure with the given number of lines, <I>nlines</I>, + and columns, <I>ncols</I>. A pad is like a window, except that + it is not restricted by the screen size, and is not neces- + sarily associated with a particular part of the screen. + Pads can be used when a large window is needed, and only a + part of the window will be on the screen at one time. + Automatic refreshes of pads (<I>e</I>.<I>g</I>., from scrolling or echo- + ing of input) do not occur. It is not legal to call <B>wre-</B> + <B>fresh</B> with a <I>pad</I> as an argument; the routines <B>prefresh</B> or + <B>pnoutrefresh</B> should be called instead. Note that these + routines require additional parameters to specify the part + of the pad to be displayed and the location on the screen + to be used for the display. + + The <B>subpad</B> routine creates and returns a pointer to a sub- + window within a pad with the given number of lines, + <I>nlines</I>, and columns, <I>ncols</I>. Unlike <B>subwin</B>, which uses + screen coordinates, the window is at position (<I>begin</I>_<I>x</I><B>,</B> + <I>begin</I>_<I>y</I>) on the pad. The window is made in the middle of + the window <I>orig</I>, so that changes made to one window affect + both windows. During the use of this routine, it will + often be necessary to call <B>touchwin</B> or <B>touchline</B> on <I>orig</I> + before calling <B>prefresh</B>. + + The <B>prefresh</B> and <B>pnoutrefresh</B> routines are analogous to + <B>wrefresh</B> and <B>wnoutrefresh</B> except that they relate to pads + instead of windows. The additional parameters are needed + to indicate what part of the pad and screen are involved. + <I>pminrow</I> and <I>pmincol</I> specify the upper left-hand corner of + the rectangle to be displayed in the pad. <I>sminrow</I>, <I>smin-</I> + <I>col</I>, <I>smaxrow</I>, and <I>smaxcol</I> specify the edges of the rectan- + gle to be displayed on the screen. The lower right-hand + corner of the rectangle to be displayed in the pad is cal- + culated from the screen coordinates, since the rectangles + must be the same size. Both rectangles must be entirely + contained within their respective structures. Negative + values of <I>pminrow</I>, <I>pmincol</I>, <I>sminrow</I>, or <I>smincol</I> are + treated as if they were zero. + + The <B>pechochar</B> routine is functionally equivalent to a call + to <B>addch</B> followed by a call to <B>refresh</B>, a call to <B>waddch</B> + followed by a call to <B>wrefresh</B>, or a call to <B>waddch</B> fol- + lowed by a call to <B>prefresh.</B> The knowledge that only a + single character is being output is taken into considera- + tion and, for non-control characters, a considerable per- + formance gain might be seen by using these routines + instead of their equivalents. In the case of <B>pechochar</B>, + the last location of the pad on the screen is reused for + the arguments to <B>prefresh</B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <B>ERR</B> upon failure + and <B>OK</B> (SVr4 only specifies "an integer value other than + <B>ERR</B>") upon successful completion. + + Routines that return pointers return <B>NULL</B> on error, and + set <B>errno</B> to <B>ENOMEM</B>. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>pechochar</B> may be a macro. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B>, + <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_print.3x.html b/ncurses-5.2/doc/html/man/curs_print.3x.html new file mode 100644 index 0000000..1319ba6 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_print.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mcprint</B> - ship binary data to printer + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>mcprint(char</B> <B>*data,</B> <B>int</B> <B>len);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This function uses the <B>mc5p</B> or <B>mc4</B> and <B>mc5</B> capabilities, + if they are present, to ship given data to a printer + attached to the terminal. + + Note that the <B>mcprint</B> code has no way to do flow control + with the printer or to know how much buffering it has. + Your application is responsible for keeping the rate of + writes to the printer below its continuous throughput rate + (typically about half of its nominal cps rating). Dot- + matrix printers and 6-page-per-minute lasers can typically + handle 80cps, so a good conservative rule of thumb is to + sleep for a second after shipping each 80-character line. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The <B>mcprint</B> function returns <B>ERR</B> if the write operation + aborted for some reason. In this case, errno will contain + either an error associated with <B>write(2)</B> or one of the + following: + + ENODEV + Capabilities for printer redirection don't exist. + + ENOMEM + Couldn't allocate sufficient memory to buffer the + printer write. + + When <B>mcprint</B> succeeds, it returns the number of char- + acters actually sent to the printer. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <B>mcprint</B> call was designed for <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>, and is not + found in SVr4 curses, 4.4BSD curses, or any other previous + version of curses. + + +</PRE> +<H2>BUGS</H2><PRE> + Padding in the <B>mc5p</B>, <B>mc4</B> and <B>mc5</B> capabilities will not be + interpreted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_printw.3x.html b/ncurses-5.2/doc/html/man/curs_printw.3x.html new file mode 100644 index 0000000..95424b3 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_printw.3x.html @@ -0,0 +1,78 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>printw</B>, <B>wprintw</B>, <B>mvprintw</B>, <B>mvwprintw</B>, <B>vwprintw</B>, <B>vw_printw</B> + - print formatted output in <B>curses</B> windows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>printw(char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B> + <B>int</B> <B>wprintw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B> + <B>int</B> <B>mvprintw(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B> + <B>int</B> <B>mvwprintw(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> + <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg]</B> ...); + + <B>#include</B> <B><varargs.h></B> + <B>int</B> <B>vwprintw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>varglist);</B> + <B>int</B> <B>vw_printw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>varglist);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>printw</B>, <B>wprintw</B>, <B>mvprintw</B> and <B>mvwprintw</B> routines are + analogous to <B>printf</B> [see <B><A HREF="printf.3S.html">printf(3S)</A></B>]. In effect, the + string that would be output by <B>printf</B> is output instead as + though <B>waddstr</B> were used on the given window. + + The <B>vwprintw</B> routine is analogous to <B>vprintf</B> [see + <B><A HREF="printf.3S.html">printf(3S)</A></B>] and performs a <B>wprintw</B> using a variable argu- + ment list. The third argument is a <B>va_list</B>, a pointer to + a list of arguments, as defined in <B><varargs.h></B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <B>ERR</B> upon failure + and <B>OK</B> (SVr4 only specifies "an integer value other than + <B>ERR</B>") upon successful completion. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. The function <B>vwprintw</B> is marked TO BE WITHDRAWN, + and is to be replaced by a function <B>vw_printw</B> using the + <B><stdarg.h></B> interface. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="printf.3S.html">printf(3S)</A></B>, <B>vprintf(3S)</B> + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_refresh.3x.html b/ncurses-5.2/doc/html/man/curs_refresh.3x.html new file mode 100644 index 0000000..a0c616c --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_refresh.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>refresh</B>, <B>wrefresh</B>, <B>wnoutrefresh</B>, <B>doupdate</B>, <B>redrawwin</B>, <B>wre-</B> + <B>drawln</B> - refresh <B>curses</B> windows and lines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>refresh(void);</B> + <B>int</B> <B>wrefresh(WINDOW</B> <B>*win);</B> + <B>int</B> <B>wnoutrefresh(WINDOW</B> <B>*win);</B> + <B>int</B> <B>doupdate(void);</B> + <B>int</B> <B>redrawwin(WINDOW</B> <B>*win);</B> + <B>int</B> <B>wredrawln(WINDOW</B> <B>*win,</B> <B>int</B> <B>beg_line,</B> <B>int</B> <B>num_lines);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>refresh</B> and <B>wrefresh</B> routines (or <B>wnoutrefresh</B> and + <B>doupdate</B>) must be called to get actual output to the ter- + minal, as other routines merely manipulate data struc- + tures. The routine <B>wrefresh</B> copies the named window to + the physical terminal screen, taking into account what is + already there in order to do optimizations. The <B>refresh</B> + routine is the same, using <B>stdscr</B> as the default window. + Unless <B>leaveok</B> has been enabled, the physical cursor of + the terminal is left at the location of the cursor for + that window. + + The <B>wnoutrefresh</B> and <B>doupdate</B> routines allow multiple + updates with more efficiency than <B>wrefresh</B> alone. In + addition to all the window structures, <B>curses</B> keeps two + data structures representing the terminal screen: a physi- + cal screen, describing what is actually on the screen, and + a virtual screen, describing what the programmer wants to + have on the screen. + + The routine <B>wrefresh</B> works by first calling <B>wnoutrefresh</B>, + which copies the named window to the virtual screen, and + then calling <B>doupdate</B>, which compares the virtual screen + to the physical screen and does the actual update. If the + programmer wishes to output several windows at once, a + series of calls to <B>wrefresh</B> results in alternating calls + to <B>wnoutrefresh</B> and <B>doupdate</B>, causing several bursts of + output to the screen. By first calling <B>wnoutrefresh</B> for + each window, it is then possible to call <B>doupdate</B> once, + resulting in only one burst of output, with fewer total + characters transmitted and less CPU time used. If the <I>win</I> + argument to <B>wrefresh</B> is the global variable <B>curscr</B>, the + screen is immediately cleared and repainted from scratch. + + The phrase "copies the named window to the virtual screen" + above is ambiguous. What actually happens is that all + <I>touched</I> (changed) lines in the window are copied to the + virtual screen. This affects programs that use overlap- + ping windows; it means that if two windows overlap, you + can refresh them in either order and the overlap region + will be modified only when it is explicitly changed. (But + see the section on <B>PORTABILITY</B> below for a warning about + exploiting this behavior.) + + The <B>wredrawln</B> routine indicates to <B>curses</B> that some screen + lines are corrupted and should be thrown away before any- + thing is written over them. It touches the indicated + lines (marking them changed). The routine <B>redrawwin</B>() + touches the entire window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <B>ERR</B> upon failure, + and <B>OK</B> (SVr4 only specifies "an integer value other than + <B>ERR</B>") upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>refresh</B> and <B>redrawwin</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + Whether <B>wnoutrefresh()</B> copies to the virtual screen the + entire contents of a window or just its changed portions + has never been well-documented in historic curses versions + (including SVr4). It might be unwise to rely on either + behavior in programs that might have to be linked with + other curses implementations. Instead, you can do an + explicit <B>touchwin()</B> before the <B>wnoutrefresh()</B> call to + guarantee an entire-contents copy anywhere. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_scanw.3x.html b/ncurses-5.2/doc/html/man/curs_scanw.3x.html new file mode 100644 index 0000000..1fb1ba9 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_scanw.3x.html @@ -0,0 +1,78 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>scanw</B>, <B>wscanw</B>, <B>mvscanw</B>, <B>mvwscanw</B>, <B>vwscanw</B>, <B>vw_scanw</B> - con- + vert formatted input from a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>scanw(char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B> + <B>int</B> <B>wscanw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B> + <B>int</B> <B>mvscanw(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B> + <B>int</B> <B>mvwscanw(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> + <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg]</B> <B>...);</B> + <B>int</B> <B>vw_scanw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>va_list</B> <B>varglist);</B> + <B>int</B> <B>vwscanw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>va_list</B> <B>varglist);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>scanw</B>, <B>wscanw</B> and <B>mvscanw</B> routines are analogous to + <B>scanf</B> [see <B><A HREF="scanf.3S.html">scanf(3S)</A></B>]. The effect of these routines is as + though <B>wgetstr</B> were called on the window, and the result- + ing line used as input for <B><A HREF="sscanf.3.html">sscanf(3)</A></B>. Fields which do not + map to a variable in the <I>fmt</I> field are lost. + + The <B>vwscanw</B> routine is similar to <B>vwprintw</B> in that it per- + forms a <B>wscanw</B> using a variable argument list. The third + argument is a <I>va</I>_<I>list</I>, a pointer to a list of arguments, + as defined in <B><varargs.h></B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>vwscanw</B> returns <B>ERR</B> on failure and an integer equal to the + number of fields scanned on success. + + Applications may use the return value from the <B>scanw</B>, + <B>wscanw</B>, <B>mvscanw</B> and <B>mvwscanw</B> routines to determine the + number of fields which were mapped in the call. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. The function <B>vwscanw</B> is marked TO BE WITHDRAWN, + and is to be replaced by a function <B>vw_scanw</B> using the + <B><stdarg.h></B> interface. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B>, <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B>, <B><A HREF="scanf.3S.html">scanf(3S)</A></B> + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_scr_dump.3x.html b/ncurses-5.2/doc/html/man/curs_scr_dump.3x.html new file mode 100644 index 0000000..7931102 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_scr_dump.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>scr_dump</B>, <B>scr_restore</B>, <B>scr_init</B>, <B>scr_set</B> - read (write) a + <B>curses</B> screen from (to) a file + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>scr_dump(const</B> <B>char</B> <B>*filename);</B> + <B>int</B> <B>scr_restore(const</B> <B>char</B> <B>*filename);</B> + <B>int</B> <B>scr_init(const</B> <B>char</B> <B>*filename);</B> + <B>int</B> <B>scr_set(const</B> <B>char</B> <B>*filename);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>scr_dump</B> routine dumps the current contents of the + virtual screen to the file <I>filename</I>. + + The <B>scr_restore</B> routine sets the virtual screen to the + contents of <I>filename</I>, which must have been written using + <B>scr_dump</B>. The next call to <B>doupdate</B> restores the screen + to the way it looked in the dump file. + + The <B>scr_init</B> routine reads in the contents of <I>filename</I> and + uses them to initialize the <B>curses</B> data structures about + what the terminal currently has on its screen. If the + data is determined to be valid, <B>curses</B> bases its next + update of the screen on this information rather than + clearing the screen and starting from scratch. <B>scr_init</B> + is used after <B>initscr</B> or a <B>system</B> [see <B>system</B>(BA_LIB)] + call to share the screen with another process which has + done a <B>scr_dump</B> after its <B>endwin</B> call. The data is + declared invalid if the terminfo capabilities <B>rmcup</B> and + <B>nrrmc</B> exist; also if the terminal has been written to + since the preceding <B>scr_dump</B> call. + + The <B>scr_set</B> routine is a combination of <B>scr_restore</B> and + <B>scr_init</B>. It tells the program that the information in + <I>filename</I> is what is currently on the screen, and also what + the program wants on the screen. This can be thought of + as a screen inheritance function. + + To read (write) a window from (to) a file, use the <B>getwin</B> + and <B>putwin</B> routines [see <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B>]. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and <B>OK</B> + upon success. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>scr_init</B>, <B>scr_set</B>, and <B>scr_restore</B> may be + macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4, describes these func- + tions (adding the const qualifiers). + The SVr4 docs merely say under <B>scr_init</B> that the dump data + is also considered invalid "if the time-stamp of the tty + is old" but don't define "old". + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, + <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B>, <B><A HREF="system.3S.html">system(3S)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_scroll.3x.html b/ncurses-5.2/doc/html/man/curs_scroll.3x.html new file mode 100644 index 0000000..fb2abac --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_scroll.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>scroll</B>, <B>scrl</B>, <B>wscrl</B> - scroll a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>scroll(WINDOW</B> <B>*win);</B> + <B>int</B> <B>scrl(int</B> <B>n);</B> + <B>int</B> <B>wscrl(WINDOW</B> <B>*win,</B> <B>int</B> <B>n);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>scroll</B> routine scrolls the window up one line. This + involves moving the lines in the window data structure. + As an optimization, if the scrolling region of the window + is the entire screen, the physical screen may be scrolled + at the same time. + + For positive <I>n</I>, the <B>scrl</B> and <B>wscrl</B> routines scroll the + window up <I>n</I> lines (line <I>i</I>+<I>n</I> becomes <I>i</I>); otherwise scroll + the window down <I>n</I> lines. This involves moving the lines + in the window character image structure. The current cur- + sor position is not changed. + + For these functions to work, scrolling must be enabled via + <B>scrollok</B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <B>ERR</B> upon failure, and <B>OK</B> (SVr4 only + specifies "an integer value other than <B>ERR</B>") upon success- + ful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>scrl</B> and <B>scroll</B> may be macros. + + The SVr4 documentation says that the optimization of phys- + ically scrolling immediately if the scroll region is the + entire screen "is" performed, not "may be" performed. + This implementation deliberately does not guarantee that + this will occur, in order to leave open the possibility of + smarter optimization of multiple scroll actions on the + next update. + + Neither the SVr4 nor the XSI documentation specify whether + the current attribute or current color-pair of blanks gen- + erated by the scroll function is zeroed. Under this + implementation it is. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_slk.3x.html b/ncurses-5.2/doc/html/man/curs_slk.3x.html new file mode 100644 index 0000000..cf77d62 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_slk.3x.html @@ -0,0 +1,188 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>slk_init</B>, <B>slk_set</B>, <B>slk_refresh</B>, <B>slk_noutrefresh</B>, + <B>slk_label</B>, <B>slk_clear</B>, <B>slk_restore</B>, <B>slk_touch</B>, <B>slk_attron</B>, + <B>slk_attrset</B>, <B>slk_attroff</B>, <B>slk_attr_on</B>, <B>slk_attr_set</B>, + <B>slk_attr_off</B>, <B>slk_attr</B> <B>slk_color</B> - <B>curses</B> soft label rou- + tines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>slk_init(int</B> <B>fmt);</B> + <B>int</B> <B>slk_set(int</B> <B>labnum,</B> <B>const</B> <B>char</B> <B>*label,</B> <B>int</B> <B>fmt);</B> + <B>int</B> <B>slk_refresh(void);</B> + <B>int</B> <B>slk_noutrefresh(void);</B> + <B>char</B> <B>*slk_label(int</B> <B>labnum);</B> + <B>int</B> <B>slk_clear(void);</B> + <B>int</B> <B>slk_restore(void);</B> + <B>int</B> <B>slk_touch(void);</B> + <B>int</B> <B>slk_attron(const</B> <B>chtype</B> <B>attrs);</B> + <B>int</B> <B>slk_attroff(const</B> <B>chtype</B> <B>attrs);</B> + <B>int</B> <B>slk_attrset(const</B> <B>chtype</B> <B>attrs);</B> + <B>int</B> <B>slk_attr_on(attr_t</B> <B>attrs,</B> <B>void*</B> <B>opts);</B> + <B>int</B> <B>slk_attr_off(const</B> <B>attr_t</B> <B>attrs,</B> <B>void</B> <B>*</B> <B>opts);</B> + <B>int</B> <B>slk_attr_set(const</B> <B>attr_t</B> <B>attrs,</B> + <B>short</B> <B>color_pair_number,</B> <B>void*</B> <B>opts);</B> + <B>attr_t</B> <B>slk_attr(void);</B> + <B>int</B> <B>slk_color(short</B> <B>color_pair_number);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The slk* functions manipulate the set of soft function-key + labels that exist on many terminals. For those terminals + that do not have soft labels, <B>curses</B> takes over the bottom + line of <B>stdscr</B>, reducing the size of <B>stdscr</B> and the vari- + able <B>LINES</B>. <B>curses</B> standardizes on eight labels of up to + eight characters each. In addition to this, the ncurses + implementation supports a mode where it simulates 12 + labels of up to five characters each. This is most common + for todays PC like enduser devices. Please note that + ncurses simulates this mode by taking over up to two lines + at the bottom of the screen, it doesn't try to use any + hardware support for this mode. + + The <B>slk_init</B> routine must be called before <B>initscr</B> or + <B>newterm</B> is called. If <B>initscr</B> eventually uses a line from + <B>stdscr</B> to emulate the soft labels, then <I>fmt</I> determines how + the labels are arranged on the screen. Setting <I>fmt</I> to <B>0</B> + indicates a 3-2-3 arrangement of the labels, <B>1</B> indicates a + 4-4 arrangement and <B>2</B> indicates the PC like 4-4-4 mode. If + <B>fmt</B> is set to <B>3</B>, it is again the PC like 4-4-4 mode, but + in addition an index line is generated, helping the user + to identify the key numbers easily. + + The <B>slk_set</B> routine requires <I>labnum</I> to be a label number, + from <B>1</B> to <B>8</B> (resp. <B>12</B>); <I>label</I> must be the string to be put + on the label, up to eight (resp. five) characters in + length. A null string or a null pointer sets up a blank + label. <I>fmt</I> is either <B>0</B>, <B>1</B>, or <B>2</B>, indicating whether the + label is to be left-justified, centered, or right-justi- + fied, respectively, within the label. + + The <B>slk_refresh</B> and <B>slk_noutrefresh</B> routines correspond to + the <B>wrefresh</B> and <B>wnoutrefresh</B> routines. + + The <B>slk_label</B> routine returns the current label for label + number <I>labnum</I>, with leading and trailing blanks stripped. + + The <B>slk_clear</B> routine clears the soft labels from the + screen. + + The <B>slk_restore</B> routine, restores the soft labels to the + screen after a <B>slk_clear</B> has been performed. + + The <B>slk_touch</B> routine forces all the soft labels to be + output the next time a <B>slk_noutrefresh</B> is performed. + + The <B>slk_attron</B>, <B>slk_attrset</B>, <B>slk_attroff</B> and <B>slk_attr</B> rou- + tines correspond to <B>attron</B>, <B>attrset</B>, <B>attroff</B> and <B>attr_get</B>. + They have an effect only if soft labels are simulated on + the bottom line of the screen. The default highlight for + soft keys is A_STANDOUT (as in System V curses, which does + not document this fact). + + The <B>slk_color</B> routine corresponds to <B>color_set</B>. It has an + effect only if soft labels are simulated on the bottom + line of the screen. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return <B>ERR</B> upon failure and OK (SVr4 speci- + fies only "an integer value other than <B>ERR</B>") upon success- + ful completion. <B>slk_attr</B> returns the attribute used for + the soft keys. + + <B>slk_label</B> returns <B>NULL</B> on error. + + +</PRE> +<H2>NOTES</H2><PRE> + Most applications would use <B>slk_noutrefresh</B> because a <B>wre-</B> + <B>fresh</B> is likely to follow soon. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4, describes these func- + tions. It changes the argument type of the attribute- + manipulation functions <B>slk_attron</B>, <B>slk_attroff</B>, + <B>slk_attrset</B> to be <B>attr_t</B>, and adds <B>const</B> qualifiers. The + format codes <B>2</B> and <B>3</B> for <B>slk_init()</B> and the function + <B>slk_attr</B> are specific to ncurses. + + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, + <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_termattrs.3x.html b/ncurses-5.2/doc/html/man/curs_termattrs.3x.html new file mode 100644 index 0000000..2119177 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_termattrs.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>baudrate</B>, <B>erasechar</B>, <B>has_ic</B>, <B>has_il</B>, <B>killchar</B>, <B>longname</B>, + <B>termattrs</B>, <B>termname</B> - <B>curses</B> environment query routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>baudrate(void);</B> + <B>char</B> <B>erasechar(void);</B> + <B>bool</B> <B>has_ic(void);</B> + <B>bool</B> <B>has_il(void);</B> + <B>char</B> <B>killchar(void);</B> + <B>char</B> <B>*longname(void);</B> + <B>attr_t</B> <B>termattrs(void);</B> + <B>char</B> <B>*termname(void);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>baudrate</B> routine returns the output speed of the ter- + minal. The number returned is in bits per second, for + example <B>9600</B>, and is an integer. + + The <B>erasechar</B> routine returns the user's current erase + character. + + The <B>has_ic</B> routine is true if the terminal has insert- and + delete- character capabilities. + + The <B>has_il</B> routine is true if the terminal has insert- and + delete-line capabilities, or can simulate them using + scrolling regions. This might be used to determine if it + would be appropriate to turn on physical scrolling using + <B>scrollok</B>. + + The <B>killchar</B> routine returns the user's current line kill + character. + + The <B>longname</B> routine returns a pointer to a static area + containing a verbose description of the current terminal. + The maximum length of a verbose description is 128 charac- + ters. It is defined only after the call to <B>initscr</B> or + <B>newterm</B>. The area is overwritten by each call to <B>newterm</B> + and is not restored by <B>set_term</B>, so the value should be + saved between calls to <B>newterm</B> if <B>longname</B> is going to be + used with multiple terminals. + + If a given terminal doesn't support a video attribute that + an application program is trying to use, <B>curses</B> may sub- + stitute a different video attribute for it. The <B>termattrs</B> + function returns a logical <B>OR</B> of all video attributes sup- + ported by the terminal. This information is useful when a + <B>curses</B> program needs complete control over the appearance + of the screen. + + The <B>termname</B> routine returns the value of the + environmental variable <B>TERM</B> (truncated to 14 characters). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>longname</B> and <B>termname</B> return <B>NULL</B> on error. + + Routines that return an integer return <B>ERR</B> upon failure + and <B>OK</B> (SVr4 only specifies "an integer value other than + <B>ERR</B>") upon successful completion. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>termattrs</B> may be a macro. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. It changes the return type of <B>termattrs</B> to the new + type <B>attr_t</B>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_termcap.3x.html b/ncurses-5.2/doc/html/man/curs_termcap.3x.html new file mode 100644 index 0000000..a301dd1 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_termcap.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>tgetent</B>, <B>tgetflag</B>, <B>tgetnum</B>, <B>tgetstr</B>, <B>tgoto</B>, <B>tputs</B> - direct + <B>curses</B> interface to the terminfo capability database + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>#include</B> <B><term.h></B> + <B>int</B> <B>tgetent(const</B> <B>char</B> <B>*bp,</B> <B>char</B> <B>*name);</B> + <B>int</B> <B>tgetflag(const</B> <B>char</B> <B>*id);</B> + <B>int</B> <B>tgetnum(const</B> <B>char</B> <B>*id);</B> + <B>char</B> <B>*tgetstr(const</B> <B>char</B> <B>*id,</B> <B>char</B> <B>**area);</B> + <B>char</B> <B>*tgoto(const</B> <B>char</B> <B>*cap,</B> <B>int</B> <B>col,</B> <B>int</B> <B>row);</B> + <B>int</B> <B>tputs(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>affcnt,</B> <B>int</B> <B>(*putc)(int));</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These routines are included as a conversion aid for pro- + grams that use the <I>termcap</I> library. Their parameters are + the same and the routines are emulated using the <I>terminfo</I> + database. Thus, they can only be used to query the capa- + bilities of entries for which a terminfo entry has been + compiled. + + The <B>tgetent</B> routine loads the entry for <I>name</I>. It returns + 1 on success, 0 if there is no such entry, and -1 if the + terminfo database could not be found. The emulation + ignores the buffer pointer <I>bp</I>. + + The <B>tgetflag</B> routine gets the boolean entry for <I>id</I>, or + zero if it is not available. + + The <B>tgetnum</B> routine gets the numeric entry for <I>id</I>, or -1 + if it is not available. + + The <B>tgetstr</B> routine returns the string entry for <I>id</I>, or + zero if it is not available. Use <B>tputs</B> to output the + returned string. The return value will also be copied to + the buffer pointed to by <I>area</I>, and the <I>area</I> value will be + updated to point past the null ending this value. + + The <B>tgoto</B> routine instantiates the parameters into the + given capability. The output from this routine is to be + passed to <B>tputs</B>. + + The <B>tputs</B> routine is described on the <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + manual page. It can retrieve capabilities by either term- + cap or terminfo name. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except where explicitly noted, routines that return an + integer return <B>ERR</B> upon failure and <B>OK</B> (SVr4 only speci- + fies "an integer value other than <B>ERR</B>") upon successful + completion. + + Routines that return pointers return <B>NULL</B> on error. + + +</PRE> +<H2>BUGS</H2><PRE> + If you call <B>tgetstr</B> to fetch <B>ca</B> or any other parameterized + string, be aware that it will be returned in terminfo + notation, not the older and not-quite-compatible termcap + notation. This won't cause problems if all you do with it + is call <B>tgoto</B> or <B>tparm</B>, which both expand terminfo-style. + + Because terminfo conventions for representing padding in + string capabilities differ from termcap's, <B>tputs("50");</B> + will put out a literal "50" rather than busy-waiting for + 50 milliseconds. Cope with it. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. However, they are marked TO BE WITHDRAWN and may + be removed in future versions. + + Neither the XSI Curses standard nor the SVr4 man pages + documented the return values of <B>tgetent</B> correctly, though + all three were in fact returned ever since SVr1. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>, <B><A HREF="putc.3S.html">putc(3S)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_terminfo.3x.html b/ncurses-5.2/doc/html/man/curs_terminfo.3x.html new file mode 100644 index 0000000..8a53cbc --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_terminfo.3x.html @@ -0,0 +1,296 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>setupterm</B>, <B>setterm</B>, <B>set_curterm</B>, <B>del_curterm</B>, <B>restartterm</B>, + <B>tparm</B>, <B>tputs</B>, <B>putp</B>, <B>vidputs</B>, <B>vidattr</B>, <B>mvcur</B>, <B>tigetflag</B>, + <B>tigetnum</B>, <B>tigetstr</B> - <B>curses</B> interfaces to terminfo + database + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>#include</B> <B><term.h></B> + + <B>int</B> <B>setupterm(const</B> <B>char</B> <B>*term,</B> <B>int</B> <B>fildes,</B> <B>int</B> <B>*errret);</B> + <B>int</B> <B>setterm(const</B> <B>char</B> <B>*term);</B> + <B>TERMINAL</B> <B>*set_curterm(TERMINAL</B> <B>*nterm);</B> + <B>int</B> <B>del_curterm(TERMINAL</B> <B>*oterm);</B> + <B>int</B> <B>restartterm(const</B> <B>char</B> <B>*term,</B> <B>int</B> <B>fildes,</B> <B>int</B> + <B>*errret);</B> + <B>char</B> <B>*tparm(const</B> <B>char</B> <B>*str,</B> <B>...);</B> + <B>int</B> <B>tputs(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>affcnt,</B> <B>int</B> <B>(*putc)(int));</B> + <B>int</B> <B>putp(const</B> <B>char</B> <B>*str);</B> + <B>int</B> <B>vidputs(chtype</B> <B>attrs,</B> <B>int</B> <B>(*putc)(char));</B> + <B>int</B> <B>vidattr(chtype</B> <B>attrs);</B> + <B>int</B> <B>mvcur(int</B> <B>oldrow,</B> <B>int</B> <B>oldcol,</B> <B>int</B> <B>newrow,</B> <B>int</B> <B>newcol);</B> + <B>int</B> <B>tigetflag(const</B> <B>char</B> <B>*capname);</B> + <B>int</B> <B>tigetnum(const</B> <B>char</B> <B>*capname);</B> + <B>char</B> <B>*tigetstr(const</B> <B>char</B> <B>*capname);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These low-level routines must be called by programs that + have to deal directly with the <B>terminfo</B> database to handle + certain terminal capabilities, such as programming func- + tion keys. For all other functionality, <B>curses</B> routines + are more suitable and their use is recommended. + + Initially, <B>setupterm</B> should be called. Note that + <B>setupterm</B> is automatically called by <B>initscr</B> and <B>newterm</B>. + This defines the set of terminal-dependent variables + [listed in <B><A HREF="terminfo.5.html">terminfo(5)</A></B>]. The <B>terminfo</B> variables <B>lines</B> and + <B>columns</B> are initialized by <B>setupterm</B> as follows: If + <B>use_env(FALSE)</B> has been called, values for <B>lines</B> and + <B>columns</B> specified in <B>terminfo</B> are used. Otherwise, if the + environment variables <B>LINES</B> and <B>COLUMNS</B> exist, their val- + ues are used. If these environment 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 <B>lines</B> and <B>columns</B> specified in + the <B>terminfo</B> database are used. + + The header files <B>curses.h</B> and <B>term.h</B> should be included + (in this order) to get the definitions for these strings, + numbers, and flags. Parameterized strings should be + passed through <B>tparm</B> to instantiate them. All <B>terminfo</B> + strings [including the output of <B>tparm</B>] should be printed + with <B>tputs</B> or <B>putp</B>. Call the <B>reset_shell_mode</B> to restore + the tty modes before exiting [see <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B>]. + Programs which use cursor addressing should output + <B>enter_ca_mode</B> upon startup and should output <B>exit_ca_mode</B> + before exiting. Programs desiring shell escapes should + call + + <B>reset_shell_mode</B> and output <B>exit_ca_mode</B> before the shell + is called and should output <B>enter_ca_mode</B> and call + <B>reset_prog_mode</B> after returning from the shell. + + The <B>setupterm</B> routine reads in the <B>terminfo</B> database, ini- + tializing the <B>terminfo</B> structures, but does not set up the + output virtualization structures used by <B>curses</B>. The ter- + minal type is the character string <I>term</I>; if <I>term</I> is null, + the environment variable <B>TERM</B> is used. All output is to + file descriptor <B>fildes</B> which is initialized for output. + If <I>errret</I> is not null, then <B>setupterm</B> returns <B>OK</B> or <B>ERR</B> + and stores a status value in the integer pointed to by + <I>errret</I>. A return value of <B>OK</B> combined with status of <B>1</B> in + <I>errret</I> is normal. If <B>ERR</B> is returned, examine <I>errret</I>: + + <B>1</B> means that the terminal is hardcopy, cannot be + used for curses applications. + + <B>0</B> means that the terminal could not be found, or + that it is a generic type, having too little + information for curses applications to run. + + <B>-1</B> means that the <B>terminfo</B> database could not be + found. + + If <I>errret</I> is null, <B>setupterm</B> prints an error message upon + finding an error and exits. Thus, the simplest call is: + + <B>setupterm((char</B> <B>*)0,</B> <B>1,</B> <B>(int</B> <B>*)0);</B>, + + which uses all the defaults and sends the output to <B>std-</B> + <B>out</B>. + + The <B>setterm</B> routine is being replaced by <B>setupterm</B>. The + call: + + <B>setupterm(</B><I>term</I><B>,</B> <B>1,</B> <B>(int</B> <B>*)0)</B> + + provides the same functionality as <B>setterm(</B><I>term</I><B>)</B>. The + <B>setterm</B> routine is included here for BSD compatibility, + and is not recommended for new programs. + + The <B>set_curterm</B> routine sets the variable <B>cur_term</B> to + <I>nterm</I>, and makes all of the <B>terminfo</B> boolean, numeric, and + string variables use the values from <I>nterm</I>. It returns + the old value of <B>cur_term</B>. + + The <B>del_curterm</B> routine frees the space pointed to by + <I>oterm</I> and makes it available for further use. If <I>oterm</I> is + the same as <B>cur_term</B>, references to any of the <B>terminfo</B> + boolean, numeric, and string variables thereafter may + refer to invalid memory locations until another <B>setupterm</B> + has been called. + + The <B>restartterm</B> routine is similar to <B>setupterm</B> and + <B>initscr</B>, 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, + does a setupterm, and then restores the bits. + + The <B>tparm</B> routine instantiates the string <I>str</I> with parame- + ters <I>pi</I>. A pointer is returned to the result of <I>str</I> with + the parameters applied. + + The <B>tputs</B> routine applies padding information to the + string <I>str</I> and outputs it. The <I>str</I> must be a terminfo + string variable or the return value from <B>tparm</B>, <B>tgetstr</B>, + or <B>tgoto</B>. <I>affcnt</I> is the number of lines affected, or 1 if + not applicable. <I>putc</I> is a <B>putchar</B>-like routine to which + the characters are passed, one at a time. + + The <B>putp</B> routine calls <B>tputs(</B><I>str</I><B>,</B> <B>1,</B> <B>putchar)</B>. Note that + the output of <B>putp</B> always goes to <B>stdout</B>, not to the + <I>fildes</I> specified in <B>setupterm</B>. + + The <B>vidputs</B> routine displays the string on the terminal in + the video attribute mode <I>attrs</I>, which is any combination + of the attributes listed in <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. The characters + are passed to the <B>putchar</B>-like routine <I>putc</I>. + + The <B>vidattr</B> routine is like the <B>vidputs</B> routine, except + that it outputs through <B>putchar</B>. + + The <B>mvcur</B> routine provides low-level cursor motion. It + takes effect immediately (rather than at the next + refresh). + + The <B>tigetflag</B>, <B>tigetnum</B> and <B>tigetstr</B> routines return the + value of the capability corresponding to the <B>terminfo</B> <I>cap-</I> + <I>name</I> passed to them, such as <B>xenl</B>. + + The <B>tigetflag</B> routine returns the value <B>-1</B> if <I>capname</I> is + not a boolean capability, or <B>0</B> if it is canceled or absent + from the terminal description. + + The <B>tigetnum</B> routine returns the value <B>-2</B> if <I>capname</I> is + not a numeric capability, or <B>-1</B> if it is canceled or + absent from the terminal description. + + The <B>tigetstr</B> routine returns the value <B>(char</B> <B>*)-1</B> if + <I>capname</I> is not a string capability, or <B>0</B> if it is canceled + or absent from the terminal description. + + The <I>capname</I> for each capability is given in the table col- + umn entitled <I>capname</I> code in the capabilities section of + <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. + + <B>char</B> <B>*boolnames</B>, <B>*boolcodes</B>, <B>*boolfnames</B> + + <B>char</B> <B>*numnames</B>, <B>*numcodes</B>, <B>*numfnames</B> + + <B>char</B> <B>*strnames</B>, <B>*strcodes</B>, <B>*strfnames</B> + + These null-terminated arrays contain the <I>capnames</I>, the + <B>termcap</B> codes, and the full C names, for each of the <B>ter-</B> + <B>minfo</B> variables. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <B>ERR</B> upon failure + and <B>OK</B> (SVr4 only specifies "an integer value other than + <B>ERR</B>") upon successful completion, unless otherwise noted + in the preceding routine descriptions. + + Routines that return pointers always return <B>NULL</B> on error. + + +</PRE> +<H2>NOTES</H2><PRE> + The <B>setupterm</B> routine should be used in place of <B>setterm</B>. + It may be useful when you want to test for terminal capa- + bilities without committing to the allocation of storage + involved in <B>initscr</B>. + + Note that <B>vidattr</B> and <B>vidputs</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The function <B>setterm</B> is not described in the XSI Curses + standard and must be considered non-portable. All other + functions are as described in the XSI curses standard. + + In System V Release 4, <B>set_curterm</B> has an <B>int</B> return type + and returns <B>OK</B> or <B>ERR</B>. We have chosen to implement the + XSI Curses semantics. + + In System V Release 4, the third argument of <B>tputs</B> has the + type <B>int</B> <B>(*putc)(char)</B>. + + The XSI Curses standard prototypes <B>tparm</B> with a fixed num- + ber of parameters, rather than a variable argument list. + + XSI notes that after calling <B>mvcur</B>, the curses state may + not match the actual terminal state, and that an applica- + tion should touch and refresh the window before resuming + normal curses calls. Both ncurses and System V Release 4 + curses implement <B>mvcur</B> using the SCREEN data allocated in + either <B>initscr</B> or <B>newterm</B>. So though it is documented as + a terminfo function, <B>mvcur</B> is really a curses function + which is not well specified. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B>, <B>curs_term-</B> + <B><A HREF="cap.3x.html">cap(3x)</A></B>, <B><A HREF="putc.3S.html">putc(3S)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_touch.3x.html b/ncurses-5.2/doc/html/man/curs_touch.3x.html new file mode 100644 index 0000000..198fc85 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_touch.3x.html @@ -0,0 +1,135 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>touchwin</B>, <B>touchline</B>, <B>untouchwin</B>, <B>wtouchln</B>, <B>is_linetouched</B>, + <B>is_wintouched</B> - <B>curses</B> refresh control routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>int</B> <B>touchwin(WINDOW</B> <B>*win);</B> + <B>int</B> <B>touchline(WINDOW</B> <B>*win,</B> <B>int</B> <B>start,</B> <B>int</B> <B>count);</B> + <B>int</B> <B>untouchwin(WINDOW</B> <B>*win);</B> + <B>int</B> <B>wtouchln(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>n,</B> <B>int</B> <B>changed);</B> + <B>bool</B> <B>is_linetouched(WINDOW</B> <B>*win,</B> <B>int</B> <B>line);</B> + <B>bool</B> <B>is_wintouched(WINDOW</B> <B>*win);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>touchwin</B> and <B>touchline</B> routines throw away all opti- + mization information about which parts of the window have + been touched, by pretending that the entire window has + been drawn on. This is sometimes necessary when using + overlapping windows, since a change to one window affects + the other window, but the records of which lines have been + changed in the other window do not reflect the change. + The routine <B>touchline</B> only pretends that <I>count</I> lines have + been changed, beginning with line <I>start</I>. + + The <B>untouchwin</B> routine marks all lines in the window as + unchanged since the last call to <B>wrefresh</B>. + + The <B>wtouchln</B> routine makes <I>n</I> lines in the window, starting + at line <I>y</I>, look as if they have (<I>changed</I><B>=1</B>) or have not + (<I>changed</I><B>=0</B>) been changed since the last call to <B>wrefresh</B>. + + The <B>is_linetouched</B> and <B>is_wintouched</B> routines return <B>TRUE</B> + if the specified line/window was modified since the last + call to <B>wrefresh</B>; otherwise they return <B>FALSE</B>. In addi- + tion, <B>is_linetouched</B> returns <B>ERR</B> if <I>line</I> is not valid for + the given window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and an + integer value other than <B>ERR</B> upon successful completion, + unless otherwise noted in the preceding routine descrip- + tions. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B> or <B>clear(std-</B> + <B>scr)</B>. This will not work under ncurses. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <B>wtouchln</B> may be macros. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_trace.3x.html b/ncurses-5.2/doc/html/man/curs_trace.3x.html new file mode 100644 index 0000000..51d082c --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_trace.3x.html @@ -0,0 +1,132 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>_tracef</B>, <B>_tracedump</B>, <B>_traceattr</B>, <B>_traceattr2</B>, + <B>_nc_tracebits</B>, <B>_tracechar</B>, <B>_tracechtype</B>, <B>_tracechtype2</B>, + <B>_tracemouse</B>, <B>trace</B> - <B>curses</B> debugging routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + <B>void</B> <B>_tracef(const</B> <B>char</B> <B>*format,</B> <B>...);</B> + <B>void</B> <B>_tracedump(const</B> <B>char</B> <B>*label,</B> <B>WINDOW</B> <B>*win);</B> + <B>char</B> <B>*_traceattr(attr_t</B> <B>attr);</B> + <B>char</B> <B>*_traceattr2(int</B> <B>buffer,</B> <B>chtype</B> <B>ch);</B> + <B>char</B> <B>*_nc_tracebits(void);</B> + <B>char</B> <B>*_tracechar(const</B> <B>unsigned</B> <B>char</B> <B>ch);</B> + <B>char</B> <B>*_tracechtype(chtype</B> <B>ch);</B> + <B>char</B> <B>*_tracechtype2(int</B> <B>buffer,</B> <B>chtype</B> <B>ch);</B> + <B>char</B> <B>*_tracemouse(const</B> <B>MEVENT</B> <B>*event);</B> + <B>void</B> <B>trace(const</B> <B>unsigned</B> <B>int</B> <B>param);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>trace</B> routines are used for debugging the ncurses + libraries, as well as applications which use the ncurses + libraries. These functions are normally available only + with the debugging library <I>libncurses</I><B>_</B><I>g.a</I>, but may be com- + piled into any model (shared, static, profile) by defining + the symbol <B>TRACE</B>. + + The principal parts of this interface are the <B>trace</B> rou- + tine which selectively enables different tracing features, + and the <B>_tracef</B> routine which writes formatted data to the + <I>trace</I> file. + + Calling <B>trace</B> with a nonzero parameter opens the file + <B>trace</B> in the current directory for output. The parameter + is formed by OR'ing values from the list of <B>TRACE_</B><I>xxx</I> def- + initions in <B><curses.h></B>. These include: + + TRACE_DISABLE + turn off tracing. + + TRACE_TIMES + trace user and system times of updates. + + TRACE_TPUTS + trace tputs calls. + + TRACE_UPDATE + trace update actions, old & new screens. + + TRACE_MOVE + trace cursor movement and scrolling. + + TRACE_CHARPUT + trace all character outputs. + + TRACE_ORDINARY + trace all update actions. The old and new screen + contents are written to the trace file for each + refresh. + + TRACE_CALLS + trace all curses calls. The parameters for each call + are traced, as well as return values. + + TRACE_VIRTPUT + trace virtual character puts, i.e., calls to <B>addch</B>. + + TRACE_IEVENT + trace low-level input processing, including timeouts. + + TRACE_BITS + trace state of TTY control bits. + + TRACE_ICALLS + trace internal/nested calls. + + TRACE_CCALLS + trace per-character calls. + + TRACE_DATABASE + trace read/write of terminfo/termcap data. + + TRACE_ATTRS + trace changes to video attributes and colors. + + TRACE_MAXIMUM + maximum trace level, enables all of the separate + trace features. + + Some tracing features are enabled whenever the <B>trace</B> + parameter is nonzero. Some features overlap. The + specific names are used as a guideline. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines which return a value are designed to be used as + parameters to the <B>_tracef</B> routine. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are not part of the XSI interface. Some + other curses implementations are known to have similar, + undocumented features, but they are not compatible with + ncurses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_util.3x.html b/ncurses-5.2/doc/html/man/curs_util.3x.html new file mode 100644 index 0000000..5fc178c --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_util.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>unctrl</B>, <B>keyname</B>, <B>filter</B>, <B>use_env</B>, <B>putwin</B>, <B>getwin</B>, + <B>delay_output</B>, <B>flushinp</B> - miscellaneous <B>curses</B> utility rou- + tines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>char</B> <B>*unctrl(chtype</B> <B>c);</B> + <B>char</B> <B>*keyname(int</B> <B>c);</B> + <B>void</B> <B>filter(void);</B> + <B>void</B> <B>use_env(char</B> <B>bool);</B> + <B>int</B> <B>putwin(WINDOW</B> <B>*win,</B> <B>FILE</B> <B>*filep);</B> + <B>WINDOW</B> <B>*getwin(FILE</B> <B>*filep);</B> + <B>int</B> <B>delay_output(int</B> <B>ms);</B> + <B>int</B> <B>flushinp(void);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>unctrl</B> macro expands to a character string which is a + printable representation of the character <I>c</I>. Control + characters are displayed in the <B>^</B><I>X</I> notation. Printing + characters are displayed as is. + + The <B>keyname</B> routine returns a character string correspond- + ing to the key <I>c</I>. + + The <B>filter</B> routine, if used, must be called before <B>initscr</B> + or <B>newterm</B> are called. The effect is that, during those + calls, <B>LINES</B> is set to 1; the capabilities <B>clear</B>, <B>cup</B>, + <B>cud</B>, <B>cud1</B>, <B>cuu1</B>, <B>cuu</B>, <B>vpa</B> are disabled; and the <B>home</B> + string is set to the value of <B>cr</B>. + + The <B>use_env</B> routine, if used, is called before <B>initscr</B> or + <B>newterm</B> are called. When called with <B>FALSE</B> as an argu- + ment, the values of <B>lines</B> and <B>columns</B> specified in the + <I>terminfo</I> database will be used, even if environment vari- + ables <B>LINES</B> and <B>COLUMNS</B> (used by default) are set, or if + <B>curses</B> is running in a window (in which case default + behavior would be to use the window size if <B>LINES</B> and + <B>COLUMNS</B> are not set). + + The <B>putwin</B> routine writes all data associated with window + <I>win</I> into the file to which <I>filep</I> points. This information + can be later retrieved using the <B>getwin</B> function. + + The <B>getwin</B> routine reads window related data stored in the + file by <B>putwin</B>. The routine then creates and initializes + a new window using that data. It returns a pointer to the + new window. + + The <B>delay_output</B> routine inserts an <I>ms</I> millisecond pause + in output. This routine should not be used extensively + because padding characters are used rather than a CPU + pause. + The <B>flushinp</B> routine throws away any typeahead that has + been typed by the user and has not yet been read by the + program. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>flushinp</B>, routines that return an integer + return <B>ERR</B> upon failure and <B>OK</B> (SVr4 specifies only "an + integer value other than <B>ERR</B>") upon successful completion. + + <B>flushinp</B> always returns <B>OK</B>. + + Routines that return pointers return <B>NULL</B> on error. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + The SVr4 documentation describes the action of <B>filter</B> only + in the vaguest terms. The description here is adapted + from the XSI Curses standard (which erroneously fails to + describe the disabling of <B>cuu</B>). + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>unctrl</B> is a macro, which is defined in <<B>unc-</B> + <B>trl.h</B>>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/curs_window.3x.html b/ncurses-5.2/doc/html/man/curs_window.3x.html new file mode 100644 index 0000000..1fae384 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_window.3x.html @@ -0,0 +1,190 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>newwin</B>, <B>delwin</B>, <B>mvwin</B>, <B>subwin</B>, <B>derwin</B>, <B>mvderwin</B>, <B>dupwin</B>, + <B>wsyncup</B>, <B>syncok</B>, <B>wcursyncup</B>, <B>wsyncdown</B> - create <B>curses</B> + windows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>WINDOW</B> <B>*newwin(int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> <B>int</B> <B>begin_y,</B> + <B>int</B> <B>begin_x);</B> + <B>int</B> <B>delwin(WINDOW</B> <B>*win);</B> + <B>int</B> <B>mvwin(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> + <B>WINDOW</B> <B>*subwin(WINDOW</B> <B>*orig,</B> <B>int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> + <B>int</B> <B>begin_y,</B> <B>int</B> <B>begin_x);</B> + <B>WINDOW</B> <B>*derwin(WINDOW</B> <B>*orig,</B> <B>int</B> <B>nlines,</B> <B>int</B> <B>ncols,</B> + <B>int</B> <B>begin_y,</B> <B>int</B> <B>begin_x);</B> + <B>int</B> <B>mvderwin(WINDOW</B> <B>*win,</B> <B>int</B> <B>par_y,</B> <B>int</B> <B>par_x);</B> + <B>WINDOW</B> <B>*dupwin(WINDOW</B> <B>*win);</B> + <B>void</B> <B>wsyncup(WINDOW</B> <B>*win);</B> + <B>int</B> <B>syncok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> + <B>void</B> <B>wcursyncup(WINDOW</B> <B>*win);</B> + <B>void</B> <B>wsyncdown(WINDOW</B> <B>*win);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Calling <B>newwin</B> 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 <I>begin</I>_<I>y</I>, column + <I>begin</I>_<I>x</I>. If either <I>nlines</I> or <I>ncols</I> is zero, they default + to <B>LINES</B> <B>-</B> <I>begin</I>_<I>y</I> and <B>COLS</B> <B>-</B> <I>begin</I>_<I>x</I>. A new full-screen + window is created by calling <B>newwin(0,0,0,0)</B>. + + Calling <B>delwin</B> deletes the named window, freeing all mem- + ory associated with it (it does not actually erase the + window's screen image). Subwindows must be deleted before + the main window can be deleted. + + Calling <B>mvwin</B> moves the window so that the upper left-hand + corner is at position (<I>x</I>, <I>y</I>). If the move would cause the + window to be off the screen, it is an error and the window + is not moved. Moving subwindows is allowed, but should be + avoided. + + Calling <B>subwin</B> creates and returns a pointer to a new win- + dow with the given number of lines, <I>nlines</I>, and columns, + <I>ncols</I>. The window is at position (<I>begin</I>_<I>y</I>, <I>begin</I>_<I>x</I>) on + the screen. (This position is relative to the screen, and + not to the window <I>orig</I>.) The window is made in the middle + of the window <I>orig</I>, so that changes made to one window + will affect both windows. The subwindow shares memory + with the window <I>orig</I>. When using this routine, it is nec- + essary to call <B>touchwin</B> or <B>touchline</B> on <I>orig</I> before call- + ing <B>wrefresh</B> on the subwindow. + + Calling <B>derwin</B> is the same as calling <B>subwin,</B> except that + <I>begin</I>_<I>y</I> and <I>begin</I>_<I>x</I> are relative to the origin of the win- + dow <I>orig</I> rather than the screen. There is no difference + between the subwindows and the derived windows. + + Calling <B>mvderwin</B> moves a derived window (or subwindow) + inside its parent window. The screen-relative parameters + of the window are not changed. This routine is used to + display different parts of the parent window at the same + physical position on the screen. + + Calling <B>dupwin</B> creates an exact duplicate of the window + <I>win</I>. + + Calling <B>wsyncup</B> touches all locations in ancestors of <I>win</I> + that are changed in <I>win</I>. If <B>syncok</B> is called with second + argument <B>TRUE</B> then <B>wsyncup</B> is called automatically when- + ever there is a change in the window. + + The <B>wsyncdown</B> routine touches each location in <I>win</I> that + has been touched in any of its ancestor windows. This + routine is called by <B>wrefresh</B>, so it should almost never + be necessary to call it manually. + + The routine <B>wcursyncup</B> updates the current cursor position + of all the ancestors of the window to reflect the current + cursor position of the window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return the integer <B>ERR</B> + upon failure and <B>OK</B> (SVr4 only specifies "an integer value + other than <B>ERR</B>") upon successful completion. + + <B>delwin</B> returns the integer <B>ERR</B> upon failure and <B>OK</B> upon + successful completion. + + Routines that return pointers return <B>NULL</B> on error. + + +</PRE> +<H2>NOTES</H2><PRE> + If many small changes are made to the window, the <B>wsyncup</B> + option could degrade performance. + + Note that <B>syncok</B> may be a macro. + + +</PRE> +<H2>BUGS</H2><PRE> + The subwindow functions (<I>subwin</I>, <I>derwin</I>, <I>mvderwin</I>, <B>wsyn-</B> + <B>cup</B>, <B>wsyncdown</B>, <B>wcursyncup</B>, <B>syncok</B>) are flaky, incom- + pletely implemented, and not well tested. + + The System V curses documentation is very unclear about + what <B>wsyncup</B> and <B>wsyncdown</B> actually do. It seems to imply + that they are only supposed to touch exactly those lines + that are affected by ancestor changes. The language here, + and the behavior of the <B>curses</B> implementation, is pat- + terned on the XPG4 curses standard. The weaker XPG4 spec + may result in slower updates. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4 describes these func- + tions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/default_colors.3x.html b/ncurses-5.2/doc/html/man/default_colors.3x.html new file mode 100644 index 0000000..8b6cdca --- /dev/null +++ b/ncurses-5.2/doc/html/man/default_colors.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>default_colors</B>: <B>use_default_colors</B>, <B>assume_default_colors</B> + - use terminal's default colors + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>use_default_colors(void);</B> + <B>int</B> <B>assume_default_colors(int</B> <B>fg,</B> <B>int</B> <B>bg);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <I>use</I><B>_</B><I>default</I><B>_</B><I>colors()</I> and <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors()</I> func- + tions are extensions to the curses library. They are used + with terminals that support ISO 6429 color, or equivalent. + These terminals allow the application to reset color to an + unspecified default value (e.g., with SGR 39 or SGR 49). + + Applications that paint a colored background over the + whole screen do not take advantage of SGR 39 and SGR 49. + Some applications are designed to work with the default + background, using colors only for text. For example, + there are several implementations of the <B>ls</B> program which + use colors to denote different file types or permissions. + These "color ls" programs do not necessarily modify the + background color, typically using only the <I>setaf</I> terminfo + capability to set the foreground color. Full-screen + applications that use default colors can achieve similar + visual effects. + + The first function, <I>use</I><B>_</B><I>default</I><B>_</B><I>colors()</I> tells the curses + library to assign terminal default foreground/background + colors to color number -1. So init_pair(x,COLOR_RED,-1) + will initialize pair x as red on default background and + init_pair(x,-1,COLOR_BLUE) will initialize pair x as + default foreground on blue. + + The other, <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors()</I> is a refinement which + tells which colors to paint for color pair 0. This func- + tion recognizes a special color number -1, which denotes + the default terminal color. + + The following are equivalent: + <I>use</I><B>_</B><I>default</I><B>_</B><I>colors();</I> + <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors(-1,-1);</I> + + These are ncurses extensions. For other curses implemen- + tations, color number -1 does not mean anything, just as + for ncurses before a successful call of <I>use</I><B>_</B><I>default</I><B>_</B><I>col-</I> + <I>ors()</I> or <I>assume</I><B>_</B><I>default</I><B>_</B><I>colors()</I>. + + Other curses implementations do not allow an application + to modify color pair 0. They assume that the background + is COLOR_BLACK, but do not ensure that the color pair 0 is + painted to match the assumption. If your application does + not use either <I>use</I><B>_</B><I>default</I><B>_</B><I>colors()</I> or <I>assume</I><B>_</B><I>default</I><B>_</B><I>col-</I> + <I>ors()</I> ncurses will paint a white foreground (text) with + black background for color pair 0. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These functions return the integer <B>ERR</B> upon failure and <B>OK</B> + on success. They will fail if either the terminal does + not support the <I>orig</I><B>_</B><I>pair</I> or <I>orig</I><B>_</B><I>colors</I> capability. If + the <I>initialize</I><B>_</B><I>pair</I> capability is found, this causes an + error as well. + + +</PRE> +<H2>NOTES</H2><PRE> + Associated with this extension, the <B><A HREF="init_pair.3x.html">init_pair(3x)</A></B> function + accepts negative arguments to specify default foreground + or background colors. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B>, <B><A HREF="ded.1.html">ded(1)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (from an analysis of the requirements for + color xterm for XFree86 3.1.2C, February 1996). + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/define_key.3x.html b/ncurses-5.2/doc/html/man/define_key.3x.html new file mode 100644 index 0000000..7e914c7 --- /dev/null +++ b/ncurses-5.2/doc/html/man/define_key.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>define_key</B> - define a keycode + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>define_key(char</B> <B>*definition,</B> <B>int</B> <B>keycode);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to define keycodes with their corresponding + control strings, so that the ncurses library will inter- + pret them just as it would the predefined codes in the + terminfo database. + + If the given string is null, any existing definition for + the keycode is removed. Similarly, if the given keycode + is negative or zero, any existing string for the given + definition is removed. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The keycode must be greater than zero, else ERR is + returned. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="keyok.3x.html">keyok(3x)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form.3x.html b/ncurses-5.2/doc/html/man/form.3x.html new file mode 100644 index 0000000..a15a712 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form.3x.html @@ -0,0 +1,245 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form</B> - curses extension for programming forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>form</B> library provides terminal-independent facilities + for composing form screens on character-cell terminals. + The library includes: field routines, which create and + modify form fields; and form routines, which group fields + into forms, display forms on the screen, and handle inter- + action with the user. + + The <B>form</B> library uses the <B>curses</B> libraries, and a curses + initialization routine such as <B>initscr</B> must be called + before using any of these functions. To use the <B>form</B> + library, link with the options <B>-lform</B> <B>-lcurses</B>. + + + <B>Current</B> <B>Default</B> <B>Values</B> <B>for</B> <B>Field</B> <B>Attributes</B> + The <B>form</B> library maintains a default value for field + attributes. You can get or set this default by calling + the appropriate <B>set_</B> or retrieval routine with a <B>NULL</B> + field pointer. Changing this default with a <B>set_</B> function + affects future field creations, but does not change the + rendering of fields already created. + + + <B>Routine</B> <B>Name</B> <B>Index</B> + The following table lists each <B>form</B> routine and the name + of the manual page on which it is described. + + <B>curses</B> Routine Name Manual Page Name + ------------------------------------------------- + current_field <B><A HREF="form_page.3x.html">form_page(3x)</A></B> + data_ahead <B><A HREF="form_data.3x.html">form_data(3x)</A></B> + data_behind <B><A HREF="form_data.3x.html">form_data(3x)</A></B> + dup_field <B><A HREF="form_field_new.3x.html">form_field_new(3x)</A></B> + dynamic_fieldinfo <B><A HREF="form_field_info.3x.html">form_field_info(3x)</A></B> + field_arg <B><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></B> + field_back <B><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></B> + field_buffer <B><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></B> + field_count <B><A HREF="form_field.3x.html">form_field(3x)</A></B> + field_fore <B><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></B> + field_index <B><A HREF="form_page.3x.html">form_page(3x)</A></B> + field_info <B><A HREF="form_field_info.3x.html">form_field_info(3x)</A></B> + field_init <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + field_just <B><A HREF="form_field_just.3x.html">form_field_just(3x)</A></B> + field_opts <B><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></B> + field_opts_off <B><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></B> + field_opts_on <B><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></B> + field_pad <B><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></B> + + field_status <B><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></B> + field_term <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + field_type <B><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></B> + field_userptr <B><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></B> + form_driver <B><A HREF="form_driver.3x.html">form_driver(3x)</A></B> + form_fields <B><A HREF="form_field.3x.html">form_field(3x)</A></B> + form_init <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + form_opts <B><A HREF="form_opts.3x.html">form_opts(3x)</A></B> + form_opts_off <B><A HREF="form_opts.3x.html">form_opts(3x)</A></B> + form_opts_on <B><A HREF="form_opts.3x.html">form_opts(3x)</A></B> + form_page <B><A HREF="form_page.3x.html">form_page(3x)</A></B> + form_request_by_name <B><A HREF="form_requestname.3x.html">form_requestname(3x)</A></B> + form_request_name <B><A HREF="form_requestname.3x.html">form_requestname(3x)</A></B> + form_sub <B><A HREF="form_win.3x.html">form_win(3x)</A></B> + form_term <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + form_userptr <B><A HREF="form_userptr.3x.html">form_userptr(3x)</A></B> + form_win <B><A HREF="form_win.3x.html">form_win(3x)</A></B> + free_field <B><A HREF="form_field_new.3x.html">form_field_new(3x)</A></B> + free_form <B><A HREF="form_new.3x.html">form_new(3x)</A></B> + link_field <B><A HREF="form_field_new.3x.html">form_field_new(3x)</A></B> + link_fieldtype <B><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></B> + move_field <B><A HREF="form_field.3x.html">form_field(3x)</A></B> + new_field <B><A HREF="form_field_new.3x.html">form_field_new(3x)</A></B> + new_form <B><A HREF="form_new.3x.html">form_new(3x)</A></B> + new_page <B><A HREF="form_new_page.3x.html">form_new_page(3x)</A></B> + pos_form_cursor <B><A HREF="form_cursor.3x.html">form_cursor(3x)</A></B> + post_form <B><A HREF="form_post.3x.html">form_post(3x)</A></B> + scale_form <B><A HREF="form_win.3x.html">form_win(3x)</A></B> + set_current_field <B><A HREF="form_page.3x.html">form_page(3x)</A></B> + set_field_back <B><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></B> + set_field_buffer <B><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></B> + set_field_fore <B><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></B> + set_field_init <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + set_field_just <B><A HREF="form_field_just.3x.html">form_field_just(3x)</A></B> + set_field_opts <B><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></B> + set_field_pad <B><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></B> + set_field_status <B><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></B> + set_field_term <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + set_field_type <B><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></B> + set_field_userptr <B><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></B> + set_fieldtype_arg <B><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></B> + set_fieldtype_choice <B><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></B> + set_form_fields <B><A HREF="form_field.3x.html">form_field(3x)</A></B> + set_form_init <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + set_form_opts <B><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></B> + set_form_page <B><A HREF="form_page.3x.html">form_page(3x)</A></B> + set_form_sub <B><A HREF="form_win.3x.html">form_win(3x)</A></B> + set_form_term <B><A HREF="form_hook.3x.html">form_hook(3x)</A></B> + set_form_userptr <B><A HREF="form_userptr.3x.html">form_userptr(3x)</A></B> + set_form_win <B><A HREF="form_win.3x.html">form_win(3x)</A></B> + set_max_field <B><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></B> + set_new_page <B><A HREF="form_new_page.3x.html">form_new_page(3x)</A></B> + unpost_form <B><A HREF="form_post.3x.html">form_post(3x)</A></B> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Rou- + tines that return an integer return one of the following + error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_CONNECTED</B> + The field is already connected to a form. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The form is already posted. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NO_ROOM</B> + Form is too large for its window. + + <B>E_NOT_POSTED</B> + The form has not been posted. + + <B>E_UNKNOWN_COMMAND</B> + The form driver code saw an unknown request code. + + <B>E_INVALID_FIELD</B> + Contents of a field are not valid. + + <B>E_NOT_CONNECTED</B> + No fields are connected to the form. + + <B>E_REQUEST_DENIED</B> + The form driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + files <B><curses.h></B> and <B><eti.h></B>. + + In your library list, libform.a should be before libn- + curses.a; that is, you want to say `-lform -lncurses', not + the other way around (which would give you a link error + using GNU <B><A HREF="ld.1.html">ld(1)</A></B> and many other linkers). + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for ncurses + by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_cursor.3x.html b/ncurses-5.2/doc/html/man/form_cursor.3x.html new file mode 100644 index 0000000..b99b824 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_cursor.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_cursor</B> - position a form window cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int pos_form_cursor(FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>pos_form_cursor</B> restores the cursor to the + position required for the forms driver to continue pro- + cessing requests. This is useful after <B>curses</B> routines + have been called to do screen-painting in response to a + form operation. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + This routine returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_NOT_POSTED</B> + The form has not been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_data.3x.html b/ncurses-5.2/doc/html/man/form_data.3x.html new file mode 100644 index 0000000..502495e --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_data.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_data</B> - test for off-screen data in given forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + bool data_ahead(const FORM *form); + bool data_behind(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>data_ahead</B> tests whether there is off-screen + data ahead in the given form. It returns TRUE (1) or + FALSE (0). + + The function <B>data_behind</B> tests whether there is off-screen + data behind in the given form. It returns TRUE (1) or + FALSE (0). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_driver.3x.html b/ncurses-5.2/doc/html/man/form_driver.3x.html new file mode 100644 index 0000000..36a27aa --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_driver.3x.html @@ -0,0 +1,299 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_driver</B> - command-processing loop of the form system + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int form_driver(FORM *form, int c); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Once a form has been posted (displayed), you should funnel + input events to it through <B>form_driver</B>. This routine has + two major input cases; either the input is a form naviga- + tion request or it's a printable ASCII character. The + form driver requests are as follows: + + REQ_NEXT_PAGE + Move to the next page. + + REQ_PREV_PAGE + Move to the previous page. + + REQ_FIRST_PAGE + Move to the first page. + + REQ_LAST_PAGE + Move to the last field. + + + REQ_NEXT_FIELD + Move to the next field. + + REQ_PREV_FIELD + Move to the previous field. + + REQ_FIRST_FIELD + Move to the first field. + + REQ_LAST_FIELD + Move to the last field. + + REQ_SNEXT_FIELD + Move to the sorted next field. + + REQ_SPREV_FIELD + Move to the sorted previous field. + + REQ_SFIRST_FIELD + Move to the sorted first field. + + REQ_SLAST_FIELD + Move to the sorted last field. + + REQ_LEFT_FIELD + Move left to a field. + + REQ_RIGHT_FIELD + Move right to a field. + + REQ_UP_FIELD + Move up to a field. + + REQ_DOWN_FIELD + Move down to a field. + + + REQ_NEXT_CHAR + Move to the next char. + + REQ_PREV_CHAR + Move to the previous char. + + REQ_NEXT_LINE + Move to the next line. + + REQ_PREV_LINE + Move to the previous line. + + REQ_NEXT_WORD + Move to the next word. + + REQ_PREV_WORD + Move to the previous word. + + REQ_BEG_FIELD + Move to the beginning of the field. + + REQ_END_FIELD + Move to the end of the field. + + REQ_BEG_LINE + Move to the beginning of the line. + + REQ_END_LINE + Move to the end of the line. + + REQ_LEFT_CHAR + Move left in the field. + + REQ_RIGHT_CHAR + Move right in the field. + + REQ_UP_CHAR + Move up in the field. + + REQ_DOWN_CHAR + Move down in the field. + + + + REQ_NEW_LINE + Insert or overlay a new line. + + REQ_INS_CHAR + Insert a blank at the cursor. + + REQ_INS_LINE + Insert a blank line at the cursor. + + REQ_DEL_CHAR + Delete character at the cursor. + + REQ_DEL_PREV + Delete character before the cursor. + + REQ_DEL_LINE + Delete line at the cursor. + + REQ_DEL_WORD + Delete blank-delimited word at the cursor. + + REQ_CLR_EOL + Clear to end of line from cursor. + + REQ_CLR_EOF + Clear to end of field from cursor. + + REQ_CLR_FIELD + Clear the entire field. + + REQ_OVL_MODE + Enter overlay mode. + + REQ_INS_MODE + Enter insert mode. + + + REQ_SCR_FLINE + Scroll the field forward a line. + + REQ_SCR_BLINE + Scroll the field backward a line. + + REQ_SCR_FPAGE + Scroll the field forward a page. + + REQ_SCR_BPAGE + Scroll the field backward a page. + + REQ_SCR_FHPAGE + Scroll the field forward half a page. + + REQ_SCR_BHPAGE + Scroll the field backward half a page. + + REQ_SCR_FCHAR + Scroll the field forward a character. + + REQ_SCR_BCHAR + Scroll the field backward a character. + + REQ_SCR_HFLINE + Horizontal scroll the field forward a line. + + REQ_SCR_HBLINE + Horizontal scroll the field backward a line. + + REQ_SCR_HFHALF + Horizontal scroll the field forward half a line. + + REQ_SCR_HBHALF + Horizontal scroll the field backward half a line. + + + REQ_VALIDATION + Validate field. + + REQ_NEXT_CHOICE + Display next field choice. + + REQ_PREV_CHOICE + Display previous field choice. + + If the second argument is a printable ASCII character, the + driver places it in the current position in the current + field. If it is one of the forms requests listed above, + that request is executed. + + If the second argument is neither printable ASCII nor one + of the above pre-defined form requests, the driver assumes + it is an application-specific command and returns + <B>E_UNKNOWN_COMMAND</B>. Application-defined commands should be + defined relative to <B>MAX_COMMAND</B>, the maximum value of + these pre-defined requests. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>form_driver</B> return one of the following error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or + termination function. + + <B>E_NOT_POSTED</B> + The form has not been posted. + + <B>E_UNKNOWN_COMMAND</B> + The form driver code saw an unknown request code. + + <B>E_INVALID_FIELD</B> + Contents of field is invalid. + + <B>E_REQUEST_DENIED</B> + The form driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + files <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field.3x.html b/ncurses-5.2/doc/html/man/form_field.3x.html new file mode 100644 index 0000000..2f14eaf --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field</B> - make and break connections between fields and + forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_form_fields(FORM *form, FIELD **fields); + FIELD **form_fields(const FORM *form); + int field_count(const FORM *form); + int move_field(FIELD *field, int frow, int fcol); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_form_fields</B> changes the field pointer + array of the given <I>form</I>. The array must be terminated by + a <B>NULL</B>. + + The function <B>form_fields</B> returns the field array of the + given form. + + The function <B>field_count</B> returns the count of fields in + <I>form</I>. + + The function <B>move_field</B> move the given field (which must + be disconnected) to a specified location on the screen. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + The function <B>form_fields</B> returns <B>NULL</B> on error. + + The function <B>field_count</B> returns <B>ERR</B> (the general <B>curses</B> + error return value) on error. + + The functions <B>set_form_fields</B> and <B>move_field</B> return one of + the following codes on error: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The form is already posted. + + <B>E_CONNECTED</B> + The field is already connected to a form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + The SVr4 forms library documentation specifies the + <B>field_count</B> error value as -1 (which is the value of <B>ERR</B>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_attributes.3x.html b/ncurses-5.2/doc/html/man/form_field_attributes.3x.html new file mode 100644 index 0000000..9e11aaf --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_attributes.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_attributes</B> - color and attribute control for + form fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_fore(FIELD *field, chtype attr); + chtype field_fore(const FIELD *field); + int set_field_back(FIELD *field, chtype attr); + chtype field_back(const FIELD *field); + int set_field_pad(FIELD *field, int pad); + chtype field_pad(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_field_fore</B> sets the foreground attribute + of <I>field</I>. This is the highlight used to display the field + contents. The function <B>field_fore</B> returns the foreground + attribute. The default is <B>A_STANDOUT</B>. + + The function <B>set_field_back</B> sets the background attribute + of <I>form</I>. This is the highlight used to display the extent + fields in the form. The function <B>field_back</B> returns the + background attribute. The default is <B>A_NORMAL</B>. + + The function <B>set_field_pad</B> sets the character used to fill + the field. The function <B>field_pad</B> returns the given + form's pad character. The default is a blank. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_buffer.3x.html b/ncurses-5.2/doc/html/man/form_field_buffer.3x.html new file mode 100644 index 0000000..a4f3dcd --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_buffer.3x.html @@ -0,0 +1,137 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_buffer</B> - field buffer control + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_buffer(FIELD *field, int buf, const char + *value); + char *field_buffer(const FIELD *field, int buffer); + int set_field_status(FIELD *field, bool status); + bool field_status(const FIELD *field); + int set_max_field(FIELD *field, int max); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_field_buffer</B> sets the numbered buffer of + the given field to contain a given string. Buffer 0 is + the displayed value of the field; other numbered buffers + may be allocated by applications through the <B>nbuf</B> argument + of (see <B><A HREF="form_field_new.3x.html">form_field_new(3x)</A></B>) but are not manipulated by the + forms library. The function <B>field_buffer</B> returns the + address of the buffer. Please note that this buffer has + always the length of the buffer, that means that it may + typically contain trailing spaces. If you entered leading + spaces the buffer may also contain them. If you want the + raw data, you must write your own routine that copies the + value out of the buffer and removes the leading and trail- + ing spaces. Please note also, that subsequent operations + on the form will probably change the content of the + buffer. So don't use it for long term storage of the + entered form data. + + The function <B>set_field_status</B> sets the associated status + flag of <I>field</I>; <B>field_status</B> gets the current value. The + status flag is set to a nonzero value whenever the field + changes. + + The function <B>set_max_field</B> sets the maximum size for a + dynamic field. An argument of 0 turns off any maximum + size threshold for that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The <B>field_buffer</B> function returns NULL on error. + + The <B>field_status</B> function returns <B>TRUE</B> or <B>FALSE</B>. + + The remaining routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_info.3x.html b/ncurses-5.2/doc/html/man/form_field_info.3x.html new file mode 100644 index 0000000..40ef3a2 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_info.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_info</B> - retrieve field characteristics + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int field_info(const FIELD *field, int *rows, int *cols, + int *frow, int *fcol, int *nrow, int *nbuf); + int dynamic_field_info(const FIELD *field, int *rows, int + *cols, *max); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>field_info</B> returns the sizes and other + attributes passed in to the field at its creation time. + The attributes are: height, width, row of upper-left cor- + ner, column of upper-left corner, number off-screen rows, + and number of working buffers. + + The function <B>dynamic_field_info</B> returns the actual size of + the field, and its maximum possible size. If the field + has no size limit, the location addressed by the third + argument will be set to 0. (A field can be made dynamic + by turning off the <B>O_STATIC</B>). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + A null (zero pointer) is accepted for any of the return + values, to ignore that value. Not all implementations + allow this, e.g., Solaris 2.7 does not. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_just.3x.html b/ncurses-5.2/doc/html/man/form_field_just.3x.html new file mode 100644 index 0000000..1643c44 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_just.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_just</B> - retrieve field characteristics + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_just(FIELD *field, int justification); + int field_just(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_field_just</B> sets the justification + attribute of a field; <B>field_just</B> returns a field's justi- + fication attribute. The attribute may be one of NO_JUSTI- + FICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>field_just</B> returns one of: NO_JUSTIFICATION, + JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER. + + The function <B>set_field_just</B> return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_new.3x.html b/ncurses-5.2/doc/html/man/form_field_new.3x.html new file mode 100644 index 0000000..f6dd76a --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_new.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_new</B> - create and destroy form fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + FIELD *new_field(int height, int width, + int toprow, int leftcol, + int offscreen, int nbuffers); + FIELD *dup_field(FIELD *field, int toprow, int leftcol); + FIELD *link_field(FIELD *field, int toprow, int leftcol); + int free_field(FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>new_field</B> allocates a new field and initial- + izes it from the parameters given: height, width, row of + upper-left corner, column of upper-left corner, number + off-screen rows, and number of additional working buffers. + + The function <B>dup_field</B> duplicates a field at a new loca- + tion. Most attributes (including current contents, size, + validation type, buffer count, growth threshold, justifi- + cation, foreground, background, pad character, options, + and user pointer) are copied. Field status and the field + page bit are not copied. + + The function <B>link_field</B> acts like <B>dup_field</B>, but the new + field shares buffers with its parent. Attribute data is + separate. + + The function <B>free_field</B> de-allocates storage associated + with a field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function, <B>new_field</B>, <B>dup_field</B>, <B>link_field</B> return <B>NULL</B> + on error. + + The function <B>free_field</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + It may be unwise to count on the set of attributes copied + by <B><A HREF="dup_field.3x.html">dup_field(3x)</A></B> being portable; the System V forms + library documents are not very explicit on what gets + copied and was not. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_opts.3x.html b/ncurses-5.2/doc/html/man/form_field_opts.3x.html new file mode 100644 index 0000000..576dcad --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_opts.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_opts</B> - set and get field options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_opts(FIELD *field, OPTIONS opts); + int field_opts_on(FIELD *field, OPTIONS opts); + int field_opts_off(FIELD *field, OPTIONS opts); + OPTIONS field_opts(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_field_opts</B> sets all the given field's + option bits (field option bits may be logically-OR'ed + together). + + The function <B>field_opts_on</B> turns on the given option bits, + and leaves others alone. + + The function <B>field_opts_off</B> turns off the given option + bits, and leaves others alone. + + The function <B>field_opts</B> returns the field's current option + bits. + + The following options are defined (all are on by default): + + O_VISIBLE + The field is displayed. If this option is off, dis- + play of the field is suppressed, + + O_ACTIVE + The field is visited during processing. If this + option is off, the field will not be reachable by + navigation keys. Please notice that an invisible + field appears to be inactive also. + + O_PUBLIC + The field contents are displayed as data is entered. + + O_EDIT + The field can be edited. + + O_WRAP + Words that don't fit on a line are wrapped to the + next line. Words are blank-separated. + + O_BLANK + The field is cleared whenever a character is entered + at the first position. + + O_AUTOSKIP + Skip to the next field when this one fills + + + O_NULLOK + Allow a blank field. + + O_STATIC + Field buffers are fixed to field's original size. + + O_PASSOK + Validate field only if modified by user. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>field_opts</B>, each routine returns one of the + following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_CURRENT</B> + The field is the current field. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + + <B>NOTES</B> The header file <B><form.h></B> automatically includes the + header file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_userptr.3x.html b/ncurses-5.2/doc/html/man/form_field_userptr.3x.html new file mode 100644 index 0000000..46977c9 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_userptr.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_userptr</B> - associate application data with a + form field + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_userptr(FIELD *field, void*userptr); + void *field_userptr(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every form field has a field that can be used to hold + application-specific data (that is, the form-driver code + leaves it alone). These functions get and set that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>field_userptr</B> returns <B>NULL</B> on error. The + function <B>set_field_userptr</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + The user pointer should be a void pointer. We leave it as + a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_field_validation.3x.html b/ncurses-5.2/doc/html/man/form_field_validation.3x.html new file mode 100644 index 0000000..34ae0dc --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_field_validation.3x.html @@ -0,0 +1,190 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_field_validation</B> - data type validation for fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_type(FIELD *field, FIELDTYPE *type, ...); + FIELDTYPE *field_type(const FIELD *field); + void *field_arg(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_field_type</B> declares a data type for a + given form field. This is the type checked by validation + functions. The types are as follows: + + TYPE_ALNUM + Alphanumeric data. Requires a third <B>int</B> argument, a + minimum field width. + + TYPE_ALPHA + Character data. Requires a third <B>int</B> argument, a + minimum field width. + + TYPE_ENUM + Accept one of a specified set of strings. Requires a + third <B>(char</B> <B>**)</B> argument pointing to a string list; a + fourth <B>int</B> flag argument to enable case-sensitivity; + and a fifth <B>int</B> flag argument specifying whether a + partial match must be a unique one (if this flag is + off, a prefix matches the first of any set of more + than one list elements with that prefix). Please + notice that the string list is not copied, only a + reference to it is stored in the field. So you should + avoid to use a list that lives in automatic variables + on the stack. + + TYPE_INTEGER + Integer data, parsable to an integer by <B>atoi(3)</B>. + Requires a third <B>int</B> argument controlling the preci- + sion, a fourth <B>long</B> argument constraining minimum + value, and a fifth <B>long</B> constraining maximum value. + If the maximum value is less or equal the minimum + value, the range is simply ignored. On return the + field buffer is formatted according to the <B>printf</B> + format specification ".*ld", where the '*' is + replaced by the precision argument. For details of + the precision handling see <B>printf's</B> man-page. + + TYPE_NUMERIC + Numeric data (may have a decimal-point part). + Requires a third <B>int</B> argument controlling the preci- + sion, a fourth <B>double</B> argument constraining minimum + value, and a fifth <B>double</B> constraining maximum value. + If your system supports locale's, the decimal point + character to be used must be the one specified by + your locale. If the maximum value is less or equal + the minimum value, the range is simply ignored. On + return the field buffer is formatted according to the + <B>printf</B> format specification ".*f", where the '*' is + replaced by the precision argument. For details of + the precision handling see <B>printf's</B> man-page. + + TYPE_REGEXP + Regular expression data. Requires a regular expres- + sion <B>(char</B> <B>*)</B> third argument; the data is valid if + the regular expression matches it. Regular expres- + sions are in the format of <B><A HREF="regcomp.3x.html">regcomp(3x)</A></B> and + <B><A HREF="regexec.3x.html">regexec(3x)</A></B>. Please notice that the regular expres- + sion must match the whole field. If you have for + example an eight character wide field, a regular + expression "^[0-9]*$" always means that you have to + fill all eight positions with digits. If you want to + allow fewer digits, you may use for example "^[0-9]* + *$" which is good for trailing spaces (up to an empty + field), or "^ *[0-9]* *$" which is good for leading + and trailing spaces around the digits. + + TYPE_IPV4 + An Internet Protocol Version 4 address. This requires + no additional argument. It is checked whether or not + the buffer has the form a.b.c.d, where a,b,c and d + are numbers between 0 and 255. Trailing blanks in the + buffer are ignored. The address itself is not vali- + dated. Please note that this is an ncurses extension. + This field type may not be available in other curses + implementations. + + It is possible to set up new programmer-defined field + types. See the <B><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></B> manual page. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The functions <B>field_type</B> and <B>field_arg</B> return <B>NULL</B> on + error. The function <B>set_field_type</B> returns one of the fol- + lowing: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_fieldtype.3x.html b/ncurses-5.2/doc/html/man/form_fieldtype.3x.html new file mode 100644 index 0000000..dec43a3 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_fieldtype.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_fieldtype</B> - define validation-field types + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + FIELDTYPE *new_fieldtype( + bool (* const field_check)(FIELD *, const void *), + bool (* const char_check)(int, const void *)); + int free_fieldtype(FIELDTYPE *fieldtype); + int set_fieldtype_arg( + FIELDTYPE *fieldtype, + void *(* const make_arg)(va_list *), + void *(* const copy_arg)(const void *), + void (* const free_arg)(void *)); + int set_fieldtype_choice( + FIELDTYPE *fieldtype + bool (* const next_choice)(FIELD *, const void *), + bool (* const prev_choice)(FIELD *, const void *)); + FIELDTYPE *link_fieldtype(FIELDTYPE *type1, + FIELDTYPE *type2); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>new_fieldtype</B> creates a new field type usable + for data validation. You supply it with <I>field</I><B>_</B><I>check</I>, a + predicate to check the validity of an entered data string + whenever the user attempt to leave a field. The (FIELD *) + argument is passed in so the validation predicate can see + the field's buffer, sizes and other attributes; the second + argument is an argument-block structure, about which more + below. + + You also supply <B>new_fieldtype</B> with <I>char</I><B>_</B><I>check</I>, a function + to validate input characters as they are entered; it will + be passed the character to be checked and a pointer to an + argument-block structure. + + The function <B>free_fieldtype</B> frees the space allocated for + a given validation type. + + The function <B>set_fieldtype</B> associates three storage-man- + agement functions with a field type. The <I>mak</I><B>_</B><I>arg</I> function + is automatically applied to the list of arguments you give + <B>set_field_type</B> when attaching validation to a field; its + job is to bundle these into an allocated argument-block + object which can later be passed to validation predicated. + The other two hook arguments should copy and free argu- + ment-block structures. They will be used by the forms- + driver code. You must supply the <I>mak</I><B>_</B><I>arg</I> function, the + other two are optional, you may supply NULL for them. In + this case it is assumed, that <I>mak</I><B>_</B><I>arg</I> doesn't allocate + memory but simply loads the argument into a single scalar + value. + + The form driver requests <B>REQ_NEXT_CHOICE</B> and + <B>REQ_PREV_CHOICE</B> 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 <B>set_fieldtype_choice</B> func- + 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. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The pointer-valued routines return NULL on error. + + The integer-valued routines return one of the following + codes on error: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_CONNECTED</B> + The field is already connected to a form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + All of the <B>(char</B> <B>*)</B> arguments of these functions should + actually be <B>(void</B> <B>*)</B>. The type has been left uncorrected + for strict compatibility with System V. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_hook.3x.html b/ncurses-5.2/doc/html/man/form_hook.3x.html new file mode 100644 index 0000000..87628aa --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_hook.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_hook</B> - set hooks for automatic invocation by applica- + tions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_field_init(FORM *form, void (*func)(FORM *)); + void (*)(FORM *) field_init(const FORM *form); + int set_field_term(FORM *form, void (*func)(FORM *)); + void (*)(FORM *) field_term(const FORM *form); + int set_form_init(FORM *form, void (*func)(FORM *)); + void (*)(FORM *) form_init(const FORM *form); + int set_form_term(FORM *form, void (*func)(FORM *)); + void (*)(FORM *) form_term(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions make it possible to set hook functions to + be called at various points in the automatic processing of + input event codes by <B>form_driver</B>. + + The function <B>set_field_init</B> sets a hook to be called at + form-post time and each time the selected field changes + (after the change). <B>field_init</B> returns the current field + init hook, if any (<B>NULL</B> if there is no such hook). + + The function <B>set_field_term</B> sets a hook to be called at + form-unpost time and each time the selected field changes + (before the change). <B>field_term</B> returns the current field + term hook, if any (<B>NULL</B> if there is no such hook). + + The function <B>set_form_init</B> sets a hook to be called at + form-post time and just after a page change once it is + posted. <B>form_init</B> returns the current form init hook, if + any (<B>NULL</B> if there is no such hook). + + The function <B>set_form_term</B> sets a hook to be called at + form-unpost time and just before a page change once it is + posted. <B>form_init</B> returns the current form term hook, if + any (<B>NULL</B> if there is no such hook). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Other + routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_new.3x.html b/ncurses-5.2/doc/html/man/form_new.3x.html new file mode 100644 index 0000000..7b0d91b --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_new.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_new</B> - create and destroy forms + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + FORM *new_form(FIELD **fields); + int free_form(FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>new_form</B> creates a new form connected to a + specified field pointer array (which must be <B>NULL</B>-termi- + nated). + + The function <B>free_form</B> disconnects <I>form</I> from its field + array and frees the storage allocated for the form. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>new_form</B> returns <B>NULL</B> on error. + + The function <B>free_form</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The form has already been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_new_page.3x.html b/ncurses-5.2/doc/html/man/form_new_page.3x.html new file mode 100644 index 0000000..1a8d4ea --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_new_page.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_new_page</B> - form pagination functions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_new_page(FIELD *field, bool new_page_flag); + bool new_page(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_new_page</B> sets or resets a flag marking + the given field as the beginning of a new page on its + form. + + The function <B>new_page</B> is a predicate which tests if a + given field marks a page beginning on its form. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>new_page</B> returns <B>TRUE</B> or <B>FALSE</B>. + + The function <B>set_new_page</B> return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_CONNECTED</B> + The given field is already connected to a form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "form_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_opts.3x.html b/ncurses-5.2/doc/html/man/form_opts.3x.html new file mode 100644 index 0000000..5ae1cc4 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_opts.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_opts</B> - set and get form options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_form_opts(FORM *form, OPTIONS opts); + int form_opts_on(FORM *form, OPTIONS opts); + int form_opts_off(FORM *form, OPTIONS opts); + OPTIONS form_opts(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_form_opts</B> sets all the given form's + option bits (form option bits may be logically-OR'ed + together). + + The function <B>form_opts_on</B> turns on the given option bits, + and leaves others alone. + + The function <B>form_opts_off</B> turns off the given option + bits, and leaves others alone. + + The function <B>form_opts</B> returns the form's current option + bits. + + The following options are defined (all are on by default): + + O_NL_OVERLOAD + Overload the <B>REQ_NEW_LINE</B> forms driver request so + that calling it at the end of a field goes to the + next field. + + O_BS_OVERLOAD + Overload the <B>REQ_DEL_PREV</B> forms driver request so + that calling it at the beginning of a field goes to + the previous field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>form_opts</B>, each routine returns one of the fol- + lowing: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_page.3x.html b/ncurses-5.2/doc/html/man/form_page.3x.html new file mode 100644 index 0000000..874bda8 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_page.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_page</B> - set and get form page number + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_current_field(FORM *form, FIELD *field); + FIELD *current_field(const FORM *); + int set_form_page(FORM *form, int n); + int form_page(const FORM *form); + int field_index(const FIELD *field); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_current</B> <B>field</B> sets the current field of + the given form; <B>current_field</B> returns the current field of + the given form. + + The function <B>set_form_page</B> sets the form's page number + (goes to page <I>n</I> of the form). + + The function <B>form_page</B> returns the form's current page + number. + + The function <B>field_index</B> returns the index of the field in + the field array of the form it is connected to. It returns + <B>ERR</B> if the argument is the null pointer or the field is + not connected. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>form_page</B>, each routine returns one of the fol- + lowing: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_INVALID_FIELD</B> + Contents of a field are not valid. + + <B>E_REQUEST_DENIED</B> + The form driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_post.3x.html b/ncurses-5.2/doc/html/man/form_post.3x.html new file mode 100644 index 0000000..e52967e --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_post.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_post</B> - write or erase forms from associated subwin- + dows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int post_form(FORM *form); + int unpost_form(FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>post_form</B> displays a form to its associated + subwindow. To trigger physical display of the subwindow, + use <B>refresh</B> or some equivalent <B>curses</B> routine (the + implicit <B>doupdate</B> triggered by an <B>curses</B> input request + will do). + + The function <B>unpost_form</B> erases form from its associated + subwindow. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The form has already been posted. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NO_ROOM</B> + Form is too large for its window. + + <B>E_NOT_POSTED</B> + The form has not been posted. + + <B>E_NOT_CONNECTED</B> + No items are connected to the form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_requestname.3x.html b/ncurses-5.2/doc/html/man/form_requestname.3x.html new file mode 100644 index 0000000..dcf5065 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_requestname.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_requestname</B> - handle printable form request names + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + const char *form_request_name(int request); + int form_request_by_name(const char *name); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>form_request_name</B> returns the printable name + of a form request code. + The function <B>form_request_by_name</B> searches in the name- + table for a request with the given name and returns its + request code. Otherwise E_NO_MATCH is returned. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>form_request_name</B> returns <B>NULL</B> on error and sets errno to + <B>E_BAD_ARGUMENT</B>. + <B>form_request_by_name</B> returns <B>E_NO_MATCH</B> on error. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_userptr.3x.html b/ncurses-5.2/doc/html/man/form_userptr.3x.html new file mode 100644 index 0000000..4ac76f8 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_userptr.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_userptr</B> - associate application data with a form item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_form_userptr(FORM *form, void *userptr); + void* form_userptr(const FORM *form); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every form and every form item has a field that can be + used to hold application-specific data (that is, the form- + driver code leaves it alone). These functions get and set + the form user pointer field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>form_userptr</B> returns <B>NULL</B> on error. The + function <B>set_form_userptr</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + The user pointer should be a void pointer. We leave it as + a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/form_win.3x.html b/ncurses-5.2/doc/html/man/form_win.3x.html new file mode 100644 index 0000000..4f73a64 --- /dev/null +++ b/ncurses-5.2/doc/html/man/form_win.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>form_win</B> - make and break form window and subwindow asso- + ciations + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><form.h></B> + int set_form_win(FORM *form, WINDOW *win); + WINDOW *form_win(const FORM *form); + int set_form_sub(FORM *form, WINDOW *sub); + WINDOW *form_sub(const FORM *form); + int scale_form(const FORM *form, int *rows, int *columns); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every form has an associated pair of <B>curses</B> windows. The + form window displays any title and border associated with + the window; the form subwindow displays the items of the + form that are currently available for selection. + + The first four functions get and set those windows. It is + not necessary to set either window; by default, the driver + code uses <B>stdscr</B> for both. + + In the <B>set_</B> functions, window argument of <B>NULL</B> is treated + as though it were <B>stsdcr</B>. A form argument of <B>NULL</B> is + treated as a request to change the system default form + window or subwindow. + + The function <B>scale_form</B> returns the minimum size required + for the subwindow of <I>form</I>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Rou- + tines that return an integer return one of the following + error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The form has already been posted. + + <B>E_NOT_CONNECTED</B> + No items are connected to the form. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>. + + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><form.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/infocmp.1m.html b/ncurses-5.2/doc/html/man/infocmp.1m.html new file mode 100644 index 0000000..5f77495 --- /dev/null +++ b/ncurses-5.2/doc/html/man/infocmp.1m.html @@ -0,0 +1,406 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>infocmp</B> - compare or print out <I>terminfo</I> descriptions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>infocmp</B> [<B>-dceEGgnpqrILCuV1</B>] [<B>-v</B> <I>n</I>] [<B>-s</B> <B>d</B>| <B>i</B>| <B>l</B>| <B>c</B>] + [<B>-w</B> <I>width</I>] [<B>-A</B> <I>directory</I>] [<B>-B</B> <I>directory</I>] + [<I>termname</I>...] + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>infocmp</B> can be used to compare a binary <B>terminfo</B> entry + with other terminfo entries, rewrite a <B>terminfo</B> descrip- + tion to take advantage of the <B>use=</B> terminfo field, or + print out a <B>terminfo</B> description from the binary file + (<B>term</B>) in a variety of formats. In all cases, the boolean + fields will be printed first, followed by the numeric + fields, followed by the string fields. + + <B>Default</B> <B>Options</B> + If no options are specified and zero or one <I>termnames</I> are + specified, the <B>-I</B> option will be assumed. If more than + one <I>termname</I> is specified, the <B>-d</B> option will be assumed. + + <B>Comparison</B> <B>Options</B> <B>[-d]</B> <B>[-c]</B> <B>[-n]</B> + <B>infocmp</B> compares the <B>terminfo</B> description of the first + terminal <I>termname</I> with each of the descriptions given by + the entries for the other terminal's <I>termnames</I>. If a + capability is defined for only one of the terminals, the + value returned will depend on the type of the capability: + <B>F</B> for boolean variables, <B>-1</B> for integer variables, and + <B>NULL</B> for string variables. + + The <B>-d</B> 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 <B>-c</B> 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 <B>-u</B> option is worth using. + + The <B>-n</B> option produces a list of each capability that is + in neither entry. If no <I>termnames</I> are given, the environ- + ment variable <B>TERM</B> will be used for both of the <I>termnames</I>. + This can be used as a quick check to see if anything was + left out of a description. + + <B>Source</B> <B>Listing</B> <B>Options</B> <B>[-I]</B> <B>[-L]</B> <B>[-C]</B> <B>[-r]</B> + The <B>-I</B>, <B>-L</B>, and <B>-C</B> options will produce a source listing + for each terminal named. + + <B>-I</B> use the <B>terminfo</B> names + <B>-L</B> use the long C variable name listed in <<B>term.h</B>> + + <B>-C</B> use the <B>termcap</B> names + <B>-r</B> when using <B>-C</B>, put out all capabilities in <B>termcap</B> form + + If no <I>termnames</I> are given, the environment variable <B>TERM</B> + will be used for the terminal name. + + The source produced by the <B>-C</B> option may be used directly + as a <B>termcap</B> entry, but not all parameterized strings can + be changed to the <B>termcap</B> format. <B>infocmp</B> will attempt to + convert most of the parameterized information, and any- + thing not converted will be plainly marked in the output + and commented out. These should be edited by hand. + + All padding information for strings will be collected + together and placed at the beginning of the string where + <B>termcap</B> expects it. Mandatory padding (padding informa- + tion with a trailing '/') will become optional. + + All <B>termcap</B> variables no longer supported by <B>terminfo</B>, but + which are derivable from other <B>terminfo</B> variables, will be + output. Not all <B>terminfo</B> capabilities will be translated; + only those variables which were part of <B>termcap</B> will nor- + mally be output. Specifying the <B>-r</B> option will take off + this restriction, allowing all capabilities to be output + in <I>termcap</I> form. + + Note that because padding is collected to the beginning of + the capability, not all capabilities are output. Manda- + tory padding is not supported. Because <B>termcap</B> strings + are not as flexible, it is not always possible to convert + a <B>terminfo</B> string capability into an equivalent <B>termcap</B> + format. A subsequent conversion of the <B>termcap</B> file back + into <B>terminfo</B> format will not necessarily reproduce the + original <B>terminfo</B> source. + + Some common <B>terminfo</B> parameter sequences, their <B>termcap</B> + equivalents, and some terminal types which commonly have + such sequences, are: + + <B>terminfo</B> <B>termcap</B> Representative Terminals + --------------------------------------------------------------- + <B>%p1%c</B> <B>%.</B> adm + <B>%p1%d</B> <B>%d</B> hp, ANSI standard, vt100 + <B>%p1%'x'%+%c</B> <B>%+x</B> concept + <B>%i</B> <B>%i</B>q ANSI standard, vt100 + <B>%p1%?%'x'%>%t%p1%'y'%+%;</B> <B>%>xy</B> concept + <B>%p2</B> is printed before <B>%p1</B> <B>%r</B> hp + + <B>Use=</B> <B>Option</B> <B>[-u]</B> + The <B>-u</B> option produces a <B>terminfo</B> source description of + the first terminal <I>termname</I> which is relative to the sum + of the descriptions given by the entries for the other + terminals <I>termnames</I>. It does this by analyzing the dif- + ferences between the first <I>termname</I> and the other + <I>termnames</I> and producing a description with <B>use=</B> fields for + the other terminals. In this manner, it is possible to + retrofit generic terminfo entries into a terminal's + description. Or, if two similar terminals exist, but were + coded at different times or by different people so that + each description is a full description, using <B>infocmp</B> 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 <I>termname</I>, but one of the other + <I>termname</I> entries contains a value for it. A capability's + value gets printed if the value in the first <I>termname</I> is + not found in any of the other <I>termname</I> entries, or if the + first of the other <I>termname</I> entries that has this capabil- + ity gives a different value for the capability than that + in the first <I>termname</I>. + + The order of the other <I>termname</I> entries is significant. + Since the terminfo compiler <B>tic</B> does a left-to-right scan + of the capabilities, specifying two <B>use=</B> 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. <B>infocmp</B> will flag any such incon- + sistencies between the other <I>termname</I> entries as they are + found. + + Alternatively, specifying a capability <I>after</I> a <B>use=</B> entry + that contains that capability will cause the second speci- + fication to be ignored. Using <B>infocmp</B> to recreate a + description can be a useful check to make sure that every- + thing was specified correctly in the original source + description. + + Another error that does not cause incorrect compiled + files, but will slow down the compilation time, is speci- + fying extra <B>use=</B> fields that are superfluous. <B>infocmp</B> + will flag any other <I>termname</I> <I>use=</I> fields that were not + needed. + + <B>Changing</B> <B>Databases</B> <B>[-A</B> <I>directory</I>] [-B <I>directory</I>] + The location of the compiled <B>terminfo</B> database is taken + from the environment variable <B>TERMINFO</B> . If the variable + is not defined, or the terminal is not found in that loca- + tion, the system <B>terminfo</B> database, in <B>/usr/share/ter-</B> + <B>minfo</B>, will be used. The options <B>-A</B> and <B>-B</B> may be used to + override this location. The <B>-A</B> option will set <B>TERMINFO</B> + for the first <I>termname</I> and the <B>-B</B> option will set <B>TERMINFO</B> + for the other <I>termnames</I>. 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. + + <B>Other</B> <B>Options</B> <B>[-s</B> <B>d|i|l|c]</B> <B>[-1FTVefip]</B> <B>[-Rsubset]</B> <B>[-v</B> <I>n</I>] [-w + <I>width</I>] + The <B>-s</B> option sorts the fields within each type according + to the argument below: + + <B>d</B> leave fields in the order that they are stored in the + <I>terminfo</I> database. + + <B>i</B> sort by <I>terminfo</I> name. + + <B>l</B> sort by the long C variable name. + + <B>c</B> sort by the <I>termcap</I> name. + + If the <B>-s</B> option is not given, the fields printed out + will be sorted alphabetically by the <B>terminfo</B> name + within each type, except in the case of the <B>-C</B> or the + <B>-L</B> options, which cause the sorting to be done by the + <B>termcap</B> name or the long C variable name, respec- + tively. + + <B>-1</B> 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. + + <B>-F</B> compare terminfo files. This assumes that two fol- + lowing arguments are filenames. The files are + searched for pairwise matches between entries, with + two entries considered to match if any of their names + do. The report printed to standard output lists + entries with no matches in the other file, and + entries with more than one match. For entries with + exactly one match it includes a difference report. + Normally, to reduce the volume of the report, use + references are not resolved before looking for dif- + ferences, but resolution can be forced by also speci- + fying <B>-r</B>. + + <B>-G</B> Display constant literals in decimal form rather than + their character equivalents. + + <B>-a</B> tells <B>infocmp</B> to retain commented-out capabilities + rather than discarding them. Capabilities are com- + mented by prefixing them with a period. + + <B>-q</B> Make the comparison listing shorter by omitting sub- + headings, and using "-" for absent capabilities, "@" + for canceled rather than "NULL". + + <B>-R</B><I>subset</I> + Restrict output to a given subset. This option is + for use with archaic versions of terminfo like those + on SVr1, Ultrix, or HP/UX that do not support the + full set of SVR4/XSI Curses terminfo; and variants + such as AIX that have their own extensions incompati- + ble with SVr4/XSI. Available terminfo subsets are + "SVr1", "Ultrix", "HP", and "AIX"; see <B><A HREF="terminfo.5.html">terminfo(5)</A></B> + for details. You can also choose the subset "BSD" + which selects only capabilities with termcap equiva- + lents recognized by 4.4BSD. + + <B>-T</B> eliminates size-restrictions on the generated text. + This is mainly useful for testing and analysis, since + the compiled descriptions are limited (e.g., 1023 for + termcap, 4096 for terminfo). + + <B>-V</B> reports the version of ncurses which was used in this + program, and exits. + + <B>-e</B> Dump the capabilities of the given terminal as a C + initializer for a TERMTYPE structure (the terminal + capability structure in the <B><term.h></B>). This option + is useful for preparing versions of the curses + library hardwired for a given terminal type. + + <B>-E</B> Dump the capabilities of the given terminal as + tables, needed in the C initializer for a TERMTYPE + structure (the terminal capability structure in the + <B><term.h></B>). 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 <B>-e</B> and <B>-E</B> + options was not needed; but support for extended + names required making the arrays of terminal capabil- + ities separate from the TERMTYPE structure. + + <B>-f</B> Display complex terminfo strings which contain + if/then/else/endif expressions indented for readabil- + ity. + + <B>-g</B> Display constant character literals in quoted form + rather than their decimal equivalents. + + <B>-i</B> Analyze the initialization (<B>is1</B>, <B>is2</B>, <B>is3</B>), and reset + (<B>rs1</B>, <B>rs2</B>, <B>rs3</B>), strings in the entry. For each + string, the code tries to analyze it into actions in + terms of the other capabilities in the entry, certain + X3.64/ISO 6429/ECMA-48 capabilities, and certain DEC + VT-series private modes (the set of recognized spe- + cial sequences has been selected for completeness + over the existing terminfo database). Each report + line consists of the capability name, followed by a + colon and space, followed by a printable expansion of + the capability string with sections matching recog- + nized actions translated into {}-bracketed + descriptions. Here is a list of the DEC/ANSI special + sequences recognized: + + Action Meaning + ----------------------------------------- + RIS full reset + SC save cursor + RC restore cursor + LL home-down + RSR reset scroll region + + ISO DEC G0 enable DEC graphics for G0 + ISO UK G0 enable UK chars for G0 + ISO US G0 enable US chars for G0 + ISO DEC G1 enable DEC graphics for G1 + ISO UK G1 enable UK chars for G1 + ISO US G1 enable US chars for G1 + + DECPAM application keypad mode + DECPNM normal keypad mode + DECANSI enter ANSI mode + + DEC[+-]CKM application cursor keys + DEC[+-]ANM set VT52 mode + DEC[+-]COLM 132-column mode + DEC[+-]SCLM smooth scroll + DEC[+-]SCNM reverse video mode + DEC[+-]OM origin mode + DEC[+-]AWM wraparound mode + DEC[+-]ARM auto-repeat mode + + It also recognizes a SGR action corresponding to + ANSI/ISO 6429/ECMA Set Graphics Rendition, with the + values NORMAL, BOLD, UNDERLINE, BLINK, and REVERSE. + All but NORMAL may be prefixed with `+' (turn on) or + `-' (turn off). + + An SGR0 designates an empty highlight sequence + (equivalent to {SGR:NORMAL}). + + <B>-p</B> Ignore padding specifications when comparing strings. + + <B>-v</B> <I>n</I> prints out tracing information on standard error as + the program runs. Higher values of n induce greater + verbosity. + + <B>-w</B> <I>width</I> + changes the output to <I>width</I> characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo Compiled terminal description + database. + + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + The <B>-E</B>, <B>-F</B>, <B>-G</B>, <B>-R</B>, <B>-T</B>, <B>-V</B>, <B>-a</B>, <B>-e</B>, <B>-f</B>, <B>-g</B>, <B>-i</B>, <B>-p</B>, and <B>-q</B> + options are not supported in SVr4 curses. + + The <B>-r</B> 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 -r + -RBSD. + + +</PRE> +<H2>BUGS</H2><PRE> + The -F option of <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B> should be a <B><A HREF="toe.1m.html">toe(1m)</A></B> mode. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B>, <B><A HREF="captoinfo.1m.html">captoinfo(1m)</A></B>, <B><A HREF="infotocap.1m.html">infotocap(1m)</A></B>, <B><A HREF="tic.1m.html">tic(1m)</A></B>, + <B><A HREF="toe.1m.html">toe(1m)</A></B>, <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Eric S. Raymond <esr@snark.thyrsus.com> and Thomas E. + Dickey <dickey@herndon4.his.com> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/infotocap.1m.html b/ncurses-5.2/doc/html/man/infotocap.1m.html new file mode 100644 index 0000000..38ab95c --- /dev/null +++ b/ncurses-5.2/doc/html/man/infotocap.1m.html @@ -0,0 +1,78 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>infotocap</B> - convert a <I>terminfo</I> description into a <I>termcap</I> + description + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>infotocap</B> [<B>-v</B><I>n</I> <I>width</I>] [<B>-V</B>] [<B>-1</B>] [<B>-w</B> <I>width</I>] <I>file</I> . . . + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>infotocap</B> looks in <I>file</I> for <B>terminfo</B> descriptions. For + each one found, an equivalent <B>termcap</B> description is writ- + ten to standard output. Terminfo <B>use</B> capabilities are + translated directly to termcap <B>tc</B> capabilities. + + <B>-v</B> print out tracing information on standard error as + the program runs. + + <B>-V</B> print out the version of the program in use on stan- + dard error and exit. + + <B>-1</B> cause the fields to print out one to a line. Other- + wise, the fields will be printed several to a line to + a maximum width of 60 characters. + + <B>-w</B> change the output to <I>width</I> characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo Compiled terminal description + database. + + +</PRE> +<H2>NOTES</H2><PRE> + This utility is actually a link to <B><A HREF="tic.1m.html">tic(1m)</A></B>, running in <I>-C</I> + mode. You can use other <I>tic</I> options such as <B>-f</B> and <B>-x</B>. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="tic.1m.html">tic(1m)</A></B>, <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B> + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/keybound.3x.html b/ncurses-5.2/doc/html/man/keybound.3x.html new file mode 100644 index 0000000..11af1ac --- /dev/null +++ b/ncurses-5.2/doc/html/man/keybound.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>keybound</B> - return definition of keycode + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>keybound(int</B> <B>keycode,</B> <B>int</B> <B>count);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to determine the string which is defined in + the terminfo for specific keycodes. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The keycode must be greater than zero, else NULL is + returned. If it does not correspond to a defined key, + then NULL is returned. Otherwise, the function returns a + string, which must be freed by the caller. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="define_key.3x.html">define_key(3x)</A></B>, <B><A HREF="keyok.3x.html">keyok(3x)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/keyok.3x.html b/ncurses-5.2/doc/html/man/keyok.3x.html new file mode 100644 index 0000000..1dbe455 --- /dev/null +++ b/ncurses-5.2/doc/html/man/keyok.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>keyok</B> - enable or disable a keycode + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>keyok(int</B> <B>keycode,</B> <B>bool</B> <B>enable);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It permits an + application to disable specific keycodes, rather than use + the <I>keypad</I> function to disable all keycodes. Keys that + have been disabled can be reenabled. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The keycode must be greater than zero, else ERR is + returned. If it does not correspond to a defined key, + then ERR is returned. If the <I>enable</I> parameter is true, + then the key must have been disabled, and vice versa. + Otherwise, the function returns OK. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="define_key.3x.html">define_key(3x)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey. + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu.3x.html b/ncurses-5.2/doc/html/man/menu.3x.html new file mode 100644 index 0000000..c72b67f --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu.3x.html @@ -0,0 +1,244 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu</B> - curses extension for programming menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>menu</B> library provides terminal-independent facilities + for composing menu systems on character-cell terminals. + The library includes: item routines, which create and mod- + ify menu items; and menu routines, which group items into + menus, display menus on the screen, and handle interaction + with the user. + + The <B>menu</B> library uses the <B>curses</B> libraries, and a curses + initialization routine such as <B>initscr</B> must be called + before using any of these functions. To use the <B>menu</B> + library, link with the options <B>-lmenu</B> <B>-lcurses</B>. + + + <B>Current</B> <B>Default</B> <B>Values</B> <B>for</B> <B>Item</B> <B>Attributes</B> + The <B>menu</B> library maintains a default value for item + attributes. You can get or set this default by calling + the appropriate <B>get_</B> or <B>set_</B> routine with a <B>NULL</B> item + pointer. Changing this default with a <B>set_</B> function + affects future item creations, but does not change the + rendering of items already created. + + + <B>Routine</B> <B>Name</B> <B>Index</B> + The following table lists each <B>menu</B> routine and the name + of the manual page on which it is described. + + <B>curses</B> Routine Name Manual Page Name + -------------------------------------------- + current_item <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + free_item <B><A HREF="mitem_new.3x.html">mitem_new(3x)</A></B> + free_menu <B><A HREF="menu_new.3x.html">menu_new(3x)</A></B> + item_count <B><A HREF="menu_items.3x.html">menu_items(3x)</A></B> + item_description <B><A HREF="mitem_name.3x.html">mitem_name(3x)</A></B> + item_index <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + item_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + item_name <B><A HREF="mitem_name.3x.html">mitem_name(3x)</A></B> + item_opts <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + item_opts_off <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + item_opts_on <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + item_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + item_userptr <B><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></B> + item_value <B><A HREF="mitem_value.3x.html">mitem_value(3x)</A></B> + item_visible <B><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></B> + menu_back <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + menu_driver <B><A HREF="menu_driver.3x.html">menu_driver(3x)</A></B> + menu_fore <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + + menu_format <B><A HREF="menu_format.3x.html">menu_format(3x)</A></B> + menu_grey <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + menu_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + menu_items <B><A HREF="menu_items.3x.html">menu_items(3x)</A></B> + menu_mark <B><A HREF="menu_mark.3x.html">menu_mark(3x)</A></B> + menu_opts <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B> + menu_opts_off <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B> + menu_opts_on <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B> + menu_pad <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + menu_pattern <B><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></B> + menu_request_by_name <B><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></B> + menu_request_name <B><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></B> + menu_spacing <B><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></B> + menu_sub <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + menu_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + menu_userptr <B><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></B> + menu_win <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + new_item <B><A HREF="mitem_new.3x.html">mitem_new(3x)</A></B> + new_menu <B><A HREF="menu_new.3x.html">menu_new(3x)</A></B> + pos_menu_cursor <B><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></B> + post_menu <B><A HREF="menu_post.3x.html">menu_post(3x)</A></B> + scale_menu <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + set_current_item <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + set_item_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_item_opts <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + set_item_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_item_userptr <B><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></B> + set_item_value <B><A HREF="mitem_value.3x.html">mitem_value(3x)</A></B> + set_menu_back <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_fore <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_format <B><A HREF="menu_format.3x.html">menu_format(3x)</A></B> + set_menu_grey <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_menu_items <B><A HREF="menu_items.3x.html">menu_items(3x)</A></B> + set_menu_mark <B><A HREF="menu_mark.3x.html">menu_mark(3x)</A></B> + set_menu_opts <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + set_menu_pad <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_pattern <B><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></B> + set_menu_spacing <B><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></B> + set_menu_sub <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + set_menu_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_menu_userptr <B><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></B> + set_menu_win <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + set_top_row <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + top_row <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + unpost_menu <B><A HREF="menu_post.3x.html">menu_post(3x)</A></B> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Rou- + tines that return an integer return one of the following + error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu is already posted. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NO_ROOM</B> + Menu is too large for its window. + + <B>E_NOT_POSTED</B> + The menu has not been posted. + + <B>E_UNKNOWN_COMMAND</B> + The menu driver code saw an unknown request code. + + <B>E_NO_MATCH</B> + Character failed to match. + + <B>E_NOT_SELECTABLE</B> + The designated item cannot be selected. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + <B>E_REQUEST_DENIED</B> + The menu driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "menu_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + files <B><curses.h></B> and <B><eti.h></B>. + + 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 give you a link error + using GNU <B><A HREF="ld.1.html">ld(1)</A></B> and many other linkers). + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for ncurses + by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_attributes.3x.html b/ncurses-5.2/doc/html/man/menu_attributes.3x.html new file mode 100644 index 0000000..d6e82b0 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_attributes.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_attributes</B> - color and attribute control for menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_fore(MENU *menu, chtype attr); + chtype menu_fore(const MENU *menu); + int set_menu_back(MENU *menu, chtype attr); + chtype menu_back(const MENU *menu); + int set_menu_grey(MENU *menu, chtype attr); + chtype menu_grey(const MENU *menu); + int set_menu_pad(MENU *menu, int pad); + int menu_pad(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_menu_fore</B> sets the foreground attribute + of <I>menu</I>. This is the highlight used for selected menu + items. <B>menu_fore</B> returns the foreground attribute. The + default is <B>A_STANDOUT</B>. + + The function <B>set_menu_back</B> sets the background attribute + of <I>menu</I>. This is the highlight used for selectable (but + not currently selected) menu items. The function + <B>menu_back</B> returns the background attribute. The default + is <B>A_NORMAL</B>. + + The function <B>set_menu_grey</B> sets the grey attribute of + <I>menu</I>. This is the highlight used for un-selectable menu + items in menus that permit more than one selection. The + function <B>menu_grey</B> returns the grey attribute. The + default is <B>A_UNDERLINE</B>. + + The function <B>set_menu_pad</B> sets the character used to fill + the space between the name and description parts of a menu + item. <B>menu_pad</B> returns the given menu's pad character. + The default is a blank. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "menu_" for + detailed descriptions of the entry points. + + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_cursor.3x.html b/ncurses-5.2/doc/html/man/menu_cursor.3x.html new file mode 100644 index 0000000..aed8af8 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_cursor.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_cursor</B> - position a menu's cursor + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int pos_menu_cursor(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>pos_menu_cursor</B> restores the cursor to the + current position associated with the menu's selected item. + This is useful after <B>curses</B> routines have been called to + do screen-painting in response to a menu select. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + This routine returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_NOT_POSTED</B> + The menu has not been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_driver.3x.html b/ncurses-5.2/doc/html/man/menu_driver.3x.html new file mode 100644 index 0000000..48ea272 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_driver.3x.html @@ -0,0 +1,190 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_driver</B> - command-processing loop of the menu system + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int menu_driver(MENU *menu, int c); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Once a menu has been posted (displayed), you should funnel + input events to it through <B>menu_driver</B>. This routine has + three major input cases; either the input is a menu navi- + gation request, it's a printable ASCII character or it is + the KEY_MOUSE special key associated with an mouse event. + The menu driver requests are as follows: + + REQ_LEFT_ITEM + Move left to an item. + + REQ_RIGHT_ITEM + Move right to an item. + + REQ_UP_ITEM + Move up to an item. + + REQ_DOWN_ITEM + Move down to an item. + + REQ_SCR_ULINE + Scroll up a line. + + REQ_SCR_DLINE + Scroll down a line. + + REQ_SCR_DPAGE + Scroll down a page. + + REQ_SCR_UPAGE + Scroll up a page. + + REQ_FIRST_ITEM + Move to the first item. + + REQ_LAST_ITEM + Move to the last item. + + REQ_NEXT_ITEM + Move to the next item. + + REQ_PREV_ITEM + Move to the previous item. + + REQ_TOGGLE_ITEM + Select/deselect an item. + + REQ_CLEAR_PATTERN + Clear the menu pattern buffer. + + REQ_BACK_PATTERN + Delete the previous character from the pattern + buffer. + + REQ_NEXT_MATCH + Move to the next item matching the pattern match. + + REQ_PREV_MATCH + Move to the previous item matching the pattern match. + + If the second argument is a printable ASCII 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, <B>menu_driver</B> returns <B>E_NO_MATCH</B> and deletes the + appended character from the buffer. + + If the second argument is one of the above pre-defined + requests, the corresponding action is performed. + + If the second argument is the KEY_MOUSE special key, the + associated mouse event is translated into one of the above + pre-defined requests. Currently only clicks in the user + window (e.g. inside the menu display area or the decora- + tion window) are handled. If you click above the display + region of the menu, a REQ_SCR_ULINE is generated, if you + doubleclick a REQ_SCR_UPAGE is generated and if you + tripleclick a REQ_FIRST_ITEM is generated. If you click + below the display region of the menu, a REQ_SCR_DLINE is + generated, if you doubleclick a REQ_SCR_DPAGE is generated + and if you tripleclick a REQ_LAST_ITEM is generated. If + you click at an item inside the display area of the menu, + the menu cursor is positioned to that item. If you double- + click at an item a REQ_TOGGLE_ITEM is generated and + <B>E_UNKNOWN_COMMAND</B> is returned. This return value makes + sense, because a double click usually means that an item- + specific action should be returned. It's exactly the pur- + pose of this return value to signal that an application + specific command should be executed. If a translation into + a request was done, <B>menu_driver</B> returns the result of this + request. If you clicked outside the user window or the + mouse event couldn't be translated into a menu request an + <B>E_REQUEST_DENIED</B> is returned. + + If the second argument is neither printable ASCII nor one + of the above pre-defined menu requests or KEY_MOUSE, the + drive assumes it is an application-specific command and + returns <B>E_UNKNOWN_COMMAND</B>. Application-defined commands + should be defined relative to <B>MAX_COMMAND</B>, the maximum + value of these pre-defined requests. + + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>menu_driver</B> return one of the following error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NOT_POSTED</B> + The menu has not been posted. + + <B>E_UNKNOWN_COMMAND</B> + The menu driver code saw an unknown request code. + + <B>E_NO_MATCH</B> + Character failed to match. + + <B>E_REQUEST_DENIED</B> + The menu driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + files <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. The sup- + port for mouse events is ncurses specific. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_format.3x.html b/ncurses-5.2/doc/html/man/menu_format.3x.html new file mode 100644 index 0000000..8702733 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_format.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_format</B> - set and get menu sizes + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_format(MENU *menu, int rows, int cols); + int menu_format(const MENU *menu, int *rows, int *cols); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_menu_format</B> sets the maximum display size + of the given menu. If this size is too small to display + all menu items, the menu will be made scrollable. If this + size is larger than the menus subwindow and the subwindow + is too small to display all menu items, <B>post_menu()</B> will + fail. + + The default format is 16 rows, 1 column. Calling + <B>set_menu_format</B> with a null menu pointer will change this + default. A zero row or column argument to <B>set_menu_format</B> + is interpreted as a request not to change the current + value. + + The function <B>menu_format</B> returns the maximum-size con- + straints for the given menu into the storage addressed by + <B>rows</B> and <B>cols</B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu is already posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_hook.3x.html b/ncurses-5.2/doc/html/man/menu_hook.3x.html new file mode 100644 index 0000000..59519cd --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_hook.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_hook</B> - set hooks for automatic invocation by applica- + tions + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_item_init(MENU *menu, void (*func)(MENU *)); + void (*)(MENU *) item_init(const MENU *menu); + int set_item_term(MENU *menu, void (*func)(MENU *)); + void (*)(MENU *) item_term(const MENU *menu); + int set_menu_init(MENU *menu, void (*func)(MENU *)); + void (*)(MENU *) menu_init(const MENU *menu); + int set_menu_term(MENU *menu, void (*func)(MENU *)); + void (*)(MENU *) menu_term(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + These functions make it possible to set hook functions to + be called at various points in the automatic processing of + input event codes by <B>menu_driver</B>. + + The function <B>set_item_init</B> sets a hook to be called at + menu-post time and each time the selected item changes + (after the change). <B>item_init</B> returns the current item + init hook, if any (<B>NULL</B> if there is no such hook). + + The function <B>set_item_term</B> sets a hook to be called at + menu-unpost time and each time the selected item changes + (before the change). <B>item_term</B> returns the current item + term hook, if any (<B>NULL</B> if there is no such hook). + + The function <B>set_menu_init</B> sets a hook to be called at + menu-post time and just after the top row on the menu + changes once it is posted. <B>menu_init</B> returns the current + menu init hook, if any (<B>NULL</B> if there is no such hook). + + The function <B>set_menu_term</B> sets a hook to be called at + menu-unpost time and just before the top row on the menu + changes once it is posted. <B>menu_term</B> returns the current + menu term hook, if any (<B>NULL</B> if there is no such hook). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Other + routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_items.3x.html b/ncurses-5.2/doc/html/man/menu_items.3x.html new file mode 100644 index 0000000..d2bde33 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_items.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_items</B> - make and break connections between items and + menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_items(MENU *menu, ITEM **items); + ITEM **menu_items(const MENU *menu); + int item_count(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_menu_items</B> changes the item pointer array + of the given <I>menu</I>. The array must be terminated by a + <B>NULL</B>. + + The function <B>menu_items</B> returns the item array of the + given menu. + + The function <B>item_count</B> returns the count of items in + <I>menu</I>. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + The function <B>menu_items</B> returns <B>NULL</B> on error. + + The function <B>item_count</B> returns <B>ERR</B> (the general <B>curses</B> + error return value) on error. + + The function <B>set_menu_items</B> returns one of the following + codes on error: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu is already posted. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The SVr4 menu library documentation specifies the + <B>item_count</B> error value as -1 (which is the value of <B>ERR</B>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_mark.3x.html b/ncurses-5.2/doc/html/man/menu_mark.3x.html new file mode 100644 index 0000000..f2eeac9 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_mark.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_mark</B> - get and set the menu mark string + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_mark(MENU *menu, const char *mark); + const char *menu_mark(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + In order to make menu selections visible on older termi- + nals without highlighting or color capability, the menu + library marks selected items in a menu with a prefix + string. + + The function <B>set_menu_mark</B> sets the mark string for the + given menu. Calling <B>set_menu_mark</B> with a null menu item + will abolish the mark string. Note that changing the + length of the mark string for a menu while the menu is + posted is likely to produce unhelpful behavior. + + The default string is "-" (a dash). Calling <B>set_menu_mark</B> + with a <B>NULL</B> menu argument will change this default. + + The function <B>menu_mark</B> returns the menu's mark string (or + <B>NULL</B> if there is none). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>menu_mark</B> returns <B>NULL</B> on error. The func- + tion <B>set_menu_mark</B> may return the following error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_new.3x.html b/ncurses-5.2/doc/html/man/menu_new.3x.html new file mode 100644 index 0000000..33e39ad --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_new.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_new</B> - create and destroy menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + MENU *new_menu(ITEM **items); + int free_menu(MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>new_menu</B> creates a new menu connected to a + specified item pointer array (which must be <B>NULL</B>-termi- + nated). + + The function <B>free_menu</B> disconnects <I>menu</I> from its item + array and frees the storage allocated for the menu. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>new_menu</B> returns <B>NULL</B> on error. + + The function <B>free_menu</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu has already been posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_opts.3x.html b/ncurses-5.2/doc/html/man/menu_opts.3x.html new file mode 100644 index 0000000..5730121 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_opts.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_opts</B> - set and get menu options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_opts(MENU *menu, OPTIONS opts); + int menu_opts_on(MENU *menu, OPTIONS opts); + int menu_opts_off(MENU *menu, OPTIONS opts); + OPTIONS menu_opts(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_menu_opts</B> sets all the given menu's + option bits (menu option bits may be logically-OR'ed + together). + + The function <B>menu_opts_on</B> turns on the given option bits, + and leaves others alone. + + The function <B>menu_opts_off</B> turns off the given option + bits, and leaves others alone. + + The function <B>menu_opts</B> returns the menu's current option + bits. + + The following options are defined (all are on by default): + + O_ONEVALUE + Only one item can be selected for this menu. + + O_SHOWDESC + Display the item descriptions when the menu is + posted. + + O_ROWMAJOR + Display the menu in row-major order. + + O_IGNORECASE + Ignore the case when pattern-matching. + + O_SHOWMATCH + Move the cursor to within the item name while pat- + tern-matching. + + O_NONCYCLIC + Don't wrap around next-item and previous-item, + requests to the other end of the menu. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>menu_opts</B>, each routine returns one of the fol- + lowing: + + <B>E_OK</B> The routine succeeded. + + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_POSTED</B> + The menu is already posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_pattern.3x.html b/ncurses-5.2/doc/html/man/menu_pattern.3x.html new file mode 100644 index 0000000..2db0a3a --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_pattern.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_pattern</B> - get and set a menu's pattern buffer + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_pattern(MENU *menu, const char *pattern); + char *menu_pattern(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu has an associated pattern match buffer. As + input events that are printable ASCII characters come in, + they are appended to this match buffer and tested for a + match, as described in <B><A HREF="menu_driver.3x.html">menu_driver(3x)</A></B>. + + The function <B>set_menu_pattern</B> sets the pattern buffer for + the given menu and tries to find the first matching item. + If it succeeds, that item becomes current; if not, the + current item does not change. + + The function <B>menu_pattern</B> returns the pattern buffer of + the given <I>menu</I>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>menu_pattern</B> returns <B>NULL</B> on error. The + function <B>set_menu_pattern</B> may return the following error + codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_NO_MATCH</B> + Character failed to match. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_post.3x.html b/ncurses-5.2/doc/html/man/menu_post.3x.html new file mode 100644 index 0000000..ca73447 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_post.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_post</B> - write or erase menus from associated subwin- + dows + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int post_menu(MENU *menu); + int unpost_menu(MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>post_menu</B> displays a menu to its associated + subwindow. To trigger physical display of the subwindow, + use <B>refresh</B> or some equivalent <B>curses</B> routine (the + implicit <B>doupdate</B> triggered by an <B>curses</B> input request + will do). <B>post_menu</B> resets the selection status of all + items. + + The function <B>unpost_menu</B> erases menu from its associated + subwindow. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines return one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu has already been posted. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NO_ROOM</B> + Menu is too large for its window. You should consider + to use <B>set_menu_format()</B> to solve the problem. + + <B>E_NOT_POSTED</B> + The menu has not been posted. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_requestname.3x.html b/ncurses-5.2/doc/html/man/menu_requestname.3x.html new file mode 100644 index 0000000..388d1fe --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_requestname.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_requestname</B> - handle printable menu request names + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + const char *menu_request_name(int request); + int menu_request_by_name(const char *name); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>menu_request_name</B> returns the printable name + of a menu request code. + The function <B>menu_request_by_name</B> searches in the name- + table for a request with the given name and returns its + request code. Otherwise E_NO_MATCH is returned. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>menu_request_name</B> returns <B>NULL</B> on error and sets errno to + <B>E_BAD_ARGUMENT</B>. + <B>menu_request_by_name</B> returns <B>E_NO_MATCH</B> on error. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_spacing.3x.html b/ncurses-5.2/doc/html/man/menu_spacing.3x.html new file mode 100644 index 0000000..ba2cd1c --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_spacing.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_spacing</B> - Control spacing between menu items. + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_spacing(MENU *menu, + int spc_description + int spc_rows, + int spc_columns); + int menu_spacing(const MENU *menu, + int* spc_description + int* spc_rows, + int* spc_columns); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_menu_spacing</B> sets the spacing informa- + tions for the menu. <B>spc_description</B> controls the number + of spaces between an item name and an item description. It + must not be larger than <B>TABSIZE</B>. The menu system puts in + the middle of this spacing area the pad character. The + remaining parts are filled with spaces. <B>spc_rows</B> controls + the number of rows that are used for an item. It must not + be larger than 3. The menu system inserts then blank lines + between item rows, these lines will contain the pad char- + acter in the appropriate positions. <B>spc_columns</B> controls + the number of blanks between columns of items. It must not + be larger than TABSIZE. A value of 0 for all the spacing + values resets them to the default, which is 1 for all of + them. + The function <B>menu_spacing</B> passes back the spacing info for + the menu. If a pointer is NULL, this specific info is sim- + ply not returned. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Both routines return <B>E_OK</B> on success. <B>set_menu_spacing</B> may + return <B>E_POSTED</B> if the menu is posted, or <B>E_BAD_ARGUMENT</B> + if one of the spacing values is out of range. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines are specific to ncurses. They were not + supported on Version 7, BSD or System V implementations. + It is recommended that any code depending on them be con- + ditioned using NCURSES_VERSION. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_userptr.3x.html b/ncurses-5.2/doc/html/man/menu_userptr.3x.html new file mode 100644 index 0000000..5eebdb8 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_userptr.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_userptr</B> - associate application data with a menu item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_userptr(MENU *menu, void *userptr); + void *menu_userptr(const MENU *menu); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu and every menu item has a field that can be + used to hold application-specific data (that is, the menu- + driver code leaves it alone). These functions get and set + the menu user pointer field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>menu_userptr</B> (which returns <B>NULL</B> on error), + each function returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The user pointer should be a void pointer. We leave it as + a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/menu_win.3x.html b/ncurses-5.2/doc/html/man/menu_win.3x.html new file mode 100644 index 0000000..c2fb72a --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_win.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_win</B> - make and break menu window and subwindow asso- + ciations + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_win(MENU *menu, WINDOW *win); + WINDOW *menu_win(const MENU *menu); + int set_menu_sub(MENU *menu, WINDOW *sub); + WINDOW *menu_sub(const MENU *menu); + int scale_menu(const MENU *menu, int *rows, int *columns); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu has an associated pair of <B>curses</B> windows. The + menu window displays any title and border associated with + the window; the menu subwindow displays the items of the + menu that are currently available for selection. + + The first four functions get and set those windows. It is + not necessary to set either window; by default, the driver + code uses <B>stdscr</B> for both. + + In the <B>set_</B> functions, window argument of <B>NULL</B> is treated + as though it were <B>stsdcr</B>. A menu argument of <B>NULL</B> is + treated as a request to change the system default menu + window or subwindow. + + The function <B>scale_menu</B> returns the minimum size required + for the subwindow of <I>menu</I>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Rou- + tines that return an integer return one of the following + error codes: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu has already been posted. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_current.3x.html b/ncurses-5.2/doc/html/man/mitem_current.3x.html new file mode 100644 index 0000000..ab74dff --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_current.3x.html @@ -0,0 +1,137 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_current</B> - set and get current_menu_item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_current_item(MENU *menu, const ITEM *item); + ITEM *current_item(const MENU *menu); + int set_top_row(MENU *menu, int row); + int top_row(const MENU *menu); + int item_index(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_current_item</B> sets the current item (the + item on which the menu cursor is positioned). <B>cur-</B> + <B>rent_item</B> returns a pointer to the current item in the + given menu. + + The function <B>set_top_row</B> sets the top row of the menu to + show the given row (the top row is initially 0, and is + reset to this value whenever the <B>O_ROWMAJOR</B> option is tog- + gled). The item leftmost on the given row becomes cur- + rent. The function <B>top_row</B> returns the number of the top + menu row being displayed. + + The function <B>item_index</B> returns the (zero-origin) index of + <I>item</I> in the menu's item pointer list. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>current_item</B> returns <B>NULL</B> on error. + + <B>top_row</B> and <B>item_index</B> return <B>ERR</B> (the general <B>curses</B> + error value) on error. + + <B>set_current_item</B> and <B>set_top_row</B> return one of the follow- + ing: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The SVr4 menu library documentation specifies the <B>top_row</B> + and <B>index_item</B> error value as -1 (which is the value of + <B>ERR</B>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_name.3x.html b/ncurses-5.2/doc/html/man/mitem_name.3x.html new file mode 100644 index 0000000..803f966 --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_name.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_name</B> - get menu item name and description fields + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + const char *item_name(const ITEM *item); + const char *item_description(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>item_name</B> returns the name part of the given + item. + The function <B>item_description</B> returns the description part + of the given item. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines returns <B>NULL</B> on error. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_new.3x.html b/ncurses-5.2/doc/html/man/mitem_new.3x.html new file mode 100644 index 0000000..9918f6c --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_new.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_new</B> - create and destroy menu items + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + ITEM *new_item(const char *name, const char *description); + int free_item(ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>new_item</B> allocates a new item and initializes + it from the <B>name</B> and <B>description</B> pointers. Please notice + that the item stores only the pointers to the name and + description. Those pointers must be valid during the life- + time of the item. So you should be very carefull with + names or descriptions allocated on the stack of some rou- + tines. + The function <B>free_item</B> de-allocates an item. Please notice + that it is the responsibility of the application to + release the memory for the name or the description of the + item. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>new_item</B> returns <B>NULL</B> on error. + + The function <B>free_item</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_CONNECTED</B> + Item is connected to a menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_opts.3x.html b/ncurses-5.2/doc/html/man/mitem_opts.3x.html new file mode 100644 index 0000000..17abe42 --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_opts.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_opts</B> - set and get menu item options + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_item_opts(ITEM *item, OPTIONS opts); + int item_opts_on(ITEM *item, OPTIONS opts); + int item_opts_off(ITEM *item, OPTIONS opts); + OPTIONS item_opts(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_item_opts</B> sets all the given item's + option bits (menu option bits may be logically-OR'ed + together). + + The function <B>item_opts_on</B> turns on the given option bits, + and leaves others alone. + + The function <B>item_opts_off</B> turns off the given option + bits, and leaves others alone. + + The function <B>item_opts</B> returns the item's current option + bits. + + There is only one defined option bit mask, <B>O_SELECTABLE</B>. + When this is on, the item may be selected during menu pro- + cessing. This option defaults to on. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>item_opts</B>, each routine returns one of the fol- + lowing: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_userptr.3x.html b/ncurses-5.2/doc/html/man/mitem_userptr.3x.html new file mode 100644 index 0000000..7d7c561 --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_userptr.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_userptr</B> - associate application data with a menu + item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_item_userptr(ITEM *item, void *userptr); + void *item_userptr(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Every menu item has a field that can be used to hold + application-specific data (that is, the menu-driver code + leaves it alone). These functions get and set that field. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Except for <B>item_userptr</B> (which returns <B>NULL</B> on error), + each function returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + The user pointer should be a void pointer. We leave it as + a char pointer for SVr4 compatibility. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_value.3x.html b/ncurses-5.2/doc/html/man/mitem_value.3x.html new file mode 100644 index 0000000..a83ece2 --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_value.3x.html @@ -0,0 +1,82 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_value</B> - set and get menu item values + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_item_value(ITEM *item, bool value); + bool item_value(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + If you turn off the menu option <B>O_ONEVALUE</B> (e.g., with + <B>set_menu_opts</B> or <B>menu_opts_off</B>; see <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B>), the + menu becomes multi-valued; that is, more than one item may + simultaneously be selected. + + In a multi_valued menu, you can used <B>set_item_value</B> to + select the given menu item (second argument <B>TRUE</B>) or dese- + lect it (second argument <B>FALSE</B>). + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function <B>set_item_value</B> returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_REQUEST_DENIED</B> + The menu driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/mitem_visible.3x.html b/ncurses-5.2/doc/html/man/mitem_visible.3x.html new file mode 100644 index 0000000..bc105a0 --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_visible.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_visible</B> - check visibility of a menu item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + bool item_visible(const ITEM *item); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + A menu item is visible when it is in the portion of a + posted menu that is mapped onto the screen (if the menu is + scrollable, in particular, this portion will be smaller + than the whole menu). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/ncurses.3x.html b/ncurses-5.2/doc/html/man/ncurses.3x.html new file mode 100644 index 0000000..5fb8400 --- /dev/null +++ b/ncurses-5.2/doc/html/man/ncurses.3x.html @@ -0,0 +1,899 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>ncurses</B> - CRT screen handling and optimization package + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>ncurses</B> library routines give the user a terminal- + independent method of updating character screens with + reasonable optimization. This implementation is ``new + curses'' (ncurses) and is the approved replacement for + 4.4BSD classic curses, which has been discontinued. + + The <B>ncurses</B> routines emulate the <B><A HREF="ncurses.3x.html">curses(3x)</A></B> library of + System V Release 4 UNIX, and the XPG4 curses standard (XSI + curses) but the <B>ncurses</B> library is freely redistributable + in source form. Differences from the SVr4 curses are + summarized under the EXTENSIONS and BUGS sections below + and described in detail in the EXTENSIONS and BUGS + sections of individual man pages. + + A program using these routines must be linked with the + <B>-lncurses</B> option, or (if it has been generated) with the + debugging library <B>-lncurses_g</B>. (Your system integrator + may also have installed these libraries under the names + <B>-lcurses</B> and <B>-lcurses_g</B>.) The ncurses_g library generates + trace logs (in a file called 'trace' in the current + directory) that describe curses actions. + + The <B>ncurses</B> package supports: overall screen, window and + pad manipulation; output to windows and pads; reading + terminal input; control over terminal and <B>curses</B> input and + output options; environment query routines; color + manipulation; use of soft label keys; terminfo + capabilities; and access to low-level terminal- + manipulation routines. + + To initialize the routines, the routine <B>initscr</B> or <B>newterm</B> + must be called before any of the other routines that deal + with windows and screens are used. The routine <B>endwin</B> + must be called before exiting. To get character-at-a-time + input without echoing (most interactive, screen oriented + programs want this), the following sequence should be + used: + + <B>initscr();</B> <B>cbreak();</B> <B>noecho();</B> + + Most programs would additionally use the sequence: + + <B>nonl();</B> + <B>intrflush(stdscr,</B> <B>FALSE);</B> + <B>keypad(stdscr,</B> <B>TRUE);</B> + + Before a <B>curses</B> program is run, the tab stops of the + terminal should be set and its initialization strings, if + defined, must be output. This can be done by executing + the <B>tput</B> <B>init</B> command after the shell environment variable + <B>TERM</B> has been exported. <B>tset(1)</B> is usually responsible + for doing this. [See <B><A HREF="terminfo.5.html">terminfo(5)</A></B> for further details.] + + The <B>ncurses</B> library permits manipulation of data + structures, called <I>windows</I>, which can be thought of as + two-dimensional arrays of characters representing all or + part of a CRT screen. A default window called <B>stdscr</B>, + which is the size of the terminal screen, is supplied. + Others may be created with <B>newwin</B>. + + Note that <B>curses</B> does not handle overlapping windows, + that's done by the <B><A HREF="panel.3x.html">panel(3x)</A></B> library. This means that you + can either use <B>stdscr</B> or divide the screen into tiled + windows and not using <B>stdscr</B> at all. Mixing the two will + result in unpredictable, and undesired, effects. + + Windows are referred to by variables declared as <B>WINDOW</B> <B>*</B>. + These data structures are manipulated with routines + described here and elsewhere in the <B>ncurses</B> manual pages. + Among which the most basic routines are <B>move</B> and <B>addch</B>. + More general versions of these routines are included with + names beginning with <B>w</B>, allowing the user to specify a + window. The routines not beginning with <B>w</B> affect <B>stdscr</B>.) + + After using routines to manipulate a window, <B>refresh</B> is + called, telling <B>curses</B> to make the user's CRT screen look + like <B>stdscr</B>. The characters in a window are actually of + type <B>chtype</B>, (character and attribute data) so that other + information about the character may also be stored with + each character. + + Special windows called <I>pads</I> may also be manipulated. + These are windows which are not constrained to the size of + the screen and whose contents need not be completely + displayed. See <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B> for more information. + + In addition to drawing characters on the screen, video + attributes and colors may be supported, causing the + characters 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, <B>curses</B> 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 + <B><curses.h></B>, such as <B>A_REVERSE</B>, <B>ACS_HLINE</B>, and <B>KEY_LEFT</B>. + + If the environment variables <B>LINES</B> and <B>COLUMNS</B> are set, or + if the program is executing in a window environment, line + and column information in the environment will override + information read by <I>terminfo</I>. This would effect a program + running in an AT&T 630 layer, for example, where the size + of a screen is changeable (see <B>ENVIRONMENT</B>). + + If the environment variable <B>TERMINFO</B> is defined, any + program using <B>curses</B> checks for a local terminal + definition before checking in the standard place. For + example, if <B>TERM</B> is set to <B>att4424</B>, then the compiled + terminal definition is found in + + <B>/usr/share/terminfo/a/att4424</B>. + + (The <B>a</B> is copied from the first letter of <B>att4424</B> to avoid + creation of huge directories.) However, if <B>TERMINFO</B> is + set to <B>$HOME/myterms</B>, <B>curses</B> first checks + + <B>$HOME/myterms/a/att4424</B>, + + and if that fails, it then checks + + <B>/usr/share/terminfo/a/att4424</B>. + + This is useful for developing experimental definitions or + when write permission in <B>/usr/share/terminfo</B> is not + available. + + The integer variables <B>LINES</B> and <B>COLS</B> are defined in + <B><curses.h></B> and will be filled in by <B>initscr</B> with the size + of the screen. The constants <B>TRUE</B> and <B>FALSE</B> have the + values <B>1</B> and <B>0</B>, respectively. + + The <B>curses</B> routines also define the <B>WINDOW</B> <B>*</B> variable + <B>curscr</B> which is used for certain low-level operations like + clearing and redrawing a screen containing garbage. The + <B>curscr</B> can be used in only a few routines. + + + <B>Routine</B> <B>and</B> <B>Argument</B> <B>Names</B> + Many <B>curses</B> routines have two or more versions. The + routines prefixed with <B>w</B> require a window argument. The + routines prefixed with <B>p</B> require a pad argument. Those + without a prefix generally use <B>stdscr</B>. + + The routines prefixed with <B>mv</B> require a <I>y</I> and <I>x</I> coordinate + to move to before performing the appropriate action. The + <B>mv</B> routines imply a call to <B>move</B> before the call to the + other routine. The coordinate <I>y</I> always refers to the row + (of the window), and <I>x</I> always refers to the column. The + upper left-hand corner is always (0,0), not (1,1). + + The routines prefixed with <B>mvw</B> take both a window argument + and <I>x</I> and <I>y</I> coordinates. The window argument is always + specified before the coordinates. + + In each case, <I>win</I> is the window affected, and <I>pad</I> is the + pad affected; <I>win</I> and <I>pad</I> are always pointers to type + <B>WINDOW</B>. + + Option setting routines require a Boolean flag <I>bf</I> with the + value <B>TRUE</B> or <B>FALSE</B>; <I>bf</I> is always of type <B>bool</B>. The + variables <I>ch</I> and <I>attrs</I> below are always of type <B>chtype</B>. + The types <B>WINDOW</B>, <B>SCREEN</B>, <B>bool</B>, and <B>chtype</B> are defined in + <B><curses.h></B>. The type <B>TERMINAL</B> is defined in <B><term.h></B>. + All other arguments are integers. + + + <B>Routine</B> <B>Name</B> <B>Index</B> + The following table lists each <B>curses</B> routine and the name + of the manual page on which it is described. Routines + flagged with `*' are ncurses-specific, not described by + XPG4 or present in SVr4. + + <B>curses</B> Routine Name Manual Page Name + -------------------------------------------- + COLOR_PAIR <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + PAIR_NUMBER <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + _nc_tracebits <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _traceattr <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _traceattr2 <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _tracechar <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _tracechtype <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _tracechtype2 <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _tracedump <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _tracef <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + _tracemouse <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + addch <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B> + addchnstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + addchstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + addnstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + addstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + assume_default_colors <B><A HREF="default_colors.3x.html">default_colors(3x)</A></B>* + attr_get <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + attr_off <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + attr_on <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + attr_set <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + attroff <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + attron <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + attrset <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + baudrate <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + beep <B><A HREF="curs_beep.3x.html">curs_beep(3x)</A></B> + bkgd <B><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></B> + bkgdset <B><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></B> + border <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + box <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + can_change_color <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + cbreak <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + chgat <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + clear <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + + clearok <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + clrtobot <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + clrtoeol <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + color_content <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + color_set <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + copywin <B><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></B> + curs_set <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + curses_version <B><A HREF="curs_extend.3x.html">curs_extend(3x)</A></B>* + def_prog_mode <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + def_shell_mode <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + define_key <B><A HREF="define_key.3x.html">define_key(3x)</A></B>* + del_curterm <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + delay_output <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + delch <B><A HREF="curs_delch.3x.html">curs_delch(3x)</A></B> + deleteln <B><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></B> + delscreen <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B> + delwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + derwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + doupdate <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + dupwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + echo <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + echochar <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B> + endwin <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B> + erase <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + erasechar <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + filter <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + flash <B><A HREF="curs_beep.3x.html">curs_beep(3x)</A></B> + flushinp <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + getbegyx <B><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></B> + getbkgd <B><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></B> + getch <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> + getmaxyx <B><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></B> + getmouse <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + getnstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + getparyx <B><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></B> + getstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + getsyx <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + getwin <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + getyx <B><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></B> + halfdelay <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + has_colors <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + has_ic <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + has_il <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + has_key <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B>* + hline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + idcok <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + idlok <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + immedok <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + inch <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B> + inchnstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + inchstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + init_color <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + init_pair <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + + initscr <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B> + innstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + insch <B><A HREF="curs_insch.3x.html">curs_insch(3x)</A></B> + insdelln <B><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></B> + insertln <B><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></B> + insnstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + insstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + instr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + intrflush <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + is_linetouched <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + is_wintouched <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + isendwin <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B> + keybound <B><A HREF="keybound.3x.html">keybound(3x)</A></B>* + keyname <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + keyok <B><A HREF="keyok.3x.html">keyok(3x)</A></B>* + keypad <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + killchar <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + leaveok <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + longname <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + mcprint <B><A HREF="curs_print.3x.html">curs_print(3x)</A></B>* + meta <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + mouse_trafo <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + mouseinterval <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + mousemask <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + move <B><A HREF="curs_move.3x.html">curs_move(3x)</A></B> + mvaddch <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B> + mvaddchnstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + mvaddchstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + mvaddnstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + mvaddstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + mvchgat <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + mvcur <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + mvdelch <B><A HREF="curs_delch.3x.html">curs_delch(3x)</A></B> + mvderwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + mvgetch <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> + mvgetnstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + mvgetstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + mvhline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + mvinch <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B> + mvinchnstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + mvinchstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + mvinnstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + mvinsch <B><A HREF="curs_insch.3x.html">curs_insch(3x)</A></B> + mvinsnstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + mvinsstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + mvinstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + mvprintw <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + mvscanw <B><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></B> + mvvline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + mvwaddch <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B> + mvwaddchnstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + mvwaddchstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + mvwaddnstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + + mvwaddstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + mvwchgat <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + mvwdelch <B><A HREF="curs_delch.3x.html">curs_delch(3x)</A></B> + mvwgetch <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> + mvwgetnstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + mvwgetstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + mvwhline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + mvwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + mvwinch <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B> + mvwinchnstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + mvwinchstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + mvwinnstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + mvwinsch <B><A HREF="curs_insch.3x.html">curs_insch(3x)</A></B> + mvwinsnstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + mvwinsstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + mvwinstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + mvwprintw <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + mvwscanw <B><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></B> + mvwvline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + napms <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + newpad <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B> + newterm <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B> + newwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + nl <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + nocbreak <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + nodelay <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + noecho <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + nonl <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + noqiflush <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + noraw <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + notimeout <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + overlay <B><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></B> + overwrite <B><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></B> + pair_content <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + pechochar <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B> + pnoutrefresh <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B> + prefresh <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B> + printw <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + putp <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + putwin <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + qiflush <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + raw <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + redrawwin <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + refresh <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + reset_prog_mode <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + reset_shell_mode <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + resetty <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + resizeterm <B><A HREF="resizeterm.3x.html">resizeterm(3x)</A></B>* + restartterm <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + ripoffline <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + savetty <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + scanw <B><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></B> + scr_dump <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B> + + scr_init <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B> + scr_restore <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B> + scr_set <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B> + scrl <B><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></B> + scroll <B><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></B> + scrollok <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + set_curterm <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + set_term <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B> + setscrreg <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + setsyx <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B> + setterm <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + setupterm <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + slk_attr <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>* + slk_attr_off <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_attr_on <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_attr_set <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_attroff <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_attron <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_attrset <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_clear <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_color <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_init <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_label <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_noutrefresh <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_refresh <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_restore <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_set <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + slk_touch <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> + standend <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + standout <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + start_color <B><A HREF="curs_color.3x.html">curs_color(3x)</A></B> + subpad <B><A HREF="curs_pad.3x.html">curs_pad(3x)</A></B> + subwin <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + syncok <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + termattrs <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + termname <B><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></B> + tgetent <B><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></B> + tgetflag <B><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></B> + tgetnum <B><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></B> + tgetstr <B><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></B> + tgoto <B><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></B> + tigetflag <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + tigetnum <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + tigetstr <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + timeout <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + touchline <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + touchwin <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + tparm <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + tputs <B><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></B> + tputs <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + trace <B><A HREF="curs_trace.3x.html">curs_trace(3x)</A></B>* + typeahead <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + unctrl <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + + ungetch <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> + ungetmouse <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + untouchwin <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + use_default_colors <B><A HREF="default_colors.3x.html">default_colors(3x)</A></B>* + use_env <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B> + use_extended_names <B><A HREF="curs_extend.3x.html">curs_extend(3x)</A></B>* + vidattr <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + vidputs <B><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></B> + vline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + vw_printw <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + vw_scanw <B><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></B> + vwprintw <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + vwscanw <B><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></B> + waddch <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B> + waddchnstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + waddchstr <B><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></B> + waddnstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + waddstr <B><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></B> + wattr_get <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wattr_off <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wattr_on <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wattr_set <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wattroff <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wattron <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wattrset <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wbkgd <B><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></B> + wbkgdset <B><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></B> + wborder <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + wchgat <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wclear <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + wclrtobot <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + wclrtoeol <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + wcolor_set <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wcursyncup <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + wdelch <B><A HREF="curs_delch.3x.html">curs_delch(3x)</A></B> + wdeleteln <B><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></B> + wechochar <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B> + wenclose <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + werase <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B> + wgetch <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> + wgetnstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + wgetstr <B><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></B> + whline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + winch <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B> + winchnstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + winchstr <B><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></B> + winnstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + winsch <B><A HREF="curs_insch.3x.html">curs_insch(3x)</A></B> + winsdelln <B><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></B> + winsertln <B><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></B> + winsnstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + winsstr <B><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></B> + winstr <B><A HREF="curs_instr.3x.html">curs_instr(3x)</A></B> + + wmouse_trafo <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B>* + wmove <B><A HREF="curs_move.3x.html">curs_move(3x)</A></B> + wnoutrefresh <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + wprintw <B><A HREF="curs_printw.3x.html">curs_printw(3x)</A></B> + wredrawln <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + wrefresh <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + wresize <B><A HREF="wresize.3x.html">wresize(3x)</A></B>* + wscanw <B><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></B> + wscrl <B><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></B> + wsetscrreg <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B> + wstandend <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wstandout <B><A HREF="curs_attr.3x.html">curs_attr(3x)</A></B> + wsyncdown <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + wsyncup <B><A HREF="curs_window.3x.html">curs_window(3x)</A></B> + wtimeout <B><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></B> + wtouchln <B><A HREF="curs_touch.3x.html">curs_touch(3x)</A></B> + wvline <B><A HREF="curs_border.3x.html">curs_border(3x)</A></B> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return an integer return <B>ERR</B> upon failure + and an integer value other than <B>ERR</B> upon successful + completion, unless otherwise noted in the routine + descriptions. + + All macros return the value of the <B>w</B> version, except + <B>setscrreg</B>, <B>wsetscrreg</B>, <B>getyx</B>, <B>getbegyx</B>, <B>getmaxyx</B>. The + return values of <B>setscrreg</B>, <B>wsetscrreg</B>, <B>getyx</B>, <B>getbegyx</B>, + and <B>getmaxyx</B> are undefined (<I>i</I>.<I>e</I>., these should not be used + as the right-hand side of assignment statements). + + Routines that return pointers return <B>NULL</B> on error. + + +</PRE> +<H2>ENVIRONMENT</H2><PRE> + The following environment symbols are useful for + customizing the runtime behavior of the <B>ncurses</B> 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 <B>ncurses</B> 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 <B>cmdch</B> capability) of the loaded terminfo + entries to the value of this symbol. Very few + terminfo entries provide this feature. + + COLUMNS + Specify the width of the screen in characters. + Applications running in a windowing environment + usually are able to obtain the width of the window in + which they are executing. If neither the $COLUMNS + value nor the terminal's screen size is available, + <B>ncurses</B> uses the size which may be specified in the + terminfo database (i.e., the <B>cols</B> capability). + + It is important that your application use a correct + size for the screen. However, 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. + + Either COLUMNS or LINES 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, <B>lines</B> and <B>cols</B> should not be specified + in a terminal description for terminals which are run + as emulations. + + Use the <B>use_env</B> function to disable this feature. + + ESCDELAY + Specifies the total time, in milliseconds, for which + ncurses will await a character sequence, e.g., a + function key. The default value, 1000 milliseconds, + is enough for most uses. However, it is made a + variable to accommodate unusual applications. + + The most common instance where you may wish to change + this value is to work with slow hosts, e.g., running + on a network. If the host cannot read characters + rapidly enough, it will have the same effect as if + the terminal did not send characters rapidly enough. + The library will still see a timeout. + + Note that xterm mouse events are built up from + character sequences received from the xterm. If your + application makes heavy use of multiple-clicking, you + may wish to lengthen this default value because the + timeout applies to the composed multi-click event as + well as the individual clicks. + + HOME Tells <B>ncurses</B> where your home directory is. That is + where it may read and write auxiliary terminal + descriptions: + + $HOME/.termcap + $HOME/.terminfo + + LINES + Like COLUMNS, specify the height of the screen in + characters. See COLUMNS for a detailed description. + + MOUSE_BUTTONS_123 + This applies only to the OS/2 EMX port. It specifies + the order of buttons on the mouse. OS/2 numbers a + 3-button mouse inconsistently from other platforms: + + 1 = left + 2 = right + 3 = middle. + + This symbol lets you customize the mouse. The symbol + must be three numeric digits 1-3 in any order, e.g., + 123 or 321. If it is not specified, <B>ncurses</B> uses + 132. + + 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 + applications. Terminal emulators can duplicate all + of the important aspects of a hardware terminal, but + they do not have the same limitations. The chief + limitation of a hardware terminal from the standpoint + of your application is the management of dataflow, + i.e., timing. Unless a hardware terminal is + interfaced into a terminal concentrator (which does + flow control), it (or your application) must manage + dataflow, preventing overruns. The cheapest solution + (no hardware cost) is for your program to do this by + pausing after operations that the terminal does + slowly, such as clearing the display. + + As a result, many terminal descriptions (including + the vt100) have delay times embedded. You may wish + to use these descriptions, but not want to pay the + performance penalty. + + Set the NCURSES_NO_PADDING symbol to disable all but + mandatory padding. Mandatory padding is used as a + part of special control sequences such as <I>flash</I>. + + NCURSES_NO_SETBUF + Normally <B>ncurses</B> enables buffered output during + terminal initialization. This is done (as in SVr4 + curses) for performance reasons. For testing + purposes, both of <B>ncurses</B> and certain applications, + this feature is made optional. Setting the + NCURSES_NO_SETBUF variable disables output buffering, + leaving the output in the original (usually line + buffered) mode. + + NCURSES_TRACE + During initialization, the <B>ncurses</B> debugging library + checks the NCURSES_TRACE symbol. If it is defined, + to a numeric value, <B>ncurses</B> calls the <B>trace</B> function, + using that value as the argument. + + The argument values, which are defined in <B>curses.h</B>, + provide several types of information. When running + with traces enabled, your application will write the + file <B>trace</B> to the current directory. + + TERM Denotes your terminal type. Each terminal type is + distinct, though many are similar. + + TERMCAP + If the <B>ncurses</B> library has been configured with + <I>termcap</I> support, <B>ncurses</B> 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 <B>ncurses</B> to ignore the usual place for this + information, e.g., /etc/termcap. + + TERMINFO + Overrides the directory in which <B>ncurses</B> searches for + your terminal description. This is the simplest, but + not the only way to change the list of directories. + The complete list of directories in order follows: + + - the last directory to which <B>ncurses</B> wrote, if any, + is searched first. + + - the directory specified by the TERMINFO symbol + + - $HOME/.terminfo + + - directories listed in the TERMINFO_DIRS symbol + + - one or more directories whose names are configured + and compiled into the ncurses library, e.g., + /usr/share/terminfo + + TERMINFO_DIRS + Specifies a list of directories to search for + terminal descriptions. The list is separated by + colons (i.e., ":"). All of the terminal descriptions + are in terminfo form, which makes a subdirectory + named for the first letter of the terminal names + therein. + + TERMPATH + If TERMCAP does not hold a file name then <B>ncurses</B> + checks the TERMPATH symbol. This is a list of + filenames separated by colons (i.e., ":"). If the + TERMPATH symbol is not set, <B>ncurses</B> looks in the + files /etc/termcap, /usr/share/misc/termcap and + $HOME/.termcap, in that order. + + The library may be configured to disregard the following + variables when the current user is the superuser (root), + or if the application uses setuid or setgid permissions: + $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/tabset + directory containing initialization files for the + terminal capability database /usr/share/terminfo + terminal capability database + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="terminfo.5.html">terminfo(5)</A></B> and 3x pages whose names begin "curs_" for + detailed routine descriptions. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + The <B>ncurses</B> library can be compiled with an option + (<B>-DUSE_GETCAP</B>) that falls back to the old-style + /etc/termcap file if the terminal setup code cannot find a + terminfo entry corresponding to <B>TERM</B>. Use of this feature + is not recommended, as it essentially includes an entire + termcap compiler in the <B>ncurses</B> startup code, at + significant cost in core and startup cycles. + + The <B>ncurses</B> library includes facilities for capturing + mouse events on certain terminals (including xterm). See + the <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B> manual page for details. + + The <B>ncurses</B> library includes facilities for responding to + window resizing events, e.g., when running in an xterm. + See the <B><A HREF="resizeterm.3x.html">resizeterm(3x)</A></B> and <B><A HREF="wresize.3x.html">wresize(3x)</A></B> manual pages for + details. In addition, the library may be configured with + a SIGWINCH handler. + + The <B>ncurses</B> 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 <B><A HREF="define_key.3x.html">define_key(3x)</A></B> and <B><A HREF="keyok.3x.html">keyok(3x)</A></B> manual pages for + details. + + The <B>ncurses</B> library can exploit the capabilities of + terminals which implement the ISO-6429 SGR 39 and SGR 49 + controls, 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 + colored text on a background whose color is set + independently, providing better control over color + contrasts. See the <B><A HREF="use_default_colors.3x.html">use_default_colors(3x)</A></B> manual page for + details. + The <B>ncurses</B> library includes a function for directing + application output to a printer attached to the terminal + device. See the <B><A HREF="curs_print.3x.html">curs_print(3x)</A></B> manual page for details. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <B>ncurses</B> library is intended to be BASE-level + conformant with the XSI Curses standard. Certain portions + of the EXTENDED XSI Curses functionality (including color + support) are supported. The following EXTENDED XSI Curses + calls in support of wide (multibyte) characters are not + yet implemented: <B>add_wch</B>, <B>add_wchnstr</B>, <B>add_wchstr</B>, + <B>addnwstr</B>, <B>addwstr</B>, <B>bkgrnd</B>, <B>bkgrndset</B>, <B>border_set</B>, <B>box_set</B>, + <B>echo_wchar</B>, <B>erasewchar</B>, <B>get_wch</B>, <B>get_wstr</B>, <B>getbkgrnd</B>, + <B>getcchar</B>, <B>getn_wstr</B>, <B>getwchtype</B>, <B>hline_set</B>, <B>in_wch</B>, + <B>in_wchnstr</B>, <B>in_wchstr</B>, <B>innwstr</B>, <B>ins_nwstr</B>, <B>ins_wch</B>, + <B>ins_wstr</B>, <B>inwchnstr</B>, <B>inwchstr</B>, <B>inwstr</B>, <B>key_name</B>, + <B>killwchar</B>, <B>mvadd_wch</B>, <B>mvadd_wchnstr</B>, <B>mvadd_wchstr</B>, + <B>mvaddnwstr</B>, <B>mvaddwstr</B>, <B>mvget_wch</B>, <B>mvget_wstr</B>, <B>mvgetn_wstr</B>, + <B>mvhline_set</B>, <B>mvin_wch</B>, <B>mvinnwstr</B>, <B>mvins_nwstr</B>, <B>mvins_wch</B>, + <B>mvins_wstr</B>, <B>mvinwchnstr</B>, <B>mvinwchstr</B>, <B>mvinwchstr</B>, <B>mvinwstr</B>, + <B>mvvline_set</B>, <B>mvwadd_wch</B>, <B>mvwadd_wchnstr</B>, <B>mvwadd_wchstr</B>, + <B>mvwaddnwstr</B>, <B>mvwaddwstr</B>, <B>mvwget_ch</B>, <B>mvwget_wch</B>, + <B>mvwget_wstr</B>, <B>mvwgetn_wstr</B>, <B>mvwhline_set</B>, <B>mvwin_wch</B>, + <B>mvwin_wchnstr</B>, <B>mvwin_wchstr</B>, <B>mvwinnwstr</B>, <B>mvwins_nwstr</B>, + <B>mvwins_wch</B>, <B>mvwins_wstr</B>, <B>mvwinwchnstr</B>. <B>mvwinwstr</B>, + <B>mvwvline_set</B>, <B>pecho_wchar</B>, <B>setcchar</B>, <B>slk_wset</B>, <B>term_attrs</B>, + <B>unget_wch</B>, <B>vhline_set</B>, <B>vid_attr</B>, <B>vid_puts</B>, <B>vline_set</B>, + <B>wadd_wch</B>, <B>wadd_wchnstr</B>, <B>wadd_wchstr</B>, <B>waddnwstr</B>, <B>waddwstr</B>, + <B>waddwstr</B>, <B>wbkgrnd</B>, <B>wbkgrndset</B>, <B>wbkgrndset</B>, <B>wborder_set</B>, + <B>wecho_wchar</B>, <B>wecho_wchar</B>, <B>wget_wch</B>, <B>wget_wstr</B>, <B>wgetbkgrnd</B>, + <B>wgetn_wstr</B>, <B>whline_set</B>, <B>win_wch</B>, <B>win_wchnstr</B>, <B>win_wchstr</B>, + <B>winnwstr</B>, <B>wins_nwstr</B>, <B>wins_wch</B>, <B>wins_wstr</B>, <B>winwchnstr</B>, + <B>winwchstr</B>, <B>winwstr</B>, <B>wunctrl</B>, <B>wvline_set</B>, + + A small number of local differences (that is, individual + differences between the XSI Curses and <B>ncurses</B> calls) are + described in <B>PORTABILITY</B> sections of the library man + pages. + + The routine <B>has_key</B> is not part of XPG4, nor is it present + in SVr4. See the <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B> manual page for details. + + The routine <B>slk_attr</B> is not part of XPG4, nor is it + present in SVr4. See the <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B> manual page for + details. + + The routines <B>getmouse</B>, <B>mousemask</B>, <B>ungetmouse</B>, + <B>mouseinterval</B>, and <B>wenclose</B> relating to mouse interfacing + are not part of XPG4, nor are they present in SVr4. See + the <B><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></B> manual page for details. + + The routine <B>mcprint</B> was not present in any previous curses + implementation. See the <B><A HREF="curs_print.3x.html">curs_print(3x)</A></B> manual page for + details. + The routine <B>wresize</B> is not part of XPG4, nor is it present + in SVr4. See the <B><A HREF="wresize.3x.html">wresize(3x)</A></B> manual page for details. + + In historic curses versions, delays embedded in the + capabilities <B>cr</B>, <B>ind</B>, <B>cub1</B>, <B>ff</B> and <B>tab</B> activated + corresponding delay bits in the UNIX tty driver. In this + implementation, all padding is done by NUL sends. This + method is slightly more expensive, but narrows the + interface to the UNIX kernel significantly and increases + the package's portability correspondingly. + + In the XSI standard and SVr4 manual pages, many entry + points have prototype arguments of the for <B>char</B> <B>*const</B> (or + <B>cchar_t</B> <B>*const</B>, or <B>wchar_t</B> <B>*const</B>, or <B>void</B> <B>*const</B>). + Depending on one's interpretation of the ANSI C standard + (see section 3.5.4.1), these declarations are either (a) + meaningless, or (b) meaningless and illegal. The + declaration <B>const</B> <B>char</B> <B>*x</B> is a modifiable pointer to + unmodifiable data, but <B>char</B> <B>*const</B> <B>x</B>' is an unmodifiable + pointer to modifiable data. Given that C passes arguments + by value, <B><type></B> <B>*const</B> as a formal type is at best + dubious. Some compilers choke on the prototypes. + Therefore, in this implementation, they have been changed + to <B>const</B> <B><type></B> <B>*</B> globally. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><curses.h></B> automatically includes the + header files <B><stdio.h></B> and <B><unctrl.h></B>. + + If standard output from a <B>ncurses</B> program is re-directed + to something which is not a tty, screen updates will be + directed to standard error. This was an undocumented + feature of AT&T System V Release 3 curses. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. + Based on pcurses by Pavel Curtis. + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/panel.3x.html b/ncurses-5.2/doc/html/man/panel.3x.html new file mode 100644 index 0000000..a07930d --- /dev/null +++ b/ncurses-5.2/doc/html/man/panel.3x.html @@ -0,0 +1,194 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + panel - panel stack extension for curses + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><panel.h></B> + + <B>cc</B> <B>[flags]</B> <B>sourcefiles</B> <B>-lpanel</B> <B>-lncurses</B> + + <B>PANEL</B> <B>*new_panel(WINDOW</B> <B>*win)</B> + <B>int</B> <B>bottom_panel(PANEL</B> <B>*pan)</B> + <B>int</B> <B>top_panel(PANEL</B> <B>*pan)</B> + <B>int</B> <B>show_panel(PANEL</B> <B>*pan)</B> + <B>void</B> <B>update_panels();</B> + <B>int</B> <B>hide_panel(PANEL</B> <B>*pan)</B> + <B>WINDOW</B> <B>*panel_window(const</B> <B>PANEL</B> <B>*pan)</B> + <B>int</B> <B>replace_panel(PANEL</B> <B>*pan,</B> <B>WINDOW</B> <B>*window)</B> + <B>int</B> <B>move_panel(PANEL</B> <B>*pan,</B> <B>int</B> <B>starty,</B> <B>int</B> <B>startx)</B> + <B>int</B> <B>panel_hidden(const</B> <B>PANEL</B> <B>*pan)</B> + <B>PANEL</B> <B>*panel_above(const</B> <B>PANEL</B> <B>*pan)</B> + <B>PANEL</B> <B>*panel_below(const</B> <B>PANEL</B> <B>*pan)</B> + <B>int</B> <B>set_panel_userptr(PANEL</B> <B>*pan,</B> <B>const</B> <B>void</B> <B>*ptr)</B> + <B>const</B> <B>void</B> <B>*panel_userptr(const</B> <B>PANEL</B> <B>*pan)</B> + <B>int</B> <B>del_panel(PANEL</B> <B>*pan)</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Panels are <B><A HREF="ncurses.3x.html">curses(3x)</A></B> windows with the added feature of + depth. Panel functions allow the use of stacked windows + and ensure the proper portions of each window and the + curses <B>stdscr</B> window are hidden or displayed when panels + are added, moved, modified or removed. The set of cur- + rently visible panels is the stack of panels. The <B>stdscr</B> + window is beneath all panels, and is not considered part + of the stack. + + A window is associated with every panel. The panel rou- + tines enable you to create, move, hides, and show panels, + as well as position a panel at any desired location in the + stack. + + Panel routines are a functional layer added to <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, + make only high-level curses calls, and work anywhere ter- + minfo curses does. + + +</PRE> +<H2>FUNCTIONS</H2><PRE> + <B>new_panel(win)</B> + allocates a <B>PANEL</B> structure, associates it with + <B>win</B>, places the panel on the top of the stack + (causes it to be displayed above any other + panel) and returns a pointer to the new panel. + + <B>void</B> <B>update_panels()</B> + refreshes the virtual screen to reflect the rela- + tions between the panels in the stack, but does not + call doupdate() to refresh the physical screen. + Use this function and not wrefresh or wnoutrefresh. + update_panels() may be called more than once before + a call to doupdate(), but doupdate() is the func- + tion responsible for updating the physical screen. + + <B>del_panel(pan)</B> + removes the given panel from the stack and deallo- + cates the <B>PANEL</B> structure (but not its associated + window). + + <B>hide_panel(pan)</B> + removes the given panel from the panel stack and + thus hides it from view. The <B>PANEL</B> structure is not + lost, merely removed from the stack. + + <B>show_panel(pan)</B> + makes a hidden panel visible by placing it on top + of the panels in the panel stack. See COMPATIBILITY + below. + + <B>top_panel(pan)</B> + puts the given visible panel on top of all panels + in the stack. See COMPATIBILITY below. + + <B>bottom_panel(pan)</B> + puts panel at the bottom of all panels. + + <B>move_panel(pan,starty,startx)</B> + moves the given panel window so that its upper-left + corner is at <B>starty</B>, <B>startx</B>. It does not change + the position of the panel in the stack. Be sure to + use this function, not <B>mvwin()</B>, to move a panel + window. + + <B>replace_panel(pan,window)</B> + replaces the current window of panel with <B>window</B> + (useful, for example if you want to resize a panel; + if you're using <B>ncurses</B>, you can call <B>replace_panel</B> + on the output of <B><A HREF="wresize.3x.html">wresize(3x)</A></B>). It does not change + the position of the panel in the stack. + + <B>panel_above(pan)</B> + returns a pointer to the panel above pan. If the + panel argument is <B>(PANEL</B> <B>*)0</B>, it returns a pointer + to the bottom panel in the stack. + + <B>panel_below(pan)</B> + returns a pointer to the panel just below pan. If + the panel argument is <B>(PANEL</B> <B>*)0</B>, it returns a + pointer to the top panel in the stack. + + <B>set_panel_userptr(pan,ptr)</B> + sets the panel's user pointer. + + <B>panel_userptr(pan)</B> + returns the user pointer for a given panel. + + <B>panel_window(pan)</B> + returns a pointer to the window of the given panel. + + +</PRE> +<H2>DIAGNOSTICS</H2><PRE> + Each routine that returns a pointer returns <B>NULL</B> if an + error occurs. Each routine that returns an int value + returns <B>OK</B> if it executes successfully and <B>ERR</B> 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 program- + ming interface is unchanged). The <B>PANEL</B> data structures + are merely similar. The programmer is cautioned not to + directly use <B>PANEL</B> fields. + + The functions <B>show_panel()</B> and <B>top_panel()</B> are identical + in this implementation, and work equally well with dis- + played or hidden panels. In the native System V implemen- + tation, <B>show_panel()</B> is intended for making a hidden panel + visible (at the top of the stack) and <B>top_panel()</B> is + intended for making an already-visible panel move to the + top of the stack. You are cautioned to use the correct + function to ensure compatibility with native panel + libraries. + + +</PRE> +<H2>NOTE</H2><PRE> + In your library list, libpanel.a should be before libn- + curses.a; that is, you want to say `-lpanel -lncurses', + not the other way around (which would give you a link + error using GNU <B><A HREF="ld.1.html">ld(1)</A></B> and some other linkers). + + +</PRE> +<H2>FILES</H2><PRE> + panel.h interface for the panels library + + libpanel.a the panels library itself + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> + + +</PRE> +<H2>AUTHOR</H2><PRE> + Originally written by Warren Tucker <wht@n4hgf.mt- + park.ga.us>, primarily to assist in porting u386mon to + systems without a native panels library. Repackaged for + ncurses by Zeyd ben-Halim. + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/resizeterm.3x.html b/ncurses-5.2/doc/html/man/resizeterm.3x.html new file mode 100644 index 0000000..712dee1 --- /dev/null +++ b/ncurses-5.2/doc/html/man/resizeterm.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>resizeterm</B> - change the curses terminal size + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>resizeterm(int</B> <B>lines,</B> <B>int</B> <B>columns);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This is an extension to the curses library. It provides + callers with a hook into the <B>ncurses</B> data to resize win- + dows, primarily for use by programs running in an X Window + terminal (e.g., xterm). The function <B>resizeterm</B> resizes + the standard and current windows to the specified dimen- + sions, and adjusts other bookkeeping data used by the + <B>ncurses</B> library that record the window dimensions. + + When resizing the windows, the function blank-fills the + areas that are extended. The calling application should + fill in these areas with appropriate data. + + The function attempts to resize all windows. However, due + to the calling convention of pads, it is not possible to + resize these without additional interaction with the + application. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function returns the integer <B>ERR</B> upon failure and <B>OK</B> + on success. It will fail if either of the dimensions less + than or equal to zero, or if an error occurs while + (re)allocating memory for the windows. + + +</PRE> +<H2>NOTES</H2><PRE> + While this function is intended to be used to support a + signal handler (i.e., for SIGWINCH), care should be taken + to avoid invoking it in a context where <B>malloc</B> or <B>realloc</B> + may have been interrupted, since it uses those functions. + + If ncurses is configured to supply its own SIGWINCH han- + dler, the <B>resizeterm</B> function ungetch's a <B>KEY_RESIZE</B> which + will be read on the next call to <B>getch</B>. This is used to + alert an application that the screen size has changed, and + that it should repaint special features such as pads that + cannot be done automatically. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="wresize.3x.html">wresize(3x)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (from an equivalent function written in 1988 + for BSD curses). + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/term.5.html b/ncurses-5.2/doc/html/man/term.5.html new file mode 100644 index 0000000..b4c1ed0 --- /dev/null +++ b/ncurses-5.2/doc/html/man/term.5.html @@ -0,0 +1,184 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + term - format of compiled term file. + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>term</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + Compiled terminfo descriptions are placed under the direc- + tory <B>/usr/share/terminfo</B>. In order to avoid a linear + search of a huge UNIX system directory, a two-level scheme + is used: <B>/c/name</B> where <I>name</I> is the name of the terminal, + and <I>c</I> is the first character of <I>name</I>. Thus, <I>act4</I> can be + found in the file <B>/usr/share/terminfo/a/act4</B>. Synonyms + for the same terminal are implemented by multiple links to + the same compiled file. + + The format has been chosen so that it will be the same on + all hardware. An 8 or more bit byte is assumed, but no + assumptions about byte ordering or sign extension are + made. + + The compiled file is created with the <I>tic</I> program, and + read by the routine <I>setupterm</I>. The file is divided into + six parts: the header, terminal names, boolean flags, num- + bers, strings, and string table. + + The header section begins the file. This section contains + six short integers in the format described below. These + integers are (1) the magic number (octal 0432); (2) the + size, in bytes, of the names section; (3) the number of + bytes in the boolean section; (4) the number of short + integers in the numbers section; (5) the number of offsets + (short integers) in the strings section; (6) the size, in + bytes, of the string table. + + Short integers are stored in two 8-bit bytes. The first + byte contains the least significant 8 bits of the value, + and the second byte contains the most significant 8 bits. + (Thus, the value represented is 256*second+first.) The + value -1 is represented by the two bytes 0377, 0377; other + negative values are illegal. This value generally means + that the corresponding capability is missing from this + terminal. Note that this format corresponds to the hard- + ware of the VAX and PDP-11 (that is, little-endian + machines). Machines where this does not correspond to the + hardware must read the integers as two bytes and compute + the little-endian value. + + The terminal names section comes next. It contains the + first line of the terminfo description, listing the vari- + ous names for the terminal, separated by the `|' charac- + ter. The section is terminated with an ASCII NUL charac- + ter. + + The boolean flags have one byte for each flag. This byte + is either 0 or 1 as the flag is present or absent. The + capabilities are in the same order as the file <term.h>. + + Between the boolean section and the number section, a null + byte will be inserted, if necessary, to ensure that the + number section begins on an even byte (this is a relic of + the PDP-11's word-addressed architecture, originally + designed in to avoid IOT traps induced by addressing a + word on an odd byte boundary). All short integers are + aligned on a short word boundary. + + The numbers section is similar to the flags section. Each + capability takes up two bytes, and is stored as a little- + endian short integer. If the value represented is -1, the + capability is taken to be missing. + + The strings section is also similar. Each capability is + stored as a short integer, in the format above. A value + of -1 means the capability is missing. Otherwise, the + value is taken as an offset from the beginning of the + string table. Special characters in ^X or \c notation are + stored in their interpreted form, not the printing repre- + sentation. Padding information $<nn> and parameter infor- + mation %x are stored intact in uninterpreted form. + + The final section is the string table. It contains all + the values of string capabilities referenced in the string + section. Each string is null terminated. + + Note that it is possible for <I>setupterm</I> to expect a differ- + ent set of capabilities than are actually present in the + file. Either the database may have been updated since + <I>setupterm</I> has been recompiled (resulting in extra unrecog- + nized entries in the file) or the program may have been + recompiled more recently than the database was updated + (resulting in missing entries). The routine <I>setupterm</I> + must be prepared for both possibilities - this is why the + numbers and sizes are included. Also, new capabilities + must always be added at the end of the lists of boolean, + number, and string capabilities. + + Despite the consistent use of little-endian for numbers + and the otherwise self-describing format, it is not wise + to count on portability of binary terminfo entries between + commercial UNIX versions. The problem is that there are + at least three versions of terminfo (under HP-UX, AIX, and + OSF/1) which diverged from System V terminfo after SVr1, + and have added extension capabilities to the string table + that (in the binary format) collide with System V and XSI + Curses extensions. See <B><A HREF="terminfo.5.html">terminfo(5)</A></B> for detailed discus- + sion of terminfo source compatibility issues. + + As an example, here is a hex dump of the description for + the Lear-Siegler ADM-3, a popular though rather stupid + early terminal: + + adm3a|lsi adm3a, + am, + cols#80, lines#24, + bel=^G, clear= 32$<1>, cr=^M, cub1=^H, cud1=^J, + cuf1=^L, cup==%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K, + home=^^, ind=^J, + + 0000 1a 01 10 00 02 00 03 00 82 00 31 00 61 64 6d 33 ........ ..1.adm3 + 0010 61 7c 6c 73 69 20 61 64 6d 33 61 00 00 01 50 00 a|lsi ad m3a...P. + 0020 ff ff 18 00 ff ff 00 00 02 00 ff ff ff ff 04 00 ........ ........ + 0030 ff ff ff ff ff ff ff ff 0a 00 25 00 27 00 ff ff ........ ..%.'... + 0040 29 00 ff ff ff ff 2b 00 ff ff 2d 00 ff ff ff ff ).....+. ..-..... + 0050 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0060 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0070 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0080 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0090 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00a0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00b0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00c0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00d0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00e0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 00f0 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0100 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0110 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ........ ........ + 0120 ff ff ff ff ff ff 2f 00 07 00 0d 00 1a 24 3c 31 ....../. .....$<1 + 0130 3e 00 1b 3d 25 70 31 25 7b 33 32 7d 25 2b 25 63 >..=%p1% {32}%+%c + 0140 25 70 32 25 7b 33 32 7d 25 2b 25 63 00 0a 00 1e %p2%{32} %+%c.... + 0150 00 08 00 0c 00 0b 00 0a 00 ........ . + + + Some limitations: total compiled entries cannot exceed + 4096 bytes. The name field cannot exceed 128 bytes. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo/*/* compiled terminal capability data + base + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/term.7.html b/ncurses-5.2/doc/html/man/term.7.html new file mode 100644 index 0000000..55df37d --- /dev/null +++ b/ncurses-5.2/doc/html/man/term.7.html @@ -0,0 +1,239 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + term - conventions for naming terminal types + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The environment variable <B>TERM</B> should normally contain the + type name of the terminal, console or display-device type + you are using. This information is critical for all + screen-oriented programs, including your editor and + mailer. + + A default <B>TERM</B> value will be set on a per-line basis by + either <B>/etc/inittab</B> (Linux and System-V-like UNIXes) or + <B>/etc/ttys</B> (BSD UNIXes). This will nearly always suffice + for workstation and microcomputer consoles. + + If you use a dialup line, the type of device attached to + it may vary. Older UNIX systems pre-set a very dumb ter- + minal type like `dumb' or `dialup' on dialup lines. Newer + ones may pre-set `vt100', reflecting the prevalence of DEC + VT100-compatible terminals and personal-computer emula- + tors. + + Modern telnets pass your <B>TERM</B> environment variable from + the local side to the remote one. There can be problems + if the remote terminfo or termcap entry for your type is + not compatible with yours, but this situation is rare and + can almost always be avoided by explicitly exporting + `vt100' (assuming you are in fact using a VT100-superset + console, terminal, or terminal emulator.) + + In any case, you are free to override the system <B>TERM</B> set- + ting to your taste in your shell profile. The <B><A HREF="tset.1.html">tset(1)</A></B> + utility may be of assistance; you can give it a set of + rules for deducing or requesting a terminal type based on + the tty device and baud rate. + + Setting your own <B>TERM</B> value may also be useful if you have + created a custom entry incorporating options (such as + visual bell or reverse-video) which you wish to override + the system default type for your line. + + Terminal type descriptions are stored as files of capabil- + ity data underneath /usr/share/terminfo. To browse a list + of all terminal names recognized by the system, do + + toe | more + + from your shell. These capability files are in a binary + format optimized for retrieval speed (unlike the old text- + based <B>termcap</B> format they replace); to examine an entry, + you must use the <B><A HREF="infocmp.1.html">infocmp(1)</A></B> command. Invoke it as fol- + lows: + + infocmp <I>entry-name</I> + + where <I>entry-name</I> is the name of the type you wish to exam- + ine (and the name of its capability file the subdirectory + of /usr/share/terminfo named for its first letter). This + command dumps a capability file in the text format + described by <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. + + The first line of a <B><A HREF="terminfo.5.html">terminfo(5)</A></B> description gives the + names by which terminfo knows a terminal, separated by `|' + (pipe-bar) characters with the last name field terminated + by a comma. The first name field is the type's <I>primary</I> + <I>name</I>, and is the one to use when setting <B>TERM</B>. The last + name field (if distinct from the first) is actually a + description of the terminal type (it may contain blanks; + the others must be single words). Name fields between the + first and last (if present) are aliases for the terminal, + usually historical names retained for compatibility. + + There are some conventions for how to choose terminal pri- + mary names that help keep them informative and unique. + Here is a step-by-step guide to naming terminals that also + explains how to parse them: + + First, choose a root name. The root will consist of a + lower-case letter followed by up to seven lower-case let- + ters or digits. You need to avoid using punctuation char- + acters in root names, because they are used and inter- + preted as filenames and shell meta-characters (such as !, + $, *, ? etc.) embedded in them may cause odd and unhelpful + behavior. The slash (/), or any other character that may + be interpreted by anyone's file system (\, $, [, ]), is + especially dangerous (terminfo is platform-independent, + and choosing names with special characters could someday + make life difficult for users of a future port). The dot + (.) character is relatively safe as long as there is at + most one per root name; some historical terminfo names use + it. + + The root name for a terminal or workstation console type + should almost always begin with a vendor prefix (such as + <B>hp</B> for Hewlett-Packard, <B>wy</B> for Wyse, or <B>att</B> for AT&T ter- + minals), or a common name of the terminal line (<B>vt</B> for the + VT series of terminals from DEC, or <B>sun</B> for Sun Microsys- + tems workstation consoles, or <B>regent</B> for the ADDS Regent + series. You can list the terminfo tree to see what pre- + fixes are already in common use. The root name prefix + should be followed when appropriate by a model number; + thus <B>vt100</B>, <B>hp2621</B>, <B>wy50</B>. + + The root name for a PC-Unix console type should be the OS + name, i.e. <B>linux</B>, <B>bsdos</B>, <B>freebsd</B>, <B>netbsd</B>. It should <I>not</I> + be <B>console</B> or any other generic that might cause confusion + in a multi-platform environment! If a model number fol- + lows, it should indicate either the OS release level or + the console driver release level. + The root name for a terminal emulator (assuming it doesn't + fit one of the standard ANSI or vt100 types) should be the + program name or a readily recognizable abbreviation of it + (i.e. <B>versaterm</B>, <B>ctrm</B>). + + Following the root name, you may add any reasonable number + of hyphen-separated feature suffixes. + + 2p Has two pages of memory. Likewise 4p, 8p, etc. + + mc Magic-cookie. Some terminals (notably older Wyses) + can only support one attribute without magic-cookie + lossage. Their base entry is usually paired with + another that has this suffix and uses magic cookies + to support multiple attributes. + + -am Enable auto-margin (right-margin wraparound) + + -m Mono mode - suppress color support + + -na No arrow keys - termcap ignores arrow keys which are + actually there on the terminal, so the user can use + the arrow keys locally. + + -nam No auto-margin - suppress am capability + + -nl No labels - suppress soft labels + + -nsl No status line - suppress status line + + -pp Has a printer port which is used. + + -rv Terminal in reverse video mode (black on white) + + -s Enable status line. + + -vb Use visible bell (flash) rather than beep. + + -w Wide; terminal is in 132 column mode. + + Conventionally, if your terminal type is a variant + intended to specify a line height, that suffix should go + first. So, for a hypothetical FuBarCo model 2317 terminal + in 30-line mode with reverse video, best form would be + <B>fubar-30-rv</B> (rather than, say, `fubar-rv-30'). + + Terminal types that are written not as standalone entries, + but rather as components to be plugged into other entries + via <B>use</B> capabilities, are distinguished by using embedded + plus signs rather than dashes. + + Commands which use a terminal type to control display + often accept a -T option that accepts a terminal name + argument. Such programs should fall back on the <B>TERM</B> + environment variable when no -T option is specified. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + For maximum compatibility with older System V UNIXes, + names and aliases should be unique within the first 14 + characters. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo/?/* + compiled terminal capability data base + + /etc/inittab + tty line initialization (AT&T-like UNIXes). + + /etc/ttys + tty line initialization (BSD-like UNIXes). + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>, <B><A HREF="term.5.html">term(5)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/terminfo.5.html b/ncurses-5.2/doc/html/man/terminfo.5.html new file mode 100644 index 0000000..20bb063 --- /dev/null +++ b/ncurses-5.2/doc/html/man/terminfo.5.html @@ -0,0 +1,2242 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + terminfo - terminal capability data base + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + /usr/share/terminfo/*/* + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <I>Terminfo</I> is a data base describing terminals, used by + screen-oriented programs such as <B><A HREF="nvi.1.html">nvi(1)</A></B>, <B><A HREF="rogue.1.html">rogue(1)</A></B> and + libraries such as <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. <I>Terminfo</I> 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. + + Entries in <I>terminfo</I> consist of a sequence of `,' separated + fields (embedded commas may be escaped with a backslash + or notated as \072). White space after the `,' separator + is ignored. The first entry for each terminal gives the + names which are known for the terminal, separated by `|' + characters. The first name given is the most common + abbreviation for the terminal, the last name given should + be a long name fully identifying the terminal, and all + others are understood as synonyms for the terminal name. + All names but the last should be in lower case and contain + no blanks; the last name may well contain upper case and + blanks for readability. + + Terminal names (except for the last, verbose entry) should + be chosen using the following conventions. The particular + piece of hardware making up the terminal should have a + root name, thus ``hp2621''. This name should not contain + hyphens. Modes that the hardware can be in, or user pref- + erences, should be indicated by appending a hyphen and a + mode suffix. Thus, a vt100 in 132 column mode would be + vt100-w. The following suffixes should be used where pos- + sible: + + <B>Suffix</B> <B>Meaning</B> <B>Example</B> + -<I>nn</I> Number of lines on the screen aaa-60 + -<I>n</I>p Number of pages of memory c100-4p + -am With automargins (usually the default) vt100-am + -m Mono mode; suppress color ansi-m + -mc Magic cookie; spaces when highlighting wy30-mc + -na No arrow keys (leave them in local) c100-na + -nam Without automatic margins vt100-nam + -nl No status line att4415-nl + -ns No status line hp2626-ns + -rv Reverse video c100-rv + -s Enable status line vt100-s + -vb Use visible bell instead of beep wy370-vb + -w Wide mode (> 80 columns, usually 132) vt100-w + + For more on terminal naming conventions, see the <B>term(7)</B> + manual page. + + <B>Capabilities</B> + The following is a complete table of the capabilities + included in a terminfo description block and available to + terminfo-using code. In each line of the table, + + The <B>variable</B> is the name by which the programmer (at the + terminfo level) accesses the capability. + + The <B>capname</B> is the short name used in the text of the + database, and is used by a person updating the database. + Whenever possible, capnames are chosen to be the same as + or similar to the ANSI X3.64-1979 standard (now superseded + by ECMA-48, which uses identical or very similar names). + Semantics are also intended to match those of the specifi- + cation. + + The termcap code is the old <B>termcap</B> capability name (some + capabilities are new, and have names which termcap did not + originate). + + Capability names have no hard length limit, but an infor- + mal limit of 5 characters has been adopted to keep them + short and to allow the tabs in the source file <B>Caps</B> to + line up nicely. + + Finally, the description field attempts to convey the + semantics of the capability. You may find some codes in + the description field: + + (P) indicates that padding may be specified + + #[1-9] in the description field indicates that the string + is passed through tparm with parms as given (#<I>i</I>). + + (P*) indicates that padding may vary in proportion to + the number of lines affected + + (#<I>i</I>) indicates the <I>i</I>th parameter. + + + These are the boolean capabilities: + + <B>Variable</B> <B>Cap-</B> <B>TCap</B> <B>Description</B> + <B>Booleans</B> <B>name</B> <B>Code</B> + auto_left_margin bw bw cub1 wraps from col- + umn 0 to last column + auto_right_margin am am terminal has auto- + matic margins + back_color_erase bce ut screen erased with + background color + can_change ccc cc terminal can re- + define existing col- + ors + + ceol_standout_glitch xhp xs standout not erased + by overwriting (hp) + col_addr_glitch xhpa YA only positive motion + for hpa/mhpa caps + cpi_changes_res cpix YF changing character + pitch changes reso- + lution + cr_cancels_micro_mode crxm YB using cr turns off + micro mode + dest_tabs_magic_smso xt xt tabs destructive, + magic so char + (t1061) + eat_newline_glitch xenl xn newline ignored + after 80 cols (con- + cept) + erase_overstrike eo eo can erase over- + strikes with a blank + generic_type gn gn generic line type + hard_copy hc hc hardcopy terminal + hard_cursor chts HC cursor is hard to + see + has_meta_key km km Has a meta key + (i.e., sets 8th-bit) + has_print_wheel daisy YC printer needs opera- + tor to change char- + acter set + has_status_line hs hs has extra status + line + hue_lightness_saturation hls hl terminal uses only + HLS color notation + (Tektronix) + insert_null_glitch in in insert mode distin- + guishes nulls + lpi_changes_res lpix YG changing line pitch + changes resolution + memory_above da da display may be + retained above the + screen + memory_below db db display may be + retained below the + screen + move_insert_mode mir mi safe to move while + in insert mode + move_standout_mode msgr ms safe to move while + in standout mode + needs_xon_xoff nxon nx padding won't work, + xon/xoff required + no_esc_ctlc xsb xb beehive (f1=escape, + f2=ctrl C) + no_pad_char npc NP pad character does + not exist + non_dest_scroll_region ndscr ND scrolling region is + non-destructive + + non_rev_rmcup nrrmc NR smcup does not + reverse rmcup + over_strike os os terminal can over- + strike + prtr_silent mc5i 5i printer won't echo + on screen + row_addr_glitch xvpa YD only positive motion + for vpa/mvpa caps + semi_auto_right_margin sam YE printing in last + column causes cr + status_line_esc_ok eslok es escape can be used + on the status line + tilde_glitch hz hz can't print ~'s + (hazeltine) + transparent_underline ul ul underline character + overstrikes + xon_xoff xon xo terminal uses + xon/xoff handshaking + + These are the numeric capabilities: + + <B>Variable</B> <B>Cap-</B> <B>TCap</B> <B>Description</B> + <B>Numeric</B> <B>name</B> <B>Code</B> + columns cols co number of columns in + a line + init_tabs it it tabs initially every + # spaces + label_height lh lh rows in each label + label_width lw lw columns in each + label + lines lines li number of lines on + screen or page + lines_of_memory lm lm lines of memory if > + line. 0 means varies + magic_cookie_glitch xmc sg number of blank + characters left by + smso or rmso + max_attributes ma ma maximum combined + attributes terminal + can handle + max_colors colors Co maximum number of + colors on screen + max_pairs pairs pa maximum number of + color-pairs on the + screen + maximum_windows wnum MW maximum number of + defineable windows + no_color_video ncv NC video attributes + that can't be used + with colors + num_labels nlab Nl number of labels on + screen + + + padding_baud_rate pb pb lowest baud rate + where padding needed + virtual_terminal vt vt virtual terminal + number (CB/unix) + width_status_line wsl ws number of columns in + status line + + The following numeric capabilities are present in the + SVr4.0 term structure, but are not yet documented in the + man page. They came in with SVr4's printer support. + + <B>Variable</B> <B>Cap-</B> <B>TCap</B> <B>Description</B> + <B>Numeric</B> <B>name</B> <B>Code</B> + bit_image_entwining bitwin Yo number of passes for + each bit-image row + bit_image_type bitype Yp type of bit-image + device + buffer_capacity bufsz Ya numbers of bytes + buffered before + printing + buttons btns BT number of buttons on + mouse + dot_horz_spacing spinh Yc spacing of dots hor- + izontally in dots + per inch + dot_vert_spacing spinv Yb spacing of pins ver- + tically in pins per + inch + max_micro_address maddr Yd maximum value in + micro_..._address + max_micro_jump mjump Ye maximum value in + parm_..._micro + micro_col_size mcs Yf character step size + when in micro mode + micro_line_size mls Yg line step size when + in micro mode + number_of_pins npins Yh numbers of pins in + print-head + output_res_char orc Yi horizontal resolu- + tion in units per + line + output_res_horz_inch orhi Yk horizontal resolu- + tion in units per + inch + output_res_line orl Yj vertical resolution + in units per line + output_res_vert_inch orvi Yl vertical resolution + in units per inch + print_rate cps Ym print rate in char- + acters per second + wide_char_size widcs Yn character step size + when in double wide + mode + + These are the string capabilities: + + <B>Variable</B> <B>Cap-</B> <B>TCap</B> <B>Description</B> + <B>String</B> <B>name</B> <B>Code</B> + acs_chars acsc ac graphics charset + pairs, based on + vt100 + back_tab cbt bt back tab (P) + bell bel bl audible signal + (bell) (P) + carriage_return cr cr carriage return (P*) + (P*) + change_char_pitch cpi ZA Change number of + characters per inch + to #1 + change_line_pitch lpi ZB Change number of + lines per inch to #1 + change_res_horz chr ZC Change horizontal + resolution to #1 + change_res_vert cvr ZD Change vertical res- + olution to #1 + change_scroll_region csr cs change region to + line #1 to line #2 + (P) + char_padding rmp rP like ip but when in + insert mode + clear_all_tabs tbc ct clear all tab stops + (P) + clear_margins mgc MC clear right and left + soft margins + clear_screen clear cl clear screen and + home cursor (P*) + clr_bol el1 cb Clear to beginning + of line + clr_eol el ce clear to end of line + (P) + clr_eos ed cd clear to end of + screen (P*) + column_address hpa ch horizontal position + #1, absolute (P) + command_character cmdch CC terminal settable + cmd character in + prototype !? + create_window cwin CW define a window #1 + from #2,#3 to #4,#5 + cursor_address cup cm move to row #1 + columns #2 + cursor_down cud1 do down one line + cursor_home home ho home cursor (if no + cup) + cursor_invisible civis vi make cursor invisi- + ble + cursor_left cub1 le move left one space + + cursor_mem_address mrcup CM memory relative cur- + sor addressing, move + to row #1 columns #2 + cursor_normal cnorm ve make cursor appear + normal (undo + civis/cvvis) + cursor_right cuf1 nd non-destructive + space (move right + one space) + cursor_to_ll ll ll last line, first + column (if no cup) + cursor_up cuu1 up up one line + cursor_visible cvvis vs make cursor very + visible + define_char defc ZE Define a character + #1, #2 dots wide, + descender #3 + delete_character dch1 dc delete character + (P*) + delete_line dl1 dl delete line (P*) + dial_phone dial DI dial number #1 + dis_status_line dsl ds disable status line + display_clock dclk DK display clock + down_half_line hd hd half a line down + ena_acs enacs eA enable alternate + char set + enter_alt_charset_mode smacs as start alternate + character set (P) + enter_am_mode smam SA turn on automatic + margins + enter_blink_mode blink mb turn on blinking + enter_bold_mode bold md turn on bold (extra + bright) mode + enter_ca_mode smcup ti string to start pro- + grams using cup + enter_delete_mode smdc dm enter delete mode + enter_dim_mode dim mh turn on half-bright + mode + enter_doublewide_mode swidm ZF Enter double-wide + mode + enter_draft_quality sdrfq ZG Enter draft-quality + mode + enter_insert_mode smir im enter insert mode + enter_italics_mode sitm ZH Enter italic mode + enter_leftward_mode slm ZI Start leftward car- + riage motion + enter_micro_mode smicm ZJ Start micro-motion + mode + enter_near_letter_quality snlq ZK Enter NLQ mode + enter_normal_quality snrmq ZL Enter normal-quality + mode + enter_protected_mode prot mp turn on protected + mode + + enter_reverse_mode rev mr turn on reverse + video mode + enter_secure_mode invis mk turn on blank mode + (characters invisi- + ble) + enter_shadow_mode sshm ZM Enter shadow-print + mode + enter_standout_mode smso so begin standout mode + enter_subscript_mode ssubm ZN Enter subscript mode + enter_superscript_mode ssupm ZO Enter superscript + mode + enter_underline_mode smul us begin underline mode + enter_upward_mode sum ZP Start upward car- + riage motion + enter_xon_mode smxon SX turn on xon/xoff + handshaking + erase_chars ech ec erase #1 characters + (P) + exit_alt_charset_mode rmacs ae end alternate char- + acter set (P) + exit_am_mode rmam RA turn off automatic + margins + exit_attribute_mode sgr0 me turn off all + attributes + exit_ca_mode rmcup te strings to end pro- + grams using cup + exit_delete_mode rmdc ed end delete mode + exit_doublewide_mode rwidm ZQ End double-wide mode + exit_insert_mode rmir ei exit insert mode + exit_italics_mode ritm ZR End italic mode + exit_leftward_mode rlm ZS End left-motion mode + exit_micro_mode rmicm ZT End micro-motion + mode + exit_shadow_mode rshm ZU End shadow-print + mode + exit_standout_mode rmso se exit standout mode + exit_subscript_mode rsubm ZV End subscript mode + exit_superscript_mode rsupm ZW End superscript mode + exit_underline_mode rmul ue exit underline mode + exit_upward_mode rum ZX End reverse charac- + ter motion + exit_xon_mode rmxon RX turn off xon/xoff + handshaking + fixed_pause pause PA pause for 2-3 sec- + onds + flash_hook hook fh flash switch hook + flash_screen flash vb visible bell (may + not move cursor) + form_feed ff ff hardcopy terminal + page eject (P*) + from_status_line fsl fs return from status + line + goto_window wingo WG go to window #1 + + hangup hup HU hang-up phone + init_1string is1 i1 initialization + string + init_2string is2 is initialization + string + init_3string is3 i3 initialization + string + init_file if if name of initializa- + tion file + init_prog iprog iP path name of program + for initialization + initialize_color initc Ic initialize color #1 + to (#2,#3,#4) + initialize_pair initp Ip Initialize color + pair #1 to + fg=(#2,#3,#4), + bg=(#5,#6,#7) + insert_character ich1 ic insert character (P) + insert_line il1 al insert line (P*) + insert_padding ip ip insert padding after + inserted character + key_a1 ka1 K1 upper left of keypad + key_a3 ka3 K3 upper right of key- + pad + key_b2 kb2 K2 center of keypad + key_backspace kbs kb backspace key + key_beg kbeg @1 begin key + key_btab kcbt kB back-tab key + key_c1 kc1 K4 lower left of keypad + key_c3 kc3 K5 lower right of key- + pad + key_cancel kcan @2 cancel key + key_catab ktbc ka clear-all-tabs key + key_clear kclr kC clear-screen or + erase key + key_close kclo @3 close key + key_command kcmd @4 command key + key_copy kcpy @5 copy key + key_create kcrt @6 create key + key_ctab kctab kt clear-tab key + key_dc kdch1 kD delete-character key + key_dl kdl1 kL delete-line key + key_down kcud1 kd down-arrow key + key_eic krmir kM sent by rmir or smir + in insert mode + key_end kend @7 end key + key_enter kent @8 enter/send key + key_eol kel kE clear-to-end-of-line + key + key_eos ked kS clear-to-end-of- + screen key + key_exit kext @9 exit key + key_f0 kf0 k0 F0 function key + + key_f1 kf1 k1 F1 function key + key_f10 kf10 k; F10 function key + key_f11 kf11 F1 F11 function key + key_f12 kf12 F2 F12 function key + key_f13 kf13 F3 F13 function key + key_f14 kf14 F4 F14 function key + key_f15 kf15 F5 F15 function key + key_f16 kf16 F6 F16 function key + key_f17 kf17 F7 F17 function key + key_f18 kf18 F8 F18 function key + key_f19 kf19 F9 F19 function key + key_f2 kf2 k2 F2 function key + key_f20 kf20 FA F20 function key + key_f21 kf21 FB F21 function key + key_f22 kf22 FC F22 function key + key_f23 kf23 FD F23 function key + key_f24 kf24 FE F24 function key + key_f25 kf25 FF F25 function key + key_f26 kf26 FG F26 function key + key_f27 kf27 FH F27 function key + key_f28 kf28 FI F28 function key + key_f29 kf29 FJ F29 function key + key_f3 kf3 k3 F3 function key + key_f30 kf30 FK F30 function key + key_f31 kf31 FL F31 function key + key_f32 kf32 FM F32 function key + key_f33 kf33 FN F33 function key + key_f34 kf34 FO F34 function key + key_f35 kf35 FP F35 function key + key_f36 kf36 FQ F36 function key + key_f37 kf37 FR F37 function key + key_f38 kf38 FS F38 function key + key_f39 kf39 FT F39 function key + key_f4 kf4 k4 F4 function key + key_f40 kf40 FU F40 function key + key_f41 kf41 FV F41 function key + key_f42 kf42 FW F42 function key + key_f43 kf43 FX F43 function key + key_f44 kf44 FY F44 function key + key_f45 kf45 FZ F45 function key + key_f46 kf46 Fa F46 function key + key_f47 kf47 Fb F47 function key + key_f48 kf48 Fc F48 function key + key_f49 kf49 Fd F49 function key + key_f5 kf5 k5 F5 function key + key_f50 kf50 Fe F50 function key + key_f51 kf51 Ff F51 function key + key_f52 kf52 Fg F52 function key + key_f53 kf53 Fh F53 function key + key_f54 kf54 Fi F54 function key + key_f55 kf55 Fj F55 function key + key_f56 kf56 Fk F56 function key + key_f57 kf57 Fl F57 function key + + key_f58 kf58 Fm F58 function key + key_f59 kf59 Fn F59 function key + key_f6 kf6 k6 F6 function key + key_f60 kf60 Fo F60 function key + key_f61 kf61 Fp F61 function key + key_f62 kf62 Fq F62 function key + key_f63 kf63 Fr F63 function key + key_f7 kf7 k7 F7 function key + key_f8 kf8 k8 F8 function key + key_f9 kf9 k9 F9 function key + key_find kfnd @0 find key + key_help khlp %1 help key + key_home khome kh home key + key_ic kich1 kI insert-character key + key_il kil1 kA insert-line key + key_left kcub1 kl left-arrow key + key_ll kll kH lower-left key (home + down) + key_mark kmrk %2 mark key + key_message kmsg %3 message key + key_move kmov %4 move key + key_next knxt %5 next key + key_npage knp kN next-page key + key_open kopn %6 open key + key_options kopt %7 options key + key_ppage kpp kP previous-page key + key_previous kprv %8 previous key + key_print kprt %9 print key + key_redo krdo %0 redo key + key_reference kref &1 reference key + key_refresh krfr &2 refresh key + key_replace krpl &3 replace key + key_restart krst &4 restart key + key_resume kres &5 resume key + key_right kcuf1 kr right-arrow key + key_save ksav &6 save key + key_sbeg kBEG &9 shifted begin key + key_scancel kCAN &0 shifted cancel key + key_scommand kCMD *1 shifted command key + key_scopy kCPY *2 shifted copy key + key_screate kCRT *3 shifted create key + key_sdc kDC *4 shifted delete-char- + acter key + key_sdl kDL *5 shifted delete-line + key + key_select kslt *6 select key + key_send kEND *7 shifted end key + key_seol kEOL *8 shifted clear-to- + end-of-line key + key_sexit kEXT *9 shifted exit key + key_sf kind kF scroll-forward key + key_sfind kFND *0 shifted find key + key_shelp kHLP #1 shifted help key + + key_shome kHOM #2 shifted home key + key_sic kIC #3 shifted insert-char- + acter key + key_sleft kLFT #4 shifted left-arrow + key + key_smessage kMSG %a shifted message key + key_smove kMOV %b shifted move key + key_snext kNXT %c shifted next key + key_soptions kOPT %d shifted options key + key_sprevious kPRV %e shifted previous key + key_sprint kPRT %f shifted print key + key_sr kri kR scroll-backward key + key_sredo kRDO %g shifted redo key + key_sreplace kRPL %h shifted replace key + key_sright kRIT %i shifted right-arrow + key + key_srsume kRES %j shifted resume key + key_ssave kSAV !1 shifted save key + key_ssuspend kSPD !2 shifted suspend key + key_stab khts kT set-tab key + key_sundo kUND !3 shifted undo key + key_suspend kspd &7 suspend key + key_undo kund &8 undo key + key_up kcuu1 ku up-arrow key + keypad_local rmkx ke leave 'key- + board_transmit' mode + keypad_xmit smkx ks enter 'key- + board_transmit' mode + lab_f0 lf0 l0 label on function + key f0 if not f0 + lab_f1 lf1 l1 label on function + key f1 if not f1 + lab_f10 lf10 la label on function + key f10 if not f10 + lab_f2 lf2 l2 label on function + key f2 if not f2 + lab_f3 lf3 l3 label on function + key f3 if not f3 + lab_f4 lf4 l4 label on function + key f4 if not f4 + lab_f5 lf5 l5 label on function + key f5 if not f5 + lab_f6 lf6 l6 label on function + key f6 if not f6 + lab_f7 lf7 l7 label on function + key f7 if not f7 + lab_f8 lf8 l8 label on function + key f8 if not f8 + lab_f9 lf9 l9 label on function + key f9 if not f9 + label_format fln Lf label format + label_off rmln LF turn off soft labels + label_on smln LO turn on soft labels + + meta_off rmm mo turn off meta mode + meta_on smm mm turn on meta mode + (8th-bit on) + micro_column_address mhpa ZY Like column_address + in micro mode + micro_down mcud1 ZZ Like cursor_down in + micro mode + micro_left mcub1 Za Like cursor_left in + micro mode + micro_right mcuf1 Zb Like cursor_right in + micro mode + micro_row_address mvpa Zc Like row_address #1 + in micro mode + micro_up mcuu1 Zd Like cursor_up in + micro mode + newline nel nw newline (behave like + cr followed by lf) + order_of_pins porder Ze Match software bits + to print-head pins + orig_colors oc oc Set all color pairs + to the original ones + orig_pair op op Set default pair to + its original value + pad_char pad pc padding char + (instead of null) + parm_dch dch DC delete #1 characters + (P*) + parm_delete_line dl DL delete #1 lines (P*) + parm_down_cursor cud DO down #1 lines (P*) + parm_down_micro mcud Zf Like parm_down_cur- + sor in micro mode + parm_ich ich IC insert #1 characters + (P*) + parm_index indn SF scroll forward #1 + lines (P) + parm_insert_line il AL insert #1 lines (P*) + parm_left_cursor cub LE move #1 characters + to the left (P) + parm_left_micro mcub Zg Like parm_left_cur- + sor in micro mode + parm_right_cursor cuf RI move #1 characters + to the right (P*) + parm_right_micro mcuf Zh Like parm_right_cur- + sor in micro mode + parm_rindex rin SR scroll back #1 lines + (P) + parm_up_cursor cuu UP up #1 lines (P*) + parm_up_micro mcuu Zi Like parm_up_cursor + in micro mode + pkey_key pfkey pk program function key + #1 to type string #2 + + + + pkey_local pfloc pl program function key + #1 to execute string + #2 + pkey_xmit pfx px program function key + #1 to transmit + string #2 + plab_norm pln pn program label #1 to + show string #2 + print_screen mc0 ps print contents of + screen + prtr_non mc5p pO turn on printer for + #1 bytes + prtr_off mc4 pf turn off printer + prtr_on mc5 po turn on printer + pulse pulse PU select pulse dialing + quick_dial qdial QD dial number #1 with- + out checking + remove_clock rmclk RC remove clock + repeat_char rep rp repeat char #1 #2 + times (P*) + req_for_input rfi RF send next input char + (for ptys) + reset_1string rs1 r1 reset string + reset_2string rs2 r2 reset string + reset_3string rs3 r3 reset string + reset_file rf rf name of reset file + restore_cursor rc rc restore cursor to + position of last + save_cursor + row_address vpa cv vertical position #1 + absolute (P) + save_cursor sc sc save current cursor + position (P) + scroll_forward ind sf scroll text up (P) + scroll_reverse ri sr scroll text down (P) + select_char_set scs Zj Select character + set, #1 + set_attributes sgr sa define video + attributes #1-#9 + (PG9) + set_background setb Sb Set background color + #1 + set_bottom_margin smgb Zk Set bottom margin at + current line + set_bottom_margin_parm smgbp Zl Set bottom margin at + line #1 or (if smgtp + is not given) #2 + lines from bottom + set_clock sclk SC set clock, #1 hrs #2 + mins #3 secs + set_color_pair scp sp Set current color + pair to #1 + + + set_foreground setf Sf Set foreground color + #1 + set_left_margin smgl ML set left soft margin + at current column. + See smgl. (ML is not + in BSD termcap). + set_left_margin_parm smglp Zm Set left (right) + margin at column #1 + set_right_margin smgr MR set right soft mar- + gin at current col- + umn + set_right_margin_parm smgrp Zn Set right margin at + column #1 + set_tab hts st set a tab in every + row, current columns + set_top_margin smgt Zo Set top margin at + current line + set_top_margin_parm smgtp Zp Set top (bottom) + margin at row #1 + set_window wind wi current window is + lines #1-#2 cols + #3-#4 + start_bit_image sbim Zq Start printing bit + image graphics + start_char_set_def scsd Zr Start character set + definition #1, with + #2 characters in the + set + stop_bit_image rbim Zs Stop printing bit + image graphics + stop_char_set_def rcsd Zt End definition of + character set #1 + subscript_characters subcs Zu List of subscript- + able characters + superscript_characters supcs Zv List of superscript- + able characters + tab ht ta tab to next 8-space + hardware tab stop + these_cause_cr docr Zw Printing any of + these characters + causes CR + to_status_line tsl ts move to status line, + column #1 + tone tone TO select touch tone + dialing + underline_char uc uc underline char and + move past it + up_half_line hu hu half a line up + user0 u0 u0 User string #0 + user1 u1 u1 User string #1 + user2 u2 u2 User string #2 + user3 u3 u3 User string #3 + user4 u4 u4 User string #4 + + user5 u5 u5 User string #5 + user6 u6 u6 User string #6 + user7 u7 u7 User string #7 + user8 u8 u8 User string #8 + user9 u9 u9 User string #9 + wait_tone wait WA wait for dial-tone + xoff_character xoffc XF XOFF character + xon_character xonc XN XON character + zero_motion zerom Zx No motion for subse- + quent character + + The following string capabilities are present in the + SVr4.0 term structure, but were originally not documented + in the man page. + + <B>Variable</B> <B>Cap-</B> <B>TCap</B> <B>Description</B> + <B>String</B> <B>name</B> <B>Code</B> + alt_scancode_esc scesa S8 Alternate escape + for scancode emu- + lation + bit_image_carriage_return bicr Yv Move to beginning + of same row + bit_image_newline binel Zz Move to next row + of the bit image + bit_image_repeat birep Xy Repeat bit image + cell #1 #2 times + char_set_names csnm Zy Produce #1'th item + from list of char- + acter set names + code_set_init csin ci Init sequence for + multiple codesets + color_names colornm Yw Give name for + color #1 + define_bit_image_region defbi Yx Define rectan- + gualar bit image + region + device_type devt dv Indicate lan- + guage/codeset sup- + port + display_pc_char dispc S1 Display PC charac- + ter #1 + end_bit_image_region endbi Yy End a bit-image + region + enter_pc_charset_mode smpch S2 Enter PC character + display mode + enter_scancode_mode smsc S4 Enter PC scancode + mode + exit_pc_charset_mode rmpch S3 Exit PC character + display mode + exit_scancode_mode rmsc S5 Exit PC scancode + mode + + + + get_mouse getm Gm Curses should get + button events, + parameter #1 not + documented. + key_mouse kmous Km Mouse event has + occurred + mouse_info minfo Mi Mouse status + information + pc_term_options pctrm S6 PC terminal + options + pkey_plab pfxl xl Program function + key #1 to type + string #2 and show + string #3 + req_mouse_pos reqmp RQ Request mouse + position + scancode_escape scesc S7 Escape for scan- + code emulation + set0_des_seq s0ds s0 Shift to code set + 0 (EUC set 0, + ASCII) + set1_des_seq s1ds s1 Shift to code set + 1 + set2_des_seq s2ds s2 Shift to code set + 2 + set3_des_seq s3ds s3 Shift to code set + 3 + set_a_background setab AB Set background + color to #1, using + ANSI escape + set_a_foreground setaf AF Set foreground + color to #1, using + ANSI escape + set_color_band setcolor Yz Change to ribbon + color #1 + set_lr_margin smglr ML Set both left and + right margins to + #1, #2. (ML is + not in BSD term- + cap). + set_page_length slines YZ Set page length to + #1 lines + set_tb_margin smgtb MT Sets both top and + bottom margins to + #1, #2 + + The XSI Curses standard added these. They are some + post-4.1 versions of System V curses, e.g., Solaris 2.5 + and IRIX 6.x. The <B>ncurses</B> 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! + + <B>Variable</B> <B>Cap-</B> <B>TCap</B> <B>Description</B> + <B>String</B> <B>name</B> <B>Code</B> + enter_horizontal_hl_mode ehhlm Xh Enter horizontal + highlight mode + enter_left_hl_mode elhlm Xl Enter left highlight + mode + enter_low_hl_mode elohlm Xo Enter low highlight + mode + enter_right_hl_mode erhlm Xr Enter right high- + light mode + enter_top_hl_mode ethlm Xt Enter top highlight + mode + enter_vertical_hl_mode evhlm Xv Enter vertical high- + light mode + set_a_attributes sgr1 sA Define second set of + video attributes + #1-#6 + set_pglen_inch slengthsL YI Set page length + to #1 hundredth of + an inch + + + <B>A</B> <B>Sample</B> <B>Entry</B> + The following entry, describing an ANSI-standard terminal, + is representative of what a <B>terminfo</B> 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 <I>terminfo</I> 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. + + + <B>Types</B> <B>of</B> <B>Capabilities</B> + All capabilities have names. For instance, the fact that + ANSI-standard terminals have <I>automatic</I> <I>margins</I> (i.e., an + automatic return and line-feed when the end of a line is + reached) is indicated by the capability <B>am</B>. Hence the + description of ansi includes <B>am</B>. Numeric capabilities are + followed by the character `#' and then a positive value. + Thus <B>cols</B>, which indicates the number of columns the ter- + minal has, gives the value `80' for ansi. Values for + numeric capabilities may be specified in decimal, octal or + hexadecimal, using the C programming language conventions + (e.g., 255, 0377 and 0xff or 0xFF). + + Finally, string valued capabilities, such as <B>el</B> (clear to + end of line sequence) are given by the two-character code, + an `=', and then a string ending at the next following + `,'. + + A number of escape sequences are provided in the string + valued capabilities for easy encoding of characters there. + Both <B>\E</B> and <B>\e</B> map to an ESCAPE character, <B>^x</B> maps to a + control-x for any appropriate x, and the sequences <B>\n</B> <B>\l</B> + <B>\r</B> <B>\t</B> <B>\b</B> <B>\f</B> <B>\s</B> give a newline, line-feed, return, tab, + backspace, form-feed, and space. Other escapes include <B>\^</B> + for <B>^</B>, <B>\\</B> for <B>\</B>, <B>\</B>, for comma, <B>\:</B> for <B>:</B>, and <B>\0</B> for null. + (<B>\0</B> will produce \200, which does not terminate a string + but behaves as a null character on most terminals, provid- + ing CS7 is specified. See <B><A HREF="stty.1.html">stty(1)</A></B>.) Finally, characters + may be given as three octal digits after a <B>\</B>. + + A delay in milliseconds may appear anywhere in a string + capability, enclosed in $<..> brackets, as in <B>el</B>=\EK$<5>, + and padding characters are supplied by <I>tputs</I> to provide + this delay. The delay must be a number with at most one + decimal place of precision; it may be followed by suffixes + `*' or '/' or both. A `*' indicates that the padding + required is proportional to the number of lines affected + by the operation, and the amount given is the per- + affected-unit padding required. (In the case of insert + character, the factor is still the number of <I>lines</I> + affected.) Normally, padding is advisory if the device + has the <B>xon</B> 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 <B>xon</B> is + present to indicate flow control. + + Sometimes individual capabilities must be commented out. + To do this, put a period before the capability name. For + example, see the second <B>ind</B> in the example above. + + + <B>Fetching</B> <B>Compiled</B> <B>Descriptions</B> + 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 <B>ncurses</B> version of the ter- + minfo reader code will instead look in the directory + <B>$HOME/.terminfo</B> 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 <I>/usr/share/terminfo</I>). 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, + <I>/usr/share/terminfo</I>. + + (Neither the <B>$HOME/.terminfo</B> lookups nor TERMINFO_DIRS + extensions are supported under stock System V ter- + minfo/curses.) + + + <B>Preparing</B> <B>Descriptions</B> + We now outline how to prepare descriptions of terminals. + The most effective way to prepare a terminal description + is by imitating the description of a similar terminal in + <I>terminfo</I> and to build up a description gradually, using + partial descriptions with <I>vi</I> or some other screen-oriented + program to check that they are correct. Be aware that a + very unusual terminal may expose deficiencies in the abil- + ity of the <I>terminfo</I> file to describe it or bugs in the + screen-handling code of the test program. + + To get the padding for insert line right (if the terminal + manufacturer did not document it) a severe test is to edit + a large file at 9600 baud, delete 16 or so lines from the + middle of the screen, then hit the `u' key several times + quickly. If the terminal messes up, more padding is usu- + ally needed. A similar test can be used for insert char- + acter. + + + <B>Basic</B> <B>Capabilities</B> + The number of columns on each line for the terminal is + given by the <B>cols</B> numeric capability. If the terminal is + a CRT, then the number of lines on the screen is given by + the <B>lines</B> capability. If the terminal wraps around to the + beginning of the next line when it reaches the right + margin, then it should have the <B>am</B> capability. If the + terminal can clear its screen, leaving the cursor in the + home position, then this is given by the <B>clear</B> string + capability. If the terminal overstrikes (rather than + clearing a position when a character is struck over) then + it should have the <B>os</B> capability. If the terminal is a + printing terminal, with no soft copy unit, give it both <B>hc</B> + and <B>os</B>. (<B>os</B> applies to storage scope terminals, such as + TEKTRONIX 4010 series, as well as hard copy and APL termi- + nals.) If there is a code to move the cursor to the left + edge of the current row, give this as <B>cr</B>. (Normally this + will be carriage return, control M.) If there is a code + to produce an audible signal (bell, beep, etc) give this + as <B>bel</B>. + + If there is a code to move the cursor one position to the + left (such as backspace) that capability should be given + as <B>cub1</B>. Similarly, codes to move to the right, up, and + down should be given as <B>cuf1</B>, <B>cuu1</B>, and <B>cud1</B>. These local + cursor motions should not alter the text they pass over, + for example, you would not normally use `<B>cuf1</B>= ' because + the space would erase the character moved over. + + A very important point here is that the local cursor + motions encoded in <I>terminfo</I> are undefined at the left and + top edges of a CRT terminal. Programs should never + attempt to backspace around the left edge, unless <B>bw</B> is + given, and never attempt to go up locally off the top. In + order to scroll text up, a program will go to the bottom + left corner of the screen and send the <B>ind</B> (index) string. + + To scroll text down, a program goes to the top left corner + of the screen and sends the <B>ri</B> (reverse index) string. + The strings <B>ind</B> and <B>ri</B> are undefined when not on their + respective corners of the screen. + + Parameterized versions of the scrolling sequences are <B>indn</B> + and <B>rin</B> which have the same semantics as <B>ind</B> and <B>ri</B> except + that they take one parameter, and scroll that many lines. + They are also undefined except at the appropriate edge of + the screen. + + The <B>am</B> 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 <B>cuf1</B> from the last column. + The only local motion which is defined from the left edge + is if <B>bw</B> is given, then a <B>cub1</B> from the left edge will + move to the right edge of the previous row. If <B>bw</B> 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 + <I>terminfo</I> file usually assumes that this is on; i.e., <B>am</B>. + If the terminal has a command which moves to the first + column of the next line, that command can be given as <B>nel</B> + (newline). It does not matter if the command clears the + remainder of the current line, so if the terminal has no + <B>cr</B> and <B>lf</B> it may still be possible to craft a working <B>nel</B> + out of one or both of them. + + These capabilities suffice to describe hard-copy and + "glass-tty" terminals. Thus the model 33 teletype is + described as + + 33|tty33|tty|model 33 teletype, + bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, + + while the Lear Siegler ADM-3 is described as + + adm3|3|lsi adm3, + am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, + ind=^J, lines#24, + + + <B>Parameterized</B> <B>Strings</B> + Cursor addressing and other strings requiring parameters + in the terminal are described by a parameterized string + capability, with <B><A HREF="printf.3S.html">printf(3S)</A></B> like escapes <B>%x</B> in it. For + example, to address the cursor, the <B>cup</B> capability is + given, using two parameters: the row and column to address + to. (Rows and columns are numbered from zero and refer to + the physical screen visible to the user, not to any unseen + memory.) If the terminal has memory relative cursor + addressing, that can be indicated by <B>mrcup</B>. + + The parameter mechanism uses a stack and special <B>%</B> codes + to manipulate it. Typically a sequence will push one of + the parameters onto the stack and then print it in some + format. Often more complex operations are necessary. + + The <B>%</B> encodings have the following meanings: + + %% outputs `%' + %<I>[[</I>:<I>]flags][width[.precision]][</I>doxXs<I>]</I> + as in <B>printf</B>, flags are [-+#] and space + %c print pop() like %c in printf() + %s print pop() like %s in printf() + + %p[1-9] push <I>i</I>'th parm + %P[a-z] set dynamic variable [a-z] to pop() + %g[a-z] get dynamic variable [a-z] and push it + %P[A-Z] set static variable [a-z] to pop() + %g[A-Z] get static variable [a-z] and push it + %'<I>c</I>' char constant <I>c</I> + %{<I>nn</I>} integer constant <I>nn</I> + %l push strlen(pop) + + %+ %- %* %/ %m + arithmetic (%m is mod): push(pop() op pop()) + + %& %| %^ bit operations: push(pop() op pop()) + %= %> %< logical operations: push(pop() op pop()) + %A, %O logical and & or operations (for conditionals) + %! %~ unary operations push(op pop()) + %i add 1 to first two parameters (for ANSI terminals) + + %? expr %t thenpart %e elsepart %; + if-then-else, %e elsepart is optional. + else-if's are possible a la Algol 68: + %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; + ci are conditions, bi are bodies. + + Binary operations are in postfix form with the operands in + the usual order. That is, to get x-5 one would use + "%gx%{5}%-". %P and %g variables are persistent across + escape-string evaluations. + + Consider the HP2645, which, to get to row 3 and column 12, + needs to be sent \E&a12c03Y padded for 6 milliseconds. + Note that the order of the rows and columns is inverted + here, and that the row and column are printed as two dig- + its. Thus its <B>cup</B> capability is "cup=6\E&%p2%2dc%p1%2dY". + + The Microterm ACT-IV needs the current row and column sent + preceded by a <B>^T</B>, 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 (<B>cub1</B>), and to + move the cursor up one line on the screen (<B>cuu1</B>). This is + necessary because it is not always safe to transmit <B>\n</B> <B>^D</B> + and <B>\r</B>, as the system may change or discard them. (The + library routines dealing with terminfo set tty modes so + that tabs are never expanded, so \t is safe to send. This + turns out to be essential for the Ann Arbor 4080.) + + A final example is the LSI ADM-3a, which uses row and col- + umn offset by a blank character, thus "cup=\E=%p1%' + '%+%c%p2%' '%+%c". After sending `\E=', this pushes the + first parameter, pushes the ASCII value for a space (32), + adds them (pushing the sum on the stack in place of the + two previous values) and outputs that value as a charac- + ter. Then the same is done for the second parameter. + More complex arithmetic is possible using the stack. + + + <B>Cursor</B> <B>Motions</B> + If the terminal has a fast way to home the cursor (to very + upper left corner of screen) then this can be given as + <B>home</B>; similarly a fast way of getting to the lower left- + hand corner can be given as <B>ll</B>; this may involve going up + with <B>cuu1</B> from the home position, but a program should + never do this itself (unless <B>ll</B> does) because it can make + no assumption about the effect of moving up from the home + position. Note that the home position is the same as + addressing to (0,0): to the top left corner of the screen, + not of memory. (Thus, the \EH sequence on HP terminals + cannot be used for <B>home</B>.) + + If the terminal has row or column absolute cursor address- + ing, these can be given as single parameter capabilities + <B>hpa</B> (horizontal position absolute) and <B>vpa</B> (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 <B>cup</B>. If there are parameter- + ized local motions (e.g., move <I>n</I> spaces to the right) + these can be given as <B>cud</B>, <B>cub</B>, <B>cuf</B>, and <B>cuu</B> with a single + parameter indicating how many spaces to move. These are + primarily useful if the terminal does not have <B>cup</B>, 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 <B>smcup</B> and <B>rmcup</B>. This + arises, for example, from terminals like the Concept with + more than one page of memory. If the terminal has only + memory relative cursor addressing and not screen relative + cursor addressing, a one screen-sized window must be fixed + into the terminal for cursor addressing to work properly. + This is also used for the TEKTRONIX 4025, where <B>smcup</B> sets + the command character to be the one used by terminfo. If + the <B>smcup</B> sequence will not restore the screen after an + <B>rmcup</B> sequence is output (to the state prior to outputting + <B>rmcup</B>), specify <B>nrrmc</B>. + + + <B>Area</B> <B>Clears</B> + If the terminal can clear from the current position to the + end of the line, leaving the cursor where it is, this + should be given as <B>el</B>. 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 + <B>el1</B>. If the terminal can clear from the current position + to the end of the display, then this should be given as + <B>ed</B>. <B>Ed</B> 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 <B>ed</B> is not available.) + + + <B>Insert/delete</B> <B>line</B> <B>and</B> <B>vertical</B> <B>motions</B> + If the terminal can open a new blank line before the line + where the cursor is, this should be given as <B>il1</B>; 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 <B>dl1</B>; this is done only from the first + position on the line to be deleted. Versions of <B>il1</B> and + <B>dl1</B> which take a single parameter and insert or delete + that many lines can be given as <B>il</B> and <B>dl</B>. + + If the terminal has a settable scrolling region (like the + vt100) the command to set this can be described with the + <B>csr</B> capability, which takes two parameters: the top and + bottom lines of the scrolling region. The cursor position + is, alas, undefined after using this command. + + It is possible to get the effect of insert or delete line + using <B>csr</B> on a properly chosen region; the <B>sc</B> and <B>rc</B> (save + and restore cursor) commands may be useful for ensuring + that your synthesized insert/delete string does not move + the cursor. (Note that the <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B> library does this + synthesis automatically, so you need not compose + insert/delete strings for an entry with <B>csr</B>). + + Yet another way to construct insert and delete might be to + use a combination of index with the memory-lock feature + found on some terminals (like the HP-700/90 series, which + however also has insert/delete). + + Inserting lines at the top or bottom of the screen can + also be done using <B>ri</B> or <B>ind</B> on many terminals without a + true insert/delete line, and is often faster even on ter- + minals with those features. + + The boolean <B>non_dest_scroll_region</B> 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 <B>ri</B> followed by <B>dl1</B> or <B>ind</B>. If the data + scrolled off the bottom of the region by the <B>ri</B> re- + appears, then scrolling is non-destructive. System V and + XSI Curses expect that <B>ind</B>, <B>ri</B>, <B>indn</B>, and <B>rin</B> will simu- + late destructive scrolling; their documentation cautions + you not to define <B>csr</B> unless this is true. This <B>curses</B> + implementation is more liberal and will do explicit erases + after scrolling if <B>ndstr</B> is defined. + + If the terminal has the ability to define a window as part + of memory, which all commands affect, it should be given + as the parameterized string <B>wind</B>. The four parameters are + the starting and ending lines in memory and the starting + and ending columns in memory, in that order. + + If the terminal can retain display memory above, then the + <B>da</B> capability should be given; if display memory can be + retained below, then <B>db</B> should be given. These indicate + that deleting a line or scrolling may bring non-blank + lines up from below or that scrolling back with <B>ri</B> may + bring down non-blank lines. + + + <B>Insert/Delete</B> <B>Character</B> + There are two basic kinds of intelligent terminals with + respect to insert/delete character which can be described + using <I>terminfo.</I> 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 <B>in</B>, which stands + for "insert null". While these are two logically separate + attributes (one line vs. multi-line insert mode, and spe- + cial treatment of untyped spaces) we have seen no termi- + nals 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 <B>smir</B> the + sequence to get into insert mode. Give as <B>rmir</B> the + sequence to leave insert mode. Now give as <B>ich1</B> 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 <B>ich1</B>; 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 <B>ich1</B>. 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 <B>ich</B> sequences do not require previous smir, + and most smir insert modes do not require <B>ich1</B> before each + character. Therefore, the new <B>curses</B> actually assumes + this is the case and uses either <B>rmir</B>/<B>smir</B> or <B>ich</B>/<B>ich1</B> as + appropriate (but not both). If you have to write an entry + to be used under new curses for a terminal old enough to + need both, include the <B>rmir</B>/<B>smir</B> sequences in <B>ich1</B>. + + If post insert padding is needed, give this as a number of + milliseconds in <B>ip</B> (a string option). Any other sequence + which may need to be sent after an insert of a single + character may also be given in <B>ip</B>. If your terminal needs + both to be placed into an `insert mode' and a special code + to precede each inserted character, then both <B>smir</B>/<B>rmir</B> + and <B>ich1</B> can be given, and both will be used. The <B>ich</B> + capability, with one parameter, <I>n</I>, will repeat the effects + of <B>ich1</B> <I>n</I> times. + + If padding is necessary between characters typed while not + in insert mode, give this as a number of milliseconds + padding in <B>rmp</B>. + + 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 <B>mir</B> to speed up inserting in this case. + Omitting <B>mir</B> will affect only speed. Some terminals + (notably Datamedia's) must not have <B>mir</B> because of the way + their insert mode works. + + Finally, you can specify <B>dch1</B> to delete a single charac- + ter, <B>dch</B> with one parameter, <I>n</I>, to delete <I>n</I> <I>characters,</I> + and delete mode by giving <B>smdc</B> and <B>rmdc</B> to enter and exit + delete mode (any mode the terminal needs to be placed in + for <B>dch1</B> to work). + + A command to erase <I>n</I> characters (equivalent to outputting + <I>n</I> blanks without moving the cursor) can be given as <B>ech</B> + with one parameter. + + + <B>Highlighting,</B> <B>Underlining,</B> <B>and</B> <B>Visible</B> <B>Bells</B> + If your terminal has one or more kinds of display + attributes, these can be represented in a number of dif- + ferent ways. You should choose one display form as <I>stand-</I> + <I>out</I> <I>mode</I>, 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 + <B>smso</B> and <B>rmso</B>, respectively. If the code to change into + or out of standout mode leaves one or even two blank + spaces on the screen, as the TVI 912 and Teleray 1061 do, + then <B>xmc</B> should be given to tell how many spaces are left. + + Codes to begin underlining and end underlining can be + given as <B>smul</B> and <B>rmul</B> respectively. If the terminal has + a code to underline the current character and move the + cursor one space to the right, such as the Microterm Mime, + this can be given as <B>uc</B>. + + Other capabilities to enter various highlighting modes + include <B>blink</B> (blinking) <B>bold</B> (bold or extra bright) <B>dim</B> + (dim or half-bright) <B>invis</B> (blanking or invisible text) + <B>prot</B> (protected) <B>rev</B> (reverse video) <B>sgr0</B> (turn off <I>all</I> + attribute modes) <B>smacs</B> (enter alternate character set + mode) and <B>rmacs</B> (exit alternate character set mode). + Turning on any of these modes singly may or may not turn + off other modes. + + If there is a sequence to set arbitrary combinations of + modes, this should be given as <B>sgr</B> (set attributes), tak- + ing 9 parameters. Each parameter is either 0 or nonzero, + as the corresponding attribute is on or off. The 9 param- + eters are, in order: standout, underline, reverse, blink, + dim, bold, blank, protect, alternate character set. Not + all modes need be supported by <B>sgr</B>, only those for which + corresponding separate attribute commands exist. + + For example, the DEC vt220 supports most of the modes: + + <B>tparm</B> <B>parameter</B> <B>attribute</B> <B>escape</B> <B>sequence</B> + + none none \E[0m + p1 standout \E[0;1;7m + p2 underline \E[0;4m + p3 reverse \E[0;7m + p4 blink \E[0;5m + p5 dim not available + p6 bold \E[0;1m + p7 invis \E[0;8m + p8 protect not used + p9 altcharset ^O (off) ^N (on) + + We begin each escape sequence by turning off any existing + modes, since there is no quick way to determine whether + they are active. Standout is set up to be the combination + of reverse and bold. The vt220 terminal has a protect + mode, though it is not commonly used in sgr because it + protects characters on the screen from the host's era- + sures. The altcharset mode also is different in that it + is either ^O or ^N, depending on whether it is off or on. + If all modes are turned on, the resulting sequence is + \E[0;1;4;5;7;8m^N. + + Some sequences are common to different modes. For exam- + ple, ;7 is output when either p1 or p3 is true, that is, + if either standout or reverse modes are turned on. + + Writing out the above sequences, along with their depen- + dencies yields + + <B>sequence</B> <B>when</B> <B>to</B> <B>output</B> <B>terminfo</B> <B>translation</B> + + \E[0 always \E[0 + ;1 if p1 or p6 %?%p1%p6%|%t;1%; + ;4 if p2 %?%p2%|%t;4%; + + ;5 if p4 %?%p4%|%t;5%; + ;7 if p1 or p3 %?%p1%p3%|%t;7%; + ;8 if p7 %?%p7%|%t;8%; + m always m + ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; + + Putting this all together into the sgr sequence gives: + + sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p1%p3%|%t;7%; + %?%p4%t;5%;%?%p7%t;8%;m%?%p9%t\016%e\017%;, + + Remember that if you specify sgr, you must also specify + sgr0. + + Terminals with the ``magic cookie'' glitch (<B>xmc</B>) deposit + special ``cookies'' when they receive mode-setting + sequences, which affect the display algorithm rather than + having extra bits for each character. Some terminals, + such as the HP 2621, automatically leave standout mode + when they move to a new line or the cursor is addressed. + Programs using standout mode should exit standout mode + before moving the cursor or sending a newline, unless the + <B>msgr</B> capability, asserting that it is safe to move in + standout mode, is present. + + If the terminal has a way of flashing the screen to indi- + cate an error quietly (a bell replacement) then this can + be given as <B>flash</B>; it must not move the cursor. + + If the cursor needs to be made more visible than normal + when it is not on the bottom line (to make, for example, a + non-blinking underline into an easier to find block or + blinking underline) give this sequence as <B>cvvis</B>. If there + is a way to make the cursor completely invisible, give + that as <B>civis</B>. The capability <B>cnorm</B> should be given which + undoes the effects of both of these modes. + + If your terminal correctly generates underlined characters + (with no special codes needed) even though it does not + overstrike, then you should give the capability <B>ul</B>. If a + character overstriking another leaves both characters on + the screen, specify the capability <B>os</B>. If overstrikes are + erasable with a blank, then this should be indicated by + giving <B>eo</B>. + + + <B>Keypad</B> <B>and</B> <B>Function</B> <B>Keys</B> + If the terminal has a keypad that transmits codes when the + keys are pressed, this information can be given. Note that + it is not possible to handle terminals where the keypad + only works in local (this applies, for example, to the + unshifted HP 2621 keys). If the keypad can be set to + transmit or not transmit, give these codes as <B>smkx</B> and + <B>rmkx</B>. 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 <B>kcub1,</B> <B>kcuf1,</B> + <B>kcuu1,</B> <B>kcud1,</B> and <B>khome</B> respectively. If there are func- + tion keys such as f0, f1, ..., f10, the codes they send + can be given as <B>kf0,</B> <B>kf1,</B> <B>...,</B> <B>kf10</B>. If these keys have + labels other than the default f0 through f10, the labels + can be given as <B>lf0,</B> <B>lf1,</B> <B>...,</B> <B>lf10</B>. The codes transmit- + ted by certain other special keys can be given: <B>kll</B> (home + down), <B>kbs</B> (backspace), <B>ktbc</B> (clear all tabs), <B>kctab</B> + (clear the tab stop in this column), <B>kclr</B> (clear screen or + erase key), <B>kdch1</B> (delete character), <B>kdl1</B> (delete line), + <B>krmir</B> (exit insert mode), <B>kel</B> (clear to end of line), <B>ked</B> + (clear to end of screen), <B>kich1</B> (insert character or enter + insert mode), <B>kil1</B> (insert line), <B>knp</B> (next page), <B>kpp</B> + (previous page), <B>kind</B> (scroll forward/down), <B>kri</B> (scroll + backward/up), <B>khts</B> (set a tab stop in this column). In + addition, if the keypad has a 3 by 3 array of keys includ- + ing the four arrow keys, the other five keys can be given + as <B>ka1</B>, <B>ka3</B>, <B>kb2</B>, <B>kc1</B>, and <B>kc3</B>. These keys are useful + when the effects of a 3 by 3 directional pad are needed. + + Strings to program function keys can be given as <B>pfkey</B>, + <B>pfloc</B>, and <B>pfx</B>. A string to program screen labels should + be specified as <B>pln</B>. Each of these strings takes two + parameters: the function key number to program (from 0 to + 10) and the string to program it with. Function key num- + bers out of this range may program undefined keys in a + terminal dependent manner. The difference between the + capabilities is that <B>pfkey</B> causes pressing the given key + to be the same as the user typing the given string; <B>pfloc</B> + causes the string to be executed by the terminal in local; + and <B>pfx</B> causes the string to be transmitted to the com- + puter. + + The capabilities <B>nlab</B>, <B>lw</B> and <B>lh</B> define the number of pro- + grammable screen labels and their width and height. If + there are commands to turn the labels on and off, give + them in <B>smln</B> and <B>rmln</B>. <B>smln</B> is normally output after one + or more pln sequences to make sure that the change becomes + visible. + + + <B>Tabs</B> <B>and</B> <B>Initialization</B> + If the terminal has hardware tabs, the command to advance + to the next tab stop can be given as <B>ht</B> (usually control + I). A ``back-tab'' command which moves leftward to the + preceding tab stop can be given as <B>cbt</B>. 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 <B>ht</B> or <B>cbt</B> even if they are pre- + sent, since the user may not have the tab stops properly + set. If the terminal has hardware tabs which are ini- + tially set every <I>n</I> spaces when the terminal is powered up, + the numeric parameter <B>it</B> is given, showing the number of + spaces the tabs are set to. This is normally used by the + <I>tset</I> command to determine whether to set the mode for + hardware tab expansion, and whether to set the tab stops. + If the terminal has tab stops that can be saved in non- + volatile memory, the terminfo description can assume that + they are properly set. + + Other capabilities include <B>is1</B>, <B>is2</B>, and <B>is3</B>, initializa- + tion strings for the terminal, <B>iprog</B>, the path name of a + program to be run to initialize the terminal, and <B>if</B>, the + name of a file containing long initialization strings. + These strings are expected to set the terminal into modes + consistent with the rest of the terminfo description. + They are normally sent to the terminal, by the <I>init</I> option + of the <I>tput</I> program, each time the user logs in. They + will be printed in the following order: run the program + <B>iprog</B>; output <B>is1</B>; <B>is2</B>; set the margins using <B>mgc</B>, <B>smgl</B> + and <B>smgr</B>; set tabs using <B>tbc</B> and <B>hts</B>; print the file <B>if</B>; + and finally output <B>is3</B>. + + Most initialization is done with <B>is2</B>. Special terminal + modes can be set up without duplicating strings by putting + the common sequences in <B>is2</B> and special cases in <B>is1</B> and + <B>is3</B>. A pair of sequences that does a harder reset from a + totally unknown state can be analogously given as <B>rs1</B>, + <B>rs2</B>, <B>rf</B>, and <B>rs3</B>, analogous to <B>is2</B> and <B>if</B>. These strings + are output by the <I>reset</I> program, which is used when the + terminal gets into a wedged state. Commands are normally + placed in <B>rs1</B>, <B>rs2</B> <B>rs3</B> and <B>rf</B> only if they produce annoy- + ing effects on the screen and are not necessary when log- + ging in. For example, the command to set the vt100 into + 80-column mode would normally be part of <B>is2</B>, but it + causes an annoying glitch of the screen and is not nor- + mally needed since the terminal is usually already in 80 + column mode. + + If there are commands to set and clear tab stops, they can + be given as <B>tbc</B> (clear all tab stops) and <B>hts</B> (set a tab + stop in the current column of every row). If a more com- + plex sequence is needed to set the tabs than can be + described by this, the sequence can be placed in <B>is2</B> or + <B>if</B>. + + <B>Delays</B> <B>and</B> <B>Padding</B> + Many older and slower terminals don't support either + XON/XOFF or DTR handshaking, including hard copy terminals + and some very archaic CRTs (including, for example, DEC + VT100s). These may require padding characters after cer- + tain cursor motions and screen changes. + + If the terminal uses xon/xoff handshaking for flow control + (that is, it automatically emits ^S back to the host when + its input buffers are close to full), set <B>xon</B>. This capa- + bility suppresses the emission of padding. You can also + set it for memory-mapped console devices effectively that + don't have a speed limit. Padding information should + still be included so that routines can make better deci- + sions about relative costs, but actual pad characters will + not be transmitted. + + If <B>pb</B> (padding baud rate) is given, padding is suppressed + at baud rates below the value of <B>pb</B>. If the entry has no + padding baud rate, then whether padding is emitted or not + is completely controlled by <B>xon</B>. + + If the terminal requires other than a null (zero) charac- + ter as a pad, then this can be given as <B>pad</B>. Only the + first character of the <B>pad</B> string is used. + + + <B>Status</B> <B>Lines</B> + Some terminals have an extra `status line' which is not + normally used by software (and thus not counted in the + terminal's <B>lines</B> capability). + + The simplest case is a status line which is cursor- + addressable but not part of the main scrolling region on + the screen; the Heathkit H19 has a status line of this + kind, as would a 24-line VT100 with a 23-line scrolling + region set up on initialization. This situation is indi- + cated by the <B>hs</B> capability. + + Some terminals with status lines need special sequences to + access the status line. These may be expressed as a + string with single parameter <B>tsl</B> which takes the cursor to + a given zero-origin column on the status line. The capa- + bility <B>fsl</B> must return to the main-screen cursor positions + before the last <B>tsl</B>. You may need to embed the string + values of <B>sc</B> (save cursor) and <B>rc</B> (restore cursor) in <B>tsl</B> + and <B>fsl</B> to accomplish this. + + The status line is normally assumed to be the same width + as the width of the terminal. If this is untrue, you can + specify it with the numeric capability <B>wsl</B>. + + A command to erase or blank the status line may be speci- + fied as <B>dsl</B>. + + The boolean capability <B>eslok</B> specifies that escape + sequences, tabs, etc. work ordinarily in the status line. + + The <B>ncurses</B> implementation does not yet use any of these + capabilities. They are documented here in case they ever + become important. + + + <B>Line</B> <B>Graphics</B> + Many terminals have alternate character sets useful for + forms-drawing. Terminfo and <B>curses</B> 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 <B>acsc</B> capability. + + <B>Glyph</B> <B>ACS</B> <B>Ascii</B> <B>VT100</B> + <B>Name</B> <B>Name</B> <B>Default</B> <B>Name</B> + 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 + <B>smacs</B>/<B>rmacs</B> 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. + + + <B>Color</B> <B>Handling</B> + Most color terminals are either `Tektronix-like' or `HP- + like'. Tektronix-like terminals have a predefined set of + N colors (where N usually 8), and can set character-cell + foreground and background characters independently, mixing + them into N * N color-pairs. On HP-like terminals, the + use must set each color pair up separately (foreground and + background are not independently settable). Up to M + color-pairs may be set up from 2*M different colors. + ANSI-compatible terminals are Tektronix-like. + + Some basic color capabilities are independent of the color + method. The numeric capabilities <B>colors</B> and <B>pairs</B> specify + the maximum numbers of colors and color-pairs that can be + displayed simultaneously. The <B>op</B> (original pair) string + resets foreground and background colors to their default + values for the terminal. The <B>oc</B> 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 <B>bce</B>. + + To change the current foreground or background color on a + Tektronix-type terminal, use <B>setaf</B> (set ANSI foreground) + and <B>setab</B> (set ANSI background) or <B>setf</B> (set foreground) + and <B>setb</B> (set background). These take one parameter, the + color number. The SVr4 documentation describes only + <B>setaf</B>/<B>setab</B>; the XPG4 draft says that "If the terminal + supports ANSI escape sequences to set background and fore- + ground, they should be coded as <B>setaf</B> and <B>setab</B>, respec- + tively. If the terminal supports other escape sequences + to set background and foreground, they should be coded as + <B>setf</B> and <B>setb</B>, respectively. The <I>vidputs()</I> function and + the refresh functions use <B>setaf</B> and <B>setab</B> if they are + defined." + + The <B>setaf</B>/<B>setab</B> and <B>setf</B>/<B>setb</B> capabilities take a single + numeric argument each. Argument values 0-7 are portably + defined as follows (the middle column is the symbolic + #define available in the header for the <B>curses</B> or <B>ncurses</B> + libraries). The terminal hardware is free to map these as + it likes, but the RGB values indicate normal locations in + color space. + + <B>Color</B> <B>#define</B> <B>Value</B> <B>RGB</B> + black <B>COLOR_BLACK</B> 0 0, 0, 0 + red <B>COLOR_RED</B> 1 max,0,0 + green <B>COLOR_GREEN</B> 2 0,max,0 + yellow <B>COLOR_YELLOW</B> 3 max,max,0 + blue <B>COLOR_BLUE</B> 4 0,0,max + magenta <B>COLOR_MAGENTA</B> 5 max,0,max + cyan <B>COLOR_CYAN</B> 6 0,max,max + white <B>COLOR_WHITE</B> 7 max,max,max + + On an HP-like terminal, use <B>scp</B> with a color-pair number + parameter to set which color pair is current. + + On a Tektronix-like terminal, the capability <B>ccc</B> may be + present to indicate that colors can be modified. If so, + the <B>initc</B> capability will take a color number (0 to <B>colors</B> + - 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 <B>hls</B> + is present, they are instead as HLS (Hue, Lightness, Satu- + ration) indices. The ranges are terminal-dependent. + + On an HP-like terminal, <B>initp</B> may give a capability for + changing a color-pair value. It will take seven parame- + ters; a color-pair number (0 to <B>max_pairs</B> - 1), and two + triples describing first background and then foreground + colors. These parameters must be (Red, Green, Blue) or + (Hue, Lightness, Saturation) depending on <B>hls</B>. + + On some color terminals, colors collide with highlights. + You can register these collisions with the <B>ncv</B> capability. + This is a bit-mask of attributes not to be used when col- + ors are enabled. The correspondence with the attributes + understood by <B>curses</B> is as follows: + + <B>Attribute</B> <B>Bit</B> <B>Decimal</B> + 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 <B>ncv</B> + capability of 2. + + SVr4 curses does nothing with <B>ncv</B>, ncurses recognizes it + and optimizes the output in favor of colors. + + + <B>Miscellaneous</B> + 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 <B>PC</B> variable; + though the application may set this value to something + other than a null, ncurses will test <B>npc</B> 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 <B>hu</B> (half-line up) and <B>hd</B> (half-line + down). This is primarily useful for superscripts and + subscripts on hard-copy terminals. If a hard-copy termi- + nal can eject to the next page (form feed), give this as + <B>ff</B> (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 <B>rep</B>. 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 <B>cmdch</B>. A + prototype command character is chosen which is used in all + capabilities. This character is given in the <B>cmdch</B> capa- + bility to identify it. The following convention is sup- + ported on some UNIX systems: The environment is to be + searched for a <B>CC</B> variable, and if found, all occurrences + of the prototype character are replaced with the character + in the environment variable. + + Terminal descriptions that do not represent a specific + kind of known terminal, such as <I>switch</I>, <I>dialup</I>, <I>patch</I>, and + <I>network</I>, should include the <B>gn</B> (generic) capability so + that programs can complain that they do not know how to + talk to the terminal. (This capability does not apply to + <I>virtual</I> 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 <B>km</B>. 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 <B>smm</B> and <B>rmm</B>. + + 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 <B>lm</B>. A value of <B>lm</B>#0 indicates that the + number of lines is not fixed, but that there is still more + memory than fits on the screen. + + If the terminal is one of those supported by the UNIX vir- + tual terminal protocol, the terminal number can be given + as <B>vt</B>. + + Media copy strings which control an auxiliary printer con- + nected to the terminal can be given as <B>mc0</B>: print the con- + tents of the screen, <B>mc4</B>: turn off the printer, and <B>mc5</B>: + 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 <B>mc5p</B> takes + one parameter, and leaves the printer on for as many char- + acters as the value of the parameter, then turns the + printer off. The parameter should not exceed 255. All + text, including <B>mc4</B>, is transparently passed to the + printer while an <B>mc5p</B> is in effect. + + + <B>Glitches</B> <B>and</B> <B>Braindamage</B> + Hazeltine terminals, which do not allow `~' characters to + be displayed should indicate <B>hz</B>. + + Terminals which ignore a line-feed immediately after an <B>am</B> + wrap, such as the Concept and vt100, should indicate <B>xenl</B>. + + If <B>el</B> is required to get rid of standout (instead of + merely writing normal text on top of it), <B>xhp</B> should be + given. + + Teleray terminals, where tabs turn all characters moved + over to blanks, should indicate <B>xt</B> (destructive tabs). + Note: the variable indicating this is now + `dest_tabs_magic_smso'; in older versions, it was tel- + eray_glitch. This glitch is also taken to mean that it is + not possible to position the cursor on top of a ``magic + cookie'', that to erase standout mode it is instead neces- + sary to use delete and insert line. The ncurses implemen- + tation ignores this glitch. + + The Beehive Superbee, which is unable to correctly trans- + mit the escape or control C characters, has <B>xsb</B>, indicat- + ing that the f1 key is used for escape and f2 for control + C. (Only certain Superbees have this problem, depending + on the ROM.) Note that in older terminfo versions, this + capability was called `beehive_glitch'; it is now + `no_esc_ctl_c'. + + Other specific terminal problems may be corrected by + adding more capabilities of the form <B>x</B><I>x</I>. + + + <B>Similar</B> <B>Terminals</B> + If there are two very similar terminals, one (the variant) + can be defined as being just like the other (the base) + with certain exceptions. In the definition of the vari- + ant, the string capability <B>use</B> can be given with the name + of the base terminal. The capabilities given before <B>use</B> + override those in the base type named by <B>use</B>. If there + are multiple <B>use</B> capabilities, they are merged in reverse + order. That is, the rightmost <B>use</B> reference is processed + first, then the one to its left, and so forth. Capabili- + ties given explicitly in the entry override those brought + in by <B>use</B> references. + + A capability can be canceled by placing <B>xx@</B> to the left of + the use reference that imports it, where <I>xx</I> is the capa- + bility. For example, the entry + + 2621-nl, smkx@, rmkx@, use=2621, + + defines a 2621-nl that does not have the <B>smkx</B> or <B>rmkx</B> + 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. + + + <B>Pitfalls</B> <B>of</B> <B>Long</B> <B>Entries</B> + Long terminfo entries are unlikely to be a problem; to + date, no entry has even approached terminfo's 4K string- + table maximum. Unfortunately, the termcap translations + are much more strictly limited (to 1K), thus termcap + translations of long terminfo entries can cause problems. + + The man pages for 4.3BSD and older versions of tgetent() + instruct the user to allocate a 1K buffer for the termcap + entry. The entry gets null-terminated by the termcap + library, so that makes the maximum safe length for a term- + cap entry 1k-1 (1023) bytes. Depending on what the appli- + cation and the termcap library being used does, and where + in the termcap file the terminal type that tgetent() is + searching for is, several bad things can happen. + + Some termcap libraries print a warning message or exit if + they find an entry that's longer than 1023 bytes; others + don't; others truncate the entries to 1023 bytes. Some + application programs allocate more than the recommended 1K + for the termcap entry; others don't. + + Each termcap entry has two important sizes associated with + it: before "tc" expansion, and after "tc" expansion. "tc" + is the capability that tacks on another termcap entry to + the end of the current one, to add on its capabilities. + If a termcap entry doesn't use the "tc" capability, then + of course the two lengths are the same. + + The "before tc expansion" length is the most important + one, because it affects more than just users of that par- + ticular terminal. This is the length of the entry as it + exists in /etc/termcap, minus the backslash-newline pairs, + which tgetent() strips out while reading it. Some termcap + libraries strip off the final newline, too (GNU termcap + does not). Now suppose: + + * a termcap entry before expansion is more than 1023 + bytes long, + + * and the application has only allocated a 1k buffer, + + * and the termcap library (like the one in BSD/OS 1.1 + and GNU) reads the whole entry into the buffer, no + matter what its length, to see if it's the entry it + wants, + + * and tgetent() is searching for a terminal type that + either is the long entry, appears in the termcap file + after the long entry, or doesn't appear in the file + at all (so that tgetent() has to search the whole + termcap file). + + Then tgetent() will overwrite memory, perhaps its stack, + and probably core dump the program. Programs like telnet + are particularly vulnerable; modern telnets pass along + values like the terminal type automatically. The results + are almost as undesirable with a termcap library, like + SunOS 4.1.3 and Ultrix 4.4, that prints warning messages + when it reads an overly long termcap entry. If a termcap + library truncates long entries, like OSF/1 3.0, it is + immune to dying here but will return incorrect data for + the terminal. + + The "after tc expansion" length will have a similar effect + to the above, but only for people who actually set TERM to + that terminal type, since tgetent() only does "tc" expan- + sion once it's found the terminal type it was looking for, + not while searching. + + In summary, a termcap entry that is longer than 1023 bytes + can cause, on various combinations of termcap libraries + and applications, a core dump, warnings, or incorrect + operation. If it's too long even before "tc" expansion, + it will have this effect even for users of some other ter- + minal types and users whose TERM variable does not have a + termcap entry. + + When in -C (translate to termcap) mode, the <B>ncurses</B> imple- + mentation of <B><A HREF="tic.1.html">tic(1)</A></B> issues warning messages when the pre- + tc length of a termcap translation is too long. The -c + (check) option also checks resolved (after tc expansion) + lengths. + + <B>Binary</B> <B>Compatibility</B> + It is not wise to count on portability of binary terminfo + entries between commercial UNIX versions. The problem is + that there are at least two versions of terminfo (under + HP-UX and AIX) which diverged from System V terminfo after + SVr1, and have added extension capabilities to the string + table that (in the binary format) collide with System V + and XSI Curses extensions. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + Some SVr4 <B>curses</B> implementations, and all previous to + SVr4, don't interpret the %A and %O operators in parameter + strings. + SVr4/XPG4 do not specify whether <B>msgr</B> licenses movement + while in an alternate-character-set mode (such modes may, + among other things, map CR and NL to characters that don't + trigger local motions). The <B>ncurses</B> implementation + ignores <B>msgr</B> in <B>ALTCHARSET</B> mode. This raises the possi- + bility that an XPG4 implementation making the opposite + interpretation may need terminfo entries made for <B>ncurses</B> + to have <B>msgr</B> turned off. + + The <B>ncurses</B> library handles insert-character and insert- + character modes in a slightly non-standard way in order to + get better update efficiency. See the <B>Insert/Delete</B> <B>Char-</B> + <B>acter</B> subsection above. + + The parameter substitutions for <B>set_clock</B> and <B>dis-</B> + <B>play_clock</B> 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 <B>kmous</B> capability. The <B>ncurses</B> + wants to interpret it as <B>KEY_MOUSE</B>, for use by terminals + and emulators like xterm that can return mouse-tracking + information in the keyboard-input stream. + + Different commercial ports of terminfo and curses support + different subsets of the XSI Curses standard and (in some + cases) different extension sets. Here is a summary, accu- + rate as of October 1995: + + <B>SVR4,</B> <B>Solaris,</B> <B>ncurses</B> -- These support all SVr4 capabili- + ties. + + <B>SGI</B> -- Supports the SVr4 set, adds one undocumented + extended string capability (<B>set_pglen</B>). + + <B>SVr1,</B> <B>Ultrix</B> -- These support a restricted subset of ter- + minfo capabilities. The booleans end with <B>xon_xoff</B>; the + numerics with <B>width_status_line</B>; and the strings with + <B>prtr_non</B>. + + <B>HP/UX</B> -- Supports the SVr1 subset, plus the SVr[234] + numerics <B>num_labels</B>, <B>label_height</B>, <B>label_width</B>, plus func- + tion keys 11 through 63, plus <B>plab_norm</B>, <B>label_on</B>, and + <B>label_off</B>, plus some incompatible extensions in the string + table. + + <B>AIX</B> -- Supports the SVr1 subset, plus function keys 11 + through 63, plus a number of incompatible string table + extensions. + + <B>OSF</B> -- Supports both the SVr4 set and the AIX extensions. + + +</PRE> +<H2>FILES</H2><PRE> + /usr/share/terminfo/?/* files containing terminal + descriptions + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="tic.1m.html">tic(1m)</A></B>, <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="printf.3S.html">printf(3S)</A></B>, <B><A HREF="term.5.html">term(5)</A></B>. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. + Based on pcurses by Pavel Curtis. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/tic.1m.html b/ncurses-5.2/doc/html/man/tic.1m.html new file mode 100644 index 0000000..eddb819 --- /dev/null +++ b/ncurses-5.2/doc/html/man/tic.1m.html @@ -0,0 +1,297 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>tic</B> - the <I>terminfo</I> entry-description compiler + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>tic</B> [<B>-1CINRTVacfrsx</B>] [<B>-e</B> <I>names</I>] [<B>-o</B> <I>dir</I>] [<B>-v</B>[<I>n</I>]] [<B>-w</B>[<I>n</I>]] + <I>file</I> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The command <B>tic</B> translates a <B>terminfo</B> file from source + format into compiled format. The compiled format is nec- + essary for use with the library routines in <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>. + + The results are normally placed in the system terminfo + directory <B>/usr/share/terminfo</B>. There are two ways to + change this behavior. + + First, you may override the system default by setting the + variable <B>TERMINFO</B> in your shell environment to a valid + (existing) directory name. + + Secondly, if <B>tic</B> cannot get access to <I>/usr/share/terminfo</I> + or your TERMINFO directory, it looks for the directory + <I>$HOME/.terminfo</I>; if that directory exists, the entry is + placed there. + + Libraries that read terminfo entries are expected to check + for a TERMINFO directory first, look at <I>$HOME/.terminfo</I> if + TERMINFO is not set, and finally look in <I>/usr/share/ter-</I> + <I>minfo</I>. + + <B>-a</B> tells <B>tic</B> to retain commented-out capabilities + rather than discarding them. Capabilities are com- + mented by prefixing them with a period. This sets + the <B>-x</B> option, because it treats the commented-out + entries as user-defined names. + + <B>-c</B> tells <B>tic</B> to only check <I>file</I> for errors, including + syntax problems and bad use links. If you specify + <B>-C</B> (<B>-I</B>) 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. + + <B>-v</B><I>n</I> specifies that (verbose) output be written to stan- + dard error trace information showing <B>tic</B>'s + progress. The optional integer <I>n</I> is a number from + 1 to 10, inclusive, indicating the desired level of + detail of information. If <I>n</I> is omitted, the + default level is 1. If <I>n</I> is specified and greater + than 1, the level of detail is increased. + + <B>-o</B><I>dir</I> Write compiled entries to given directory. + Overrides the TERMINFO environment variable. + + <B>-w</B><I>n</I> specifies the width of the output. + + <B>-1</B> restricts the output to a single column + + <B>-C</B> Force source translation to termcap format. Note: + this differs from the -C option of <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B> in + that it does not merely translate capability names, + but also translates terminfo strings to termcap + format. Capabilities that are not translatable are + left in the entry under their terminfo names but + commented out with two preceding dots. + + <B>-G</B> Display constant literals in decimal form rather + than their character equivalents. + + <B>-I</B> Force source translation to terminfo format. + + <B>-L</B> Force source translation to terminfo format using + the long C variable names listed in <<B>term.h</B>> + + <B>-N</B> Disable smart defaults. Normally, when translating + from termcap to terminfo, the compiler makes a num- + ber of assumptions about the defaults of string + capabilities <B>reset1_string</B>, <B>carriage_return</B>, <B>cur-</B> + <B>sor_left</B>, <B>cursor_down</B>, <B>scroll_forward</B>, <B>tab</B>, <B>new-</B> + <B>line</B>, <B>key_backspace</B>, <B>key_left</B>, and <B>key_down</B>, then + attempts to use obsolete termcap capabilities to + deduce correct values. It also normally suppresses + output of obsolete termcap capabilities such as <B>bs</B>. + This option forces a more literal translation that + also preserves the obsolete capabilities. + + <B>-R</B><I>subset</I> + 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 don't support + the full set of SVR4/XSI Curses terminfo; and out- + right broken ports like AIX 3.x that have their own + extensions incompatible with SVr4/XSI. Available + subsets are "SVr1", "Ultrix", "HP", "BSD" and + "AIX"; see <B><A HREF="terminfo.5.html">terminfo(5)</A></B> for details. + + <B>-T</B> eliminates size-restrictions on the generated text. + This is mainly useful for testing and analysis, + since the compiled descriptions are limited (e.g., + 1023 for termcap, 4096 for terminfo). + + <B>-V</B> reports the version of ncurses which was used in + this program, and exits. + + <B>-r</B> 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 up to version 1.3 or BSD term- + cap up to 4.3BSD) that doesn't handle multiple tc + capabilities per entry. + + <B>-e</B> Limit writes and translations to the following + comma-separated list of terminals. If any name or + alias of a terminal matches one of the names in the + list, the entry will be written or translated as + normal. Otherwise no output will be generated for + it. The option value is interpreted as a file con- + taining the list if it contains a '/'. (Note: + depending on how tic was compiled, this option may + require -I or -C.) + + <B>-f</B> Display complex terminfo strings which contain + if/then/else/endif expressions indented for read- + ability. + + <B>-g</B> Display constant character literals in quoted form + rather than their decimal equivalents. + + <B>-s</B> Summarize the compile by showing the directory into + which entries are written, and the number of + entries which are compiled. + + <B>-x</B> Treat unknown capabilities as user-defined. That + is, if you supply a capability name which <B>tic</B> does + not recognize, it will infer its type (boolean, + number or string) from the syntax and make an + extended table entry for that. + + <I>file</I> contains one or more <B>terminfo</B> terminal descriptions + in source format [see <B><A HREF="terminfo.5.html">terminfo(5)</A></B>]. Each descrip- + tion in the file describes the capabilities of a + particular terminal. + + The debug flag levels are as follows: + + 1 Names of files created and linked + + 2 Information related to the ``use'' facility + + 3 Statistics from the hashing algorithm + + 5 String-table memory allocations + + 7 Entries into the string-table + + 8 List of tokens encountered by scanner + + 9 All values computed in construction of the hash + table + + If n is not given, it is taken to be one. + + All but one of the capabilities recognized by <B>tic</B> are doc- + umented in <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. The exception is the <B>use</B> capabil- + ity. + + When a <B>use</B>=<I>entry</I>-<I>name</I> field is discovered in a terminal + entry currently being compiled, <B>tic</B> reads in the binary + from <B>/usr/share/terminfo</B> to complete the entry. (Entries + created from <I>file</I> will be used first. If the environment + variable <B>TERMINFO</B> is set, that directory is searched + instead of <B>/usr/share/terminfo</B>.) <B>tic</B> duplicates the capa- + bilities in <I>entry</I>-<I>name</I> for the current entry, with the + exception of those capabilities that explicitly are + defined in the current entry. + + When an entry, e.g., <B>entry_name_1</B>, contains a + <B>use=</B><I>entry</I>_<I>name</I>_<I>2</I> field, any canceled capabilities in + <I>entry</I>_<I>name</I>_<I>2</I> must also appear in <B>entry_name_1</B> before <B>use=</B> + for these capabilities to be canceled in <B>entry_name_1</B>. + + If the environment variable <B>TERMINFO</B> is set, the compiled + results are placed there instead of <B>/usr/share/terminfo</B>. + + Total compiled entries cannot exceed 4096 bytes. The name + field cannot exceed 512 bytes. Terminal names exceeding + the maximum alias length (32 characters on systems with + long filenames, 14 characters otherwise) will be truncated + to the maximum alias length and a warning message will be + printed. + + +</PRE> +<H2>COMPATIBILITY</H2><PRE> + There is some evidence that historic <B>tic</B> implementations + treated description fields with no whitespace in them as + additional aliases or short names. This <B>tic</B> does not do + that, but it does warn when description fields may be + treated that way and check them for dangerous characters. + + +</PRE> +<H2>EXTENSIONS</H2><PRE> + Unlike the stock SVr4 <B>tic</B> 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 <B><A HREF="terminfo.5.html">terminfo(5)</A></B> 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 <B>use</B> capabilities. This implementation of <B>tic</B> + will find <B>use</B> targets anywhere in the source file, or any- + where in the file tree rooted at <B>TERMINFO</B> (if <B>TERMINFO</B> is + defined), or in the user's <I>$HOME/.terminfo</I> directory (if + it exists), or (finally) anywhere in the system's file + tree of compiled entries. + + The error messages from this <B>tic</B> have the same format as + GNU C error messages, and can be parsed by GNU Emacs's + compile facility. + + The <B>-C</B>, <B>-G</B>, <B>-I</B>, <B>-N</B>, <B>-R</B>, <B>-T</B>, <B>-V</B>, <B>-a</B>, <B>-e</B>, <B>-f</B>, <B>-g</B>, <B>-o</B>, <B>-r</B>, <B>-s</B> + and <B>-x</B> options are not supported under SVr4. The SVr4 -c + mode does not report bad use links. + + System V does not compile entries to or read entries from + your <I>$HOME/.terminfo</I> directory unless TERMINFO is explic- + itly set to it. + + +</PRE> +<H2>FILES</H2><PRE> + <B>/usr/share/terminfo/?/*</B> + Compiled terminal description database. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B>, <B><A HREF="captoinfo.1m.html">captoinfo(1m)</A></B>, <B><A HREF="infotocap.1m.html">infotocap(1m)</A></B>, <B><A HREF="toe.1m.html">toe(1m)</A></B>, + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/toe.1m.html b/ncurses-5.2/doc/html/man/toe.1m.html new file mode 100644 index 0000000..887a9c4 --- /dev/null +++ b/ncurses-5.2/doc/html/man/toe.1m.html @@ -0,0 +1,76 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>toe</B> - table of (terminfo) entries + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>toe</B> [<B>-v</B>[<I>n</I>]] [<B>-huUV</B>] <I>file...</I> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + With no options, <B>toe</B> lists all available terminal types by + primary name with descriptions. File arguments specify + the directories to be scanned; if no such arguments are + given, your default terminfo directory is scanned. If you + also specify the -h option, a directory header will be + issued as each directory is entered. + + There are other options intended for use by terminfo file + maintainers: + + <B>-u</B> <I>file</I> + says to issue a report on dependencies in the given + file. This report condenses the `use' relation: + each line consists of the primary name of a termi- + nal that has use capabilities, followed by a colon, + followed by the whitespace-separated primary names + of all terminals which occur in those use capabili- + ties, followed by a newline + + <B>-U</B> <I>file</I> + says to issue a report on reverse dependencies in + the given file. This report reverses the `use' + relation: each line consists of the primary name of + a terminal that occurs in use capabilities, fol- + lowed by a colon, followed by the whitespace-sepa- + rated primary names of all terminals which depend + on it, followed by a newline. + + <B>-v</B><I>n</I> specifies that (verbose) output be written to stan- + dard error trace information showing <B>toe</B>'s + progress. The optional integer <I>n</I> is a number from + 1 to 10, interpreted as for <B><A HREF="tic.1.html">tic(1)</A></B>. + + <B>-V</B> reports the version of ncurses which was used in this + program, and exits. + + +</PRE> +<H2>FILES</H2><PRE> + <B>/usr/share/terminfo/?/*</B> + Compiled terminal description database. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="tic.1m.html">tic(1m)</A></B>, <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B>, <B><A HREF="captoinfo.1m.html">captoinfo(1m)</A></B>, <B><A HREF="infotocap.1m.html">infotocap(1m)</A></B>, + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/tput.1.html b/ncurses-5.2/doc/html/man/tput.1.html new file mode 100644 index 0000000..17c55aa --- /dev/null +++ b/ncurses-5.2/doc/html/man/tput.1.html @@ -0,0 +1,246 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>tput</B>, <B>reset</B> - initialize a terminal or query terminfo + database + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>tput</B> [<B>-T</B><I>type</I>] <I>capname</I> [<I>parms</I> ... ] + <B>tput</B> [<B>-T</B><I>type</I>] <B>init</B> + <B>tput</B> [<B>-T</B><I>type</I>] <B>reset</B> + <B>tput</B> [<B>-T</B><I>type</I>] <B>longname</B> + <B>tput</B> <B>-S</B> <B><<</B> + <B>tput</B> <B>-V</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>tput</B> utility uses the <B>terminfo</B> database to make the + values of terminal-dependent capabilities and information + available to the shell (see <B><A HREF="sh.1.html">sh(1)</A></B>), to initialize or reset + the terminal, or return the long name of the requested + terminal type. <B>tput</B> outputs a string if the attribute + (<I>cap</I>ability <I>name</I>) is of type string, or an integer if the + attribute is of type integer. If the attribute is of type + boolean, <B>tput</B> simply sets the exit code (<B>0</B> for TRUE if the + terminal has the capability, <B>1</B> for FALSE if it does not), + and produces no output. Before using a value returned on + standard output, the user should test the exit code [<B>$?</B>, + see <B><A HREF="sh.1.html">sh(1)</A></B>] to be sure it is <B>0</B>. (See the <B>EXIT</B> <B>CODES</B> and + <B>DIAGNOSTICS</B> sections.) For a complete list of capabili- + ties and the <I>capname</I> associated with each, see <B>ter-</B> + <B><A HREF="minfo.5.html">minfo(5)</A></B>. + + <B>-T</B><I>type</I> indicates the <I>type</I> of terminal. Normally this + option is unnecessary, because the default is taken + from the environment variable <B>TERM</B>. If <B>-T</B> is spec- + ified, then the shell variables <B>LINES</B> and <B>COLUMNS</B> + will be ignored,and the operating system will not + be queried for the actual screen size. + + <I>capname</I> + indicates the attribute from the <B>terminfo</B> database. + When <B>termcap</B> support is compiled in, the <B>termcap</B> + name for the attribute is also accepted. + + <I>parms</I> If the attribute is a string that takes parameters, + the arguments <I>parms</I> will be instantiated into the + string. An all numeric argument will be passed to + the attribute as a number. + + <B>-S</B> allows more than one capability per invocation of + <B>tput</B>. The capabilities must be passed to <B>tput</B> from + the standard input instead of from the command line + (see example). Only one <I>capname</I> is allowed per + line. The <B>-S</B> option changes the meaning of the <B>0</B> + and <B>1</B> boolean and string exit codes (see the EXIT + CODES section). + + <B>-V</B> reports the version of ncurses which was used in + this program, and exits. + + <B>init</B> If the <B>terminfo</B> database is present and an entry + for the user's terminal exists (see <B>-T</B><I>type</I>, above), + the following will occur: (1) if present, the ter- + minal's initialization strings will be output (<B>is1</B>, + <B>is2</B>, <B>is3</B>, <B>if</B>, <B>iprog</B>), (2) any delays (e.g., new- + line) specified in the entry will be set in the tty + driver, (3) tabs expansion will be turned on or off + according to the specification in the entry, and + (4) if tabs are not expanded, standard tabs will be + set (every 8 spaces). If an entry does not contain + the information needed for any of the four above + activities, that activity will silently be skipped. + + <B>reset</B> Instead of putting out initialization strings, the + terminal's reset strings will be output if present + (<B>rs1</B>, <B>rs2</B>, <B>rs3</B>, <B>rf</B>). If the reset strings are not + present, but initialization strings are, the ini- + tialization strings will be output. Otherwise, + <B>reset</B> acts identically to <B>init</B>. + + <B>longname</B> + If the <B>terminfo</B> database is present and an entry + for the user's terminal exists (see <B>-T</B><I>type</I> 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 <B>terminfo</B> database + [see <B><A HREF="term.5.html">term(5)</A></B>]. + + If <B>tput</B> is invoked by a link named <B>reset</B>, this has the + same effect as <B>tput</B> <B>reset</B>. See <B>tset</B> for comparison, which + has similar behavior. + + +</PRE> +<H2>EXAMPLES</H2><PRE> + <B>tput</B> <B>init</B> + Initialize the terminal according to the type of ter- + minal in the environmental variable <B>TERM</B>. This com- + mand should be included in everyone's .profile after + the environmental variable <B>TERM</B> has been exported, as + illustrated on the <B><A HREF="profile.4.html">profile(4)</A></B> manual page. + + <B>tput</B> <B>-T5620</B> <B>reset</B> + Reset an AT&T 5620 terminal, overriding the type of + terminal in the environmental variable <B>TERM</B>. + + <B>tput</B> <B>cup</B> <B>0</B> <B>0</B> + Send the sequence to move the cursor to row <B>0</B>, column + <B>0</B> (the upper left corner of the screen, usually known + as the "home" cursor position). + + <B>tput</B> <B>clear</B> + Echo the clear-screen sequence for the current + terminal. + + <B>tput</B> <B>cols</B> + Print the number of columns for the current terminal. + + <B>tput</B> <B>-T450</B> <B>cols</B> + Print the number of columns for the 450 terminal. + + <B>bold=`tput</B> <B>smso`</B> <B>offbold=`tput</B> <B>rmso`</B> + Set the shell variables <B>bold</B>, to begin stand-out mode + sequence, and <B>offbold</B>, to end standout mode sequence, + for the current terminal. This might be followed by + a prompt: <B>echo</B> <B>"${bold}Please</B> <B>type</B> <B>in</B> <B>your</B> <B>name:</B> + <B>${offbold}\c"</B> + + <B>tput</B> <B>hc</B> + Set exit code to indicate if the current terminal is + a hard copy terminal. + + <B>tput</B> <B>cup</B> <B>23</B> <B>4</B> + Send the sequence to move the cursor to row 23, col- + umn 4. + + <B>tput</B> <B>longname</B> + Print the long name from the <B>terminfo</B> database for + the type of terminal specified in the environmental + variable <B>TERM</B>. + + <B>tput</B> <B>-S</B> <B><<!</B> + <B>></B> <B>clear</B> + <B>></B> <B>cup</B> <B>10</B> <B>10</B> + <B>></B> <B>bold</B> + <B>></B> <B>!</B> + + This example shows tput processing several capabili- + ties in one invocation. This example clears the + screen, moves the cursor to position 10, 10 and turns + on bold (extra bright) mode. The list is terminated + by an exclamation mark (<B>!</B>) on a line by itself. + + +</PRE> +<H2>FILES</H2><PRE> + <B>/usr/share/terminfo</B> + compiled terminal description database + + <B>/usr/include/curses.h</B> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> header file + + <B>/usr/include/term.h</B> + <B>terminfo</B> header file + + <B>/usr/share/tabset/*</B> + tab settings for some terminals, in a format appro- + priate to be output to the terminal (escape + sequences that set margins and tabs); for more + information, see the "Tabs and Initialization" sec- + tion of <B><A HREF="terminfo.4.html">terminfo(4)</A></B> + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="clear.1.html">clear(1)</A></B>, <B><A HREF="stty.1.html">stty(1)</A></B>, <B><A HREF="tabs.5.html">tabs(5)</A></B>. <B><A HREF="profile.5.html">profile(5)</A></B>, <B><A HREF="terminfo.4.html">terminfo(4)</A></B> in + the <I>System</I> <I>Administrator</I>'<I>s</I> <I>Reference</I> <I>Manual</I>. Chapter 10 + of the <I>Programmer</I>'<I>s</I> <I>Guide</I>. + + +</PRE> +<H2>EXIT CODES</H2><PRE> + If <I>capname</I> is of type boolean, a value of <B>0</B> is set for + TRUE and <B>1</B> for FALSE unless the <B>-S</B> option is used. + + If <I>capname</I> is of type string, a value of <B>0</B> is set if the + <I>capname</I> is defined for this terminal <I>type</I> (the value of + <I>capname</I> is returned on standard output); a value of <B>1</B> is + set if <I>capname</I> is not defined for this terminal <I>type</I> (a + null value is returned on standard output). + + If <I>capname</I> is of type boolean or string and the <B>-S</B> option + is used, a value of <B>0</B> is returned to indicate that all + lines were successful. No indication of which line failed + can be given so exit code <B>1</B> will never appear. Exit codes + <B>2</B>, <B>3</B>, and <B>4</B> retain their usual interpretation. + + If <I>capname</I> is of type integer, a value of <B>0</B> is always set, + whether or not <I>capname</I> is defined for this terminal <I>type</I>. + To determine if <I>capname</I> is defined for this terminal <I>type</I>, + the user must test the value of standard output. A value + of <B>-1</B> means that <I>capname</I> is not defined for this terminal + <I>type</I>. + + Any other exit code indicates an error; see the DIAGNOS- + TICS section. + + +</PRE> +<H2>DIAGNOSTICS</H2><PRE> + <B>tput</B> prints the following error messages and sets the cor- + responding exit codes. + + exit code error message + --------------------------------------------------------------------- + <B>0</B> (<I>capname</I> is a numeric variable that is not specified in + the <B><A HREF="terminfo.5.html">terminfo(5)</A></B> database for this terminal type, e.g. + <B>tput</B> <B>-T450</B> <B>lines</B> and <B>tput</B> <B>-T2621</B> <B>xmc</B>) + <B>1</B> no error message is printed, see the <B>EXIT</B> <B>CODES</B> section. + <B>2</B> usage error + <B>3</B> unknown terminal <I>type</I> or no <B>terminfo</B> database + <B>4</B> unknown <B>terminfo</B> capability <I>capname</I> + --------------------------------------------------------------------- + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The <B>longname</B> and <B>-S</B> options, and the parameter-substitu- + tion features used in the <B>cup</B> example, are not supported + in BSD curses or in AT&T/USL curses before SVr4. + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/tset.1.html b/ncurses-5.2/doc/html/man/tset.1.html new file mode 100644 index 0000000..635ddd5 --- /dev/null +++ b/ncurses-5.2/doc/html/man/tset.1.html @@ -0,0 +1,303 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>tset</B>, <B>reset</B> - terminal initialization + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + tset [-IQVqrs] [-] [-e <I>ch</I>] [-i <I>ch</I>] [-k <I>ch</I>] [-m <I>mapping</I>] + [<I>terminal</I>] + reset [-IQVqrs] [-] [-e <I>ch</I>] [-i <I>ch</I>] [-k <I>ch</I>] [-m <I>mapping</I>] + [<I>terminal</I>] + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>Tset</B> initializes terminals. <B>Tset</B> first determines the + type of terminal that you are using. This determination + is done as follows, using the first terminal type found. + + 1. The <B>terminal</B> argument specified on the command line. + + 2. The value of the <B>TERM</B> environmental variable. + + 3. (BSD systems only.) The terminal type associated with + the standard error output device in the <I>/etc/ttys</I> file. + (On Linux and System-V-like UNIXes, <I>getty</I> does this job by + setting <B>TERM</B> according to the type passed to it by + <I>/etc/inittab</I>.) + + 4. The default terminal type, ``unknown''. + + If the terminal type was not specified on the command- + line, the -m option mappings are then applied (see below + for more information). Then, if the terminal type begins + with a question mark (``?''), the user is prompted for + confirmation of the terminal type. An empty response con- + firms the type, or, another type can be entered to specify + a new type. Once the terminal type has been determined, + the terminfo entry for the terminal is retrieved. If no + terminfo entry is found for the type, the user is prompted + for another terminal type. + + Once the terminfo entry is retrieved, the window size, + backspace, interrupt and line kill characters (among many + other things) are set and the terminal and tab initializa- + tion strings are sent to the standard error output. + Finally, if the erase, interrupt and line kill characters + have changed, or are not set to their default values, + their values are displayed to the standard error output. + + When invoked as <B>reset</B>, <B>tset</B> sets cooked and echo modes, + turns off cbreak and raw modes, turns on newline transla- + tion and resets any unset special characters to their + default values before doing the terminal initialization + described above. This is useful after a program dies + leaving a terminal in an abnormal state. Note, you may + have to type + + <B><LF>reset<LF></B> + + (the line-feed character is normally control-J) to get the + terminal to work, as carriage-return may no longer work in + the abnormal state. Also, the terminal will often not + echo the command. + + The options are as follows: + + -q 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. + + -e Set the erase character to <I>ch</I>. + + -I Do not send the terminal or tab initialization + strings to the terminal. + + -Q Don't display any values for the erase, interrupt and + line kill characters. + + <B>-V</B> reports the version of ncurses which was used in this + program, and exits. + + -i Set the interrupt character to <I>ch</I>. + + -k Set the line kill character to <I>ch</I>. + + -m Specify a mapping from a port type to a terminal. + See below for more information. + + -r Print the terminal type to the standard error output. + + -s Print the sequence of shell commands to initialize + the environment variable <B>TERM</B> to the standard output. + See the section below on setting the environment for + details. + + The arguments for the -e, -i, and -k options may either be + entered as actual characters or by using the `hat' nota- + tion, i.e. control-h may be specified as ``^H'' or ``^h''. + + +</PRE> +<H2>SETTING THE ENVIRONMENT</H2><PRE> + It is often desirable to enter the terminal type and + information about the terminal's capabilities into the + shell's environment. This is done using the -s option. + + When the -s option is specified, the commands to enter the + information into the shell's environment are written to + the standard output. If the <B>SHELL</B> environmental variable + ends in ``csh'', the commands are for <B>csh</B>, otherwise, they + are for <B>sh</B>. Note, the <B>csh</B> commands set and unset the + shell variable <B>noglob</B>, leaving it unset. The following + line in the <B>.login</B> or <B>.profile</B> files will initialize the + environment correctly: + + eval `tset -s options ... ` + + + +</PRE> +<H2>TERMINAL TYPE MAPPING</H2><PRE> + When the terminal is not hardwired into the system (or the + current system information is incorrect) the terminal type + derived from the <I>/etc/ttys</I> file or the <B>TERM</B> environmental + variable is often something generic like <B>network</B>, <B>dialup</B>, + or <B>unknown</B>. When <B>tset</B> is used in a startup script it is + often desirable to provide information about the type of + terminal used on such ports. + + The purpose of the -m option is to map from some set of + conditions to a terminal type, that is, to tell <B>tset</B> ``If + I'm on this port at a particular speed, guess that I'm on + that kind of terminal''. + + The argument to the -m option consists of an optional port + type, an optional operator, an optional baud rate specifi- + cation, an optional colon (``:'') character and a terminal + type. The port type is a string (delimited by either the + operator or the colon character). The operator may be any + combination of ``>'', ``<'', ``@'', and ``!''; ``>'' means + greater than, ``<'' means less than, ``@'' means equal to + and ``!'' inverts the sense of the test. The baud rate is + specified as a number and is compared with the speed of + the standard error output (which should be the control + terminal). The terminal type is a string. + + If the terminal type is not specified on the command line, + the -m mappings are applied to the terminal type. If the + port type and baud rate match the mapping, the terminal + type specified in the mapping replaces the current type. + If more than one mapping is specified, the first applica- + ble mapping is used. + + For example, consider the following mapping: + <B>dialup>9600:vt100</B>. The port type is dialup , the operator + is >, the baud rate specification is 9600, and the termi- + nal type is vt100. The result of this mapping is to spec- + ify that if the terminal type is <B>dialup</B>, and the baud rate + is greater than 9600 baud, a terminal type of <B>vt100</B> will + be used. + + If no baud rate is specified, the terminal type will match + any baud rate. If no port type is specified, the terminal + type will match any port type. For example, <B>-m</B> + <B>dialup:vt100</B> <B>-m</B> <B>:?xterm</B> will cause any dialup port, + regardless of baud rate, to match the terminal type vt100, + and any non-dialup port type to match the terminal type + ?xterm. Note, because of the leading question mark, the + user will be queried on a default port as to whether they + are actually using an xterm terminal. + + No whitespace characters are permitted in the -m option + argument. Also, to avoid problems with meta-characters, + it is suggested that the entire -m option argument be + placed within single quote characters, and that <B>csh</B> users + insert a backslash character (``\'') before any exclama- + tion marks (``!''). + + +</PRE> +<H2>HISTORY</H2><PRE> + The <B>tset</B> command appeared in BSD 3.0. The <B>ncurses</B> imple- + mentation was lightly adapted from the 4.4BSD sources for + a terminfo environment by Eric S. Raymond <esr@snark.thyr- + sus.com>. + + +</PRE> +<H2>COMPATIBILITY</H2><PRE> + The <B>tset</B> utility has been provided for backward-compati- + bility with BSD environments (under most modern UNIXes, + <B>/etc/inittab</B> and <B><A HREF="getty.1.html">getty(1)</A></B> can set <B>TERM</B> appropriately for + each dial-up line; this obviates what was <B>tset</B>'s most + important use). This implementation behaves like 4.4BSD + tset, with a few exceptions specified here. + + The -S option of BSD tset no longer works; it prints an + error message to stderr and dies. The -s option only sets + <B>TERM</B>, not <B>TERMCAP</B>. Both these changes are because the + <B>TERMCAP</B> variable is no longer supported under terminfo- + based <B>ncurses</B>, which makes <B>tset</B> <B>-S</B> useless (we made it die + noisily rather than silently induce lossage). + + There was an undocumented 4.4BSD feature that invoking + tset via a link named `TSET` (or via any other name begin- + ning with an upper-case letter) set the terminal to use + upper-case only. This feature has been omitted. + + The -A, -E, -h, -u and -v options were deleted from the + <B>tset</B> utility in 4.4BSD. None of them were documented in + 4.3BSD and all are of limited utility at best. The -a, -d, + and -p options are similarly not documented or useful, but + were retained as they appear to be in widespread use. It + is strongly recommended that any usage of these three + options be changed to use the -m option instead. The -n + option remains, but has no effect. The -adnp options are + therefore omitted from the usage summary above. + + It is still permissible to specify the -e, -i, and -k + options without arguments, although it is strongly recom- + mended that such usage be fixed to explicitly specify the + character. + + As of 4.4BSD, executing <B>tset</B> as <B>reset</B> no longer implies + the -Q option. Also, the interaction between the - option + and the <I>terminal</I> argument in some historic implementations + of <B>tset</B> has been removed. + + + +</PRE> +<H2>ENVIRONMENT</H2><PRE> + The <B>tset</B> command uses the <B>SHELL</B> and <B>TERM</B> environment vari- + ables. + + +</PRE> +<H2>FILES</H2><PRE> + /etc/ttys + system port name to terminal type mapping database + (BSD versions only). + + /usr/share/terminfo + terminal capability database + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="csh.1.html">csh(1)</A></B>, <B><A HREF="sh.1.html">sh(1)</A></B>, <B><A HREF="stty.1.html">stty(1)</A></B>, <B><A HREF="tty.4.html">tty(4)</A></B>, <B><A HREF="termcap.5.html">termcap(5)</A></B>, <B><A HREF="ttys.5.html">ttys(5)</A></B>, envi- + <B><A HREF="ron.7.html">ron(7)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/ncurses-5.2/doc/html/man/wresize.3x.html b/ncurses-5.2/doc/html/man/wresize.3x.html new file mode 100644 index 0000000..d2e2650 --- /dev/null +++ b/ncurses-5.2/doc/html/man/wresize.3x.html @@ -0,0 +1,80 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>wresize</B> - resize a curses window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>wresize(WINDOW</B> <B>*win,</B> <B>int</B> <B>lines,</B> <B>int</B> <B>columns);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>wresize</B> function reallocates storage for an <B>ncurses</B> + window to adjust its dimensions to the specified values. + If either dimension is larger than the current values, the + window's data is filled with blanks that have the current + background rendition (as set by <B>wbkgndset</B>) merged into + them. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + The function returns the integer <B>ERR</B> upon failure and <B>OK</B> + on success. It will fail if either of the dimensions less + than or equal to zero, or if an error occurs while + (re)allocating memory for the window. + + +</PRE> +<H2>NOTES</H2><PRE> + The only restriction placed on the dimensions is that they + be greater than zero. The dimensions are not compared to + <B>curses</B> screen dimensions to simplify the logic of + <B>resizeterm</B>. The caller must ensure that the window's + dimensions fit within the actual screen dimensions. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="resizeterm.3x.html">resizeterm(3x)</A></B>. + + +</PRE> +<H2>AUTHOR</H2><PRE> + Thomas Dickey (from an equivalent function written in 1988 + for BSD curses). + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |