diff options
Diffstat (limited to 'man/menu_pattern.3x')
| -rw-r--r-- | man/menu_pattern.3x | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/man/menu_pattern.3x b/man/menu_pattern.3x index e63a9f7..ce439b4 100644 --- a/man/menu_pattern.3x +++ b/man/menu_pattern.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,10 +27,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ +.\" $Id: menu_pattern.3x,v 1.18 2020/02/02 23:34:34 tom Exp $ .TH menu_pattern 3X "" .SH NAME -\fBmenu_pattern\fR \- get and set a menu's pattern buffer +\fBset_menu_pattern\fP, +\fBmenu_pattern\fR \- set and get a menu's pattern buffer .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -38,19 +40,23 @@ int set_menu_pattern(MENU *menu, const char *pattern); char *menu_pattern(const MENU *menu); .br .SH DESCRIPTION -Every menu has an associated pattern match buffer. As input events that are +Every menu has an associated pattern match buffer. +As input events that are printable characters come in, they are appended to this match buffer and tested for a match, as described in \fBmenu_driver\fR(3X). .PP The function \fBset_menu_pattern\fR sets the pattern buffer for the given menu -and tries to find the first matching item. If it succeeds, that item becomes -current; if not, the current item does not change. +and tries to find the first matching item. +If it succeeds, that item becomes +current; if not, the current item does not change. .PP The function \fBmenu_pattern\fR returns the pattern buffer of the given \fImenu\fR. .SH RETURN VALUE -The function \fBmenu_pattern\fR returns a pointer, which is \fBNULL\fR if the \fImenu\fP parameter is \fBNULL\fP. -Otherwise, it is a pointer to a string which is empty if no pattern has been set. +The function \fBmenu_pattern\fR returns a pointer, +which is \fBNULL\fR if the \fImenu\fP parameter is \fBNULL\fP. +Otherwise, it is a pointer to a string which is empty +if no pattern has been set. It does not set errno. .PP The function \fBset_menu_pattern\fR may return the following error codes: @@ -71,15 +77,16 @@ No items are connected to menu. Character failed to match. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fR(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES The header file \fB<menu.h>\fR automatically includes the header file \fB<curses.h>\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond. |