| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" |
| 56 |
.\" Required to disable full justification in groff 1.23.0. |
| 57 |
.if n .ds AD l |
| 58 |
.\" ======================================================================== |
| 59 |
.\" |
| 60 |
.IX Title "TYPOG-GREP 1" |
| 61 |
.TH TYPOG-GREP 1 2025/10/27 0.5 "User Contributed Perl Documentation" |
| 62 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 63 |
.\" way too many mistakes in technical documents. |
| 64 |
.if n .ad l |
| 65 |
.nh |
| 66 |
.\" Turn off justification. |
| 67 |
.na |
| 68 |
.SH NAME |
| 69 |
typog\-grep \- specialized grep for typog\-inspect elements in LaTeX log files |
| 70 |
.SH SYNOPSIS |
| 71 |
.IX Header "SYNOPSIS" |
| 72 |
.IP "\fBtypog\-grep\fR \-a|\-\-all|\-\-any [\fIOPTION\fR...] \fILOG\-FILE\fR..." 4 |
| 73 |
.IX Item "typog-grep -a|--all|--any [OPTION...] LOG-FILE..." |
| 74 |
.PD 0 |
| 75 |
.IP "\fBtypog\-grep\fR [\fIOPTION\fR...] \fIREGEXP\fR \fILOG\-FILE\fR..." 4 |
| 76 |
.IX Item "typog-grep [OPTION...] REGEXP LOG-FILE..." |
| 77 |
.PD |
| 78 |
.PP |
| 79 |
The first form, \`\`discovery mode\*(Aq\*(Aq, shows all \fIID\fRs of |
| 80 |
.RS |
| 81 |
.EX |
| 82 |
<typog-inspect id="\fI\,ID\/\fP" ...> |
| 83 |
.EE |
| 84 |
.RE |
| 85 |
.PP |
| 86 |
|
| 87 |
elements in \fILOG\-FILE\fR. |
| 88 |
.PP |
| 89 |
The second form shows the contents, \fILOG\-DATA\fR, of the elements |
| 90 |
.RS |
| 91 |
.EX |
| 92 |
<typog-inspect id="\fI\,ID\/\fP" ...> |
| 93 |
\fILOG-DATA\fP |
| 94 |
</typog-inspect> |
| 95 |
.EE |
| 96 |
.RE |
| 97 |
.PP |
| 98 |
|
| 99 |
whose \fIID\fRs match \fIREGEXP\fR in \fILOG\-FILE\fR. |
| 100 |
.PP |
| 101 |
If no \fILOG\-FILE\fR is given read from \fIstdin\fR. |
| 102 |
The filename\ \f(CW\*(C`\-\*(C'\fR is synonymous to \fIstdin\fR. |
| 103 |
.SH DESCRIPTION |
| 104 |
.IX Header "DESCRIPTION" |
| 105 |
\&\fBtypog\-grep\fR is a tailored post\-processor for LaTeX \fIlog\fR\ files |
| 106 |
and the \f(CW\*(C`typoginspect\*(C'\fR environment as provided by the LaTeX\ package\ typog. |
| 107 |
It shares more with the venerable |
| 108 |
\&\fBsgrep\fR <https://www.cs.helsinki.fi/u/jjaakkol/sgrep.html> |
| 109 |
than with POSIX\ \fBgrep\fR\ <https://pubs.opengroup.org/onlinepubs/9699919799/utilities/grep.html>. |
| 110 |
.PP |
| 111 |
In the LaTeX source file the user brackets her text or code |
| 112 |
in a \f(CW\*(C`typoginspect\*(C'\fR environment: |
| 113 |
.RS |
| 114 |
.EX |
| 115 |
\ebegin{typoginspect}{\fI\,ID\/\fP} |
| 116 |
\fITEXT-OR-CODE-TO-INVESTIGATE\fP |
| 117 |
\eend{typoginspect} |
| 118 |
.EE |
| 119 |
.RE |
| 120 |
.PP |
| 121 |
|
| 122 |
where \fIID\fR is used to identify one or more bracketed snippets. |
| 123 |
\&\fIID\fR does not have to be unique. |
| 124 |
The \fIREGEXP\fR mechanism makes it easy to select groups of related \fIID\fRs |
| 125 |
if they are named accordingly. |
| 126 |
.PP |
| 127 |
In \fILOG\-FILE\fR the result of the environment shows up, |
| 128 |
packed with tracing information, as |
| 129 |
.RS |
| 130 |
.EX |
| 131 |
<typog-inspect id="\fI\,ID\/\fP" job="\fI\,JOB-NAME\/\fP" line="\fI\,LINE-NUMBER\/\fP" page="\fI\,PAGE-NUMBER\/\fP"> |
| 132 |
\fILOG-DATA\fP |
| 133 |
</typog-inspect> |
| 134 |
.EE |
| 135 |
.RE |
| 136 |
.PP |
| 137 |
|
| 138 |
where all the capital\-letter sequences are meta\-variables |
| 139 |
and in particular |
| 140 |
\&\fIJOB\-NAME\fR is the expansion of \f(CW\*(C`\ejobname\*(C'\fR, |
| 141 |
\&\fILINE\-NUMBER\fR is the LaTeX source file line number |
| 142 |
of the beginning of the \f(CW\*(C`typoginspect\*(C'\fR environment, |
| 143 |
and \fIPAGE\-NUMBER\fR is the page where |
| 144 |
the output of \f(CW\*(C`TEXT\-OR\-CODE\-TO\-INVESTIGATE\*(C'\fR occurs. |
| 145 |
.PP |
| 146 |
\&\fBtypog\-grep\fR reveals the contents of \fILOG\-FILE\fR |
| 147 |
between \f(CW\*(C`<typog\-inspect id="\fR\f(CIID\fR\f(CW" ...>\*(C'\fR |
| 148 |
and \f(CW\*(C`</typog\-inspect>\*(C'\fR excluding the XML\-tags themselves. |
| 149 |
Access the \fIJOB\-NAME\fR, \fILINE\-NUMBER\fR, and \fIPAGE\-NUMBER\fR |
| 150 |
with the commandline options |
| 151 |
\&\fB\-\-job\-name\fR, \fB\-\-line\-number\fR, and \fB\-\-page\-number\fR. |
| 152 |
Use \fB\-\-id\fR to show the name of the IDs that matched \fIREGEXP\fR. |
| 153 |
.PP |
| 154 |
\&\f(CW\*(C`typoginspect\*(C'\fR environments can be nested. |
| 155 |
\&\fBtypog\-grep\fR respects the nesting, |
| 156 |
i.e., if the \fIID\fR of the nested environment does not match \fIREGEXP\fR |
| 157 |
it will not be included in the program\*(Aqs output. |
| 158 |
.SH OPTIONS |
| 159 |
.IX Header "OPTIONS" |
| 160 |
The list of options is sorted by the names of the long options. |
| 161 |
.IP "\fB\-a\fR, \fB\-\-all\fR, \fB\-\-any\fR" 4 |
| 162 |
.IX Item "-a, --all, --any" |
| 163 |
ID\-discovery mode: |
| 164 |
Discover all \f(CW\*(C`typog\-inspect\*(C'\fR elements independent of any matching patterns |
| 165 |
and print their \fIID\fRs. |
| 166 |
The results are printed in their order of occurrence in the \fILOG\-FILE\fRs. |
| 167 |
Pipe the output into \fBsort\fR to get alphabetically ordered \fIID\fRs. |
| 168 |
.Sp |
| 169 |
Augment with options |
| 170 |
\&\fB\-\-job\-name\fR, \fB\-\-line\-number\fR, \fB\-\-log\-line\-number\fR, or \fB\-\-page\-number\fR |
| 171 |
for more information. |
| 172 |
.IP "\fB\-\-color\fR, \fBcolour\fR \fIWHEN\fR" 4 |
| 173 |
.IX Item "--color, colour WHEN" |
| 174 |
Colorize specific log contents for the matching \fIID\fRs. |
| 175 |
The argument\ \fIWHEN\fR determines when to apply color: |
| 176 |
\&\f(CW\*(C`always\*(C'\fR, \f(CW\*(C`never\*(C'\fR, or\ \f(CW\*(C`auto\*(C'\fR. |
| 177 |
The setting \f(CW\*(C`auto\*(C'\fR checks whether standard output has been redirected. |
| 178 |
This is the default. |
| 179 |
.IP "\fB\-C\fR, \fB\-\-config\fR \fIKEY\fR=\fIVALUE\fR[:\fIKEY\fR=\fIVALUE\fR[:...]]" 4 |
| 180 |
.IX Item "-C, --config KEY=VALUE[:KEY=VALUE[:...]]" |
| 181 |
Set one or more configuration \fIKEY\fR to \fIVALUE\fR pairs. |
| 182 |
See section "CONFIGURATION" for a description |
| 183 |
of all available configuration items. |
| 184 |
Use option\ \fB\-\-show\-config\fR to display the default configuration. |
| 185 |
.IP \fB\-\-debug\fR 4 |
| 186 |
.IX Item "--debug" |
| 187 |
Turn on debug output on \fIstderr\fR. |
| 188 |
.IP "\fB\-E\fR, \fB\-\-encoding\fR \fIENCODING\fR" 4 |
| 189 |
.IX Item "-E, --encoding ENCODING" |
| 190 |
Set the \fIENCODING\fR of \fILOG\-FILE\fR for the translation to UTF\-8. |
| 191 |
The default is unset. |
| 192 |
.Sp |
| 193 |
Use this option to get rid of pesky |
| 194 |
"<\fIHEX\-DIGITS\fR>"\ escapes on UTF\-8 terminals. |
| 195 |
See option\ \fB\-\-show\-encodings\fR for the known encodings and |
| 196 |
Encode::Supported for a summary of all encodings. |
| 197 |
See also section\ "Some\ Common\ Encodings". |
| 198 |
.Sp |
| 199 |
Apply \fBiconv\fR <https://pubs.opengroup.org/onlinepubs/9699919799/utilities/iconv.html> |
| 200 |
(POSIX) or \fBrecode\fR <https://github.com/rrthomas/recode/> (GNU) on \fILOG\-FILE\fR |
| 201 |
before this tool to avoid having to use option\ \fB\-\-encoding\fR. |
| 202 |
.IP "\fB\-h\fR, \fB\-\-help\fR" 4 |
| 203 |
.IX Item "-h, --help" |
| 204 |
Display brief help then exit. |
| 205 |
.IP "\fB\-i\fR, \fB\-\-[no\-]id\fR" 4 |
| 206 |
.IX Item "-i, --[no-]id" |
| 207 |
Print the actual ID\-name that matched \fIREGEXP\fR. |
| 208 |
Control the appearance of the matching \fIID\fR with configuration item\ \f(CW\*(C`id\-heading\*(C'\fR. |
| 209 |
.IP "\fB\-y\fR, \fB\-\-[no\-]ignore\-case\fR" 4 |
| 210 |
.IX Item "-y, --[no-]ignore-case" |
| 211 |
Match \fIID\fRs while ignoring case distinctions in patterns and data. |
| 212 |
.IP "\fB\-j\fR, \fB\-\-[no\-]job\-name\fR" 4 |
| 213 |
.IX Item "-j, --[no-]job-name" |
| 214 |
Print the \f(CW\*(C`\ejobname\*(C'\fR that \fBlatex\fR associated with the input file. |
| 215 |
.IP "\fB\-n\fR, \fB\-\-[no\-]line\-number\fR" 4 |
| 216 |
.IX Item "-n, --[no-]line-number" |
| 217 |
Print the line number where the \f(CW\*(C`typoginspect\*(C'\fR\ environment |
| 218 |
was encountered in the LaTeX source file. |
| 219 |
.IP "\fB\-N\fR, \fB\-\-[no\-]log\-line\-number\fR" 4 |
| 220 |
.IX Item "-N, --[no-]log-line-number" |
| 221 |
Print the line number of the \fIlog\fR\-file where the current line was encountered. |
| 222 |
.IP "\fB\-p\fR, \fB\-\-[no\-]page\-number\fR" 4 |
| 223 |
.IX Item "-p, --[no-]page-number" |
| 224 |
Print page number where the contents of the \f(CW\*(C`typoginspect\*(C'\fR\ environment |
| 225 |
starts in the typeset document. |
| 226 |
.IP "\fB\-P\fR, \fB\-\-[no\-]pager\fR" 4 |
| 227 |
.IX Item "-P, --[no-]pager" |
| 228 |
Redirect output from \fIstdout\fR to the configured pager. |
| 229 |
.IP \fB\-\-show\-config\fR 4 |
| 230 |
.IX Item "--show-config" |
| 231 |
Show the default configuration and exit. |
| 232 |
.IP \fB\-\-show\-encodings\fR 4 |
| 233 |
.IX Item "--show-encodings" |
| 234 |
Show all known encodings and exit. |
| 235 |
.IP "\fB\-V\fR, \fB\-\-version\fR" 4 |
| 236 |
.IX Item "-V, --version" |
| 237 |
Show version information and exit. |
| 238 |
.IP "\fB\-w\fR, \fB\-\-[no\-]word\-regexp\fR" 4 |
| 239 |
.IX Item "-w, --[no-]word-regexp" |
| 240 |
Match only whole words. |
| 241 |
.SH CONFIGURATION |
| 242 |
.IX Header "CONFIGURATION" |
| 243 |
.ie n .IP """id\-format""=\fIFORMAT\fR" 4 |
| 244 |
.el .IP \f(CWid\-format\fR=\fIFORMAT\fR 4 |
| 245 |
.IX Item "id-format=FORMAT" |
| 246 |
Control the \fIFORMAT\fR for printing matching ids in inline\-mode, |
| 247 |
where \fIFORMAT\fR is passed to Perl\*(Aqs \f(CW\*(C`printf\*(C'\fR. |
| 248 |
Default:\ \f(CW%s:\fR. |
| 249 |
.ie n .IP """id\-heading""=0|1" 4 |
| 250 |
.el .IP \f(CWid\-heading\fR=\f(CW0\fR|\f(CW1\fR 4 |
| 251 |
.IX Item "id-heading=0|1" |
| 252 |
Choose between printing the matching \fIID\fRs with option\ \fB\-\-id\fR: |
| 253 |
Inline\ (\f(CW0\fR) or heading before the matching data (\f(CW1\fR). |
| 254 |
Default:\ \f(CW0\fR. |
| 255 |
.ie n .IP """id\-heading\-format""=\fIFORMAT\fR" 4 |
| 256 |
.el .IP \f(CWid\-heading\-format\fR=\fIFORMAT\fR 4 |
| 257 |
.IX Item "id-heading-format=FORMAT" |
| 258 |
Control the \fIFORMAT\fR for printing matching \fIID\fRs in heading\-mode, |
| 259 |
where \fIFORMAT\fR is passed to Perl\*(Aqs \f(CW\*(C`printf\*(C'\fR. |
| 260 |
Default:\ \f(CW\*(C`\-\->\ %s\ <\-\-\*(C'\fR. |
| 261 |
.ie n .IP """id\-indent""=\fIINDENT\fR" 4 |
| 262 |
.el .IP \f(CWid\-indent\fR=\fIINDENT\fR 4 |
| 263 |
.IX Item "id-indent=INDENT" |
| 264 |
Indentation of nested typog\-inspect tags. |
| 265 |
Only used in \`\`discovery mode\*(Aq\*(Aq (first form), i.e., if \fB\-\-all\fR is active. |
| 266 |
Default:\ 8. |
| 267 |
.ie n .IP """id\-max\-length""=\fIMAXIMUM\-LENGTH\fR" 4 |
| 268 |
.el .IP \f(CWid\-max\-length\fR=\fIMAXIMUM\-LENGTH\fR 4 |
| 269 |
.IX Item "id-max-length=MAXIMUM-LENGTH" |
| 270 |
Set the maximum length of a matching \fIID\fR for printing. |
| 271 |
It a matching \fIID\fR exceeds this length it will be truncated |
| 272 |
and the last three characters (short of \fIMAXIMUM\-LENGTH\fR) will be replaced by dots. |
| 273 |
Default:\ 40. |
| 274 |
.ie n .IP """line\-number\-format""=\fIFORMAT\fR" 4 |
| 275 |
.el .IP \f(CWline\-number\-format\fR=\fIFORMAT\fR 4 |
| 276 |
.IX Item "line-number-format=FORMAT" |
| 277 |
Control the \fIFORMAT\fR for printing TeX source line numbers, |
| 278 |
where \fIFORMAT\fR is passed to Perl\*(Aqs \f(CW\*(C`printf\*(C'\fR. |
| 279 |
Default:\ \f(CW%5d\fR. |
| 280 |
.ie n .IP """log\-line\-number\-format""=\fIFORMAT\fR" 4 |
| 281 |
.el .IP \f(CWlog\-line\-number\-format\fR=\fIFORMAT\fR 4 |
| 282 |
.IX Item "log-line-number-format=FORMAT" |
| 283 |
Control the \fIFORMAT\fR for printing log line numbers, |
| 284 |
where \fIFORMAT\fR is passed to Perl\*(Aqs \f(CW\*(C`printf\*(C'\fR. |
| 285 |
Default:\ \f(CW%6d\fR. |
| 286 |
.ie n .IP """page\-number\-format""=\fIFORMAT\fR" 4 |
| 287 |
.el .IP \f(CWpage\-number\-format\fR=\fIFORMAT\fR 4 |
| 288 |
.IX Item "page-number-format=FORMAT" |
| 289 |
Control the \fIFORMAT\fR for printing page numbers, |
| 290 |
where \fIFORMAT\fR is passed to Perl\*(Aqs \f(CW\*(C`printf\*(C'\fR. |
| 291 |
Default:\ \f(CW\*(C`[%3d]\*(C'\fR. |
| 292 |
.ie n .IP """pager""=\fIPAGER\fR" 4 |
| 293 |
.el .IP \f(CWpager\fR=\fIPAGER\fR 4 |
| 294 |
.IX Item "pager=PAGER" |
| 295 |
Name of pager application to pipe output into |
| 296 |
if run with option\ \fB\-\-pager\fR. |
| 297 |
Default:\ \f(CW\*(C`less\*(C'\fR. |
| 298 |
.ie n .IP """pager\-flags""=\fIFLAGS\fR" 4 |
| 299 |
.el .IP \f(CWpager\-flags\fR=\fIFLAGS\fR 4 |
| 300 |
.IX Item "pager-flags=FLAGS" |
| 301 |
Pass \fIFLAGS\fR to \fIPAGER\fR. |
| 302 |
Default:\ \f(CW\*(C`\-\-quit\-if\-one\-screen\*(C'\fR. |
| 303 |
.IP "Color Configuration" 4 |
| 304 |
.IX Item "Color Configuration" |
| 305 |
For the syntax of the color specifications consult |
| 306 |
the manual page of Term::ANSIColor(pm). |
| 307 |
.RS 4 |
| 308 |
.ie n .IP """file\-header\-color""" 4 |
| 309 |
.el .IP \f(CWfile\-header\-color\fR 4 |
| 310 |
.IX Item "file-header-color" |
| 311 |
Color of the filename header. |
| 312 |
.ie n .IP """fill\-state\-color""" 4 |
| 313 |
.el .IP \f(CWfill\-state\-color\fR 4 |
| 314 |
.IX Item "fill-state-color" |
| 315 |
Color of the messages that report \`\`Underfull hbox\*(Aq\*(Aq or \`\`Overfull hbox\*(Aq\*(Aq. |
| 316 |
.ie n .IP """first\-vbox\-color""" 4 |
| 317 |
.el .IP \f(CWfirst\-vbox\-color\fR 4 |
| 318 |
.IX Item "first-vbox-color" |
| 319 |
Color of the first vbox on a page. |
| 320 |
.ie n .IP """font\-spec\-color""" 4 |
| 321 |
.el .IP \f(CWfont\-spec\-color\fR 4 |
| 322 |
.IX Item "font-spec-color" |
| 323 |
Color of font specifications. |
| 324 |
.ie n .IP """horizontal\-break\-candidate\-color""" 4 |
| 325 |
.el .IP \f(CWhorizontal\-break\-candidate\-color\fR 4 |
| 326 |
.IX Item "horizontal-break-candidate-color" |
| 327 |
Color of lines with horizontal\-breakpoint candidates\ \f(CW\*(C`@\*(C'\fR. |
| 328 |
.ie n .IP """horizontal\-breakpoint\-color""" 4 |
| 329 |
.el .IP \f(CWhorizontal\-breakpoint\-color\fR 4 |
| 330 |
.IX Item "horizontal-breakpoint-color" |
| 331 |
Color of lines with horizontal breakpoints\ \f(CW\*(C`@@\*(C'\fR. |
| 332 |
.ie n .IP """id\-color""" 4 |
| 333 |
.el .IP \f(CWid\-color\fR 4 |
| 334 |
.IX Item "id-color" |
| 335 |
Color of matching \fIID\fRs when printed inline. |
| 336 |
.ie n .IP """id\-heading\-color""" 4 |
| 337 |
.el .IP \f(CWid\-heading\-color\fR 4 |
| 338 |
.IX Item "id-heading-color" |
| 339 |
Color of matching \fIID\fRs when printed in heading form. |
| 340 |
.ie n .IP """line\-break\-pass\-color""" 4 |
| 341 |
.el .IP \f(CWline\-break\-pass\-color\fR 4 |
| 342 |
.IX Item "line-break-pass-color" |
| 343 |
Color of the lines showing which pass (e.g., \f(CW@firstpass\fR) |
| 344 |
of the line\-breaking algorithm is active. |
| 345 |
.ie n .IP """line\-number\-color""" 4 |
| 346 |
.el .IP \f(CWline\-number\-color\fR 4 |
| 347 |
.IX Item "line-number-color" |
| 348 |
Color of TeX\-source\-file line numbers. |
| 349 |
.ie n .IP """log\-line\-number\-color""" 4 |
| 350 |
.el .IP \f(CWlog\-line\-number\-color\fR 4 |
| 351 |
.IX Item "log-line-number-color" |
| 352 |
Color of log\-file line numbers. |
| 353 |
.ie n .IP """math\-color""" 4 |
| 354 |
.el .IP \f(CWmath\-color\fR 4 |
| 355 |
.IX Item "math-color" |
| 356 |
Color used for math expressions including their font specs. |
| 357 |
.ie n .IP """page\-number\-color""" 4 |
| 358 |
.el .IP \f(CWpage\-number\-color\fR 4 |
| 359 |
.IX Item "page-number-color" |
| 360 |
Color of page numbers of the final output. |
| 361 |
.ie n .IP """tightness\-color""" 4 |
| 362 |
.el .IP \f(CWtightness\-color\fR 4 |
| 363 |
.IX Item "tightness-color" |
| 364 |
Color of lines with Tight/Loose hbox reports. |
| 365 |
.ie n .IP """vertical\-breakpoint\-color""" 4 |
| 366 |
.el .IP \f(CWvertical\-breakpoint\-color\fR 4 |
| 367 |
.IX Item "vertical-breakpoint-color" |
| 368 |
Color of possible vertical breakpoints. |
| 369 |
.RE |
| 370 |
.RS 4 |
| 371 |
.RE |
| 372 |
.SS "Brief summary of colors and attributes" |
| 373 |
.IX Subsection "Brief summary of colors and attributes" |
| 374 |
.IP "Foreground Color" 4 |
| 375 |
.IX Item "Foreground Color" |
| 376 |
\&\f(CW\*(C`black\*(C'\fR, \f(CW\*(C`red\*(C'\fR, \f(CW\*(C`green\*(C'\fR, \f(CW\*(C`yellow\*(C'\fR, |
| 377 |
\&\f(CW\*(C`blue\*(C'\fR, \f(CW\*(C`magenta\*(C'\fR, \f(CW\*(C`cyan\*(C'\fR, \f(CW\*(C`white\*(C'\fR, |
| 378 |
.Sp |
| 379 |
Prefix with \f(CW\*(C`bright_\*(C'\fR for high\-intensity or bold foreground. |
| 380 |
.IP "Foreground Grey" 4 |
| 381 |
.IX Item "Foreground Grey" |
| 382 |
\&\f(CW\*(C`grey0\*(C'\fR, ..., \f(CW\*(C`grey23\*(C'\fR |
| 383 |
.IP "Background Color" 4 |
| 384 |
.IX Item "Background Color" |
| 385 |
\&\f(CW\*(C`on_black\*(C'\fR, \f(CW\*(C`on_red\*(C'\fR, \f(CW\*(C`on_green\*(C'\fR, \f(CW\*(C`on_yellow\*(C'\fR, |
| 386 |
\&\f(CW\*(C`on_blue\*(C'\fR, \f(CW\*(C`on_magenta\*(C'\fR, \f(CW\*(C`on_cyan\*(C'\fR, \f(CW\*(C`on_white\*(C'\fR |
| 387 |
.Sp |
| 388 |
Replace \f(CW\*(C`on_\*(C'\fR with \f(CW\*(C`on_bright_\*(C'\fR for high\-intensity or bold background. |
| 389 |
.IP "Background Grey" 4 |
| 390 |
.IX Item "Background Grey" |
| 391 |
\&\f(CW\*(C`on_grey0\*(C'\fR, ..., \f(CW\*(C`on_grey23\*(C'\fR |
| 392 |
.IP "Text Attribute" 4 |
| 393 |
.IX Item "Text Attribute" |
| 394 |
\&\f(CW\*(C`bold\*(C'\fR, \f(CW\*(C`dark\*(C'\fR, \f(CW\*(C`italic\*(C'\fR, \f(CW\*(C`underline\*(C'\fR, \f(CW\*(C`reverse\*(C'\fR |
| 395 |
.SS "Some Common Encodings" |
| 396 |
.IX Subsection "Some Common Encodings" |
| 397 |
The following list shows some encodings |
| 398 |
that are suitable for option\ \fB\-\-encoding\fR. |
| 399 |
.IP "Latin\-1, Western European" 4 |
| 400 |
.IX Item "Latin-1, Western European" |
| 401 |
\&\f(CW\*(C`iso\-8859\-1\*(C'\fR, \f(CW\*(C`cp850\*(C'\fR, \f(CW\*(C`cp860\*(C'\fR, \f(CW\*(C`cp1252\*(C'\fR |
| 402 |
.IP "Latin\-2, Central European" 4 |
| 403 |
.IX Item "Latin-2, Central European" |
| 404 |
\&\f(CW\*(C`iso\-8859\-2\*(C'\fR, \f(CW\*(C`cp852\*(C'\fR, \f(CW\*(C`cp1250\*(C'\fR |
| 405 |
.IP "Latin\-3, South European (Esperanto, Maltese)" 4 |
| 406 |
.IX Item "Latin-3, South European (Esperanto, Maltese)" |
| 407 |
\&\f(CW\*(C`iso\-8859\-3\*(C'\fR |
| 408 |
.IP "Latin\-4, North European (Baltics)" 4 |
| 409 |
.IX Item "Latin-4, North European (Baltics)" |
| 410 |
\&\f(CW\*(C`iso\-8859\-4\*(C'\fR |
| 411 |
.IP Cyrillics 4 |
| 412 |
.IX Item "Cyrillics" |
| 413 |
\&\f(CW\*(C`iso\-8859\-5\*(C'\fR, \f(CW\*(C`cp855\*(C'\fR, \f(CW\*(C`cp866\*(C'\fR (Ukrainian), \f(CW\*(C`cp1251\*(C'\fR |
| 414 |
.IP Arabic 4 |
| 415 |
.IX Item "Arabic" |
| 416 |
\&\f(CW\*(C`iso\-8859\-6\*(C'\fR, \f(CW\*(C`cp864\*(C'\fR, \f(CW\*(C`cp1006\*(C'\fR (Farsi), \f(CW\*(C`cp1256\*(C'\fR |
| 417 |
.IP Greek 4 |
| 418 |
.IX Item "Greek" |
| 419 |
\&\f(CW\*(C`iso\-8859\-7\*(C'\fR, \f(CW\*(C`cp737\*(C'\fR, \f(CW\*(C`cp1253\*(C'\fR |
| 420 |
.IP Hebrew 4 |
| 421 |
.IX Item "Hebrew" |
| 422 |
\&\f(CW\*(C`iso\-8859\-8\*(C'\fR, \f(CW\*(C`cp862\*(C'\fR, \f(CW\*(C`cp1255\*(C'\fR |
| 423 |
.IP Turkish 4 |
| 424 |
.IX Item "Turkish" |
| 425 |
\&\f(CW\*(C`iso\-8859\-9\*(C'\fR, \f(CW\*(C`cp857\*(C'\fR, \f(CW\*(C`cp1254\*(C'\fR |
| 426 |
.IP Nordic 4 |
| 427 |
.IX Item "Nordic" |
| 428 |
\&\f(CW\*(C`iso\-8859\-10\*(C'\fR, \f(CW\*(C`cp865\*(C'\fR, \f(CW\*(C`cp861\*(C'\fR (Icelandic) |
| 429 |
.IP Thai 4 |
| 430 |
.IX Item "Thai" |
| 431 |
\&\f(CW\*(C`iso\-8859\-11\*(C'\fR, \f(CW\*(C`cp874\*(C'\fR |
| 432 |
.IP Baltic 4 |
| 433 |
.IX Item "Baltic" |
| 434 |
\&\f(CW\*(C`iso\-8859\-13\*(C'\fR, \f(CW\*(C`cp775\*(C'\fR, \f(CW\*(C`cp1257\*(C'\fR |
| 435 |
.IP Celtic 4 |
| 436 |
.IX Item "Celtic" |
| 437 |
\&\f(CW\*(C`iso\-8859\-14\*(C'\fR |
| 438 |
.IP "Latin\-9 (sometimes called Latin0)" 4 |
| 439 |
.IX Item "Latin-9 (sometimes called Latin0)" |
| 440 |
\&\f(CW\*(C`iso\-8859\-15\*(C'\fR |
| 441 |
.IP Latin\-10 4 |
| 442 |
.IX Item "Latin-10" |
| 443 |
\&\f(CW\*(C`iso\-8859\-16\*(C'\fR |
| 444 |
.SH "EXIT STATUS" |
| 445 |
.IX Header "EXIT STATUS" |
| 446 |
The exit status is 0 if at least one \fIID\fR matched \fIREGEXP\fR, |
| 447 |
1 if no \fIID\fR matched \fIREGEXP\fR, and 2 if an error occurred. |
| 448 |
.SH CAVEATS |
| 449 |
.IX Header "CAVEATS" |
| 450 |
The end tag \f(CW\*(C`</typog\-inspect>\*(C'\fR sometimes gets placed too early in the output and the trace |
| 451 |
\&\fIseems\fR truncated. However, LaTeX reliably logs the requested the trace information, but the |
| 452 |
write operations for trace data and the code which is used to print the end\ tag are not |
| 453 |
synchronized. |
| 454 |
.SH "SEE ALSO" |
| 455 |
.IX Header "SEE ALSO" |
| 456 |
\&\fBgrep\fR(1), \fBprintf\fR(3), \fBEncode::Supported\fR(pm), \fBTerm::ANSIColor\fR(pm) |