X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_terminfo.3x.html;h=14361b3298a9186161ad32c5ef844185e109eb20;hp=4163fbb781f651839b57f4ac67088b8d811a62b0;hb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html index 4163fbb7..14361b32 100644 --- a/doc/html/man/curs_terminfo.3x.html +++ b/doc/html/man/curs_terminfo.3x.html @@ -1,7 +1,7 @@
@@ -40,12 +40,16 @@+curs_terminfo(3x) curs_terminfo(3x) + + +
- del_curterm, mvcur, putp, restartterm, set_curterm, set- - term, setupterm, tigetflag, tigetnum, tigetstr, tparm, - tputs, vid_attr, vid_puts, vidattr, vidputs - curses + del_curterm, mvcur, putp, restartterm, set_curterm, + setterm, setupterm, tigetflag, tigetnum, tigetstr, tparm, + tputs, vid_attr, vid_puts, vidattr, vidputs - curses interfaces to terminfo database @@ -80,8 +84,8 @@ tion keys. For all other functionality, curses routines are more suitable and their use is recommended. - Initially, setupterm should be called. Note that - setupterm is automatically called by initscr and newterm. + Initially, setupterm should be called. Note that se- + tupterm is automatically called by initscr and newterm. This defines the set of terminal-dependent variables [listed in terminfo(5)]. The terminfo variables lines and columns are initialized by setupterm as follows: If @@ -101,14 +105,14 @@ strings [including the output of tparm] should be printed with tputs or putp. Call the reset_shell_mode to restore the tty modes before exiting [see curs_kernel(3x)]. Pro- - grams which use cursor addressing should output - enter_ca_mode upon startup and should output exit_ca_mode + grams which use cursor addressing should output en- + ter_ca_mode upon startup and should output exit_ca_mode before exiting. Programs desiring shell escapes should call reset_shell_mode and output exit_ca_mode before the shell - is called and should output enter_ca_mode and call - reset_prog_mode after returning from the shell. + is called and should output enter_ca_mode and call re- + set_prog_mode after returning from the shell. The setupterm routine reads in the terminfo database, ini- tializing the terminfo structures, but does not set up the @@ -117,8 +121,8 @@ the environment variable TERM is used. All output is to file descriptor fildes which is initialized for output. If errret is not null, then setupterm returns OK or ERR - and stores a status value in the integer pointed to by - errret. A return value of OK combined with status of 1 in + and stores a status value in the integer pointed to by er- + rret. A return value of OK combined with status of 1 in errret is normal. If ERR is returned, examine errret: 1 means that the terminal is hardcopy, cannot be @@ -156,8 +160,8 @@ The del_curterm routine frees the space pointed to by oterm and makes it available for further use. If oterm is the same as cur_term, references to any of the terminfo - boolean, numeric, and string variables thereafter may - refer to invalid memory locations until another setupterm + boolean, numeric, and string variables thereafter may re- + fer to invalid memory locations until another setupterm has been called. The restartterm routine is similar to setupterm and @@ -203,20 +207,20 @@ that argument. The mvcur routine provides low-level cursor motion. It - takes effect immediately (rather than at the next - refresh). + takes effect immediately (rather than at the next re- + fresh). The tigetflag, tigetnum and tigetstr routines return the - value of the capability corresponding to the terminfo - capname passed to them, such as xenl. + value of the capability corresponding to the terminfo cap- + name passed to them, such as xenl. The tigetflag routine returns the value -1 if capname is not a boolean capability, or 0 if it is canceled or absent from the terminal description. The tigetnum routine returns the value -2 if capname is - not a numeric capability, or -1 if it is canceled or - absent from the terminal description. + not a numeric capability, or -1 if it is canceled or ab- + sent from the terminal description. The tigetstr routine returns the value (char *)-1 if cap- name is not a string capability, or 0 if it is canceled or @@ -246,6 +250,23 @@ Routines that return pointers always return NULL on error. + X/Open defines no error conditions. In this implementa- + tion + + del_curterm + returns an error if its terminal parameter is + null. + + restartterm + returns an error if the associated call to se- + tupterm returns an error. + + setupterm + returns an error if it cannot allocate enough + memory, or create the initial windows (stdscr, + curscr, newscr). Other error conditions are + documented above. +
@@ -293,37 +314,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + curs_terminfo(3x)