ncurses 6.0 - patch 20171118
[ncurses.git] / man / tic.1m
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: tic.1m,v 1.66 2017/11/18 23:51:17 tom Exp $
30 .TH @TIC@ 1M ""
31 .ie \n(.g .ds `` \(lq
32 .el       .ds `` ``
33 .ie \n(.g .ds '' \(rq
34 .el       .ds '' ''
35 .ds n 5
36 .ds d @TERMINFO@
37 .de bP
38 .ie n  .IP \(bu 4
39 .el    .IP \(bu 2
40 ..
41 .SH NAME
42 \fB@TIC@\fR \- the \fIterminfo\fR entry-description compiler
43 .SH SYNOPSIS
44 \fB@TIC@\fR
45 [\fB\-\
46 0\
47 1\
48 C\
49 D\
50 G\
51 I\
52 K\
53 L\
54 N\
55 T\
56 U\
57 V\
58 W\
59 a\
60 c\
61 f\
62 g\
63 q\
64 r\
65 s\
66 t\
67 x\
68 \fR]
69 [\fB\-e\fR \fInames\fR]
70 [\fB\-o\fR \fIdir\fR]
71 [\fB\-Q\fR[\fIn\fR]]
72 [\fB\-R\fR \fIsubset\fR]
73 [\fB\-v\fR[\fIn\fR]]
74 [\fB\-w\fR[\fIn\fR]]
75 \fIfile\fR
76 .br
77 .SH DESCRIPTION
78 The \fB@TIC@\fR command translates a \fBterminfo\fR file from source
79 format into compiled format.
80 The compiled format is necessary for use with
81 the library routines in \fBncurses\fR(3X).
82 .PP
83 As described in \fBterm\fR(\*n), the database may be either a directory
84 tree (one file per terminal entry) or a hashed database (one record per entry).
85 The \fB@TIC@\fR command writes only one type of entry,
86 depending on how it was built:
87 .bP
88 For directory trees, the top-level directory, e.g., /usr/share/terminfo,
89 specifies the location of the database.
90 .bP
91 For hashed databases, a filename is needed.
92 If the given file is not found by that name,
93 but can be found by adding the suffix ".db",
94 then that is used.
95 .IP
96 The default name for the hashed database is the same as the
97 default directory name (only adding a ".db" suffix).
98 .PP
99 In either case (directory or hashed database),
100 \fB@TIC@\fP will create the container if it does not exist.
101 For a directory, this would be the "terminfo" leaf,
102 versus a "terminfo.db" file.
103 .PP
104 The results are normally placed in the system terminfo database \fB\*d\fR.
105 The compiled terminal description can be placed
106 in a different terminfo database.
107 There are two ways to achieve this:
108 .bP
109 First, you may override the system default either by
110 using the \fB\-o\fP option,
111 or by setting the variable \fBTERMINFO\fR
112 in your shell environment to a valid database location.
113 .bP
114 Secondly, if \fB@TIC@\fR cannot write in \fI\*d\fR
115 or the location specified using your TERMINFO variable,
116 it looks for the directory \fI$HOME/.terminfo\fR
117 (or hashed database \fI$HOME/.terminfo.db)\fR;
118 if that location exists, the entry is placed there.
119 .PP
120 Libraries that read terminfo entries are expected to check in succession
121 .bP
122 a location specified with the TERMINFO environment variable,
123 .bP
124 \fI$HOME/.terminfo\fR,
125 .bP
126 directories listed in the TERMINFO_DIRS environment variable,
127 .bP
128 a compiled-in list of directories (@TERMINFO_DIRS@), and
129 .bP
130 the system terminfo database (\fI\*d\fR).
131 .SS OPTIONS
132 .TP
133 \fB\-0\fR
134 restricts the output to a single line
135 .TP
136 \fB\-1\fR
137 restricts the output to a single column
138 .TP
139 \fB\-a\fR
140 tells \fB@TIC@\fP to retain commented-out capabilities rather than discarding
141 them.
142 Capabilities are commented by prefixing them with a period.
143 This sets the \fB\-x\fR option, because it treats the commented-out
144 entries as user-defined names.
145 If the source is termcap, accept the 2-character names required by version 6.
146 Otherwise these are ignored.
147 .TP
148 \fB\-C\fR
149 Force source translation to termcap format.
150 Note: this differs from the \fB\-C\fR
151 option of \fB@INFOCMP@\fR(1M) in that it does not merely translate capability
152 names, but also translates terminfo strings to termcap format.
153 Capabilities
154 that are not translatable are left in the entry under their terminfo names
155 but commented out with two preceding dots.
156 The actual format used incorporates some improvements for escaped characters
157 from terminfo format.
158 For a stricter BSD-compatible translation, add the \fB\-K\fR option.
159 .IP
160 If this is combined with \fB\-c\fR, \fB@TIC@\fR makes additional checks
161 to report cases where the terminfo values do not have an exact equivalent
162 in termcap form.
163 For example:
164 .RS
165 .bP
166 \fBsgr\fP usually will not convert, because termcap lacks the ability to
167 work with more than two parameters, and because termcap lacks many of
168 the arithmetic/logical operators used in terminfo.
169 .bP
170 capabilities with more than one delay or with delays before the end of
171 the string will not convert completely.
172 .RE
173 .TP
174 \fB\-c\fR
175 tells \fB@TIC@\fP to only check \fIfile\fR for errors, including syntax problems and
176 bad use links.
177 If you specify \fB\-C\fR (\fB\-I\fR) with this option, the code
178 will print warnings about entries which, after use resolution, are more than
179 1023 (4096) bytes long.
180 Due to a fixed buffer length in older termcap libraries,
181 as well as buggy checking for the buffer length
182 (and a documented limit in terminfo),
183 these entries may cause core
184 dumps with other implementations.
185 .IP
186 \fB@TIC@\fP checks string capabilities to ensure that those with parameters
187 will be valid expressions.
188 It does this check only for the predefined string capabilities;
189 those which are defined with the \fB\-x\fP option are ignored.
190 .TP
191 \fB\-D\fR
192 tells \fB@TIC@\fP to print the database locations that it knows about, and exit.
193 The first location shown is the one to which it would write compiled
194 terminal descriptions.
195 If \fB@TIC@\fP is not able to find a writable database location
196 according to the rules summarized above,
197 it will print a diagnostic and exit with an error rather than
198 printing a list of database locations.
199 .TP
200 \fB\-e \fR\fInames\fR
201 Limit writes and translations to the following comma-separated list of
202 terminals.
203 If any name or alias of a terminal matches one of the names in
204 the list, the entry will be written or translated as normal.
205 Otherwise no output will be generated for it.
206 The option value is interpreted as a file containing the list if it
207 contains a '/'.
208 (Note: depending on how tic was compiled, this option may require \fB\-I\fR or \fB\-C\fR.)
209 .TP
210 \fB\-f\fR
211 Display complex terminfo strings which contain if/then/else/endif expressions
212 indented for readability.
213 .TP
214 \fB\-G\fR
215 Display constant literals in decimal form
216 rather than their character equivalents.
217 .TP
218 \fB\-g\fR
219 Display constant character literals in quoted form
220 rather than their decimal equivalents.
221 .TP
222 \fB\-I\fR
223 Force source translation to terminfo format.
224 .TP
225 \fB\-K\fR
226 Suppress some longstanding ncurses extensions to termcap format,
227 e.g., "\\s" for space.
228 .TP
229 \fB\-L\fR
230 Force source translation to terminfo format
231 using the long C variable names listed in <\fBterm.h\fR>
232 .TP
233 \fB\-N\fR
234 Disable smart defaults.
235 Normally, when translating from termcap to terminfo, the compiler makes
236 a number of assumptions about the defaults of string capabilities
237 \fBreset1_string\fR, \fBcarriage_return\fR, \fBcursor_left\fR,
238 \fBcursor_down\fR, \fBscroll_forward\fR, \fBtab\fR, \fBnewline\fR,
239 \fBkey_backspace\fR, \fBkey_left\fR, and \fBkey_down\fR, then attempts
240 to use obsolete termcap capabilities to deduce correct values.
241 It also
242 normally suppresses output of obsolete termcap capabilities such as \fBbs\fR.
243 This option forces a more literal translation that also preserves the
244 obsolete capabilities.
245 .TP
246 \fB\-o\fR\fIdir\fR
247 Write compiled entries to given database location.
248 Overrides the TERMINFO environment variable.
249 .TP
250 \fB\-Q\fR\fIn\fR
251 Rather than show source in terminfo (text) format,
252 print the compiled (binary) format in hexadecimal or base64 form,
253 depending on the option's value:
254 .RS 8
255 .TP 3
256 1
257 hexadecimal
258 .TP 3
259 2
260 base64
261 .TP 3
262 3
263 hexadecimal and base64
264 .RE
265 .TP
266 \fB\-q\fR
267 Suppress comments and blank lines when showing translated source.
268 .TP
269 \fB\-R\fR\fIsubset\fR
270 Restrict output to a given subset.
271 This option is for use with archaic
272 versions of terminfo like those on SVr1, Ultrix, or HP/UX that do not support
273 the full set of SVR4/XSI Curses terminfo; and outright broken ports like AIX 3.x
274 that have their own extensions incompatible with SVr4/XSI.
275 Available subsets
276 are "SVr1", "Ultrix", "HP", "BSD" and "AIX"; see \fBterminfo\fR(\*n) for details.
277 .TP
278 \fB\-r\fR
279 Force entry resolution (so there are no remaining tc capabilities) even
280 when doing translation to termcap format.
281 This may be needed if you are
282 preparing a termcap file for a termcap library (such as GNU termcap through
283 version 1.3 or BSD termcap through 4.3BSD) that does not handle multiple
284 tc capabilities per entry.
285 .TP
286 \fB\-s\fR
287 Summarize the compile by showing the database location into which entries
288 are written, and the number of entries which are compiled.
289 .TP
290 \fB\-T\fR
291 eliminates size-restrictions on the generated text.
292 This is mainly useful for testing and analysis, since the compiled
293 descriptions are limited (e.g., 1023 for termcap, 4096 for terminfo).
294 .TP
295 \fB\-t\fR
296 tells \fB@TIC@\fP to discard commented-out capabilities.
297 Normally when translating from terminfo to termcap,
298 untranslatable capabilities are commented-out.
299 .TP 5
300 \fB\-U\fR
301 tells \fB@TIC@\fP to not post-process the data after parsing the source file.
302 Normally, it infers data which is commonly missing in older terminfo data,
303 or in termcaps.
304 .TP
305 \fB\-V\fR
306 reports the version of ncurses which was used in this program, and exits.
307 .TP
308 \fB\-v\fR\fIn\fR
309 specifies that (verbose) output be written to standard error trace
310 information showing \fB@TIC@\fR's progress.
311 .IP
312 The optional parameter \fIn\fR is a number from 1 to 10, inclusive,
313 indicating the desired level of detail of information.
314 If ncurses is built without tracing support, the optional parameter is ignored.
315 If \fIn\fR is omitted, the default level is 1.
316 If \fIn\fR is specified and greater than 1, the level of
317 detail is increased.
318 .RS
319 .PP
320 The debug flag levels are as follows:
321 .TP
322 1
323 Names of files created and linked
324 .TP
325 2
326 Information related to the \*(``use\*('' facility
327 .TP
328 3
329 Statistics from the hashing algorithm
330 .TP
331 5
332 String-table memory allocations
333 .TP
334 7
335 Entries into the string-table
336 .TP
337 8
338 List of tokens encountered by scanner
339 .TP
340 9
341 All values computed in construction of the hash table
342 .LP
343 If the debug level \fIn\fR is not given, it is taken to be one.
344 .RE
345 .TP
346 \fB\-W\fR
347 By itself, the \fB\-w\fP option will not force long strings to be wrapped.
348 Use the \fB\-W\fP option to do this.
349 .IP
350 If you specify both \fB\-f\fP and \fB\-W\fP options,
351 the latter is ignored when \fB\-f\fP has already split the line.
352 .TP
353 \fB\-w\fR\fIn\fR
354 specifies the width of the output.
355 The parameter is optional.
356 If it is omitted, it defaults to 60.
357 .TP
358 \fB\-x\fR
359 Treat unknown capabilities as user-defined.
360 That is, if you supply a capability name which \fB@TIC@\fP does not recognize,
361 it will infer its type (boolean, number or string) from the syntax and
362 make an extended table entry for that.
363 User-defined capability strings
364 whose name begins with \*(``k\*('' are treated as function keys.
365 .SS PARAMETERS
366 .TP
367 \fIfile\fR
368 contains one or more \fBterminfo\fR terminal descriptions in source
369 format [see \fBterminfo\fR(\*n)].
370 Each description in the file
371 describes the capabilities of a particular terminal.
372 .IP
373 If \fIfile\fR is \*(``-\*('', then the data is read from the standard input.
374 The \fIfile\fR parameter may also be the path of a character-device.
375 .SS PROCESSING
376 .PP
377 All but one of the capabilities recognized by \fB@TIC@\fR are documented
378 in \fBterminfo\fR(\*n).
379 The exception is the \fBuse\fR capability.
380 .PP
381 When a \fBuse\fR=\fIentry\fR\-\fIname\fR field is discovered in a
382 terminal entry currently being compiled, \fB@TIC@\fR reads in the binary
383 from \fB\*d\fR to complete the entry.
384 (Entries created from
385 \fIfile\fR will be used first.
386 \fB@TIC@\fR duplicates the capabilities in
387 \fIentry\fR\-\fIname\fR for the current entry, with the exception of
388 those capabilities that explicitly are defined in the current entry.
389 .PP
390 When an entry, e.g., \fBentry_name_1\fR, contains a
391 \fBuse=\fR\fIentry\fR_\fIname\fR_\fI2\fR field, any canceled
392 capabilities in \fIentry\fR_\fIname\fR_\fI2\fR must also appear in
393 \fBentry_name_1\fR before \fBuse=\fR for these capabilities to be
394 canceled in \fBentry_name_1\fR.
395 .PP
396 Total compiled entries cannot exceed 4096 bytes.
397 The name field cannot
398 exceed 512 bytes.
399 Terminal names exceeding the maximum alias length
400 (32 characters on systems with long filenames, 14 characters otherwise)
401 will be truncated to the maximum alias length and a warning message will be printed.
402 .SH COMPATIBILITY
403 There is some evidence that historic \fB@TIC@\fR implementations treated
404 description fields with no whitespace in them as additional aliases or
405 short names.
406 This \fB@TIC@\fR does not do that, but it does warn when
407 description fields may be treated that way and check them for dangerous
408 characters.
409 .SH EXTENSIONS
410 Unlike the SVr4 \fB@TIC@\fR command, this implementation can actually
411 compile termcap sources.
412 In fact, entries in terminfo and termcap syntax can
413 be mixed in a single source file.
414 See \fBterminfo\fR(\*n) for the list of
415 termcap names taken to be equivalent to terminfo names.
416 .PP
417 The SVr4 manual pages are not clear on the resolution rules for \fBuse\fR
418 capabilities.
419 This implementation of \fB@TIC@\fR will find \fBuse\fR targets anywhere
420 in the source file, or anywhere in the file tree rooted at \fBTERMINFO\fR (if
421 \fBTERMINFO\fR is defined),
422 or in the user's \fI$HOME/.terminfo\fR database
423 (if it exists),
424 or (finally) anywhere in the system's file tree of
425 compiled entries.
426 .PP
427 The error messages from this \fB@TIC@\fR have the same format as GNU C
428 error messages, and can be parsed by GNU Emacs's compile facility.
429 .PP
430 The
431 \fB\-0\fR,
432 \fB\-1\fR,
433 \fB\-C\fR,
434 \fB\-G\fR,
435 \fB\-I\fR,
436 \fB\-N\fR,
437 \fB\-R\fR,
438 \fB\-T\fR,
439 \fB\-V\fR,
440 \fB\-a\fR,
441 \fB\-e\fR,
442 \fB\-f\fR,
443 \fB\-g\fR,
444 \fB\-o\fR,
445 \fB\-r\fR,
446 \fB\-s\fR,
447 \fB\-t\fR and
448 \fB\-x\fR
449 options
450 are not supported under SVr4.
451 The SVr4 \fB\-c\fR mode does not report bad use links.
452 .PP
453 System V does not compile entries to or read entries from your
454 \fI$HOME/.terminfo\fR database unless TERMINFO is explicitly set to it.
455 .SH FILES
456 .TP 5
457 \fB\*d/?/*\fR
458 Compiled terminal description database.
459 .SH SEE ALSO
460 \fB@INFOCMP@\fR(1M),
461 \fB@CAPTOINFO@\fR(1M),
462 \fB@INFOTOCAP@\fR(1M),
463 \fB@TOE@\fR(1M),
464 \fBcurses\fR(3X),
465 \fBterm\fR(\*n).
466 \fBterminfo\fR(\*n).
467 .PP
468 This describes \fBncurses\fR
469 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
470 .SH AUTHOR
471 Eric S. Raymond <esr@snark.thyrsus.com>
472 and
473 .br
474 Thomas E. Dickey <dickey@invisible-island.net>