summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-02-10 21:20:19 +0000
committerKarl Berry <karl@freefriends.org>2022-02-10 21:20:19 +0000
commitef4a791cfef99df6f7b9043051d3ba25255db354 (patch)
tree2de19dd0628fcba5c92aff5e91c5c1c0e36d9be9 /Master/texmf-dist/doc/support
parentffee07bd7efd5b8cdf09d3d335fd249e8087b035 (diff)
texlogsieve (10feb22)
git-svn-id: svn://tug.org/texlive/trunk@61974 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdfbin52118 -> 56978 bytes
-rw-r--r--Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex127
2 files changed, 109 insertions, 18 deletions
diff --git a/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf
index bf2f2df5f9f..1301f70b662 100644
--- a/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf
+++ b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex
index eb1ad528700..17d1919575e 100644
--- a/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex
+++ b/Master/texmf-dist/doc/support/texlogsieve/texlogsieve.tex
@@ -39,34 +39,40 @@
\RecordChanges
-\changes{v1.0.0-beta-1}{2021/12/16}{First public prerelease}
-\changes{v1.0.0-beta-2}{2022/01/04}{Automatically read \texttt{texlogsieverc}
+\changes{1.0.0-beta-1}{2021/12/16}{First public prerelease}
+\changes{1.0.0-beta-2}{2022/01/04}{Automatically read \texttt{texlogsieverc}
if it exists}
-\changes{v1.0.0-beta-2}{2022/01/04}{Add options \texttt{-\/-be-redundant}
+\changes{1.0.0-beta-2}{2022/01/04}{Add options \texttt{-\/-be-redundant}
and \texttt{-\/-box-detail}}
-\changes{v1.0.0-beta-2}{2022/01/04}{Add options
+\changes{1.0.0-beta-2}{2022/01/04}{Add options
\texttt{-\/-set-to-level-[levelname]}}
-\changes{v1.0.0-beta-2}{2022/01/04}{Include silenced messages in summaries}
-\changes{v1.0.0-beta-2}{2022/01/04}{Substitute empty citation/label keys
+\changes{1.0.0-beta-2}{2022/01/04}{Include silenced messages in summaries}
+\changes{1.0.0-beta-2}{2022/01/04}{Substitute empty citation/label keys
for ``???''}
-\changes{v1.0.0-beta-2}{2022/01/04}{Fix bug that prevented
+\changes{1.0.0-beta-2}{2022/01/04}{Fix bug that prevented
\texttt{-\/-add-[info\textbar
warning]-message} from working}
-\changes{v1.0.0-beta-2}{2022/01/04}{Misc small bugfixes}
-\changes{v1.0.0-beta-3}{2022/02/02}{Add options
+\changes{1.0.0-beta-2}{2022/01/04}{Misc small bugfixes}
+\changes{1.0.0-beta-3}{2022/02/02}{Add options
\texttt{-\/-summary-detail},
\texttt{-\/-ref-detail},
\texttt{-\/-cite-detail}}
-\changes{v1.0.0-beta-3}{2022/02/02}{Abort on invalid command-line options}
-\changes{v1.0.0-beta-3}{2022/02/02}{Detect ``please rerun`` messages and
+\changes{1.0.0-beta-3}{2022/02/02}{Abort on invalid command-line options}
+\changes{1.0.0-beta-3}{2022/02/02}{Detect ``please rerun`` messages and
add them to the summary}
-\changes{v1.0.0-beta-3}{2022/02/02}{Fix line unwrapping with \XeTeX}
+\changes{1.0.0-beta-3}{2022/02/02}{Fix line unwrapping with \XeTeX}
+\changes{1.0.0-final={1.0.0}}{2022/02/09}{Better compatibility with MiK\TeX\ for
+ Windows}
+\changes{1.0.0-final={1.0.0}}{2022/02/09}{If possible, use the \texttt{.fls} file}
+\changes{1.0.0-final={1.0.0}}{2022/02/09}{Add options \texttt{-\/-file-banner}
+ and \texttt{-\/-color}}
+\changes{1.0.0-final={1.0.0}}{2022/02/09}{Changed the effect of filters on the summary}
\begin{document}
\title{\textsf{texlogsieve}:\thanks{This document
-corresponds to \textsf{texlogsieve}~1.0.0-beta-3,
-dated~2022-02-02.}\\[.3\baselineskip]
+corresponds to \textsf{texlogsieve}~1.0.0,
+dated~2022-02-09.}\\[.3\baselineskip]
{\normalsize(yet another program to)\\[-.6\baselineskip]}
{\large filter and summarize \LaTeX\ log files}
}
@@ -203,10 +209,11 @@ starting with a ``\#'' sign are comments. An example configuration file:
\begin{quote}
\begin{verbatim}
+no-summary-detail
no-page-delay
# no-page-delay enables shipouts, but we do not want that
no-shipouts
-silence-string = Hyperreferences in rotated content will be misplaced
+set-to-level-info=Hyperreferences in rotated content will be misplaced
# no need to escape the "\" (or any other) character
silence-string = Using \overbracket and \underbracket from `mathtools'
# silence a string using lua pattern matching
@@ -241,6 +248,12 @@ with no-page-delay).
\end{description}
\begin{description}
+\item[\texttt{-\/-file-banner}, \texttt{-\/-no-file-banner}]~\\
+Show/don't show the ``From file\dots'' banner messages (default enabled,
+except with level \texttt{DEBUG} as that would be redundant and confusing).
+\end{description}
+
+\begin{description}
\item[\texttt{-\/-repetitions}, \texttt{-\/-no-repetitions}]~\\
Allow/prevent repeated messages (default disabled, i.e., repeated messages
are supressed).
@@ -288,6 +301,12 @@ Enable/disable progress gauge in page-delay mode (default enabled).
\end{description}
\begin{description}
+\item[\texttt{-\/-color}, \texttt{-\/-no-color}]~\\
+Enable/disable colored output. On Windows, this will only work with
+an up-to-date Windows 10 or later (default disabled).
+\end{description}
+
+\begin{description}
\item[\texttt{-l LEVEL}, \texttt{-\/-minlevel=LEVEL}]~\\
Filter out messages with severity level lower than \texttt{LEVEL}. Valid
levels are \texttt{DEBUG} (no filtering), \texttt{INFO}, \texttt{WARNING},
@@ -300,9 +319,9 @@ Do not filter messages and do not output the summary, only unwrap long,
wrapped lines. The output should be very similar (but not equal) to the
input file, but with wrapped lines reconstructed. This activates
\texttt{-l debug}, \texttt{-\/-no-summary}, \texttt{-\/-no-page-delay},
-\texttt{-\/-repetitions}, \texttt{-\/-be-redundant}, and
-\texttt{-\/-shipouts}, and also supresses the verbose ``open/close file''
-and ``shipout'' messages, simulating instead the \TeX{} format, with
+\texttt{-\/-repetitions}, \texttt{-\/-be-redundant}, \texttt{-\/-shipouts},
+and \texttt{-\/-no-file-banner}, and also supresses the verbose ``open/close
+file'' and ``shipout'' messages, simulating instead the \TeX{} format, with
parens and square brackets. This is useful if you prefer the reports
generated by some other tool but want to benefit from texlogsieve's line
unwrapping algorithm; the output generated by this option should be
@@ -397,6 +416,78 @@ Show concise options description.
Print program version.
\end{description}
+\section{Tips}
+
+\begin{itemize}
+ \item If the program output is still too verbose to your liking, resist
+ the urge to use \texttt{-l critical} or \texttt{-\/-only-summary}. Instead,
+ create a configuration file with \texttt{no-summary-detail} and appropriate
+ \texttt{silence-[something]} and \texttt{set-to-level-[something]} options:
+ You will get reasonably quiet output but still be notified of problems. Since
+ you probably always use essentially the same set of packages and classes,
+ the file will be useable in other \LaTeX\ projects too (you may even put
+ it somewhere in your \TeX\ path, like \texttt{\$HOME/texmf/tex/latex} on
+ Unix-like systems).
+
+ \item \texttt{texlogsieve} has no smarts to deal with error messages, but
+ you may use options \texttt{-l unknown -\/-no-page-delay -\/-no-summary
+ -\/-no-shipouts -\/-no-file-banner} to get almost nothing but errors.
+
+ \item With \texttt{latexmk}, it is enough to put something like this in
+ \texttt{latexmkrc}:
+
+ \bgroup\small
+ \begin{verbatim}
+set_tex_cmds("-halt-on-error -interaction nonstopmode %O %S|texlogsieve");\end{verbatim}
+ \egroup
+
+ However, this means you get to see the repeated output of all iterations
+ needed to produce the document. To only see the output of the last iteration,
+ you may do something like this:
+
+ \bgroup\small
+ \begin{verbatim}
+set_tex_cmds("-halt-on-error %O %S");
+
+$silent = 1; # This adds "-interaction batchmode"
+$silence_logfile_warnings = 1;
+
+END {
+ if (-s "$root_filename.blg"
+ and open my $bibfile, '<', "$root_filename.blg") {
+
+ print("**********************\n");
+ print("bibtex/biber messages:\n");
+ while(my $line = <$bibfile>) {
+ if ($line =~ /You.ve used/) {
+ last;
+ } else {
+ print($line);
+ };
+ };
+ close($bibfile);
+ };
+
+ if (-s "$root_filename.ilg"
+ and open my $indfile, '<', "$root_filename.ilg") {
+
+ print("*************************\n");
+ print("makeindex/xindy messages:\n");
+ while(my $line = <$indfile>) {
+ print($line);
+ };
+ close($indfile);
+ };
+
+ if (-s "$root_filename.log") {
+ print("***************\n");
+ print("LaTeX messages:\n");
+ Run_subst("texlogsieve %R.log");
+ };
+};\end{verbatim}
+ \egroup
+\end{itemize}
+
\section{License}
Copyright © 2021, 2022 Nelson Lago \textless lago@ime.usp.br\textgreater\\