X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Ftic.1m;h=878e213ba7e405e8943348212604ceb18f6851f9;hp=57c9b8a182ee174d3f0743d3a0b8e0188c308ad9;hb=6b96eb711cbf58da43002ff14b66d8a52c19a731;hpb=5e36f11feab6f790e0cc6f2c882a67b7b65e3b6b diff --git a/man/tic.1m b/man/tic.1m index 57c9b8a1..878e213b 100644 --- a/man/tic.1m +++ b/man/tic.1m @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2013,2014 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,8 +26,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tic.1m,v 1.53 2011/12/17 23:13:19 tom Exp $ +.\" $Id: tic.1m,v 1.60 2014/05/24 22:00:11 tom Exp $ .TH @TIC@ 1M "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .ds n 5 .ds d @TERMINFO@ .de bP @@ -74,7 +78,8 @@ the library routines in \fBncurses\fR(3X). .PP As described in \fBterm\fR(\*n), the database may be either a directory tree (one file per terminal entry) or a hashed database (one record per entry). -The \fB@TIC@\fR writes only one type of entry, depending on how it was built: +The \fB@TIC@\fR command writes only one type of entry, +depending on how it was built: .bP For directory trees, the top-level directory, e.g., /usr/share/terminfo, specifies the location of the database. @@ -87,14 +92,20 @@ then that is used. The default name for the hashed database is the same as the default directory name (only adding a ".db" suffix). .PP +In either case (directory or hashed database), +\fB@TIC@\fP will create the container if it does not exist. +For a directory, this would be the "terminfo" leaf, +versus a "terminfo.db" file. +.PP The results are normally placed in the system terminfo database \fB\*d\fR. -The compiled terminal description can be placed in a different terminfo database. +The compiled terminal description can be placed +in a different terminfo database. There are two ways to achieve this: .bP -First, you may override the system default by setting the variable -\fBTERMINFO\fR in your shell environment to a valid database -location, e.g., an existing directory (for directory trees) or -valid location for a hashed database. +First, you may override the system default either by +using the \fB\-o\fP option, +or by setting the variable \fBTERMINFO\fR +in your shell environment to a valid database location. .bP Secondly, if \fB@TIC@\fR cannot write in \fI\*d\fR or the location specified using your TERMINFO variable, @@ -102,10 +113,18 @@ it looks for the directory \fI$HOME/.terminfo\fR (or hashed database \fI$HOME/.terminfo.db)\fR; if that location exists, the entry is placed there. .PP -Libraries that read terminfo entries are expected to check for -a location specified with the TERMINFO variable first, -look at \fI$HOME/.terminfo\fR if TERMINFO is not set, and -finally look in \fI\*d\fR. +Libraries that read terminfo entries are expected to check in succession +.bP +a location specified with the TERMINFO environment variable, +.bP +\fI$HOME/.terminfo\fR, +.bP +directories listed in the TERMINFO_DIRS environment variable, +.bP +a compiled-in list of directories (@TERMINFO_DIRS@), and +.bP +the system terminfo database (\fI\*d\fR). +.SS OPTIONS .TP \fB\-0\fR restricts the output to a single line @@ -133,6 +152,20 @@ but commented out with two preceding dots. The actual format used incorporates some improvements for escaped characters from terminfo format. For a stricter BSD-compatible translation, add the \fB\-K\fR option. +.IP +If this is combined with \fB\-c\fR, \fB@TIC@\fR makes additional checks +to report cases where the terminfo values do not have an exact equivalent +in termcap form. +For example: +.RS +.bP +\fBsgr\fP usually will not convert, because termcap lacks the ability to +work with more than two parameters, and because termcap lacks many of +the arithmetic/logical operators used in terminfo. +.bP +capabilities with more than one delay or with delays before the end of +the string will not convert completely. +.RE .TP \fB\-c\fR tells \fB@TIC@\fP to only check \fIfile\fR for errors, including syntax problems and @@ -145,6 +178,11 @@ as well as buggy checking for the buffer length (and a documented limit in terminfo), these entries may cause core dumps with other implementations. +.IP +\fB@TIC@\fP checks string capabilities to ensure that those with parameters +will be valid expressions. +It does this check only for the predefined string capabilities; +those which are defined with the \fB\-x\fP option are ignored. .TP \fB\-D\fR tells \fB@TIC@\fP to print the database locations that it knows about, and exit. @@ -252,25 +290,7 @@ indicating the desired level of detail of information. If \fIn\fR is omitted, the default level is 1. If \fIn\fR is specified and greater than 1, the level of detail is increased. -.TP -\fB\-w\fR\fIn\fR -specifies the width of the output. -The parameter is optional. -If it is omitted, it defaults to 60. -.TP -\fB\-x\fR -Treat unknown capabilities as user-defined. -That is, if you supply a capability name which \fB@TIC@\fP does not recognize, -it will infer its type (boolean, number or string) from the syntax and -make an extended table entry for that. -User-defined capability strings -whose name begins with ``k'' are treated as function keys. -.TP -\fIfile\fR -contains one or more \fBterminfo\fR terminal descriptions in source -format [see \fBterminfo\fR(\*n)]. -Each description in the file -describes the capabilities of a particular terminal. +.RS .PP The debug flag levels are as follows: .TP @@ -278,7 +298,7 @@ The debug flag levels are as follows: Names of files created and linked .TP 2 -Information related to the ``use'' facility +Information related to the \*(``use\*('' facility .TP 3 Statistics from the hashing algorithm @@ -296,6 +316,31 @@ List of tokens encountered by scanner All values computed in construction of the hash table .LP If the debug level \fIn\fR is not given, it is taken to be one. +.RE +.TP +\fB\-w\fR\fIn\fR +specifies the width of the output. +The parameter is optional. +If it is omitted, it defaults to 60. +.TP +\fB\-x\fR +Treat unknown capabilities as user-defined. +That is, if you supply a capability name which \fB@TIC@\fP does not recognize, +it will infer its type (boolean, number or string) from the syntax and +make an extended table entry for that. +User-defined capability strings +whose name begins with \*(``k\*('' are treated as function keys. +.SS PARAMETERS +.TP +\fIfile\fR +contains one or more \fBterminfo\fR terminal descriptions in source +format [see \fBterminfo\fR(\*n)]. +Each description in the file +describes the capabilities of a particular terminal. +.IP +If \fIfile\fR is \*(``-\*('', then the data is read from the standard input. +The \fIfile\fR parameter may also be the path of a character-device. +.SS PROCESSING .PP All but one of the capabilities recognized by \fB@TIC@\fR are documented in \fBterminfo\fR(\*n). @@ -306,9 +351,7 @@ terminal entry currently being compiled, \fB@TIC@\fR reads in the binary from \fB\*d\fR to complete the entry. (Entries created from \fIfile\fR will be used first. -If the environment variable -\fBTERMINFO\fR is set, that database location is searched instead of -\fB\*d\fR.) \fB@TIC@\fR duplicates the capabilities in +\fB@TIC@\fR duplicates the capabilities in \fIentry\fR\-\fIname\fR for the current entry, with the exception of those capabilities that explicitly are defined in the current entry. .PP @@ -318,9 +361,6 @@ capabilities in \fIentry\fR_\fIname\fR_\fI2\fR must also appear in \fBentry_name_1\fR before \fBuse=\fR for these capabilities to be canceled in \fBentry_name_1\fR. .PP -If the environment variable \fBTERMINFO\fR is set, the compiled -results are placed there instead of \fB\*d\fR. -.PP Total compiled entries cannot exceed 4096 bytes. The name field cannot exceed 512 bytes. @@ -335,7 +375,7 @@ This \fB@TIC@\fR does not do that, but it does warn when description fields may be treated that way and check them for dangerous characters. .SH EXTENSIONS -Unlike the stock SVr4 \fB@TIC@\fR command, this implementation can actually +Unlike the SVr4 \fB@TIC@\fR command, this implementation can actually compile termcap sources. In fact, entries in terminfo and termcap syntax can be mixed in a single source file.