[src/trunk]: src/lib/libedit PR/46941: Steffen Nurpmeso: document EL_BUFFERED

[christos <christos%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/0b99a38d7300
branches:  trunk
changeset: 781500:0b99a38d7300
user:      christos <christos%NetBSD.org@localhost>
date:      Tue Sep 11 11:57:18 2012 +0000

description:
PR/46941: Steffen Nurpmeso: document EL_BUFFERED

diffstat:

 lib/libedit/editline.3 |  17 +++++++++++------
 1 files changed, 11 insertions(+), 6 deletions(-)

diffs (45 lines):

diff -r 3a47c899132c -r 0b99a38d7300 lib/libedit/editline.3
--- a/lib/libedit/editline.3    Tue Sep 11 00:15:19 2012 +0000
+++ b/lib/libedit/editline.3    Tue Sep 11 11:57:18 2012 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: editline.3,v 1.75 2011/02/27 01:51:37 christos Exp $
+.\"    $NetBSD: editline.3,v 1.76 2012/09/11 11:57:18 christos Exp $
 .\"
 .\" Copyright (c) 1997-2003 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -26,7 +26,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd February 26, 2011
+.Dd September 11, 2012
 .Dt EDITLINE 3
 .Os
 .Sh NAME
@@ -432,6 +432,14 @@
 (using
 .Fn el_get )
 to determine if editing should be enabled or not.
+.It Dv EL_UNBUFFERED , Fa "int flag"
+If
+.Fa flag
+is zero,
+unbuffered mode is disabled (the default).
+In unbuffered mode,
+.Fn el_gets
+will return immediately after processing a single character.
 .It Dv EL_GETCFN , Fa "int (*f)(EditLine *, char *c)"
 Define the character reading function as
 .Fa f ,
@@ -534,10 +542,7 @@
 .Fn el_set
 call.
 .It Dv EL_UNBUFFERED , Fa "int"
-Sets or clears unbuffered mode.
-In this mode,
-.Fn el_gets
-will return immediately after processing a single character.
+Return non-zero if unbuffered mode is enabled.
 .It Dv EL_PREP_TERM , Fa "int"
 Sets or clears terminal editing mode.
 .It Dv EL_GETFP , Fa "int fd", Fa "FILE **fp"