X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getch.3x;h=a8b2ffea1868a70e8dd1c4b901535f394bb7e6a8;hp=8f29f75f475341890117d52075ae5abfe5a596f4;hb=555811d68fc57f29fcf3d803adfbf7070b6a70e7;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/curs_getch.3x b/man/curs_getch.3x index 8f29f75f..a8b2ffea 100644 --- a/man/curs_getch.3x +++ b/man/curs_getch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2011,2012 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,10 +27,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getch.3x,v 1.33 2010/12/04 18:36:44 tom Exp $ +.\" $Id: curs_getch.3x,v 1.37 2012/07/07 20:04:56 tom Exp $ .TH curs_getch 3X "" .na .hy 0 +.de bP +.IP \(bu 4 +.. .SH NAME \fBgetch\fR, \fBwgetch\fR, @@ -234,14 +237,14 @@ See \fBresizeterm\fR(3X) for more details about \fBKEY_RESIZE\fP, and 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 completion. -.RS +.RS 3 .TP 5 \fBungetch\fP -returns an error +returns ERR if there is no more room in the FIFO. -.TP 5 +.TP \fBwgetch\fP -returns an error +returns ERR if the window pointer is null, or if its timeout expires without having any data. .RE @@ -264,6 +267,20 @@ If it says that \fBKEY_ENTER\fP is control/M, \fBgetch\fR will return \fBKEY_ENTER\fP when you press control/M. .PP +Generally, \fBKEY_ENTER\fP denotes the character(s) sent by the \fIEnter\fP +key on the numeric keypad: +.bP +the terminal description lists the most useful keys, +.bP +the \fIEnter\fP key on the regular keyboard is already handled by +the standard ASCII characters for carriage-return and line-feed, +.bP +depending on whether \fBnl\fP or \fBnonl\fP was called, +pressing "Enter" on the regular keyboard may return either a carriage-return +or line-feed, and finally +.bP +"Enter or send" is the standard description for this key. +.PP When using \fBgetch\fR, \fBwgetch\fR, \fBmvgetch\fR, or \fBmvwgetch\fR, nocbreak mode (\fBnocbreak\fR) and echo mode (\fBecho\fR) should not be used at the same time. @@ -316,6 +333,7 @@ any code using it be conditionalized on the \fBNCURSES_VERSION\fR feature macro. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inopts\fR(3X), +\fBcurs_outopts\fR(3X), \fBcurs_mouse\fR(3X), \fBcurs_move\fR(3X), \fBcurs_refresh\fR(3X),