X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fdefine_key.3x;h=216a3cbce4b6a22c9af127a6765aa2a2650a4e5d;hp=79a82052e3bf2b158569448099c92ee18d786a7d;hb=b6bff46512483ea0da80307fd50ce70172d3eb24;hpb=661078ddbde3ce0f3b06e95642fbb9b5fef7dca1 diff --git a/man/define_key.3x b/man/define_key.3x index 79a82052..216a3cbc 100644 --- a/man/define_key.3x +++ b/man/define_key.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2004,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 * @@ -26,19 +26,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" Author: Thomas E. Dickey 1997 +.\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: define_key.3x,v 1.4 1998/02/11 12:13:48 tom Exp $ +.\" $Id: define_key.3x,v 1.12 2006/02/25 21:49:19 tom Exp $ .TH define_key 3X "" -. .SH NAME \fBdefine_key\fP \- define a keycode -. .SH SYNOPSIS \fB#include \fP - -\fBint define_key(char *definition, int keycode);\fP -. +.sp +\fBint define_key(const char *definition, int keycode);\fP .SH DESCRIPTION This is an extension to the curses library. It permits an application to define keycodes with their corresponding control @@ -47,18 +44,17 @@ the predefined codes in the terminfo database. .PP If the given string is null, any existing definition for the keycode is removed. -. +Similarly, if the given keycode is negative or zero, any existing string +for the given definition is removed. .SH RETURN VALUE The keycode must be greater than zero, else ERR is returned. -. .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 -\fBkeyok\fR(3X). -. +\fBkeyok\fR(3X), +\fBkey_defined\fR(3X). .SH AUTHOR Thomas Dickey. .\"#