~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/curs_util.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\"***************************************************************************
2
 
.\" Copyright (c) 1998-2004,2005 Free Software Foundation, Inc.              *
 
2
.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.              *
3
3
.\"                                                                          *
4
4
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
5
5
.\" copy of this software and associated documentation files (the            *
26
26
.\" authorization.                                                           *
27
27
.\"***************************************************************************
28
28
.\"
29
 
.\" $Id: curs_util.3x,v 1.17 2005/06/25 21:51:37 tom Exp $
 
29
.\" $Id: curs_util.3x,v 1.21 2006/08/26 14:17:48 tom Exp $
30
30
.TH curs_util 3X ""
31
31
.na
32
32
.hy 0
37
37
\fBgetwin\fR,
38
38
\fBkey_name\fR,
39
39
\fBkeyname\fR,
 
40
\fBnofilter\fR,
40
41
\fBputwin\fR,
41
42
\fBunctrl\fR,
42
43
\fBuse_env\fR,
56
57
.br
57
58
\fBvoid filter(void);\fR
58
59
.br
 
60
\fBvoid nofilter(void);\fR
 
61
.br
59
62
\fBvoid use_env(bool f);\fR
60
63
.br
61
64
\fBint putwin(WINDOW *win, FILE *filep);\fR
89
92
\fBcuu1\fR, \fBcuu\fR, \fBvpa\fR are disabled; and the \fBhome\fR string is
90
93
set to the value of \fBcr\fR.
91
94
.PP
 
95
The \fBnofilter\fP routine cancels the effect of a preceding \fBfilter\fP
 
96
call.
 
97
That allows the caller to initialize a screen on a different device,
 
98
using a different value of \fB$TERM\fP.
 
99
The limitation arises because the \fBfilter\fP routine modifies the
 
100
in-memory copy of the terminal information.
 
101
.PP
92
102
The \fBuse_env\fR routine, if used, is called before \fBinitscr\fR or
93
103
\fBnewterm\fR are called.  When called with \fBFALSE\fR as an
94
104
argument, the values of \fBlines\fR and \fBcolumns\fR specified in the
142
152
erroneously fails to describe the disabling of \fBcuu\fR).
143
153
.PP
144
154
The strings returned by \fBunctrl\fR in this implementation are determined
145
 
at compile time, showing C1 controls from the upper-128 codes with a `~'
146
 
prefix rather than `^'.
147
 
Other implementations typically show both sets of control characters with `^',
148
 
and may strip the parameter to 7 bits.
 
155
at compile time,
 
156
showing C1 controls from the upper-128 codes with a `~' prefix rather than `^'.
 
157
Other implementations have different conventions.
 
158
For example, they may show both sets of control characters with `^',
 
159
and strip the parameter to 7 bits.
 
160
Or they may ignore C1 controls and treat all of the upper-1280 codes as
 
161
printable.
149
162
This implementation uses 8 bits but does not modify the string to reflect
150
163
locale.
 
164
The \fBuse_legacy_coding\fP function allows the caller to
 
165
change the output of \fBunctrl\fP.
151
166
.PP
152
167
The \fBkeyname\fP function may return the names of user-defined
153
168
string capabilities which are defined in the terminfo entry via the \fB-x\fP
154
169
option of \fBtic\fP.
 
170
This implementation automatically assigns at run-time keycodes to 
 
171
user-defined strings which begin with "k".
 
172
The keycodes start at KEY_MAX, but are not guaranteed to be 
 
173
the same value for different runs because user-defined codes are
 
174
merged from all terminal descriptions which have been loaded.
 
175
.PP
 
176
The \fBnofilter\fP routine is specific to ncurses.
 
177
It was not supported on Version 7, BSD or System V implementations.
 
178
It is recommended that any code depending on ncurses extensions
 
179
be conditioned using NCURSES_VERSION.
155
180
.SH SEE ALSO
 
181
\fBuse_legacy_coding\fR(3),
156
182
\fBcurses\fR(3X),
157
183
\fBcurs_initscr\fR(3X),
158
184
\fBcurs_kernel\fR(3X),