xref: /netbsd-src/usr.bin/tic/tic.1 (revision 98ea63c46867bf44f24a87a017b271e2682c5026)
1*98ea63c4Sabhinav.\"	$NetBSD: tic.1,v 1.13 2017/02/22 13:43:15 abhinav Exp $
24ca00e00Sroy.\"
355a396b9Sroy.\" Copyright (c) 2009, 2010 The NetBSD Foundation, Inc.
44ca00e00Sroy.\" All rights reserved.
54ca00e00Sroy.\"
64ca00e00Sroy.\" This code is derived from software contributed to The NetBSD Foundation
74ca00e00Sroy.\" by Roy Marples.
84ca00e00Sroy.\"
94ca00e00Sroy.\" Redistribution and use in source and binary forms, with or without
104ca00e00Sroy.\" modification, are permitted provided that the following conditions
114ca00e00Sroy.\" are met:
124ca00e00Sroy.\" 1. Redistributions of source code must retain the above copyright
134ca00e00Sroy.\"    notice, this list of conditions and the following disclaimer.
144ca00e00Sroy.\" 2. Redistributions in binary form must reproduce the above copyright
154ca00e00Sroy.\"    notice, this list of conditions and the following disclaimer in the
164ca00e00Sroy.\"    documentation and/or other materials provided with the distribution.
174ca00e00Sroy.\"
184ca00e00Sroy.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
194ca00e00Sroy.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
204ca00e00Sroy.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
214ca00e00Sroy.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
224ca00e00Sroy.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
234ca00e00Sroy.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
244ca00e00Sroy.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
254ca00e00Sroy.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
264ca00e00Sroy.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
274ca00e00Sroy.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
284ca00e00Sroy.\" POSSIBILITY OF SUCH DAMAGE.
294ca00e00Sroy.\"
30fc67b0cdSjoerg.Dd June 3, 2012
314ca00e00Sroy.Dt TIC 1
324ca00e00Sroy.Os
334ca00e00Sroy.Sh NAME
344ca00e00Sroy.Nm tic
354ca00e00Sroy.Nd terminfo compiler
364ca00e00Sroy.Sh SYNOPSIS
374ca00e00Sroy.Nm tic
3866fbc76fSwiz.Op Fl acSsx
394ca00e00Sroy.Op Fl o Ar file
404ca00e00Sroy.Ar source
4155a396b9Sroy.Op Ar term1 term2 ...
424ca00e00Sroy.Sh DESCRIPTION
434ca00e00SroyThe
444ca00e00Sroy.Nm
454ca00e00Sroyutility compiles
464ca00e00Sroy.Xr terminfo 5
474ca00e00Sroysource into a database for use by other programs.
48fc67b0cdSjoergThe created database path name is the same as the source but with .cdb appended.
494ca00e00Sroy.Pp
504ca00e00SroyThe following options are available:
514ca00e00Sroy.Bl -tag -width Fl
524ca00e00Sroy.It Fl a
534ca00e00SroyDo not discard commented out capabilities.
544ca00e00Sroy.It Fl c
554ca00e00SroyOnly check for errors, don't write the final database.
564ca00e00Sroy.It Fl o Ar file
574ca00e00SroyWrite the database to
58fc67b0cdSjoerg.Ar file
594ca00e00Sroyinstead of
60fc67b0cdSjoerg.Ar source Ns .cdb .
6166fbc76fSwiz.It Fl S
6266fbc76fSwizFor
6366fbc76fSwiz.Ar term1 , term2 , ...
64a2542d1aSwizoutput a C structure containing name, compiled description, and compiled size.
65eb11ed07SpgoyetteThis can be used to embed terminal descriptions into a program.
664ca00e00Sroy.It Fl s
67eb11ed07SpgoyetteDisplay the number of terminal descriptions written to the database.
684ca00e00Sroy.It Fl x
694ca00e00SroyInclude non standard capabilities defined in the
704ca00e00Sroy.Ar source .
714ca00e00Sroy.El
724ca00e00Sroy.Ss Extensions To Terminfo
734ca00e00SroyWhen
744ca00e00Sroy.Nm
754ca00e00Sroydiscovers a
764ca00e00Sroy.Sy use Ns = Ns Va term
774ca00e00Sroycapability, the terminal description for
784ca00e00Sroy.Va term
794ca00e00Sroyis merged in.
80*98ea63c4SabhinavCapabilities do not overwrite previously discovered ones and capabilities
814ca00e00Sroyending with @ are marked as absent so the terminal does not inherit the
824ca00e00Sroycapability from
834ca00e00Sroy.Sy use Ns d
844ca00e00Sroyterminals.
854ca00e00Sroy.Sh EXIT STATUS
86fcf135c0Swiz.Ex -std tic
874ca00e00Sroy.Sh EXAMPLES
884ca00e00SroyTo maintain your private terminfo definitions, if the system supplied
894ca00e00Sroyones do not support your terminal:
904ca00e00Sroy.Bd -literal -offset indent
914ca00e00Sroy.Ic tic ~/.terminfo
924ca00e00Sroy.Ed
934ca00e00Sroy.Sh SEE ALSO
944ca00e00Sroy.Xr infocmp 1 ,
954ca00e00Sroy.Xr tput 1 ,
964ca00e00Sroy.Xr curses 3 ,
974ca00e00Sroy.Xr terminfo 5
984ca00e00Sroy.Sh STANDARDS
994ca00e00SroyThe
1004ca00e00Sroy.Nm
1014ca00e00Sroyutility works with terminfo files that conform to the
1024ca00e00Sroy.St -xcurses4.2
1034ca00e00Sroystandard.
1044ca00e00Sroy.Sh AUTHORS
105a5684d07Swiz.An Roy Marples Aq Mt roy@NetBSD.org
106