]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/user_caps.5
ncurses 6.4 - patch 20230909
[ncurses.git] / man / user_caps.5
index f0b100a4e2ad255e01eae671ab85f3b82b45ed9e..0ca74be887c98d93f9d668c7013faca1a2355206 100644 (file)
@@ -1,5 +1,6 @@
+'\" t
 .\"***************************************************************************
-.\" Copyright 2018-2020,2021 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  *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: user_caps.5,v 1.21 2022/07/03 20:01:04 tom Exp $
-.TH user_caps 5
+.\" $Id: user_caps.5,v 1.32 2023/09/09 21:25:30 tom Exp $
+.TH user_caps 5 2023-09-09 "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
@@ -57,7 +44,6 @@ user_caps \- user-defined terminfo capabilities
 .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 +174,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:
@@ -345,7 +330,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 +345,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 +365,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,17 +400,14 @@ 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 SEE ALSO
-.PP
 \fB@INFOCMP@\fP(1M),
 \fB@TIC@\fP(1M).
 .PP
@@ -439,7 +422,6 @@ 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)