man/toe.1m

   1 .\"***************************************************************************
   2 .\" Copyright (c) 1998-2010,2011 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.26 2012/01/01 00:40:51 tom Exp $
  30 .TH @TOE@ 1M ""
  31 .ds n 5
  32 .ds d @TERMINFO@
  33 .SH NAME
  34 \fB@TOE@\fR \- table of (terminfo) entries
  35 .SH SYNOPSIS
  36 \fB@TOE@\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahsuUV\fR] \fIfile...\fR
  37 .br
  38 .SH DESCRIPTION
  39 .PP
  40 With no options,
  41 \fB@TOE@\fR lists all available terminal types by primary name
  42 with descriptions.
  43 File arguments specify the directories to be scanned; if no
  44 such arguments are given,
  45 your default terminfo directory is scanned.
  46 If you also specify the \fB\-h\fR option,
  47 a directory header will be issued as each
  48 directory is entered.
  49 .PP
  50 There are other options intended for use by terminfo file maintainers:
  51 .TP
  52 \fB\-a\fR
  53 report on all of the terminal databases which ncurses would search,
  54 rather than only the first one that it finds.
  55 .IP
  56 If the \fB\-s\fR is also given, \fB@TOE@\fR
  57 adds a column to the report,
  58 showing (like \fBconflict\fP(1)) which entries which
  59 belong to a given terminal database.
  60 An "*" marks entries which differ, and "+" marks equivalent entries.
  61 .TP
  62 \fB\-s\fR
  63 sort the output by the entry names.
  64 .TP
  65 \fB\-u\fR \fIfile\fR
  66 says to write a report to the standard output,
  67 listing dependencies in the given terminfo/termcap source file.
  68 The report condenses the `use' relation:
  69 each line consists of the primary name of a terminal that
  70 has use capabilities,
  71 followed by a colon,
  72 followed by the
  73 whitespace-separated primary names of all terminals which occur in those use
  74 capabilities,
  75 followed by a newline
  76 .TP
  77 \fB\-U\fR \fIfile\fR
  78 says to write a report to the standard output,
  79 listing reverse dependencies in the given terminfo/termcap source file.
  80 The report reverses the `use' relation:
  81 each line consists of the primary name of a
  82 terminal that occurs in use capabilities,
  83 followed by a colon,
  84 followed by the
  85 whitespace-separated primary names of all terminals which depend on it,
  86 followed by a newline.
  87 .TP
  88 \fB\-v\fR\fIn\fR
  89 specifies that (verbose) output be written to standard error,
  90 showing \fB@TOE@\fR's progress.
  91 The optional parameter \fIn\fR is a number from 1 to 10,
  92 interpreted as for \fB@TIC@\fR(1M).
  93 .TP
  94 \fB\-V\fR
  95 reports the version of ncurses which was used in this program,
  96 and exits.
  97 .SH FILES
  98 .TP 5
  99 \fB\*d/?/*\fR
 100 Compiled terminal description database.
 101 .SH SEE ALSO
 102 \fB@TIC@\fR(1M),
 103 \fB@INFOCMP@\fR(1M),
 104 \fB@CAPTOINFO@\fR(1M),
 105 \fB@INFOTOCAP@\fR(1M),
 106 \fBcurses\fR(3X),
 107 \fBterminfo\fR(\*n).
 108 .PP
 109 This describes \fBncurses\fR
 110 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).