]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/user_caps.5.html
ncurses 6.4 - patch 20230805
[ncurses.git] / doc / html / man / user_caps.5.html
index 0fd1f15d202aae3fd90affd49680d5e37ec4a128..a939b949d6f12c7334a585b803812caa0d50a30b 100644 (file)
@@ -1,6 +1,7 @@
 <!--
+  * 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  *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: user_caps.5,v 1.17 2021/06/17 21:30:22 tom Exp @
+  * @Id: user_caps.5,v 1.28 2023/08/06 00:00:22 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>user_caps 5</TITLE>
+<TITLE>user_caps 5 2023-07-01 ncurses 6.4 File formats</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
 </HEAD>
 <BODY>
-<H1 class="no-header">user_caps 5</H1>
+<H1 class="no-header">user_caps 5 2023-07-01 ncurses 6.4 File formats</H1>
 <PRE>
-<STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>                  File Formats Manual                 <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>
+<STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>                     File formats                     <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>
 
 
 
                     (box1) box characters primary set
 
            The memory lock/unlock capabilities were included because they were
-           used in  the  X11R6  terminal  description  for  <STRONG>xterm</STRONG>.   The  <EM>box1</EM>
+           used in the X11R6 terminal  description  for  <STRONG>xterm(1)</STRONG>.   The  <EM>box1</EM>
            capability  is  used  in  tic  to  help  with terminal descriptions
            written for AIX.
 
            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  <STRONG>xterm</STRONG> to provide
+           ncurses  database  uses  a  convention based on <STRONG>xterm(1)</STRONG> to provide
            extended special-key names.
 
            Fitting that into termcap's limitation of 2-character  names  would
 
              The command "<STRONG>tput</STRONG> <STRONG>clear</STRONG>" does the same thing.
 
+          NQ 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 and  its  device
+             attributes.
+
           RGB
-             <EM>boolean</EM>, <EM>number</EM> <STRONG>or</STRONG> <EM>string</EM>, to assert  that  the  <STRONG>set_a_foreground</STRONG>
-             and  <STRONG>set_a_background</STRONG>  capabilities  correspond to <EM>direct</EM> <EM>colors</EM>,
-             using an RGB (red/green/blue) convention.  This capability allows
-             the  <STRONG>color_content</STRONG>  function to return appropriate values without
-             requiring the application to initialize colors using <STRONG>init_color</STRONG>.
+             <EM>boolean</EM>,   <EM>number</EM>   <STRONG>or</STRONG>   <EM>string</EM>,   used   to   assert   that  the
+             <STRONG>set_a_foreground</STRONG> and <STRONG>set_a_background</STRONG> capabilities correspond  to
+             <EM>direct</EM>  <EM>colors</EM>,  using  an RGB (red/green/blue) convention.  This
+             capability  allows   the   <STRONG>color_content</STRONG>   function   to   return
+             appropriate   values   without   requiring   the  application  to
+             initialize colors using <STRONG>init_color</STRONG>.
 
              The capability type determines the values which ncurses sees:
 
              Set this capability to a nonzero value to enable it.
 
           XM <EM>string</EM>, override ncurses's built-in string which enables/disables
-             <STRONG>xterm</STRONG> mouse mode.
+             <STRONG>xterm(1)</STRONG> mouse mode.
 
              ncurses  sends a character sequence to the terminal to initialize
              mouse mode, and when the user clicks the  mouse  buttons  or  (in
        combinations of modified special keys.  There is no standard  for  what
        those keys can send.
 
-       Since 1999, <STRONG>xterm</STRONG> has supported <EM>shift</EM>, <EM>control</EM>, <EM>alt</EM>, and <EM>meta</EM> modifiers
-       which produce distinct special-key strings.  In a terminal description,
-       ncurses  has  no special knowledge of the modifiers used.  Applications
-       can use the <EM>naming</EM> <EM>convention</EM>  established  for  <STRONG>xterm</STRONG>  to  find  these
-       special keys in the terminal description.
+       Since  1999,  <STRONG>xterm(1)</STRONG>  has  supported  <EM>shift</EM>,  <EM>control</EM>,  <EM>alt</EM>, and <EM>meta</EM>
+       modifiers which produce distinct special-key strings.   In  a  terminal
+       description,  ncurses  has  no special knowledge of the modifiers used.
+       Applications can use the <EM>naming</EM> <EM>convention</EM>  established  for  <STRONG>xterm</STRONG>  to
+       find these special keys in the terminal description.
 
        Starting  with  the curses convention that <EM>key</EM> <EM>names</EM> begin with "k" and
        that shifted special keys are  an  uppercase  name,  ncurses'  terminal
        database defines these names to which a suffix is added:
 
-            <EM>Name</EM>   <EM>Description</EM>
+            <STRONG>Name</STRONG>   <STRONG>Description</STRONG>
             ---------------------------------------------------------------
             kDC    special form of kdch1 (delete character)
             kDN    special form of kcud1 (cursor down)
 
        These are the suffixes used to denote the modifiers:
 
-            <EM>Value</EM>   <EM>Description</EM>
+            <STRONG>Value</STRONG>   <STRONG>Description</STRONG>
             ----------------------------------
             2       Shift
             3       Alt
        the  terminal  descriptions.   Some  of those features are mentioned in
        <STRONG>screen(1)</STRONG> or <STRONG>tmux(1)</STRONG>.
 
-       <EM>XTerm</EM> <EM>Control</EM> <EM>Sequences</EM>  provides  further  information  on  the  <STRONG>xterm</STRONG>
+       <EM>XTerm</EM> <EM>Control</EM> <EM>Sequences</EM> provides further information  on  the  <STRONG>xterm(1)</STRONG>
        features which are used in these extended capabilities.
 
 
 
 
 
-                                                                  <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>
+ncurses 6.4                       2023-07-01                      <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>