X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inopts.3x;h=7b5a17b8f1256364f6e3ceaa97be2ec8e2be6c46;hp=c129ae194ca35db032a5434e39b38ffa5f211c72;hb=40cf934fff2d2790c060619e3a29bd54c20994b0;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x index c129ae19..7b5a17b8 100644 --- a/man/curs_inopts.3x +++ b/man/curs_inopts.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2001 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2003,2005 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,17 +26,33 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inopts.3x,v 1.9 2002/08/10 22:29:49 tom Exp $ +.\" $Id: curs_inopts.3x,v 1.13 2005/05/15 16:18:07 tom Exp $ .TH curs_inopts 3X "" +.na +.hy 0 .SH NAME -\fBcbreak\fR, \fBnocbreak\fR, \fBecho\fR, -\fBnoecho\fR, \fBhalfdelay\fR, \fBintrflush\fR, \fBkeypad\fR, -\fBmeta\fR, \fBnodelay\fR, \fBnotimeout\fR, \fBraw\fR, \fBnoraw\fR, -\fBnoqiflush\fR, \fBqiflush\fR, \fBtimeout\fR, \fBwtimeout\fR, +\fBcbreak\fR, +\fBnocbreak\fR, +\fBecho\fR, +\fBnoecho\fR, +\fBhalfdelay\fR, +\fBintrflush\fR, +\fBkeypad\fR, +\fBmeta\fR, +\fBnodelay\fR, +\fBnotimeout\fR, +\fBraw\fR, +\fBnoraw\fR, +\fBnoqiflush\fR, +\fBqiflush\fR, +\fBtimeout\fR, +\fBwtimeout\fR, \fBtypeahead\fR - \fBcurses\fR input options +.ad +.hy .SH SYNOPSIS \fB#include \fR - +.PP \fBint cbreak(void);\fR .br \fBint nocbreak(void);\fR @@ -78,14 +94,14 @@ erase/kill character-processing (interrupt and flow control characters are unaffected), making characters typed by the user immediately available to the program. The \fBnocbreak\fR routine returns the terminal to normal (cooked) mode. - +.PP Initially the terminal may or may not be in \fBcbreak\fR mode, as the mode is inherited; therefore, a program should call \fBcbreak\fR or \fBnocbreak\fR explicitly. Most interactive programs using \fBcurses\fR set the \fBcbreak\fR mode. Note that \fBcbreak\fR overrides \fBraw\fR. [See \fBcurs_getch\fR(3X) for a discussion of how these routines interact with \fBecho\fR and \fBnoecho\fR.] - +.PP The \fBecho\fR and \fBnoecho\fR routines control whether characters typed by the user are echoed by \fBgetch\fR as they are typed. Echoing by the tty driver is always disabled, but initially \fBgetch\fR is in echo mode, so @@ -95,14 +111,14 @@ they disable echoing by calling \fBnoecho\fR. [See \fBcurs_getch\fR(3X) for a discussion of how these routines interact with \fBcbreak\fR and \fBnocbreak\fR.] - +.PP The \fBhalfdelay\fR routine is used for half-delay mode, which is similar to \fBcbreak\fR mode in that characters typed by the user are immediately available to the program. However, after blocking for \fItenths\fR tenths of seconds, ERR is returned if nothing has been typed. The value of \fBtenths\fR must be a number between 1 and 255. Use \fBnocbreak\fR to leave half-delay mode. - +.PP If the \fBintrflush\fR option is enabled, (\fIbf\fR is \fBTRUE\fR), when an interrupt key is pressed on the keyboard (interrupt, break, quit) all output in the tty driver queue will be flushed, giving the effect of faster response to @@ -110,7 +126,7 @@ the interrupt, but causing \fBcurses\fR to have the wrong idea of what is on the screen. Disabling (\fIbf\fR is \fBFALSE\fR), the option prevents the flush. The default for the option is inherited from the tty driver settings. The window argument is ignored. - +.PP The \fBkeypad\fR option enables the keypad of the user's terminal. If enabled (\fIbf\fR is \fBTRUE\fR), the user can press a function key (such as an arrow key) and \fBwgetch\fR returns a single value @@ -121,7 +137,7 @@ itself. If the keypad in the terminal can be turned on (made to transmit) and off (made to work locally), turning on this option causes the terminal keypad to be turned on when \fBwgetch\fR is called. The default value for keypad is false. - +.PP Initially, whether the terminal returns 7 or 8 significant bits on input depends on the control mode of the tty driver [see termio(7)]. To force 8 bits to be returned, invoke \fBmeta\fR(\fIwin\fR, @@ -134,17 +150,17 @@ to setting the CS7 flag on the terminal. The window argument, \fBsmm\fR is sent to the terminal when \fBmeta\fR(\fIwin\fR, \fBTRUE\fR) is called and \fBrmm\fR is sent when \fBmeta\fR(\fIwin\fR, \fBFALSE\fR) is called. - +.PP The \fBnodelay\fR option causes \fBgetch\fR to be a non-blocking call. If no input is ready, \fBgetch\fR returns \fBERR\fR. If disabled (\fIbf\fR is \fBFALSE\fR), \fBgetch\fR waits until a key is pressed. - +.PP While interpreting an input escape sequence, \fBwgetch\fR sets a timer while waiting for the next character. If \fBnotimeout(\fR\fIwin\fR, \fBTRUE\fR) is called, then \fBwgetch\fR does not set a timer. The purpose of the timeout is to differentiate between sequences received from a function key and those typed by a user. - +.PP The \fBraw\fR and \fBnoraw\fR routines place the terminal into or out of raw mode. Raw mode is similar to \fBcbreak\fR mode, in that characters typed are immediately passed through to the user program. The differences are that in @@ -152,7 +168,7 @@ raw mode, the interrupt, quit, suspend, and flow control characters are all passed through uninterpreted, instead of generating a signal. The behavior of the BREAK key depends on other bits in the tty driver that are not set by \fBcurses\fR. - +.PP When the \fBnoqiflush\fR routine is used, normal flush of input and output queues associated with the \fBINTR\fR, \fBQUIT\fR and \fBSUSP\fR characters will not be done [see termio(7)]. When @@ -160,18 +176,18 @@ output queues associated with the \fBINTR\fR, \fBQUIT\fR and characters are read. You may want to call \fBnoqiflush()\fR in a signal handler if you want output to continue as though the interrupt had not occurred, after the handler exits. - +.PP The \fBtimeout\fR and \fBwtimeout\fR routines set blocking or non-blocking read for a given window. If \fIdelay\fR is negative, -blocking read is used (\fIi\fR.\fIe\fR., waits indefinitely for +blocking read is used (i.e., waits indefinitely for input). If \fIdelay\fR is zero, then non-blocking read is used -(\fIi\fR.\fIe\fR., read returns \fBERR\fR if no input is waiting). If +(i.e., read returns \fBERR\fR if no input is waiting). If \fIdelay\fR is positive, then read blocks for \fIdelay\fR milliseconds, and returns \fBERR\fR if there is still no input. Hence, these routines provide the same functionality as \fBnodelay\fR, plus the additional capability of being able to block for only \fIdelay\fR milliseconds (where \fIdelay\fR is positive). - +.PP The \fBcurses\fR library does ``line-breakout optimization'' by looking for typeahead periodically while updating the screen. If input is found, and it is coming from a tty, the current update is postponed until @@ -186,20 +202,32 @@ The \fBtypeahead\fR routine specifies that the file descriptor All routines that return an integer return \fBERR\fR upon failure and OK (SVr4 specifies only "an integer value other than \fBERR\fR") upon successful completion, unless otherwise noted in the preceding routine descriptions. +.PP +X/Open does not define any error conditions. +In this implementation, +functions with a window parameter will return an error if it is null. +Any function will also return an error if the terminal was not initialized. +Also, +.RS +.TP 5 +\fBhalfdelay\fP +returns an error +if its parameter is outside the range 1..255. +.RE .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. - +.PP The ncurses library obeys the XPG4 standard and the historical practice of the AT&T curses implementations, in that the echo bit is cleared when curses initializes the terminal state. BSD curses differed from this slightly; it left the echo bit on at initialization, but the BSD \fBraw\fR call turned it -off as a side-effect. For best portability, set echo or noecho explicitly +off as a side-effect. For best portability, set echo or noecho explicitly just after initialization, even if your program remains in cooked mode. .SH NOTES Note that \fBecho\fR, \fBnoecho\fR, \fBhalfdelay\fR, \fBintrflush\fR, \fBmeta\fR, \fBnodelay\fR, \fBnotimeout\fR, \fBnoqiflush\fR, \fBqiflush\fR, \fBtimeout\fR, and \fBwtimeout\fR may be macros. - +.PP The \fBnoraw\fR and \fBnocbreak\fR calls follow historical practice in that they attempt to restore to normal (`cooked') mode from raw and cbreak modes respectively. Mixing raw/noraw and cbreak/nocbreak calls leads to tty driver