From 7eeaf58bb70ff9ce85d9d0580c5a2abcab8c6832 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Fri, 28 Jan 2022 12:17:06 -0500 Subject: More doc tweaks --- job.sums | 4 +-- libqpdf/qpdf/auto_job_help.hh | 44 +++++++++++++-------------- manual/cli.rst | 70 +++++++++++++++++++++---------------------- 3 files changed, 59 insertions(+), 59 deletions(-) diff --git a/job.sums b/job.sums index 05c7344f..6b153fb7 100644 --- a/job.sums +++ b/job.sums @@ -8,8 +8,8 @@ include/qpdf/auto_job_c_pages.hh 931840b329a36ca0e41401190e04537b47f2867671a6643 include/qpdf/auto_job_c_uo.hh 0585b7de459fa479d9e51a45fa92de0ff6dee748efc9ec1cedd0dde6cee1ad50 job.yml 1590fd16fd17ed40db9aa56b6713c844cfd61b3a6d0441a3ccd122b7371c68e9 libqpdf/qpdf/auto_job_decl.hh 9f79396ec459f191be4c5fe34cf88c265cf47355a1a945fa39169d1c94cf04f6 -libqpdf/qpdf/auto_job_help.hh 7155be7c3212afb9d5033dfacd3456768931bb6e837a2079d2332cd5bdafa087 +libqpdf/qpdf/auto_job_help.hh 23c79f1d2c02bda28f64aace17f69487205c797e7ae2234892cbbabab49d6d47 libqpdf/qpdf/auto_job_init.hh 3b6323189480a7d782563c9d2b5bc29b8dcd19c6dcc89840b207e38cb503d3f1 libqpdf/qpdf/auto_job_schema.hh 1c3b4b5488270f8d200ed345573e3a241f15baff6fb7e97ec3d044103b2546d9 manual/_ext/qpdf.py e9ac9d6c70642a3d29281ee5ad92ae2422dee8be9306fb8a0bc9dba0ed5e28f3 -manual/cli.rst 5fd018a6b34cd1b42a278f7b9afef709b72f082a65a563e8d2d3e10ce8ebe31a +manual/cli.rst 79140e023faa0cb77afe0b1dc512dd120ee5617f4db82f842596e4f239f93882 diff --git a/libqpdf/qpdf/auto_job_help.hh b/libqpdf/qpdf/auto_job_help.hh index 62991284..18ce5a2b 100644 --- a/libqpdf/qpdf/auto_job_help.hh +++ b/libqpdf/qpdf/auto_job_help.hh @@ -102,7 +102,7 @@ ap.addOptionHelp("--allow-weak-crypto", "general", "allow insecure cryptographic option is necessary to create 40-bit files or 128-bit files that use RC4 encryption. )"); -ap.addOptionHelp("--keep-files-open", "general", "manage keeping multiple files open", R"(--keep-files-open=[yn] +ap.addOptionHelp("--keep-files-open", "general", "manage keeping multiple files open", R"(--keep-files-open=[y|n] When qpdf needs to work with many files, as when merging large numbers of files, explicitly indicate whether files should be @@ -175,7 +175,7 @@ had in the original file. } static void add_help_3(QPDFArgParser& ap) { -ap.addOptionHelp("--compress-streams", "transformation", "compress uncompressed streams", R"(--compress-streams=[yn] +ap.addOptionHelp("--compress-streams", "transformation", "compress uncompressed streams", R"(--compress-streams=[y|n] Setting --compress-streams=n prevents qpdf from compressing uncompressed streams. This can be useful if you are leaving some @@ -220,7 +220,7 @@ gzip), which is the default compression for most PDF files. You need --recompress-flate with this option if you want to change already compressed streams. )"); -ap.addOptionHelp("--normalize-content", "transformation", "fix newlines in content streams", R"(--normalize-content=[yn] +ap.addOptionHelp("--normalize-content", "transformation", "fix newlines in content streams", R"(--normalize-content=[y|n] Normalize newlines to UNIX-style newlines in PDF content streams, which is useful for viewing them in a programmer's text @@ -402,24 +402,24 @@ restrictions that differ from what you selected. This is probably not a bug in qpdf. Options for 40-bit only: - --annotate=[yn] restrict comments, filling forms, and signing - --extract=[yn] restrict text/graphic extraction - --modify=[yn] restrict document modification - --print=[yn] restrict printing + --annotate=[y|n] restrict comments, filling forms, and signing + --extract=[y|n] restrict text/graphic extraction + --modify=[y|n] restrict document modification + --print=[y|n] restrict printing Options for 128-bit or 256-bit: - --accessibility=[yn] restrict accessibility (usually ignored) - --annotate=[yn] restrict commenting/filling form fields - --assemble=[yn] restrict document assembly - --extract=[yn] restrict text/graphic extraction - --form=[yn] restrict filling form fields - --modify-other=[yn] restrict other modifications + --accessibility=[y|n] restrict accessibility (usually ignored) + --annotate=[y|n] restrict commenting/filling form fields + --assemble=[y|n] restrict document assembly + --extract=[y|n] restrict text/graphic extraction + --form=[y|n] restrict filling form fields + --modify-other=[y|n] restrict other modifications --modify=modify-opt control modify access by level --print=print-opt control printing access --cleartext-metadata prevent encryption of metadata For 128-bit only: - --use-aes=[yn] indicates whether to use AES encryption + --use-aes=[y|n] indicates whether to use AES encryption --force-V4 forces use of V=4 encryption handler For 256-bit only: @@ -438,26 +438,26 @@ Values for modify-opt: annotate form + commenting and modifying forms all allow full document modification )"); -ap.addOptionHelp("--accessibility", "encryption", "restrict document accessibility", R"(--accessibility=[yn] +ap.addOptionHelp("--accessibility", "encryption", "restrict document accessibility", R"(--accessibility=[y|n] This option is ignored except with very old encryption formats. The current PDF specification does not allow restriction of document accessibility. This option is not available with 40-bit encryption. )"); -ap.addOptionHelp("--annotate", "encryption", "restrict document annotation", R"(--annotate=[yn] +ap.addOptionHelp("--annotate", "encryption", "restrict document annotation", R"(--annotate=[y|n] Enable/disable modifying annotations including making comments and filling in form fields. For 128-bit and 256-bit encryption, this also enables editing, creating, and deleting form fields unless --modify-other=n or --modify=none is also specified. )"); -ap.addOptionHelp("--assemble", "encryption", "restrict document assembly", R"(--assemble=[yn] +ap.addOptionHelp("--assemble", "encryption", "restrict document assembly", R"(--assemble=[y|n] Enable/disable document assembly (rotation and reordering of pages). This option is not available with 40-bit encryption. )"); -ap.addOptionHelp("--extract", "encryption", "restrict text/graphic extraction", R"(--extract=[yn] +ap.addOptionHelp("--extract", "encryption", "restrict text/graphic extraction", R"(--extract=[y|n] Enable/disable text/graphic extraction for purposes other than accessibility. @@ -465,13 +465,13 @@ accessibility. } static void add_help_5(QPDFArgParser& ap) { -ap.addOptionHelp("--form", "encryption", "restrict form filling", R"(--form=[yn] +ap.addOptionHelp("--form", "encryption", "restrict form filling", R"(--form=[y|n] Enable/disable whether filling form fields is allowed even if modification of annotations is disabled. This option is not available with 40-bit encryption. )"); -ap.addOptionHelp("--modify-other", "encryption", "restrict other modifications", R"(--modify-other=[yn] +ap.addOptionHelp("--modify-other", "encryption", "restrict other modifications", R"(--modify-other=[y|n] Enable/disable modifications not controlled by --assemble, --annotate, or --form. --modify-other=n is implied by any of the @@ -509,7 +509,7 @@ ap.addOptionHelp("--cleartext-metadata", "encryption", "don't encrypt metadata", encrypting the rest of the document. This option is not available with 40-bit encryption. )"); -ap.addOptionHelp("--use-aes", "encryption", "use AES with 128-bit encryption", R"(--use-aes=[yn] +ap.addOptionHelp("--use-aes", "encryption", "use AES with 128-bit encryption", R"(--use-aes=[y|n] Enables/disables use of the more secure AES encryption with 128-bit encryption. Specifying --use-aes=y forces the PDF @@ -576,7 +576,7 @@ underlaid on the primary output. Overlaid pages are drawn on top of the destination page and may obscure the page. Underlaid pages are drawn below the destination page. Usage: -{--overlay | --underlay } file +{--overlay|--underlay} file [--password=password] [--to=page-range] [--from=[page-range]] diff --git a/manual/cli.rst b/manual/cli.rst index 2a5d66db..dbd64aad 100644 --- a/manual/cli.rst +++ b/manual/cli.rst @@ -473,7 +473,7 @@ Related Options files with weak cryptography when this flag is not given. See :ref:`weak-crypto` for additional details. -.. qpdf:option:: --keep-files-open=[yn] +.. qpdf:option:: --keep-files-open=[y|n] .. help: manage keeping multiple files open @@ -817,7 +817,7 @@ Related Options default because it makes it easier to trace objects back to the original file. -.. qpdf:option:: --compress-streams=[yn] +.. qpdf:option:: --compress-streams=[y|n] .. help: compress uncompressed streams @@ -963,7 +963,7 @@ Related Options :samp:`--object-streams=generate`. If you omit this option, qpdf defers to the compression library's default behavior. -.. qpdf:option:: --normalize-content=[yn] +.. qpdf:option:: --normalize-content=[y|n] .. help: fix newlines in content streams @@ -1703,24 +1703,24 @@ Encryption not a bug in qpdf. Options for 40-bit only: - --annotate=[yn] restrict comments, filling forms, and signing - --extract=[yn] restrict text/graphic extraction - --modify=[yn] restrict document modification - --print=[yn] restrict printing + --annotate=[y|n] restrict comments, filling forms, and signing + --extract=[y|n] restrict text/graphic extraction + --modify=[y|n] restrict document modification + --print=[y|n] restrict printing Options for 128-bit or 256-bit: - --accessibility=[yn] restrict accessibility (usually ignored) - --annotate=[yn] restrict commenting/filling form fields - --assemble=[yn] restrict document assembly - --extract=[yn] restrict text/graphic extraction - --form=[yn] restrict filling form fields - --modify-other=[yn] restrict other modifications + --accessibility=[y|n] restrict accessibility (usually ignored) + --annotate=[y|n] restrict commenting/filling form fields + --assemble=[y|n] restrict document assembly + --extract=[y|n] restrict text/graphic extraction + --form=[y|n] restrict filling form fields + --modify-other=[y|n] restrict other modifications --modify=modify-opt control modify access by level --print=print-opt control printing access --cleartext-metadata prevent encryption of metadata For 128-bit only: - --use-aes=[yn] indicates whether to use AES encryption + --use-aes=[y|n] indicates whether to use AES encryption --force-V4 forces use of V=4 encryption handler For 256-bit only: @@ -1792,38 +1792,38 @@ help for each option. :widths: 30 70 :header-rows: 0 - - - ``--annotate=[yn]`` + - - ``--annotate=[y|n]`` - restrict comments, filling forms, and signing - - - ``--extract=[yn]`` + - - ``--extract=[y|n]`` - restrict text/graphic extraction - - - ``--modify=[yn]`` + - - ``--modify=[y|n]`` - restrict document modification - - - ``--print=[yn]`` + - - ``--print=[y|n]`` - restrict printing .. list-table:: Options for 128-bit or 256-bit Encryption :widths: 30 70 :header-rows: 0 - - - ``--accessibility=[yn]`` + - - ``--accessibility=[y|n]`` - restrict accessibility (usually ignored) - - - ``--annotate=[yn]`` + - - ``--annotate=[y|n]`` - restrict commenting/filling form fields - - - ``--assemble=[yn]`` + - - ``--assemble=[y|n]`` - restrict document assembly - - - ``--extract=[yn]`` + - - ``--extract=[y|n]`` - restrict text/graphic extraction - - - ``--form=[yn]`` + - - ``--form=[y|n]`` - restrict filling form fields - - - ``--modify-other=[yn]`` + - - ``--modify-other=[y|n]`` - restrict other modifications - - ``--modify=modify-opt`` @@ -1836,10 +1836,10 @@ help for each option. - prevent encryption of metadata .. list-table:: Options for 128-bit Encryption Only - :widths: 30 70 + :widths: 35 65 :header-rows: 0 - - - ``--use-aes=[yn]`` + - - ``--use-aes=[y|n]`` - indicates whether to use AES encryption - - ``--force-V4`` @@ -1891,7 +1891,7 @@ help for each option. Related Options ~~~~~~~~~~~~~~~ -.. qpdf:option:: --accessibility=[yn] +.. qpdf:option:: --accessibility=[y|n] .. help: restrict document accessibility @@ -1910,7 +1910,7 @@ Related Options This option is not available with 40-bit encryption. -.. qpdf:option:: --annotate=[yn] +.. qpdf:option:: --annotate=[y|n] .. help: restrict document annotation @@ -1925,7 +1925,7 @@ Related Options creating, and deleting form fields unless :samp:`--modify-other=n` or :samp:`--modify=none` is also specified. -.. qpdf:option:: --assemble=[yn] +.. qpdf:option:: --assemble=[y|n] .. help: restrict document assembly @@ -1937,7 +1937,7 @@ Related Options This option is not available with 40-bit encryption. -.. qpdf:option:: --extract=[yn] +.. qpdf:option:: --extract=[y|n] .. help: restrict text/graphic extraction @@ -1947,7 +1947,7 @@ Related Options Enable/disable text/graphic extraction for purposes other than accessibility. The default is to be fully permissive. -.. qpdf:option:: --form=[yn] +.. qpdf:option:: --form=[y|n] .. help: restrict form filling @@ -1961,7 +1961,7 @@ Related Options This option is not available with 40-bit encryption. -.. qpdf:option:: --modify-other=[yn] +.. qpdf:option:: --modify-other=[y|n] .. help: restrict other modifications @@ -2094,7 +2094,7 @@ Related Options This option is not available with 40-bit encryption. -.. qpdf:option:: --use-aes=[yn] +.. qpdf:option:: --use-aes=[y|n] .. help: use AES with 128-bit encryption @@ -2434,7 +2434,7 @@ Overlay and Underlay the destination page and may obscure the page. Underlaid pages are drawn below the destination page. Usage: - {--overlay | --underlay } file + {--overlay|--underlay} file [--password=password] [--to=page-range] [--from=[page-range]] @@ -2458,7 +2458,7 @@ as follows: :: - { --overlay | --underlay } file [options] -- + {--overlay|--underlay} file [options] -- Overlay and underlay options are processed late, so they can be combined with other options like merging and will apply to the final -- cgit v1.2.3-70-g09d2