man/toe.1m

   1 .\"***************************************************************************
   2 .\" Copyright (c) 1998-2015,2017 Free Software Foundation, Inc.              *
   3 .\"                                                                          *
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   5 .\" copy of this software and associated documentation files (the            *
   6 .\" "Software"), to deal in the Software without restriction, including      *
   7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
   9 .\" copies of the Software, and to permit persons to whom the Software is    *
  10 .\" furnished to do so, subject to the following conditions:                 *
  11 .\"                                                                          *
  12 .\" The above copyright notice and this permission notice shall be included  *
  13 .\" in all copies or substantial portions of the Software.                   *
  14 .\"                                                                          *
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22 .\"                                                                          *
  23 .\" Except as contained in this notice, the name(s) of the above copyright   *
  24 .\" holders shall not be used in advertising or otherwise to promote the     *
  25 .\" sale, use or other dealings in this Software without prior written       *
  26 .\" authorization.                                                           *
  27 .\"***************************************************************************
  28 .\"
  29 .\" $Id: toe.1m,v 1.29 2017/02/18 17:10:26 tom Exp $
  30 .TH @TOE@ 1M ""
  31 .ie \n(.g .ds `` \(lq
  32 .el       .ds `` ``
  33 .ie \n(.g .ds '' \(rq
  34 .el       .ds '' ''
  35 .ds n 5
  36 .ds d @TERMINFO@
  37 .SH NAME
  38 \fB@TOE@\fR \- table of (terminfo) entries
  39 .SH SYNOPSIS
  40 \fB@TOE@\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahsuUV\fR] \fIfile...\fR
  41 .br
  42 .SH DESCRIPTION
  43 .PP
  44 With no options,
  45 \fB@TOE@\fR lists all available terminal types by primary name
  46 with descriptions.
  47 File arguments specify the directories to be scanned; if no
  48 such arguments are given,
  49 your default terminfo directory is scanned.
  50 If you also specify the \fB\-h\fR option,
  51 a directory header will be issued as each
  52 directory is entered.
  53 .PP
  54 There are other options intended for use by terminfo file maintainers:
  55 .TP
  56 \fB\-a\fR
  57 report on all of the terminal databases which ncurses would search,
  58 rather than only the first one that it finds.
  59 .IP
  60 If the \fB\-s\fR is also given, \fB@TOE@\fR
  61 adds a column to the report,
  62 showing (like \fBconflict\fP(1)) which entries which
  63 belong to a given terminal database.
  64 An "*" marks entries which differ, and "+" marks equivalent entries.
  65 .IP
  66 Without the \fB\-s\fP option, \fB@TOE@\fR does not attempt to merge
  67 duplicates in its report
  68 .TP
  69 \fB\-s\fR
  70 sort the output by the entry names.
  71 .TP
  72 \fB\-u\fR \fIfile\fR
  73 says to write a report to the standard output,
  74 listing dependencies in the given terminfo/termcap source file.
  75 The report condenses the \*(``use\*('' relation:
  76 each line consists of the primary name of a terminal that
  77 has use capabilities,
  78 followed by a colon,
  79 followed by the
  80 whitespace-separated primary names of all terminals which occur in those use
  81 capabilities,
  82 followed by a newline
  83 .TP
  84 \fB\-U\fR \fIfile\fR
  85 says to write a report to the standard output,
  86 listing reverse dependencies in the given terminfo/termcap source file.
  87 The report reverses the \*(``use\*('' relation:
  88 each line consists of the primary name of a
  89 terminal that occurs in use capabilities,
  90 followed by a colon,
  91 followed by the
  92 whitespace-separated primary names of all terminals which depend on it,
  93 followed by a newline.
  94 .TP
  95 \fB\-v\fR\fIn\fR
  96 specifies that (verbose) output be written to standard error,
  97 showing \fB@TOE@\fR's progress.
  98 .IP
  99 The optional parameter \fIn\fR is a number from 1 to 10,
 100 interpreted as for \fB@TIC@\fR(1M).
 101 If ncurses is built without tracing support, the optional parameter is ignored.
 102 .TP
 103 \fB\-V\fR
 104 reports the version of ncurses which was used in this program,
 105 and exits.
 106 .SH FILES
 107 .TP 5
 108 \fB\*d/?/*\fR
 109 Compiled terminal description database.
 110 .SH SEE ALSO
 111 \fB@TIC@\fR(1M),
 112 \fB@INFOCMP@\fR(1M),
 113 \fB@CAPTOINFO@\fR(1M),
 114 \fB@INFOTOCAP@\fR(1M),
 115 \fBcurses\fR(3X),
 116 \fBterminfo\fR(\*n).
 117 .PP
 118 This describes \fBncurses\fR
 119 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).