summaryrefslogtreecommitdiff
path: root/lib/libmenu/menu_pattern.3
diff options
context:
space:
mode:
authorblymn <blymn@NetBSD.org>1999-11-23 11:12:34 +0000
committerblymn <blymn@NetBSD.org>1999-11-23 11:12:34 +0000
commitb68c50bcbecd3e6e991193a29654503abe841ca7 (patch)
tree3d7658eb79a05a109d0e8d9ed7912c9006e81d68 /lib/libmenu/menu_pattern.3
parent2e175b3f885644bbca8623423ecc730ba6715314 (diff)
A curses based menu library.
Diffstat (limited to 'lib/libmenu/menu_pattern.3')
-rw-r--r--lib/libmenu/menu_pattern.378
1 files changed, 78 insertions, 0 deletions
diff --git a/lib/libmenu/menu_pattern.3 b/lib/libmenu/menu_pattern.3
new file mode 100644
index 00000000000..3ac128f7e23
--- /dev/null
+++ b/lib/libmenu/menu_pattern.3
@@ -0,0 +1,78 @@
+.\" Copyright (c) 1999
+.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
+.\"
+.\" This code is donated to The NetBSD Foundation by the author.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. The name of the Author may not be used to endorse or promote
+.\" products derived from this software without specific prior written
+.\" permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $Id: menu_pattern.3,v 1.1.1.1 1999/11/23 11:12:36 blymn Exp $
+.\"
+.Dd September, 1999
+.Dt MENU_PATTERN 3
+.Os BSD 4
+.Sh NAME
+.Nm menu_pattern ,
+.Nm set_menu_pattern
+.Nd menu library
+.Sh LIBRARY
+.Lb libmenu
+.Sh SYNOPSIS
+.Fd #include <menu.h>
+.Ft char *
+.Fn menu_pattern "MENU *menu"
+.Sh DESCRIPTION
+The
+.Fn menu_pattern
+function returns a pointer to the string that is currently in the menu
+pattern buffer. The menu pattern buffer can be set by calling
+.Fn set_menu_pattern
+which will set the pattern buffer to the string passed and then
+attempt to match that string against the names of the items in the
+attached items.
+.Sh RETURN VALUES
+The functions return one of the following error values:
+.Pp
+.ta 20
+.nf
+E_OK The function was successful
+E_SYSTEM_ERROR There was a system error during the call.
+E_BAD_ARGUMENT One or more of the arguments passed to the function
+ was incorrect.
+E_NO_MATCH The character search failed to find a match.
+.fi
+.ft 1
+.br
+.ne 8
+.Sh SEE ALSO
+.Xr curses 3 ,
+.Xr menus 3
+.Sh NOTES
+The header
+.Xr <menus.h>
+automatically includes both
+.Xr <curses.h>
+and
+.Xr <eti.h>
+