diff options
author | Nicholas Marriott <nicm@cvs.openbsd.org> | 2010-05-14 21:12:37 +0000 |
---|---|---|
committer | Nicholas Marriott <nicm@cvs.openbsd.org> | 2010-05-14 21:12:37 +0000 |
commit | aae209063b62cb154aaed719a5fa9da659054b37 (patch) | |
tree | f919acb422a53dd36b617725be99289e27914df2 /lib | |
parent | 73195c73ba1ad5ce930e4f96391cb9eb6e5ff0de (diff) |
Document return values, based on a diff from Ross Richardson.
ok jmc
Diffstat (limited to 'lib')
-rw-r--r-- | lib/libedit/editline.3 | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/lib/libedit/editline.3 b/lib/libedit/editline.3 index 35100b72ce1..aced91fece8 100644 --- a/lib/libedit/editline.3 +++ b/lib/libedit/editline.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: editline.3,v 1.26 2010/05/09 19:12:05 jmc Exp $ +.\" $OpenBSD: editline.3,v 1.27 2010/05/14 21:12:36 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: May 9 2010 $ +.Dd $Mdocdate: May 14 2010 $ .Dt EDITLINE 3 .Os .Sh NAME @@ -194,6 +194,7 @@ parameters. .Fa op determines which parameter to set, and each operation has its own parameter list. +Returns 0 on success, \-1 on failure. .Pp The following values for .Fa op @@ -450,6 +451,8 @@ Refer to .Xr editrc 5 for details on the format of .Fa file . +.Fn el_source +returns 0 on success and \-1 on error. .It Fn el_resize Must be called if the terminal size changes. If @@ -495,7 +498,9 @@ The following functions are available: .Bl -tag -width 4n .It Fn history_init Initialise the history list, and return a data structure -to be used by all other history list functions. +to be used by all other history list functions, or +.Dv NULL +on failure. .It Fn history_end Clean up and finish with .Fa h , |