usr.bin/tconv/tconv.1

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