Blame - doc/html/man/ncurses.3x.html - android_external_libncurses

2025-07-08 18:04:53 -0400

[diff] [blame]

1

<!--

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

2

* t

3

****************************************************************************

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

4

5

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

6

* *

7

* Permission is hereby granted, free of charge, to any person obtaining a *

8

* copy of this software and associated documentation files (the *

9

* "Software"), to deal in the Software without restriction, including *

10

* without limitation the rights to use, copy, modify, merge, publish, *

11

* distribute, distribute with modifications, sublicense, and/or sell *

12

* copies of the Software, and to permit persons to whom the Software is *

13

* furnished to do so, subject to the following conditions: *

14

* *

15

* The above copyright notice and this permission notice shall be included *

16

* in all copies or substantial portions of the Software. *

17

* *

18

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

19

* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

20

* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

21

* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

22

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

23

* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

24

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

25

* *

26

* Except as contained in this notice, the name(s) of the above copyright *

27

* holders shall not be used in advertising or otherwise to promote the *

28

* sale, use or other dealings in this Software without prior written *

29

* authorization. *

30

****************************************************************************

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

31

* @Id: ncurses.3x,v 1.214 2024/04/27 17:55:43 tom Exp @

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

32

-->

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

33

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

34

<HTML>

35

<HEAD>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

36

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

37

38

<TITLE>ncurses 3x 2024-04-27 ncurses 6.5 Library calls</TITLE>

39

40

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

41

</HEAD>

42

<BODY>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

43

<H1 class="no-header">ncurses 3x 2024-04-27 ncurses 6.5 Library calls</H1>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

44

<PRE>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

45

<A HREF="ncurses.3x.html">ncurses(3x)</A> Library calls <A HREF="ncurses.3x.html">ncurses(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

50

</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

51

ncurses - character-cell terminal interface with optimized output

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

52

53

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

54

</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

#include <curses.h>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

58

</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

59

The "new curses" library offers the programmer a terminal-independent

60

means of reading keyboard and mouse input and updating character-cell

61

terminals with output optimized to minimize screen updates. ncurses

62

replaces the curses libraries from System V Release 4 Unix ("SVr4") and

63

4.4BSD Unix, the development of which ceased in the 1990s. This

64

document describes ncurses version 6.5 (patch 20240427).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

65

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

66

ncurses permits control of the terminal screen's contents; abstraction

67

and subdivision thereof with windows and pads; the reading of terminal

68

input; control of terminal input and output options; environment query

69

routines; color manipulation; the definition and use of soft label

70

keys; terminfo capability access; a termcap compatibility interface;

71

and an abstraction of the system's API for manipulating the terminal

72

(such as termios(3)).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

73

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

74

ncurses implements the standard interface described by X/Open Curses

75

Issue 7. In many behavioral details not standardized by X/Open,

76

ncurses emulates the curses library of SVr4 and provides numerous

77

useful extensions.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

78

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

79

ncurses man pages employ several sections to clarify matters of usage

80

and interoperability with other curses implementations.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

81

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

82

o "NOTES" describes issues and caveats of which any user of the

83

ncurses API should be aware, such as limitations on the size of an

84

underlying integral type or the availability of a preprocessor

85

macro exclusive of a function definition (which prevents its

86

address from being taken). This section also describes

87

implementation details that will be significant to the programmer

88

but which are not standardized.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

89

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

90

o "EXTENSIONS" presents ncurses innovations beyond the X/Open Curses

91

standard and/or the SVr4 curses implementation. They are termed

92

extensions to indicate that they cannot be implemented solely by

93

using the library API, but require access to the library's internal

94

state.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

95

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

96

o "PORTABILITY" discusses matters (beyond the exercise of extensions)

97

that should be considered when writing to a curses standard, or for

98

multiple implementations.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

99

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

100

o "HISTORY" examines points of detail in ncurses and other curses

101

implementations over the decades of their development, particularly

102

where precedent or inertia have frustrated better design (and, in a

103

few cases, where such inertia has been overcome).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

104

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

105

A curses application must be linked with the library; use the -lncurses

106

option to your compiler or linker. A debugging version of the library

107

may be available; if so, link with it using -lncurses_g. (Your system

108

integrator may have installed these libraries such that you can use the

109

options -lcurses and -lcurses_g, respectively.) The ncurses_g library

110

generates trace logs (in a file called trace in the current directory)

111

that describe ncurses actions. See section "ALTERNATE CONFIGURATIONS"

112

below.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

113

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

114

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

115

</PRE><H3><a name="h3-Application-Structure">Application Structure</a></H3><PRE>

116

A curses application uses information from the system locale;

117

setlocale(3) prepares it for curses library calls.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

118

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

119

setlocale(LC_ALL, "");

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

120

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

121

If the locale is not thus initialized, the library assumes that

122

characters are printable as in ISO 8859-1, to work with certain legacy

123

programs. You should initialize the locale; do not expect consistent

124

behavior from the library when the locale has not been set up.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

125

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

126

<A HREF="curs_initscr.3x.html">initscr(3x)</A> or <A HREF="curs_initscr.3x.html">newterm(3x)</A> must be called to initialize curses before

127

use of any functions that deal with windows and screens.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

128

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

129

To get character-at-a-time input without echoing--most interactive,

130

screen-oriented programs want this--use the following sequence.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

131

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

132

initscr(); cbreak(); noecho();

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

133

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

134

Most applications perform further setup as follows.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

135

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

136

intrflush(stdscr, FALSE);

137

keypad(stdscr, TRUE);

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

138

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

139

A curses program then often enters an event loop of some sort. Call

140

<A HREF="curs_initscr.3x.html">endwin(3x)</A> before exiting.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

141

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

142

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

143

</PRE><H3><a name="h3-Overview">Overview</a></H3><PRE>

144

A curses library abstracts the terminal screen by representing all or

145

part of it as a WINDOW data structure. A window is a rectangular grid

146

of character cells, addressed by row and column coordinates (y, x),

147

with the upper left corner as (0, 0). A window called stdscr, the same

148

size as the terminal screen, is always available. Create others with

149

<A HREF="curs_window.3x.html">newwin(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

150

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

151

A curses library does not manage overlapping windows (but see below).

152

You can either use stdscr to manage one screen-filling window, or tile

153

the screen into non-overlapping windows and not use stdscr at all.

154

Mixing the two approaches will result in unpredictable and undesired

155

effects.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

156

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

157

Functions permit manipulation of a window and the cursor identifying

158

the cell within it at which the next output operation will occur.

159

Among those, the most basic are <A HREF="curs_move.3x.html">move(3x)</A> and <A HREF="curs_addch.3x.html">addch(3x)</A>: these place the

160

cursor and write a character to stdscr, respectively.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

161

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

162

Frequent changes to the terminal screen can cause unpleasant flicker or

163

inefficient use of the communication channel to the device, so the

164

library does not generally update it automatically. Therefore, after

165

using curses functions to accumulate a set of desired updates that make

166

sense to present together, call <A HREF="curs_refresh.3x.html">refresh(3x)</A> to tell the library to make

167

the user's screen look like stdscr. The library optimizes its output

168

by computing a minimal number of operations to mutate the screen from

169

its state at the previous refresh to the new one. Effective

170

optimization demands accurate information about the terminal device:

171

the management of such information is the province of the <A HREF="curs_terminfo.3x.html">terminfo(3x)</A>

172

API, a feature of every standard curses implementation.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

173

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

174

Special windows called pads may also be manipulated. These are windows

175

that are not constrained to the size of the terminal screen and whose

176

contents need not be completely displayed. See <A HREF="curs_pad.3x.html">curs_pad(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

177

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

178

In addition to drawing characters on the screen, rendering attributes

179

and colors may be supported, causing the characters to show up in such

180

modes as underlined, in reverse video, or in color on terminals that

181

support such display enhancements. See <A HREF="curs_attr.3x.html">curs_attr(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

182

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

183

curses predefines constants for a small set of forms-drawing graphics

184

corresponding to the DEC Alternate Character Set (ACS), a feature of

185

VT100 and other terminals. See <A HREF="curs_addch.3x.html">waddch(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

186

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

187

curses is implemented using the operating system's terminal driver;

188

keystroke events are received not as scan codes but as byte sequences.

189

Graphical keycaps (alphanumeric and punctuation keys, and the space)

190

appear as-is. Everything else, including the tab, enter/return,

191

keypad, arrow, and function keys, appears as a control character or a

192

multibyte escape sequence. curses translates these into unique key

193

codes. See <A HREF="curs_getch.3x.html">getch(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

194

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

195

ncurses provides reimplementations of the SVr4 <A HREF="panel.3x.html">panel(3x)</A>, <A HREF="form.3x.html">form(3x)</A>, and

196

<A HREF="menu.3x.html">menu(3x)</A> libraries to ease construction of user interfaces with curses.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

197

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

198

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

199

</PRE><H3><a name="h3-Initialization">Initialization</a></H3><PRE>

200

The selection of an appropriate value of TERM in the process

201

environment is essential to correct curses and terminfo library

202

operation. A well-configured system selects a correct TERM value

203

automatically; <A HREF="tset.1.html">tset(1)</A> may assist with troubleshooting exotic

204

situations.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

205

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

206

If you change the terminal type, export the TERM environment variable

207

in the shell, then run <A HREF="tset.1.html">tset(1)</A> or the "tput init" command. See

208

subsection "Tabs and Initialization" of <A HREF="terminfo.5.html">terminfo(5)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

209

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

210

If the environment variables LINES and COLUMNS are set, or if the

211

curses program is executing in a graphical windowing environment, the

212

information obtained thence overrides that obtained by terminfo. An

213

ncurses extension supports resizable terminals; see <A HREF="wresize.3x.html">wresize(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

214

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

215

If the environment variable TERMINFO is defined, a curses program

216

checks first for a terminal type description in the location it

217

identifies. TERMINFO is useful for developing experimental type

218

descriptions or when write permission to /usr/share/terminfo is not

219

available.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

220

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

221

See section "ENVIRONMENT" below.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

222

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

223

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

224

</PRE><H3><a name="h3-Naming-Conventions">Naming Conventions</a></H3><PRE>

225

curses offers many functions in variant forms using a regular set of

226

alternatives to the name of an elemental one. Those prefixed with "w"

227

require a WINDOW pointer argument; those with a "mv" prefix first

228

perform cursor movement using <A HREF="curs_move.3x.html">wmove(3x)</A>; a "mvw" prefix indicates both.

229

The "w" function is typically the elemental one; the removal of this

230

prefix usually indicates operation on stdscr.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

231

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

232

Four functions prefixed with "p" require a pad argument.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

233

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

234

In function synopses, ncurses man pages apply the following names to

235

parameters.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

236

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

237

bf bool (TRUE or FALSE)

238

c a char or int

239

ch a chtype

240

wc a wchar_t or wint_t

241

wch a cchar_t

242

win pointer to a WINDOW

243

pad pointer to a WINDOW that is a pad

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

244

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

245

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

246

</PRE><H3><a name="h3-Wide-and-Non-wide-Character-Configurations">Wide and Non-wide Character Configurations</a></H3><PRE>

247

This manual page describes functions that appear in any configuration

248

of the library. There are two common configurations; see section

249

"ALTERNATE CONFIGURATIONS" below.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

250

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

251

ncurses is the library in its "non-wide" configuration, handling only

252

eight-bit characters. It stores a character combined with

253

attributes in a chtype datum, which is often an alias of int.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

254

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

255

Attributes alone (with no corresponding character) can be

256

stored in variables of chtype or attr_t type. In either

257

case, they are represented as an integral bit mask.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

258

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

259

Each cell of a WINDOW is stored as a chtype.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

260

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

261

ncursesw is the library in its "wide" configuration, which handles

262

character encodings requiring a larger data type than char (a

263

byte-sized type) can represent. It adds about one third more

264

calls using additional data types that can store such

265

multibyte characters.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

266

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

267

cchar_t corresponds to the non-wide configuration's chtype.

268

It always a structure type, because it stores more

269

data than fit into a standard scalar type. A

270

character code may not be representable as a char,

271

and moreover more than one character may occupy a

272

cell (as with accent marks and other diacritics).

273

Each character is of type wchar_t; a complex

274

character contains one spacing character and zero or

275

more non-spacing characters (see below). Attributes

276

and color data are stored in separate fields of the

277

structure, not combined as in chtype.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

278

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

279

Each cell of a WINDOW is stored as a cchar_t.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

280

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

281

<A HREF="curs_getcchar.3x.html">setcchar(3x)</A> and <A HREF="curs_getcchar.3x.html">getcchar(3x)</A> store and retrieve cchar_t

282

data. The wide library API of ncurses depends on two data

283

types standardized by ISO C95.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

284

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

285

wchar_t stores a wide character. Like chtype, it may be an

286

alias of int. Depending on the character encoding,

287

a wide character may be spacing, meaning that it

288

occupies a character cell by itself and typically

289

accompanies cursor advancement, or non-spacing,

290

meaning that it occupies the same cell as a spacing

291

character, is often regarded as a "modifier" of the

292

base glyph with which it combines, and typically

293

does not advance the cursor.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

294

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

295

wint_t can store a wchar_t or the constant WEOF,

296

analogously to the int-sized character manipulation

297

functions of ISO C and its constant EOF.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

298

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

299

The wide library provides additional functions that

300

complement those in the non-wide library where the size of

301

the underlying character type is significant. A somewhat

302

regular naming convention relates many of the wide variants

303

to their non-wide counterparts; where a non-wide function

304

name contains "ch" or "str", prefix it with "_w" to obtain

305

the wide counterpart. For example, waddch becomes wadd_wch.

306

(Exceptions that add only "w" comprise addwstr, inwstr, and

307

their variants.)

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

308

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

309

This convention is inapplicable to some non-wide function

310

names, so other transformations are used for the wide

311

configuration: the window background management function

312

"bkgd" becomes "bkgrnd"; the window border-drawing and

313

-clearing functions are suffixed with "_set"; and character

314

attribute manipulation functions like "attron" become

315

"attr_on".

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

316

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

317

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

318

</PRE><H3><a name="h3-Function-Name-Index">Function Name Index</a></H3><PRE>

319

The following table lists the curses functions provided in the non-wide

320

and wide APIs and the corresponding man pages that describe them.

321

Those flagged with "*" are ncurses-specific, neither described by

322

X/Open Curses nor present in SVr4.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

323

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

324

curses Function Name Man Page

325

---------------------------------------------

326

COLOR_PAIR <A HREF="curs_color.3x.html">curs_color(3x)</A>

327

PAIR_NUMBER <A HREF="curs_color.3x.html">curs_color(3x)</A>

328

add_wch <A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A>

329

add_wchnstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

330

add_wchstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

331

addch <A HREF="curs_addch.3x.html">curs_addch(3x)</A>

332

addchnstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

333

addchstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

334

addnstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

335

addnwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

336

addstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

337

addwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

338

alloc_pair <A HREF="new_pair.3x.html">new_pair(3x)</A>*

339

assume_default_colors <A HREF="default_colors.3x.html">default_colors(3x)</A>*

340

attr_get <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

341

attr_off <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

342

attr_on <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

343

attr_set <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

344

attroff <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

345

attron <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

346

attrset <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

347

baudrate <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

348

beep <A HREF="curs_beep.3x.html">curs_beep(3x)</A>

349

bkgd <A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A>

350

bkgdset <A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A>

351

bkgrnd <A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A>

352

bkgrndset <A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A>

353

border <A HREF="curs_border.3x.html">curs_border(3x)</A>

354

border_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

355

box <A HREF="curs_border.3x.html">curs_border(3x)</A>

356

box_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

357

can_change_color <A HREF="curs_color.3x.html">curs_color(3x)</A>

358

cbreak <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

359

chgat <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

360

clear <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

361

clearok <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

362

clrtobot <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

363

clrtoeol <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

364

color_content <A HREF="curs_color.3x.html">curs_color(3x)</A>

365

color_set <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

366

copywin <A HREF="curs_overlay.3x.html">curs_overlay(3x)</A>

367

curs_set <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

368

curses_trace <A HREF="curs_trace.3x.html">curs_trace(3x)</A>*

369

curses_version <A HREF="curs_extend.3x.html">curs_extend(3x)</A>*

370

def_prog_mode <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

371

def_shell_mode <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

372

define_key <A HREF="define_key.3x.html">define_key(3x)</A>*

373

del_curterm <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

374

delay_output <A HREF="curs_util.3x.html">curs_util(3x)</A>

375

delch <A HREF="curs_delch.3x.html">curs_delch(3x)</A>

376

deleteln <A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A>

377

delscreen <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

378

delwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

379

derwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

380

doupdate <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

381

dupwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

382

echo <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

383

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

384

echo_wchar <A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A>

385

echochar <A HREF="curs_addch.3x.html">curs_addch(3x)</A>

386

endwin <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

387

erase <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

388

erasechar <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

389

erasewchar <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

390

exit_curses <A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A>*

391

exit_terminfo <A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A>*

392

extended_color_content <A HREF="curs_color.3x.html">curs_color(3x)</A>*

393

extended_pair_content <A HREF="curs_color.3x.html">curs_color(3x)</A>*

394

extended_slk_color <A HREF="curs_slk.3x.html">curs_slk(3x)</A>*

395

filter <A HREF="curs_util.3x.html">curs_util(3x)</A>

396

find_pair <A HREF="new_pair.3x.html">new_pair(3x)</A>*

397

flash <A HREF="curs_beep.3x.html">curs_beep(3x)</A>

398

flushinp <A HREF="curs_util.3x.html">curs_util(3x)</A>

399

free_pair <A HREF="new_pair.3x.html">new_pair(3x)</A>*

400

get_escdelay <A HREF="curs_threads.3x.html">curs_threads(3x)</A>*

401

get_wch <A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A>

402

get_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

403

getattrs <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

404

getbegx <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

405

getbegy <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

406

getbegyx <A HREF="curs_getyx.3x.html">curs_getyx(3x)</A>

407

getbkgd <A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A>

408

getbkgrnd <A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A>

409

getcchar <A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A>

410

getch <A HREF="curs_getch.3x.html">curs_getch(3x)</A>

411

getcurx <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

412

getcury <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

413

getmaxx <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

414

getmaxy <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

415

getmaxyx <A HREF="curs_getyx.3x.html">curs_getyx(3x)</A>

416

getmouse <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

417

getn_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

418

getnstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

419

getparx <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

420

getpary <A HREF="curs_legacy.3x.html">curs_legacy(3x)</A>*

421

getparyx <A HREF="curs_getyx.3x.html">curs_getyx(3x)</A>

422

getstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

423

getsyx <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

424

getwin <A HREF="curs_util.3x.html">curs_util(3x)</A>

425

getyx <A HREF="curs_getyx.3x.html">curs_getyx(3x)</A>

426

halfdelay <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

427

has_colors <A HREF="curs_color.3x.html">curs_color(3x)</A>

428

has_ic <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

429

has_il <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

430

has_key <A HREF="curs_getch.3x.html">curs_getch(3x)</A>*

431

has_mouse <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

432

hline <A HREF="curs_border.3x.html">curs_border(3x)</A>

433

hline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

434

idcok <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

435

idlok <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

436

immedok <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

437

in_wch <A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A>

438

in_wchnstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

439

in_wchstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

440

inch <A HREF="curs_inch.3x.html">curs_inch(3x)</A>

441

inchnstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

442

inchstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

443

init_color <A HREF="curs_color.3x.html">curs_color(3x)</A>

444

init_extended_color <A HREF="curs_color.3x.html">curs_color(3x)</A>*

445

init_extended_pair <A HREF="curs_color.3x.html">curs_color(3x)</A>*

446

init_pair <A HREF="curs_color.3x.html">curs_color(3x)</A>

447

initscr <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

448

innstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

449

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

450

innwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

451

ins_nwstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

452

ins_wch <A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A>

453

ins_wstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

454

insch <A HREF="curs_insch.3x.html">curs_insch(3x)</A>

455

insdelln <A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A>

456

insertln <A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A>

457

insnstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

458

insstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

459

instr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

460

intrflush <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

461

inwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

462

is_cbreak <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>*

463

is_cleared <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

464

is_echo <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>*

465

is_idcok <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

466

is_idlok <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

467

is_immedok <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

468

is_keypad <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

469

is_leaveok <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

470

is_linetouched <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

471

is_nl <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>*

472

is_nodelay <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

473

is_notimeout <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

474

is_pad <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

475

is_raw <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>*

476

is_scrollok <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

477

is_subwin <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

478

is_syncok <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

479

is_term_resized <A HREF="resizeterm.3x.html">resizeterm(3x)</A>*

480

is_wintouched <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

481

isendwin <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

482

key_defined <A HREF="key_defined.3x.html">key_defined(3x)</A>*

483

key_name <A HREF="curs_util.3x.html">curs_util(3x)</A>

484

keybound <A HREF="keybound.3x.html">keybound(3x)</A>*

485

keyname <A HREF="curs_util.3x.html">curs_util(3x)</A>

486

keyok <A HREF="keyok.3x.html">keyok(3x)</A>*

487

keypad <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

488

killchar <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

489

killwchar <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

490

leaveok <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

491

longname <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

492

mcprint <A HREF="curs_print.3x.html">curs_print(3x)</A>*

493

meta <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

494

mouse_trafo <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

495

mouseinterval <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

496

mousemask <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

497

move <A HREF="curs_move.3x.html">curs_move(3x)</A>

498

mvadd_wch <A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A>

499

mvadd_wchnstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

500

mvadd_wchstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

501

mvaddch <A HREF="curs_addch.3x.html">curs_addch(3x)</A>

502

mvaddchnstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

503

mvaddchstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

504

mvaddnstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

505

mvaddnwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

506

mvaddstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

507

mvaddwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

508

mvchgat <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

509

mvcur <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

510

mvdelch <A HREF="curs_delch.3x.html">curs_delch(3x)</A>

511

mvderwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

512

mvget_wch <A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A>

513

mvget_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

514

mvgetch <A HREF="curs_getch.3x.html">curs_getch(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

515

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

516

mvgetn_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

517

mvgetnstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

518

mvgetstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

519

mvhline <A HREF="curs_border.3x.html">curs_border(3x)</A>

520

mvhline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

521

mvin_wch <A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A>

522

mvin_wchnstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

523

mvin_wchstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

524

mvinch <A HREF="curs_inch.3x.html">curs_inch(3x)</A>

525

mvinchnstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

526

mvinchstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

527

mvinnstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

528

mvinnwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

529

mvins_nwstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

530

mvins_wch <A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A>

531

mvins_wstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

532

mvinsch <A HREF="curs_insch.3x.html">curs_insch(3x)</A>

533

mvinsnstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

534

mvinsstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

535

mvinstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

536

mvinwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

537

mvprintw <A HREF="curs_printw.3x.html">curs_printw(3x)</A>

538

mvscanw <A HREF="curs_scanw.3x.html">curs_scanw(3x)</A>

539

mvvline <A HREF="curs_border.3x.html">curs_border(3x)</A>

540

mvvline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

541

mvwadd_wch <A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A>

542

mvwadd_wchnstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

543

mvwadd_wchstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

544

mvwaddch <A HREF="curs_addch.3x.html">curs_addch(3x)</A>

545

mvwaddchnstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

546

mvwaddchstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

547

mvwaddnstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

548

mvwaddnwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

549

mvwaddstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

550

mvwaddwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

551

mvwchgat <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

552

mvwdelch <A HREF="curs_delch.3x.html">curs_delch(3x)</A>

553

mvwget_wch <A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A>

554

mvwget_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

555

mvwgetch <A HREF="curs_getch.3x.html">curs_getch(3x)</A>

556

mvwgetn_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

557

mvwgetnstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

558

mvwgetstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

559

mvwhline <A HREF="curs_border.3x.html">curs_border(3x)</A>

560

mvwhline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

561

mvwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

562

mvwin_wch <A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A>

563

mvwin_wchnstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

564

mvwin_wchstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

565

mvwinch <A HREF="curs_inch.3x.html">curs_inch(3x)</A>

566

mvwinchnstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

567

mvwinchstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

568

mvwinnstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

569

mvwinnwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

570

mvwins_nwstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

571

mvwins_wch <A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A>

572

mvwins_wstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

573

mvwinsch <A HREF="curs_insch.3x.html">curs_insch(3x)</A>

574

mvwinsnstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

575

mvwinsstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

576

mvwinstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

577

mvwinwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

578

mvwprintw <A HREF="curs_printw.3x.html">curs_printw(3x)</A>

579

mvwscanw <A HREF="curs_scanw.3x.html">curs_scanw(3x)</A>

580

mvwvline <A HREF="curs_border.3x.html">curs_border(3x)</A>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

581

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

582

mvwvline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

583

napms <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

584

newpad <A HREF="curs_pad.3x.html">curs_pad(3x)</A>

585

newterm <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

586

newwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

587

nl <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

588

nocbreak <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

589

nodelay <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

590

noecho <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

591

nofilter <A HREF="curs_util.3x.html">curs_util(3x)</A>*

592

nonl <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

593

noqiflush <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

594

noraw <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

595

notimeout <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

596

overlay <A HREF="curs_overlay.3x.html">curs_overlay(3x)</A>

597

overwrite <A HREF="curs_overlay.3x.html">curs_overlay(3x)</A>

598

pair_content <A HREF="curs_color.3x.html">curs_color(3x)</A>

599

pecho_wchar <A HREF="curs_pad.3x.html">curs_pad(3x)</A>

600

pechochar <A HREF="curs_pad.3x.html">curs_pad(3x)</A>

601

pnoutrefresh <A HREF="curs_pad.3x.html">curs_pad(3x)</A>

602

prefresh <A HREF="curs_pad.3x.html">curs_pad(3x)</A>

603

printw <A HREF="curs_printw.3x.html">curs_printw(3x)</A>

604

putp <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

605

putwin <A HREF="curs_util.3x.html">curs_util(3x)</A>

606

qiflush <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

607

raw <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

608

redrawwin <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

609

refresh <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

610

reset_color_pairs <A HREF="curs_color.3x.html">curs_color(3x)</A>*

611

reset_prog_mode <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

612

reset_shell_mode <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

613

resetty <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

614

resize_term <A HREF="resizeterm.3x.html">resizeterm(3x)</A>*

615

resizeterm <A HREF="resizeterm.3x.html">resizeterm(3x)</A>*

616

restartterm <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

617

ripoffline <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

618

savetty <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

619

scanw <A HREF="curs_scanw.3x.html">curs_scanw(3x)</A>

620

scr_dump <A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A>

621

scr_init <A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A>

622

scr_restore <A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A>

623

scr_set <A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A>

624

scrl <A HREF="curs_scroll.3x.html">curs_scroll(3x)</A>

625

scroll <A HREF="curs_scroll.3x.html">curs_scroll(3x)</A>

626

scrollok <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

627

set_curterm <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

628

set_escdelay <A HREF="curs_threads.3x.html">curs_threads(3x)</A>*

629

set_tabsize <A HREF="curs_threads.3x.html">curs_threads(3x)</A>*

630

set_term <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

631

setcchar <A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A>

632

setscrreg <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

633

setsyx <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>

634

setupterm <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

635

slk_attr <A HREF="curs_slk.3x.html">curs_slk(3x)</A>*

636

slk_attr_off <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

637

slk_attr_on <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

638

slk_attr_set <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

639

slk_attroff <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

640

slk_attron <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

641

slk_attrset <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

642

slk_clear <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

643

slk_color <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

644

slk_init <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

645

slk_label <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

646

slk_noutrefresh <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

647

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

648

slk_refresh <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

649

slk_restore <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

650

slk_set <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

651

slk_touch <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

652

slk_wset <A HREF="curs_slk.3x.html">curs_slk(3x)</A>

653

standend <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

654

standout <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

655

start_color <A HREF="curs_color.3x.html">curs_color(3x)</A>

656

subpad <A HREF="curs_pad.3x.html">curs_pad(3x)</A>

657

subwin <A HREF="curs_window.3x.html">curs_window(3x)</A>

658

syncok <A HREF="curs_window.3x.html">curs_window(3x)</A>

659

term_attrs <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

660

termattrs <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

661

termname <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

662

tgetent <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A>

663

tgetflag <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A>

664

tgetnum <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A>

665

tgetstr <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A>

666

tgoto <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A>

667

tigetflag <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

668

tigetnum <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

669

tigetstr <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

670

timeout <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

671

tiparm <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

672

tiparm_s <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>*

673

tiscan_s <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>*

674

touchline <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

675

touchwin <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

676

tparm <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

677

tputs <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A>

678

tputs <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

679

trace <A HREF="curs_trace.3x.html">curs_trace(3x)</A>*

680

typeahead <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

681

unctrl <A HREF="curs_util.3x.html">curs_util(3x)</A>

682

unget_wch <A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A>

683

ungetch <A HREF="curs_getch.3x.html">curs_getch(3x)</A>

684

ungetmouse <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

685

untouchwin <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

686

use_default_colors <A HREF="default_colors.3x.html">default_colors(3x)</A>*

687

use_env <A HREF="curs_util.3x.html">curs_util(3x)</A>

688

use_extended_names <A HREF="curs_extend.3x.html">curs_extend(3x)</A>*

689

use_legacy_coding <A HREF="legacy_coding.3x.html">legacy_coding(3x)</A>*

690

use_screen <A HREF="curs_threads.3x.html">curs_threads(3x)</A>*

691

use_tioctl <A HREF="curs_util.3x.html">curs_util(3x)</A>*

692

use_window <A HREF="curs_threads.3x.html">curs_threads(3x)</A>*

693

vid_attr <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

694

vid_puts <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

695

vidattr <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

696

vidputs <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

697

vline <A HREF="curs_border.3x.html">curs_border(3x)</A>

698

vline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

699

vw_printw <A HREF="curs_printw.3x.html">curs_printw(3x)</A>

700

vw_scanw <A HREF="curs_scanw.3x.html">curs_scanw(3x)</A>

701

vwprintw <A HREF="curs_printw.3x.html">curs_printw(3x)</A>

702

vwscanw <A HREF="curs_scanw.3x.html">curs_scanw(3x)</A>

703

wadd_wch <A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A>

704

wadd_wchnstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

705

wadd_wchstr <A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A>

706

waddch <A HREF="curs_addch.3x.html">curs_addch(3x)</A>

707

waddchnstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

708

waddchstr <A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A>

709

waddnstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

710

waddnwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

711

waddstr <A HREF="curs_addstr.3x.html">curs_addstr(3x)</A>

712

waddwstr <A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

713

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

714

wattr_get <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

715

wattr_off <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

716

wattr_on <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

717

wattr_set <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

718

wattroff <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

719

wattron <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

720

wattrset <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

721

wbkgd <A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A>

722

wbkgdset <A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A>

723

wbkgrnd <A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A>

724

wbkgrndset <A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A>

725

wborder <A HREF="curs_border.3x.html">curs_border(3x)</A>

726

wborder_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

727

wchgat <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

728

wclear <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

729

wclrtobot <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

730

wclrtoeol <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

731

wcolor_set <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

732

wcursyncup <A HREF="curs_window.3x.html">curs_window(3x)</A>

733

wdelch <A HREF="curs_delch.3x.html">curs_delch(3x)</A>

734

wdeleteln <A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A>

735

wecho_wchar <A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A>

736

wechochar <A HREF="curs_addch.3x.html">curs_addch(3x)</A>

737

wenclose <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

738

werase <A HREF="curs_clear.3x.html">curs_clear(3x)</A>

739

wget_wch <A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A>

740

wget_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

741

wgetbkgrnd <A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A>

742

wgetch <A HREF="curs_getch.3x.html">curs_getch(3x)</A>

743

wgetdelay <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

744

wgetn_wstr <A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A>

745

wgetnstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

746

wgetparent <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

747

wgetscrreg <A HREF="curs_opaque.3x.html">curs_opaque(3x)</A>*

748

wgetstr <A HREF="curs_getstr.3x.html">curs_getstr(3x)</A>

749

whline <A HREF="curs_border.3x.html">curs_border(3x)</A>

750

whline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

751

win_wch <A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A>

752

win_wchnstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

753

win_wchstr <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>

754

winch <A HREF="curs_inch.3x.html">curs_inch(3x)</A>

755

winchnstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

756

winchstr <A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A>

757

winnstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

758

winnwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

759

wins_nwstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

760

wins_wch <A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A>

761

wins_wstr <A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A>

762

winsch <A HREF="curs_insch.3x.html">curs_insch(3x)</A>

763

winsdelln <A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A>

764

winsertln <A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A>

765

winsnstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

766

winsstr <A HREF="curs_insstr.3x.html">curs_insstr(3x)</A>

767

winstr <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

768

winwstr <A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A>

769

wmouse_trafo <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>*

770

wmove <A HREF="curs_move.3x.html">curs_move(3x)</A>

771

wnoutrefresh <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

772

wprintw <A HREF="curs_printw.3x.html">curs_printw(3x)</A>

773

wredrawln <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

774

wrefresh <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

775

wresize <A HREF="wresize.3x.html">wresize(3x)</A>*

776

wscanw <A HREF="curs_scanw.3x.html">curs_scanw(3x)</A>

777

wscrl <A HREF="curs_scroll.3x.html">curs_scroll(3x)</A>

778

wsetscrreg <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

779

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

780

wstandend <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

781

wstandout <A HREF="curs_attr.3x.html">curs_attr(3x)</A>

782

wsyncdown <A HREF="curs_window.3x.html">curs_window(3x)</A>

783

wsyncup <A HREF="curs_window.3x.html">curs_window(3x)</A>

784

wtimeout <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>

785

wtouchln <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

786

wunctrl <A HREF="curs_util.3x.html">curs_util(3x)</A>

787

wvline <A HREF="curs_border.3x.html">curs_border(3x)</A>

788

wvline_set <A HREF="curs_border_set.3x.html">curs_border_set(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

789

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

790

ncurses's screen-pointer extension adds additional functions

791

corresponding to many of the above, each with an "_sp" suffix; see

792

<A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

793

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

794

The availability of some extensions is configurable when ncurses is

795

compiled; see sections "ALTERNATE CONFIGURATIONS" and "EXTENSIONS"

796

below.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

797

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

798

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

799

</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>

800

Unless otherwise noted, functions that return an integer return OK on

801

success and ERR on failure. Functions that return pointers return NULL

802

on failure. Typically, ncurses treats a null pointer passed as a

803

function parameter as a failure. Functions prefixed with "mv" first

804

perform cursor movement and fail if the position (y, x) is outside the

805

window boundaries.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

806

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

807

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

808

</PRE><H2><a name="h2-ENVIRONMENT">ENVIRONMENT</a></H2><PRE>

809

The following symbols from the process environment customize the

810

runtime behavior of ncurses applications. The library may be

811

configured to disregard the variables TERMINFO, TERMINFO_DIRS,

812

TERMPATH, and HOME, if the user is the superuser (root), or the

813

application uses setuid(2) or setgid(2).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

814

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

815

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

816

</PRE><H3><a name="h3-BAUDRATE">BAUDRATE</a></H3><PRE>

817

The debugging library checks this variable when the application has

818

redirected output to a file. Its integral value is used for the baud

819

rate. If that value is absent or invalid, ncurses uses 9600. This

820

feature allows testers to construct repeatable test cases that take

821

into account optimization decisions that depend on baud rate.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

822

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

823

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

824

</PRE><H3><a name="h3-CC-_command-character_">CC (command character)</a></H3><PRE>

825

When set, the command_character (cmdch) capability value of loaded

826

terminfo entries changes to the value of this variable. Very few term-

827

info entries provide this feature.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

828

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

829

Because this name is also used in development environments to represent

830

the C compiler's name, ncurses ignores its value if it is not one

831

character in length.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

832

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

833

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

834

</PRE><H3><a name="h3-COLUMNS">COLUMNS</a></H3><PRE>

835

This variable specifies the width of the screen in characters.

836

Applications running in a windowing environment usually are able to

837

obtain the width of the window in which they are executing. If COLUMNS

838

is not defined and the terminal's screen size is not available from the

839

terminal driver, ncurses uses the size specified by the columns (cols)

840

capability of the terminal type's entry in the terminfo database, if

841

any.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

842

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

843

It is important that your application use the correct screen size.

844

Automatic detection thereof is not always possible because an

845

application may be running on a host that does not honor NAWS

846

(Negotiations About Window Size) or as a different user ID than the

847

owner of the terminal device file. Setting COLUMNS and/or LINES

848

overrides the library's use of the screen size obtained from the

849

operating system.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

850

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

851

The COLUMNS and LINES variables may be specified independently. This

852

property is useful to circumvent misfeatures of legacy terminal type

853

descriptions; xterm(1) descriptions specifying 65 lines were once

854

notorious. For best results, avoid specifying cols and lines

855

capability codes in terminfo descriptions of terminal emulators.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

856

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

857

<A HREF="curs_util.3x.html">use_env(3x)</A> can disable use of the process environment in determining

858

the screen size. <A HREF="curs_util.3x.html">use_tioctl(3x)</A> can update COLUMNS and LINES to match

859

the screen size obtained from system calls or the terminal database.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

860

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

861

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

862

</PRE><H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>

863

For curses to distinguish the ESC character resulting from a user's

864

press of the "Escape" key on the input device from one beginning an

865

escape sequence (as commonly produced by function keys), it waits after

866

receiving the escape character to see if further characters are

867

available on the input stream within a short interval. A global

868

variable ESCDELAY stores this interval in milliseconds. The default

869

value of 1000 (one second) is adequate for most uses. This environment

870

variable overrides it.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

871

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

872

The most common instance where you may wish to change this value is to

873

work with a remote host over a slow communication channel. If the host

874

running a curses application does not receive the characters of an

875

escape sequence in a timely manner, the library can interpret them as

876

multiple key stroke events.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

877

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

878

xterm(1) mouse events are a form of escape sequence; therefore, if your

879

application makes heavy use of multiple-clicking, you may wish to

880

lengthen the default value because the delay applies to the composite

881

multi-click event as well as the individual clicks.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

882

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

883

Portable applications should not rely upon the presence of ESCDELAY in

884

either form, but setting the environment variable rather than the

885

global variable does not create problems when compiling an application.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

886

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

887

If <A HREF="curs_inopts.3x.html">keypad(3x)</A> is disabled for the curses window receiving input, a

888

program must disambiguate escape sequences itself.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

889

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

890

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

891

</PRE><H3><a name="h3-HOME">HOME</a></H3><PRE>

892

ncurses may read and write auxiliary terminal descriptions in .termcap

893

and .terminfo files in the user's home directory.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

894

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

895

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

896

</PRE><H3><a name="h3-LINES">LINES</a></H3><PRE>

897

This counterpart to COLUMNS specifies the height of the screen in

898

characters. The corresponding terminfo capability and code is lines.

899

See the description of the COLUMNS variable above.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

900

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

901

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

902

</PRE><H3><a name="h3-MOUSE_BUTTONS_123">MOUSE_BUTTONS_123</a></H3><PRE>

903

(OS/2 EMX port only) OS/2 numbers a three-button mouse inconsistently

904

with other platforms, such that 1 is the left button, 2 the right, and

905

3 the middle. This variable customizes the mouse button numbering.

906

Its value must be three digits 1-3 in any order. By default, ncurses

907

assumes a numbering of "132".

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

908

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

909

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

910

</PRE><H3><a name="h3-NCURSES_ASSUMED_COLORS">NCURSES_ASSUMED_COLORS</a></H3><PRE>

911

If set, this variable overrides the ncurses library's compiled-in

912

assumption that the terminal's default colors are white on black; see

913

<A HREF="default_colors.3x.html">default_colors(3x)</A>. Set the foreground and background color values

914

with this environment variable by assigning it two integer values

915

separated by a comma, indicating foregound and background color

916

numbers, respectively.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

917

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

918

For example, to tell ncurses not to assume anything about the colors,

919

use a value of "-1,-1". To make the default color scheme green on

920

black, use "2,0". ncurses accepts integral values from -1 up to the

921

value of the terminfo max_colors (colors) capability.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

922

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

923

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

924

</PRE><H3><a name="h3-NCURSES_CONSOLE2">NCURSES_CONSOLE2</a></H3><PRE>

925

(MinGW port only) The Console2 program defectively handles the

926

Microsoft Console API call CreateConsoleScreenBuffer. Applications

927

that use it will hang. However, it is possible to simulate the action

928

of this call by mapping coordinates, explicitly saving and restoring

929

the original screen contents. Setting the environment variable NCGDB

930

has the same effect.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

931

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

932

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

933

</PRE><H3><a name="h3-NCURSES_GPM_TERMS">NCURSES_GPM_TERMS</a></H3><PRE>

934

(Linux only) When ncurses is configured to use the GPM interface, this

935

variable may list one or more terminal names against which the TERM

936

variable (see below) is matched. An empty value disables the GPM

937

interface, using ncurses's built-in support for xterm(1) mouse

938

protocols instead. If the variable is absent, ncurses attempts to open

939

GPM if TERM contains "linux".

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

940

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

941

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

942

</PRE><H3><a name="h3-NCURSES_NO_HARD_TABS">NCURSES_NO_HARD_TABS</a></H3><PRE>

943

ncurses may use tab characters in cursor movement optimization. In

944

some cases, your terminal driver may not handle them properly. Set

945

this environment variable to any value to disable the feature. You can

946

also adjust your stty(1) settings to avoid the problem.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

947

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

948

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

949

</PRE><H3><a name="h3-NCURSES_NO_MAGIC_COOKIE">NCURSES_NO_MAGIC_COOKIE</a></H3><PRE>

950

Many terminals store video attributes as a property of a character

951

cell, as curses does. Historically, some recorded changes in video

952

attributes as data that logically occupies character cells on the

953

display, switching attributes on or off, similarly to tags in a markup

954

language; these are termed "magic cookies", and must be subsequently

955

overprinted. If the terminfo entry for your terminal type does not

956

adequately describe its handling of magic cookies, set this variable to

957

any value to instruct ncurses to disable attributes entirely.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

958

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

959

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

960

</PRE><H3><a name="h3-NCURSES_NO_PADDING">NCURSES_NO_PADDING</a></H3><PRE>

961

Most terminal type descriptions in the terminfo database detail

962

hardware devices. Many people use curses-based applications in

963

terminal emulator programs that run in a windowing environment. These

964

programs can duplicate all of the important features of a hardware

965

terminal, but often lack their limitations. Chief among these absent

966

drawbacks is the problem of data flow management; that is, limiting the

967

speed of communication to what the hardware could handle. Unless a

968

hardware terminal is interfaced into a terminal concentrator (which

969

does flow control), an application must manage flow control itself to

970

prevent overruns and data loss.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

971

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

972

A solution that comes at no hardware cost is for an application to

973

pause after directing a terminal to execute an operation that it

974

performs slowly, such as clearing the display. Many terminal type

975

descriptions, including that for the VT100, embed delay specifications

976

in capabilities. You may wish to use these terminal descriptions

977

without paying the performance penalty. Set NCURSES_NO_PADDING to any

978

value to disable all but mandatory padding. Mandatory padding is used

979

by such terminal capabilities as flash_screen (flash).

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

980

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

981

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

982

</PRE><H3><a name="h3-NCURSES_NO_SETBUF">NCURSES_NO_SETBUF</a></H3><PRE>

983

(Obsolete) Prior to internal changes developed in ncurses 5.9 (patches

984

20120825 through 20130126), the library used setbuf(3) to enable fully

985

buffered output when initializing the terminal. This was done, as in

986

SVr4 curses, to increase performance. For testing purposes, both of

987

ncurses and of certain applications, this feature was made optional.

988

Setting this variable disabled output buffering, leaving the output

989

stream in the original (usually line-buffered) mode.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

990

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

991

Nowadays, ncurses performs its own buffering and does not require this

992

workaround; it does not modify the buffering of the standard output

993

stream. This approach makes signal handling, as for interrupts, more

994

robust. A drawback is that certain unconventional programs mixed

995

stdio(3) calls with ncurses calls and (usually) got the behavior they

996

expected. This is no longer the case; ncurses does not write to the

997

standard output file descriptor through a stdio-buffered stream.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

998

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

999

As a special case, low-level API calls such as <A HREF="curs_terminfo.3x.html">putp(3x)</A> still use the

1000

standard output stream. High-level curses calls such as <A HREF="curs_printw.3x.html">printw(3x)</A> do

1001

not.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1002

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1003

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1004

</PRE><H3><a name="h3-NCURSES_NO_UTF8_ACS">NCURSES_NO_UTF8_ACS</a></H3><PRE>

1005

At initialization, ncurses inspects the TERM environment variable for

1006

special cases where VT100 forms-drawing characters (and the

1007

corresponding alternate character set terminfo capabilities) are known

1008

to be unsupported by terminal types that otherwise claim VT100

1009

compatibility. Specifically, when running in a UTF-8 locale, the Linux

1010

virtual console device and the GNU screen(1) program ignore them. Set

1011

this variable to a nonzero value to instruct ncurses that the

1012

terminal's ACS support is broken; the library then outputs Unicode code

1013

points that correspond to the forms-drawing characters. Set it to zero

1014

(or a non-integer) to disable the special check for terminal type names

1015

matching "linux" or "screen", directing ncurses to assume that the ACS

1016

feature works if the terminal type description advertises it.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1017

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1018

As an alternative to use of this variable, ncurses checks for an

1019

extended terminfo numeric capability U8 that can be compiled using "tic

1020

-x". Examples follow.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1021

1022

# linux console, if patched to provide working

1023

# VT100 shift-in/shift-out, with corresponding font.

1024

linux-vt100|linux console with VT100 line-graphics,

1025

U8#0, use=linux,

1026

1027

# uxterm with vt100Graphics resource set to false

1028

xterm-utf8|xterm relying on UTF-8 line-graphics,

1029

U8#1, use=xterm,

1030

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1031

The two-character name "U8" was chosen to permit its use via ncurses's

1032

termcap interface.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1033

1034

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1035

</PRE><H3><a name="h3-NCURSES_TRACE">NCURSES_TRACE</a></H3><PRE>

1036

At initialization, ncurses (in its debugging configuration) checks for

1037

this variable's presence. If defined with an integral value, the

1038

library calls <A HREF="curs_trace.3x.html">curses_trace(3x)</A> with that value as the argument.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1039

1040

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1041

</PRE><H3><a name="h3-TERM">TERM</a></H3><PRE>

1042

The TERM variable denotes the terminal type. Each is distinct, though

1043

many are similar. It is commonly set by terminal emulators to help

1044

applications find a workable terminal description. Some choose a

1045

popular approximation such as "ansi", "vt100", or "xterm" rather than

1046

an exact fit to their capabilities. Not infrequently, an application

1047

will have problems with that approach; for example, a key stroke may

1048

not operate correctly, or produce no effect but seeming garbage

1049

characters on the screen.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1050

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1051

Setting TERM has no effect on hardware operation; it affects the way

1052

applications communicate with the terminal. Likewise, as a general

1053

rule (xterm(1) being a rare exception), terminal emulators that allow

1054

you to specify TERM as a parameter or configuration value do not change

1055

their behavior to match that setting.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1056

1057

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1058

</PRE><H3><a name="h3-TERMCAP">TERMCAP</a></H3><PRE>

1059

If ncurses is configured with termcap support, it checks for a terminal

1060

type description in termcap format if one in terminfo format is not

1061

available. Setting this variable directs ncurses to ignore the usual

1062

termcap database location, /etc/termcap; see TERMPATH below. TERMCAP

1063

should contain either a terminal description (with newlines stripped

1064

out), or a file name indicating where the information required by the

1065

TERM environment variable is stored.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1066

1067

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1068

</PRE><H3><a name="h3-TERMINFO">TERMINFO</a></H3><PRE>

1069

ncurses can be configured to read terminal type description databases

1070

in various locations using different formats. This variable overrides

1071

the default location.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1072

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1073

o Descriptions in terminfo format are normally stored in a directory

1074

tree using subdirectories named by the common first letters of the

1075

terminal types named therein. This is the scheme used in System V.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1076

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1077

o If ncurses is configured to use hashed databases, then TERMINFO may

1078

name its location, such as /usr/share/terminfo.db, rather than

1079

/usr/share/terminfo/.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1080

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1081

The hashed database uses less disk space and is a little faster than

1082

the directory tree. However, some applications assume the existence of

1083

the directory tree, and read it directly rather than using the terminfo

1084

API.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1085

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1086

o If ncurses is configured with termcap support, this variable may

1087

contain the location of a termcap file.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1088

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1089

o If the value of TERMINFO begins with "hex:" or "b64:", ncurses uses

1090

the remainder of the value as a compiled terminfo description. You

1091

might produce the base64 format using <A HREF="infocmp.1m.html">infocmp(1m)</A>.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1092

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1093

TERMINFO=$(infocmp -0 -Q2 -q)

1094

export TERMINFO

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1095

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1096

The compiled description is used only if it corresponds to the

1097

terminal type identified by TERM.

1098

1099

Setting TERMINFO is the simplest, but not the only, way to direct

1100

ncurses to a terminal database. The search path is as follows.

1101

1102

o the last terminal database to which the running ncurses application

1103

wrote, if any

1104

1105

o the location specified by the TERMINFO environment variable

o $HOME/.terminfo

o locations listed in the TERMINFO_DIRS environment variable

1110

1111

o location(s) configured and compiled into ncurses

1112

1113

o /usr/share/terminfo

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1114

1115

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1116

</PRE><H3><a name="h3-TERMINFO_DIRS">TERMINFO_DIRS</a></H3><PRE>

1117

This variable specifies a list of locations, akin to PATH, in which

1118

ncurses searches for the terminal type descriptions described by

1119

TERMINFO above. The list items are separated by colons on Unix and

1120

semicolons on OS/2 EMX. System V terminfo lacks a corresponding

1121

feature; TERMINFO_DIRS is an ncurses extension.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1122

1123

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1124

</PRE><H3><a name="h3-TERMPATH">TERMPATH</a></H3><PRE>

1125

If TERMCAP does not hold a terminal type description or file name, then

1126

ncurses checks the contents of TERMPATH, a list of locations, akin to

1127

PATH, in which it searches for termcap terminal type descriptions. The

1128

list items are separated by colons on Unix and semicolons on OS/2 EMX.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1129

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1130

If both TERMCAP and TERMPATH are unset or invalid, ncurses searches for

1131

the files /etc/termcap, /usr/share/misc/termcap, and $HOME/.termcap, in

1132

that order.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1133

1134

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1135

</PRE><H2><a name="h2-ALTERNATE-CONFIGURATIONS">ALTERNATE CONFIGURATIONS</a></H2><PRE>

1136

Many different ncurses configurations are possible, determined by the

1137

options given to the configure script when building the library. Run

1138

the script with the --help option to peruse them all. A few are of

1139

particular significance to the application developer employing ncurses.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1140

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1141

--disable-overwrite

1142

The standard include for ncurses is as noted in SYNOPSIS:

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1143

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1144

#include <curses.h>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1145

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1146

This option is used to avoid filename conflicts when ncurses is

1147

not the main implementation of curses of the computer. If ncurses

1148

is installed disabling overwrite, it puts its headers in a

1149

subdirectory, e.g.,

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1150

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1151

#include <ncurses/curses.h>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1152

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1153

It also omits a symbolic link which would allow you to use

1154

-lcurses to build executables.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1155

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1156

--enable-widec

1157

The configure script renames the library and (if the

1158

--disable-overwrite option is used) puts the header files in a

1159

different subdirectory. All of the library names have a "w"

1160

appended to them, i.e., instead of

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1161

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1162

-lncurses

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

you link with

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1166

-lncursesw

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1167

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1168

You must also enable the wide-character features in the header

1169

file when compiling for the wide-character library to use the

1170

extended (wide-character) functions. The symbol which enables

1171

these features has changed since X/Open Curses, Issue 4:

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1172

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1173

o Originally, the wide-character feature required the symbol

1174

_XOPEN_SOURCE_EXTENDED but that was only valid for XPG4

1175

(1996).

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1176

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1177

o Later, that was deemed conflicting with _XOPEN_SOURCE defined

1178

to 500.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1179

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1180

o As of mid-2018, none of the features in this implementation

1181

require a _XOPEN_SOURCE feature greater than 600. However,

1182

X/Open Curses, Issue 7 (2009) recommends defining it to 700.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1183

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1184

o Alternatively, you can enable the feature by defining

1185

NCURSES_WIDECHAR with the caveat that some other header file

1186

than curses.h may require a specific value for _XOPEN_SOURCE

1187

(or a system-specific symbol).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1188

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1189

The curses.h header file installed for the wide-character library

1190

is designed to be compatible with the non-wide library's header.

1191

Only the size of the WINDOW structure differs; few applications

1192

require more than pointers to WINDOWs.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1193

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1194

If the headers are installed allowing overwrite, the wide-

1195

character library's headers should be installed last, to allow

1196

applications to be built using either library from the same set of

1197

headers.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1198

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1199

--with-pthread

1200

The configure script renames the library. All of the library

1201

names have a "t" appended to them (before any "w" added by

1202

--enable-widec).

1203

1204

The global variables such as LINES are replaced by macros to allow

1205

read-only access. At the same time, setter-functions are provided

1206

to set these values. Some applications (very few) may require

1207

changes to work with this convention.

--with-shared

--with-normal

--with-debug

--with-profile

The shared and normal (static) library names differ by their

1214

suffixes, e.g., libncurses.so and libncurses.a. The debug and

1215

profiling libraries add a "_g" and a "_p" to the root names

1216

respectively, e.g., libncurses_g.a and libncurses_p.a.

1217

1218

--with-termlib

1219

Low-level functions which do not depend upon whether the library

1220

supports wide-characters, are provided in the tinfo library.

1221

1222

By doing this, it is possible to share the tinfo library between

1223

wide/normal configurations as well as reduce the size of the

1224

library when only low-level functions are needed.

1225

1226

Those functions are described in these pages:

1227

1228

o <A HREF="curs_extend.3x.html">curs_extend(3x)</A> - miscellaneous curses extensions

1229

1230

o <A HREF="curs_inopts.3x.html">curs_inopts(3x)</A> - curses input options

1231

1232

o <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A> - low-level curses routines

1233

1234

o <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A> - curses environment query routines

1235

1236

o <A HREF="curs_termcap.3x.html">curs_termcap(3x)</A> - curses emulation of termcap

1237

1238

o <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A> - curses interface to terminfo database

1239

1240

o <A HREF="curs_util.3x.html">curs_util(3x)</A> - miscellaneous curses utility routines

1241

1242

--with-trace

1243

The trace function normally resides in the debug library, but it

1244

is sometimes useful to configure this in the shared library.

1245

Configure scripts should check for the function's existence rather

1246

than assuming it is always in the debug library.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1247

1248

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1249

</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>

1250

/usr/share/tabset

1251

tab stop initialization database

1252

1253

/usr/share/terminfo

1254

compiled terminal capability database

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1255

1256

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1257

</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>

1258

X/Open Curses permits most functions it specifies to be made available

1259

as macros as well. ncurses does so

1260

1261

o for functions that return values via their parameters,

1262

1263

o to support obsolete features,

1264

1265

o to reuse functions (for example, those that move the cursor before

1266

another operation), and

1267

1268

o a few special cases.

1269

1270

If the standard output file descriptor of an ncurses program is

1271

redirected to something that is not a terminal device, the library

1272

writes screen updates to the standard error file descriptor. This was

1273

an undocumented feature of SVr3 curses.

1274

1275

See subsection "Header Files" below regarding symbols exposed by

1276

inclusion of curses.h.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1277

1278

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1279

</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>

1280

ncurses enables an application to capture mouse events on certain

1281

terminals, including xterm(1); see <A HREF="curs_mouse.3x.html">curs_mouse(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1282

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1283

ncurses provides a means of responding to window resizing events, as

1284

when running in a GUI terminal emulator application such as xterm; see

1285

<A HREF="resizeterm.3x.html">resizeterm(3x)</A> and <A HREF="wresize.3x.html">wresize(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1286

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1287

ncurses allows an application to query the terminal for the presence of

1288

a wide variety of special keys; see <A HREF="curs_getch.3x.html">has_key(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1289

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1290

ncurses extends the fixed set of function key capabilities specified by

1291

X/Open Curses by allowing the application programmer to define

1292

additional key events at runtime; see <A HREF="define_key.3x.html">define_key(3x)</A>, <A HREF="key_defined.3x.html">key_defined(3x)</A>,

1293

<A HREF="keybound.3x.html">keybound(3x)</A>, and <A HREF="keyok.3x.html">keyok(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1294

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1295

ncurses can exploit the capabilities of terminals implementing

1296

ISO 6429/ECMA-48 SGR 39 and SGR 49 sequences, which allow an

1297

application to reset the terminal to its original foreground and

1298

background colors. From a user's perspective, the application is able

1299

to draw colored text on a background whose color is set independently,

1300

providing better control over color contrasts. See <A HREF="default_colors.3x.html">default_colors(3x)</A>.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1301

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1302

An ncurses application can eschew knowledge of WINDOW structure

1303

internals, instead using accessor functions such as <A HREF="curs_opaque.3x.html">is_scrollok(3x)</A>.

1304

1305

ncurses enables an application to direct application output to a

1306

printer attached to the terminal device; see <A HREF="curs_print.3x.html">curs_print(3x)</A>.

1307

1308

ncurses offers <A HREF="curs_slk.3x.html">slk_attr(3x)</A> as a counterpart of <A HREF="curs_attr.3x.html">attr_get(3x)</A> for soft-

1309

label key lines, and <A HREF="curs_slk.3x.html">extended_slk_color(3x)</A> as a form of <A HREF="curs_slk.3x.html">slk_color(3x)</A>

1310

that can gather color information from them when many colors are

1311

supported.

1312

1313

Some extensions are available only if ncurses permits modification of

1314

<A HREF="unctrl.3x.html">unctrl(3x)</A>'s behavior; see <A HREF="legacy_coding.3x.html">use_legacy_coding(3x)</A>. ncurses is compiled

1315

to support them; section "ALTERNATE CONFIGURATIONS" describes how.

1316

1317

o Rudimentary support for multi-threaded applications may be

1318

available; see <A HREF="curs_threads.3x.html">curs_threads(3x)</A>.

1319

1320

o Functions that ease the management of multiple screens can be

1321

exposed; see <A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A>.

1322

1323

o To aid applications to debug their memory usage, ncurses optionally

1324

offers functions to more aggressively free memory it dynamically

1325

allocates itself; see <A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A>.

1326

1327

o The library facilitates auditing and troubleshooting of its

1328

behavior; see <A HREF="curs_trace.3x.html">curs_trace(3x)</A>.

1329

1330

o The compiler option -DUSE_GETCAP causes the library to fall back to

1331

reading /etc/termcap if the terminal setup code cannot find a term-

1332

info entry corresponding to TERM. Use of this feature is not

1333

recommended, as it essentially includes an entire termcap compiler

1334

in the ncurses startup code, at a cost in memory usage and

1335

application launch latency.

1336

1337

PDCurses and NetBSD curses incorporate some ncurses extensions.

1338

Individual man pages indicate where this is the case.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1339

1340

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1341

</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

1342

X/Open Curses defines two levels of conformance, "base" and "enhanced".

1343

The latter includes several additional features, such as wide-character

1344

and color support. ncurses intends base-level conformance with X/Open

1345

Curses, and supports all features of its enhanced level except the

1346

untic utility.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1347

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1348

Differences between X/Open Curses and ncurses are documented in the

1349

"PORTABILITY" sections of applicable man pages.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1350

1351

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1352

</PRE><H3><a name="h3-Error-Checking">Error Checking</a></H3><PRE>

1353

In many cases, X/Open Curses is vague about error conditions, omitting

1354

some of the SVr4 documentation.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1355

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1356

Unlike other implementations, ncurses checks pointer parameters, such

1357

as those to WINDOW structures, to ensure that they are not null. This

1358

is done primarily to guard against programmer error. The standard

1359

interface does not provide a way for the library to tell an application

1360

which of several possible errors occurred. Relying on this (or some

1361

other) extension adversely affects the portability of curses

1362

applications.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1363

1364

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1365

</PRE><H3><a name="h3-Padding-Differences">Padding Differences</a></H3><PRE>

1366

In historical curses implementations, delays embedded in the terminfo

1367

capabilities carriage_return (cr), scroll_forward (ind), cursor_left

1368

(cub1), form_feed (ff), and tab (ht) activated corresponding delay bits

1369

in the Unix terminal driver. ncurses performs all padding by sending

1370

NUL bytes to the device. This method is slightly more expensive, but

1371

narrows the interface to the Unix kernel significantly and

1372

correspondingly increases the package's portability.

1373

1374

1375

</PRE><H3><a name="h3-Header-Files">Header Files</a></H3><PRE>

1376

The header file curses.h itself includes the header files stdio.h and

1377

unctrl.h.

1378

1379

X/Open Curses has more to say,

1380

1381

The inclusion of curses.h may make visible all symbols from the

1382

headers stdio.h, term.h, termios.h, and wchar.h.

1383

1384

but does not finish the story. A more complete account follows.

1385

1386

o Starting with 4BSD curses (1980) all implementations have provided

1387

a curses.h file.

1388

1389

BSD curses code included curses.h and unctrl.h from an internal

1390

header file curses.ext, where "ext" abbreviated "externs".

1391

1392

The implementations of printw and scanw used undocumented internal

1393

functions of the standard I/O library (_doprnt and _doscan), but

1394

nothing in curses.h itself relied upon stdio.h.

1395

1396

o SVr2 curses added newterm, which relies upon stdio.h because its

1397

function prototype employs the FILE type.

1398

1399

SVr4 curses added putwin and getwin, which also use stdio.h.

1400

1401

X/Open Curses specifies all three of these functions.

1402

1403

SVr4 curses and X/Open Curses do not require the developer to

1404

include stdio.h before curses.h. Both document use of curses as

1405

requiring only curses.h.

1406

1407

As a result, standard curses.h always includes stdio.h.

1408

1409

o X/Open Curses and SVr4 curses are inconsistent with respect to

1410

unctrl.h.

1411

1412

As noted in <A HREF="curs_util.3x.html">curs_util(3x)</A>, ncurses includes unctrl.h from curses.h

1413

(as SVr4 does).

1414

1415

o X/Open Curses's comments about term.h and termios.h may refer to

1416

HP-UX and AIX.

1417

1418

HP-UX curses includes term.h from curses.h to declare setupterm in

1419

curses.h, but ncurses and Solaris curses do not.

1420

1421

AIX curses includes term.h and termios.h. Again, ncurses and

1422

Solaris curses do not.

1423

1424

o X/Open Curses says that curses.h may include term.h, but does not

1425

require it to do so.

1426

1427

Some programs use functions declared in both curses.h and term.h,

1428

and must include both header files in the same module. Very old

1429

versions of AIX curses required inclusion of curses.h before

1430

term.h.

1431

1432

The header files supplied by ncurses include the standard library

1433

headers required for its declarations, so ncurses's own header

1434

files can be included in any order. But for portability, you

1435

should include curses.h before term.h.

1436

1437

o X/Open Curses says "may make visible" because including a header

1438

file does not necessarily make visible all of the symbols in it

1439

(consider #ifdef and similar).

1440

1441

For instance, ncurses's curses.h may include wchar.h if the proper

1442

symbol is defined, and if ncurses is configured for wide-character

1443

support. If wchar.h is included, its symbols may be made visible

1444

depending on the value of the _XOPEN_SOURCE feature test macro.

1445

1446

o X/Open Curses mandates an application's inclusion of one standard C

1447

library header in a special case: stdarg.h before curses.h to

1448

prototype the functions vw_printw and vw_scanw (as well as the

1449

obsolete vwprintw and vwscanw). Each of these takes a variadic

1450

argument list, a va_list parameter, like that of printf(3).

1451

1452

SVr3 curses introduced the two obsolete functions, and X/Open

1453

Curses the others. In between, SVr4 curses provided for the

1454

possibility that an application might include either varargs.h or

1455

stdarg.h. These represented contrasting approaches to handling

1456

variadic argument lists. The older interface, varargs.h, used a

1457

pointer to char for variadic functions' va_list parameter. Later,

1458

the list acquired its own standard data type, va_list, defined in

1459

stdarg.h, empowering the compiler to check the types of a function

1460

call's actual parameters against the formal ones declared in its

1461

prototype.

1462

1463

No conforming implementations of X/Open Curses require an

1464

application to include stdarg.h before curses.h because they either

1465

have allowed for a special type, or, like ncurses, they include

1466

stdarg.h themselves to provide a portable interface.

1467

1468

1469

</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>

1470

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

by Pavel Curtis.

</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

1475

<A HREF="curs_variables.3x.html">curs_variables(3x)</A>, <A HREF="terminfo.5.html">terminfo(5)</A>, <A HREF="user_caps.5.html">user_caps(5)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1479

ncurses 6.5 2024-04-27 <A HREF="ncurses.3x.html">ncurses(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

1480

</PRE>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

<ul>

<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

1485

<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

1486

<ul>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1487

<li><a href="#h3-Application-Structure">Application Structure</a></li>

1488

<li><a href="#h3-Overview">Overview</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1489

<li><a href="#h3-Initialization">Initialization</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1490

<li><a href="#h3-Naming-Conventions">Naming Conventions</a></li>

1491

<li><a href="#h3-Wide-and-Non-wide-Character-Configurations">Wide and Non-wide Character Configurations</a></li>

1492

<li><a href="#h3-Function-Name-Index">Function Name Index</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1493

</ul>

1494

</li>

1495

<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>

1496

<li><a href="#h2-ENVIRONMENT">ENVIRONMENT</a>

1497

<ul>

1498

<li><a href="#h3-BAUDRATE">BAUDRATE</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1499

<li><a href="#h3-CC-_command-character_">CC (command character)</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1500

<li><a href="#h3-COLUMNS">COLUMNS</a></li>

1501

<li><a href="#h3-ESCDELAY">ESCDELAY</a></li>

1502

1503

<li><a href="#h3-LINES">LINES</a></li>

1504

<li><a href="#h3-MOUSE_BUTTONS_123">MOUSE_BUTTONS_123</a></li>

1505

<li><a href="#h3-NCURSES_ASSUMED_COLORS">NCURSES_ASSUMED_COLORS</a></li>

1506

<li><a href="#h3-NCURSES_CONSOLE2">NCURSES_CONSOLE2</a></li>

1507

<li><a href="#h3-NCURSES_GPM_TERMS">NCURSES_GPM_TERMS</a></li>

1508

<li><a href="#h3-NCURSES_NO_HARD_TABS">NCURSES_NO_HARD_TABS</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1509

<li><a href="#h3-NCURSES_NO_MAGIC_COOKIE">NCURSES_NO_MAGIC_COOKIE</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1510

<li><a href="#h3-NCURSES_NO_PADDING">NCURSES_NO_PADDING</a></li>

1511

<li><a href="#h3-NCURSES_NO_SETBUF">NCURSES_NO_SETBUF</a></li>

1512

<li><a href="#h3-NCURSES_NO_UTF8_ACS">NCURSES_NO_UTF8_ACS</a></li>

1513

<li><a href="#h3-NCURSES_TRACE">NCURSES_TRACE</a></li>

1514

1515

<li><a href="#h3-TERMCAP">TERMCAP</a></li>

1516

<li><a href="#h3-TERMINFO">TERMINFO</a></li>

1517

<li><a href="#h3-TERMINFO_DIRS">TERMINFO_DIRS</a></li>

1518

<li><a href="#h3-TERMPATH">TERMPATH</a></li>

1519

</ul>

1520

</li>

1521

<li><a href="#h2-ALTERNATE-CONFIGURATIONS">ALTERNATE CONFIGURATIONS</a></li>

1522

<li><a href="#h2-FILES">FILES</a></li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1523

<li><a href="#h2-NOTES">NOTES</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1524

<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>

1525

<li><a href="#h2-PORTABILITY">PORTABILITY</a>

1526

<ul>

1527

<li><a href="#h3-Error-Checking">Error Checking</a></li>

1528

<li><a href="#h3-Padding-Differences">Padding Differences</a></li>

1529

<li><a href="#h3-Header-Files">Header Files</a></li>

1530

</ul>

1531

</li>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1532

<li><a href="#h2-AUTHORS">AUTHORS</a></li>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

1533

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

1534

</ul>

1535

</div>

Amit Daniel Kachhap