summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/pdftex-quiet/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/pdftex-quiet/README.md')
-rw-r--r--Master/texmf-dist/doc/support/pdftex-quiet/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/pdftex-quiet/README.md b/Master/texmf-dist/doc/support/pdftex-quiet/README.md
new file mode 100644
index 00000000000..49e0a2e5f4c
--- /dev/null
+++ b/Master/texmf-dist/doc/support/pdftex-quiet/README.md
@@ -0,0 +1,50 @@
+# pdftex-quiet
+
+This is a tool in BASH serving to reduce the output of `pdftex` command and see only relevant errors in red bold font to fight them ASAP.
+
+Originally, I've started this as [the TeX StackExchange answer](https://tex.stackexchange.com/a/459470/134632).
+
+Now, it's being proposed as a CTAN package called also `pdftex-quiet`.
+
+## Installation
+
+Download this repository:
+
+```bash
+git clone https://gitlab.jkozlovsky.cz/productivity/pdftex-quiet.git
+cd pdftex-quiet
+```
+
+Simply copy the bash script to your `$PATH`:
+
+```bash
+cp bin/pdftex-quiet /usr/local/bin/
+chmod +x /usr/local/bin/pdftex-quiet
+
+# Make sure we support also pdflatex-quiet command (pdflatex is also a symlink to pdftex command)
+ln -sf /usr/local/bin/pdftex-quiet /usr/local/bin/pdflatex-quiet
+```
+
+## Usage
+
+Usage is the same as with `pdftex` (it supports all the arguments except [COMMANDS], **but the filename is mandatory!**).
+
+```bash
+# Keep in mind that the last argument should always be the filename to compile
+# and it's mandatory! (unless you only want to print a help)
+pdftex-quiet --output-format dvi --output-directory=/tmp my_tex_source.tex
+
+# Print help
+pdftex-quiet --help
+
+# But most probably you simply want to run the pdftex without modifications:
+pdftex-quiet my_tex_source.tex
+```
+
+## Licence
+
+See the `LICENCE` file.
+
+## Credits
+
+This [project's avatar](https://www.shareicon.net/warning-attention-error-notice-signs-signaling-815477) was designed by [Flaticon](https://profile.flaticon.com/license/free).