summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-11-02 23:06:09 +0100
committerJay Berkenbilt <ejb@ql.org>2021-11-03 14:43:17 +0100
commit42ca1f007ac18b2a1426093c02c6ff261b737eae (patch)
tree7de1e61215c7083bafbc877645004c4a68d058d5 /manual
parent532a4f3d60f6981b22beb32e6ff688ec41f87e26 (diff)
downloadqpdf-42ca1f007ac18b2a1426093c02c6ff261b737eae.tar.zst
Document that --check > /dev/null is safe (fixes #522)
Diffstat (limited to 'manual')
-rw-r--r--manual/qpdf-manual.xml7
1 files changed, 6 insertions, 1 deletions
diff --git a/manual/qpdf-manual.xml b/manual/qpdf-manual.xml
index 411cfcfb..f5dd444e 100644
--- a/manual/qpdf-manual.xml
+++ b/manual/qpdf-manual.xml
@@ -2943,7 +2943,12 @@ outfile.pdf</option>
recover, after which other options are effectively operating
on the recovered file. Combining <option>--check</option> with
other options in this way can be useful for manually
- recovering severely damaged files.
+ recovering severely damaged files. Note that
+ <option>--check</option> produces no output to standard output
+ when everything is valid, so if you are using this to
+ programmatically validate files in bulk, it is safe to run
+ without output redirected to <filename>/dev/null</filename>
+ and just check for a 0 exit code.
</para>
</listitem>
</varlistentry>