doc/html/man/term.7.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2021,2023 Thomas E. Dickey                                *
   4   * Copyright 1998-2011,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: term.7,v 1.42 2023/11/11 11:48:16 tom Exp @
  31   *SH SYNOPSIS
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>term 7 2023-11-11 ncurses 6.4 Miscellaneous</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">term 7 2023-11-11 ncurses 6.4 Miscellaneous</H1>
  44 <PRE>
  45 <STRONG><A HREF="term.7.html">term(7)</A></STRONG>                          Miscellaneous                         <STRONG><A HREF="term.7.html">term(7)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        term - conventions for naming terminal types
  52
  53
  54 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  55        The  environment variable <STRONG>TERM</STRONG> should normally contain the type name of
  56        the terminal, console or  display-device  type  you  are  using.   This
  57        information  is  critical  for  all screen-oriented programs, including
  58        your editor and mailer.
  59
  60        A default <STRONG>TERM</STRONG> value  will  be  set  on  a  per-line  basis  by  either
  61        <STRONG>/etc/inittab</STRONG>  (e.g.,  System-V-like  UNIXes) or <STRONG>/etc/ttys</STRONG> (BSD UNIXes).
  62        This will nearly  always  suffice  for  workstation  and  microcomputer
  63        consoles.
  64
  65        If  you  use a dialup line, the type of device attached to it may vary.
  66        Older UNIX systems pre-set a very dumb terminal  type  like  "dumb"  or
  67        "dialup"  on  dialup lines.  Newer ones may pre-set "vt100", reflecting
  68        the prevalence of DEC VT100-compatible terminals and  personal-computer
  69        emulators.
  70
  71        Modern  telnets pass your <STRONG>TERM</STRONG> environment variable from the local side
  72        to the remote one.  There can be problems if  the  remote  terminfo  or
  73        termcap  entry  for  your  type  is not compatible with yours, but this
  74        situation is rare and  can  almost  always  be  avoided  by  explicitly
  75        exporting  "vt100"  (assuming  you  are  in fact using a VT100-superset
  76        console, terminal, or terminal emulator).
  77
  78        In any case, you are free to override the system <STRONG>TERM</STRONG> setting  to  your
  79        taste in your shell profile.  The <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> utility may be of assistance;
  80        you can give it a set of rules for deducing or  requesting  a  terminal
  81        type based on the tty device and baud rate.
  82
  83        Setting  your  own  <STRONG>TERM</STRONG> value may also be useful if you have created a
  84        custom entry incorporating options (such as  visual  bell  or  reverse-
  85        video)  which  you  wish  to  override the system default type for your
  86        line.
  87
  88        Terminal type descriptions are  stored  as  files  of  capability  data
  89        underneath /usr/share/terminfo.  To browse a list of all terminal names
  90        recognized by the system, do
  91
  92                toe | more
  93
  94        from your shell.   These  capability  files  are  in  a  binary  format
  95        optimized for retrieval speed (unlike the old text-based <STRONG>termcap</STRONG> format
  96        they replace); to examine  an  entry,  you  must  use  the  <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>
  97        command.  Invoke it as follows:
  98
  99                infocmp <EM>entry</EM><STRONG>_</STRONG><EM>name</EM>
 100
 101        where  <EM>entry</EM><STRONG>_</STRONG><EM>name</EM>  is the name of the type you wish to examine (and the
 102        name of its capability file  the  subdirectory  of  /usr/share/terminfo
 103        named  for  its first letter).  This command dumps a capability file in
 104        the text format described by <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 105
 106        The first line of a <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> description gives the  names  by  which
 107        terminfo  knows a terminal, separated by "|" (pipe-bar) characters with
 108        the last name field terminated by a comma.  The first name field is the
 109        type's <EM>primary</EM> <EM>name</EM>, and is the one to use when setting <STRONG>TERM</STRONG>.  The last
 110        name field (if distinct from the first) is actually  a  description  of
 111        the  terminal  type  (it  may contain blanks; the others must be single
 112        words).  Name fields between  the  first  and  last  (if  present)  are
 113        aliases  for  the  terminal,  usually  historical  names  retained  for
 114        compatibility.
 115
 116        There are some conventions for how to  choose  terminal  primary  names
 117        that  help  keep  them  informative and unique.  Here is a step-by-step
 118        guide to naming terminals that also explains how to parse them:
 119
 120        First, choose a root name.  The  root  will  consist  of  a  lower-case
 121        letter  followed by up to seven lower-case letters or digits.  You need
 122        to avoid using punctuation characters in root names, because  they  are
 123        used and interpreted as filenames and shell meta-characters (such as !,
 124        $, *, ?, etc.) embedded in them may cause odd and  unhelpful  behavior.
 125        The  slash  (/),  or  any  other  character  that may be interpreted by
 126        anyone's file system (\, $, [, ]), is especially dangerous (terminfo is
 127        platform-independent,  and choosing names with special characters could
 128        someday make life difficult for users of a future port).  The  dot  (.)
 129        character  is  relatively safe as long as there is at most one per root
 130        name; some historical terminfo names use it.
 131
 132        The root name for a terminal or workstation console type should  almost
 133        always  begin  with a vendor prefix (such as <STRONG>hp</STRONG> for Hewlett-Packard, <STRONG>wy</STRONG>
 134        for Wyse, or <STRONG>att</STRONG> for AT&amp;T terminals), or a common name of the  terminal
 135        line  (<STRONG>vt</STRONG>  for  the  VT  series  of  terminals from DEC, or <STRONG>sun</STRONG> for Sun
 136        Microsystems workstation  consoles,  or  <STRONG>regent</STRONG>  for  the  ADDS  Regent
 137        series.   You  can  list  the  terminfo  tree  to see what prefixes are
 138        already in common use.  The root name prefix should  be  followed  when
 139        appropriate by a model number; thus <STRONG>vt100</STRONG>, <STRONG>hp2621</STRONG>, <STRONG>wy50</STRONG>.
 140
 141        The  root  name for a PC-Unix console type should be the OS name, i.e.,
 142        <STRONG>linux</STRONG>, <STRONG>bsdos</STRONG>, <STRONG>freebsd</STRONG>, <STRONG>netbsd</STRONG>.  It should <EM>not</EM> be <STRONG>console</STRONG> or  any  other
 143        generic that might cause confusion in a multi-platform environment!  If
 144        a model number follows, it should indicate either the OS release  level
 145        or the console driver release level.
 146
 147        The  root name for a terminal emulator (assuming it does not fit one of
 148        the standard ANSI or vt100 types) should  be  the  program  name  or  a
 149        readily recognizable abbreviation of it (i.e., <STRONG>versaterm</STRONG>, <STRONG>ctrm</STRONG>).
 150
 151        Following  the  root name, you may add any reasonable number of hyphen-
 152        separated feature suffixes.
 153
 154        2p   Has two pages of memory.  Likewise 4p, 8p, etc.
 155
 156        mc   Magic-cookie.  Some  terminals  (notably  older  Wyses)  can  only
 157             support  one  attribute  without magic-cookie lossage.  Their base
 158             entry is usually paired with another that has this suffix and uses
 159             magic cookies to support multiple attributes.
 160
 161        -am  Enable auto-margin (right-margin wraparound).
 162
 163        -m   Mono mode - suppress color support.
 164
 165        -na  No  arrow  keys  -  termcap  ignores arrow keys which are actually
 166             there on the terminal, so the user can use the arrow keys locally.
 167
 168        -nam No auto-margin - suppress am capability.
 169
 170        -nl  No labels - suppress soft labels.
 171
 172        -nsl No status line - suppress status line.
 173
 174        -pp  Has a printer port which is used.
 175
 176        -rv  Terminal in reverse video mode (black on white).
 177
 178        -s   Enable status line.
 179
 180        -vb  Use visible bell (flash) rather than beep.
 181
 182        -w   Wide; terminal is in 132-column mode.
 183
 184        Conventionally, if your terminal type is a variant intended to  specify
 185        a  line  height,  that  suffix should go first.  So, for a hypothetical
 186        FuBarCo model 2317 terminal in 30-line mode with  reverse  video,  best
 187        form would be <STRONG>fubar-30-rv</STRONG> (rather than, say, "fubar-rv-30").
 188
 189        Terminal  types  that are written not as standalone entries, but rather
 190        as components to be plugged into other entries  via  <STRONG>use</STRONG>  capabilities,
 191        are distinguished by using embedded plus signs rather than dashes.
 192
 193        Commands which use a terminal type to control display often accept a -T
 194        option that accepts a terminal name  argument.   Such  programs  should
 195        fall  back  on  the  <STRONG>TERM</STRONG>  environment  variable  when  no -T option is
 196        specified.
 197
 198
 199 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 200        For maximum compatibility with older System V UNIXes, names and aliases
 201        should be unique within the first 14 characters.
 202
 203
 204 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
 205        <EM>/usr/share/terminfo</EM>
 206             compiled terminal description database
 207
 208        /etc/inittab
 209             tty line initialization (AT&amp;T-like UNIXes)
 210
 211        /etc/ttys
 212             tty line initialization (BSD-like UNIXes)
 213
 214
 215 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 216        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 217
 218
 219
 220 ncurses 6.4                       2023-11-11                           <STRONG><A HREF="term.7.html">term(7)</A></STRONG>
 221 </PRE>
 222 <div class="nav">
 223 <ul>
 224 <li><a href="#h2-NAME">NAME</a></li>
 225 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 226 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 227 <li><a href="#h2-FILES">FILES</a></li>
 228 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 229 </ul>
 230 </div>
 231 </BODY>
 232 </HTML>