lib/libcurses/curses_keyname.3

   1 .\"     $NetBSD: curses_keyname.3,v 1.5 2008/04/30 13:10:51 martin Exp $
   2 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to The NetBSD Foundation
   6 .\" by Julian Coleman.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 .\" POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .Dd October 17, 2007
  29 .Dt CURSES_KEYNAME 3
  30 .Os
  31 .Sh NAME
  32 .Nm curses_keyname ,
  33 .Nm keyname
  34 .Nd curses report key name routine
  35 .Sh LIBRARY
  36 .Lb libcurses
  37 .Sh SYNOPSIS
  38 .In curses.h
  39 .Ft "char *"
  40 .Fn keyname "int key"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn keyname
  44 generates a character string containing a description of the key specified in
  45 .Fa key .
  46 .Pp
  47 The string is formatted according to the following table:
  48 .Bl -column "Meta + control character" "KEY_MIN - KEY_MAX" "String format"
  49 .It "Description" Ta "Key range" Ta "String format"
  50 .It Li "Control character" Ta "0 - 31" Ta "^X"
  51 .It Li "Visible character" Ta "32 - 126" Ta "X"
  52 .It Li "Delete character" Ta "127" Ta "^?"
  53 .It Li "Meta + control character" Ta "128 - 158" Ta "M-^X"
  54 .It Li "Meta + visible character" Ta "159 - 254" Ta "M-X"
  55 .It Li "Meta + delete character" Ta "255" Ta "M-^?"
  56 .It Li "Named key" Ta "KEY_MIN - KEY_MAX" Ta "KEY_EXIT"
  57 .It Li "Unknown key" Ta "" Ta "-1"
  58 .El
  59 .Sh SEE ALSO
  60 .Xr curses_input 3
  61 .Sh NOTE
  62 The return value of
  63 .Fn keyname
  64 is a static buffer, which will be overwritten on a subsequent call.
  65 .Sh STANDARDS
  66 The
  67 .Nx
  68 Curses library complies with the X/Open Curses specification, part of the
  69 Single Unix Specification.
  70 .Sh HISTORY
  71 These functions first appeared in
  72 .Nx 2.0 .