usr.bin/tic/tic.1

*0a6a1f1dSLionel Sambuc.\"	$NetBSD: tic.1,v 1.12 2014/03/18 18:20:45 riastradh Exp $
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" Copyright (c) 2009, 2010 The NetBSD Foundation, Inc.
51e66a47SVivek Prakash.\" All rights reserved.
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" This code is derived from software contributed to The NetBSD Foundation
51e66a47SVivek Prakash.\" by Roy Marples.
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" Redistribution and use in source and binary forms, with or without
51e66a47SVivek Prakash.\" modification, are permitted provided that the following conditions
51e66a47SVivek Prakash.\" are met:
51e66a47SVivek Prakash.\" 1. Redistributions of source code must retain the above copyright
51e66a47SVivek Prakash.\"    notice, this list of conditions and the following disclaimer.
51e66a47SVivek Prakash.\" 2. Redistributions in binary form must reproduce the above copyright
51e66a47SVivek Prakash.\"    notice, this list of conditions and the following disclaimer in the
51e66a47SVivek Prakash.\"    documentation and/or other materials provided with the distribution.
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
51e66a47SVivek Prakash.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
51e66a47SVivek Prakash.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
51e66a47SVivek Prakash.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
51e66a47SVivek Prakash.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
51e66a47SVivek Prakash.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51e66a47SVivek Prakash.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
51e66a47SVivek Prakash.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
51e66a47SVivek Prakash.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
51e66a47SVivek Prakash.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
51e66a47SVivek Prakash.\" POSSIBILITY OF SUCH DAMAGE.
51e66a47SVivek Prakash.\"
84d9c625SLionel Sambuc.Dd June 3, 2012
51e66a47SVivek Prakash.Dt TIC 1
51e66a47SVivek Prakash.Os
51e66a47SVivek Prakash.Sh NAME
51e66a47SVivek Prakash.Nm tic
51e66a47SVivek Prakash.Nd terminfo compiler
51e66a47SVivek Prakash.Sh SYNOPSIS
51e66a47SVivek Prakash.Nm tic
51e66a47SVivek Prakash.Op Fl acSsx
51e66a47SVivek Prakash.Op Fl o Ar file
51e66a47SVivek Prakash.Ar source
51e66a47SVivek Prakash.Op Ar term1 term2 ...
51e66a47SVivek Prakash.Sh DESCRIPTION
51e66a47SVivek PrakashThe
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashutility compiles
51e66a47SVivek Prakash.Xr terminfo 5
51e66a47SVivek Prakashsource into a database for use by other programs.
84d9c625SLionel SambucThe created database path name is the same as the source but with .cdb appended.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashThe following options are available:
51e66a47SVivek Prakash.Bl -tag -width Fl
51e66a47SVivek Prakash.It Fl a
51e66a47SVivek PrakashDo not discard commented out capabilities.
51e66a47SVivek Prakash.It Fl c
51e66a47SVivek PrakashOnly check for errors, don't write the final database.
51e66a47SVivek Prakash.It Fl o Ar file
51e66a47SVivek PrakashWrite the database to
84d9c625SLionel Sambuc.Ar file
51e66a47SVivek Prakashinstead of
84d9c625SLionel Sambuc.Ar source Ns .cdb .
51e66a47SVivek Prakash.It Fl S
51e66a47SVivek PrakashFor
51e66a47SVivek Prakash.Ar term1 , term2 , ...
51e66a47SVivek Prakashoutput a C structure containing name, compiled description, and compiled size.
84d9c625SLionel SambucThis can be used to embed terminal descriptions into a program.
51e66a47SVivek Prakash.It Fl s
84d9c625SLionel SambucDisplay the number of terminal descriptions written to the database.
51e66a47SVivek Prakash.It Fl x
51e66a47SVivek PrakashInclude non standard capabilities defined in the
51e66a47SVivek Prakash.Ar source .
51e66a47SVivek Prakash.El
51e66a47SVivek Prakash.Ss Extensions To Terminfo
51e66a47SVivek PrakashWhen
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashdiscovers a
51e66a47SVivek Prakash.Sy use Ns = Ns Va term
51e66a47SVivek Prakashcapability, the terminal description for
51e66a47SVivek Prakash.Va term
51e66a47SVivek Prakashis merged in.
51e66a47SVivek PrakashCapabilities do not overwrite previously disovered ones and capabilities
51e66a47SVivek Prakashending with @ are marked as absent so the terminal does not inherit the
51e66a47SVivek Prakashcapability from
51e66a47SVivek Prakash.Sy use Ns d
51e66a47SVivek Prakashterminals.
51e66a47SVivek Prakash.Sh EXIT STATUS
51e66a47SVivek Prakash.Ex -std tic
51e66a47SVivek Prakash.Sh EXAMPLES
51e66a47SVivek PrakashTo maintain your private terminfo definitions, if the system supplied
51e66a47SVivek Prakashones do not support your terminal:
51e66a47SVivek Prakash.Bd -literal -offset indent
51e66a47SVivek Prakash.Ic tic ~/.terminfo
51e66a47SVivek Prakash.Ed
51e66a47SVivek Prakash.Sh SEE ALSO
51e66a47SVivek Prakash.Xr infocmp 1 ,
51e66a47SVivek Prakash.Xr tput 1 ,
51e66a47SVivek Prakash.Xr curses 3 ,
51e66a47SVivek Prakash.Xr terminfo 5
51e66a47SVivek Prakash.Sh STANDARDS
51e66a47SVivek PrakashThe
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashutility works with terminfo files that conform to the
51e66a47SVivek Prakash.St -xcurses4.2
51e66a47SVivek Prakashstandard.
51e66a47SVivek Prakash.Sh AUTHORS
84d9c625SLionel Sambuc.An Roy Marples Aq Mt roy@NetBSD.org