X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getch.3x;h=e74df1d8dfad78bcec7ff23bfc321268aad3be27;hp=1196b3d61285592c4430b3f558f1e6b287d994d7;hb=f4ed859493ee1d227b3b51cfe88ec635f0dcb099;hpb=603f0cb25b7acc8f04f4b18d2a2fe6f90039829a diff --git a/man/curs_getch.3x b/man/curs_getch.3x index 1196b3d6..e74df1d8 100644 --- a/man/curs_getch.3x +++ b/man/curs_getch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2016 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2016,2017 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 * @@ -27,12 +27,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getch.3x,v 1.47 2016/06/11 22:56:33 tom Exp $ +.\" $Id: curs_getch.3x,v 1.51 2017/11/21 00:45:48 tom Exp $ .TH curs_getch 3X "" .na .hy 0 .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .SH NAME \fBgetch\fR, @@ -289,18 +290,20 @@ string (see \fBkey_defined\fP(3X)). .PP .SH RETURN VALUE All routines return the integer \fBERR\fR upon failure and an integer value -other than \fBERR\fR (\fBOK\fR in the case of ungetch()) upon successful +other than \fBERR\fR (\fBOK\fR in the case of \fBungetch\fP) upon successful completion. .RS 3 .TP 5 \fBungetch\fP -returns ERR +returns \fBERR\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. +if its timeout expires without having any data, or +if the execution was interrupted by a signal (\fBerrno\fR will be set to +\fBEINTR\fR). .RE .PP Functions with a "mv" prefix first perform a cursor movement using @@ -383,10 +386,8 @@ 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. -Under the \fBncurses\fR implementation, handled signals never -interrupt \fBgetch\fR. .PP The \fBhas_key\fR function is unique to \fBncurses\fR. We recommend that