xref: /netbsd-src/usr.bin/tic/tic.1 (revision 7f21db1c0118155e0dd40b75182e30c589d9f63e)
1.\"	$NetBSD: tic.1,v 1.4 2010/02/05 16:54:11 roy Exp $
2.\"
3.\" Copyright (c) 2009 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Roy Marples.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd February 5, 2010
31.Dt TIC 1
32.Os
33.Sh NAME
34.Nm tic
35.Nd terminfo compiler
36.Sh SYNOPSIS
37.Nm tic
38.Op Fl acsx
39.Op Fl o Ar file
40.Ar source
41.Sh DESCRIPTION
42The
43.Nm
44utility compiles
45.Xr terminfo 5
46source into a database for use by other programs.
47The created database path name is the same as the source but with .db appended.
48.Pp
49The following options are available:
50.Bl -tag -width Fl
51.It Fl a
52Do not discard commented out capabilities.
53.It Fl c
54Only check for errors, don't write the final database.
55.It Fl o Ar file
56Write the database to
57.Ar file Ns .db
58instead of
59.Ar source Ns .db .
60.It Fl s
61Display the number of terminal descritions written to the database.
62.It Fl x
63Include non standard capabilities defined in the
64.Ar source .
65.El
66.Ss Extensions To Terminfo
67When
68.Nm
69discovers a
70.Sy use Ns = Ns Va term
71capability, the terminal description for
72.Va term
73is merged in.
74Capabilities do not overwrite previously disovered ones and capabilities
75ending with @ are marked as absent so the terminal does not inherit the
76capability from
77.Sy use Ns d
78terminals.
79.Sh EXIT STATUS
80.Ex -std tic
81.Sh EXAMPLES
82To maintain your private terminfo definitions, if the system supplied
83ones do not support your terminal:
84.Bd -literal -offset indent
85.Ic tic ~/.terminfo
86.Ed
87.Sh SEE ALSO
88.Xr infocmp 1 ,
89.Xr tput 1 ,
90.Xr curses 3 ,
91.Xr terminfo 5
92.Sh STANDARDS
93The
94.Nm
95utility works with terminfo files that conform to the
96.St -xcurses4.2
97standard.
98.Sh AUTHORS
99.An Roy Marples Aq roy@NetBSD.org
100