usr.bin/tic/tic.1

   1 .\"     $NetBSD: tic.1,v 1.12 2014/03/18 18:20:45 riastradh Exp $
   2 .\"
   3 .\" Copyright (c) 2009, 2010 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 June 3, 2012
  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 acSsx
  39 .Op Fl o Ar file
  40 .Ar source
  41 .Op Ar term1 term2 ...
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility compiles
  46 .Xr terminfo 5
  47 source into a database for use by other programs.
  48 The created database path name is the same as the source but with .cdb appended.
  49 .Pp
  50 The following options are available:
  51 .Bl -tag -width Fl
  52 .It Fl a
  53 Do not discard commented out capabilities.
  54 .It Fl c
  55 Only check for errors, don't write the final database.
  56 .It Fl o Ar file
  57 Write the database to
  58 .Ar file
  59 instead of
  60 .Ar source Ns .cdb .
  61 .It Fl S
  62 For
  63 .Ar term1 , term2 , ...
  64 output a C structure containing name, compiled description, and compiled size.
  65 This can be used to embed terminal descriptions into a program.
  66 .It Fl s
  67 Display the number of terminal descriptions written to the database.
  68 .It Fl x
  69 Include non standard capabilities defined in the
  70 .Ar source .
  71 .El
  72 .Ss Extensions To Terminfo
  73 When
  74 .Nm
  75 discovers a
  76 .Sy use Ns = Ns Va term
  77 capability, the terminal description for
  78 .Va term
  79 is merged in.
  80 Capabilities do not overwrite previously disovered ones and capabilities
  81 ending with @ are marked as absent so the terminal does not inherit the
  82 capability from
  83 .Sy use Ns d
  84 terminals.
  85 .Sh EXIT STATUS
  86 .Ex -std tic
  87 .Sh EXAMPLES
  88 To maintain your private terminfo definitions, if the system supplied
  89 ones do not support your terminal:
  90 .Bd -literal -offset indent
  91 .Ic tic ~/.terminfo
  92 .Ed
  93 .Sh SEE ALSO
  94 .Xr infocmp 1 ,
  95 .Xr tput 1 ,
  96 .Xr curses 3 ,
  97 .Xr terminfo 5
  98 .Sh STANDARDS
  99 The
 100 .Nm
 101 utility works with terminfo files that conform to the
 102 .St -xcurses4.2
 103 standard.
 104 .Sh AUTHORS
 105 .An Roy Marples Aq Mt roy@NetBSD.org