Debian Codegraph @

texmf-dist/doc/man/man1/texlogfilter.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "TEXLOGFILTER 1"
58 .TH TEXLOGFILTER 1 2024-06-14 texlogfilter "Julien Labbe"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH texlogfilter
64 .IX Header "texlogfilter"
65 .SS NAME
66 .IX Subsection "NAME"
67 texlogfilter \- filter latex engines output or log file
68 .SS SYNOPSIS
69 .IX Subsection "SYNOPSIS"
70 .Vb 1
71 \& texlogfilter [options] file.log
72 .Ve
73 .SS DESCRIPTION
74 .IX Subsection "DESCRIPTION"
75 Filter latex engines output or log file. For latex, pdflatex, lualatex or
76 xelatex output or log file.
77 .PP
78 Without input file, standard input is used. Use on latex engine output with:
79 .PP
80 .Vb 1
81 \& latex file.tex < /dev/null | texlogfilter
82 .Ve
83 .SS OPTIONS
84 .IX Subsection "OPTIONS"
85 .Vb 2
86 \& \-\-help : print this help and exit
87 \& \-\-version : print version and exit
88 \&
89 \& \-\-box : show box warnings
90 \& \-\-no\-box : mask box warnings
91 \&
92 \& \-\-ref : show reference/citation warnings
93 \& \-\-no\-ref : mask reference/citation warnings
94 \&
95 \& \-\-info : show latex info messages
96 \& \-\-no\-info : mask latex info messages
97 \&
98 \& \-\-filename : print current file name
99 \& \-\-no\-filename : do not print current file name
100 \& \-\-files\-ext=string : regex pattern used to match files extension (default: tex|sty|cls|bib)
101 \&
102 \& \-\-skips : indicate skipped lines
103 \& \-\-no\-skips : mask skipped lines
104 \& \-\-skip\-marker=string : marker used to indicate skipped lines (defaut: ...)
105 \&
106 \& \-\-add\-filter=string : add user filter pattern (as perl regular expression)
107 \&
108 \& \-\-full\-log : show full log (don\*(Aqt filter \- only colorize latex engine output)
109 \&
110 \& \-\-errors\-color=string
111 \& \-\-warnings\-color=string
112 \& \-\-infos\-color=string
113 \& \-\-skips\-color=string
114 \& \-\-user\-color=string : colors used for errors, warnings, informations and skipped lines
115 .Ve
116 .SS ALTERNATIVES
117 .IX Subsection "ALTERNATIVES"
118 .IP \(bu 4
119 \&\fBtexlog-extract\fR : <https://www.ctan.org/pkg/texlog\-extract>
120 .IP \(bu 4
121 \&\fBtexloganalyser\fR : <https://www.ctan.org/pkg/texloganalyser>
122 .IP \(bu 4
123 \&\fBtexlogsieve\fR : <https://ctan.org/pkg/texlogsieve>
124 .SS AUTHOR
125 .IX Subsection "AUTHOR"
126 Written by Julien Labbé.
127 .PP
128 Inspired from a script given by Martin Scharrer on Stack Exchange network (see
129 <https://tex.stackexchange.com/a/10564>).
130 .SS LICENCE
131 .IX Subsection "LICENCE"
132 This work may be distributed and/or modified under the conditions of the LaTeX
133 Project Public License, either version 1.3 of this license or (at your option)
134 any later version. The latest version of this license is in
135 <http://www.latex\-project.org/lppl.txt> and version 1.3 or later is part of all
136 distributions of LaTeX version 2005/12/01 or later.
137 .SS VERSION
138 .IX Subsection "VERSION"
139 1.3.1
140 .SS HISTORY
141 .IX Subsection "HISTORY"
142 .IP \(bu 4
143 2024, June, versions 1.4: add warning patterns.
144 .IP \(bu 4
145 2024, February, versions 1.3 and 1.3.1: better detect the current file name.
146 .IP \(bu 4
147 2024, February, version 1.2: fix duplicate or missing lines; handle
148 package and class names with hyphen; add info and warning patterns for fonts.
149 .IP \(bu 4
150 2022, March, version 1.1: add \-\-info and \-\-no\-info options.
151 .IP \(bu 4
152 2021, November, version 1.0: initial version.
153 .SS DOCUMENTATION
154 .IX Subsection "DOCUMENTATION"
155 The documentation is integrated, writtent in Plain Old Documentation (POD)
156 format. Exported versions are available, in the following files:
157 .IP \(bu 4
158 \&\fIREADME\fR: created with perldoc.
159 .IP \(bu 4
160 \&\fItexlogfilter.html\fR: created with pod2html.