]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/menu_pattern.3x
ncurses 6.1 - patch 20180728
[ncurses.git] / man / menu_pattern.3x
index 3cde165b78c527417d24946c8301632ee06ded36..6b9fbccd1fa36381d5f8790595f14d43fcdcab0f 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2015,2018 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_pattern.3x,v 1.11 2008/06/21 21:58:20 tom Exp $
+.\" $Id: menu_pattern.3x,v 1.16 2018/07/28 22:08:59 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 +39,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:
@@ -78,14 +83,9 @@ System error occurred (see \fBerrno\fR).
 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.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.