usr.bin/tconv/tconv.1

   1 .\" @(#) mytinfo tconv.1 3.2 92/02/01 public domain, By Ross Ridge
   2 .\" $Id: tconv.1,v 1.7 1997/02/22 19:57:23 peter Exp $
   3 .\"
   4 .Dd February 1, 1992
   5 .Dt TCONV 1
   6 .Os
   7 .Sh NAME
   8 .Nm tconv
   9 .Nd convert between termcap, terminfo source and terminfo binary
  10 .Sh SYNOPSIS
  11 .Nm tconv
  12 .Op Fl b
  13 .Op Fl c Op Fl OUGd
  14 .Op Fl i
  15 .Op Fl B Op Fl D Ar dir
  16 .Op Fl I
  17 .Op Fl k
  18 .Op Fl V
  19 .Op Fl t Ar term
  20 .Op Ar file
  21 .Nm tic
  22 .Op Ar file
  23 .Nm captoinfo
  24 .Op Fl t Ar term
  25 .Op Fl OUGdk
  26 .Op Ar file
  27 .Sh DESCRIPTION
  28 .Nm Tconv
  29 converts between the three terminal descriptions,
  30 termcap, terminfo source, and terminfo binary,
  31 that the
  32 .Em tinfo
  33 library uses.
  34 It performs the same functions of
  35 .Xr captoinfo 1
  36 and
  37 .Xr tic 1
  38 of System V.
  39 It also can be used to generate a terminfo source listing from a terminfo
  40 binary, one of the functions of System V's
  41 .Xr infocmp 1 .
  42 .Pp
  43 Translation options:
  44 .Bl -tag -width indent
  45 .It Fl c
  46 Convert from termcap.
  47 .It Fl i
  48 Convert from terminfo source.
  49 .It Fl b
  50 Convert from terminfo binary.
  51 .It Fl B
  52 Convert to terminfo binary.
  53 .It Fl I
  54 Convert to terminfo source.
  55 .El
  56 .Pp
  57 If a file is specified, one of
  58 .Fl c
  59 or
  60 .Fl i
  61 must specified and the whole file while be translated.
  62 If no file is specified then the input options will only restrict looking
  63 for the terminal to be translated in places likely have descriptions
  64 of the desired type
  65 (ie. with the
  66 .Fl c
  67 option in the
  68 .Ev TERMCAP
  69 environment variable, and in
  70 .Pa /usr/share/misc/termcap ,
  71 with the
  72 .Fl i
  73 option in the
  74 .Ev TERMINFO
  75 environment variable, and in
  76 .Pa /usr/lib/terminfo Ns ),
  77 otherwise
  78 .Nm
  79 will look in all available databases.
  80 If neither
  81 .Fl I
  82 or
  83 .Fl B
  84 are given the
  85 .Fl I
  86 option will be assumed.
  87 If the
  88 .Fl B
  89 option is used, the compiled output will be put in the
  90 terminfo database, otherwise standard output is used.
  91 .Pp
  92 You cannot translate from terminfo binary to terminfo binary.
  93 Translating from terminfo source to terminfo source is possible,
  94 but not of much use in most cases, as
  95 .Em use=
  96 fields will be followed and incorporated into the output terminal
  97 description.
  98 .Pp
  99 .Nm Tconv
 100 should be able translate all standard termcap parameterized strings
 101 terminfo format, but complex strings using GNU's %a code may be
 102 too hard to translate.
 103 If
 104 .Nm
 105 thinks a termcap string is already in terminfo format (if a %p
 106 code appears in the string), it won't try to translate it.
 107 String capabilities that don't take parameters won't be translated.
 108 .Pp
 109 Termcap options: the following options are available when translating termcap
 110 entries (
 111 .Fl c
 112 option is used).
 113 .Bl -tag -width indent
 114 .It Fl d
 115 Don't supply any defaults for missing capabilities.
 116 .It Fl O
 117 Include obsolete termcap capabilities.
 118 .It Fl G
 119 Include GNU capabilities.
 120 .It Fl U
 121 Include UW capabilities.
 122 .El
 123 .Pp
 124 Other options:
 125 .Bl -tag -width indent
 126 .It Fl k
 127 Keep comments when translating a file.
 128 .It Fl V
 129 Print version information and exit.
 130 .It Fl D Ar dir
 131 Directory to put terminfo binaries in.
 132 .It Fl t Ar term
 133 Terminal name to translate.
 134 .El
 135 .Pp
 136 If no terminal specified with the
 137 .Fl t
 138 option, then the terminal name to to translate will be taken from the
 139 environment variable
 140 .Ev TERM .
 141 .Sh FILES
 142 .Bl -tag -width /usr/lib/terminfo/terminfo.src -compact
 143 .It Pa /usr/lib/terminfo
 144 The default location to get and put terminfo binaries.
 145 .It Pa /usr/lib/terminfo/terminfo.src
 146 The default filename of the terminfo source file.
 147 .It Pa /etc/termcap
 148 The default filename of the termcap database.
 149 .El
 150 .Sh SEE ALSO
 151 .Xr curses 3 ,
 152 .Xr termcap 3 ,
 153 .Xr term 5 ,
 154 .Xr termcap 5 ,
 155 .Xr terminfo 5 .
 156 .Sh DIAGNOSTICS
 157 The line number of a warning message when translating a file
 158 may refer to the last line of an entry instead of the line in the entry
 159 that generated the warning.
 160 .Sh BUGS
 161 More warning messages could be generated.
 162 .Nm Tconv
 163 can't translate to termcap.  Binaries generated will have canceled
 164 capabilities marked as canceled, which is incompatible with
 165 System V Release 2.0 terminfo.