]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_variables.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / curs_variables.3x.html
diff --git a/doc/html/man/curs_variables.3x.html b/doc/html/man/curs_variables.3x.html
index 3cca3feef6a590b7a0b59c773311af9cb957073b..42ce0b28e0be21bfda770f8bc778ff5b7dbd0c90 100644 (file)
--- a/doc/html/man/curs_variables.3x.html
+++ b/doc/html/man/curs_variables.3x.html
@@ -1,7 +1,6 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2010 Free Software Foundation, Inc.                        *
+  * Copyright (c) 2010-2013,2015 Free Software Foundation, Inc.              *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -27,32 +26,31 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_variables.3x,v 1.4 2010/12/04 18:38:55 tom Exp @
+  * @Id: curs_variables.3x,v 1.8 2015/08/22 23:33:22 tom Exp @
 -->
 -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <HTML>
 <HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>curs_variables 3x</TITLE>
 <link rev=made href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
 <TITLE>curs_variables 3x</TITLE>
 <link rev=made href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1>curs_variables 3x</H1>
-<HR>
+<H1 class="no-header">curs_variables 3x</H1>
 <PRE>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
 <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>                                   <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 
 
 
 
 <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>                                   <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 
 
 
 
-</PRE>
-<H2>NAME</H2><PRE>
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
        <STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>,
        <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables
 
 
        <STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>,
        <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables
 
 
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
        <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
        <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
@@ -66,19 +64,19 @@
        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
 
 
        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
 
 
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        This page summarizes variables provided by the <STRONG>curses</STRONG>  li-
        brary.   A more complete description is given in the <STRONG>curs-</STRONG>
        <STRONG><A HREF="ncurses.3x.html">es(3x)</A></STRONG> manual page.
 
        Depending on the configuration, these may be actual  vari-
        This page summarizes variables provided by the <STRONG>curses</STRONG>  li-
        brary.   A more complete description is given in the <STRONG>curs-</STRONG>
        <STRONG><A HREF="ncurses.3x.html">es(3x)</A></STRONG> manual page.
 
        Depending on the configuration, these may be actual  vari-
-       ables,  or  macros  (see  <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>)  which provide
-       read-only access to <EM>curses</EM>'s state.  In either  case,  ap-
-       plications should treat them as read-only to avoid confus-
-       ing the library.
+       ables,     or    macros    (see    <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>    and
+       <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>) which provide read-only access  to  <EM>curs-</EM>
+       <EM>es</EM>'s  state.   In  either  case, applications should treat
+       them as read-only to avoid confusing the library.
 
 
-   <STRONG>COLOR_PAIRS</STRONG>
+
+</PRE><H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
        After initializing curses, this variable contains the num-
        ber of color pairs which the terminal can support.  Usual-
        ly the number of color pairs  will  be  the  product  <STRONG>COL-</STRONG>
        After initializing curses, this variable contains the num-
        ber of color pairs which the terminal can support.  Usual-
        ly the number of color pairs  will  be  the  product  <STRONG>COL-</STRONG>
@@ -91,74 +89,111 @@
            ited  by  the number of color pairs that can be repre-
            sented in a <EM>signed</EM> <EM>short</EM> value.
 
            ited  by  the number of color pairs that can be repre-
            sented in a <EM>signed</EM> <EM>short</EM> value.
 
-   <STRONG>COLORS</STRONG>
+
+</PRE><H3><a name="h3-COLORS">COLORS</a></H3><PRE>
        After initializing curses, this variable contains the num-
        ber of colors which the terminal can support.
 
        After initializing curses, this variable contains the num-
        ber of colors which the terminal can support.
 
-   <STRONG>COLS</STRONG>
+
+</PRE><H3><a name="h3-COLS">COLS</a></H3><PRE>
        After  initializing  curses,  this  variable  contains the
        width of the screen, i.e., the number of columns.
 
        After  initializing  curses,  this  variable  contains the
        width of the screen, i.e., the number of columns.
 
-   <STRONG>ESCDELAY</STRONG>
+
+</PRE><H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
        This variable holds the number of milliseconds to wait af-
        ter reading an escape character, to distinguish between an
        individual escape character entered on the  keyboard  from
        escape  sequences  sent  by cursor- and function-keys (see
        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 
        This variable holds the number of milliseconds to wait af-
        ter reading an escape character, to distinguish between an
        individual escape character entered on the  keyboard  from
        escape  sequences  sent  by cursor- and function-keys (see
        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 
-   <STRONG>LINES</STRONG>
+
+</PRE><H3><a name="h3-LINES">LINES</a></H3><PRE>
        After initializing  curses,  this  variable  contains  the
        height of the screen, i.e., the number of lines.
 
        After initializing  curses,  this  variable  contains  the
        height of the screen, i.e., the number of lines.
 
-   <STRONG>TABSIZE</STRONG>
+
+</PRE><H3><a name="h3-TABSIZE">TABSIZE</a></H3><PRE>
        This  variable  holds  the  number  of columns used by the
        <EM>curses</EM> library when converting a tab character  to  spaces
        as it adds the tab to a window (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
 
        This  variable  holds  the  number  of columns used by the
        <EM>curses</EM> library when converting a tab character  to  spaces
        as it adds the tab to a window (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
 
-   <STRONG>The</STRONG> <STRONG>Current</STRONG> <STRONG>Screen</STRONG>
+
+</PRE><H3><a name="h3-The-Current-Screen">The Current Screen</a></H3><PRE>
        This implementation of curses uses a special window <STRONG>curscr</STRONG>
        to record its updates to the terminal screen.
 
        This implementation of curses uses a special window <STRONG>curscr</STRONG>
        to record its updates to the terminal screen.
 
-   <STRONG>The</STRONG> <STRONG>New</STRONG> <STRONG>Screen</STRONG>
+
+</PRE><H3><a name="h3-The-New-Screen">The New Screen</a></H3><PRE>
        This implementation of curses uses a special window <STRONG>newscr</STRONG>
        to  hold  updates  to  the terminal screen before applying
        them to <STRONG>curscr</STRONG>.
 
        This implementation of curses uses a special window <STRONG>newscr</STRONG>
        to  hold  updates  to  the terminal screen before applying
        them to <STRONG>curscr</STRONG>.
 
-   <STRONG>The</STRONG> <STRONG>Standard</STRONG> <STRONG>Screen</STRONG>
+
+</PRE><H3><a name="h3-The-Standard-Screen">The Standard Screen</a></H3><PRE>
        Upon initializing curses, a default window called  <STRONG>stdscr</STRONG>,
        which  is  the  size  of  the terminal screen, is created.
        Many curses functions use this window.
 
 
        Upon initializing curses, a default window called  <STRONG>stdscr</STRONG>,
        which  is  the  size  of  the terminal screen, is created.
        Many curses functions use this window.
 
 
-</PRE>
-<H2>NOTES</H2><PRE>
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        The   curses   library   is   initialized   using   either
        The   curses   library   is   initialized   using   either
-       <STRONG><A HREF="initscr.3x.html">initscr(3x)</A></STRONG>, or <STRONG><A HREF="newterm.3x.html">newterm(3x)</A></STRONG>.
+       <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, or <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>.
 
        If  <STRONG>curses</STRONG>  is  configured to use separate curses/terminfo
        libraries, most of these variables reside  in  the  curses
        library.
 
 
 
        If  <STRONG>curses</STRONG>  is  configured to use separate curses/terminfo
        libraries, most of these variables reside  in  the  curses
        library.
 
 
-</PRE>
-<H2>PORTABILITY</H2><PRE>
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        ESCDELAY  and TABSIZE are extensions, not provided in most
        other implementations of curses.
 
        ESCDELAY  and TABSIZE are extensions, not provided in most
        other implementations of curses.
 
+       ESCDELAY is an extension in AIX curses:
 
 
-</PRE>
-<H2>SEE ALSO</H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>,  <STRONG>termin-</STRONG>
-       <STRONG><A HREF="terminfo.3x.html">fo(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
+       <STRONG>o</STRONG>   In AIX, the units for ESCDELAY are <EM>fifths</EM>  of  a  mil-
+           lisecond.
+
+       <STRONG>o</STRONG>   The default value for AIX's ESCDELAY is 0.1 seconds.
+
+       <STRONG>o</STRONG>   AIX also enforces a limit of 10,000 seconds for ESCDE-
+           LAY; this implementation currently has no upper limit.
+
+       This implementation has long used ESCDELAY with  units  of
+       milliseconds,  making  it impossible to be completely com-
+       patible with AIX.  Likewise, most users have either decid-
+       ed to override the value, or rely upon its default value.
+
+
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,       <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>,      <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>,
+       <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 
 
 
                                                      <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 </PRE>
 
 
 
                                                      <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-COLOR_PAIRS">COLOR_PAIRS</a></li>
+<li><a href="#h3-COLORS">COLORS</a></li>
+<li><a href="#h3-COLS">COLS</a></li>
+<li><a href="#h3-ESCDELAY">ESCDELAY</a></li>
+<li><a href="#h3-LINES">LINES</a></li>
+<li><a href="#h3-TABSIZE">TABSIZE</a></li>
+<li><a href="#h3-The-Current-Screen">The Current Screen</a></li>
+<li><a href="#h3-The-New-Screen">The New Screen</a></li>
+<li><a href="#h3-The-Standard-Screen">The Standard Screen</a></li>
+</ul>
+</li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>
 </BODY>
 </HTML>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/