6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / tic.1m
blob7a5960e2abee12cdc2708804399209d0c81bf97d
1 '\" te
2 .\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" Copyright 2011 Nexenta Systems, Inc. All rights Reserved.
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH TIC 1M "Jun 25, 2011"
9 .SH NAME
10 tic \- terminfo compiler
11 .SH SYNOPSIS
12 .LP
13 .nf
14 \fBtic\fR [\fB-v\fR [\fIn\fR]] [\fB-c\fR] \fIfile\fR
15 .fi
17 .SH DESCRIPTION
18 .sp
19 .LP
20 The command \fBtic\fR translates a \fBterminfo\fR file from the source format
21 into the compiled format. The results are placed in the directory
22 \fB/usr/share/lib/terminfo\fR. The compiled format is necessary for use with
23 the library routines in \fBcurses\fR(3CURSES).
24 .sp
25 .LP
26 If the environment variable \fBTERMINFO\fR is set, the compiled results are
27 placed there instead of \fB/usr/share/lib/terminfo\fR.
28 .sp
29 .LP
30 Total compiled entries cannot exceed 4096 bytes. The name field cannot exceed
31 128 bytes.
32 .SH OPTIONS
33 .sp
34 .LP
35 The following options are supported:
36 .sp
37 .ne 2
38 .na
39 \fB\fB-c\fR\fR
40 .ad
41 .RS 9n
42 Specifies to check only \fBfile\fR for errors. Errors in \fBuse=\fR links are
43 not detected.
44 .RE
46 .sp
47 .ne 2
48 .na
49 \fB\fB-v\fR[\fIn\fR]\fR
50 .ad
51 .RS 9n
52 Specify that (verbose) output be written to standard error trace information
53 showing \fBtic\fR's progress. The optional integer \fIn\fR is a number from 1
54 to 10, indicating the desired level of detail of information. If \fIn\fR is
55 omitted, the default level is 1. If \fIn\fR is specified and greater than 1,
56 the level of detail is increased.
57 .RE
59 .SH OPERANDS
60 .sp
61 .ne 2
62 .na
63 \fB\fBfile\fR\fR
64 .ad
65 .RS 8n
66 Contains one or more \fBterminfo\fR terminal descriptions in source format [see
67 \fBterminfo\fR(4)]. Each description in the file describes the capabilities of
68 a particular terminal. When a \fBuse\fR\fI=entry-name\fR field is discovered in
69 a terminal entry currently being compiled, \fBtic\fR reads in the binary from
70 \fB/usr/share/lib/terminfo\fR to complete the entry. (Entries created from
71 \fBfile\fR will be used first. If the environment variable
72 \fB\fR\fBTERM\fR\fBINFO \fR is set, that directory is searched instead of
73 \fB/usr/share/lib/terminfo\fR.) \fBtic\fR duplicates the capabilities in
74 \fIentry-name\fR for the current entry, with the exception of those
75 capabilities that are explicitly defined in the current entry.
76 .RE
78 .SH FILES
79 .sp
80 .ne 2
81 .na
82 \fB\fB/usr/share/lib/terminfo/?/*\fR\fR
83 .ad
84 .sp .6
85 .RS 4n
86 Compiled terminal description database
87 .RE
89 .SH ATTRIBUTES
90 .sp
91 .LP
92 See \fBattributes\fR(5) for descriptions of the following attributes:
93 .sp
95 .sp
96 .TS
97 box;
98 c | c
99 l | l .
100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
103 .SH SEE ALSO
106 \fBcaptoinfo\fR(1M), \fBinfocmp\fR(1M), \fBcurses\fR(3CURSES),
107 \fBterminfo\fR(4), \fBattributes\fR(5)
108 .SH NOTES
111 When an entry, for example, \fBentry_name_1\fR, contains a
112 \fBuse=\fR\fIentry_name_2\fR field, any canceled capabilities in
113 \fIentry_name_2\fR must also appear in \fBentry_name_1\fR before \fBuse=\fR for
114 these capabilities to be canceled in \fBentry_name_1\fR.