diff options
author | Nicholas Marriott <nicm@cvs.openbsd.org> | 2010-01-12 23:22:15 +0000 |
---|---|---|
committer | Nicholas Marriott <nicm@cvs.openbsd.org> | 2010-01-12 23:22:15 +0000 |
commit | 6ee254699bf787d78835419be2b3241fb037d444 (patch) | |
tree | 07fe67dab517e4990f344fe2c00e65cef4d25b81 /lib/libcurses/keybound.3 | |
parent | 0b62f5dc36fc7203a74cdc812c4234ae188fdfd2 (diff) |
Update to ncurses 5.7, with local changes reapplied.
This is around eight years worth of changes (previously we were around ncurses
5.2), too many to list - many bug fixes and also a few new functions.
A major bump for libcurses, libpanel, libform and libmenu.
ok deraadt
Diffstat (limited to 'lib/libcurses/keybound.3')
-rw-r--r-- | lib/libcurses/keybound.3 | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/lib/libcurses/keybound.3 b/lib/libcurses/keybound.3 index bad5d9e4486..bd586434234 100644 --- a/lib/libcurses/keybound.3 +++ b/lib/libcurses/keybound.3 @@ -1,7 +1,7 @@ -.\" $OpenBSD: keybound.3,v 1.2 2008/12/07 08:59:22 jmc Exp $ +.\" $OpenBSD: keybound.3,v 1.3 2010/01/12 23:21:59 nicm Exp $ .\" .\"*************************************************************************** -.\" Copyright (c) 1999 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2003,2006 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 * @@ -28,37 +28,34 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" Author: Thomas E. Dickey <dickey@clark.net> 1999 +.\" Author: Thomas E. Dickey 1999 .\" -.\" $From: keybound.3x,v 1.1 1999/02/19 11:59:24 tom Exp $ +.\" $Id: keybound.3,v 1.3 2010/01/12 23:21:59 nicm Exp $ .TH keybound 3 "" .SH NAME \fBkeybound\fP \- return definition of keycode -.. .SH SYNOPSIS \fB#include <curses.h>\fP - +.sp \fBchar * keybound(int keycode, int count);\fP -.. .SH DESCRIPTION This is an extension to the curses library. It permits an application to determine the string which is defined in the terminfo for specific keycodes. -.. .SH RETURN VALUE -The keycode must be greater than zero, else NULL is returned. +The \fIkeycode\fP parameter must be greater than zero, else NULL is returned. If it does not correspond to a defined key, then NULL is returned. -Otherwise, the function returns a string, which must be freed by the caller. -.. +The \fIcount\fP parameter is used to allow the application to iterate +through multiple definitions, counting from zero. +When successful, +the function returns a string which must be freed by the caller. .SH PORTABILITY These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that any code depending on them be conditioned using NCURSES_VERSION. -.. .SH SEE ALSO \fBdefine_key\fR(3), \fBkeyok\fR(3). -.. .SH AUTHOR Thomas Dickey. .\"# |