summaryrefslogtreecommitdiff
path: root/lib/libedit
diff options
context:
space:
mode:
authorNicholas Marriott <nicm@cvs.openbsd.org>2010-05-09 15:16:31 +0000
committerNicholas Marriott <nicm@cvs.openbsd.org>2010-05-09 15:16:31 +0000
commite7e6c96c0f8791aafff7712718c683cb9ae5e407 (patch)
tree1afa2069c2b6724e79e69bfe968d8589089bfcf9 /lib/libedit
parentbd31080ae2db2ae9a9272d56ccae4711ed9f45bf (diff)
Document that el_init can return NULL on failure, PR 6374 from rueda at
devio.us. ok jmc
Diffstat (limited to 'lib/libedit')
-rw-r--r--lib/libedit/editline.38
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/libedit/editline.3 b/lib/libedit/editline.3
index b2c18b9b45a..1cfef6c8edb 100644
--- a/lib/libedit/editline.3
+++ b/lib/libedit/editline.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: editline.3,v 1.24 2008/06/26 05:42:05 ray Exp $
+.\" $OpenBSD: editline.3,v 1.25 2010/05/09 15:16:30 nicm Exp $
.\" $NetBSD: editline.3,v 1.42 2003/11/04 13:22:19 christos Exp $
.\"
.\" Copyright (c) 1997-1999 The NetBSD Foundation, Inc.
@@ -27,7 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: June 26 2008 $
+.Dd $Mdocdate: May 9 2010 $
.Os
.Dt EDITLINE 3
.Sh NAME
@@ -112,7 +112,9 @@ The following functions are available:
.Bl -tag -width 4n
.It Fn el_init
Initialise the line editor, and return a data structure
-to be used by all other line editing functions.
+to be used by all other line editing functions, or
+.Dv NULL
+on failure.
.Fa prog
is the name of the invoking program, used when reading the
.Xr editrc 5