Tweak short text for job schema help

Jay Berkenbilt
1 parent 21b92907
Showing 6 changed files with 30 additions and 30 deletions
generate_auto_job
job.sums
job.yml
libqpdf/qpdf/auto_job_help.hh
libqpdf/qpdf/auto_job_schema.hh
manual/cli.rst
@@ -543,7 +543,7 @@ class Main:
             schema_value = j
             if schema_value is None:
                 schema_value = re.sub(
-                    r'--(\S+)',
+                    r'--([^\s=]+)',
                     lambda x: self.option_to_json_key(x.group(1)),
                     expected[flag]['help'])
             is_trivial = False
 # Generated by generate_auto_job
-generate_auto_job 8b3cc47eb96bfd003954d16d51c482e0e015544fdcdc1cbc89b6dcd964f8a2cb
+generate_auto_job cb0945a8aa05eb4a523d0931b2cf1a70188e4667d42e012d7621b3aba4f32621
 include/qpdf/auto_job_c_att.hh 7ad43bb374c1370ef32ebdcdcb7b73a61d281f7f4e3f12755585872ab30fb60e
 include/qpdf/auto_job_c_copy_att.hh 32275d03cdc69b703dd7e02ba0bbe15756e714e9ad185484773a6178dc09e1ee
 include/qpdf/auto_job_c_enc.hh 72e138c7b96ed5aacdce78c1dec04b1c20d361faec4f8faf52f64c1d6be99265
 include/qpdf/auto_job_c_main.hh ff776dd643279330fbf59770d1abf5aaeb13f20bfc5f6a25997aaa72a0907b44
 include/qpdf/auto_job_c_pages.hh 931840b329a36ca0e41401190e04537b47f2867671a6643bfd8da74014202671
 include/qpdf/auto_job_c_uo.hh 0585b7de459fa479d9e51a45fa92de0ff6dee748efc9ec1cedd0dde6cee1ad50
-job.yml 92565dc8023ea880aca5b96c2620f756642a6dafa5ed15546bc2c777c31b218e
+job.yml effc93a805fb74503be2213ad885238db21991ba3d084fbfeff01183c66cb002
 libqpdf/qpdf/auto_job_decl.hh 9f79396ec459f191be4c5fe34cf88c265cf47355a1a945fa39169d1c94cf04f6
-libqpdf/qpdf/auto_job_help.hh a0ab6ab4dde2ad3d3f17ecae3ea274919119329e075061f3a3973535f5e367de
+libqpdf/qpdf/auto_job_help.hh 6297d355cb37a6183469962ed75d465d62f498a9a49d43cac7af0c9d013a9e1b
 libqpdf/qpdf/auto_job_init.hh c244e03e8b83ed7db732920f40aff0134e5f2e78a6edb9473ea4dd1934a8953e
 libqpdf/qpdf/auto_job_json_decl.hh c5e3fd38a3b0c569eb0c6b4c60953a09cd6bc7d3361a357a81f64fe36af2b0cf
 libqpdf/qpdf/auto_job_json_init.hh 3f86ce40931ca8f417d050fcd49104d73c1fa4e977ad19d54b372831a8ea17ed
-libqpdf/qpdf/auto_job_schema.hh 2ec70dffdd15974d74102b4d7ada9f97449bc28c98be119efee5e15507ed22a8
+libqpdf/qpdf/auto_job_schema.hh d2fb9344bb0ed9b60cfa5511e81bea1335ea12997df731db9572de46b1d7f0b2
 manual/_ext/qpdf.py e9ac9d6c70642a3d29281ee5ad92ae2422dee8be9306fb8a0bc9dba0ed5e28f3
-manual/cli.rst a75a7e34aa9aba4f06e9c88cae9a2d9a2aa4e55a08521dde1478e8f2d80aadab
+manual/cli.rst 280826695c13d69527f49ef3e9de89cb628dc55cdbf2ad1dba1606325874c20a
@@ -356,7 +356,7 @@ json:
   ii-min-bytes:
   remove-unreferenced-resources:
   add-attachment:
-    - _file: "attachment to add"
+    - _file: "file to attach"
       creationdate:
       description:
       filename:
@@ -366,7 +366,7 @@ json:
       replace:
   remove-attachment:
   copy-attachments-from:
-    - _file: "attachment source filename"
+    - _file: "file to copy attachments from"
       CopyAtt.password:
       prefix:
   collate:
@@ -22,10 +22,10 @@ Usage: qpdf [infile] [options] [outfile]
 - @- may be used to read arguments from stdin
 - Later options may override earlier options if contradictory
 )");
-ap.addOptionHelp("--empty", "usage", "empty input file", R"(Use in place of infile for an empty input. Especially useful
+ap.addOptionHelp("--empty", "usage", "use empty file as input", R"(Use in place of infile for an empty input. Especially useful
 with --pages.
 )");
-ap.addOptionHelp("--replace-input", "usage", "replace input with output", R"(Use in place of outfile to overwrite the input file with the output.
+ap.addOptionHelp("--replace-input", "usage", "overwrite input with output", R"(Use in place of outfile to overwrite the input file with the output.
 )");
 ap.addOptionHelp("--job-json-file", "usage", "job JSON file", R"(--job-json-file=file
@@ -70,7 +70,7 @@ default provider is shown first.
 ap.addHelpTopic("general", "general options", R"(General options control qpdf's behavior in ways that are not
 directly related to the operation it is performing.
 )");
-ap.addOptionHelp("--password", "general", "specify password", R"(--password=password
+ap.addOptionHelp("--password", "general", "password for encrypted file", R"(--password=password
 Specify a password for an encrypted, password-protected file.
 Not needed for encrypted files without a password.
@@ -796,13 +796,13 @@ specific version or &quot;latest&quot;.
 )");
 ap.addOptionHelp("--json-help", "json", "show format of json output", R"(Describe the format of the JSON output.
 )");
-ap.addOptionHelp("--json-key", "json", "restrict which keys are in json output", R"(--json-key=key
+ap.addOptionHelp("--json-key", "json", "limit which keys are in json output", R"(--json-key=key
 This option is repeatable. If given, only the specified
 top-level keys will be included in the JSON output. Otherwise,
 all keys will be included.
 )");
-ap.addOptionHelp("--json-object", "json", "restrict which objects are in JSON", R"(--json-object={trailer|obj[,gen]}
+ap.addOptionHelp("--json-object", "json", "limit which objects are in JSON", R"(--json-object={trailer|obj[,gen]}
 This option is repeatable. If given, only specified objects will
 be shown in the "objects" key of the JSON output. Otherwise, all
 static constexpr char const* JOB_SCHEMA_DATA = R"({
   "inputFile": "input filename",
-  "password": "specify password",
+  "password": "password for encrypted file",
   "passwordFile": "read password from a file",
-  "empty": "empty input file",
+  "empty": "use empty file as input",
   "outputFile": "output filename",
-  "replaceInput": "replace input with output",
+  "replaceInput": "overwrite input with output",
   "qdf": "enable viewing PDF code in a text editor",
   "preserveUnreferenced": "preserve unreferenced objects",
   "newlineBeforeEndstream": "force a newline before endstream",
@@ -79,10 +79,10 @@ static constexpr char const* JOB_SCHEMA_DATA = R&quot;({
   "showAttachment": "export an embedded file",
   "json": "show file in json format",
   "jsonKey": [
-    "restrict which keys are in json output"
+    "limit which keys are in json output"
   ],
   "jsonObject": [
-    "restrict which objects are in JSON"
+    "limit which objects are in JSON"
   ],
   "allowWeakCrypto": "allow insecure cryptographic algorithms",
   "keepFilesOpen": "manage keeping multiple files open",
@@ -101,7 +101,7 @@ static constexpr char const* JOB_SCHEMA_DATA = R&quot;({
   "removeUnreferencedResources": "remove unreferenced page resources",
   "addAttachment": [
     {
-      "file": "attachment to add",
+      "file": "file to attach",
       "creationdate": "set attachment's creation date",
       "description": "set attachment's description",
       "filename": "set attachment's displayed filename",
@@ -114,8 +114,8 @@ static constexpr char const* JOB_SCHEMA_DATA = R&quot;({
   "removeAttachment": "remove an embedded file",
   "copyAttachmentsFrom": [
     {
-      "file": "attachment source filename",
-      "password": "specify password",
+      "file": "file to copy attachments from",
+      "password": "password for encrypted file",
       "prefix": "key prefix for copying attachments"
     }
   ],
@@ -131,7 +131,7 @@ static constexpr char const* JOB_SCHEMA_DATA = R&quot;({
   "pages": [
     {
       "file": "source for for pages",
-      "password": "specify password",
+      "password": "password for encrypted file",
       "range": "page range"
     }
   ],
@@ -139,21 +139,21 @@ static constexpr char const* JOB_SCHEMA_DATA = R&quot;({
   "rotate": "rotate pages",
   "overlay": {
     "file": "source file for overlay",
-    "password": "specify password",
+    "password": "password for encrypted file",
     "from": "source pages for underlay/overlay",
     "repeat": "overlay/underlay pages to repeat",
     "to": "destination pages for underlay/overlay"
   },
   "underlay": {
     "file": "source file for underlay",
-    "password": "specify password",
+    "password": "password for encrypted file",
     "from": "source pages for underlay/overlay",
     "repeat": "overlay/underlay pages to repeat",
     "to": "destination pages for underlay/overlay"
   },
   "warningExit0": "exit 0 even with warnings",
   "jobJsonFile": "job JSON file",
-  "preserveUnreferencedResources": "use removeUnreferencedResourcesNo",
+  "preserveUnreferencedResources": "use removeUnreferencedResources=no",
   "requiresPassword": "silently test a file's password",
   "isEncrypted": "silently test whether a file is encrypted"
 })";
@@ -134,7 +134,7 @@ Related Options
 .. qpdf:option:: --empty
-   .. help: empty input file
+   .. help: use empty file as input
       Use in place of infile for an empty input. Especially useful
       with --pages.
@@ -146,7 +146,7 @@ Related Options
 .. qpdf:option:: --replace-input
-   .. help: replace input with output
+   .. help: overwrite input with output
       Use in place of outfile to overwrite the input file with the output.
@@ -358,7 +358,7 @@ Related Options
 .. qpdf:option:: --password=password
-   .. help: specify password
+   .. help: password for encrypted file
       Specify a password for an encrypted, password-protected file.
       Not needed for encrypted files without a password.
@@ -3162,7 +3162,7 @@ Related Options
 .. qpdf:option:: --json-key=key
-   .. help: restrict which keys are in json output
+   .. help: limit which keys are in json output
       This option is repeatable. If given, only the specified
       top-level keys will be included in the JSON output. Otherwise,
@@ -3174,7 +3174,7 @@ Related Options
 .. qpdf:option:: --json-object={trailer|obj[,gen]}
-   .. help: restrict which objects are in JSON
+   .. help: limit which objects are in JSON
       This option is repeatable. If given, only specified objects will
       be shown in the "objects" key of the JSON output. Otherwise, all