X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inopts.3x;h=a10ce60db12470da0734d8ec400663d98b68bf85;hp=69ad2c21fe2b964bd8356e051fa024d69313d40f;hb=321b81e6b3fa425daddac02420d862100dc3aac8;hpb=58552e8c761a70f8f0bd591fecdf576fa8216e3e diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x index 69ad2c21..a10ce60d 100644 --- a/man/curs_inopts.3x +++ b/man/curs_inopts.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inopts.3x,v 1.24 2017/01/07 19:25:15 tom Exp $ +.\" $Id: curs_inopts.3x,v 1.27 2018/07/28 22:20:54 tom Exp $ .TH curs_inopts 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -140,7 +140,7 @@ 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. +seconds, \fBERR\fP is returned if nothing has been typed. The value of \fItenths\fR must be a number between 1 and 255. Use \fBnocbreak\fR to leave half-delay @@ -266,9 +266,10 @@ If \fIfd\fR is \-1, then no typeahead checking is done. .\" .SH RETURN VALUE -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. +All routines that return an integer return \fBERR\fR upon failure and \fBOK\fP +(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, @@ -298,13 +299,13 @@ ncurses loads the key-definitions for the current terminal description. If the terminal description includes extended string capabilities, e.g., from using the \fB\-x\fP option of \fB@TIC@\fP, then ncurses also defines keys for the capabilities whose names -begin with "k". +begin with \*(``k\*(''. The corresponding keycodes are generated and (depending on previous loads of terminal descriptions) may differ from one execution of a program to the next. The generated keycodes are recognized by the \fBkeyname\fP function -(which will then return a name beginning with "k" denoting the -terminfo capability name rather than "K", used for curses key-names). +(which will then return a name beginning with \*(``k\*('' denoting the +terminfo capability name rather than \*(``K\*('', used for curses key-names). On the other hand, an application can use \fBdefine_key\fP to establish a specific keycode for a given string. This makes it possible for an application to check for an extended @@ -334,8 +335,8 @@ Note that \fBecho\fR, \fBnoecho\fR, \fBhalfdelay\fR, \fBintrflush\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. +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 control states that are hard to predict or understand; it is not recommended. .SH SEE ALSO