X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fdefine_key.3x;h=298a979c3305ead3fd558d9eb254949bed175d73;hp=c11e14b1e74756287229936468184f62b246a219;hb=8d3ea9021573747ecd129228ba7782a03243f62c;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/man/define_key.3x b/man/define_key.3x index c11e14b1..298a979c 100644 --- a/man/define_key.3x +++ b/man/define_key.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2017 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,13 +28,13 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: define_key.3x,v 1.10 2003/10/25 20:33:16 tom Exp $ +.\" $Id: define_key.3x,v 1.15 2017/11/21 00:53:44 tom Exp $ .TH define_key 3X "" .SH NAME \fBdefine_key\fP \- define a keycode .SH SYNOPSIS \fB#include \fP - +.sp \fBint define_key(const char *definition, int keycode);\fP .SH DESCRIPTION This is an extension to the curses library. @@ -47,18 +47,17 @@ 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. +The keycode must be greater than zero, and the string non-null, +otherwise \fBERR\fP is returned. +\fBERR\fP may also be returned if there is insufficient memory to allocate the +data to store the definition. +If no error is detected, \fBOK\fP 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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: