ncurses 6.4 - patch 20231001

[ncurses.git] / man / user_caps.5

diff --git a/man/user_caps.5 b/man/user_caps.5
index b43e218f376d7921d799c632dccc85e87e0b46b4..27c48f83d24efcf5929992ebcc4470b593aa94e0 100644 (file)
--- a/man/user_caps.5
+++ b/man/user_caps.5
@@ -1,5 +1,6 @@
+'\" t
 .\"***************************************************************************
-.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
 .\" Copyright 2017 Free Software Foundation, Inc.                            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,37 +28,23 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: user_caps.5,v 1.22 2022/07/03 20:01:04 tom Exp $
-.TH user_caps 5
+.\" $Id: user_caps.5,v 1.40 2023/09/30 23:47:46 tom Exp $
+.TH user_caps 5 2023-09-30 "ncurses 6.4" "File formats"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
-.de NS
-.ie n  .sp
-.el    .sp .5
-.ie n  .in +4
-.el    .in +2
-.nf
-.ft C                  \" Courier
-..
-.de NE
-.fi
-.ft R
-.ie n  .in -4
-.el    .in -2
-..
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
-user_caps \- user-defined terminfo capabilities
+user_caps \-
+user-defined \fIterminfo\fR capability format
 .SH SYNOPSIS
 .B @TIC@ -x, @INFOCMP@ -x
 .SH DESCRIPTION
 .SS Background
-.PP
 Before ncurses 5.0,
 terminfo databases used a \fIfixed repertoire\fP of terminal
 capabilities designed for the SVr2 terminal database in 1984,
@@ -188,7 +175,6 @@ Fitting that into termcap's limitation of 2-character names
 would be pointless.
 These extended keys are available only with terminfo.
 .SS Recognized capabilities
-.PP
 The ncurses library uses the user-definable capabilities.
 While the terminfo database may have other extensions,
 ncurses makes explicit checks for these:
@@ -208,6 +194,7 @@ the terminal.
 The command \*(``\fBtput clear\fP\*('' does the same thing.
 .TP 3
 NQ
+\fIboolean\fP,
 used to suppress a consistency check in @TIC@ for the ncurses capabilities
 in user6 through user9 (u6, u7, u8 and u9)
 which tell how to query the terminal's cursor position
@@ -345,7 +332,6 @@ xterm mouse protocols:
 .fi
 .
 .SS Extended key-definitions
-.PP
 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.
@@ -361,6 +347,7 @@ to find these special keys in the terminal description.
 Starting with the curses convention that \fIkey names\fP begin with \*(``k\*(''
 and that shifted special keys are an uppercase name,
 ncurses' terminal database defines these names to which a suffix is added:
+.PP
 .RS 5
 .TS
 tab(/) ;
@@ -380,6 +367,7 @@ kUP/special form of kcuu1 (cursor-up)
 .RE
 .PP
 These are the suffixes used to denote the modifiers:
+.PP
 .RS 5
 .TS
 tab(/) ;
@@ -414,32 +402,29 @@ ask \fBtigetstr\fP(3X) for their values, and
 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 AUTHORS
+Thomas E. Dickey
+.br
+beginning with ncurses 5.0 (1999)
+.\"
 .SH SEE ALSO
-.PP
-\fB@INFOCMP@\fP(1M),
-\fB@TIC@\fP(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).
+Some of those features are mentioned in \fB\%screen\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
-.br
-beginning with ncurses 5.0 (1999)
+provides further information on the \fB\%xterm\fP(1) features
+that are used in these extended capabilities.