JezK
Edit File: _0040key.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". --> <title>@key (GNU Texinfo 6.8)</title> <meta name="description" content="@key (GNU Texinfo 6.8)"> <meta name="keywords" content="@key (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link href="index.html" rel="start" title="Top"> <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Indicating.html" rel="up" title="Indicating"> <link href="_0040samp.html" rel="next" title="@samp"> <link href="_0040kbd.html" rel="prev" title="@kbd"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="subsection" id="g_t_0040key"> <div class="header"> <p> Next: <a href="_0040samp.html" accesskey="n" rel="next"><code>@samp</code>{<var>text</var>}</a>, Previous: <a href="_0040kbd.html" accesskey="p" rel="prev"><code>@kbd</code>{<var>keyboard-characters</var>}</a>, Up: <a href="Indicating.html" accesskey="u" rel="up">Indicating Definitions, Commands, etc.</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> <span id="g_t_0040key_007bkey_002dname_007d"></span><h4 class="subsection">6.1.4 <code>@key</code>{<var>key-name</var>}</h4> <span id="key"></span><span id="index-key"></span> <p>Use the <code>@key</code> command for the conventional name for a key on a keyboard, as in: </p> <div class="example"> <pre class="example">@key{RET} </pre></div> <p>You can use the <code>@key</code> command within the argument of an <code>@kbd</code> command when the sequence of characters to be typed includes one or more keys that are described by name. </p> <p>For example, to produce <kbd>C-x <span class="key">ESC</span></kbd> and <kbd>M-<span class="key">TAB</span></kbd> you would type: </p> <div class="example"> <pre class="example">@kbd{C-x @key{ESC}} @kbd{M-@key{TAB}} </pre></div> <p>Here is a list of the recommended names for keys: <span id="index-Recommended-names-for-keys"></span> <span id="index-Keys_002c-recommended-names"></span> <span id="index-Names-recommended-for-keys"></span> <span id="index-Abbreviations-for-keys"></span> <span id="index-Control-keys_002c-specifying"></span> <span id="index-Meta-keys_002c-specifying"></span> </p> <blockquote> <dl compact="compact"> <dt><span><tt>SPC</tt></span></dt> <dd><p>Space </p></dd> <dt><span><tt>RET</tt></span></dt> <dd><p>Return </p></dd> <dt><span><tt>LFD</tt></span></dt> <dd><p>Linefeed (however, since most keyboards nowadays do not have a Linefeed key, it might be better to call this character <kbd>C-j</kbd>) </p></dd> <dt><span><tt>TAB</tt></span></dt> <dd><p>Tab </p></dd> <dt><span><tt>BS</tt></span></dt> <dd><p>Backspace </p></dd> <dt><span><tt>ESC</tt></span></dt> <dd><p>Escape </p></dd> <dt><span><tt>DELETE</tt></span></dt> <dd><p>Delete </p></dd> <dt><span><tt>SHIFT</tt></span></dt> <dd><p>Shift </p></dd> <dt><span><tt>CTRL</tt></span></dt> <dd><p>Control </p></dd> <dt><span><tt>META</tt></span></dt> <dd><p>Meta </p></dd> </dl> </blockquote> <span id="index-META-key"></span> <p>There are subtleties to handling words like ‘meta’ or ‘ctrl’ that are names of modifier keys. When mentioning a character in which the modifier key is used, such as <kbd>Meta-a</kbd>, use the <code>@kbd</code> command alone; do not use the <code>@key</code> command; but when you are referring to the modifier key in isolation, use the <code>@key</code> command. For example, write ‘<samp>@kbd{Meta-a}</samp>’ to produce <kbd>Meta-a</kbd> and ‘<samp>@key{META}</samp>’ to produce <tt class="key">META</tt>. </p> <p>As a convention in GNU manuals, <code>@key</code> should not be used in index entries. </p> </div> </body> </html>