X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Finfocmp.1m;h=807dc08e40e51f74724e45c7727a0888516af3ee;hp=601ba3be47caa457c874108b4f480f026012ec67;hb=5c2245b6fc619f8d96ce940281dfbf13b5b8900b;hpb=ceaf3464e98d7984ed377f023abf63d69b7b8045 diff --git a/man/infocmp.1m b/man/infocmp.1m index 601ba3be..807dc08e 100644 --- a/man/infocmp.1m +++ b/man/infocmp.1m @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2011,2012 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2016,2017 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 * @@ -27,9 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: infocmp.1m,v 1.51 2012/05/26 21:32:01 tom Exp $ +.\" $Id: infocmp.1m,v 1.66 2017/08/13 00:21:55 tom Exp $ .TH @INFOCMP@ 1M "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .ds n 5 +.de bP +.IP \(bu 4 +.. .ds d @TERMINFO@ .SH NAME \fB@INFOCMP@\fR \- compare or print out \fIterminfo\fR descriptions @@ -47,6 +54,7 @@ L\ T\ U\ V\ +W\ c\ d\ e\ @@ -62,7 +70,7 @@ u\ x\ \fR] .br - [\fB\-v\fR \fIn\fR] [\fB\-s d\fR| \fBi\fR| \fBl\fR| \fBc\fR] [\fB\-R \fR\fBsubset\fR] + [\fB\-v\fR \fIn\fR] [\fB\-s d\fR| \fBi\fR| \fBl\fR| \fBc\fR] [\fB\-Q\fR \fIn\fR] [\fB\-R \fR\fBsubset\fR] .br [\fB\-w\fR\ \fIwidth\fR] [\fB\-A\fR\ \fIdirectory\fR] [\fB\-B\fR\ \fIdirectory\fR] .br @@ -85,27 +93,46 @@ the \fB\-d\fR option will be assumed. \fItermname\fR with each of the descriptions given by the entries for the other terminal's \fItermnames\fR. If a capability is defined for only one of the -terminals, the value returned will depend on the type of the capability: -\fBF\fR for boolean variables, \fB\-1\fR for integer variables, and \fBNULL\fR -for string variables. +terminals, the value returned depends on the type of the capability: +.bP +\fBF\fR for missing boolean variables +.bP +\fBNULL\fR for missing integer or string variables .PP -The \fB\-d\fR option produces a list of each capability that is different -between two entries. -This option is useful to show the difference between two -entries, created by different people, for the same or similar terminals. +Use the \fB\-q\fP option to show the distinction between +\fIabsent\fP and \fIcancelled\fP capabilities. .PP -The \fB\-c\fR option produces a list of each capability that is common between +These options produce a list which you can use to compare two +or more terminal descriptions: +.TP 5 +\fB\-d\fR +produces a list of each capability that is \fIdifferent\fP +between two entries. +Each item in the list shows \*(``:\*('' after the capability name, +followed by the capability values, separated by a comma. +.TP +\fB\-c\fR +produces a list of each capability that is \fIcommon\fP between two or more entries. -Capabilities that are not set are ignored. -This option can be -used as a quick check to see if the \fB\-u\fR option is worth using. -.PP -The \fB\-n\fR option produces a list of each capability that is in none of -the given entries. -If no \fItermnames\fR are given, the environment variable \fBTERM\fR -will be used for both of the \fItermnames\fR. -This can be used as a quick -check to see if anything was left out of a description. +Missing capabilities are ignored. +Each item in the list shows \*(``=\*('' after the capability name, +followed by the capability value. +.IP +The \fB\-u\fR option provides a related output, +showing the first terminal description rewritten to use the second +as a building block via the \*(``use=\*('' clause. +.TP +\fB\-n\fR +produces a list of each capability that is in \fInone\fP of the given entries. +Each item in the list shows \*(``!\*('' before the capability name. +.IP +Normally only the conventional capabilities are shown. +Use the \fB\-x\fP option to add the BSD-compatibility +capabilities (names prefixed with \*(``OT\*(''). +.IP +If no \fItermnames\fR are given, +\fB@INFOCMP@\fR uses the environment variable \fBTERM\fR +for each of the \fItermnames\fR. .SS Source Listing Options [\-I] [\-L] [\-C] [\-r] The \fB\-I\fR, \fB\-L\fR, and \fB\-C\fR options will produce a source listing for each terminal named. @@ -131,10 +158,20 @@ parameterized information, and anything not converted will be plainly marked in the output and commented out. These should be edited by hand. .PP +For best results when converting to \fBtermcap\fP format, +you should use both \fB\-C\fP and \fB\-r\fP. +Normally a termcap description is limited to 1023 bytes. +\fB@INFOCMP@\fP trims away less essential parts to make it fit. +If you are converting to one of the (rare) termcap implementations +which accept an unlimited size of termcap, +you may want to add the \fB\-T\fP option. +More often however, you must help the termcap implementation, +and trim excess whitespace (use the \fB\-0\fP option for that). +.PP All padding information for strings will be collected together and placed at the beginning of the string where \fBtermcap\fR expects it. Mandatory -padding (padding information with a trailing '/') will become optional. +padding (padding information with a trailing \*(``/\*('') will become optional. .PP All \fBtermcap\fR variables no longer supported by \fBterminfo\fR, but which are derivable from other \fBterminfo\fR variables, will be output. @@ -220,20 +257,25 @@ superfluous. \fB@INFOCMP@\fR will flag any other \fItermname use=\fR fields that were not needed. .SS Changing Databases [\-A \fIdirectory\fR] [\-B \fIdirectory\fR] -The location of the compiled \fBterminfo\fR database is taken from the -environment variable \fBTERMINFO\fR\ . -If the variable is not defined, or the -terminal is not found in that location, the system \fBterminfo\fR database, -in \fB@TERMINFO@\fR, will be used. -The options \fB\-A\fR -and \fB\-B\fR may be used to override this location. -The \fB\-A\fR option will -set \fBTERMINFO\fR for the first \fItermname\fR and the \fB\-B\fR option will -set \fBTERMINFO\fR for the other \fItermnames\fR. -With this, it is possible to +Like other \fBncurses\fP utilities, +\fB@INFOCMP@\fP looks for the terminal descriptions in several places. +You can use the \fBTERMINFO\fP and \fBTERMINFO_DIRS\fP environment variables +to override the compiled-in default list of places to search +(see \fBcurses\fP(3X) for details). +.PP +You can also use the options \fB\-A\fR +and \fB\-B\fR to override the list of places to search +when comparing terminal descriptions: +.bP +The \fB\-A\fR option sets the location for the first \fItermname\fR +.bP +The \fB\-B\fR option sets the location for the other \fItermnames\fR. +.PP +Using these options, it is possible to compare descriptions for a terminal with the same name located in two different databases. -This is useful for comparing descriptions for the same terminal +For instance, +you can use this feature for comparing descriptions for the same terminal created by different people. .SS Other Options .TP 5 @@ -301,7 +343,11 @@ rather than their decimal equivalents. .TP 5 \fB\-i\fR Analyze the initialization (\fBis1\fR, \fBis2\fR, \fBis3\fR), and reset -(\fBrs1\fR, \fBrs2\fR, \fBrs3\fR), strings in the entry. +(\fBrs1\fR, \fBrs2\fR, \fBrs3\fR), strings in the entry, +as well as those used for starting/stopping cursor-positioning mode +(\fBsmcup\fP, \fBrmcup\fP) as well as starting/stopping keymap mode +(\fBsmkx\fP, \fBrmkx\fP). +.IP For each string, the code tries to analyze it into actions in terms of the other capabilities in the entry, certain X3.64/ISO 6429/ECMA\-48 capabilities, and certain DEC VT-series @@ -311,9 +357,9 @@ Each report line consists of the capability name, followed by a colon and space, followed by a printable expansion of the capability string with sections matching recognized actions translated into {}-bracketed descriptions. +.IP Here is a list of the DEC/ANSI special sequences recognized: -i. .TS center tab(/) ; l l @@ -358,8 +404,14 @@ DEC[+\-]ARM/auto-repeat mode It also recognizes a SGR action corresponding to ANSI/ISO 6429/ECMA Set Graphics Rendition, with the values NORMAL, BOLD, UNDERLINE, BLINK, and REVERSE. -All but NORMAL may be prefixed with `+' (turn on) or `\-' (turn off). -.PP +All but NORMAL may be prefixed with +.RS +.bP +\*(``+\*('' (turn on) or +.bP +\*(``\-\*('' (turn off). +.RE +.IP An SGR0 designates an empty highlight sequence (equivalent to {SGR:NORMAL}). .TP 5 \fB\-l\fR @@ -368,9 +420,33 @@ Set output format to terminfo. \fB\-p\fR Ignore padding specifications when comparing strings. .TP 5 +\fB\-Q\fR \fIn\fR +Rather than show source in terminfo (text) format, +print the compiled (binary) format in hexadecimal or base64 form, +depending on the option's value: +.RS 8 +.TP 3 +1 +hexadecimal +.TP 3 +2 +base64 +.TP 3 +3 +hexadecimal and base64 +.RE +.TP 5 \fB\-q\fR +This makes the output a little shorter: +.RS +.bP Make the comparison listing shorter by omitting subheadings, and using -"\-" for absent capabilities, "@" for canceled rather than "NULL". +\*(``\-\*('' for absent capabilities, \*(``@\*('' for canceled rather than \*(``NULL\*(''. +.bP +However, show differences between absent and cancelled capabilities. +.bP +Omit the \*(``Reconstructed from\*('' comment for source listings. +.RE .TP 5 \fB\-R\fR\fIsubset\fR Restrict output to a given subset. @@ -378,11 +454,20 @@ This option is for use with archaic versions of terminfo like those on SVr1, Ultrix, or HP/UX that do not support the full set of SVR4/XSI Curses terminfo; and variants such as AIX that have their own extensions incompatible with SVr4/XSI. +.RS +.bP Available terminfo -subsets are "SVr1", "Ultrix", "HP", and "AIX"; see \fBterminfo\fR(\*n) for +subsets are \*(``SVr1\*('', \*(``Ultrix\*('', \*(``HP\*('', and \*(``AIX\*(''; see \fBterminfo\fR(\*n) for details. -You can also choose the subset "BSD" which selects only capabilities +.bP +You can also choose the subset \*(``BSD\*('' which selects only capabilities with termcap equivalents recognized by 4.4BSD. +The \fB\-C\fP option sets the \*(``BSD\*('' subset as a side-effect. +.bP +If you select any other value for \fB\-R\fP, +it is the same as no subset, i.e., all capabilities are used. +The \fB\-I\fP option likewise selects no subset as a side-effect. +.RE .TP \fB\-s \fR\fI[d|i|l|c]\fR The \fB\-s\fR option sorts the fields within each type according to the argument @@ -430,7 +515,14 @@ reports the version of ncurses which was used in this program, and exits. .TP 5 \fB\-v\fR \fIn\fR prints out tracing information on standard error as the program runs. -Higher values of n induce greater verbosity. +.IP +The optional parameter \fIn\fR is a number from 1 to 10, inclusive, +indicating the desired level of detail of information. +If ncurses is built without tracing support, the optional parameter is ignored. +.TP +\fB\-W\fR +By itself, the \fB\-w\fP option will not force long strings to be wrapped. +Use the \fB\-W\fP option to do this. .TP 5 \fB\-w\fR \fIwidth\fR changes the output to \fIwidth\fR characters. @@ -450,6 +542,7 @@ The \fB\-E\fR, \fB\-F\fR, \fB\-G\fR, +\fB\-Q\fR, \fB\-R\fR, \fB\-T\fR, \fB\-V\fR, @@ -464,7 +557,13 @@ The \fB\-t\fR options are not supported in SVr4 curses. .PP -The \fB\-r\fR option's notion of `termcap' capabilities is System V Release 4's. +SVr4 infocmp does not distinguish between absent and cancelled capabilities. +Also, it shows missing integer capabilities as \fB\-1\fP +(the internal value used to represent missing integers). +This implementation shows those as \*(``NULL\*('', +for consistency with missing strings. +.PP +The \fB\-r\fR option's notion of \*(``termcap\*('' capabilities is System V Release 4's. Actual BSD curses versions will have a more restricted set. To see only the 4.4BSD set, use \fB\-r\fR \fB\-RBSD\fR. @@ -477,6 +576,8 @@ The \fB\-F\fR option of \fB@INFOCMP@\fR(1M) should be a \fB@TOE@\fR(1M) mode. \fB@TOE@\fR(1M), \fBcurses\fR(3X), \fBterminfo\fR(\*n). +.sp +http://invisible-island.net/ncurses/tctest.html .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).