X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fdefine_key.3x;h=18eaff87cb1156e617224bac191f2329956154f6;hp=b7bca879f2a239a1e8ad604bddc43fd6f1503205;hb=59c1a9740d123db3cecafe76e18f7848081a670b;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/define_key.3x b/man/define_key.3x index b7bca879..18eaff87 100644 --- a/man/define_key.3x +++ b/man/define_key.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2004 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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.11 2004/06/05 19:20:03 tom Exp $ +.\" $Id: define_key.3x,v 1.14 2010/12/04 18:49:20 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,7 +47,11 @@ 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 ERR is returned. +ERR may also be returned if there is insufficient memory to allocate the +data to store the definition. +If no error is detected, OK 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 @@ -57,9 +61,3 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBkey_defined\fR(3X). .SH AUTHOR Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: