X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fdefine_key.3x;h=d0dbe7fccaa9e4904074a0bb1a0839f37135ab5b;hp=18eaff87cb1156e617224bac191f2329956154f6;hb=152c5a605234b7ea36ba3a03ec07e124bb6aac75;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/define_key.3x b/man/define_key.3x index 18eaff87..d0dbe7fc 100644 --- a/man/define_key.3x +++ b/man/define_key.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 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,14 +29,14 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: define_key.3x,v 1.14 2010/12/04 18:49:20 tom Exp $ +.\" $Id: define_key.3x,v 1.18 2020/10/24 09:52:54 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 +\fBint define_key(const char *\fP\fIdefinition\fP\fB, int \fP\fIkeycode\fP\fB);\fP .SH DESCRIPTION This is an extension to the curses library. It permits an application to define keycodes with their corresponding control @@ -48,13 +49,15 @@ 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, and the string non-null, -otherwise ERR is returned. -ERR may also be returned if there is insufficient memory to allocate the +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, OK is returned. +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 +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),