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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame^]

1

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">

2

<!--

3

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

4

5

* *

6

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

7

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

8

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

9

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

10

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

11

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

12

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

13

* *

14

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

15

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

16

* *

17

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

18

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

19

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

20

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

21

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

22

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

23

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

24

* *

25

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

26

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

27

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

28

* authorization. *

29

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

30

* @Id: curs_initscr.3x,v 1.14 2005/05/15 16:18:01 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_initscr 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_initscr 3x</H1>

40

<HR>

41

<PRE>

42

43

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

</PRE>

initscr, newterm, endwin, isendwin, set_term, delscreen -

51

curses screen initialization and manipulation routines

</PRE>

<H2>SYNOPSIS</H2><PRE>

56

#include <curses.h>

57

58

WINDOW *initscr(void);

59

int endwin(void);

60

bool isendwin(void);

61

SCREEN *newterm(char *type, FILE *outfd, FILE *infd);

62

SCREEN *set_term(SCREEN *new);

63

void delscreen(SCREEN* sp);

</PRE>

<H2>DESCRIPTION</H2><PRE>

68

initscr is normally the first curses routine to call when

69

initializing a program. A few special routines sometimes

70

need to be called before it; these are slk_init, filter,

71

ripoffline, use_env. For multiple-terminal applications,

72

newterm may be called before initscr.

73

74

The initscr code determines the terminal type and initial-

75

izes all curses data structures. initscr also causes the

76

first call to refresh to clear the screen. If errors oc-

77

cur, initscr writes an appropriate error message to stan-

78

dard error and exits; otherwise, a pointer is returned to

79

stdscr.

80

81

A program that outputs to more than one terminal should

82

use the newterm routine for each terminal instead of

83

initscr. A program that needs to inspect capabilities, so

84

it can continue to run in a line-oriented mode if the ter-

85

minal cannot support a screen-oriented program, would also

86

use newterm. The routine newterm should be called once

87

for each terminal. It returns a variable of type SCREEN *

88

which should be saved as a reference to that terminal.

89

The arguments are the type of the terminal to be used in

90

place of $TERM, a file pointer for output to the terminal,

91

and another file pointer for input from the terminal (if

92

type is NULL, $TERM will be used). The program must also

93

call endwin for each terminal being used before exiting

94

from curses. If newterm is called more than once for the

95

same terminal, the first terminal referred to must be the

96

last one for which endwin is called.

97

98

A program should always call endwin before exiting or es-

99

caping from curses mode temporarily. This routine re-

100

stores tty modes, moves the cursor to the lower left-hand

101

corner of the screen and resets the terminal into the

102

proper non-visual mode. Calling refresh or doupdate after

103

a temporary escape causes the program to resume visual

104

mode.

105

106

The isendwin routine returns TRUE if endwin has been

107

called without any subsequent calls to wrefresh, and FALSE

108

otherwise.

109

110

The set_term routine is used to switch between different

111

terminals. The screen reference new becomes the new cur-

112

rent terminal. The previous terminal is returned by the

113

routine. This is the only routine which manipulates

114

SCREEN pointers; all other routines affect only the cur-

115

rent terminal.

116

117

The delscreen routine frees storage associated with the

118

SCREEN data structure. The endwin routine does not do

119

this, so delscreen should be called after endwin if a par-

120

ticular SCREEN is no longer needed.

</PRE>

<H2>RETURN VALUE</H2><PRE>

125

endwin returns the integer ERR upon failure and OK upon

126

successful completion.

127

128

Routines that return pointers always return NULL on error.

129

130

X/Open defines no error conditions. In this implementa-

131

tion endwin returns an error if the terminal was not ini-

tialized.

</PRE>

<H2>NOTES</H2><PRE>

Note that initscr and newterm may be macros.

</PRE>

<H2>PORTABILITY</H2><PRE>

142

These functions are described in the XSI Curses standard,

143

Issue 4. It specifies that portable applications must not

144

call initscr more than once.

145

146

Old versions of curses, e.g., BSD 4.4, may have returned a

147

null pointer from initscr when an error is detected,

148

rather than exiting. It is safe but redundant to check

149

the return value of initscr in XSI Curses.

</PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_kernel.3x.html">curs_kernel(3x)</A>, <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>,

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

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>