X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fncurses.3x.html;h=2e9e92eb4cde4e3f8fa2a4b0395bbed67b9d8a73;hp=d451806af80121f17a349c8f2bf69fba4f2ccf7d;hb=29a36e53e1f77a0c3672f2e267d573823d6a9a60;hpb=a0b91dc27f0c411e343161b0a4b5459d15a43f85 diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html index d451806a..2e9e92eb 100644 --- a/doc/html/man/ncurses.3x.html +++ b/doc/html/man/ncurses.3x.html @@ -46,24 +46,21 @@ - -

NAME

+

NAME

        ncurses - CRT screen handling and optimization package
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
 
-
-

DESCRIPTION

+

DESCRIPTION

        The  ncurses  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 clas-
        sic  curses,  which has been discontinued.  This describes
-       ncurses version 6.0 (patch 20151024).
+       ncurses version 6.0 (patch 20160820).
 
        The ncurses library emulates the curses library of  System
        V  Release  4  UNIX,  and  XPG4 (X/Open Portability Guide)
@@ -97,8 +94,7 @@
        access to low-level terminal-manipulation routines.
 
 
-
-

Initialization

+

Initialization

        The  library uses the locale which the calling program has
        initialized.  That is normally done with setlocale:
 
@@ -135,8 +131,7 @@
        for doing this.  [See terminfo(5) for further details.]
 
 
-
-

Datatypes

+

Datatypes

        The ncurses library permits manipulation  of  data  struc-
        tures,  called  windows,  which  can be thought of as two-
        dimensional arrays of characters representing all or  part
@@ -182,8 +177,7 @@
        <curses.h>, such as A_REVERSE, ACS_HLINE, and KEY_LEFT.
 
 
-
-

Environment variables

+

Environment variables

        If the environment variables LINES and COLUMNS are set, or
        if  the program is executing in a window environment, line
        and column information in the  environment  will  override
@@ -224,8 +218,7 @@
        curscr can be used in only a few routines.
 
 
-
-

Routine and Argument Names

+

Routine and Argument Names

        Many  curses routines have two or more versions.  The rou-
        tines prefixed with w require a window argument.  The rou-
        tines prefixed with p require a pad argument.  Those with-
@@ -306,8 +299,7 @@
                becomes wadd_wch.
 
 
-
-

Routine Name Index

+

Routine Name Index

        The following table lists each curses routine and the name
        of the manual page on which  it  is  described.   Routines
        flagged  with  `*'  are ncurses-specific, not described by
@@ -766,8 +758,7 @@
               wvline_set              curs_border_set(3x)
 
 
-
-

RETURN VALUE

+

RETURN VALUE

        Routines that return an integer return  ERR  upon  failure
        and  an  integer value other than ERR upon successful com-
        pletion, unless otherwise noted in  the  routine  descrip-
@@ -785,8 +776,7 @@
        Routines that return pointers return NULL on error.
 
 
-
-

ENVIRONMENT

+

ENVIRONMENT

        The following environment symbols are useful for customiz-
        ing the runtime behavior of the ncurses library.  The most
        important ones have been already discussed in detail.
@@ -802,8 +792,7 @@
        it does not happen to be a single character.
 
 
-
-

BAUDRATE

+

BAUDRATE

        The  debugging  library  checks  this environment variable
        when the application has redirected output to a file.  The
        variable's  numeric value is used for the baudrate.  If no
@@ -812,8 +801,7 @@
        costs that depend on baudrate.
 
 
-
-

COLUMNS

+

COLUMNS

        Specify the width of the screen in  characters.   Applica-
        tions  running in a windowing environment usually are able
        to obtain the width of the window in which they  are  exe-
@@ -844,8 +832,7 @@
        system calls or the terminal database.
 
 
-
-

ESCDELAY

+

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
@@ -874,8 +861,7 @@
        lems when compiling an application.
 
 
-
-

HOME

+

HOME

        Tells ncurses where your home directory is.  That is where
        it may read and write auxiliary terminal descriptions:
 
@@ -883,14 +869,12 @@
        $HOME/.terminfo
 
 
-
-

LINES

+

LINES

        Like  COLUMNS, specify the height of the screen in charac-
        ters.  See COLUMNS for a detailed description.
 
 
-
-

MOUSE_BUTTONS_123

+

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:
@@ -904,8 +888,7 @@
        or 321.  If it is not specified, ncurses uses 132.
 
 
-
-

NCURSES_ASSUMED_COLORS

+

NCURSES_ASSUMED_COLORS

        Override the compiled-in assumption  that  the  terminal's
        default   colors   are  white-on-black  (see  default_col-
        ors(3x)).  You may set the foreground and background color
@@ -917,8 +900,7 @@
        value is allowed.
 
 
-
-

NCURSES_CONSOLE2

+

NCURSES_CONSOLE2

        This applies only to the MinGW port of ncurses.
 
        The Console2 program's handling of the  Microsoft  Console
@@ -930,8 +912,7 @@
        same effect.
 
 
-
-

NCURSES_GPM_TERMS

+

NCURSES_GPM_TERMS

        This applies only to ncurses configured  to  use  the  GPM
        interface.
 
@@ -945,8 +926,7 @@
        attempt to open GPM if TERM contains "linux".
 
 
-
-

NCURSES_NO_HARD_TABS

+

NCURSES_NO_HARD_TABS

        Ncurses may use tabs as part of the cursor movement  opti-
        mization.   In  some  cases,  your terminal driver may not
        handle these properly.  Set this environment  variable  to
@@ -959,8 +939,7 @@
        environment variable.
 
 
-
-

NCURSES_NO_PADDING

+

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 environ-
@@ -987,8 +966,7 @@
        part of special control sequences such as flash.
 
 
-
-

NCURSES_NO_SETBUF

+

NCURSES_NO_SETBUF

        This setting is obsolete.  Before changes
 
           o   started with 5.9 patch 20120825 and
@@ -1018,8 +996,7 @@
        level curses calls do not.
 
 
-
-

NCURSES_NO_UTF8_ACS

+

NCURSES_NO_UTF8_ACS

        During initialization, the ncurses library checks for spe-
        cial cases where VT100 line-drawing (and the corresponding
        alternate character set  capabilities)  described  in  the
@@ -1055,8 +1032,7 @@
        interface.
 
 
-
-

NCURSES_TRACE

+

NCURSES_TRACE

        During   initialization,  the  ncurses  debugging  library
        checks the NCURSES_TRACE environment variable.  If  it  is
        defined, to a numeric value, ncurses calls the trace func-
@@ -1070,8 +1046,7 @@
        See curs_trace(3x) for more information.
 
 
-
-

TERM

+

TERM

        Denotes  your  terminal  type.  Each terminal type is dis-
        tinct, though many are similar.
 
@@ -1091,8 +1066,7 @@
        match that setting.
 
 
-
-

TERMCAP

+

TERMCAP

        If  the  ncurses  library has been configured with termcap
        support, ncurses will check for a  terminal's  description
        in  termcap  form  if  it is not available in the terminfo
@@ -1106,8 +1080,7 @@
        mation, e.g., /etc/termcap.
 
 
-
-

TERMINFO

+

TERMINFO

        Overrides the directory in which ncurses searches for your
        terminal description.  This is the simplest, but  not  the
        only  way to change the list of directories.  The complete
@@ -1135,8 +1108,7 @@
                  MINFO variable)
 
 
-
-

TERMINFO_DIRS

+

TERMINFO_DIRS

        Specifies  a  list  of  directories to search for terminal
        descriptions.  The list is separated by colons (i.e., ":")
        on Unix, semicolons on OS/2 EMX.
@@ -1155,8 +1127,7 @@
        of a termcap file.
 
 
-
-

TERMPATH

+

TERMPATH

        If TERMCAP does not hold a file name then  ncurses  checks
        the  TERMPATH  environment  variable.   This  is a list of
        filenames separated by spaces or  colons  (i.e.,  ":")  on
@@ -1173,8 +1144,7 @@
        $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME.
 
 
-
-

ALTERNATE CONFIGURATIONS

+

ALTERNATE CONFIGURATIONS

        Several  different  configurations are possible, depending
        on  the  configure  script  options  used  when   building
        ncurses.   There  are a few main options whose effects are
@@ -1255,23 +1225,20 @@
             ing it is always in the debug library.
 
 
-
-

FILES

+

FILES

        /usr/share/tabset
             directory  containing  initialization  files  for the
             terminal capability database /usr/share/terminfo ter-
             minal capability database
 
 
-
-

SEE ALSO

+

SEE ALSO

        terminfo(5)  and  related  pages whose names begin "curs_"
        for detailed routine descriptions.
        curs_variables(3x)
 
 
-
-

EXTENSIONS

+

EXTENSIONS

        The  ncurses  library  can  be  compiled  with  an  option
        (-DUSE_GETCAP) that falls back to the old-style /etc/term-
        cap file if the terminal setup code cannot find a terminfo
@@ -1310,8 +1277,7 @@
        device.  See the curs_print(3x) manual page for details.
 
 
-
-

PORTABILITY

+

PORTABILITY

        The  ncurses  library is intended to be BASE-level confor-
        mant with XSI Curses.  The EXTENDED XSI Curses functional-
        ity (including color support) is supported.
@@ -1374,8 +1340,7 @@
        package's portability correspondingly.
 
 
-
-

NOTES

+

NOTES

        The header  file  <curses.h>  automatically  includes  the
        header files <stdio.h> and <unctrl.h>.
 
@@ -1385,8 +1350,7 @@
        ture of AT&T System V Release 3 curses.
 
 
-
-

AUTHORS

+

AUTHORS

        Zeyd M. Ben-Halim, Eric  S.  Raymond,  Thomas  E.  Dickey.
        Based on pcurses by Pavel Curtis.