Module Name: src Committed By: christos Date: Tue Sep 11 11:57:19 UTC 2012
Modified Files: src/lib/libedit: editline.3 Log Message: PR/46941: Steffen Nurpmeso: document EL_BUFFERED To generate a diff of this commit: cvs rdiff -u -r1.75 -r1.76 src/lib/libedit/editline.3 Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.
Modified files: Index: src/lib/libedit/editline.3 diff -u src/lib/libedit/editline.3:1.75 src/lib/libedit/editline.3:1.76 --- src/lib/libedit/editline.3:1.75 Sat Feb 26 20:51:37 2011 +++ src/lib/libedit/editline.3 Tue Sep 11 07:57:18 2012 @@ -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 correspon .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"