summaryrefslogtreecommitdiff
path: root/support/texlogsieve/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'support/texlogsieve/README.md')
-rw-r--r--support/texlogsieve/README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/support/texlogsieve/README.md b/support/texlogsieve/README.md
index e7e9233997..fd13e3de2b 100644
--- a/support/texlogsieve/README.md
+++ b/support/texlogsieve/README.md
@@ -3,8 +3,13 @@
`texlogsieve` reads a LaTeX log file (or the standard input if no file is
specified), filters out less relevant messages, and displays a summary
report. It is a `texlua` script, similar in spirit to tools such as
-`texfot`, `texloganalyser`, `rubber-info`, `textlog_extract`,
-`texlogparser`, and others. Highlights:
+[`texfot`](https://ctan.org/pkg/texfot),
+[`texloganalyser`](https://ctan.org/pkg/texloganalyser),
+[`rubber-info`](https://gitlab.com/latex-rubber/rubber),
+[`textlog_extract`](https://ctan.org/pkg/texlog-extract),
+[`texlogparser`](https://github.com/reitzig/texlogparser),
+[`texlogfilter`](https://gricad-gitlab.univ-grenoble-alpes.fr/labbeju/latex-packages),
+and others. Highlights:
* Two reports: the most important messages from the log file followed by
a summary of repeated messages, undefined references etc.;
@@ -16,9 +21,7 @@ report. It is a `texlua` script, similar in spirit to tools such as
* Several options to control which messages should be filtered out;
-* No messages are accidentally removed;
-
-* The summary report is currently simple, but useful.
+* No messages are accidentally removed.
`texlogsieve` **must** be run from the same directory as `[pdf|lua|xe]latex`,
because it searches for the files used during compilation (packages loaded
@@ -38,7 +41,8 @@ or
texlogsieve myfile.log
```
-and be satisfied with the result.
+and be satisfied with the result (still, you should check the "Tips"
+section of the documentation).
Since it needs to know what messages to expect, `texlogsieve` is
currently geared towards LaTeX; I have no idea how it would work with