ncurses 6.1 - patch 20190406
[ncurses.git] / man / term.7
index 33d6c7359ece22308abb5dd9759efa39b2f8698f..c3e09a1dabd9d36cfe24f86d760ba8637acfdf45 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************
-.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2017,2018 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: term.7,v 1.19 2010/01/09 16:42:15 tom Exp $
+.\" $Id: term.7,v 1.26 2018/07/28 22:19:56 tom Exp $
 .TH term 7
 .TH term 7
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''
 .ds n 5
 .ds d @TERMINFO@
 .SH NAME
 .ds n 5
 .ds d @TERMINFO@
 .SH NAME
@@ -35,27 +39,32 @@ term \- conventions for naming terminal types
 .SH DESCRIPTION
 .PP
 The environment variable \fBTERM\fR should normally contain the type name of
 .SH DESCRIPTION
 .PP
 The environment variable \fBTERM\fR should normally contain the type name of
-the terminal, console or display-device type you are using.  This information
+the terminal, console or display-device type you are using.
+This information
 is critical for all screen-oriented programs, including your editor and mailer.
 .PP
 A default \fBTERM\fR value will be set on a per-line basis by either
 is critical for all screen-oriented programs, including your editor and mailer.
 .PP
 A default \fBTERM\fR value will be set on a per-line basis by either
-\fB/etc/inittab\fR (e.g., System-V-like UNIXes)
+\fB/etc/inittab\fR (e.g., System\-V-like UNIXes)
 or \fB/etc/ttys\fR (BSD UNIXes).
 This will nearly always suffice for workstation and microcomputer consoles.
 .PP
 or \fB/etc/ttys\fR (BSD UNIXes).
 This will nearly always suffice for workstation and microcomputer consoles.
 .PP
-If you use a dialup line, the type of device attached to it may vary.  Older
-UNIX systems pre-set a very dumb terminal type like `dumb' or `dialup' on
-dialup lines.  Newer ones may pre-set `vt100', reflecting the prevalence of DEC
+If you use a dialup line, the type of device attached to it may vary.
+Older UNIX systems pre-set a very dumb terminal type
+like \*(``dumb\*('' or \*(``dialup\*('' on dialup lines.
+Newer ones may pre-set \*(``vt100\*('', reflecting the prevalence of DEC
 VT100-compatible terminals and personal-computer emulators.
 .PP
 Modern telnets pass your \fBTERM\fR environment variable from the local side to
 VT100-compatible terminals and personal-computer emulators.
 .PP
 Modern telnets pass your \fBTERM\fR environment variable from the local side to
-the remote one.  There can be problems if the remote terminfo or termcap entry
+the remote one.
+There can be problems if the remote terminfo or termcap entry
 for your type is not compatible with yours, but this situation is rare and
 for your type is not compatible with yours, but this situation is rare and
-can almost always be avoided by explicitly exporting `vt100' (assuming you
-are in fact using a VT100-superset console, terminal, or terminal emulator.)
+can almost always be avoided by explicitly exporting \*(``vt100\*(''
+(assuming you are in fact using a VT100-superset console,
+terminal, or terminal emulator.)
 .PP
 In any case, you are free to override the system \fBTERM\fR setting to your
 .PP
 In any case, you are free to override the system \fBTERM\fR setting to your
-taste in your shell profile.  The \fBtset\fP(1) utility may be of assistance;
+taste in your shell profile.
+The \fB@TSET@\fP(1) utility may be of assistance;
 you can give it a set of rules for deducing or requesting a terminal type based
 on the tty device and baud rate.
 .PP
 you can give it a set of rules for deducing or requesting a terminal type based
 on the tty device and baud rate.
 .PP
@@ -64,43 +73,54 @@ custom entry incorporating options (such as visual bell or reverse-video)
 which you wish to override the system default type for your line.
 .PP
 Terminal type descriptions are stored as files of capability data underneath
 which you wish to override the system default type for your line.
 .PP
 Terminal type descriptions are stored as files of capability data underneath
-\*d.  To browse a list of all terminal names recognized by the system, do
+\*d.
+To browse a list of all terminal names recognized by the system, do
 .sp
        @TOE@ | more
 .sp
 .sp
        @TOE@ | more
 .sp
-from your shell.  These capability files are in a binary format optimized for
+from your shell.
+These capability files are in a binary format optimized for
 retrieval speed (unlike the old text-based \fBtermcap\fR format they replace);
 to examine an entry, you must use the \fB@INFOCMP@\fR(1M) command.
 Invoke it as follows:
 .sp
 retrieval speed (unlike the old text-based \fBtermcap\fR format they replace);
 to examine an entry, you must use the \fB@INFOCMP@\fR(1M) command.
 Invoke it as follows:
 .sp
-       @INFOCMP@ \fIentry-name\fR
+       @INFOCMP@ \fIentry_name\fR
 .sp
 .sp
-where \fIentry-name\fR is the name of the type you wish to examine (and the
+where \fIentry_name\fR is the name of the type you wish to examine (and the
 name of its capability file the subdirectory of \*d named for its first
 name of its capability file the subdirectory of \*d named for its first
-letter).  This command dumps a capability file in the text format described by
+letter).
+This command dumps a capability file in the text format described by
 \fBterminfo\fR(\*n).
 .PP
 The first line of a \fBterminfo\fR(\*n) description gives the names by which
 \fBterminfo\fR(\*n).
 .PP
 The first line of a \fBterminfo\fR(\*n) description gives the names by which
-terminfo knows a terminal, separated by `|' (pipe-bar) characters with the last
-name field terminated by a comma.  The first name field is the type's
+terminfo knows a terminal,
+separated by \*(``|\*('' (pipe-bar) characters with the last
+name field terminated by a comma.
+The first name field is the type's
 \fIprimary name\fR, and is the one to use when setting \fBTERM\fR.  The last
 name field (if distinct from the first) is actually a description of the
 \fIprimary name\fR, and is the one to use when setting \fBTERM\fR.  The last
 name field (if distinct from the first) is actually a description of the
-terminal type (it may contain blanks; the others must be single words).  Name
+terminal type (it may contain blanks; the others must be single words).
+Name
 fields between the first and last (if present) are aliases for the terminal,
 usually historical names retained for compatibility.
 .PP
 There are some conventions for how to choose terminal primary names that help
 fields between the first and last (if present) are aliases for the terminal,
 usually historical names retained for compatibility.
 .PP
 There are some conventions for how to choose terminal primary names that help
-keep them informative and unique.  Here is a step-by-step guide to naming
+keep them informative and unique.
+Here is a step-by-step guide to naming
 terminals that also explains how to parse them:
 .PP
 terminals that also explains how to parse them:
 .PP
-First, choose a root name.  The root will consist of a lower-case letter
-followed by up to seven lower-case letters or digits.  You need to avoid using
+First, choose a root name.
+The root will consist of a lower-case letter
+followed by up to seven lower-case letters or digits.
+You need to avoid using
 punctuation characters in root names, because they are used and interpreted as
 filenames and shell meta-characters (such as !, $, *, ?, etc.) embedded in them
 punctuation characters in root names, because they are used and interpreted as
 filenames and shell meta-characters (such as !, $, *, ?, etc.) embedded in them
-may cause odd and unhelpful behavior.  The slash (/), or any other character
+may cause odd and unhelpful behavior.
+The slash (/), or any other character
 that may be interpreted by anyone's file system (\e, $, [, ]), is especially
 dangerous (terminfo is platform-independent, and choosing names with special
 that may be interpreted by anyone's file system (\e, $, [, ]), is especially
 dangerous (terminfo is platform-independent, and choosing names with special
-characters could someday make life difficult for users of a future port).  The
+characters could someday make life difficult for users of a future port).
+The
 dot (.) character is relatively safe as long as there is at most one per root
 name; some historical terminfo names use it.
 .PP
 dot (.) character is relatively safe as long as there is at most one per root
 name; some historical terminfo names use it.
 .PP
@@ -114,73 +134,78 @@ The root name prefix should be followed when appropriate by a model number;
 thus \fBvt100\fR, \fBhp2621\fR, \fBwy50\fR.
 .PP
 The root name for a PC-Unix console type should be the OS name,
 thus \fBvt100\fR, \fBhp2621\fR, \fBwy50\fR.
 .PP
 The root name for a PC-Unix console type should be the OS name,
-i.e. \fBlinux\fR, \fBbsdos\fR, \fBfreebsd\fR, \fBnetbsd\fR.  It should
+i.e., \fBlinux\fR, \fBbsdos\fR, \fBfreebsd\fR, \fBnetbsd\fR.  It should
 \fInot\fR be \fBconsole\fR or any other generic that might cause confusion in a
 multi-platform environment!  If a model number follows, it should indicate
 either the OS release level or the console driver release level.
 .PP
 The root name for a terminal emulator (assuming it does not fit one of the
 standard ANSI or vt100 types) should be the program name or a readily
 \fInot\fR be \fBconsole\fR or any other generic that might cause confusion in a
 multi-platform environment!  If a model number follows, it should indicate
 either the OS release level or the console driver release level.
 .PP
 The root name for a terminal emulator (assuming it does not fit one of the
 standard ANSI or vt100 types) should be the program name or a readily
-recognizable abbreviation of it (i.e. \fBversaterm\fR, \fBctrm\fR).
+recognizable abbreviation of it (i.e., \fBversaterm\fR, \fBctrm\fR).
 .PP
 Following the root name, you may add any reasonable number of hyphen-separated
 feature suffixes.
 .TP 5
 2p
 .PP
 Following the root name, you may add any reasonable number of hyphen-separated
 feature suffixes.
 .TP 5
 2p
-Has two pages of memory.  Likewise 4p, 8p, etc.
+Has two pages of memory.
+Likewise 4p, 8p, etc.
 .TP 5
 mc
 .TP 5
 mc
-Magic-cookie.  Some terminals (notably older Wyses) can only support one
-attribute without magic-cookie lossage.  Their base entry is usually paired
+Magic-cookie.
+Some terminals (notably older Wyses) can only support one
+attribute without magic-cookie lossage.
+Their base entry is usually paired
 with another that has this suffix and uses magic cookies to support multiple
 attributes.
 .TP 5
 with another that has this suffix and uses magic cookies to support multiple
 attributes.
 .TP 5
--am
+\-am
 Enable auto-margin (right-margin wraparound).
 .TP 5
 Enable auto-margin (right-margin wraparound).
 .TP 5
--m
-Mono mode - suppress color support.
+\-m
+Mono mode \- suppress color support.
 .TP 5
 .TP 5
--na
-No arrow keys - termcap ignores arrow keys which are actually there on the
+\-na
+No arrow keys \- termcap ignores arrow keys which are actually there on the
 terminal, so the user can use the arrow keys locally.
 .TP 5
 terminal, so the user can use the arrow keys locally.
 .TP 5
--nam
-No auto-margin - suppress am capability.
+\-nam
+No auto-margin \- suppress am capability.
 .TP 5
 .TP 5
--nl
-No labels - suppress soft labels.
+\-nl
+No labels \- suppress soft labels.
 .TP 5
 .TP 5
--nsl
-No status line - suppress status line.
+\-nsl
+No status line \- suppress status line.
 .TP 5
 .TP 5
--pp
+\-pp
 Has a printer port which is used.
 .TP 5
 Has a printer port which is used.
 .TP 5
--rv
+\-rv
 Terminal in reverse video mode (black on white).
 .TP 5
 Terminal in reverse video mode (black on white).
 .TP 5
--s
+\-s
 Enable status line.
 .TP 5
 Enable status line.
 .TP 5
--vb
+\-vb
 Use visible bell (flash) rather than beep.
 .TP 5
 Use visible bell (flash) rather than beep.
 .TP 5
--w
+\-w
 Wide; terminal is in 132 column mode.
 .PP
 Conventionally, if your terminal type is a variant intended to specify a
 Wide; terminal is in 132 column mode.
 .PP
 Conventionally, if your terminal type is a variant intended to specify a
-line height, that suffix should go first.  So, for a hypothetical FuBarCo
+line height, that suffix should go first.
+So, for a hypothetical FuBarCo
 model 2317 terminal in 30-line mode with reverse video, best form would be
 model 2317 terminal in 30-line mode with reverse video, best form would be
-\fBfubar-30-rv\fR (rather than, say, `fubar-rv-30').
+\fBfubar\-30\-rv\fR (rather than, say, \*(``fubar\-rv\-30\*('').
 .PP
 Terminal types that are written not as standalone entries, but rather as
 components to be plugged into other entries via \fBuse\fP capabilities,
 are distinguished by using embedded plus signs rather than dashes.
 .PP
 .PP
 Terminal types that are written not as standalone entries, but rather as
 components to be plugged into other entries via \fBuse\fP capabilities,
 are distinguished by using embedded plus signs rather than dashes.
 .PP
-Commands which use a terminal type to control display often accept a -T
-option that accepts a terminal name argument.  Such programs should fall back
-on the \fBTERM\fR environment variable when no -T option is specified.
+Commands which use a terminal type to control display often accept a \-T
+option that accepts a terminal name argument.
+Such programs should fall back
+on the \fBTERM\fR environment variable when no \-T option is specified.
 .SH PORTABILITY
 For maximum compatibility with older System V UNIXes, names and aliases
 should be unique within the first 14 characters.
 .SH PORTABILITY
 For maximum compatibility with older System V UNIXes, names and aliases
 should be unique within the first 14 characters.
@@ -196,9 +221,3 @@ tty line initialization (AT&T-like UNIXes)
 tty line initialization (BSD-like UNIXes)
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBterm\fR(\*n).
 tty line initialization (BSD-like UNIXes)
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBterm\fR(\*n).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: