aboutsummaryrefslogtreecommitdiffstats
path: root/manual/cli.rst
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-01-31 20:20:06 +0100
committerJay Berkenbilt <ejb@ql.org>2022-01-31 21:57:45 +0100
commite3506253f17137d6d4831b4615d74689446da72c (patch)
tree5357ed44fbbd4be6e41935a8f2d6c43ce2913316 /manual/cli.rst
parentb4fb9b4ec3e70945b07436c1f4a6a222c2d28b9f (diff)
downloadqpdf-e3506253f17137d6d4831b4615d74689446da72c.tar.zst
Add optional version to --json
Diffstat (limited to 'manual/cli.rst')
-rw-r--r--manual/cli.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/manual/cli.rst b/manual/cli.rst
index dbd64aad..141f8f2a 100644
--- a/manual/cli.rst
+++ b/manual/cli.rst
@@ -3136,15 +3136,21 @@ See :ref:`json` for details about the qpdf JSON format.
Related Options
~~~~~~~~~~~~~~~
-.. qpdf:option:: --json
+.. qpdf:option:: --json[=version]
.. help: show file in json format
Generate a JSON representation of the file. This is described in
- depth in the JSON section of the manual.
+ depth in the JSON section of the manual. "version" may be a
+ specific version or "latest".
Generate a JSON representation of the file. This is described in
- depth in :ref:`json`.
+ depth in :ref:`json`. The version parameter can be used to specify
+ which json version should be output. The only supported value is
+ ``1``, but it's possible that a new json output version will be
+ added in a future version. You can also specify ``latest`` to use
+ the latest json version. For backward compatibility, the default
+ value is ``1``.
.. qpdf:option:: --json-help