ncurses 5.3

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

diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index bb5c8ca6cfa3fe746e6e0c2c7d1266017cbfcff1..ee0ef0c00c309bcaca82edc4a1533da73f26a2b1 100644 (file)
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1999,2000 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1999-2000,2002 Free Software Foundation, Inc.              *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,57 +26,65 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_terminfo.3x,v 1.13 2000/07/01 20:07:34 tom Exp $
+.\" $Id: curs_terminfo.3x,v 1.16 2002/07/20 16:05:19 tom Exp $

 .TH curs_terminfo 3X ""
 .ds n 5
 .SH NAME
 .TH curs_terminfo 3X ""
 .ds n 5
 .SH NAME

-\fBsetupterm\fR,
-\fBsetterm\fR,
-\fBset_curterm\fR,

 \fBdel_curterm\fR,
 \fBdel_curterm\fR,

+\fBmvcur\fR,
+\fBputp\fR,

 \fBrestartterm\fR,
 \fBrestartterm\fR,

+\fBset_curterm\fR,
+\fBsetterm\fR,
+\fBsetupterm\fR,
+\fBtigetflag\fR,
+\fBtigetnum\fR,
+\fBtigetstr\fR,

 \fBtparm\fR,
 \fBtputs\fR,
 \fBtparm\fR,
 \fBtputs\fR,

-\fBputp\fR,
-\fBvidputs\fR,
+\fBvid_attr\fR,
+\fBvid_puts\fR,

 \fBvidattr\fR,
 \fBvidattr\fR,

-\fBmvcur\fR,
-\fBtigetflag\fR,
-\fBtigetnum\fR,
-\fBtigetstr\fR - \fBcurses\fR interfaces to terminfo database
+\fBvidputs\fR - \fBcurses\fR interfaces to terminfo database

 .SH SYNOPSIS
 .SH SYNOPSIS

+.nf

 \fB#include <curses.h>\fR
 .br
 \fB#include <term.h>\fR
 
 \fB#include <curses.h>\fR
 .br
 \fB#include <term.h>\fR
 

-\fBint setupterm(const char *term, int fildes, int *errret);\fR
+\fBint setupterm(char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR
+.br
+\fBint setterm(char *\fR\fIterm\fR\fB);\fR

 .br
 .br

-\fBint setterm(const char *term);\fR
+\fBTERMINAL *set_curterm(TERMINAL *\fR\fInterm\fR\fB);\fR

 .br
 .br

-\fBTERMINAL *set_curterm(TERMINAL *nterm);\fR
+\fBint del_curterm(TERMINAL *\fR\fIoterm\fR\fB);\fR

 .br
 .br

-\fBint del_curterm(TERMINAL *oterm);\fR
+\fBint restartterm(const char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR

 .br
 .br

-\fBint restartterm(const char *term, int fildes, int *errret);\fR
+\fBchar *tparm(char *\fR\fIstr\fR\fB, ...);\fR

 .br
 .br

-\fBchar *tparm(const char *str, ...);\fR
+\fBint tputs(const char *\fR\fIstr\fR\fB, int \fR\fIaffcnt\fR\fB, int (*\fR\fIputc\fR\fB)(int));\fR

 .br
 .br

-\fBint tputs(const char *str, int affcnt, int (*putc)(int));\fR
+\fBint putp(const char *\fR\fIstr\fR\fB);\fR

 .br
 .br

-\fBint putp(const char *str);\fR
+\fBint vidputs(chtype \fR\fIattrs\fR\fB, int (*\fR\fIputc\fR\fB)(int));\fR

 .br
 .br

-\fBint vidputs(chtype attrs, int (*putc)(char));\fR
+\fBint vidattr(chtype \fR\fIattrs\fR\fB);\fR

 .br
 .br

-\fBint vidattr(chtype attrs);\fR
+\fBint vid_puts(attr_t \fR\fIattrs\fR\fB, short \fR\fIpair\fR\fB, void *\fR\fIopts\fR\fB, int (*\fR\fIputc\fR\fB)(char));\fR

 .br
 .br

-\fBint mvcur(int oldrow, int oldcol, int newrow, int newcol);\fR
+\fBint vid_attr(attr_t \fR\fIattrs\fR\fB, short \fR\fIpair\fR\fB, void *\fR\fIopts\fR\fB);\fR

 .br
 .br

-\fBint tigetflag(const char *capname);\fR
+\fBint mvcur(int \fR\fIoldrow\fR\fB, int \fR\fIoldcol\fR\fB, int \fR\fInewrow\fR, int \fR\fInewcol\fR\fB);\fR

 .br
 .br

-\fBint tigetnum(const char *capname);\fR
+\fBint tigetflag(char *\fR\fIcapname\fR\fB);\fR

 .br
 .br

-\fBchar *tigetstr(const char *capname);\fR
+\fBint tigetnum(char *\fR\fIcapname\fR\fB);\fR

 .br
 .br

+\fBchar *tigetstr(char *\fR\fIcapname\fR\fB);\fR
+.br
+.fi

 .SH DESCRIPTION
 These low-level routines must be called by programs that have to deal
 directly with the \fBterminfo\fR database to handle certain terminal
 .SH DESCRIPTION
 These low-level routines must be called by programs that have to deal
 directly with the \fBterminfo\fR database to handle certain terminal


@@ -196,6 +204,17 @@ the \fBputchar\fR-like routine \fIputc\fR.
 The \fBvidattr\fR routine is like the \fBvidputs\fR routine, except
 that it outputs through \fBputchar\fR.
 
 The \fBvidattr\fR routine is like the \fBvidputs\fR routine, except
 that it outputs through \fBputchar\fR.
 

+The \fBvid_attr\fR and \fBvid_puts\fR routines correspond to vidattr and vidputs,
+respectively.
+They use a set of arguments for representing the video attributes plus color,
+i.e.,
+one of type attr_t for the attributes and one of short for
+the color_pair number.
+The \fBvid_attr\fR and \fBvid_puts\fR routines
+are designed to use the attribute constants with the \fIWA_\fR prefix.
+The opts argument is reserved for future use.
+Currently, applications must provide a null pointer for that argument.
+

 The \fBmvcur\fR routine provides low-level cursor motion.  It takes
 effect immediately (rather than at the next refresh).
 
 The \fBmvcur\fR routine provides low-level cursor motion.  It takes
 effect immediately (rather than at the next refresh).
 


@@ -253,6 +272,9 @@ In System V Release 4, the third argument of \fBtputs\fR has the type
 
 The XSI Curses standard prototypes \fBtparm\fR with a fixed number of parameters,
 rather than a variable argument list.
 
 The XSI Curses standard prototypes \fBtparm\fR with a fixed number of parameters,
 rather than a variable argument list.

+This implementation uses a variable argument list.
+Portable applications should provide 9 parameters after the format;
+zeroes are fine for this purpose.

 
 XSI notes that after calling \fBmvcur\fR, the curses state may not match the
 actual terminal state, and that an application should touch and refresh
 
 XSI notes that after calling \fBmvcur\fR, the curses state may not match the
 actual terminal state, and that an application should touch and refresh