ncurses 5.7 - patch 20100731
[ncurses.git] / man / tic.1m
index 29d5261972eae3b4eda8281bc691c5977a5ad5d6..ec30e59633fedb18c92d016bfb9fdff2bd61732f 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2006,2010 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: tic.1m,v 1.35 2003/05/11 00:32:53 tom Exp $
-.TH tic 1M ""
+.\" $Id: tic.1m,v 1.45 2010/07/31 16:08:48 tom Exp $
+.TH @TIC@ 1M ""
 .ds n 5
 .ds d @TERMINFO@
 .SH NAME
-\fBtic\fR - the \fIterminfo\fR entry-description compiler
+\fBtic\fR \- the \fIterminfo\fR entry-description compiler
 .SH SYNOPSIS
 \fBtic\fR
 [\fB\-\
@@ -42,6 +42,7 @@ I\
 L\
 N\
 T\
+U\
 V\
 a\
 c\
@@ -86,10 +87,12 @@ tells \fBtic\fP to retain commented-out capabilities rather than discarding
 them.  Capabilities are commented by prefixing them with a period.
 This sets the \fB\-x\fR option, because it treats the commented-out
 entries as user-defined names.
+If the source is termcap, accept the 2-character names required by version 6.
+Otherwise these are ignored.
 .TP
 \fB\-C\fR
 Force source translation to termcap format.  Note: this differs from the \fB\-C\fR
-option of \fIinfocmp\fR(1M) in that it does not merely translate capability
+option of \fB@INFOCMP@\fR(1M) in that it does not merely translate capability
 names, but also translates terminfo strings to termcap format.  Capabilities
 that are not translatable are left in the entry under their terminfo names
 but commented out with two preceding dots.
@@ -174,26 +177,36 @@ descriptions are limited (e.g., 1023 for termcap, 4096 for terminfo).
 tells \fBtic\fP to discard commented-out capabilities.
 Normally when translating from terminfo to termcap,
 untranslatable capabilities are commented-out.
+.TP 5
+\fB\-U\fR
+tells \fBtic\fP to not post-process the data after parsing the source file.
+Normally, it infers data which is commonly missing in older terminfo data,
+or in termcaps.
 .TP
 \fB\-V\fR
 reports the version of ncurses which was used in this program, and exits.
 .TP
 \fB\-v\fR\fIn\fR
 specifies that (verbose) output be written to standard error trace
-information showing \fBtic\fR's progress.  The optional integer
-\fIn\fR is a number from 1 to 10, inclusive, 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
+information showing \fBtic\fR's progress.
+The optional parameter \fIn\fR is a number from 1 to 10, inclusive,
+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 \fBtic\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
@@ -227,25 +240,25 @@ If the debug level \fIn\fR is not given, it is taken to be one.
 .PP
 All but one of the capabilities recognized by \fBtic\fR are documented
 in \fBterminfo\fR(\*n).  The exception is the \fBuse\fR capability.
-
-When a \fBuse\fR=\fIentry\fR-\fIname\fR field is discovered in a
+.PP
+When a \fBuse\fR=\fIentry\fR\-\fIname\fR field is discovered in a
 terminal entry currently being compiled, \fBtic\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 directory is searched instead of
 \fB\*d\fR.)  \fBtic\fR duplicates the capabilities in
-\fIentry\fR-\fIname\fR for the current entry, with the exception of
+\fIentry\fR\-\fIname\fR for the current entry, with the exception of
 those capabilities that explicitly are defined in the current entry.
-
+.PP
 When an entry, e.g., \fBentry_name_1\fR, contains a
 \fBuse=\fR\fIentry\fR_\fIname\fR_\fI2\fR field, any canceled
 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.  Terminal names exceeding the maximum alias length
 (32 characters on systems with long filenames, 14 characters otherwise)
@@ -261,7 +274,7 @@ Unlike the stock SVr4 \fBtic\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.  See \fBterminfo\fR(\*n) for the list of
 termcap names taken to be equivalent to terminfo names.
-
+.PP
 The SVr4 manual pages are not clear on the resolution rules for \fBuse\fR
 capabilities.
 This implementation of \fBtic\fR will find \fBuse\fR targets anywhere
@@ -269,10 +282,10 @@ in the source file, or anywhere in the file tree rooted at \fBTERMINFO\fR (if
 \fBTERMINFO\fR is defined), or in the user's \fI$HOME/.terminfo\fR directory
 (if it exists), or (finally) anywhere in the system's file tree of
 compiled entries.
-
+.PP
 The error messages from this \fBtic\fR have the same format as GNU C
 error messages, and can be parsed by GNU Emacs's compile facility.
-
+.PP
 The
 \fB\-C\fR,
 \fB\-G\fR,
@@ -293,7 +306,7 @@ The
 options
 are not supported under SVr4.
 The SVr4 \fB\-c\fR mode does not report bad use links.
-
+.PP
 System V does not compile entries to or read entries from your
 \fI$HOME/.terminfo\fR directory unless TERMINFO is explicitly set to it.
 .SH FILES
@@ -301,8 +314,15 @@ System V does not compile entries to or read entries from your
 \fB\*d/?/*\fR
 Compiled terminal description database.
 .SH SEE ALSO
-\fB@INFOCMP@\fR(1M), \fB@CAPTOINFO@\fR(1M), \fB@INFOTOCAP@\fR(1M),
-\fB@TOE@\fR(1M), \fBcurses\fR(3X), \fBterminfo\fR(\*n).
+\fB@INFOCMP@\fR(1M),
+\fB@CAPTOINFO@\fR(1M),
+\fB@INFOTOCAP@\fR(1M),
+\fB@TOE@\fR(1M),
+\fBcurses\fR(3X),
+\fBterminfo\fR(\*n).
+.PP
+This describes \fBncurses\fR
+version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: