<STRONG>int</STRONG> <STRONG>restartterm(const</STRONG> <STRONG>char</STRONG> <STRONG>*term,</STRONG> <STRONG>int</STRONG> <STRONG>fildes,</STRONG> <STRONG>int</STRONG>
<STRONG>*errret);</STRONG>
<STRONG>char</STRONG> <STRONG>*tparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>...);</STRONG>
- <STRONG>char</STRONG> <STRONG>*tparam(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>char</STRONG> <STRONG>*buffer,</STRONG> <STRONG>int</STRONG> <STRONG>size,</STRONG>
- <STRONG>...);</STRONG>
<STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>affcnt,</STRONG> <STRONG>int</STRONG> <STRONG>(*putc)(int));</STRONG>
<STRONG>int</STRONG> <STRONG>putp(const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
<STRONG>int</STRONG> <STRONG>vidputs(chtype</STRONG> <STRONG>attrs,</STRONG> <STRONG>int</STRONG> <STRONG>(*putc)(char));</STRONG>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- These low-level routines must be called by programs that
+ These low-level routines must be called by programs that
have to deal directly with the <STRONG>terminfo</STRONG> database to handle
- certain terminal capabilities, such as programming func-
- tion keys. For all other functionality, <STRONG>curses</STRONG> routines
+ certain terminal capabilities, such as programming func-
+ tion keys. For all other functionality, <STRONG>curses</STRONG> routines
are more suitable and their use is recommended.
- Initially, <STRONG>setupterm</STRONG> should be called. Note that
- <STRONG>setupterm</STRONG> is automatically called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
+ Initially, <STRONG>setupterm</STRONG> should be called. Note that
+ <STRONG>setupterm</STRONG> is automatically called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
This defines the set of terminal-dependent variables
[listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and
<STRONG>columns</STRONG> are initialized by <STRONG>setupterm</STRONG> as follows: If
- <STRONG>use_env(FALSE)</STRONG> has been called, values for <STRONG>lines</STRONG> and
+ <STRONG>use_env(FALSE)</STRONG> has been called, values for <STRONG>lines</STRONG> and
<STRONG>columns</STRONG> specified in <STRONG>terminfo</STRONG> are used. Otherwise, if the
- environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> exist, their val-
+ environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> exist, their val-
ues are used. If these environment variables do not exist
and the program is running in a window, the current window
- size is used. Otherwise, if the environment variables do
- not exist, the values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in
+ size is used. Otherwise, if the environment variables do
+ not exist, the values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in
the <STRONG>terminfo</STRONG> database are used.
- The header files <STRONG>curses.h</STRONG> and <STRONG>term.h</STRONG> should be included
- (in this order) to get the definitions for these strings,
+ The header files <STRONG>curses.h</STRONG> and <STRONG>term.h</STRONG> should be included
+ (in this order) to get the definitions for these strings,
numbers, and flags. Parameterized strings should be
- passed through <STRONG>tparm</STRONG> to instantiate them. All <STRONG>terminfo</STRONG>
- the tty modes before exiting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3X)</A></STRONG>]. Pro-
- grams which use cursor addressing should output
- <STRONG>enter_ca_mode</STRONG> upon startup and should output <STRONG>exit_ca_mode</STRONG>
- before exiting. Programs desiring shell escapes should
+ passed through <STRONG>tparm</STRONG> to instantiate them. All <STRONG>terminfo</STRONG>
+ strings [including the output of <STRONG>tparm</STRONG>] should be printed
+ with <STRONG>tputs</STRONG> or <STRONG>putp</STRONG>. Call the <STRONG>reset_shell_mode</STRONG> to restore
+ <STRONG>enter_ca_mode</STRONG> upon startup and should output <STRONG>exit_ca_mode</STRONG>
+ before exiting. Programs desiring shell escapes should
call
- <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the shell
- is called and should output <STRONG>enter_ca_mode</STRONG> and call
+ <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the shell
+ is called and should output <STRONG>enter_ca_mode</STRONG> and call
<STRONG>reset_prog_mode</STRONG> after returning from the shell.
The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, ini-
tializing the <STRONG>terminfo</STRONG> structures, but does not set up the
output virtualization structures used by <STRONG>curses</STRONG>. The ter-
- minal type is the character string <EM>term</EM>; if <EM>term</EM> is null,
- the environment variable <STRONG>TERM</STRONG> is used. All output is to
- file descriptor <STRONG>fildes</STRONG> which is initialized for output.
- If <EM>errret</EM> is not null, then <STRONG>setupterm</STRONG> returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>
- and stores a status value in the integer pointed to by
- <EM>errret</EM>. A status of <STRONG>1</STRONG> in <EM>errret</EM> is normal, <STRONG>0</STRONG> means that
- the terminal could not be found, and <STRONG>-1</STRONG> means that the
- <STRONG>terminfo</STRONG> database could not be found. If <EM>errret</EM> is null,
- <STRONG>setupterm</STRONG> prints an error message upon finding an error
+ minal type is the character string <EM>term</EM>; if <EM>term</EM> is null,
+ the environment variable <STRONG>TERM</STRONG> is used. All output is to
+ file descriptor <STRONG>fildes</STRONG> which is initialized for output.
+ If <EM>errret</EM> is not null, then <STRONG>setupterm</STRONG> returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>
+ and stores a status value in the integer pointed to by
+ <EM>errret</EM>. A status of <STRONG>1</STRONG> in <EM>errret</EM> is normal, <STRONG>0</STRONG> means that
+ the terminal could not be found, and <STRONG>-1</STRONG> means that the
+ <STRONG>terminfo</STRONG> database could not be found. If <EM>errret</EM> is null,
+ <STRONG>setupterm</STRONG> prints an error message upon finding an error
and exits. Thus, the simplest call is:
<STRONG>setupterm((char</STRONG> <STRONG>*)0,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0);</STRONG>,
- which uses all the defaults and sends the output to <STRONG>std-</STRONG>
+ which uses all the defaults and sends the output to <STRONG>std-</STRONG>
<STRONG>out</STRONG>.
- The <STRONG>setterm</STRONG> routine is being replaced by <STRONG>setupterm</STRONG>. The
+ The <STRONG>setterm</STRONG> routine is being replaced by <STRONG>setupterm</STRONG>. The
call:
<STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG>
- provides the same functionality as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>. The
- <STRONG>setterm</STRONG> routine is included here for BSD compatibility,
+ provides the same functionality as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>. The
+ <STRONG>setterm</STRONG> routine is included here for BSD compatibility,
and is not recommended for new programs.
- The <STRONG>set_curterm</STRONG> routine sets the variable <STRONG>cur_term</STRONG> to
+ The <STRONG>set_curterm</STRONG> routine sets the variable <STRONG>cur_term</STRONG> to
<EM>nterm</EM>, and makes all of the <STRONG>terminfo</STRONG> boolean, numeric, and
- string variables use the values from <EM>nterm</EM>. It returns
+ string variables use the values from <EM>nterm</EM>. It returns
the old value of <STRONG>cur_term</STRONG>.
- The <STRONG>del_curterm</STRONG> routine frees the space pointed to by
+ The <STRONG>del_curterm</STRONG> routine frees the space pointed to by
<EM>oterm</EM> and makes it available for further use. If <EM>oterm</EM> is
- the same as <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG>
- boolean, numeric, and string variables thereafter may
- refer to invalid memory locations until another <STRONG>setupterm</STRONG>
+ the same as <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG>
+ boolean, numeric, and string variables thereafter may
+ refer to invalid memory locations until another <STRONG>setupterm</STRONG>
has been called.
The <STRONG>restartterm</STRONG> routine is similar to <STRONG>setupterm</STRONG> and
- <STRONG>initscr</STRONG>, except that it is called after restoring memory
- and the input and output options are the same as when mem-
- ory was saved, but the terminal type and baud rate may be
- different. Accordingly, it saves various tty state bits,
- does a setupterm, and then restores the bits.
+ <STRONG>initscr</STRONG>, except that it is called after restoring memory
+ to a previous state (for example, when reloading a game
+ saved as a core image dump). It assumes that the windows
+ be different. Accordingly, it saves various tty state
+ bits, does a setupterm, and then restores the bits.
The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame-
- ters <EM>pi</EM>. A pointer is returned to the result of <EM>str</EM> with
+ ters <EM>pi</EM>. A pointer is returned to the result of <EM>str</EM> with
the parameters applied.
- The <STRONG>tparam</STRONG> routine is included for compatibility with the
- GNU termcap implementation. It works like <STRONG>tparm</STRONG> but you
- specify a buffer and buffer size to be filled with the
- expanded string.
-
The <STRONG>tputs</STRONG> routine applies padding information to the
string <EM>str</EM> and outputs it. The <EM>str</EM> must be a terminfo
string variable or the return value from <STRONG>tparm</STRONG>, <STRONG>tgetstr</STRONG>,
The <EM>capname</EM> for each capability is given in the table col-
umn entitled <EM>capname</EM> code in the capabilities section of
+ <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
+
+ <STRONG>char</STRONG> <STRONG>*boolnames</STRONG>, <STRONG>*boolcodes</STRONG>, <STRONG>*boolfnames</STRONG>
<STRONG>char</STRONG> <STRONG>*numnames</STRONG>, <STRONG>*numcodes</STRONG>, <STRONG>*numfnames</STRONG>
<STRONG>char</STRONG> <STRONG>*strnames</STRONG>, <STRONG>*strcodes</STRONG>, <STRONG>*strfnames</STRONG>
-
- These null-terminated arrays contain the <EM>capnames</EM>, the
<STRONG>termcap</STRONG> codes, and the full C names, for each of the <STRONG>ter-</STRONG>
<STRONG>minfo</STRONG> variables.
+
+
+
+
+
+
</PRE>
</BODY>
</HTML>
projects / ncurses.git / blobdiff