OpenSystemsDevelopment / qpdf

Commit b764ba95edb7c2d9be4f8f804db82faacdebdeac

Authored by Jay Berkenbilt
1 parent 15b87d76

Replace things previously marked with <filename> with :file:`...`

Inline Side-by-side
Showing 2 changed files with 129 additions and 130 deletions
... ... @@ -36,7 +36,6 @@ Make sure the information from &lt;book&gt; is in there
36 36 <xref> -- find #ref. in converted rst
37 37 Correct placement of comment: <!-- This section is referenced in QPDFObjectHandle.hh -->
38 38  
39   -<filename> -> :file: (allows {x})
40 39 <option> -> :samp: (allows {x})
41 40 <firstterm> -> just use literal
42 41 <replaceable> -> Make sure in :file: or :samp:, then use {}
... ...
manual/index.rst
  View file @b764ba9
... ... @@ -86,8 +86,8 @@ Building and Installing QPDF
86 86 ============================
87 87  
88 88 This chapter describes how to build and install qpdf. Please see also
89   -the @1@filename@1@README.md@2@filename@2@ and
90   -@1@filename@1@INSTALL@2@filename@2@ files in the source distribution.
  89 +the :file:`README.md` and
  90 +:file:`INSTALL` files in the source distribution.
91 91  
92 92 .. _ref.prerequisites:
93 93  
... ... @@ -167,16 +167,16 @@ suite and :command:`make install` to install. Please run
167 167 configured. You can also set the value of ``DESTDIR`` during
168 168 installation to install to a temporary location, as is common with many
169 169 open source packages. Please see also the
170   -@1@filename@1@README.md@2@filename@2@ and
171   -@1@filename@1@INSTALL@2@filename@2@ files in the source distribution.
  170 +:file:`README.md` and
  171 +:file:`INSTALL` files in the source distribution.
172 172  
173 173 Building on Windows is a little bit more complicated. For details,
174   -please see @1@filename@1@README-windows.md@2@filename@2@ in the source
  174 +please see :file:`README-windows.md` in the source
175 175 distribution. You can also download a binary distribution for Windows.
176 176 There is a port of qpdf to Visual C++ version 6 in the
177   -@1@filename@1@contrib@2@filename@2@ area generously contributed by Jian
  177 +:file:`contrib` area generously contributed by Jian
178 178 Ma. This is also discussed in more detail in
179   -@1@filename@1@README-windows.md@2@filename@2@.
  179 +:file:`README-windows.md`.
180 180  
181 181 While ``wchar_t`` is part of the C++ standard, qpdf uses it in only one
182 182 place in the public API, and it's just in a helper function. It is
... ... @@ -191,7 +191,7 @@ uses :command:`autoconf`, it does not use
191 191 :command:`automake` but instead uses a
192 192 hand-crafted non-recursive Makefile that requires gnu make. If you're
193 193 really interested, please read the comments in the top-level
194   -@1@filename@1@Makefile@2@filename@2@.
  194 +:file:`Makefile`.
195 195  
196 196 .. _ref.crypto:
197 197  
... ... @@ -251,13 +251,13 @@ used and that the native provider is not built, you could run
251 251  
252 252 If you build qpdf using your own build system, in order for qpdf to work
253 253 at all, you need to enable at least one crypto provider. The file
254   -@1@filename@1@libqpdf/qpdf/qpdf-config.h.in@2@filename@2@ provides
  254 +:file:`libqpdf/qpdf/qpdf-config.h.in` provides
255 255 macros ``DEFAULT_CRYPTO``, whose value must be a string naming the
256 256 default crypto provider, and various symbols starting with
257 257 ``USE_CRYPTO_``, at least one of which has to be enabled. Additionally,
258 258 you must compile the source files that implement a crypto provider. To
259 259 get a list of those files, look at
260   -@1@filename@1@libqpdf/build.mk@2@filename@2@. If you want to omit a
  260 +:file:`libqpdf/build.mk`. If you want to omit a
261 261 particular crypto provider, as long as its ``USE_CRYPTO_`` symbol is
262 262 undefined, you can completely ignore the source files that belong to a
263 263 particular crypto provider. Additionally, crypto providers may have
... ... @@ -269,8 +269,8 @@ is not defined, and ``DEFAULT_CRYPTO`` is defined to ``&quot;native&quot;``. Then
269 269 you must include the source files used in the native implementation,
270 270 some of which were added or renamed from earlier versions, to your
271 271 build, and you can ignore
272   -@1@filename@1@QPDFCrypto_gnutls.cc@2@filename@2@. Always consult
273   -@1@filename@1@libqpdf/build.mk@2@filename@2@ to get the list of source
  272 +:file:`QPDFCrypto_gnutls.cc`. Always consult
  273 +:file:`libqpdf/build.mk` to get the list of source
274 274 files you need to build.
275 275  
276 276 .. _ref.crypto.runtime:
... ... @@ -303,7 +303,7 @@ certain crypto provider to be used, you can call the method
303 303 a built-in or developer-supplied provider. To add your own crypto
304 304 provider, you have to create a class derived from ``QPDFCryptoImpl`` and
305 305 register it with ``QPDFCryptoProvider``. For additional information, see
306   -comments in @1@filename@1@include/qpdf/QPDFCryptoImpl.hh@2@filename@2@.
  306 +comments in :file:`include/qpdf/QPDFCryptoImpl.hh`.
307 307  
308 308 .. _ref.crypto.design:
309 309  
... ... @@ -417,10 +417,10 @@ some things you may want to keep in mind:
417 417 completion files by default, but as a packager, it's good if you
418 418 install them wherever your distribution expects such files to go. You
419 419 can find completion files to install in the
420   - @1@filename@1@completions@2@filename@2@ directory.
  420 + :file:`completions` directory.
421 421  
422 422 - Packagers are encouraged to install the source files from the
423   - @1@filename@1@examples@2@filename@2@ directory along with qpdf
  423 + :file:`examples` directory along with qpdf
424 424 development packages.
425 425  
426 426 .. _ref.using:
... ... @@ -625,10 +625,10 @@ needed transformations.
625 625 If specified, the output file name should be omitted. This option
626 626 tells qpdf to replace the input file with the output. It does this by
627 627 writing to
628   - @1@filename@1@@1@replaceable@1@infilename@2@replaceable@2@.~qpdf-temp#@2@filename@2@
  628 + :file:`@1@replaceable@1@infilename@2@replaceable@2@.~qpdf-temp#`
629 629 and, when done, overwriting the input file with the temporary file.
630 630 If there were any warnings, the original input is saved as
631   - @1@filename@1@@1@replaceable@1@infilename@2@replaceable@2@.~qpdf-orig@2@filename@2@.
  631 + :file:`@1@replaceable@1@infilename@2@replaceable@2@.~qpdf-orig`.
632 632  
633 633 @1@option@1@--copy-encryption=file@2@option@2@
634 634 Encrypt the file using the same encryption parameters, including user
... ... @@ -815,7 +815,7 @@ needed transformations.
815 815 replaced with a range of zero-padded page numbers starting from 1.
816 816  
817 817 - Otherwise, if the output file name ends in
818   - @1@filename@1@.pdf@2@filename@2@ (case insensitive), a zero-padded
  818 + :file:`.pdf` (case insensitive), a zero-padded
819 819 page range, preceded by a dash, is inserted before the file
820 820 extension.
821 821  
... ... @@ -824,21 +824,21 @@ needed transformations.
824 824  
825 825 Page ranges are a single number in the case of single-page groups or
826 826 two numbers separated by a dash otherwise. For example, if
827   - @1@filename@1@infile.pdf@2@filename@2@ has 12 pages
  827 + :file:`infile.pdf` has 12 pages
828 828  
829 829 - :command:`qpdf --split-pages infile.pdf %d-out`
830   - would generate files @1@filename@1@01-out@2@filename@2@ through
831   - @1@filename@1@12-out@2@filename@2@
  830 + would generate files :file:`01-out` through
  831 + :file:`12-out`
832 832  
833 833 - :command:`qpdf --split-pages=2 infile.pdf
834 834 outfile.pdf` would generate files
835   - @1@filename@1@outfile-01-02.pdf@2@filename@2@ through
836   - @1@filename@1@outfile-11-12.pdf@2@filename@2@
  835 + :file:`outfile-01-02.pdf` through
  836 + :file:`outfile-11-12.pdf`
837 837  
838 838 - :command:`qpdf --split-pages infile.pdf
839 839 something.else` would generate files
840   - @1@filename@1@something.else-01@2@filename@2@ through
841   - @1@filename@1@something.else-12@2@filename@2@
  840 + :file:`something.else-01` through
  841 + :file:`something.else-12`
842 842  
843 843 Note that outlines, threads, and other global features of the
844 844 original PDF file are not preserved. For each page of output, this
... ... @@ -1065,7 +1065,7 @@ the range of pages. Note that &quot;@1@option@1@--@2@option@2@&quot; terminates
1065 1065 parsing of page selection flags.
1066 1066  
1067 1067 Starting with qpf 8.4, the special input file name
1068   -"@1@filename@1@.@2@filename@2@" can be used as a shortcut for the
  1068 +":file:`.`" can be used as a shortcut for the
1069 1069 primary input filename.
1070 1070  
1071 1071 For each file that pages should be taken from, specify the file, a
... ... @@ -1122,8 +1122,8 @@ specified outside of @1@option@1@--pages ... --@2@option@2@. When
1122 1122 @1@option@1@--collate@2@option@2@ is specified, it changes the meaning
1123 1123 of @1@option@1@--pages@2@option@2@ so that the specified files, as
1124 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
1126   -@1@filename@1@even.pdf@2@filename@2@ containing odd and even pages of a
  1125 +example, if you add the files :file:`odd.pdf` and
  1126 +:file:`even.pdf` containing odd and even pages of a
1127 1127 document respectively, you could run :command:`qpdf --collate odd.pdf
1128 1128 --pages odd.pdf even.pdf -- all.pdf` to collate the pages.
1129 1129 This would pick page 1 from odd, page 1 from even, page 2 from odd, page
... ... @@ -1193,7 +1193,7 @@ required in order to implement this in your own application if you need
1193 1193 it.) In the mean time, you can always use
1194 1194 @1@option@1@--empty@2@option@2@ as the primary input file to avoid
1195 1195 copying all of that from the first file. For example, to take pages 1
1196   -through 5 from a @1@filename@1@infile.pdf@2@filename@2@ while preserving
  1196 +through 5 from a :file:`infile.pdf` while preserving
1197 1197 all metadata associated with that file, you could use
1198 1198  
1199 1199 ::
... ... @@ -1201,7 +1201,7 @@ all metadata associated with that file, you could use
1201 1201 :command:`qpdf` @1@option@1@infile.pdf --pages . 1-5 -- outfile.pdf@2@option@2@
1202 1202  
1203 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 +:file:`infile.pdf` but you wanted the rest of the
1205 1205 metadata to be dropped, you could instead run
1206 1206  
1207 1207 ::
... ... @@ -1209,16 +1209,16 @@ metadata to be dropped, you could instead run
1209 1209 :command:`qpdf` @1@option@1@--empty --pages infile.pdf 1-5 -- outfile.pdf@2@option@2@
1210 1210  
1211 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
1213   -@1@filename@1@file2.pdf@2@filename@2@ in reverse, taking document-level
1214   -metadata from @1@filename@1@file2.pdf@2@filename@2@, you would run
  1212 +:file:`file1.pdf` and pages 11 through 15 from
  1213 +:file:`file2.pdf` in reverse, taking document-level
  1214 +metadata from :file:`file2.pdf`, you would run
1215 1215  
1216 1216 ::
1217 1217  
1218 1218 :command:`qpdf` @1@option@1@file2.pdf --pages file1.pdf 1-5 . 15-11 -- outfile.pdf@2@option@2@
1219 1219  
1220 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 :file:`encrypted.pdf` with password
1222 1222 ``pass`` and repeat it twice in an output file, and if you wanted to
1223 1223 drop document-level metadata but preserve encryption, you would use
1224 1224  
... ... @@ -1231,8 +1231,8 @@ drop document-level metadata but preserve encryption, you would use
1231 1231 Note that we had to specify the password all three times because giving
1232 1232 a password as @1@option@1@--encryption-file-password@2@option@2@ doesn't
1233 1233 count for page selection, and as far as qpdf is concerned,
1234   -@1@filename@1@encrypted.pdf@2@filename@2@ and
1235   -@1@filename@1@./encrypted.pdf@2@filename@2@ are separated files. These
  1234 +:file:`encrypted.pdf` and
  1235 +:file:`./encrypted.pdf` are separated files. These
1236 1236 are all corner cases that most users should hopefully never have to be
1237 1237 bothered with.
1238 1238  
... ... @@ -1304,15 +1304,15 @@ Here are some examples.
1304 1304  
1305 1305 - :command:`--overlay o.pdf --to=1-5 --from=1-3 --repeat=4
1306 1306 --`: overlay the first three pages from file
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@
  1307 + :file:`o.pdf` onto the first three pages of the
  1308 + output, then overlay page 4 from :file:`o.pdf`
1309 1309 onto pages 4 and 5 of the output. Leave remaining output pages
1310 1310 untouched.
1311 1311  
1312 1312 - :command:`--underlay footer.pdf --from= --repeat=1,2
1313 1313 --`: Underlay page 1 of
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
  1314 + :file:`footer.pdf` on all odd output pages, and
  1315 + underlay page 2 of :file:`footer.pdf` on all even
1316 1316 output pages.
1317 1317  
1318 1318 .. _ref.attachments:
... ... @@ -1991,7 +1991,7 @@ given. The following options are available:
1991 1991 @1@option@1@--check@2@option@2@ produces no output to standard output
1992 1992 when everything is valid, so if you are using this to
1993 1993 programmatically validate files in bulk, it is safe to run without
1994   - output redirected to @1@filename@1@/dev/null@2@filename@2@ and just
  1994 + output redirected to :file:`/dev/null` and just
1995 1995 check for a 0 exit code.
1996 1996  
1997 1997 The @1@option@1@--raw-stream-data@2@option@2@ and
... ... @@ -2219,23 +2219,23 @@ Using QPDF from C++
2219 2219 -------------------
2220 2220  
2221 2221 The source tree for the qpdf package has an
2222   -@1@filename@1@examples@2@filename@2@ directory that contains a few
2223   -example programs. The @1@filename@1@qpdf/qpdf.cc@2@filename@2@ source
  2222 +:file:`examples` directory that contains a few
  2223 +example programs. The :file:`qpdf/qpdf.cc` source
2224 2224 file also serves as a useful example since it exercises almost all of
2225 2225 the qpdf library's public interface. The best source of documentation on
2226 2226 the library itself is reading comments in
2227   -@1@filename@1@include/qpdf/QPDF.hh@2@filename@2@,
2228   -@1@filename@1@include/qpdf/QPDFWriter.hh@2@filename@2@, and
2229   -@1@filename@1@include/qpdf/QPDFObjectHandle.hh@2@filename@2@.
  2227 +:file:`include/qpdf/QPDF.hh`,
  2228 +:file:`include/qpdf/QPDFWriter.hh`, and
  2229 +:file:`include/qpdf/QPDFObjectHandle.hh`.
2230 2230  
2231 2231 All header files are installed in the
2232   -@1@filename@1@include/qpdf@2@filename@2@ directory. It is recommend that
  2232 +:file:`include/qpdf` directory. It is recommend that
2233 2233 you use ``#include <qpdf/QPDF.hh>`` rather than adding
2234   -@1@filename@1@include/qpdf@2@filename@2@ to your include path.
  2234 +:file:`include/qpdf` to your include path.
2235 2235  
2236 2236 When linking against the qpdf static library, you may also need to
2237 2237 specify ``-lz -ljpeg`` on your link command. If your system understands
2238   -how to read libtool @1@filename@1@.la@2@filename@2@ files, this may not
  2238 +how to read libtool :file:`.la` files, this may not
2239 2239 be necessary.
2240 2240  
2241 2241 The qpdf library is safe to use in a multithreaded program, but no
... ... @@ -2255,7 +2255,7 @@ directly in other languages. There are a few things that can help.
2255 2255 "C"
2256 2256 The qpdf library includes a "C" language interface that provides a
2257 2257 subset of the overall capabilities. The header file
2258   - @1@filename@1@qpdf/qpdf-c.h@2@filename@2@ includes information about
  2258 + :file:`qpdf/qpdf-c.h` includes information about
2259 2259 its use. As long as you use a C++ linker, you can link C programs
2260 2260 with qpdf and use the C API. For languages that can directly load
2261 2261 methods from a shared library, the C API can also be useful. People
... ... @@ -2600,7 +2600,7 @@ are factory methods for each type of object as well as a convenience
2600 2600 method ``QPDFObjectHandle::parse`` that creates an object from a string
2601 2601 representation of the object. Existing instances of ``QPDFObjectHandle``
2602 2602 can also be modified in several ways. See comments in
2603   -@1@filename@1@QPDFObjectHandle.hh@2@filename@2@ for details.
  2603 +:file:`QPDFObjectHandle.hh` for details.
2604 2604  
2605 2605 An instance of ``QPDF`` is constructed by using the class's default
2606 2606 constructor. If desired, the ``QPDF`` object may be configured with
... ... @@ -2629,8 +2629,8 @@ instead.
2629 2629 There are some convenience routines for very common operations such as
2630 2630 walking the page tree and returning a vector of all page objects. For
2631 2631 full details, please see the header files
2632   -@1@filename@1@QPDF.hh@2@filename@2@ and
2633   -@1@filename@1@QPDFObjectHandle.hh@2@filename@2@. There are also some
  2632 +:file:`QPDF.hh` and
  2633 +:file:`QPDFObjectHandle.hh`. There are also some
2634 2634 additional helper classes that provide higher level API functions for
2635 2635 certain document constructions. These are discussed in `Helper
2636 2636 Classes <#ref.helper-classes>`__.
... ... @@ -2697,8 +2697,8 @@ By Convention, document helpers are called
2697 2697 ``QPDFSomethingObjectHelper`` and are derived from ``QPDFObjectHelper``.
2698 2698 For details on specific helpers, please see their header files. You can
2699 2699 find them by looking at
2700   -@1@filename@1@include/qpdf/QPDF*DocumentHelper.hh@2@filename@2@ and
2701   -@1@filename@1@include/qpdf/QPDF*ObjectHelper.hh@2@filename@2@.
  2700 +:file:`include/qpdf/QPDF*DocumentHelper.hh` and
  2701 +:file:`include/qpdf/QPDF*ObjectHelper.hh`.
2702 2702  
2703 2703 In order to avoid creation of circular dependencies, the following
2704 2704 general guidelines are followed with helper classes:
... ... @@ -2790,7 +2790,7 @@ file.
2790 2790 ``pdf.processFile("a.pdf");``.
2791 2791  
2792 2792 - The ``QPDF`` class checks the beginning of
2793   - @1@filename@1@a.pdf@2@filename@2@ for a PDF header. It then reads the
  2793 + :file:`a.pdf` for a PDF header. It then reads the
2794 2794 cross reference table mentioned at the end of the file, ensuring that
2795 2795 it is looking before the last ``%%EOF``. After getting to ``trailer``
2796 2796 keyword, it invokes the parser.
... ... @@ -2859,7 +2859,7 @@ warnings about the use of old-style casts in code that is shared between
2859 2859 C and C++ code.
2860 2860  
2861 2861 The ``QIntC`` namespace, provided by
2862   -@1@filename@1@include/qpdf/QIntC.hh@2@filename@2@, implements safe
  2862 +:file:`include/qpdf/QIntC.hh`, implements safe
2863 2863 functions for converting between integer types. These functions do range
2864 2864 checking and throw a ``std::range_error``, which is subclass of
2865 2865 ``std::runtime_error``, if conversion from one integer type to another
... ... @@ -2997,7 +2997,7 @@ useful on Windows if you want to avoid a dependency on Microsoft&#39;s
2997 2997 cryptography API. You can also supply your own random data provider. For
2998 2998 details on how to do this, please refer to the top-level README.md file
2999 2999 in the source distribution and to comments in
3000   -@1@filename@1@QUtil.hh@2@filename@2@.
  3000 +:file:`QUtil.hh`.
3001 3001  
3002 3002 .. _ref.adding-and-remove-pages:
3003 3003  
... ... @@ -3010,7 +3010,7 @@ pages. These are largely convenience routines that handle two tricky
3010 3010 issues: pushing inheritable resources from the ``/Pages`` tree down to
3011 3011 individual pages and manipulation of the ``/Pages`` tree itself. For
3012 3012 details, see ``addPage`` and surrounding methods in
3013   -@1@filename@1@QPDF.hh@2@filename@2@.
  3013 +:file:`QPDF.hh`.
3014 3014  
3015 3015 .. _ref.reserved-objects:
3016 3016  
... ... @@ -3038,7 +3038,7 @@ it is used internally by QPDF when copying objects from other PDF files,
3038 3038 as discussed in `Copying Objects From Other PDF
3039 3039 Files <#ref.foreign-objects>`__. For an example of how to use reserved
3040 3040 objects, search for ``newReserved`` in
3041   -@1@filename@1@test_driver.cc@2@filename@2@ in qpdf's sources.
  3041 +:file:`test_driver.cc` in qpdf's sources.
3042 3042  
3043 3043 .. _ref.foreign-objects:
3044 3044  
... ... @@ -3178,7 +3178,7 @@ and then writes the data (possibly modified) to its successor.
3178 3178 Alternatively, a pipeline may be an end-of-the-line pipeline that does
3179 3179 something like store its output to a file or a memory buffer ignoring a
3180 3180 successor. For additional details, look at
3181   -@1@filename@1@Pipeline.hh@2@filename@2@.
  3181 +:file:`Pipeline.hh`.
3182 3182  
3183 3183 ``QPDF`` can read raw or filtered streams. When reading a filtered
3184 3184 stream, the ``QPDF`` class creates a ``Pipeline`` object for one of each
... ... @@ -3196,7 +3196,7 @@ Object Accessor Methods
3196 3196  
3197 3197 For general information about how to access instances of
3198 3198 ``QPDFObjectHandle``, please see the comments in
3199   -@1@filename@1@QPDFObjectHandle.hh@2@filename@2@. Search for "Accessor
  3199 +:file:`QPDFObjectHandle.hh`. Search for "Accessor
3200 3200 methods". This section provides a more in-depth discussion of the
3201 3201 behavior and the rationale for the behavior.
3202 3202  
... ... @@ -3332,7 +3332,7 @@ this optimization was initially motivated by the need to create
3332 3332 linearized files, we are using these terms separately.
3333 3333  
3334 3334 PDF file optimization is implemented in the
3335   -@1@filename@1@QPDF_optimization.cc@2@filename@2@ source file. That file
  3335 +:file:`QPDF_optimization.cc` source file. That file
3336 3336 is richly commented and serves as the primary reference for the
3337 3337 optimization process.
3338 3338  
... ... @@ -3654,7 +3654,7 @@ Release Notes
3654 3654 =============
3655 3655  
3656 3656 For a detailed list of changes, please see the file
3657   -@1@filename@1@ChangeLog@2@filename@2@ in the source distribution.
  3657 +:file:`ChangeLog` in the source distribution.
3658 3658  
3659 3659 10.5.0: XXX Month dd, YYYY
3660 3660 - Library Enhancements
... ... @@ -3664,14 +3664,14 @@ For a detailed list of changes, please see the file
3664 3664 object is not of the expected type. These warnings now have an
3665 3665 error code of ``qpdf_e_object`` instead of
3666 3666 ``qpdf_e_damaged_pdf``. Also, comments have been added to
3667   - @1@filename@1@QPDFObjectHandle.hh@2@filename@2@ to explain in
  3667 + :file:`QPDFObjectHandle.hh` to explain in
3668 3668 more detail what the behavior is. See `Object Accessor
3669 3669 Methods <#ref.object-accessors>`__ for a more in-depth
3670 3670 discussion.
3671 3671  
3672 3672 - Overhaul error handling for the object handle functions in the
3673 3673 C API. See comments in the "Object handling" section of
3674   - @1@filename@1@include/qpdf/qpdf-c.h@2@filename@2@ for details.
  3674 + :file:`include/qpdf/qpdf-c.h` for details.
3675 3675 In particular, exceptions thrown by the underlying C++ code
3676 3676 when calling object accessors are caught and converted into
3677 3677 errors. The errors can be trapped by registering an error
... ... @@ -3754,7 +3754,7 @@ For a detailed list of changes, please see the file
3754 3754 - When adding a page that already exists, make a shallow copy
3755 3755 instead of throwing an exception. This makes the library
3756 3756 behavior consistent with the CLI behavior. See
3757   - @1@filename@1@ChangeLog@2@filename@2@ for additional notes.
  3757 + :file:`ChangeLog` for additional notes.
3758 3758  
3759 3759 10.3.1: March 11, 2021
3760 3760 - Bug Fixes
... ... @@ -3799,7 +3799,7 @@ For a detailed list of changes, please see the file
3799 3799 method added in 10.2.0. The majority of the API changes are in
3800 3800 methods most people would never call and that will hopefully be
3801 3801 superseded by higher-level interfaces for handling page copies.
3802   - Please see the @1@filename@1@ChangeLog@2@filename@2@ file for
  3802 + Please see the :file:`ChangeLog` file for
3803 3803 details.
3804 3804  
3805 3805 - The method ``QPDF::numWarnings`` was added so that you can tell
... ... @@ -3905,16 +3905,16 @@ For a detailed list of changes, please see the file
3905 3905  
3906 3906 - This release includes numerous additions to the API. Not all
3907 3907 changes are listed here. Please see the
3908   - @1@filename@1@ChangeLog@2@filename@2@ file in the source
  3908 + :file:`ChangeLog` file in the source
3909 3909 distribution for a comprehensive list. Highlights appear below.
3910 3910  
3911 3911 - Add ``QPDFObjectHandle::ditems()`` and
3912 3912 ``QPDFObjectHandle::aitems()`` that enable C++-style iteration,
3913 3913 including range-for iteration, over dictionary and array
3914 3914 QPDFObjectHandles. See comments in
3915   - @1@filename@1@include/qpdf/QPDFObjectHandle.hh@2@filename@2@
  3915 + :file:`include/qpdf/QPDFObjectHandle.hh`
3916 3916 and
3917   - @1@filename@1@examples/pdf-name-number-tree.cc@2@filename@2@
  3917 + :file:`examples/pdf-name-number-tree.cc`
3918 3918 for details.
3919 3919  
3920 3920 - Add ``QPDFObjectHandle::copyStream`` for making a copy of a
... ... @@ -3925,13 +3925,13 @@ For a detailed list of changes, please see the file
3925 3925 ``QPDFEmbeddedFileDocumentHelper``,
3926 3926 ``QPDFFileSpecObjectHelper``, and ``QPDFEFStreamObjectHelper``.
3927 3927 See their respective headers for details and
3928   - @1@filename@1@examples/pdf-attach-file.cc@2@filename@2@ for an
  3928 + :file:`examples/pdf-attach-file.cc` for an
3929 3929 example.
3930 3930  
3931 3931 - Add a version of ``QPDFObjectHandle::parse`` that takes a
3932 3932 ``QPDF`` pointer as context so that it can parse strings
3933 3933 containing indirect object references. This is illustrated in
3934   - @1@filename@1@examples/pdf-attach-file.cc@2@filename@2@.
  3934 + :file:`examples/pdf-attach-file.cc`.
3935 3935  
3936 3936 - Re-implement ``QPDFNameTreeObjectHelper`` and
3937 3937 ``QPDFNumberTreeObjectHelper`` to be more efficient, add an
... ... @@ -3948,12 +3948,12 @@ For a detailed list of changes, please see the file
3948 3948  
3949 3949 - The ``QPDFMatrix`` class, formerly a private, internal class,
3950 3950 has been added to the public API. See
3951   - @1@filename@1@include/qpdf/QPDFMatrix.hh@2@filename@2@ for
  3951 + :file:`include/qpdf/QPDFMatrix.hh` for
3952 3952 details. This class is for working with transformation
3953 3953 matrices. Some methods in ``QPDFPageObjectHelper`` make use of
3954 3954 this to make information about transformation matrices
3955 3955 available. For an example, see
3956   - @1@filename@1@examples/pdf-overlay-page.cc@2@filename@2@.
  3956 + :file:`examples/pdf-overlay-page.cc`.
3957 3957  
3958 3958 - Several new methods were added to
3959 3959 ``QPDFAcroFormDocumentHelper`` for adding, removing, getting
... ... @@ -4013,7 +4013,7 @@ For a detailed list of changes, please see the file
4013 4013 and register it with ``QPDF`` so that regular library methods,
4014 4014 including those used by ``QPDFWriter``, can decode streams with
4015 4015 filters not directly supported by the library. The example
4016   - @1@filename@1@examples/pdf-custom-filter.cc@2@filename@2@
  4016 + :file:`examples/pdf-custom-filter.cc`
4017 4017 illustrates how to use this capability.
4018 4018  
4019 4019 - Add methods to ``QPDFPageObjectHelper`` to iterate through
... ... @@ -4023,7 +4023,7 @@ For a detailed list of changes, please see the file
4023 4023  
4024 4024 - Enhance several methods in ``QPDFPageObjectHelper`` to work
4025 4025 with form XObjects as well as pages, as noted in comments. See
4026   - @1@filename@1@ChangeLog@2@filename@2@ for a full list.
  4026 + :file:`ChangeLog` for a full list.
4027 4027  
4028 4028 - Rename some functions in ``QPDFPageObjectHelper``, while
4029 4029 keeping old names for compatibility:
... ... @@ -4172,7 +4172,7 @@ For a detailed list of changes, please see the file
4172 4172 been moved from ``ifdefs`` to an autoconf
4173 4173 test. If you are using your own build system, you will need to
4174 4174 provide a value for ``LL_FMT`` in
4175   - @1@filename@1@libqpdf/qpdf/qpdf-config.h@2@filename@2@, which
  4175 + :file:`libqpdf/qpdf/qpdf-config.h`, which
4176 4176 would typically be ``"%lld"`` or, for some Windows compilers,
4177 4177 ``"%I64d"``.
4178 4178  
... ... @@ -4215,7 +4215,7 @@ For a detailed list of changes, please see the file
4215 4215  
4216 4216 - Enhancements
4217 4217  
4218   - - Improve the @1@filename@1@pdf-invert-images@2@filename@2@
  4218 + - Improve the :file:`pdf-invert-images`
4219 4219 example to avoid having to load all the images into RAM at the
4220 4220 same time.
4221 4221  
... ... @@ -4525,7 +4525,7 @@ For a detailed list of changes, please see the file
4525 4525 - Library Enhancements
4526 4526  
4527 4527 - A new namespace ``QIntC``, provided by
4528   - @1@filename@1@qpdf/QIntC.hh@2@filename@2@, provides safe
  4528 + :file:`qpdf/QIntC.hh`, provides safe
4529 4529 conversion methods between different integer types. These
4530 4530 conversion methods do range checking to ensure that the cast
4531 4531 can be performed with no loss of information. Every use of
... ... @@ -4599,7 +4599,7 @@ For a detailed list of changes, please see the file
4599 4599 hexadecimal digits, which is invalid in PDF 1.2 and above, are
4600 4600 properly handled by the library: a warning is generated, and
4601 4601 the name token is properly preserved, even if invalid, in the
4602   - output. See @1@filename@1@ChangeLog@2@filename@2@ for a more
  4602 + output. See :file:`ChangeLog` for a more
4603 4603 complete description of this change.
4604 4604  
4605 4605 - Bug Fixes
... ... @@ -4654,8 +4654,8 @@ For a detailed list of changes, please see the file
4654 4654 files but not others.
4655 4655  
4656 4656 - If :command:`pkg-config` is available, use it to
4657   - locate @1@filename@1@libjpeg@2@filename@2@ and
4658   - @1@filename@1@zlib@2@filename@2@ dependencies, falling back on
  4657 + locate :file:`libjpeg` and
  4658 + :file:`zlib` dependencies, falling back on
4659 4659 old behavior if unsuccessful.
4660 4660  
4661 4661 - Other Notes
... ... @@ -4796,7 +4796,7 @@ For a detailed list of changes, please see the file
4796 4796 - In the @1@option@1@--pages@2@option@2@ option, allow use of "."
4797 4797 as a shortcut for the primary input file. That way, you can do
4798 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 :file:`in.pdf`
4800 4800 in the command.
4801 4801  
4802 4802 - When encrypting with 128-bit and 256-bit encryption, new
... ... @@ -4853,7 +4853,7 @@ For a detailed list of changes, please see the file
4853 4853 - Add new versions of
4854 4854 ``QPDFWriter::setR{3,4,5,6}EncryptionParameters`` that allow
4855 4855 more granular setting of permissions bits. See
4856   - @1@filename@1@QPDFWriter.hh@2@filename@2@ for details.
  4856 + :file:`QPDFWriter.hh` for details.
4857 4857  
4858 4858 - Add new versions of the transcoders from UTF-8 to single-byte
4859 4859 coding systems in ``QUtil`` that report success or failure
... ... @@ -4885,7 +4885,7 @@ For a detailed list of changes, please see the file
4885 4885 copied immediately instead of lazily. This option uses more
4886 4886 memory but allows the source object to go out of scope before
4887 4887 the destination object is written in all cases. See comments in
4888   - @1@filename@1@QPDF.hh@2@filename@2@ for details.
  4888 + :file:`QPDF.hh` for details.
4889 4889  
4890 4890 - Add method ``QPDFPageObjectHelper::getAttribute`` for
4891 4891 retrieving an attribute from the page dictionary taking
... ... @@ -5025,10 +5025,10 @@ For a detailed list of changes, please see the file
5025 5025  
5026 5026 - Ordinarily qpdf treats an argument of the form
5027 5027 @1@option@1@@file@2@option@2@ to mean that command-line options
5028   - should be read from @1@filename@1@file@2@filename@2@. Now, if
5029   - @1@filename@1@file@2@filename@2@ does not exist but
5030   - @1@filename@1@@file@2@filename@2@ does, qpdf will treat
5031   - @1@filename@1@@file@2@filename@2@ as a regular option. This
  5028 + should be read from :file:`file`. Now, if
  5029 + :file:`file` does not exist but
  5030 + :file:`@file` does, qpdf will treat
  5031 + :file:`@file` as a regular option. This
5032 5032 makes it possible to work more easily with PDF files whose
5033 5033 names happen to start with the ``@`` character.
5034 5034  
... ... @@ -5040,11 +5040,11 @@ For a detailed list of changes, please see the file
5040 5040 case is when the source stream gets is data using a
5041 5041 QPDFObjectHandle::StreamDataProvider. For a more in-depth
5042 5042 discussion, see comments around ``copyForeignObject`` in
5043   - @1@filename@1@QPDF.hh@2@filename@2@.
  5043 + :file:`QPDF.hh`.
5044 5044  
5045 5045 - Add new method ``QPDFWriter::getFinalVersion()``, which returns
5046 5046 the PDF version that will ultimately be written to the final
5047   - file. See comments in @1@filename@1@QPDFWriter.hh@2@filename@2@
  5047 + file. See comments in :file:`QPDFWriter.hh`
5048 5048 for some restrictions on its use.
5049 5049  
5050 5050 - Add several methods for transcoding strings to some of the
... ... @@ -5057,14 +5057,14 @@ For a detailed list of changes, please see the file
5057 5057 - Add new methods to ``QPDFAnnotationObjectHelper`` and
5058 5058 ``QPDFFormFieldObjectHelper`` for querying flags and
5059 5059 interpretation of different field types. Define constants in
5060   - @1@filename@1@qpdf/Constants.h@2@filename@2@ to help with
  5060 + :file:`qpdf/Constants.h` to help with
5061 5061 interpretation of flag values.
5062 5062  
5063 5063 - Add new methods
5064 5064 ``QPDFAcroFormDocumentHelper::generateAppearancesIfNeeded`` and
5065 5065 ``QPDFFormFieldObjectHelper::generateAppearance`` for
5066 5066 generating appearance streams. See discussion in
5067   - @1@filename@1@QPDFFormFieldObjectHelper.hh@2@filename@2@ for
  5067 + :file:`QPDFFormFieldObjectHelper.hh` for
5068 5068 limitations.
5069 5069  
5070 5070 - Add two new helper functions for dealing with resource
... ... @@ -5141,7 +5141,7 @@ For a detailed list of changes, please see the file
5141 5141 - If you would like to have qpdf completion enabled
5142 5142 automatically, you can install completion files in the
5143 5143 distribution's default location. You can find sample completion
5144   - files to install in the @1@filename@1@completions@2@filename@2@
  5144 + files to install in the :file:`completions`
5145 5145 directory.
5146 5146  
5147 5147 8.2.1: August 18, 2018
... ... @@ -5195,8 +5195,8 @@ For a detailed list of changes, please see the file
5195 5195 - Build Changes
5196 5196  
5197 5197 - For the mingw builds, change the name of the DLL import library
5198   - from @1@filename@1@libqpdf.a@2@filename@2@ to
5199   - @1@filename@1@libqpdf.dll.a@2@filename@2@ to more accurately
  5198 + from :file:`libqpdf.a` to
  5199 + :file:`libqpdf.dll.a` to more accurately
5200 5200 reflect that it is an import library rather than a static
5201 5201 library. This potentially clears the way for supporting a
5202 5202 static library in the future, though presently, the qpdf
... ... @@ -5274,7 +5274,7 @@ For a detailed list of changes, please see the file
5274 5274 way to perform operations on pages rather than calling the old
5275 5275 methods in ``QPDFObjectHandle`` and ``QPDF`` directly. Comments
5276 5276 in the header files direct you to the new interfaces. Please
5277   - see the header files and @1@filename@1@ChangeLog@2@filename@2@
  5277 + see the header files and :file:`ChangeLog`
5278 5278 for additional details.
5279 5279  
5280 5280 - Add three new object helper class: ``QPDFPageObjectHelper`` for
... ... @@ -5284,7 +5284,7 @@ For a detailed list of changes, please see the file
5284 5284 some useful, basic functionality.
5285 5285  
5286 5286 - A new example program
5287   - @1@filename@1@examples/pdf-set-form-values.cc@2@filename@2@ has
  5287 + :file:`examples/pdf-set-form-values.cc` has
5288 5288 been added that illustrates use of the new document and object
5289 5289 helpers.
5290 5290  
... ... @@ -5369,7 +5369,7 @@ For a detailed list of changes, please see the file
5369 5369  
5370 5370 - Major enhancements to the lexical layer of qpdf. For a complete
5371 5371 list of enhancements, please refer to the
5372   - @1@filename@1@ChangeLog@2@filename@2@ file. Most of the changes
  5372 + :file:`ChangeLog` file. Most of the changes
5373 5373 result in improvements to qpdf's ability handle erroneous
5374 5374 files. It is also possible for programs to handle whitespace,
5375 5375 comments, and inline images as tokens.
... ... @@ -5379,10 +5379,10 @@ For a detailed list of changes, please see the file
5379 5379 the developer to provide token handlers. Token filters can be
5380 5380 used with several different methods in ``QPDFObjectHandle`` as
5381 5381 well as with a lower-level interface. See comments in
5382   - @1@filename@1@QPDFObjectHandle.hh@2@filename@2@ as well as the
  5382 + :file:`QPDFObjectHandle.hh` as well as the
5383 5383 new examples
5384   - @1@filename@1@examples/pdf-filter-tokens.cc@2@filename@2@ and
5385   - @1@filename@1@examples/pdf-count-strings.cc@2@filename@2@ for
  5384 + :file:`examples/pdf-filter-tokens.cc` and
  5385 + :file:`examples/pdf-count-strings.cc` for
5386 5386 details.
5387 5387  
5388 5388 7.1.1: February 4, 2018
... ... @@ -5407,7 +5407,7 @@ For a detailed list of changes, please see the file
5407 5407 the discussion of @1@option@1@--password-is-hex-key@2@option@2@ in
5408 5408 `Basic Options <#ref.basic-options>`__ or the comments around
5409 5409 ``QPDF::setPasswordIsHexKey`` in
5410   - @1@filename@1@QPDF.hh@2@filename@2@ for additional details.
  5410 + :file:`QPDF.hh` for additional details.
5411 5411  
5412 5412 - Bug fix: numbers ending with a trailing decimal point are now
5413 5413 properly recognized as numbers.
... ... @@ -5520,7 +5520,7 @@ For a detailed list of changes, please see the file
5520 5520 - New ``Pipeline`` types ``Pl_RunLength`` and ``Pl_DCT`` are
5521 5521 available for developers who wish to produce or consume
5522 5522 RunLength or DCT stream data directly. The
5523   - @1@filename@1@examples/pdf-create.cc@2@filename@2@ example
  5523 + :file:`examples/pdf-create.cc` example
5524 5524 illustrates their use.
5525 5525  
5526 5526 - ``QPDFWriter::setCompressStreams`` and
... ... @@ -5643,8 +5643,8 @@ For a detailed list of changes, please see the file
5643 5643 preferred over ``QPDFObjectHandle::getObjectID()`` and
5644 5644 ``QPDFObjectHandle::getGeneration()`` as it makes it less likely
5645 5645 for people to accidentally write code that ignores the generation
5646   - number. See @1@filename@1@QPDF.hh@2@filename@2@ and
5647   - @1@filename@1@QPDFObjectHandle.hh@2@filename@2@ for additional
  5646 + number. See :file:`QPDF.hh` and
  5647 + :file:`QPDFObjectHandle.hh` for additional
5648 5648 notes.
5649 5649  
5650 5650 - Add @1@option@1@--show-npages@2@option@2@ command-line option to
... ... @@ -5658,15 +5658,15 @@ For a detailed list of changes, please see the file
5658 5658  
5659 5659 - Various enhancements were made to support different types of
5660 5660 broken files or broken readers. Details can be found in
5661   - @1@filename@1@ChangeLog@2@filename@2@.
  5661 + :file:`ChangeLog`.
5662 5662  
5663 5663 4.1.0: April 14, 2013
5664 5664 - Note to people including qpdf in distributions: the
5665   - @1@filename@1@.la@2@filename@2@ files generated by libtool are now
  5665 + :file:`.la` files generated by libtool are now
5666 5666 installed by qpdf's :command:`make install` target.
5667 5667 Before, they were not installed. This means that if your
5668 5668 distribution does not want to include
5669   - @1@filename@1@.la@2@filename@2@ files, you must remove them as
  5669 + :file:`.la` files, you must remove them as
5670 5670 part of your packaging process.
5671 5671  
5672 5672 - Major enhancement: API enhancements have been made to support
... ... @@ -5676,7 +5676,7 @@ For a detailed list of changes, please see the file
5676 5676 - ``QPDFObjectHandle::parseContentStream`` method parses objects
5677 5677 in a content stream and calls handlers in a callback class. The
5678 5678 example
5679   - @1@filename@1@examples/pdf-parse-content.cc@2@filename@2@
  5679 + :file:`examples/pdf-parse-content.cc`
5680 5680 illustrates how this may be used.
5681 5681  
5682 5682 - ``QPDFObjectHandle`` can now represent operators and inline
... ... @@ -5699,7 +5699,7 @@ For a detailed list of changes, please see the file
5699 5699 versions.
5700 5700  
5701 5701 - Warning flags have been moved into a separate variable in
5702   - @1@filename@1@autoconf.mk@2@filename@2@
  5702 + :file:`autoconf.mk`
5703 5703  
5704 5704 - The configure flag @1@option@1@--enable-werror@2@option@2@ work
5705 5705 for Microsoft compilers
... ... @@ -5718,7 +5718,7 @@ For a detailed list of changes, please see the file
5718 5718 - Some internal limits have been removed in code that converts
5719 5719 numbers to strings. This is largely invisible to users, but it
5720 5720 does trigger a bug in some older versions of mingw-w64's C++
5721   - library. See @1@filename@1@README-windows.md@2@filename@2@ in
  5721 + library. See :file:`README-windows.md` in
5722 5722 the source distribution if you think this may affect you. The
5723 5723 copy of the DLL distributed with qpdf's binary distribution is
5724 5724 not affected by this problem.
... ... @@ -5745,7 +5745,7 @@ For a detailed list of changes, please see the file
5745 5745 - Fix detection of binary attachments in test suite to avoid false
5746 5746 test failures on some platforms.
5747 5747  
5748   - - Add clarifying comment in @1@filename@1@QPDF.hh@2@filename@2@ to
  5748 + - Add clarifying comment in :file:`QPDF.hh` to
5749 5749 methods that return the user password explaining that it is no
5750 5750 longer possible with newer encryption formats to recover the user
5751 5751 password knowing the owner password. In earlier encryption
... ... @@ -5938,14 +5938,14 @@ For a detailed list of changes, please see the file
5938 5938  
5939 5939 - The ``QPDF::emptyPDF`` can be used to allow creation of PDF files
5940 5940 from scratch. The example
5941   - @1@filename@1@examples/pdf-create.cc@2@filename@2@ illustrates how
  5941 + :file:`examples/pdf-create.cc` illustrates how
5942 5942 it can be used.
5943 5943  
5944 5944 - Several methods to take ``PointerHolder<Buffer>`` can now also
5945 5945 accept ``std::string`` arguments.
5946 5946  
5947 5947 - Many new convenience methods have been added to the library, most
5948   - in ``QPDFObjectHandle``. See @1@filename@1@ChangeLog@2@filename@2@
  5948 + in ``QPDFObjectHandle``. See :file:`ChangeLog`
5949 5949 for a full list.
5950 5950  
5951 5951 - When building on a platform that supports ELF shared libraries
... ... @@ -5954,23 +5954,23 @@ For a detailed list of changes, please see the file
5954 5954 @1@option@1@--disable-ld-version-script@2@option@2@ to
5955 5955 :command:`./configure`.
5956 5956  
5957   - - The file @1@filename@1@libqpdf.pc@2@filename@2@ is now installed
  5957 + - The file :file:`libqpdf.pc` is now installed
5958 5958 to support :command:`pkg-config`.
5959 5959  
5960 5960 - Image comparison tests are off by default now since they are not
5961 5961 needed to verify a correct build or port of qpdf. They are needed
5962 5962 only when changing the actual PDF output generated by qpdf. You
5963 5963 should enable them if you are making deep changes to qpdf itself.
5964   - See @1@filename@1@README.md@2@filename@2@ for details.
  5964 + See :file:`README.md` for details.
5965 5965  
5966 5966 - Large file tests are off by default but can be turned on with
5967 5967 :command:`./configure` or by setting an environment
5968 5968 variable before running the test suite. See
5969   - @1@filename@1@README.md@2@filename@2@ for details.
  5969 + :file:`README.md` for details.
5970 5970  
5971 5971 - When qpdf's test suite fails, failures are not printed to the
5972 5972 terminal anymore by default. Instead, find them in
5973   - @1@filename@1@build/qtest.log@2@filename@2@. For packagers who are
  5973 + :file:`build/qtest.log`. For packagers who are
5974 5974 building with an autobuilder, you can add the
5975 5975 @1@option@1@--enable-show-failed-test-output@2@option@2@ option to
5976 5976 :command:`./configure` to restore the old behavior.
... ... @@ -6046,7 +6046,7 @@ For a detailed list of changes, please see the file
6046 6046 library to present to the user in some other way. Note that QPDF
6047 6047 does not write to ``std::cout`` (or the specified output stream)
6048 6048 except where explicitly mentioned in
6049   - @1@filename@1@QPDF.hh@2@filename@2@, and that the only use of the
  6049 + :file:`QPDF.hh`, and that the only use of the
6050 6050 error stream is for warnings. Note also that output of warnings is
6051 6051 suppressed when ``setSuppressWarnings(true)`` is called.
6052 6052  
... ... @@ -6143,14 +6143,14 @@ For a detailed list of changes, please see the file
6143 6143 excellent suggestions on improving the interface.
6144 6144  
6145 6145 For programming to the C interface, please see the header file
6146   - @1@filename@1@qpdf/qpdf-c.h@2@filename@2@ and the example
6147   - @1@filename@1@examples/pdf-linearize.c@2@filename@2@.
  6146 + :file:`qpdf/qpdf-c.h` and the example
  6147 + :file:`examples/pdf-linearize.c`.
6148 6148  
6149 6149 - Žarko Gajić has written a Delphi wrapper for qpdf, which can be
6150 6150 downloaded from qpdf's download side. Žarko's Delphi wrapper is
6151 6151 released with the same licensing terms as qpdf itself and comes
6152 6152 with this disclaimer: "Delphi wrapper unit
6153   - @1@filename@1@qpdf.pas@2@filename@2@ created by Žarko Gajić
  6153 + :file:`qpdf.pas` created by Žarko Gajić
6154 6154 (http://zarko-gajic.iz.hr/). Use at your own risk and for whatever
6155 6155 purpose you want. No support is provided. Sample code is
6156 6156 provided."
... ... @@ -6214,14 +6214,14 @@ For a detailed list of changes, please see the file
6214 6214 2.0.2: June 30, 2008
6215 6215 - Update test suite to work properly with a
6216 6216 non-:command:`bash`
6217   - @1@filename@1@/bin/sh@2@filename@2@ and with Perl 5.10. No changes
  6217 + :file:`/bin/sh` and with Perl 5.10. No changes
6218 6218 were made to the actual qpdf source code itself for this release.
6219 6219  
6220 6220 2.0.1: May 6, 2008
6221 6221 - No changes in functionality or interface. This release includes
6222 6222 fixes to the source code so that qpdf compiles properly and passes
6223 6223 its test suite on a broader range of platforms. See
6224   - @1@filename@1@ChangeLog@2@filename@2@ in the source distribution
  6224 + :file:`ChangeLog` in the source distribution
6225 6225 for details.
6226 6226  
6227 6227 2.0: April 29, 2008
... ... @@ -6244,7 +6244,7 @@ files.
6244 6244 internal errors and ``std::runtime_error`` for runtime errors in
6245 6245 favor of the now removed ``QEXC`` classes used in previous versions.
6246 6246 The ``QEXC`` exception classes predated the addition of the
6247   - @1@filename@1@<stdexcept>@2@filename@2@ header file to the C++
  6247 + :file:`<stdexcept>` header file to the C++
6248 6248 standard library. Most of the exceptions thrown by the qpdf library
6249 6249 itself are still of type ``QPDFExc`` which is now derived from
6250 6250 ``std::runtime_error``. Programs that caught an instance of
... ... @@ -6255,7 +6255,7 @@ files.
6255 6255 error condition and provides interfaces for querying them. Among the
6256 6256 fields is a numeric error code that can help applications act
6257 6257 differently on (a small number of) different error conditions. See
6258   - @1@filename@1@QPDFExc.hh@2@filename@2@ for details.
  6258 + :file:`QPDFExc.hh` for details.
6259 6259  
6260 6260 - Warnings can be retrieved from qpdf as instances of ``QPDFExc``
6261 6261 instead of strings.
... ... @@ -6278,7 +6278,7 @@ files.
6278 6278  
6279 6279 - The enumerated types that used to be nested in ``QPDFWriter`` have
6280 6280 moved to top-level enumerated types and are now defined in the file
6281   - @1@filename@1@qpdf/Constants.h@2@filename@2@. This enables them to be
  6281 + :file:`qpdf/Constants.h`. This enables them to be
6282 6282 shared by both the C and C++ interfaces.
6283 6283  
6284 6284 .. _ref.upgrading-to-3.0:
... ...