Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | <!-- |
| 2 | **************************************************************************** |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 3 | * Copyright (c) 1998-2013,2014 Free Software Foundation, Inc. * |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 4 | * * |
| 5 | * Permission is hereby granted, free of charge, to any person obtaining a * |
| 6 | * copy of this software and associated documentation files (the * |
| 7 | * "Software"), to deal in the Software without restriction, including * |
| 8 | * without limitation the rights to use, copy, modify, merge, publish, * |
| 9 | * distribute, distribute with modifications, sublicense, and/or sell * |
| 10 | * copies of the Software, and to permit persons to whom the Software is * |
| 11 | * furnished to do so, subject to the following conditions: * |
| 12 | * * |
| 13 | * The above copyright notice and this permission notice shall be included * |
| 14 | * in all copies or substantial portions of the Software. * |
| 15 | * * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 17 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 18 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 19 | * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 20 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 21 | * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 22 | * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 23 | * * |
| 24 | * Except as contained in this notice, the name(s) of the above copyright * |
| 25 | * holders shall not be used in advertising or otherwise to promote the * |
| 26 | * sale, use or other dealings in this Software without prior written * |
| 27 | * authorization. * |
| 28 | **************************************************************************** |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 29 | * @Id: tic.1m,v 1.60 2014/05/24 22:00:11 tom Exp @ |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 30 | --> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 31 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 32 | <HTML> |
| 33 | <HEAD> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 34 | <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
| 35 | <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts"> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 36 | <TITLE>tic 1m</TITLE> |
| 37 | <link rev=made href="mailto:bug-ncurses@gnu.org"> |
| 38 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 39 | </HEAD> |
| 40 | <BODY> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 41 | <H1 class="no-header">tic 1m</H1> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 42 | <PRE> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 43 | <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> |
| 44 | |
| 45 | |
| 46 | |
| 47 | |
| 48 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 49 | <H2><a name="h2-NAME">NAME</a></H2><PRE> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 50 | <STRONG>tic</STRONG> - the <EM>terminfo</EM> entry-description compiler |
| 51 | |
| 52 | |
| 53 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 54 | <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 55 | <STRONG>tic</STRONG> [<STRONG>-01CDGIKLNTUVacfgrstx</STRONG>] [<STRONG>-e</STRONG> <EM>names</EM>] [<STRONG>-o</STRONG> <EM>dir</EM>] [<STRONG>-R</STRONG> <EM>sub-</EM> |
| 56 | <EM>set</EM>] [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-w</STRONG>[<EM>n</EM>]] <EM>file</EM> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 57 | |
| 58 | |
| 59 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 60 | <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 61 | The <STRONG>tic</STRONG> command translates a <STRONG>terminfo</STRONG> file from source |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 62 | format into compiled format. The compiled format is nec- |
| 63 | essary for use with the library routines in <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. |
| 64 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 65 | As described in <STRONG><A HREF="term.5.html">term(5)</A></STRONG>, the database may be either a |
| 66 | directory tree (one file per terminal entry) or a hashed |
| 67 | database (one record per entry). The <STRONG>tic</STRONG> command writes |
| 68 | only one type of entry, depending on how it was built: |
| 69 | |
| 70 | <STRONG>o</STRONG> For directory trees, the top-level directory, e.g., |
| 71 | /usr/share/terminfo, specifies the location of the |
| 72 | database. |
| 73 | |
| 74 | <STRONG>o</STRONG> For hashed databases, a filename is needed. If the |
| 75 | given file is not found by that name, but can be found |
| 76 | by adding the suffix ".db", then that is used. |
| 77 | |
| 78 | The default name for the hashed database is the same |
| 79 | as the default directory name (only adding a ".db" |
| 80 | suffix). |
| 81 | |
| 82 | In either case (directory or hashed database), <STRONG>tic</STRONG> will |
| 83 | create the container if it does not exist. For a direc- |
| 84 | tory, this would be the "terminfo" leaf, versus a "ter- |
| 85 | minfo.db" file. |
| 86 | |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 87 | The results are normally placed in the system terminfo |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 88 | database <STRONG>/usr/share/terminfo</STRONG>. The compiled terminal |
| 89 | description can be placed in a different terminfo data- |
| 90 | base. There are two ways to achieve this: |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 91 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 92 | <STRONG>o</STRONG> First, you may override the system default either by |
| 93 | using the <STRONG>-o</STRONG> option, or by setting the variable <STRONG>TER-</STRONG> |
| 94 | <STRONG>MINFO</STRONG> in your shell environment to a valid database |
| 95 | location. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 96 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 97 | <STRONG>o</STRONG> Secondly, if <STRONG>tic</STRONG> cannot write in <EM>/usr/share/terminfo</EM> |
| 98 | or the location specified using your TERMINFO vari- |
| 99 | able, it looks for the directory <EM>$HOME/.terminfo</EM> (or |
| 100 | hashed database <EM>$HOME/.terminfo.db)</EM>; if that location |
| 101 | exists, the entry is placed there. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 102 | |
| 103 | Libraries that read terminfo entries are expected to check |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 104 | in succession |
| 105 | |
| 106 | <STRONG>o</STRONG> a location specified with the TERMINFO environment |
| 107 | variable, |
| 108 | |
| 109 | <STRONG>o</STRONG> <EM>$HOME/.terminfo</EM>, |
| 110 | |
| 111 | <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS environment |
| 112 | variable, |
| 113 | |
| 114 | <STRONG>o</STRONG> a compiled-in list of directories |
| 115 | (/usr/local/ncurses/share/terminfo:/usr/share/ter- |
| 116 | minfo), and |
| 117 | |
| 118 | <STRONG>o</STRONG> the system terminfo database (<EM>/usr/share/terminfo</EM>). |
| 119 | |
| 120 | |
| 121 | </PRE> |
| 122 | <H3><a name="h3-OPTIONS">OPTIONS</a></H3><PRE> |
| 123 | <STRONG>-0</STRONG> restricts the output to a single line |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 124 | |
| 125 | <STRONG>-1</STRONG> restricts the output to a single column |
| 126 | |
| 127 | <STRONG>-a</STRONG> tells <STRONG>tic</STRONG> to retain commented-out capabilities |
| 128 | rather than discarding them. Capabilities are com- |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 129 | mented by prefixing them with a period. This sets |
| 130 | the <STRONG>-x</STRONG> option, because it treats the commented-out |
| 131 | entries as user-defined names. If the source is |
| 132 | termcap, accept the 2-character names required by |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 133 | version 6. Otherwise these are ignored. |
| 134 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 135 | <STRONG>-C</STRONG> Force source translation to termcap format. Note: |
| 136 | this differs from the <STRONG>-C</STRONG> option of <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> in |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 137 | that it does not merely translate capability names, |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 138 | but also translates terminfo strings to termcap |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 139 | format. Capabilities that are not translatable are |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 140 | left in the entry under their terminfo names but |
| 141 | commented out with two preceding dots. The actual |
| 142 | format used incorporates some improvements for |
| 143 | escaped characters from terminfo format. For a |
| 144 | stricter BSD-compatible translation, add the <STRONG>-K</STRONG> |
| 145 | option. |
| 146 | |
| 147 | If this is combined with <STRONG>-c</STRONG>, <STRONG>tic</STRONG> makes additional |
| 148 | checks to report cases where the terminfo values do |
| 149 | not have an exact equivalent in termcap form. For |
| 150 | example: |
| 151 | |
| 152 | <STRONG>o</STRONG> <STRONG>sgr</STRONG> usually will not convert, because termcap |
| 153 | lacks the ability to work with more than two |
| 154 | parameters, and because termcap lacks many of |
| 155 | the arithmetic/logical operators used in ter- |
| 156 | minfo. |
| 157 | |
| 158 | <STRONG>o</STRONG> capabilities with more than one delay or with |
| 159 | delays before the end of the string will not |
| 160 | convert completely. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 161 | |
| 162 | <STRONG>-c</STRONG> tells <STRONG>tic</STRONG> to only check <EM>file</EM> for errors, including |
| 163 | syntax problems and bad use links. If you specify |
| 164 | <STRONG>-C</STRONG> (<STRONG>-I</STRONG>) with this option, the code will print warn- |
| 165 | ings about entries which, after use resolution, are |
| 166 | more than 1023 (4096) bytes long. Due to a fixed |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 167 | buffer length in older termcap libraries, as well |
| 168 | as buggy checking for the buffer length (and a doc- |
| 169 | umented limit in terminfo), these entries may cause |
| 170 | core dumps with other implementations. |
| 171 | |
| 172 | <STRONG>tic</STRONG> checks string capabilities to ensure that those |
| 173 | with parameters will be valid expressions. It does |
| 174 | this check only for the predefined string capabili- |
| 175 | ties; those which are defined with the <STRONG>-x</STRONG> option |
| 176 | are ignored. |
| 177 | |
| 178 | <STRONG>-D</STRONG> tells <STRONG>tic</STRONG> to print the database locations that it |
| 179 | knows about, and exit. The first location shown is |
| 180 | the one to which it would write compiled terminal |
| 181 | descriptions. If <STRONG>tic</STRONG> is not able to find a |
| 182 | writable database location according to the rules |
| 183 | summarized above, it will print a diagnostic and |
| 184 | exit with an error rather than printing a list of |
| 185 | database locations. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 186 | |
| 187 | <STRONG>-e</STRONG> <EM>names</EM> |
| 188 | Limit writes and translations to the following |
| 189 | comma-separated list of terminals. If any name or |
| 190 | alias of a terminal matches one of the names in the |
| 191 | list, the entry will be written or translated as |
| 192 | normal. Otherwise no output will be generated for |
| 193 | it. The option value is interpreted as a file con- |
| 194 | taining the list if it contains a '/'. (Note: |
| 195 | depending on how tic was compiled, this option may |
| 196 | require <STRONG>-I</STRONG> or <STRONG>-C</STRONG>.) |
| 197 | |
| 198 | <STRONG>-f</STRONG> Display complex terminfo strings which contain |
| 199 | if/then/else/endif expressions indented for read- |
| 200 | ability. |
| 201 | |
| 202 | <STRONG>-G</STRONG> Display constant literals in decimal form rather |
| 203 | than their character equivalents. |
| 204 | |
| 205 | <STRONG>-g</STRONG> Display constant character literals in quoted form |
| 206 | rather than their decimal equivalents. |
| 207 | |
| 208 | <STRONG>-I</STRONG> Force source translation to terminfo format. |
| 209 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 210 | <STRONG>-K</STRONG> Suppress some longstanding ncurses extensions to |
| 211 | termcap format, e.g., "\s" for space. |
| 212 | |
| 213 | <STRONG>-L</STRONG> Force source translation to terminfo format using |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 214 | the long C variable names listed in <<STRONG>term.h</STRONG>> |
| 215 | |
| 216 | <STRONG>-N</STRONG> Disable smart defaults. Normally, when translating |
| 217 | from termcap to terminfo, the compiler makes a num- |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 218 | ber of assumptions about the defaults of string |
| 219 | capabilities <STRONG>reset1_string</STRONG>, <STRONG>carriage_return</STRONG>, <STRONG>cur-</STRONG> |
| 220 | <STRONG>sor_left</STRONG>, <STRONG>cursor_down</STRONG>, <STRONG>scroll_forward</STRONG>, <STRONG>tab</STRONG>, <STRONG>new-</STRONG> |
| 221 | <STRONG>line</STRONG>, <STRONG>key_backspace</STRONG>, <STRONG>key_left</STRONG>, and <STRONG>key_down</STRONG>, then |
| 222 | attempts to use obsolete termcap capabilities to |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 223 | deduce correct values. It also normally suppresses |
| 224 | output of obsolete termcap capabilities such as <STRONG>bs</STRONG>. |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 225 | This option forces a more literal translation that |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 226 | also preserves the obsolete capabilities. |
| 227 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 228 | <STRONG>-o</STRONG><EM>dir</EM> Write compiled entries to given database location. |
| 229 | Overrides the TERMINFO environment variable. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 230 | |
| 231 | <STRONG>-R</STRONG><EM>subset</EM> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 232 | Restrict output to a given subset. This option is |
| 233 | for use with archaic versions of terminfo like |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 234 | those on SVr1, Ultrix, or HP/UX that do not support |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 235 | the full set of SVR4/XSI Curses terminfo; and out- |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 236 | right broken ports like AIX 3.x that have their own |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 237 | extensions incompatible with SVr4/XSI. Available |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 238 | subsets are "SVr1", "Ultrix", "HP", "BSD" and |
| 239 | "AIX"; see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for details. |
| 240 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 241 | <STRONG>-r</STRONG> Force entry resolution (so there are no remaining |
| 242 | tc capabilities) even when doing translation to |
| 243 | termcap format. This may be needed if you are pre- |
| 244 | paring a termcap file for a termcap library (such |
| 245 | as GNU termcap through version 1.3 or BSD termcap |
| 246 | through 4.3BSD) that does not handle multiple tc |
| 247 | capabilities per entry. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 248 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 249 | <STRONG>-s</STRONG> Summarize the compile by showing the database loca- |
| 250 | tion into which entries are written, and the number |
| 251 | of entries which are compiled. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 252 | |
| 253 | <STRONG>-T</STRONG> eliminates size-restrictions on the generated text. |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 254 | This is mainly useful for testing and analysis, |
| 255 | since the compiled descriptions are limited (e.g., |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 256 | 1023 for termcap, 4096 for terminfo). |
| 257 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 258 | <STRONG>-t</STRONG> tells <STRONG>tic</STRONG> to discard commented-out capabilities. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 259 | Normally when translating from terminfo to termcap, |
| 260 | untranslatable capabilities are commented-out. |
| 261 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 262 | <STRONG>-U</STRONG> tells <STRONG>tic</STRONG> to not post-process the data after parsing |
| 263 | the source file. Normally, it infers data which is |
| 264 | commonly missing in older terminfo data, or in term- |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 265 | caps. |
| 266 | |
| 267 | <STRONG>-V</STRONG> reports the version of ncurses which was used in this |
| 268 | program, and exits. |
| 269 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 270 | <STRONG>-v</STRONG><EM>n</EM> specifies that (verbose) output be written to stan- |
| 271 | dard error trace information showing <STRONG>tic</STRONG>'s progress. |
| 272 | The optional parameter <EM>n</EM> is a number from 1 to 10, |
| 273 | inclusive, indicating the desired level of detail of |
| 274 | information. If <EM>n</EM> is omitted, the default level is |
| 275 | 1. If <EM>n</EM> is specified and greater than 1, the level |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 276 | of detail is increased. |
| 277 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 278 | The debug flag levels are as follows: |
| 279 | |
| 280 | 1 Names of files created and linked |
| 281 | |
| 282 | 2 Information related to the "use" facility |
| 283 | |
| 284 | 3 Statistics from the hashing algorithm |
| 285 | |
| 286 | 5 String-table memory allocations |
| 287 | |
| 288 | 7 Entries into the string-table |
| 289 | |
| 290 | 8 List of tokens encountered by scanner |
| 291 | |
| 292 | 9 All values computed in construction of the |
| 293 | hash table |
| 294 | |
| 295 | If the debug level <EM>n</EM> is not given, it is taken to be |
| 296 | one. |
| 297 | |
| 298 | <STRONG>-w</STRONG><EM>n</EM> specifies the width of the output. The parameter is |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 299 | optional. If it is omitted, it defaults to 60. |
| 300 | |
| 301 | <STRONG>-x</STRONG> Treat unknown capabilities as user-defined. That is, |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 302 | if you supply a capability name which <STRONG>tic</STRONG> does not |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 303 | recognize, it will infer its type (boolean, number or |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 304 | string) from the syntax and make an extended table |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 305 | entry for that. User-defined capability strings |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 306 | whose name begins with "k" are treated as function |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 307 | keys. |
| 308 | |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 309 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 310 | </PRE> |
| 311 | <H3><a name="h3-PARAMETERS">PARAMETERS</a></H3><PRE> |
| 312 | <EM>file</EM> contains one or more <STRONG>terminfo</STRONG> terminal descriptions |
| 313 | in source format [see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. Each descrip- |
| 314 | tion in the file describes the capabilities of a |
| 315 | particular terminal. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 316 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 317 | If <EM>file</EM> is "-", then the data is read from the |
| 318 | standard input. The <EM>file</EM> parameter may also be the |
| 319 | path of a character-device. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 320 | |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 321 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 322 | </PRE> |
| 323 | <H3><a name="h3-PROCESSING">PROCESSING</a></H3><PRE> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 324 | All but one of the capabilities recognized by <STRONG>tic</STRONG> are doc- |
| 325 | umented in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. The exception is the <STRONG>use</STRONG> capabil- |
| 326 | ity. |
| 327 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 328 | When a <STRONG>use</STRONG>=<EM>entry</EM>-<EM>name</EM> field is discovered in a terminal |
| 329 | entry currently being compiled, <STRONG>tic</STRONG> reads in the binary |
| 330 | from <STRONG>/usr/share/terminfo</STRONG> to complete the entry. (Entries |
| 331 | created from <EM>file</EM> will be used first. <STRONG>tic</STRONG> duplicates the |
| 332 | capabilities in <EM>entry</EM>-<EM>name</EM> for the current entry, with the |
| 333 | exception of those capabilities that explicitly are |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 334 | defined in the current entry. |
| 335 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 336 | When an entry, e.g., <STRONG>entry_name_1</STRONG>, contains a |
| 337 | <STRONG>use=</STRONG><EM>entry</EM>_<EM>name</EM>_<EM>2</EM> field, any canceled capabilities in |
| 338 | <EM>entry</EM>_<EM>name</EM>_<EM>2</EM> must also appear in <STRONG>entry_name_1</STRONG> before <STRONG>use=</STRONG> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 339 | for these capabilities to be canceled in <STRONG>entry_name_1</STRONG>. |
| 340 | |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 341 | Total compiled entries cannot exceed 4096 bytes. The name |
| 342 | field cannot exceed 512 bytes. Terminal names exceeding |
| 343 | the maximum alias length (32 characters on systems with |
| 344 | long filenames, 14 characters otherwise) will be truncated |
| 345 | to the maximum alias length and a warning message will be |
| 346 | printed. |
| 347 | |
| 348 | |
| 349 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 350 | <H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 351 | There is some evidence that historic <STRONG>tic</STRONG> implementations |
| 352 | treated description fields with no whitespace in them as |
| 353 | additional aliases or short names. This <STRONG>tic</STRONG> does not do |
| 354 | that, but it does warn when description fields may be |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 355 | treated that way and check them for dangerous characters. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 356 | |
| 357 | |
| 358 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 359 | <H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> |
| 360 | Unlike the SVr4 <STRONG>tic</STRONG> command, this implementation can actu- |
| 361 | ally compile termcap sources. In fact, entries in ter- |
| 362 | minfo and termcap syntax can be mixed in a single source |
| 363 | file. See <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for the list of termcap names taken |
| 364 | to be equivalent to terminfo names. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 365 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 366 | The SVr4 manual pages are not clear on the resolution |
| 367 | rules for <STRONG>use</STRONG> capabilities. This implementation of <STRONG>tic</STRONG> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 368 | will find <STRONG>use</STRONG> targets anywhere in the source file, or any- |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 369 | where in the file tree rooted at <STRONG>TERMINFO</STRONG> (if <STRONG>TERMINFO</STRONG> is |
| 370 | defined), or in the user's <EM>$HOME/.terminfo</EM> database (if it |
| 371 | exists), or (finally) anywhere in the system's file tree |
| 372 | of compiled entries. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 373 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 374 | The error messages from this <STRONG>tic</STRONG> have the same format as |
| 375 | GNU C error messages, and can be parsed by GNU Emacs's |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 376 | compile facility. |
| 377 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 378 | The <STRONG>-0</STRONG>, <STRONG>-1</STRONG>, <STRONG>-C</STRONG>, <STRONG>-G</STRONG>, <STRONG>-I</STRONG>, <STRONG>-N</STRONG>, <STRONG>-R</STRONG>, <STRONG>-T</STRONG>, <STRONG>-V</STRONG>, <STRONG>-a</STRONG>, <STRONG>-e</STRONG>, <STRONG>-f</STRONG>, <STRONG>-g</STRONG>, |
| 379 | <STRONG>-o</STRONG>, <STRONG>-r</STRONG>, <STRONG>-s</STRONG>, <STRONG>-t</STRONG> and <STRONG>-x</STRONG> options are not supported under |
| 380 | SVr4. The SVr4 <STRONG>-c</STRONG> mode does not report bad use links. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 381 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 382 | System V does not compile entries to or read entries from |
| 383 | your <EM>$HOME/.terminfo</EM> database unless TERMINFO is explic- |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 384 | itly set to it. |
| 385 | |
| 386 | |
| 387 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 388 | <H2><a name="h2-FILES">FILES</a></H2><PRE> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 389 | <STRONG>/usr/share/terminfo/?/*</STRONG> |
| 390 | Compiled terminal description database. |
| 391 | |
| 392 | |
| 393 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 394 | <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 395 | <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>, <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>, |
| 396 | <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>. <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 397 | |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 398 | This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20150808). |
| 399 | |
| 400 | |
| 401 | </PRE> |
| 402 | <H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE> |
| 403 | Eric S. Raymond <esr@snark.thyrsus.com> and |
| 404 | Thomas E. Dickey <dickey@invisible-island.net> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 405 | |
| 406 | |
| 407 | |
| 408 | <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> |
| 409 | </PRE> |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 410 | <div class="nav"> |
| 411 | <ul> |
| 412 | <li><a href="#h2-NAME">NAME</a></li> |
| 413 | <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> |
| 414 | <li><a href="#h2-DESCRIPTION">DESCRIPTION</a> |
| 415 | <ul> |
| 416 | <li><a href="#h3-OPTIONS">OPTIONS</a></li> |
| 417 | <li><a href="#h3-PARAMETERS">PARAMETERS</a></li> |
| 418 | <li><a href="#h3-PROCESSING">PROCESSING</a></li> |
| 419 | </ul> |
| 420 | </li> |
| 421 | <li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li> |
| 422 | <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li> |
| 423 | <li><a href="#h2-FILES">FILES</a></li> |
| 424 | <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 425 | <li><a href="#h2-AUTHOR">AUTHOR</a></li> |
| 426 | </ul> |
| 427 | </div> |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 428 | </BODY> |
| 429 | </HTML> |