Commit 15b87d769e256046bd22227bdc6fb874484f2d53

Authored by Jay Berkenbilt
1 parent cf3b9a77

Replace command|application with :command:`...`

Replace @1@...@2@ stuff from prior to the conversion with new
representation.
Showing 2 changed files with 141 additions and 142 deletions
@@ -36,7 +36,6 @@ Make sure the information from <book> is in there @@ -36,7 +36,6 @@ Make sure the information from <book> is in there
36 <xref> -- find #ref. in converted rst 36 <xref> -- find #ref. in converted rst
37 Correct placement of comment: <!-- This section is referenced in QPDFObjectHandle.hh --> 37 Correct placement of comment: <!-- This section is referenced in QPDFObjectHandle.hh -->
38 38
39 -<application>, <command> -> :command:  
40 <filename> -> :file: (allows {x}) 39 <filename> -> :file: (allows {x})
41 <option> -> :samp: (allows {x}) 40 <option> -> :samp: (allows {x})
42 <firstterm> -> just use literal 41 <firstterm> -> just use literal
manual/index.rst
@@ -116,7 +116,7 @@ the following packages are required: @@ -116,7 +116,7 @@ the following packages are required:
116 - GNU diffutils (any version): http://www.gnu.org/software/diffutils/ 116 - GNU diffutils (any version): http://www.gnu.org/software/diffutils/
117 is required to run the test suite. Note that this is the version of 117 is required to run the test suite. Note that this is the version of
118 diff present on virtually all GNU/Linux systems. This is required 118 diff present on virtually all GNU/Linux systems. This is required
119 - because the test suite uses @1@command@1@diff -u@2@command@2@. 119 + because the test suite uses :command:`diff -u`.
120 120
121 Part of qpdf's test suite does comparisons of the contents PDF files by 121 Part of qpdf's test suite does comparisons of the contents PDF files by
122 converting them images and comparing the images. The image comparison 122 converting them images and comparing the images. The image comparison
@@ -130,7 +130,7 @@ off by default and are only provided to help developers look into the @@ -130,7 +130,7 @@ off by default and are only provided to help developers look into the
130 contents of PDF files. If you are making deep changes to the library 130 contents of PDF files. If you are making deep changes to the library
131 that cause changes in the contents of the files that qpdf generates, 131 that cause changes in the contents of the files that qpdf generates,
132 then you should enable the image comparison tests. Enable them by 132 then you should enable the image comparison tests. Enable them by
133 -running @1@command@1@configure@2@command@2@ with the 133 +running :command:`configure` with the
134 @1@option@1@--enable-test-compare-images@2@option@2@ flag. If you enable 134 @1@option@1@--enable-test-compare-images@2@option@2@ flag. If you enable
135 this, the following additional requirements are required by the test 135 this, the following additional requirements are required by the test
136 suite. Note that in no case are these items required to use qpdf. 136 suite. Note that in no case are these items required to use qpdf.
@@ -161,9 +161,9 @@ Building qpdf on UNIX is generally just a matter of running @@ -161,9 +161,9 @@ Building qpdf on UNIX is generally just a matter of running
161 ./configure 161 ./configure
162 make 162 make
163 163
164 -You can also run @1@command@1@make check@2@command@2@ to run the test  
165 -suite and @1@command@1@make install@2@command@2@ to install. Please run  
166 -@1@command@1@./configure --help@2@command@2@ for options on what can be 164 +You can also run :command:`make check` to run the test
  165 +suite and :command:`make install` to install. Please run
  166 +:command:`./configure --help` for options on what can be
167 configured. You can also set the value of ``DESTDIR`` during 167 configured. You can also set the value of ``DESTDIR`` during
168 installation to install to a temporary location, as is common with many 168 installation to install to a temporary location, as is common with many
169 open source packages. Please see also the 169 open source packages. Please see also the
@@ -187,8 +187,8 @@ very unusual situation. For a detailed discussion, please see the @@ -187,8 +187,8 @@ very unusual situation. For a detailed discussion, please see the
187 top-level README.md file in qpdf's source distribution. 187 top-level README.md file in qpdf's source distribution.
188 188
189 There are some other things you can do with the build. Although qpdf 189 There are some other things you can do with the build. Although qpdf
190 -uses @1@application@1@autoconf@2@application@2@, it does not use  
191 -@1@application@1@automake@2@application@2@ but instead uses a 190 +uses :command:`autoconf`, it does not use
  191 +:command:`automake` but instead uses a
192 hand-crafted non-recursive Makefile that requires gnu make. If you're 192 hand-crafted non-recursive Makefile that requires gnu make. If you're
193 really interested, please read the comments in the top-level 193 really interested, please read the comments in the top-level
194 @1@filename@1@Makefile@2@filename@2@. 194 @1@filename@1@Makefile@2@filename@2@.
@@ -218,13 +218,13 @@ Build Support For Crypto Providers @@ -218,13 +218,13 @@ Build Support For Crypto Providers
218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219 219
220 When building with qpdf's build system, crypto providers can be enabled 220 When building with qpdf's build system, crypto providers can be enabled
221 -at build time using various @1@command@1@./configure@2@command@2@ 221 +at build time using various :command:`./configure`
222 options. The default behavior is for 222 options. The default behavior is for
223 -@1@command@1@./configure@2@command@2@ to discover which crypto providers 223 +:command:`./configure` to discover which crypto providers
224 can be supported based on available external libraries, to build all 224 can be supported based on available external libraries, to build all
225 available crypto providers, and to use an external provider as the 225 available crypto providers, and to use an external provider as the
226 default over the native one. This behavior can be changed with the 226 default over the native one. This behavior can be changed with the
227 -following flags to @1@command@1@./configure@2@command@2@: 227 +following flags to :command:`./configure`:
228 228
229 - @1@option@1@--enable-crypto-@1@replaceable@1@x@2@replaceable@2@@2@option@2@ 229 - @1@option@1@--enable-crypto-@1@replaceable@1@x@2@replaceable@2@@2@option@2@
230 (where @1@replaceable@1@x@2@replaceable@2@ is a supported crypto 230 (where @1@replaceable@1@x@2@replaceable@2@ is a supported crypto
@@ -246,8 +246,8 @@ following flags to @1@command@1@./configure@2@command@2@: @@ -246,8 +246,8 @@ following flags to @1@command@1@./configure@2@command@2@:
246 246
247 For example, if you want to guarantee that the gnutls crypto provider is 247 For example, if you want to guarantee that the gnutls crypto provider is
248 used and that the native provider is not built, you could run 248 used and that the native provider is not built, you could run
249 -@1@command@1@./configure --enable-crypto-gnutls  
250 ---disable-implicit-crypto@2@command@2@. 249 +:command:`./configure --enable-crypto-gnutls
  250 +--disable-implicit-crypto`.
251 251
252 If you build qpdf using your own build system, in order for qpdf to work 252 If you build qpdf using your own build system, in order for qpdf to work
253 at all, you need to enable at least one crypto provider. The file 253 at all, you need to enable at least one crypto provider. The file
@@ -279,7 +279,7 @@ Runtime Crypto Provider Selection @@ -279,7 +279,7 @@ Runtime Crypto Provider Selection
279 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 279 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
280 280
281 You can use the @1@option@1@--show-crypto@2@option@2@ option to 281 You can use the @1@option@1@--show-crypto@2@option@2@ option to
282 -@1@command@1@qpdf@2@command@2@ to get a list of available crypto 282 +:command:`qpdf` to get a list of available crypto
283 providers. The default provider is always listed first, and the rest are 283 providers. The default provider is always listed first, and the rest are
284 listed in lexical order. Each crypto provider is listed on a line by 284 listed in lexical order. Each crypto provider is listed on a line by
285 itself with no other text, enabling the output of this command to be 285 itself with no other text, enabling the output of this command to be
@@ -396,7 +396,7 @@ some things you may want to keep in mind: @@ -396,7 +396,7 @@ some things you may want to keep in mind:
396 Providers <#ref.crypto.build>`__ for details. 396 Providers <#ref.crypto.build>`__ for details.
397 397
398 - Passing @1@option@1@--enable-show-failed-test-output@2@option@2@ to 398 - Passing @1@option@1@--enable-show-failed-test-output@2@option@2@ to
399 - @1@command@1@./configure@2@command@2@ will cause any failed test 399 + :command:`./configure` will cause any failed test
400 output to be written to the console. This can be very useful for 400 output to be written to the console. This can be very useful for
401 seeing test failures generated by autobuilders where you can't access 401 seeing test failures generated by autobuilders where you can't access
402 qtest.log after the fact. 402 qtest.log after the fact.
@@ -409,11 +409,11 @@ some things you may want to keep in mind: @@ -409,11 +409,11 @@ some things you may want to keep in mind:
409 their sources. If your packaging environment automatically refreshes 409 their sources. If your packaging environment automatically refreshes
410 automatic files, it can cause this check to fail. Suppress qpdf's 410 automatic files, it can cause this check to fail. Suppress qpdf's
411 checks by passing @1@option@1@--disable-check-autofiles@2@option@2@ 411 checks by passing @1@option@1@--disable-check-autofiles@2@option@2@
412 - to @1@command@1@/.configure@2@command@2@. This is safe since qpdf's  
413 - @1@command@1@autogen.sh@2@command@2@ just runs autotools in the 412 + to :command:`/.configure`. This is safe since qpdf's
  413 + :command:`autogen.sh` just runs autotools in the
414 normal way. 414 normal way.
415 415
416 -- QPDF's @1@command@1@make install@2@command@2@ does not install 416 +- QPDF's :command:`make install` does not install
417 completion files by default, but as a packager, it's good if you 417 completion files by default, but as a packager, it's good if you
418 install them wherever your distribution expects such files to go. You 418 install them wherever your distribution expects such files to go. You
419 can find completion files to install in the 419 can find completion files to install in the
@@ -440,7 +440,7 @@ When running qpdf, the basic invocation is as follows: @@ -440,7 +440,7 @@ When running qpdf, the basic invocation is as follows:
440 440
441 :: 441 ::
442 442
443 - @1@command@1@qpdf@2@command@2@@1@option@1@ [ @1@replaceable@1@options@2@replaceable@2@ ] { @1@replaceable@1@infilename@2@replaceable@2@ | @1@option@1@--empty@2@option@2@ } [ @1@replaceable@1@page_selection_options@2@replaceable@2@ ] @1@replaceable@1@outfilename@2@replaceable@2@@2@option@2@ 443 + :command:`qpdf`@1@option@1@ [ @1@replaceable@1@options@2@replaceable@2@ ] { @1@replaceable@1@infilename@2@replaceable@2@ | @1@option@1@--empty@2@option@2@ } [ @1@replaceable@1@page_selection_options@2@replaceable@2@ ] @1@replaceable@1@outfilename@2@replaceable@2@@2@option@2@
444 444
445 This converts PDF file @1@option@1@infilename@2@option@2@ to PDF file 445 This converts PDF file @1@option@1@infilename@2@option@2@ to PDF file
446 @1@option@1@outfilename@2@option@2@. The output file is functionally 446 @1@option@1@outfilename@2@option@2@. The output file is functionally
@@ -484,7 +484,7 @@ commands do not. These are specifically noted. @@ -484,7 +484,7 @@ commands do not. These are specifically noted.
484 Exit Status 484 Exit Status
485 ~~~~~~~~~~~ 485 ~~~~~~~~~~~
486 486
487 -The exit status of @1@command@1@qpdf@2@command@2@ may be interpreted as 487 +The exit status of :command:`qpdf` may be interpreted as
488 follows: 488 follows:
489 489
490 - ``0``: no errors or warnings were found. The file may still have 490 - ``0``: no errors or warnings were found. The file may still have
@@ -502,9 +502,9 @@ follows: @@ -502,9 +502,9 @@ follows:
502 @1@option@1@--warning-exit-0@2@option@2@, warnings without errors 502 @1@option@1@--warning-exit-0@2@option@2@, warnings without errors
503 exit with status 0 instead of 3. 503 exit with status 0 instead of 3.
504 504
505 -Note that @1@command@1@qpdf@2@command@2@ never exists with status ``1``. 505 +Note that :command:`qpdf` never exists with status ``1``.
506 If you get an exit status of ``1``, it was something else, like the 506 If you get an exit status of ``1``, it was something else, like the
507 -shell not being able to find or execute @1@command@1@qpdf@2@command@2@. 507 +shell not being able to find or execute :command:`qpdf`.
508 508
509 .. _ref.shell-completion: 509 .. _ref.shell-completion:
510 510
@@ -512,10 +512,10 @@ Shell Completion @@ -512,10 +512,10 @@ Shell Completion
512 ---------------- 512 ----------------
513 513
514 Starting in qpdf version 8.3.0, qpdf provides its own completion support 514 Starting in qpdf version 8.3.0, qpdf provides its own completion support
515 -for zsh and bash. You can enable bash completion with @1@command@1@eval  
516 -$(qpdf --completion-bash)@2@command@2@ and zsh completion with  
517 -@1@command@1@eval $(qpdf --completion-zsh)@2@command@2@. If  
518 -@1@command@1@qpdf@2@command@2@ is not in your path, you should invoke it 515 +for zsh and bash. You can enable bash completion with :command:`eval
  516 +$(qpdf --completion-bash)` and zsh completion with
  517 +:command:`eval $(qpdf --completion-zsh)`. If
  518 +:command:`qpdf` is not in your path, you should invoke it
519 above with an absolute path. If you invoke it with a relative path, it 519 above with an absolute path. If you invoke it with a relative path, it
520 will warn you, and the completion won't work if you're in a different 520 will warn you, and the completion won't work if you're in a different
521 directory. 521 directory.
@@ -610,13 +610,13 @@ needed transformations. @@ -610,13 +610,13 @@ needed transformations.
610 610
611 @1@option@1@--no-warn@2@option@2@ 611 @1@option@1@--no-warn@2@option@2@
612 Suppress writing of warnings to stderr. If warnings were detected and 612 Suppress writing of warnings to stderr. If warnings were detected and
613 - suppressed, @1@command@1@qpdf@2@command@2@ will still exit with exit 613 + suppressed, :command:`qpdf` will still exit with exit
614 code 3. See also @1@option@1@--warning-exit-0@2@option@2@. 614 code 3. See also @1@option@1@--warning-exit-0@2@option@2@.
615 615
616 @1@option@1@--warning-exit-0@2@option@2@ 616 @1@option@1@--warning-exit-0@2@option@2@
617 If warnings are found but no errors, exit with exit code 0 instead 3. 617 If warnings are found but no errors, exit with exit code 0 instead 3.
618 When combined with @1@option@1@--no-warn@2@option@2@, the effect is 618 When combined with @1@option@1@--no-warn@2@option@2@, the effect is
619 - for @1@command@1@qpdf@2@command@2@ to completely ignore warnings. 619 + for :command:`qpdf` to completely ignore warnings.
620 620
621 @1@option@1@--linearize@2@option@2@ 621 @1@option@1@--linearize@2@option@2@
622 Causes generation of a linearized (web-optimized) output file. 622 Causes generation of a linearized (web-optimized) output file.
@@ -749,12 +749,12 @@ needed transformations. @@ -749,12 +749,12 @@ needed transformations.
749 original rotations. This is almost always what you want. Otherwise 749 original rotations. This is almost always what you want. Otherwise
750 the pages' rotations are set to the exact value, which may cause the 750 the pages' rotations are set to the exact value, which may cause the
751 appearances of the pages to be inconsistent, especially for scans. 751 appearances of the pages to be inconsistent, especially for scans.
752 - For example, the command @1@command@1@qpdf in.pdf out.pdf  
753 - --rotate=+90:2,4,6 --rotate=180:7-8@2@command@2@ would rotate pages 752 + For example, the command :command:`qpdf in.pdf out.pdf
  753 + --rotate=+90:2,4,6 --rotate=180:7-8` would rotate pages
754 2, 4, and 6 90 degrees clockwise from their original rotation and 754 2, 4, and 6 90 degrees clockwise from their original rotation and
755 force the rotation of pages 7 through 8 to 180 degrees regardless of 755 force the rotation of pages 7 through 8 to 180 degrees regardless of
756 - their original rotation, and the command @1@command@1@qpdf in.pdf  
757 - out.pdf --rotate=+180@2@command@2@ would rotate all pages by 180 756 + their original rotation, and the command :command:`qpdf in.pdf
  757 + out.pdf --rotate=+180` would rotate all pages by 180
758 degrees. 758 degrees.
759 759
760 @1@option@1@--keep-files-open=@1@replaceable@1@[yn]@2@replaceable@2@@2@option@2@ 760 @1@option@1@--keep-files-open=@1@replaceable@1@[yn]@2@replaceable@2@@2@option@2@
@@ -826,17 +826,17 @@ needed transformations. @@ -826,17 +826,17 @@ needed transformations.
826 two numbers separated by a dash otherwise. For example, if 826 two numbers separated by a dash otherwise. For example, if
827 @1@filename@1@infile.pdf@2@filename@2@ has 12 pages 827 @1@filename@1@infile.pdf@2@filename@2@ has 12 pages
828 828
829 - - @1@command@1@qpdf --split-pages infile.pdf %d-out@2@command@2@ 829 + - :command:`qpdf --split-pages infile.pdf %d-out`
830 would generate files @1@filename@1@01-out@2@filename@2@ through 830 would generate files @1@filename@1@01-out@2@filename@2@ through
831 @1@filename@1@12-out@2@filename@2@ 831 @1@filename@1@12-out@2@filename@2@
832 832
833 - - @1@command@1@qpdf --split-pages=2 infile.pdf  
834 - outfile.pdf@2@command@2@ would generate files 833 + - :command:`qpdf --split-pages=2 infile.pdf
  834 + outfile.pdf` would generate files
835 @1@filename@1@outfile-01-02.pdf@2@filename@2@ through 835 @1@filename@1@outfile-01-02.pdf@2@filename@2@ through
836 @1@filename@1@outfile-11-12.pdf@2@filename@2@ 836 @1@filename@1@outfile-11-12.pdf@2@filename@2@
837 837
838 - - @1@command@1@qpdf --split-pages infile.pdf  
839 - something.else@2@command@2@ would generate files 838 + - :command:`qpdf --split-pages infile.pdf
  839 + something.else` would generate files
840 @1@filename@1@something.else-01@2@filename@2@ through 840 @1@filename@1@something.else-01@2@filename@2@ through
841 @1@filename@1@something.else-12@2@filename@2@ 841 @1@filename@1@something.else-12@2@filename@2@
842 842
@@ -844,7 +844,7 @@ needed transformations. @@ -844,7 +844,7 @@ needed transformations.
844 original PDF file are not preserved. For each page of output, this 844 original PDF file are not preserved. For each page of output, this
845 option creates an empty PDF and copies a single page from the output 845 option creates an empty PDF and copies a single page from the output
846 into it. If you require the global data, you will have to run 846 into it. If you require the global data, you will have to run
847 - @1@command@1@qpdf@2@command@2@ with the 847 + :command:`qpdf` with the
848 @1@option@1@--pages@2@option@2@ option once for each file. Using 848 @1@option@1@--pages@2@option@2@ option once for each file. Using
849 @1@option@1@--split-pages@2@option@2@ is much faster if you don't 849 @1@option@1@--split-pages@2@option@2@ is much faster if you don't
850 require the global data. 850 require the global data.
@@ -878,7 +878,7 @@ properly encoded encryption and decryption passwords to the user. @@ -878,7 +878,7 @@ properly encoded encryption and decryption passwords to the user.
878 Starting in qpdf 8.4.0, qpdf does this automatically in most cases. For 878 Starting in qpdf 8.4.0, qpdf does this automatically in most cases. For
879 an in-depth discussion, please see `Unicode 879 an in-depth discussion, please see `Unicode
880 Passwords <#ref.unicode-passwords>`__. Previous versions of this manual 880 Passwords <#ref.unicode-passwords>`__. Previous versions of this manual
881 -described workarounds using the @1@command@1@iconv@2@command@2@ command. 881 +described workarounds using the :command:`iconv` command.
882 Such workarounds are no longer required or recommended with qpdf 8.4.0. 882 Such workarounds are no longer required or recommended with qpdf 8.4.0.
883 However, for backward compatibility, qpdf attempts to detect those 883 However, for backward compatibility, qpdf attempts to detect those
884 workarounds and do the right thing in most cases. 884 workarounds and do the right thing in most cases.
@@ -1084,8 +1084,8 @@ sees a value in the place where it expects a page range and that value @@ -1084,8 +1084,8 @@ sees a value in the place where it expects a page range and that value
1084 is not a valid range but is a valid file name, qpdf will implicitly use 1084 is not a valid range but is a valid file name, qpdf will implicitly use
1085 the range ``1-z``, meaning that it will include all pages in the file. 1085 the range ``1-z``, meaning that it will include all pages in the file.
1086 This makes it possible to easily combine all pages in a set of files 1086 This makes it possible to easily combine all pages in a set of files
1087 -with a command like @1@command@1@qpdf --empty out.pdf --pages \*.pdf  
1088 ---@2@command@2@. 1087 +with a command like :command:`qpdf --empty out.pdf --pages \*.pdf
  1088 +--`.
1089 1089
1090 The page range is a set of numbers separated by commas, ranges of 1090 The page range is a set of numbers separated by commas, ranges of
1091 numbers separated dashes, or combinations of those. The character "z" 1091 numbers separated dashes, or combinations of those. The character "z"
@@ -1124,14 +1124,14 @@ of @1@option@1@--pages@2@option@2@ so that the specified files, as @@ -1124,14 +1124,14 @@ of @1@option@1@--pages@2@option@2@ so that the specified files, as
1124 modified by page ranges, are collated rather than concatenated. For 1124 modified by page ranges, are collated rather than concatenated. For
1125 example, if you add the files @1@filename@1@odd.pdf@2@filename@2@ and 1125 example, if you add the files @1@filename@1@odd.pdf@2@filename@2@ and
1126 @1@filename@1@even.pdf@2@filename@2@ containing odd and even pages of a 1126 @1@filename@1@even.pdf@2@filename@2@ containing odd and even pages of a
1127 -document respectively, you could run @1@command@1@qpdf --collate odd.pdf  
1128 ---pages odd.pdf even.pdf -- all.pdf@2@command@2@ to collate the pages. 1127 +document respectively, you could run :command:`qpdf --collate odd.pdf
  1128 +--pages odd.pdf even.pdf -- all.pdf` to collate the pages.
1129 This would pick page 1 from odd, page 1 from even, page 2 from odd, page 1129 This would pick page 1 from odd, page 1 from even, page 2 from odd, page
1130 2 from even, etc. until all pages have been included. Any number of 1130 2 from even, etc. until all pages have been included. Any number of
1131 files and page ranges can be specified. If any file has fewer pages, 1131 files and page ranges can be specified. If any file has fewer pages,
1132 that file is just skipped when its pages have all been included. For 1132 that file is just skipped when its pages have all been included. For
1133 -example, if you ran @1@command@1@qpdf --collate --empty --pages a.pdf  
1134 -1-5 b.pdf 6-4 c.pdf r1 -- out.pdf@2@command@2@, you would get the 1133 +example, if you ran :command:`qpdf --collate --empty --pages a.pdf
  1134 +1-5 b.pdf 6-4 c.pdf r1 -- out.pdf`, you would get the
1135 following pages in this order: 1135 following pages in this order:
1136 1136
1137 - a.pdf page 1 1137 - a.pdf page 1
@@ -1157,8 +1157,8 @@ Starting in qpdf version 10.2, you may specify a numeric argument to @@ -1157,8 +1157,8 @@ Starting in qpdf version 10.2, you may specify a numeric argument to
1157 @1@option@1@--collate=@1@replaceable@1@n@2@replaceable@2@@2@option@2@, 1157 @1@option@1@--collate=@1@replaceable@1@n@2@replaceable@2@@2@option@2@,
1158 pull groups of @1@replaceable@1@n@2@replaceable@2@ pages from each file, 1158 pull groups of @1@replaceable@1@n@2@replaceable@2@ pages from each file,
1159 again, stopping when there are no more pages. For example, if you ran 1159 again, stopping when there are no more pages. For example, if you ran
1160 -@1@command@1@qpdf --collate=2 --empty --pages a.pdf 1-5 b.pdf 6-4 c.pdf  
1161 -r1 -- out.pdf@2@command@2@, you would get the following pages in this 1160 +:command:`qpdf --collate=2 --empty --pages a.pdf 1-5 b.pdf 6-4 c.pdf
  1161 +r1 -- out.pdf`, you would get the following pages in this
1162 order: 1162 order:
1163 1163
1164 - a.pdf page 1 1164 - a.pdf page 1
@@ -1187,7 +1187,7 @@ features. For example, the document&#39;s outlines (bookmarks) point to @@ -1187,7 +1187,7 @@ features. For example, the document&#39;s outlines (bookmarks) point to
1187 actual page objects, so if you select some pages and not others, 1187 actual page objects, so if you select some pages and not others,
1188 bookmarks that point to pages that are in the output file will work, and 1188 bookmarks that point to pages that are in the output file will work, and
1189 remaining bookmarks will not work. A future version of 1189 remaining bookmarks will not work. A future version of
1190 -@1@command@1@qpdf@2@command@2@ may do a better job at handling these 1190 +:command:`qpdf` may do a better job at handling these
1191 issues. (Note that the qpdf library already contains all of the APIs 1191 issues. (Note that the qpdf library already contains all of the APIs
1192 required in order to implement this in your own application if you need 1192 required in order to implement this in your own application if you need
1193 it.) In the mean time, you can always use 1193 it.) In the mean time, you can always use
@@ -1198,7 +1198,7 @@ all metadata associated with that file, you could use @@ -1198,7 +1198,7 @@ all metadata associated with that file, you could use
1198 1198
1199 :: 1199 ::
1200 1200
1201 - @1@command@1@qpdf@2@command@2@ @1@option@1@infile.pdf --pages . 1-5 -- outfile.pdf@2@option@2@ 1201 + :command:`qpdf` @1@option@1@infile.pdf --pages . 1-5 -- outfile.pdf@2@option@2@
1202 1202
1203 If you wanted pages 1 through 5 from 1203 If you wanted pages 1 through 5 from
1204 @1@filename@1@infile.pdf@2@filename@2@ but you wanted the rest of the 1204 @1@filename@1@infile.pdf@2@filename@2@ but you wanted the rest of the
@@ -1206,7 +1206,7 @@ metadata to be dropped, you could instead run @@ -1206,7 +1206,7 @@ metadata to be dropped, you could instead run
1206 1206
1207 :: 1207 ::
1208 1208
1209 - @1@command@1@qpdf@2@command@2@ @1@option@1@--empty --pages infile.pdf 1-5 -- outfile.pdf@2@option@2@ 1209 + :command:`qpdf` @1@option@1@--empty --pages infile.pdf 1-5 -- outfile.pdf@2@option@2@
1210 1210
1211 If you wanted to take pages 1 through 5 from 1211 If you wanted to take pages 1 through 5 from
1212 @1@filename@1@file1.pdf@2@filename@2@ and pages 11 through 15 from 1212 @1@filename@1@file1.pdf@2@filename@2@ and pages 11 through 15 from
@@ -1215,7 +1215,7 @@ metadata from @1@filename@1@file2.pdf@2@filename@2@, you would run @@ -1215,7 +1215,7 @@ metadata from @1@filename@1@file2.pdf@2@filename@2@, you would run
1215 1215
1216 :: 1216 ::
1217 1217
1218 - @1@command@1@qpdf@2@command@2@ @1@option@1@file2.pdf --pages file1.pdf 1-5 . 15-11 -- outfile.pdf@2@option@2@ 1218 + :command:`qpdf` @1@option@1@file2.pdf --pages file1.pdf 1-5 . 15-11 -- outfile.pdf@2@option@2@
1219 1219
1220 If, for some reason, you wanted to take the first page of an encrypted 1220 If, for some reason, you wanted to take the first page of an encrypted
1221 file called @1@filename@1@encrypted.pdf@2@filename@2@ with password 1221 file called @1@filename@1@encrypted.pdf@2@filename@2@ with password
@@ -1224,7 +1224,7 @@ drop document-level metadata but preserve encryption, you would use @@ -1224,7 +1224,7 @@ drop document-level metadata but preserve encryption, you would use
1224 1224
1225 :: 1225 ::
1226 1226
1227 - @1@command@1@qpdf@2@command@2@ @1@option@1@--empty --copy-encryption=encrypted.pdf --encryption-file-password=pass 1227 + :command:`qpdf` @1@option@1@--empty --copy-encryption=encrypted.pdf --encryption-file-password=pass
1228 --pages encrypted.pdf --password=pass 1 ./encrypted.pdf --password=pass 1 -- 1228 --pages encrypted.pdf --password=pass 1 ./encrypted.pdf --password=pass 1 --
1229 outfile.pdf@2@option@2@ 1229 outfile.pdf@2@option@2@
1230 1230
@@ -1244,7 +1244,7 @@ the same page from the same file more than once, qpdf will share objects @@ -1244,7 +1244,7 @@ the same page from the same file more than once, qpdf will share objects
1244 between the pages. If you are going to do further manipulation on the 1244 between the pages. If you are going to do further manipulation on the
1245 file and need the two instances of the same original page to be deep 1245 file and need the two instances of the same original page to be deep
1246 copies, then you can specify the file in two different ways. For example 1246 copies, then you can specify the file in two different ways. For example
1247 -@1@command@1@qpdf in.pdf --pages . 1 ./in.pdf 1 -- out.pdf@2@command@2@ 1247 +:command:`qpdf in.pdf --pages . 1 ./in.pdf 1 -- out.pdf`
1248 would create a file with two copies of the first page of the input, and 1248 would create a file with two copies of the first page of the input, and
1249 the two copies would share any objects in common. This includes fonts, 1249 the two copies would share any objects in common. This includes fonts,
1250 images, and anything else the page references. 1250 images, and anything else the page references.
@@ -1302,15 +1302,15 @@ between the @1@option@1@--overlay@2@option@2@ or @@ -1302,15 +1302,15 @@ between the @1@option@1@--overlay@2@option@2@ or
1302 1302
1303 Here are some examples. 1303 Here are some examples.
1304 1304
1305 -- @1@command@1@--overlay o.pdf --to=1-5 --from=1-3 --repeat=4  
1306 - --@2@command@2@: overlay the first three pages from file 1305 +- :command:`--overlay o.pdf --to=1-5 --from=1-3 --repeat=4
  1306 + --`: overlay the first three pages from file
1307 @1@filename@1@o.pdf@2@filename@2@ onto the first three pages of the 1307 @1@filename@1@o.pdf@2@filename@2@ onto the first three pages of the
1308 output, then overlay page 4 from @1@filename@1@o.pdf@2@filename@2@ 1308 output, then overlay page 4 from @1@filename@1@o.pdf@2@filename@2@
1309 onto pages 4 and 5 of the output. Leave remaining output pages 1309 onto pages 4 and 5 of the output. Leave remaining output pages
1310 untouched. 1310 untouched.
1311 1311
1312 -- @1@command@1@--underlay footer.pdf --from= --repeat=1,2  
1313 - --@2@command@2@: Underlay page 1 of 1312 +- :command:`--underlay footer.pdf --from= --repeat=1,2
  1313 + --`: Underlay page 1 of
1314 @1@filename@1@footer.pdf@2@filename@2@ on all odd output pages, and 1314 @1@filename@1@footer.pdf@2@filename@2@ on all odd output pages, and
1315 underlay page 2 of @1@filename@1@footer.pdf@2@filename@2@ on all even 1315 underlay page 2 of @1@filename@1@footer.pdf@2@filename@2@ on all even
1316 output pages. 1316 output pages.
@@ -1374,7 +1374,7 @@ from the command line. The following options are available: @@ -1374,7 +1374,7 @@ from the command line. The following options are available:
1374 @1@option@1@--replace@2@option@2@ 1374 @1@option@1@--replace@2@option@2@
1375 Indicates that any existing attachment with the same key should be 1375 Indicates that any existing attachment with the same key should be
1376 replaced by the new attachment. Otherwise, 1376 replaced by the new attachment. Otherwise,
1377 - @1@command@1@qpdf@2@command@2@ gives an error if an attachment 1377 + :command:`qpdf` gives an error if an attachment
1378 with that key is already present. 1378 with that key is already present.
1379 1379
1380 @1@option@1@--remove-attachment=@1@replaceable@1@key@2@replaceable@2@@2@option@2@ 1380 @1@option@1@--remove-attachment=@1@replaceable@1@key@2@replaceable@2@@2@option@2@
@@ -1848,7 +1848,7 @@ QDF mode, stream lengths are stored as indirect objects, objects are @@ -1848,7 +1848,7 @@ QDF mode, stream lengths are stored as indirect objects, objects are
1848 laid out in a less efficient but more readable fashion, and the 1848 laid out in a less efficient but more readable fashion, and the
1849 documents are interspersed with comments that make it easier for the 1849 documents are interspersed with comments that make it easier for the
1850 user to find things and also make it possible for 1850 user to find things and also make it possible for
1851 -@1@command@1@fix-qdf@2@command@2@ to work properly. QDF mode is intended 1851 +:command:`fix-qdf` to work properly. QDF mode is intended
1852 for people, mostly developers, who wish to inspect or modify PDF files 1852 for people, mostly developers, who wish to inspect or modify PDF files
1853 in a text editor. For details, please see `QDF Mode <#ref.qdf>`__. 1853 in a text editor. For details, please see `QDF Mode <#ref.qdf>`__.
1854 1854
@@ -2047,7 +2047,7 @@ If a file is being encrypted with 40-bit or 128-bit encryption and the @@ -2047,7 +2047,7 @@ If a file is being encrypted with 40-bit or 128-bit encryption and the
2047 supplied password is not a valid UTF-8 string, qpdf will fall back to 2047 supplied password is not a valid UTF-8 string, qpdf will fall back to
2048 the behavior of interpreting the password as a string of bytes. If you 2048 the behavior of interpreting the password as a string of bytes. If you
2049 have old scripts that encrypt files by passing the output of 2049 have old scripts that encrypt files by passing the output of
2050 -@1@command@1@iconv@2@command@2@ to qpdf, you no longer need to do that, 2050 +:command:`iconv` to qpdf, you no longer need to do that,
2051 but if you do, qpdf should still work. The only exception would be for 2051 but if you do, qpdf should still work. The only exception would be for
2052 the extremely unlikely case of a password that is encoded with a 2052 the extremely unlikely case of a password that is encoded with a
2053 single-byte encoding but also happens to be valid UTF-8. Such a password 2053 single-byte encoding but also happens to be valid UTF-8. Such a password
@@ -2079,7 +2079,7 @@ by attempting to interpret the password as each of a handful of @@ -2079,7 +2079,7 @@ by attempting to interpret the password as each of a handful of
2079 different coding systems and then transcode them to the required format. 2079 different coding systems and then transcode them to the required format.
2080 This helps to compensate for the supplied password being given in the 2080 This helps to compensate for the supplied password being given in the
2081 wrong coding system, such as would happen if you used the 2081 wrong coding system, such as would happen if you used the
2082 -@1@command@1@iconv@2@command@2@ workaround that was previously needed. 2082 +:command:`iconv` workaround that was previously needed.
2083 It also generates passwords by doing the reverse operation: translating 2083 It also generates passwords by doing the reverse operation: translating
2084 from correct in incorrect encoding of the password. This would enable 2084 from correct in incorrect encoding of the password. This would enable
2085 qpdf to decrypt files using passwords that were improperly encoded by 2085 qpdf to decrypt files using passwords that were improperly encoded by
@@ -2133,9 +2133,9 @@ two reasons: most meaningful data in PDF files is compressed, and PDF @@ -2133,9 +2133,9 @@ two reasons: most meaningful data in PDF files is compressed, and PDF
2133 files are full of offset and length information that makes it hard to 2133 files are full of offset and length information that makes it hard to
2134 add or remove data. A QDF file is organized in a manner such that, if 2134 add or remove data. A QDF file is organized in a manner such that, if
2135 edits are kept within certain constraints, the 2135 edits are kept within certain constraints, the
2136 -@1@command@1@fix-qdf@2@command@2@ program, distributed with qpdf, is 2136 +:command:`fix-qdf` program, distributed with qpdf, is
2137 able to restore edited files to a correct state. The 2137 able to restore edited files to a correct state. The
2138 -@1@command@1@fix-qdf@2@command@2@ program takes no command-line 2138 +:command:`fix-qdf` program takes no command-line
2139 arguments. It reads a possibly edited QDF file from standard input and 2139 arguments. It reads a possibly edited QDF file from standard input and
2140 writes a repaired file to standard output. 2140 writes a repaired file to standard output.
2141 2141
@@ -2189,10 +2189,10 @@ nothing generally ever references it by number. @@ -2189,10 +2189,10 @@ nothing generally ever references it by number.
2189 It is not generally practical to remove objects from QDF files without 2189 It is not generally practical to remove objects from QDF files without
2190 messing up object numbering, but if you remove all references to an 2190 messing up object numbering, but if you remove all references to an
2191 object, you can run qpdf on the file (after running 2191 object, you can run qpdf on the file (after running
2192 -@1@command@1@fix-qdf@2@command@2@), and qpdf will omit the now-orphaned 2192 +:command:`fix-qdf`), and qpdf will omit the now-orphaned
2193 object. 2193 object.
2194 2194
2195 -When @1@command@1@fix-qdf@2@command@2@ is run, it goes through the file 2195 +When :command:`fix-qdf` is run, it goes through the file
2196 and recomputes the following parts of the file: 2196 and recomputes the following parts of the file:
2197 2197
2198 - the ``/N``, ``/W``, and ``/First`` keys of all object stream 2198 - the ``/N``, ``/W``, and ``/First`` keys of all object stream
@@ -2271,7 +2271,7 @@ Python @@ -2271,7 +2271,7 @@ Python
2271 rich standard library and available modules. 2271 rich standard library and available modules.
2272 2272
2273 Other Languages 2273 Other Languages
2274 - Starting with version 8.3.0, the @1@command@1@qpdf@2@command@2@ 2274 + Starting with version 8.3.0, the :command:`qpdf`
2275 command-line tool can produce a JSON representation of the PDF file's 2275 command-line tool can produce a JSON representation of the PDF file's
2276 non-content data. This can facilitate interacting programmatically 2276 non-content data. This can facilitate interacting programmatically
2277 with PDF files through qpdf's command line interface. For more 2277 with PDF files through qpdf's command line interface. For more
@@ -2344,7 +2344,7 @@ QPDF JSON @@ -2344,7 +2344,7 @@ QPDF JSON
2344 Overview 2344 Overview
2345 -------- 2345 --------
2346 2346
2347 -Beginning with qpdf version 8.3.0, the @1@command@1@qpdf@2@command@2@ 2347 +Beginning with qpdf version 8.3.0, the :command:`qpdf`
2348 command-line program can produce a JSON representation of the 2348 command-line program can produce a JSON representation of the
2349 non-content data in a PDF file. It includes a dump in JSON format of all 2349 non-content data in a PDF file. It includes a dump in JSON format of all
2350 objects in the PDF file excluding the content of streams. This JSON 2350 objects in the PDF file excluding the content of streams. This JSON
@@ -2386,7 +2386,7 @@ Compatibility @@ -2386,7 +2386,7 @@ Compatibility
2386 strong effort will be made to avoid breaking compatibility. 2386 strong effort will be made to avoid breaking compatibility.
2387 2387
2388 Documentation 2388 Documentation
2389 - The @1@command@1@qpdf@2@command@2@ command can be invoked with the 2389 + The :command:`qpdf` command can be invoked with the
2390 @1@option@1@--json-help@2@option@2@ option. This will output a JSON 2390 @1@option@1@--json-help@2@option@2@ option. This will output a JSON
2391 structure that has the same structure as the JSON output that qpdf 2391 structure that has the same structure as the JSON output that qpdf
2392 generates, except that each field in the help output is a description 2392 generates, except that each field in the help output is a description
@@ -2509,8 +2509,8 @@ be aware of: @@ -2509,8 +2509,8 @@ be aware of:
2509 "``parameters``" that indicates the decode level used for computing 2509 "``parameters``" that indicates the decode level used for computing
2510 whether a stream was filterable. For example, jpeg images will be 2510 whether a stream was filterable. For example, jpeg images will be
2511 shown as not filterable by default, but they will be shown as 2511 shown as not filterable by default, but they will be shown as
2512 - filterable if you run @1@command@1@qpdf --json  
2513 - --decode-level=all@2@command@2@. 2512 + filterable if you run :command:`qpdf --json
  2513 + --decode-level=all`.
2514 2514
2515 .. _ref.design: 2515 .. _ref.design:
2516 2516
@@ -3050,7 +3050,7 @@ Version 3.0 of qpdf introduced the ability to copy objects into a @@ -3050,7 +3050,7 @@ Version 3.0 of qpdf introduced the ability to copy objects into a
3050 @1@firstterm@1@foreign objects@2@firstterm@2@. This allows arbitrary 3050 @1@firstterm@1@foreign objects@2@firstterm@2@. This allows arbitrary
3051 merging of PDF files. The "from" ``QPDF`` object must remain valid after 3051 merging of PDF files. The "from" ``QPDF`` object must remain valid after
3052 the copy as discussed in the note below. The 3052 the copy as discussed in the note below. The
3053 -@1@command@1@qpdf@2@command@2@ command-line tool provides limited 3053 +:command:`qpdf` command-line tool provides limited
3054 support for basic page selection, including merging in pages from other 3054 support for basic page selection, including merging in pages from other
3055 files, but the library's API makes it possible to implement arbitrarily 3055 files, but the library's API makes it possible to implement arbitrarily
3056 complex merging operations. The main method for copying foreign objects 3056 complex merging operations. The main method for copying foreign objects
@@ -3277,9 +3277,9 @@ Basic Strategy for Linearization @@ -3277,9 +3277,9 @@ Basic Strategy for Linearization
3277 3277
3278 To avoid the incestuous problem of having the qpdf library validate its 3278 To avoid the incestuous problem of having the qpdf library validate its
3279 own linearized files, we have a special linearized file checking mode 3279 own linearized files, we have a special linearized file checking mode
3280 -which can be invoked via @1@command@1@qpdf  
3281 ---check-linearization@2@command@2@ (or @1@command@1@qpdf  
3282 ---check@2@command@2@). This mode reads the linearization parameter 3280 +which can be invoked via :command:`qpdf
  3281 +--check-linearization` (or :command:`qpdf
  3282 +--check`). This mode reads the linearization parameter
3283 dictionary and the hint streams and validates that object ordering, 3283 dictionary and the hint streams and validates that object ordering,
3284 parameters, and hint stream contents are correct. The validation code 3284 parameters, and hint stream contents are correct. The validation code
3285 was first tested against linearized files created by external tools 3285 was first tested against linearized files created by external tools
@@ -3441,11 +3441,11 @@ linearization appendix of the PDF specification. @@ -3441,11 +3441,11 @@ linearization appendix of the PDF specification.
3441 Debugging Note 3441 Debugging Note
3442 -------------- 3442 --------------
3443 3443
3444 -The @1@command@1@qpdf --show-linearization@2@command@2@ command can show 3444 +The :command:`qpdf --show-linearization` command can show
3445 the complete contents of linearization hint streams. To look at the raw 3445 the complete contents of linearization hint streams. To look at the raw
3446 data, you can extract the filtered contents of the linearization hint 3446 data, you can extract the filtered contents of the linearization hint
3447 -tables using @1@command@1@qpdf --show-object=n  
3448 ---filtered-stream-data@2@command@2@. Then, to convert this into a bit 3447 +tables using :command:`qpdf --show-object=n
  3448 +--filtered-stream-data`. Then, to convert this into a bit
3449 stream (since linearization tables are bit streams written without 3449 stream (since linearization tables are bit streams written without
3450 regard to byte boundaries), you can pipe the resulting data through the 3450 regard to byte boundaries), you can pipe the resulting data through the
3451 following perl code: 3451 following perl code:
@@ -3818,7 +3818,7 @@ For a detailed list of changes, please see the file @@ -3818,7 +3818,7 @@ For a detailed list of changes, please see the file
3818 the original input file, unused form fields are removed, which 3818 the original input file, unused form fields are removed, which
3819 prevents lots of unused annotations from being retained. 3819 prevents lots of unused annotations from being retained.
3820 3820
3821 - - By default, @1@command@1@qpdf@2@command@2@ no longer allows 3821 + - By default, :command:`qpdf` no longer allows
3822 creation of encrypted PDF files whose user password is 3822 creation of encrypted PDF files whose user password is
3823 non-empty and owner password is empty when a 256-bit key is in 3823 non-empty and owner password is empty when a 256-bit key is in
3824 use. The @1@option@1@--allow-insecure@2@option@2@ option, 3824 use. The @1@option@1@--allow-insecure@2@option@2@ option,
@@ -4082,7 +4082,7 @@ For a detailed list of changes, please see the file @@ -4082,7 +4082,7 @@ For a detailed list of changes, please see the file
4082 performance while allowing indirect objects to appear in 4082 performance while allowing indirect objects to appear in
4083 ``/DecodeParms``. 4083 ``/DecodeParms``.
4084 4084
4085 - - When extracting pages, the @1@command@1@qpdf@2@command@2@ CLI 4085 + - When extracting pages, the :command:`qpdf` CLI
4086 only removes unreferenced resources from the pages that are 4086 only removes unreferenced resources from the pages that are
4087 being kept, resulting in a significant performance improvement 4087 being kept, resulting in a significant performance improvement
4088 when extracting small numbers of pages from large, complex 4088 when extracting small numbers of pages from large, complex
@@ -4164,7 +4164,7 @@ For a detailed list of changes, please see the file @@ -4164,7 +4164,7 @@ For a detailed list of changes, please see the file
4164 - Build Changes 4164 - Build Changes
4165 4165
4166 - The option @1@option@1@--disable-rpath@2@option@2@ is now 4166 - The option @1@option@1@--disable-rpath@2@option@2@ is now
4167 - supported by qpdf's @1@command@1@./configure@2@command@2@ 4167 + supported by qpdf's :command:`./configure`
4168 script. Some distributions' packaging standards recommended the 4168 script. Some distributions' packaging standards recommended the
4169 use of this option. 4169 use of this option.
4170 4170
@@ -4262,7 +4262,7 @@ For a detailed list of changes, please see the file @@ -4262,7 +4262,7 @@ For a detailed list of changes, please see the file
4262 and, if so, what its length and filters are. Without this, it 4262 and, if so, what its length and filters are. Without this, it
4263 was not possible to tell conclusively from the JSON output 4263 was not possible to tell conclusively from the JSON output
4264 alone whether or not an object was a stream. Run 4264 alone whether or not an object was a stream. Run
4265 - @1@command@1@qpdf --json-help@2@command@2@ for details. 4265 + :command:`qpdf --json-help` for details.
4266 4266
4267 - Add new option 4267 - Add new option
4268 @1@option@1@--remove-unreferenced-resources@2@option@2@ which 4268 @1@option@1@--remove-unreferenced-resources@2@option@2@ which
@@ -4281,12 +4281,12 @@ For a detailed list of changes, please see the file @@ -4281,12 +4281,12 @@ For a detailed list of changes, please see the file
4281 @1@option@1@--remove-unreferenced-resources=no@2@option@2@. 4281 @1@option@1@--remove-unreferenced-resources=no@2@option@2@.
4282 4282
4283 - If the ``QPDF_EXECUTABLE`` environment variable is set when 4283 - If the ``QPDF_EXECUTABLE`` environment variable is set when
4284 - invoking @1@command@1@qpdf --bash-completion@2@command@2@ or  
4285 - @1@command@1@qpdf --zsh-completion@2@command@2@, the completion 4284 + invoking :command:`qpdf --bash-completion` or
  4285 + :command:`qpdf --zsh-completion`, the completion
4286 command that it outputs will refer to qpdf using the value of 4286 command that it outputs will refer to qpdf using the value of
4287 - that variable rather than what @1@command@1@qpdf@2@command@2@ 4287 + that variable rather than what :command:`qpdf`
4288 determines its executable path to be. This can be useful when 4288 determines its executable path to be. This can be useful when
4289 - wrapping @1@command@1@qpdf@2@command@2@ with a script, working 4289 + wrapping :command:`qpdf` with a script, working
4290 with a version in the source tree, using an AppImage, or other 4290 with a version in the source tree, using an AppImage, or other
4291 situations where there is some indirection. 4291 situations where there is some indirection.
4292 4292
@@ -4381,15 +4381,15 @@ For a detailed list of changes, please see the file @@ -4381,15 +4381,15 @@ For a detailed list of changes, please see the file
4381 the reconstructed user password for older encryption formats, 4381 the reconstructed user password for older encryption formats,
4382 this provides the same information as 4382 this provides the same information as
4383 @1@option@1@--show-encryption@2@option@2@ but in a consistent, 4383 @1@option@1@--show-encryption@2@option@2@ but in a consistent,
4384 - parseable format. See output of @1@command@1@qpdf  
4385 - --json-help@2@command@2@ for details. 4384 + parseable format. See output of :command:`qpdf
  4385 + --json-help` for details.
4386 4386
4387 - Bug Fixes 4387 - Bug Fixes
4388 4388
4389 - In QDF mode, be sure not to write more than one XRef stream to 4389 - In QDF mode, be sure not to write more than one XRef stream to
4390 a file, even when 4390 a file, even when
4391 @1@option@1@--preserve-unreferenced@2@option@2@ is used. 4391 @1@option@1@--preserve-unreferenced@2@option@2@ is used.
4392 - @1@command@1@fix-qdf@2@command@2@ assumes that there is only 4392 + :command:`fix-qdf` assumes that there is only
4393 one XRef stream, and that it appears at the end of the file. 4393 one XRef stream, and that it appears at the end of the file.
4394 4394
4395 - When externalizing inline images, properly handle images whose 4395 - When externalizing inline images, properly handle images whose
@@ -4446,7 +4446,7 @@ For a detailed list of changes, please see the file @@ -4446,7 +4446,7 @@ For a detailed list of changes, please see the file
4446 specified in the range. 4446 specified in the range.
4447 4447
4448 - Fix shell wildcard expansion behavior (``*`` and ``?``) of the 4448 - Fix shell wildcard expansion behavior (``*`` and ``?``) of the
4449 - @1@command@1@qpdf.exe@2@command@2@ as built my MSVC. 4449 + :command:`qpdf.exe` as built my MSVC.
4450 4450
4451 9.0.2: October 12, 2019 4451 9.0.2: October 12, 2019
4452 - Bug Fix 4452 - Bug Fix
@@ -4512,7 +4512,7 @@ For a detailed list of changes, please see the file @@ -4512,7 +4512,7 @@ For a detailed list of changes, please see the file
4512 Options <#ref.basic-options>`__ for more details. 4512 Options <#ref.basic-options>`__ for more details.
4513 4513
4514 - The @1@option@1@--recompress-flate@2@option@2@ instructs 4514 - The @1@option@1@--recompress-flate@2@option@2@ instructs
4515 - @1@command@1@qpdf@2@command@2@ to recompress streams that are 4515 + :command:`qpdf` to recompress streams that are
4516 already compressed with ``/FlateDecode``. Useful with 4516 already compressed with ``/FlateDecode``. Useful with
4517 @1@option@1@--compression-level@2@option@2@. 4517 @1@option@1@--compression-level@2@option@2@.
4518 4518
@@ -4570,8 +4570,8 @@ For a detailed list of changes, please see the file @@ -4570,8 +4570,8 @@ For a detailed list of changes, please see the file
4570 ``QPDF::ownerPasswordMatched`` have been added to enable a 4570 ``QPDF::ownerPasswordMatched`` have been added to enable a
4571 caller to determine whether the supplied password was the user 4571 caller to determine whether the supplied password was the user
4572 password, the owner password, or both. This information is also 4572 password, the owner password, or both. This information is also
4573 - displayed by @1@command@1@qpdf --show-encryption@2@command@2@  
4574 - and @1@command@1@qpdf --check@2@command@2@. 4573 + displayed by :command:`qpdf --show-encryption`
  4574 + and :command:`qpdf --check`.
4575 4575
4576 - Static method ``Pl_Flate::setCompressionLevel`` can be called 4576 - Static method ``Pl_Flate::setCompressionLevel`` can be called
4577 to set the zlib compression level globally used by all 4577 to set the zlib compression level globally used by all
@@ -4609,8 +4609,8 @@ For a detailed list of changes, please see the file @@ -4609,8 +4609,8 @@ For a detailed list of changes, please see the file
4609 files have been fixed. Most of these problems were found by 4609 files have been fixed. Most of these problems were found by
4610 Google's OSS-Fuzz project. 4610 Google's OSS-Fuzz project.
4611 4611
4612 - - When @1@command@1@qpdf --check@2@command@2@ or  
4613 - @1@command@1@qpdf --check-linearization@2@command@2@ encounters 4612 + - When :command:`qpdf --check` or
  4613 + :command:`qpdf --check-linearization` encounters
4614 a file with linearization warnings but not errors, it now 4614 a file with linearization warnings but not errors, it now
4615 properly exits with exit code 3 instead of 2. 4615 properly exits with exit code 3 instead of 2.
4616 4616
@@ -4648,12 +4648,12 @@ For a detailed list of changes, please see the file @@ -4648,12 +4648,12 @@ For a detailed list of changes, please see the file
4648 conversion warnings enabled. Numerous changes were made to the 4648 conversion warnings enabled. Numerous changes were made to the
4649 library to make this safe. 4649 library to make this safe.
4650 4650
4651 - - QPDF's @1@command@1@make install@2@command@2@ target explicitly 4651 + - QPDF's :command:`make install` target explicitly
4652 specifies the mode to use when installing files instead of 4652 specifies the mode to use when installing files instead of
4653 relying the user's umask. It was previously doing this for some 4653 relying the user's umask. It was previously doing this for some
4654 files but not others. 4654 files but not others.
4655 4655
4656 - - If @1@command@1@pkg-config@2@command@2@ is available, use it to 4656 + - If :command:`pkg-config` is available, use it to
4657 locate @1@filename@1@libjpeg@2@filename@2@ and 4657 locate @1@filename@1@libjpeg@2@filename@2@ and
4658 @1@filename@1@zlib@2@filename@2@ dependencies, falling back on 4658 @1@filename@1@zlib@2@filename@2@ dependencies, falling back on
4659 old behavior if unsuccessful. 4659 old behavior if unsuccessful.
@@ -4674,15 +4674,15 @@ For a detailed list of changes, please see the file @@ -4674,15 +4674,15 @@ For a detailed list of changes, please see the file
4674 8.4.1: April 27, 2019 4674 8.4.1: April 27, 2019
4675 - Enhancements 4675 - Enhancements
4676 4676
4677 - - When @1@command@1@qpdf --version@2@command@2@ is run, it will 4677 + - When :command:`qpdf --version` is run, it will
4678 detect if the qpdf CLI was built with a different version of 4678 detect if the qpdf CLI was built with a different version of
4679 qpdf than the library, which may indicate a problem with the 4679 qpdf than the library, which may indicate a problem with the
4680 installation. 4680 installation.
4681 4681
4682 - New option @1@option@1@--remove-page-labels@2@option@2@ will 4682 - New option @1@option@1@--remove-page-labels@2@option@2@ will
4683 remove page labels before generating output. This used to 4683 remove page labels before generating output. This used to
4684 - happen if you ran @1@command@1@qpdf --empty --pages ..  
4685 - --@2@command@2@, but the behavior changed in qpdf 8.3.0. This 4684 + happen if you ran :command:`qpdf --empty --pages ..
  4685 + --`, but the behavior changed in qpdf 8.3.0. This
4686 option enables people who were relying on the old behavior to 4686 option enables people who were relying on the old behavior to
4687 get it again. 4687 get it again.
4688 4688
@@ -4795,7 +4795,7 @@ For a detailed list of changes, please see the file @@ -4795,7 +4795,7 @@ For a detailed list of changes, please see the file
4795 4795
4796 - In the @1@option@1@--pages@2@option@2@ option, allow use of "." 4796 - In the @1@option@1@--pages@2@option@2@ option, allow use of "."
4797 as a shortcut for the primary input file. That way, you can do 4797 as a shortcut for the primary input file. That way, you can do
4798 - @1@command@1@qpdf in.pdf --pages . 1-2 -- out.pdf@2@command@2@ 4798 + :command:`qpdf in.pdf --pages . 1-2 -- out.pdf`
4799 instead of having to repeat @1@filename@1@in.pdf@2@filename@2@ 4799 instead of having to repeat @1@filename@1@in.pdf@2@filename@2@
4800 in the command. 4800 in the command.
4801 4801
@@ -4868,7 +4868,7 @@ For a detailed list of changes, please see the file @@ -4868,7 +4868,7 @@ For a detailed list of changes, please see the file
4868 resulting object is an indirect object ready to be passed to 4868 resulting object is an indirect object ready to be passed to
4869 ``QPDFPageDocumentHelper::addPage()`` for either the original 4869 ``QPDFPageDocumentHelper::addPage()`` for either the original
4870 ``QPDF`` object or a different one. This is what the 4870 ``QPDF`` object or a different one. This is what the
4871 - @1@command@1@qpdf@2@command@2@ command-line tool uses to copy 4871 + :command:`qpdf` command-line tool uses to copy
4872 the same page multiple times from the same file during 4872 the same page multiple times from the same file during
4873 splitting and merging operations. 4873 splitting and merging operations.
4874 4874
@@ -4931,15 +4931,15 @@ For a detailed list of changes, please see the file @@ -4931,15 +4931,15 @@ For a detailed list of changes, please see the file
4931 ``WINDOWS_WMAIN`` to be defined. If you do your own builds with 4931 ``WINDOWS_WMAIN`` to be defined. If you do your own builds with
4932 other compilers, you can define this symbol to cause ``wmain`` 4932 other compilers, you can define this symbol to cause ``wmain``
4933 to be used. This is needed to allow the Windows 4933 to be used. This is needed to allow the Windows
4934 - @1@command@1@qpdf@2@command@2@ command to receive Unicode 4934 + :command:`qpdf` command to receive Unicode
4935 command-line options. 4935 command-line options.
4936 4936
4937 8.3.0: January 7, 2019 4937 8.3.0: January 7, 2019
4938 - Command-line Enhancements 4938 - Command-line Enhancements
4939 4939
4940 - - Shell completion: you can now use eval @1@command@1@$(qpdf  
4941 - --completion-bash)@2@command@2@ and eval @1@command@1@$(qpdf  
4942 - --completion-zsh)@2@command@2@ to enable shell completion for 4940 + - Shell completion: you can now use eval :command:`$(qpdf
  4941 + --completion-bash)` and eval :command:`$(qpdf
  4942 + --completion-zsh)` to enable shell completion for
4943 bash and zsh. 4943 bash and zsh.
4944 4944
4945 - Page numbers (also known as page labels) are now preserved when 4945 - Page numbers (also known as page labels) are now preserved when
@@ -4968,8 +4968,8 @@ For a detailed list of changes, please see the file @@ -4968,8 +4968,8 @@ For a detailed list of changes, please see the file
4968 options @1@option@1@--json@2@option@2@, 4968 options @1@option@1@--json@2@option@2@,
4969 @1@option@1@--json-key@2@option@2@, and 4969 @1@option@1@--json-key@2@option@2@, and
4970 @1@option@1@--json-object@2@option@2@ to generate a JSON 4970 @1@option@1@--json-object@2@option@2@ to generate a JSON
4971 - representation of the PDF file. Run @1@command@1@qpdf  
4972 - --json-help@2@command@2@ to get a description of the JSON 4971 + representation of the PDF file. Run :command:`qpdf
  4972 + --json-help` to get a description of the JSON
4973 format. For more information, see `QPDF JSON <#ref.json>`__. 4973 format. For more information, see `QPDF JSON <#ref.json>`__.
4974 4974
4975 - The @1@option@1@--generate-appearances@2@option@2@ flag will 4975 - The @1@option@1@--generate-appearances@2@option@2@ flag will
@@ -5109,11 +5109,11 @@ For a detailed list of changes, please see the file @@ -5109,11 +5109,11 @@ For a detailed list of changes, please see the file
5109 - Build Improvements 5109 - Build Improvements
5110 5110
5111 - It is no longer necessary to run 5111 - It is no longer necessary to run
5112 - @1@command@1@autogen.sh@2@command@2@ to build from a pristine 5112 + :command:`autogen.sh` to build from a pristine
5113 checkout. Automatically generated files are now committed so 5113 checkout. Automatically generated files are now committed so
5114 that it is possible to build on platforms without autoconf 5114 that it is possible to build on platforms without autoconf
5115 directly from a clean checkout of the repository. The 5115 directly from a clean checkout of the repository. The
5116 - @1@command@1@configure@2@command@2@ script detects if the files 5116 + :command:`configure` script detects if the files
5117 are out of date when it also determines that the tools are 5117 are out of date when it also determines that the tools are
5118 present to regenerate them. 5118 present to regenerate them.
5119 5119
@@ -5136,7 +5136,7 @@ For a detailed list of changes, please see the file @@ -5136,7 +5136,7 @@ For a detailed list of changes, please see the file
5136 autoconf files, it could cause this check to fail. To avoid 5136 autoconf files, it could cause this check to fail. To avoid
5137 this problem, pass 5137 this problem, pass
5138 @1@option@1@--disable-check-autofiles@2@option@2@ to 5138 @1@option@1@--disable-check-autofiles@2@option@2@ to
5139 - @1@command@1@configure@2@command@2@. 5139 + :command:`configure`.
5140 5140
5141 - If you would like to have qpdf completion enabled 5141 - If you would like to have qpdf completion enabled
5142 automatically, you can install completion files in the 5142 automatically, you can install completion files in the
@@ -5293,7 +5293,7 @@ For a detailed list of changes, please see the file @@ -5293,7 +5293,7 @@ For a detailed list of changes, please see the file
5293 called by ``QPDFWriter`` to update your idea of the percentage 5293 called by ``QPDFWriter`` to update your idea of the percentage
5294 it thinks it is through writing its output. Client programs can 5294 it thinks it is through writing its output. Client programs can
5295 use this to implement reasonably accurate progress meters. The 5295 use this to implement reasonably accurate progress meters. The
5296 - @1@command@1@qpdf@2@command@2@ command line tool uses this to 5296 + :command:`qpdf` command line tool uses this to
5297 implement its @1@option@1@--progress@2@option@2@ option. 5297 implement its @1@option@1@--progress@2@option@2@ option.
5298 5298
5299 - New methods ``QPDFObjectHandle::newUnicodeString`` and 5299 - New methods ``QPDFObjectHandle::newUnicodeString`` and
@@ -5347,7 +5347,7 @@ For a detailed list of changes, please see the file @@ -5347,7 +5347,7 @@ For a detailed list of changes, please see the file
5347 type". This situation should be mostly or entirely eliminated 5347 type". This situation should be mostly or entirely eliminated
5348 now. 5348 now.
5349 5349
5350 - - Enhancements to the @1@command@1@qpdf@2@command@2@ Command-line 5350 + - Enhancements to the :command:`qpdf` Command-line
5351 Tool. All new options listed here are documented in more detail in 5351 Tool. All new options listed here are documented in more detail in
5352 `Running QPDF <#ref.using>`__. 5352 `Running QPDF <#ref.using>`__.
5353 5353
@@ -5364,8 +5364,8 @@ For a detailed list of changes, please see the file @@ -5364,8 +5364,8 @@ For a detailed list of changes, please see the file
5364 changes to the API. 5364 changes to the API.
5365 5365
5366 - Add function ``qpdf_check_pdf`` to the C API. This function 5366 - Add function ``qpdf_check_pdf`` to the C API. This function
5367 - does basic checking that is a subset of what @1@command@1@qpdf  
5368 - --check@2@command@2@ performs. 5367 + does basic checking that is a subset of what :command:`qpdf
  5368 + --check` performs.
5369 5369
5370 - Major enhancements to the lexical layer of qpdf. For a complete 5370 - Major enhancements to the lexical layer of qpdf. For a complete
5371 list of enhancements, please refer to the 5371 list of enhancements, please refer to the
@@ -5461,7 +5461,7 @@ For a detailed list of changes, please see the file @@ -5461,7 +5461,7 @@ For a detailed list of changes, please see the file
5461 specialized and is only useful to applications that already 5461 specialized and is only useful to applications that already
5462 know how to create PCLm files. 5462 know how to create PCLm files.
5463 5463
5464 - - Enhancements to the @1@command@1@qpdf@2@command@2@ Command-line 5464 + - Enhancements to the :command:`qpdf` Command-line
5465 Tool. All new options listed here are documented in more detail in 5465 Tool. All new options listed here are documented in more detail in
5466 `Running QPDF <#ref.using>`__. 5466 `Running QPDF <#ref.using>`__.
5467 5467
@@ -5492,14 +5492,14 @@ For a detailed list of changes, please see the file @@ -5492,14 +5492,14 @@ For a detailed list of changes, please see the file
5492 The @1@option@1@--stream-data@2@option@2@ option will remain 5492 The @1@option@1@--stream-data@2@option@2@ option will remain
5493 available. 5493 available.
5494 5494
5495 - - When running @1@command@1@qpdf --check@2@command@2@ with other 5495 + - When running :command:`qpdf --check` with other
5496 options, checks are always run first. This enables qpdf to 5496 options, checks are always run first. This enables qpdf to
5497 perform its full recovery logic before outputting other 5497 perform its full recovery logic before outputting other
5498 information. This can be especially useful when manually 5498 information. This can be especially useful when manually
5499 recovering broken files, looking at qpdf's regenerated cross 5499 recovering broken files, looking at qpdf's regenerated cross
5500 reference table, or other similar operations. 5500 reference table, or other similar operations.
5501 5501
5502 - - Process @1@command@1@--pages@2@command@2@ earlier so that other 5502 + - Process :command:`--pages` earlier so that other
5503 options like @1@option@1@--show-pages@2@option@2@ or 5503 options like @1@option@1@--show-pages@2@option@2@ or
5504 @1@option@1@--split-pages@2@option@2@ can operate on the file 5504 @1@option@1@--split-pages@2@option@2@ can operate on the file
5505 after page splitting/merging has occurred. 5505 after page splitting/merging has occurred.
@@ -5573,10 +5573,10 @@ For a detailed list of changes, please see the file @@ -5573,10 +5573,10 @@ For a detailed list of changes, please see the file
5573 - Bug fix: qpdf would fail to write files that had streams with 5573 - Bug fix: qpdf would fail to write files that had streams with
5574 decode parameters referencing other streams. 5574 decode parameters referencing other streams.
5575 5575
5576 - - New example program: @1@command@1@pdf-split-pages@2@command@2@: 5576 + - New example program: :command:`pdf-split-pages`:
5577 efficiently split PDF files into individual pages. The example 5577 efficiently split PDF files into individual pages. The example
5578 - program does this more efficiently than using @1@command@1@qpdf  
5579 - --pages@2@command@2@ to do it. 5578 + program does this more efficiently than using :command:`qpdf
  5579 + --pages` to do it.
5580 5580
5581 - Packaging fix: Visual C++ binaries did not support Windows XP. 5581 - Packaging fix: Visual C++ binaries did not support Windows XP.
5582 This has been rectified by updating the compilers used to generate 5582 This has been rectified by updating the compilers used to generate
@@ -5619,9 +5619,9 @@ For a detailed list of changes, please see the file @@ -5619,9 +5619,9 @@ For a detailed list of changes, please see the file
5619 cryptography API. To disable the OS-specific cryptography and use 5619 cryptography API. To disable the OS-specific cryptography and use
5620 the old version, pass the 5620 the old version, pass the
5621 @1@option@1@--enable-insecure-random@2@option@2@ option to 5621 @1@option@1@--enable-insecure-random@2@option@2@ option to
5622 - @1@command@1@./configure@2@command@2@. 5622 + :command:`./configure`.
5623 5623
5624 - - The @1@command@1@qpdf@2@command@2@ command-line tool now issues a 5624 + - The :command:`qpdf` command-line tool now issues a
5625 warning when @1@option@1@-accessibility=n@2@option@2@ is specified 5625 warning when @1@option@1@-accessibility=n@2@option@2@ is specified
5626 for newer encryption versions stating that the option is ignored. 5626 for newer encryption versions stating that the option is ignored.
5627 qpdf, per the spec, has always ignored this flag, but it 5627 qpdf, per the spec, has always ignored this flag, but it
@@ -5648,12 +5648,12 @@ For a detailed list of changes, please see the file @@ -5648,12 +5648,12 @@ For a detailed list of changes, please see the file
5648 notes. 5648 notes.
5649 5649
5650 - Add @1@option@1@--show-npages@2@option@2@ command-line option to 5650 - Add @1@option@1@--show-npages@2@option@2@ command-line option to
5651 - the @1@command@1@qpdf@2@command@2@ command to show the number of 5651 + the :command:`qpdf` command to show the number of
5652 pages in a file. 5652 pages in a file.
5653 5653
5654 - Allow omission of the page range within 5654 - Allow omission of the page range within
5655 @1@option@1@--pages@2@option@2@ for the 5655 @1@option@1@--pages@2@option@2@ for the
5656 - @1@command@1@qpdf@2@command@2@ command. When omitted, the page 5656 + :command:`qpdf` command. When omitted, the page
5657 range is implicitly taken to be all the pages in the file. 5657 range is implicitly taken to be all the pages in the file.
5658 5658
5659 - Various enhancements were made to support different types of 5659 - Various enhancements were made to support different types of
@@ -5663,7 +5663,7 @@ For a detailed list of changes, please see the file @@ -5663,7 +5663,7 @@ For a detailed list of changes, please see the file
5663 4.1.0: April 14, 2013 5663 4.1.0: April 14, 2013
5664 - Note to people including qpdf in distributions: the 5664 - Note to people including qpdf in distributions: the
5665 @1@filename@1@.la@2@filename@2@ files generated by libtool are now 5665 @1@filename@1@.la@2@filename@2@ files generated by libtool are now
5666 - installed by qpdf's @1@command@1@make install@2@command@2@ target. 5666 + installed by qpdf's :command:`make install` target.
5667 Before, they were not installed. This means that if your 5667 Before, they were not installed. This means that if your
5668 distribution does not want to include 5668 distribution does not want to include
5669 @1@filename@1@.la@2@filename@2@ files, you must remove them as 5669 @1@filename@1@.la@2@filename@2@ files, you must remove them as
@@ -5689,7 +5689,7 @@ For a detailed list of changes, please see the file @@ -5689,7 +5689,7 @@ For a detailed list of changes, please see the file
5689 ``QPDFObjectHandle`` object. These methods can be used for more 5689 ``QPDFObjectHandle`` object. These methods can be used for more
5690 efficient parsing and debugging/diagnostic messages. 5690 efficient parsing and debugging/diagnostic messages.
5691 5691
5692 - - @1@command@1@qpdf --check@2@command@2@ now parses all pages' 5692 + - :command:`qpdf --check` now parses all pages'
5693 content streams in addition to doing other checks. While there are 5693 content streams in addition to doing other checks. While there are
5694 still many types of errors that cannot be detected, syntactic 5694 still many types of errors that cannot be detected, syntactic
5695 errors in content streams will now be reported. 5695 errors in content streams will now be reported.
@@ -5735,7 +5735,7 @@ For a detailed list of changes, please see the file @@ -5735,7 +5735,7 @@ For a detailed list of changes, please see the file
5735 was loss of filled in form values for certain files. 5735 was loss of filled in form values for certain files.
5736 5736
5737 - Installation no longer uses GNU/Linux-specific versions of some 5737 - Installation no longer uses GNU/Linux-specific versions of some
5738 - commands, so @1@command@1@make install@2@command@2@ works on 5738 + commands, so :command:`make install` works on
5739 Solaris with native tools. 5739 Solaris with native tools.
5740 5740
5741 - The 64-bit mingw Windows binary package no longer includes a 5741 - The 64-bit mingw Windows binary package no longer includes a
@@ -5838,7 +5838,7 @@ For a detailed list of changes, please see the file @@ -5838,7 +5838,7 @@ For a detailed list of changes, please see the file
5838 5838
5839 - Removed the method ``decodeStreams``. This method was used by 5839 - Removed the method ``decodeStreams``. This method was used by
5840 the @1@option@1@--check@2@option@2@ option of the 5840 the @1@option@1@--check@2@option@2@ option of the
5841 - @1@command@1@qpdf@2@command@2@ command-line tool to force all 5841 + :command:`qpdf` command-line tool to force all
5842 streams in the file to be decoded, but it also suffered from 5842 streams in the file to be decoded, but it also suffered from
5843 the problem of opening otherwise unreferenced streams and thus 5843 the problem of opening otherwise unreferenced streams and thus
5844 could report false positive. The 5844 could report false positive. The
@@ -5859,9 +5859,9 @@ For a detailed list of changes, please see the file @@ -5859,9 +5859,9 @@ For a detailed list of changes, please see the file
5859 - Allow the PDF header to appear anywhere in the first 1024 bytes of 5859 - Allow the PDF header to appear anywhere in the first 1024 bytes of
5860 the file. This is consistent with what other readers do. 5860 the file. This is consistent with what other readers do.
5861 5861
5862 - - Fix the @1@command@1@pkg-config@2@command@2@ files to list zlib 5862 + - Fix the :command:`pkg-config` files to list zlib
5863 and pcre in ``Requires.private`` to better support static linking 5863 and pcre in ``Requires.private`` to better support static linking
5864 - using @1@command@1@pkg-config@2@command@2@. 5864 + using :command:`pkg-config`.
5865 5865
5866 3.0.2: September 6, 2012 5866 3.0.2: September 6, 2012
5867 - Bug fix: ``QPDFWriter::setOutputMemory`` did not work when not 5867 - Bug fix: ``QPDFWriter::setOutputMemory`` did not work when not
@@ -5875,7 +5875,7 @@ For a detailed list of changes, please see the file @@ -5875,7 +5875,7 @@ For a detailed list of changes, please see the file
5875 5875
5876 3.0.1: August 11, 2012 5876 3.0.1: August 11, 2012
5877 - Version 3.0.0 included addition of files for 5877 - Version 3.0.0 included addition of files for
5878 - @1@command@1@pkg-config@2@command@2@, but this was not mentioned 5878 + :command:`pkg-config`, but this was not mentioned
5879 in the release notes. The release notes for 3.0.0 were updated to 5879 in the release notes. The release notes for 3.0.0 were updated to
5880 mention this. 5880 mention this.
5881 5881
@@ -5909,10 +5909,10 @@ For a detailed list of changes, please see the file @@ -5909,10 +5909,10 @@ For a detailed list of changes, please see the file
5909 as the compiler and underlying platforms support it. 5909 as the compiler and underlying platforms support it.
5910 5910
5911 - Support for page selection (splitting and merging PDF files) has 5911 - Support for page selection (splitting and merging PDF files) has
5912 - been added to the @1@command@1@qpdf@2@command@2@ command-line 5912 + been added to the :command:`qpdf` command-line
5913 tool. See `Page Selection Options <#ref.page-selection>`__. 5913 tool. See `Page Selection Options <#ref.page-selection>`__.
5914 5914
5915 - - Options have been added to the @1@command@1@qpdf@2@command@2@ 5915 + - Options have been added to the :command:`qpdf`
5916 command-line tool for copying encryption parameters from another 5916 command-line tool for copying encryption parameters from another
5917 file. See `Basic Options <#ref.basic-options>`__. 5917 file. See `Basic Options <#ref.basic-options>`__.
5918 5918
@@ -5952,10 +5952,10 @@ For a detailed list of changes, please see the file @@ -5952,10 +5952,10 @@ For a detailed list of changes, please see the file
5952 (such as Linux), symbol versions are enabled by default. They can 5952 (such as Linux), symbol versions are enabled by default. They can
5953 be disabled by passing 5953 be disabled by passing
5954 @1@option@1@--disable-ld-version-script@2@option@2@ to 5954 @1@option@1@--disable-ld-version-script@2@option@2@ to
5955 - @1@command@1@./configure@2@command@2@. 5955 + :command:`./configure`.
5956 5956
5957 - The file @1@filename@1@libqpdf.pc@2@filename@2@ is now installed 5957 - The file @1@filename@1@libqpdf.pc@2@filename@2@ is now installed
5958 - to support @1@command@1@pkg-config@2@command@2@. 5958 + to support :command:`pkg-config`.
5959 5959
5960 - Image comparison tests are off by default now since they are not 5960 - Image comparison tests are off by default now since they are not
5961 needed to verify a correct build or port of qpdf. They are needed 5961 needed to verify a correct build or port of qpdf. They are needed
@@ -5964,7 +5964,7 @@ For a detailed list of changes, please see the file @@ -5964,7 +5964,7 @@ For a detailed list of changes, please see the file
5964 See @1@filename@1@README.md@2@filename@2@ for details. 5964 See @1@filename@1@README.md@2@filename@2@ for details.
5965 5965
5966 - Large file tests are off by default but can be turned on with 5966 - Large file tests are off by default but can be turned on with
5967 - @1@command@1@./configure@2@command@2@ or by setting an environment 5967 + :command:`./configure` or by setting an environment
5968 variable before running the test suite. See 5968 variable before running the test suite. See
5969 @1@filename@1@README.md@2@filename@2@ for details. 5969 @1@filename@1@README.md@2@filename@2@ for details.
5970 5970
@@ -5973,7 +5973,7 @@ For a detailed list of changes, please see the file @@ -5973,7 +5973,7 @@ For a detailed list of changes, please see the file
5973 @1@filename@1@build/qtest.log@2@filename@2@. For packagers who are 5973 @1@filename@1@build/qtest.log@2@filename@2@. For packagers who are
5974 building with an autobuilder, you can add the 5974 building with an autobuilder, you can add the
5975 @1@option@1@--enable-show-failed-test-output@2@option@2@ option to 5975 @1@option@1@--enable-show-failed-test-output@2@option@2@ option to
5976 - @1@command@1@./configure@2@command@2@ to restore the old behavior. 5976 + :command:`./configure` to restore the old behavior.
5977 5977
5978 2.3.1: December 28, 2011 5978 2.3.1: December 28, 2011
5979 - Fix thread-safety problem resulting from non-thread-safe use of 5979 - Fix thread-safety problem resulting from non-thread-safe use of
@@ -6090,8 +6090,8 @@ For a detailed list of changes, please see the file @@ -6090,8 +6090,8 @@ For a detailed list of changes, please see the file
6090 stream's data is filterable. 6090 stream's data is filterable.
6091 6091
6092 - Provide two new examples: 6092 - Provide two new examples:
6093 - @1@command@1@pdf-double-page-size@2@command@2@ and  
6094 - @1@command@1@pdf-invert-images@2@command@2@ that illustrate the 6093 + :command:`pdf-double-page-size` and
  6094 + :command:`pdf-invert-images` that illustrate the
6095 newly added interfaces. 6095 newly added interfaces.
6096 6096
6097 - Fix a memory leak that would cause loss of a few bytes for every 6097 - Fix a memory leak that would cause loss of a few bytes for every
@@ -6109,7 +6109,7 @@ For a detailed list of changes, please see the file @@ -6109,7 +6109,7 @@ For a detailed list of changes, please see the file
6109 - Apply the same padding calculation fix from version 2.1.2 to the 6109 - Apply the same padding calculation fix from version 2.1.2 to the
6110 main cross reference stream as well. 6110 main cross reference stream as well.
6111 6111
6112 - - Since @1@command@1@qpdf --check@2@command@2@ only performs limited 6112 + - Since :command:`qpdf --check` only performs limited
6113 checks, clarify the output to make it clear that there still may 6113 checks, clarify the output to make it clear that there still may
6114 be errors that qpdf can't check. This should make it less 6114 be errors that qpdf can't check. This should make it less
6115 surprising to people when another PDF reader is unable to read a 6115 surprising to people when another PDF reader is unable to read a
@@ -6181,7 +6181,7 @@ For a detailed list of changes, please see the file @@ -6181,7 +6181,7 @@ For a detailed list of changes, please see the file
6181 use qpdf can enforce permissions. 6181 use qpdf can enforce permissions.
6182 6182
6183 - The @1@option@1@--check@2@option@2@ option to 6183 - The @1@option@1@--check@2@option@2@ option to
6184 - @1@command@1@qpdf@2@command@2@ has been extended to include some 6184 + :command:`qpdf` has been extended to include some
6185 additional information. 6185 additional information.
6186 6186
6187 - There have been a handful of non-compatible API changes. For 6187 - There have been a handful of non-compatible API changes. For
@@ -6213,7 +6213,7 @@ For a detailed list of changes, please see the file @@ -6213,7 +6213,7 @@ For a detailed list of changes, please see the file
6213 6213
6214 2.0.2: June 30, 2008 6214 2.0.2: June 30, 2008
6215 - Update test suite to work properly with a 6215 - Update test suite to work properly with a
6216 - non-@1@command@1@bash@2@command@2@ 6216 + non-:command:`bash`
6217 @1@filename@1@/bin/sh@2@filename@2@ and with Perl 5.10. No changes 6217 @1@filename@1@/bin/sh@2@filename@2@ and with Perl 5.10. No changes
6218 were made to the actual qpdf source code itself for this release. 6218 were made to the actual qpdf source code itself for this release.
6219 6219