diff options
| author | Jay Berkenbilt <ejb@ql.org> | 2022-01-11 17:49:33 +0100 |
|---|---|---|
| committer | Jay Berkenbilt <ejb@ql.org> | 2022-01-30 19:11:03 +0100 |
| commit | c8729398ddb9ac82b00bbafaf24e8d37543e5b9e (patch) | |
| tree | 9f1931af7f1087f503737f45ed04b3745812cae2 /manual/json.rst | |
| parent | b4bd124be496170937d19742d83c2bad7471fe81 (diff) | |
| download | qpdf-c8729398ddb9ac82b00bbafaf24e8d37543e5b9e.tar.zst | |
Generate help content from manual
This is a massive rewrite of the help text and cli.rst section of the
manual. All command-line flags now have their own help and are
specifically index. qpdf --help is completely redone.
Diffstat (limited to 'manual/json.rst')
| -rw-r--r-- | manual/json.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/manual/json.rst b/manual/json.rst index 39bf9445..5567794d 100644 --- a/manual/json.rst +++ b/manual/json.rst @@ -51,7 +51,7 @@ Compatibility Documentation The :command:`qpdf` command can be invoked with the - :samp:`--json-help` option. This will output a JSON + :qpdf:ref:`--json-help` option. This will output a JSON structure that has the same structure as the JSON output that qpdf generates, except that each field in the help output is a description of the corresponding field in the JSON output. The specific @@ -134,7 +134,7 @@ There are a few limitations to be aware of with the JSON structure: encoding. In other words, it's best if you don't try to use the JSON format to extract binary strings from the PDF file, but if you really had to, it could be done. Note that qpdf's - :samp:`--show-object` option does not have this + :qpdf:ref:`--show-object` option does not have this limitation and will reveal the string as encoded in the original file. @@ -150,9 +150,9 @@ be aware of: - While qpdf guarantees that keys present in the help will be present in the output, those fields may be null or empty if the information is not known or absent in the file. Also, if you specify - :samp:`--json-keys`, the keys that are not listed + :qpdf:ref:`--json-key`, the keys that are not listed will be excluded entirely except for those that - :samp:`--json-help` says are always present. + :qpdf:ref:`--json-help` says are always present. - In a few places, there are keys with names containing ``pageposfrom1``. The values of these keys are null or an integer. If @@ -168,7 +168,7 @@ be aware of: - The image information included in the ``page`` section of the JSON output includes the key "``filterable``". Note that the value of this - field may depend on the :samp:`--decode-level` that + field may depend on the :qpdf:ref:`--decode-level` that you invoke qpdf with. The JSON output includes a top-level key "``parameters``" that indicates the decode level used for computing whether a stream was filterable. For example, jpeg images will be |