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