ncurses 5.7 - patch 20100220

[ncurses.git] / man / ncurses.3x

diff --git a/man/ncurses.3x b/man/ncurses.3x
index 7e337f9d21b34b34640b9bd6383b1bc3890bcbd2..651531b0a63856c89f92c6529d372382cc90551f 100644 (file)
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2009,2010 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,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: ncurses.3x,v 1.90 2008/09/27 19:30:39 tom Exp $
+.\" $Id: ncurses.3x,v 1.94 2010/01/09 16:34:57 tom Exp $

 .hy 0
 .TH ncurses 3X ""
 .ds n 5
 .hy 0
 .TH ncurses 3X ""
 .ds n 5


@@ -74,10 +74,23 @@ terminal and \fBcurses\fR input and output options; environment query
 routines; color manipulation; use of soft label keys; terminfo capabilities;
 and access to low-level terminal-manipulation routines.
 .PP
 routines; color manipulation; use of soft label keys; terminfo capabilities;
 and access to low-level terminal-manipulation routines.
 .PP

-To initialize the routines, the routine \fBinitscr\fR or \fBnewterm\fR
-must be called before any of the other routines that deal with windows
+The library uses the locale which the calling program has initialized.
+That is normally done with \fBsetlocale\fP:
+.sp
+      \fBsetlocale(LC_ALL, "");\fP
+.sp
+If the locale is not initialized,
+the library assumes that characters are printable as in ISO-8859-1,
+to work with certain legacy programs.
+You should initialize the locale and not rely on specific details of
+the library when the locale has not been setup.
+.PP
+The function \fBinitscr\fR or \fBnewterm\fR
+must be called to initialize the library
+before any of the other routines that deal with windows

 and screens are used.
 The routine \fBendwin\fR must be called before exiting.
 and screens are used.
 The routine \fBendwin\fR must be called before exiting.

+.PP

 To get character-at-a-time input without echoing (most
 interactive, screen oriented programs want this), the following
 sequence should be used:
 To get character-at-a-time input without echoing (most
 interactive, screen oriented programs want this), the following
 sequence should be used:


@@ -280,6 +293,8 @@ l l .
 =
 COLOR_PAIR/\fBcurs_color\fR(3X)
 PAIR_NUMBER/\fBcurs_attr\fR(3X)
 =
 COLOR_PAIR/\fBcurs_color\fR(3X)
 PAIR_NUMBER/\fBcurs_attr\fR(3X)

+_nc_free_and_exit/\fBcurs_memleaks\fR(3X)*
+_nc_freeall/\fBcurs_memleaks\fR(3X)*

 _nc_tracebits/\fBcurs_trace\fR(3X)*
 _traceattr/\fBcurs_trace\fR(3X)*
 _traceattr2/\fBcurs_trace\fR(3X)*
 _nc_tracebits/\fBcurs_trace\fR(3X)*
 _traceattr/\fBcurs_trace\fR(3X)*
 _traceattr2/\fBcurs_trace\fR(3X)*


@@ -741,6 +756,10 @@ When set, change occurrences of the command_character
 (i.e., the \fBcmdch\fP capability)
 of the loaded terminfo entries to the value of this symbol.
 Very few terminfo entries provide this feature.
 (i.e., the \fBcmdch\fP capability)
 of the loaded terminfo entries to the value of this symbol.
 Very few terminfo entries provide this feature.

+.IP
+Because this name is also used in development environments to represent
+the C compiler's name, \fBncurses\fR ignores it if it does not happen to
+be a single character.

 .TP 5
 COLUMNS
 Specify the width of the screen in characters.
 .TP 5
 COLUMNS
 Specify the width of the screen in characters.


@@ -907,7 +926,7 @@ and is likely to work for terminal emulators.
 .IP
 When setting this variable, you should set it to a nonzero value.
 Setting it to zero (or to a nonnumber)
 .IP
 When setting this variable, you should set it to a nonzero value.
 Setting it to zero (or to a nonnumber)

-disables the special check for Linux and screen.
+disables the special check for "linux" and "screen".

 .TP 5
 NCURSES_TRACE
 During initialization, the \fBncurses\fR debugging library
 .TP 5
 NCURSES_TRACE
 During initialization, the \fBncurses\fR debugging library