]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/ncurses.3x.html
ncurses 5.9 - patch 20140524
[ncurses.git] / doc / html / man / ncurses.3x.html
index b670e16ed2b0ccc0134497db78645239f8964201..c4153e2ecd1a8ec7ffd10596f9216b4367e4d223 100644 (file)
@@ -1,8 +1,8 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <!-- 
   * t
   ****************************************************************************
-  * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc.              *
+  * Copyright (c) 1998-2013,2014 Free Software Foundation, Inc.              *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -28,7 +28,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: ncurses.3x,v 1.111 2013/03/02 22:15:25 tom Exp @
+  * @Id: ncurses.3x,v 1.117 2014/05/24 20:29:27 tom Exp @
 -->
 <HTML>
 <HEAD>
 <H2>DESCRIPTION</H2><PRE>
        The  <STRONG>ncurses</STRONG>  library  routines  give the user a terminal-
        independent method of updating character screens with rea-
-       sonable   optimization.    This  implementation  is  ``new
-       curses'' (ncurses) and is  the  approved  replacement  for
-       4.4BSD  classic curses, which has been discontinued.  This
-       describes <STRONG>ncurses</STRONG> version 5.9 (patch 20130309).
+       sonable optimization.  This implementation is "new curses"
+       (ncurses) and is the approved replacement for 4.4BSD clas-
+       sic  curses,  which has been discontinued.  This describes
+       <STRONG>ncurses</STRONG> version 5.9 (patch 20140524).
 
        The <STRONG>ncurses</STRONG> library emulates the curses library of  System
        V  Release  4  UNIX,  and  XPG4 (X/Open Portability Guide)
        ing the runtime behavior of the <STRONG>ncurses</STRONG> library.  The most
        important ones have been already discussed in detail.
 
-       BAUDRATE
-            The  debugging  library checks this environment vari-
-            able when the application has redirected output to  a
-            file.   The  variable's numeric value is used for the
-            baudrate.  If no value is found, <STRONG>ncurses</STRONG>  uses  9600.
-            This  allows  testers  to  construct repeatable test-
-            cases that take into account  costs  that  depend  on
-            baudrate.
-
        CC   When set, change occurrences of the command_character
             (i.e., the <STRONG>cmdch</STRONG> capability) of the  loaded  terminfo
             entries to the value of this variable.  Very few ter-
             ignores it if it does not happen to be a single char-
             acter.
 
+       BAUDRATE
+            The  debugging  library checks this environment vari-
+            able when the application has redirected output to  a
+            file.   The  variable's numeric value is used for the
+            baudrate.  If no value is found, <STRONG>ncurses</STRONG>  uses  9600.
+            This  allows  testers  to  construct repeatable test-
+            cases that take into account  costs  that  depend  on
+            baudrate.
+
        COLUMNS
             Specify  the  width  of  the  screen  in  characters.
             Applications running in a windowing environment  usu-
             tive value from zero to the terminfo <STRONG>max_colors</STRONG> value
             is allowed.
 
+       NCURSES_CONSOLE2
+            This applies only to the MinGW port of ncurses.
+
+            The <STRONG>Console2</STRONG> program's handling of the Microsoft Con-
+            sole API call <STRONG>CreateConsoleScreenBuffer</STRONG> is defective.
+            Applications which use this will hang.   However,  it
+            is  possible  to  simulate the action of this call by
+            mapping coordinates, explicitly saving and  restoring
+            the  original  screen contents.  Setting the environ-
+            ment variable <STRONG>NCGDB</STRONG> has the same effect.
+
        NCURSES_GPM_TERMS
             This applies only to ncurses configured  to  use  the
             GPM interface.
             variable to disable the feature.  You can also adjust
             your <STRONG>stty</STRONG> settings to avoid the problem.
 
-       NCURSES_NO_MAGIC_COOKIES
+       NCURSES_NO_MAGIC_COOKIE
             Some  terminals  use  a  magic-cookie  feature  which
             requires  special  handling  to make highlighting and
             other video attributes  display  properly.   You  can
             applications  to  be  built using either library from
             the same set of headers.
 
+       --with-pthread
+            The configure script renames the library.  All of the
+            library names have a "t" appended to them (before any
+            "w" added by <STRONG>--enable-widec</STRONG>).
+
+            The global variables such as <STRONG>LINES</STRONG>  are  replaced  by
+            macros  to allow read-only access.  At the same time,
+            setter-functions are provided to  set  these  values.
+            Some  applications  (very few) may require changes to
+            work with this convention.
+
        --with-shared
 
        --with-normal