ncurses 6.3 - patch 20211225

[ncurses.git] / man / user_caps.5

diff --git a/man/user_caps.5 b/man/user_caps.5
index b07504c3e9b229859aa560df52e15b066a5fb6d8..6b6956dd8ecf3fe06cecc4458b8289192f668c0c 100644 (file)
--- a/man/user_caps.5
+++ b/man/user_caps.5
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2017-2019,2020 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 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            *
@@ -26,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: user_caps.5,v 1.11 2020/01/19 02:01:39 tom Exp $
+.\" $Id: user_caps.5,v 1.20 2021/12/25 21:09:22 tom Exp $
 .TH user_caps 5
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
@@ -123,9 +124,9 @@ box characters primary set
 .RE
 .IP
 The memory lock/unlock capabilities were included because they were used
-in the X11R6 terminal description for \fBxterm\fP.
+in the X11R6 terminal description for \fBxterm\fP(1).
 The \fIbox1\fP capability is used in @TIC@ to help with terminal descriptions
-written for AIX. 
+written for AIX.
 .PP
 During the 1990s, some users were reluctant to use terminfo
 in spite of its performance advantages over termcap:
@@ -180,7 +181,7 @@ While terminfo and termcap have a set of 60 predefined function-key names,
 to which a series of keys can be assigned,
 that is insufficient for more than a dozen keys multiplied by more than
 a couple of modifier combinations.
-The ncurses database uses a convention based on \fBxterm\fP to
+The ncurses database uses a convention based on \fBxterm\fP(1) to
 provide extended special-key names.
 .IP
 Fitting that into termcap's limitation of 2-character names
@@ -257,7 +258,7 @@ Set this capability to a nonzero value to enable it.
 XM
 \fIstring\fP,
 override ncurses's built-in string which
-enables/disables \fBxterm\fP mouse mode.
+enables/disables \fBxterm\fP(1) mouse mode.
 .IP
 ncurses sends a character sequence to the terminal to initialize mouse mode,
 and when the user clicks the mouse buttons or (in certain modes) moves the
@@ -343,7 +344,7 @@ Several terminals provide the ability to send distinct strings for
 combinations of modified special keys.
 There is no standard for what those keys can send.
 .PP
-Since 1999, \fBxterm\fP has supported
+Since 1999, \fBxterm\fP(1) has supported
 \fIshift\fP, \fIcontrol\fP, \fIalt\fP, and \fImeta\fP modifiers which produce
 distinct special-key strings.
 In a terminal description, ncurses has no special knowledge of the
@@ -358,7 +359,7 @@ ncurses' terminal database defines these names to which a suffix is added:
 .TS
 tab(/) ;
 l l .
-\fIName\fR/\fIDescription\fR
+\fBName\fP/\fBDescription\fP
 _
 kDC/special form of kdch1 (delete character)
 kDN/special form of kcud1 (cursor down)
@@ -377,7 +378,7 @@ These are the suffixes used to denote the modifiers:
 .TS
 tab(/) ;
 l l .
-\fIValue\fR/\fIDescription\fR
+\fBValue\fP/\fBDescription\fP
 _
 2/Shift
 3/Alt
@@ -408,16 +409,29 @@ given the list of values,
 ask \fBkey_defined\fP(3X) for the \fIkey-code\fP which
 would be returned for those keys by \fBwgetch\fP(3X).
 .PP
+.\"
 .SH PORTABILITY
 .PP
 The \*(``\-x\*('' extension feature of \fB@TIC@\fP and \fB@INFOCMP@\fP
 has been adopted in NetBSD curses.
 That implementation stores user-defined capabilities,
 but makes no use of these capabilities itself.
+.\"
 .SH SEE ALSO
 .PP
-\fB@TIC@\fR(1M),
-\fB@INFOCMP@\fR(1M).
+\fB@INFOCMP@\fP(1M),
+\fB@TIC@\fP(1M).
+.PP
+The terminal database section
+.I "NCURSES USER-DEFINABLE CAPABILITIES"
+summarizes commonly-used user-defined capabilities
+which are used in the terminal descriptions.
+Some of those features are mentioned in \fBscreen\fP(1) or \fBtmux\fP(1).
+.PP
+.I "XTerm Control Sequences"
+provides further information on the \fBxterm\fP(1) features
+which are used in these extended capabilities.
+.\"
 .SH AUTHORS
 .PP
 Thomas E. Dickey