diff options
author | Jay Berkenbilt <ejb@ql.org> | 2020-10-15 21:03:14 +0200 |
---|---|---|
committer | Jay Berkenbilt <ejb@ql.org> | 2020-10-15 21:03:14 +0200 |
commit | bbd45cd01c5993de0970065b2bbd03aa28837b2c (patch) | |
tree | 0be4c7ecdc6e44ec6a1dfe77c91bc5604b20d9dd /manual | |
parent | 8f1db4dcf253386f45a3aa535c5e7144b5ca36d1 (diff) | |
download | qpdf-bbd45cd01c5993de0970065b2bbd03aa28837b2c.tar.zst |
Clarify qpdf's exit statuses in the documentation
Diffstat (limited to 'manual')
-rw-r--r-- | manual/qpdf-manual.xml | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/manual/qpdf-manual.xml b/manual/qpdf-manual.xml index 11e963dc..9579562c 100644 --- a/manual/qpdf-manual.xml +++ b/manual/qpdf-manual.xml @@ -594,6 +594,40 @@ make Most options require an output file, but some testing or inspection commands do not. These are specifically noted. </para> + <sect2 id="ref.exit-status"> + <title>Exit Status</title> + <para> + The exit status of <command>qpdf</command> may be interpreted as + follows: + <itemizedlist> + <listitem> + <para> + <literal>0</literal>: no errors or warnings were found. The + file may still have problems qpdf can't detect. + </para> + </listitem> + <listitem> + <para> + <literal>2</literal>: errors were found. qpdf was not able to + fully process the file. + </para> + </listitem> + <listitem> + <para> + <literal>3</literal>: qpdf encountered problems that it was + able to recover from. In some cases, the resulting file may + still be damaged. Note that qpdf still exits with status + <literal>3</literal> if it finds warnings even when + <option>--no-warn</option> is specified. + </para> + </listitem> + </itemizedlist> + Note that <command>qpdf</command> never exists with status + <literal>1</literal>. If you get an exit status of + <literal>1</literal>, it was something else, like the shell not + being able to find or execute <command>qpdf</command>. + </para> + </sect2> </sect1> <sect1 id="ref.shell-completion"> <title>Shell Completion</title> |