From 2e9d696349cc7121fa9fc4129781439fac979dbb Mon Sep 17 00:00:00 2001 From: christos Date: Tue, 11 Sep 2012 11:57:18 +0000 Subject: [PATCH] PR/46941: Steffen Nurpmeso: document EL_BUFFERED --- lib/libedit/editline.3 | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/lib/libedit/editline.3 b/lib/libedit/editline.3 index 9d06fbc4d206..f9146eaf2ced 100644 --- a/lib/libedit/editline.3 +++ b/lib/libedit/editline.3 @@ -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 @@ check this (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 @@ previously registered with the corresponding .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"