ncurses 6.1 - patch 20181208

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

diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index ce4b959ea36f82ddf873ee2dc390100edd51a35b..53716beeff916deed4482bd309abb049a05e56c9 100644 (file)
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_getch.3x,v 1.50 2017/11/18 23:56:00 tom Exp $
+.\" $Id: curs_getch.3x,v 1.53 2018/07/28 22:15:59 tom Exp $

 .TH curs_getch 3X ""
 .na
 .hy 0
 .TH curs_getch 3X ""
 .na
 .hy 0


@@ -103,7 +103,8 @@ keys are listed in \fB<curses.h>\fR as macros with values outside the range
 of 8-bit characters.
 Their names begin with \fBKEY_\fR.
 .bP
 of 8-bit characters.
 Their names begin with \fBKEY_\fR.
 .bP

-Other (user-defined) function keys which may be defined using \fBdefine_key\fP(3X)
+Other (user-defined) function keys which may be defined
+using \fBdefine_key\fP(3X)

 have no names, but also are expected to have values outside the range of
 8-bit characters.
 .PP
 have no names, but also are expected to have values outside the range of
 8-bit characters.
 .PP


@@ -120,7 +121,8 @@ otherwise, the function key value is returned.
 For this reason, many terminals experience a delay between the time
 a user presses the escape key and the escape is returned to the program.
 .PP
 For this reason, many terminals experience a delay between the time
 a user presses the escape key and the escape is returned to the program.
 .PP

-In \fBncurses\fP, the timer normally expires after the value in \fBESCDELAY\fP (see \fBcurs_variables\fP(3X)).
+In \fBncurses\fP, the timer normally expires after
+the value in \fBESCDELAY\fP (see \fBcurs_variables\fP(3X)).

 If \fBnotimeout\fP is \fBTRUE\fP, the timer does not expire;
 it is an infinite (or very large) value.
 Because function keys usually begin with an escape character,
 If \fBnotimeout\fP is \fBTRUE\fP, the timer does not expire;
 it is an infinite (or very large) value.
 Because function keys usually begin with an escape character,


@@ -295,11 +297,11 @@ completion.
 .RS 3
 .TP 5
 \fBungetch\fP
 .RS 3
 .TP 5
 \fBungetch\fP

-returns ERR
+returns \fBERR\fP

 if there is no more room in the FIFO.
 .TP
 \fBwgetch\fP
 if there is no more room in the FIFO.
 .TP
 \fBwgetch\fP

-returns ERR
+returns \fBERR\fP

 if the window pointer is null, or
 if its timeout expires without having any data, or
 if the execution was interrupted by a signal (\fBerrno\fR will be set to
 if the window pointer is null, or
 if its timeout expires without having any data, or
 if the execution was interrupted by a signal (\fBerrno\fR will be set to


@@ -315,7 +317,9 @@ discouraged, as it will cause a delay of up to one second while the
 keypad code looks for a following function-key sequence.
 .PP
 Some keys may be the same as commonly used control
 keypad code looks for a following function-key sequence.
 .PP
 Some keys may be the same as commonly used control

-keys, e.g., \fBKEY_ENTER\fP versus control/M, \fBKEY_BACKSPACE\fP versus control/H.
+keys, e.g.,
+\fBKEY_ENTER\fP versus control/M,
+\fBKEY_BACKSPACE\fP versus control/H.

 Some curses implementations may differ according to whether they
 treat these control keys specially (and ignore the terminfo), or
 use the terminfo definitions.
 Some curses implementations may differ according to whether they
 treat these control keys specially (and ignore the terminfo), or
 use the terminfo definitions.


@@ -381,12 +385,12 @@ input timeout or non-blocking mode has been set.
 terminfo capabilities, but no higher-level functions use the feature.
 The implementation in ncurses is an extension.
 .PP
 terminfo capabilities, but no higher-level functions use the feature.
 The implementation in ncurses is an extension.
 .PP

-\fBKEY_RESIZE\fP is an extension first implemented for ncurses. 
+\fBKEY_RESIZE\fP is an extension first implemented for ncurses.

 NetBSD curses later added this extension.
 .PP
 Programmers concerned about portability should be prepared for either of two
 cases: (a) signal receipt does not interrupt \fBgetch\fR; (b) signal receipt
 NetBSD curses later added this extension.
 .PP
 Programmers concerned about portability should be prepared for either of two
 cases: (a) signal receipt does not interrupt \fBgetch\fR; (b) signal receipt

-interrupts \fBgetch\fR and causes it to return ERR with \fBerrno\fR set to
+interrupts \fBgetch\fR and causes it to return \fBERR\fP with \fBerrno\fR set to

 \fBEINTR\fR.
 .PP
 The \fBhas_key\fR function is unique to \fBncurses\fR.
 \fBEINTR\fR.
 .PP
 The \fBhas_key\fR function is unique to \fBncurses\fR.