X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_terminfo.3x;h=5af0b8fbe27c6bfdfe8808cf28ff13b0a2dfebf4;hp=d5c9bf68275baddcdde584601f7995ccbda17e4a;hb=a21e1b511e3c79ea7c4786f6b0e48850e7fa94f0;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x index d5c9bf68..5af0b8fb 100644 --- a/man/curs_terminfo.3x +++ b/man/curs_terminfo.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1999-2002,2003 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2006,2007 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 * @@ -26,9 +26,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_terminfo.3x,v 1.18 2003/12/27 18:48:59 tom Exp $ +.\" $Id: curs_terminfo.3x,v 1.28 2007/05/26 20:09:06 tom Exp $ .TH curs_terminfo 3X "" .ds n 5 +.na +.hy 0 .SH NAME \fBdel_curterm\fR, \fBmvcur\fR, @@ -46,6 +48,8 @@ \fBvid_puts\fR, \fBvidattr\fR, \fBvidputs\fR - \fBcurses\fR interfaces to terminfo database +.ad +.hy .SH SYNOPSIS .nf \fB#include \fR @@ -60,7 +64,7 @@ .br \fBint del_curterm(TERMINAL *\fR\fIoterm\fR\fB);\fR .br -\fBint restartterm(const char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR +\fBint restartterm(char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR .br \fBchar *tparm(char *\fR\fIstr\fR\fB, ...);\fR .br @@ -95,16 +99,22 @@ recommended. Initially, \fBsetupterm\fR should be called. Note that \fBsetupterm\fR is automatically called by \fBinitscr\fR and \fBnewterm\fR. This defines the set of terminal-dependent variables -[listed in \fBterminfo\fR(\*n)]. The \fBterminfo\fR variables +[listed in \fBterminfo\fR(\*n)]. +The \fBterminfo\fR variables \fBlines\fR and \fBcolumns\fR are initialized by \fBsetupterm\fR as -follows: If \fBuse_env(FALSE)\fR has been called, values for +follows: +.RS +.PP +If \fBuse_env(FALSE)\fR has been called, values for \fBlines\fR and \fBcolumns\fR specified in \fBterminfo\fR are used. +.PP Otherwise, if the environment variables \fBLINES\fR and \fBCOLUMNS\fR exist, their values 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 \fBlines\fR and \fBcolumns\fR specified in the \fBterminfo\fR database are used. +.RE .PP The header files \fBcurses.h\fR and \fBterm.h\fR should be included (in this order) to get the definitions for these strings, numbers, and flags. @@ -150,15 +160,15 @@ means that the \fBterminfo\fR database could not be found. If \fIerrret\fR is null, \fBsetupterm\fR prints an error message upon finding an error and exits. Thus, the simplest call is: - +.sp \fBsetupterm((char *)0, 1, (int *)0);\fR, - +.sp which uses all the defaults and sends the output to \fBstdout\fR. .PP The \fBsetterm\fR routine is being replaced by \fBsetupterm\fR. The call: - +.sp \fBsetupterm(\fR\fIterm\fR\fB, 1, (int *)0)\fR - +.sp provides the same functionality as \fBsetterm(\fR\fIterm\fR\fB)\fR. The \fBsetterm\fR routine is included here for BSD compatibility, and is not recommended for new programs. @@ -179,7 +189,8 @@ 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 and the input and output options are the same as when memory 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. +it saves various tty state bits, calls \fBsetupterm\fP, +and then restores the bits. .PP The \fBtparm\fR routine instantiates the string \fIstr\fR with parameters \fIpi\fR. A pointer is returned to the result of \fIstr\fR @@ -236,13 +247,15 @@ or \fB0\fR if it is canceled or absent from the terminal description. .PP The \fIcapname\fR for each capability is given in the table column entitled \fIcapname\fR code in the capabilities section of \fBterminfo\fR(\*n). - -\fBchar *boolnames\fR, \fB*boolcodes\fR, \fB*boolfnames\fR - -\fBchar *numnames\fR, \fB*numcodes\fR, \fB*numfnames\fR - -\fBchar *strnames\fR, \fB*strcodes\fR, \fB*strfnames\fR - +.sp +.RS +\fBchar *boolnames[]\fR, \fB*boolcodes[]\fR, \fB*boolfnames[]\fR +.sp +\fBchar *numnames[]\fR, \fB*numcodes[]\fR, \fB*numfnames[]\fR +.sp +\fBchar *strnames[]\fR, \fB*strcodes[]\fR, \fB*strfnames[]\fR +.RE +.PP These null-terminated arrays contain the \fIcapnames\fR, the \fBtermcap\fR codes, and the full C names, for each of the \fBterminfo\fR variables. @@ -252,6 +265,25 @@ Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR completion, unless otherwise noted in the preceding routine descriptions. .PP Routines that return pointers always return \fBNULL\fR on error. +.PP +X/Open defines no error conditions. +In this implementation +.RS +.TP 5 +\fBdel_curterm\fP +returns an error +if its terminal parameter is null. +.TP 5 +\fBrestartterm\fP +returns an error +if the associated call to \fBsetupterm\fP returns an error. +.TP 5 +\fBsetupterm\fP +returns an error +if it cannot allocate enough memory, or +create the initial windows (stdscr, curscr, newscr). +Other error conditions are documented above. +.RE .SH NOTES The \fBsetupterm\fR routine should be used in place of \fBsetterm\fR. It may be useful when you want to test for terminal capabilities without @@ -263,6 +295,9 @@ The function \fBsetterm\fR is not described in the XSI Curses standard and must be considered non-portable. All other functions are as described in the XSI curses standard. .PP +\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP. +This is not part of X/Open Curses, but is assumed by some applications. +.PP In System V Release 4, \fBset_curterm\fR has an \fBint\fR return type and returns \fBOK\fR or \fBERR\fR. We have chosen to implement the XSI Curses semantics. @@ -283,9 +318,16 @@ Both ncurses and System V Release 4 curses implement \fBmvcur\fR using the SCREEN data allocated in either \fBinitscr\fR or \fBnewterm\fR. So though it is documented as a terminfo function, \fBmvcur\fR is really a curses function which is not well specified. +.PP +XSI states that the old location must be given for \fBmvcur\fP. +This implementation allows the caller to use -1's for the old ordinates. +In that case, the old location is unknown. +.PP +Extended terminal capability names, e.g., as defined by \fBtic\ -x\fP, +are not stored in the arrays described in this section. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_termcap\fR(3X), -\fBputc\fR(3S), \fBterminfo\fR(\*n) +\fBputc\fR(3), \fBterminfo\fR(\*n) .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: