mirror of
https://github.com/qpdf/qpdf.git
synced 2024-12-22 19:08:59 +00:00
Replace <replaceable> with {...}
All occurrences are in :file: or :samp: now.
This commit is contained in:
parent
0fdbb957a0
commit
d13a6032e6
1
TODO
1
TODO
@ -37,7 +37,6 @@ Make sure the information from <book> is in there
|
|||||||
Correct placement of comment: <!-- This section is referenced in QPDFObjectHandle.hh -->
|
Correct placement of comment: <!-- This section is referenced in QPDFObjectHandle.hh -->
|
||||||
|
|
||||||
<firstterm> -> just use literal
|
<firstterm> -> just use literal
|
||||||
<replaceable> -> use {}
|
|
||||||
|
|
||||||
Additional cleanup:
|
Additional cleanup:
|
||||||
|
|
||||||
|
164
manual/index.rst
164
manual/index.rst
@ -226,22 +226,22 @@ available crypto providers, and to use an external provider as the
|
|||||||
default over the native one. This behavior can be changed with the
|
default over the native one. This behavior can be changed with the
|
||||||
following flags to :command:`./configure`:
|
following flags to :command:`./configure`:
|
||||||
|
|
||||||
- :samp:`--enable-crypto-@3@replaceable@3@x@4@replaceable@4@`
|
- :samp:`--enable-crypto-{x}`
|
||||||
(where :samp:`@1@replaceable@1@x@2@replaceable@2@` is a supported crypto
|
(where :samp:`{x}` is a supported crypto
|
||||||
provider): enable the :samp:`@1@replaceable@1@x@2@replaceable@2@` crypto
|
provider): enable the :samp:`{x}` crypto
|
||||||
provider, requiring any external dependencies it needs
|
provider, requiring any external dependencies it needs
|
||||||
|
|
||||||
- :samp:`--disable-crypto-@3@replaceable@3@x@4@replaceable@4@`:
|
- :samp:`--disable-crypto-{x}`:
|
||||||
disable the :samp:`@1@replaceable@1@x@2@replaceable@2@` provider, and do not
|
disable the :samp:`{x}` provider, and do not
|
||||||
link against its dependencies even if they are available
|
link against its dependencies even if they are available
|
||||||
|
|
||||||
- :samp:`--with-default-crypto=@3@replaceable@3@x@4@replaceable@4@`:
|
- :samp:`--with-default-crypto={x}`:
|
||||||
make :samp:`@1@replaceable@1@x@2@replaceable@2@` the default provider even if
|
make :samp:`{x}` the default provider even if
|
||||||
a higher priority one is available
|
a higher priority one is available
|
||||||
|
|
||||||
- :samp:`--disable-implicit-crypto`: only build crypto
|
- :samp:`--disable-implicit-crypto`: only build crypto
|
||||||
providers that are explicitly requested with an
|
providers that are explicitly requested with an
|
||||||
:samp:`--enable-crypto-@3@replaceable@3@x@4@replaceable@4@`
|
:samp:`--enable-crypto-{x}`
|
||||||
option
|
option
|
||||||
|
|
||||||
For example, if you want to guarantee that the gnutls crypto provider is
|
For example, if you want to guarantee that the gnutls crypto provider is
|
||||||
@ -557,7 +557,7 @@ needed transformations.
|
|||||||
Output a completion command you can eval to enable shell completion
|
Output a completion command you can eval to enable shell completion
|
||||||
from zsh.
|
from zsh.
|
||||||
|
|
||||||
:samp:`--password=@3@replaceable@3@password@4@replaceable@4@`
|
:samp:`--password={password}`
|
||||||
Specifies a password for accessing encrypted files. To read the
|
Specifies a password for accessing encrypted files. To read the
|
||||||
password from a file or standard input, you can use
|
password from a file or standard input, you can use
|
||||||
:samp:`--password-file`, added in qpdf 10.2. Note
|
:samp:`--password-file`, added in qpdf 10.2. Note
|
||||||
@ -565,16 +565,16 @@ needed transformations.
|
|||||||
:samp:`@-` as described above to put the password in
|
:samp:`@-` as described above to put the password in
|
||||||
a file or pass it via standard input, but you would do so by
|
a file or pass it via standard input, but you would do so by
|
||||||
specifying the entire
|
specifying the entire
|
||||||
:samp:`--password=@3@replaceable@3@password@4@replaceable@4@`
|
:samp:`--password={password}`
|
||||||
option in the file. Syntax such as
|
option in the file. Syntax such as
|
||||||
:samp:`--password=@filename` won't work since
|
:samp:`--password=@filename` won't work since
|
||||||
:samp:`@filename` is not recognized in the middle of
|
:samp:`@filename` is not recognized in the middle of
|
||||||
an argument.
|
an argument.
|
||||||
|
|
||||||
:samp:`--password-file=@3@replaceable@3@filename@4@replaceable@4@`
|
:samp:`--password-file={filename}`
|
||||||
Reads the first line from the specified file and uses it as the
|
Reads the first line from the specified file and uses it as the
|
||||||
password for accessing encrypted files.
|
password for accessing encrypted files.
|
||||||
:samp:`@3@replaceable@3@filename@4@replaceable@4@`
|
:samp:`{filename}`
|
||||||
may be ``-`` to read the password from standard input. Note that, in
|
may be ``-`` to read the password from standard input. Note that, in
|
||||||
this case, the password is echoed and there is no prompt, so use with
|
this case, the password is echoed and there is no prompt, so use with
|
||||||
caution.
|
caution.
|
||||||
@ -625,10 +625,10 @@ needed transformations.
|
|||||||
If specified, the output file name should be omitted. This option
|
If specified, the output file name should be omitted. This option
|
||||||
tells qpdf to replace the input file with the output. It does this by
|
tells qpdf to replace the input file with the output. It does this by
|
||||||
writing to
|
writing to
|
||||||
:file:`@3@replaceable@3@infilename@4@replaceable@4@.~qpdf-temp#`
|
:file:`{infilename}.~qpdf-temp#`
|
||||||
and, when done, overwriting the input file with the temporary file.
|
and, when done, overwriting the input file with the temporary file.
|
||||||
If there were any warnings, the original input is saved as
|
If there were any warnings, the original input is saved as
|
||||||
:file:`@3@replaceable@3@infilename@4@replaceable@4@.~qpdf-orig`.
|
:file:`{infilename}.~qpdf-orig`.
|
||||||
|
|
||||||
:samp:`--copy-encryption=file`
|
:samp:`--copy-encryption=file`
|
||||||
Encrypt the file using the same encryption parameters, including user
|
Encrypt the file using the same encryption parameters, including user
|
||||||
@ -692,7 +692,7 @@ needed transformations.
|
|||||||
this option. See `Unicode Passwords <#ref.unicode-passwords>`__ for a
|
this option. See `Unicode Passwords <#ref.unicode-passwords>`__ for a
|
||||||
discussion
|
discussion
|
||||||
|
|
||||||
:samp:`--password-mode=@3@replaceable@3@mode@4@replaceable@4@`
|
:samp:`--password-mode={mode}`
|
||||||
This option can be used to fine-tune how qpdf interprets Unicode
|
This option can be used to fine-tune how qpdf interprets Unicode
|
||||||
(non-ASCII) password strings passed on the command line. With the
|
(non-ASCII) password strings passed on the command line. With the
|
||||||
exception of the :samp:`hex-bytes` mode, these only
|
exception of the :samp:`hex-bytes` mode, these only
|
||||||
@ -757,7 +757,7 @@ needed transformations.
|
|||||||
out.pdf --rotate=+180` would rotate all pages by 180
|
out.pdf --rotate=+180` would rotate all pages by 180
|
||||||
degrees.
|
degrees.
|
||||||
|
|
||||||
:samp:`--keep-files-open=@3@replaceable@3@[yn]@4@replaceable@4@`
|
:samp:`--keep-files-open={[yn]}`
|
||||||
This option controls whether qpdf keeps individual files open while
|
This option controls whether qpdf keeps individual files open while
|
||||||
merging. Prior to version 8.1.0, qpdf always kept all files open, but
|
merging. Prior to version 8.1.0, qpdf always kept all files open, but
|
||||||
this meant that the number of files that could be merged was limited
|
this meant that the number of files that could be merged was limited
|
||||||
@ -782,7 +782,7 @@ needed transformations.
|
|||||||
switching may be changed from the default 200 with the
|
switching may be changed from the default 200 with the
|
||||||
:samp:`--keep-files-open-threshold` option.
|
:samp:`--keep-files-open-threshold` option.
|
||||||
|
|
||||||
:samp:`--keep-files-open-threshold=@3@replaceable@3@count@4@replaceable@4@`
|
:samp:`--keep-files-open-threshold={count}`
|
||||||
If specified, overrides the default value of 200 used as the
|
If specified, overrides the default value of 200 used as the
|
||||||
threshold for qpdf deciding whether or not to keep files open. See
|
threshold for qpdf deciding whether or not to keep files open. See
|
||||||
:samp:`--keep-files-open` for details.
|
:samp:`--keep-files-open` for details.
|
||||||
@ -792,10 +792,10 @@ needed transformations.
|
|||||||
Selection Options <#ref.page-selection>`__ for details on how to do
|
Selection Options <#ref.page-selection>`__ for details on how to do
|
||||||
page selection (splitting and merging).
|
page selection (splitting and merging).
|
||||||
|
|
||||||
:samp:`--collate=@3@replaceable@3@n@4@replaceable@4@`
|
:samp:`--collate={n}`
|
||||||
When specified, collate rather than concatenate pages from files
|
When specified, collate rather than concatenate pages from files
|
||||||
specified with :samp:`--pages`. With a numeric
|
specified with :samp:`--pages`. With a numeric
|
||||||
argument, collate in groups of :samp:`@1@replaceable@1@n@2@replaceable@2@`.
|
argument, collate in groups of :samp:`{n}`.
|
||||||
The default is 1. See `Page Selection
|
The default is 1. See `Page Selection
|
||||||
Options <#ref.page-selection>`__ for additional details.
|
Options <#ref.page-selection>`__ for additional details.
|
||||||
|
|
||||||
@ -906,12 +906,12 @@ you want to create such files, specify the encryption option
|
|||||||
:samp:`--allow-insecure`, as described below.
|
:samp:`--allow-insecure`, as described below.
|
||||||
|
|
||||||
The value for
|
The value for
|
||||||
:samp:`@3@replaceable@3@key-length@4@replaceable@4@` may
|
:samp:`{key-length}` may
|
||||||
be 40, 128, or 256. The restriction flags are dependent upon key length.
|
be 40, 128, or 256. The restriction flags are dependent upon key length.
|
||||||
When no additional restrictions are given, the default is to be fully
|
When no additional restrictions are given, the default is to be fully
|
||||||
permissive.
|
permissive.
|
||||||
|
|
||||||
If :samp:`@3@replaceable@3@key-length@4@replaceable@4@`
|
If :samp:`{key-length}`
|
||||||
is 40, the following restriction options are available:
|
is 40, the following restriction options are available:
|
||||||
|
|
||||||
:samp:`--print=[yn]`
|
:samp:`--print=[yn]`
|
||||||
@ -927,7 +927,7 @@ is 40, the following restriction options are available:
|
|||||||
Determines whether or not to allow comments and form fill-in and
|
Determines whether or not to allow comments and form fill-in and
|
||||||
signing.
|
signing.
|
||||||
|
|
||||||
If :samp:`@3@replaceable@3@key-length@4@replaceable@4@`
|
If :samp:`{key-length}`
|
||||||
is 128, the following restriction options are available:
|
is 128, the following restriction options are available:
|
||||||
|
|
||||||
:samp:`--accessibility=[yn]`
|
:samp:`--accessibility=[yn]`
|
||||||
@ -960,9 +960,9 @@ is 128, the following restriction options are available:
|
|||||||
:samp:`--annotate`, and
|
:samp:`--annotate`, and
|
||||||
:samp:`--form` options.
|
:samp:`--form` options.
|
||||||
|
|
||||||
:samp:`--print=@3@replaceable@3@print-opt@4@replaceable@4@`
|
:samp:`--print={print-opt}`
|
||||||
Controls printing access.
|
Controls printing access.
|
||||||
:samp:`@3@replaceable@3@print-opt@4@replaceable@4@`
|
:samp:`{print-opt}`
|
||||||
may be one of the following:
|
may be one of the following:
|
||||||
|
|
||||||
- :samp:`full`: allow full printing
|
- :samp:`full`: allow full printing
|
||||||
@ -971,10 +971,10 @@ is 128, the following restriction options are available:
|
|||||||
|
|
||||||
- :samp:`none`: disallow printing
|
- :samp:`none`: disallow printing
|
||||||
|
|
||||||
:samp:`--modify=@3@replaceable@3@modify-opt@4@replaceable@4@`
|
:samp:`--modify={modify-opt}`
|
||||||
Controls modify access. This way of controlling modify access has
|
Controls modify access. This way of controlling modify access has
|
||||||
less granularity than new options added in qpdf 8.4.
|
less granularity than new options added in qpdf 8.4.
|
||||||
:samp:`@3@replaceable@3@modify-opt@4@replaceable@4@`
|
:samp:`{modify-opt}`
|
||||||
may be one of the following:
|
may be one of the following:
|
||||||
|
|
||||||
- :samp:`all`: allow full document modification
|
- :samp:`all`: allow full document modification
|
||||||
@ -1022,7 +1022,7 @@ is 128, the following restriction options are available:
|
|||||||
ever use this option. It exists primarily for use in testing qpdf
|
ever use this option. It exists primarily for use in testing qpdf
|
||||||
itself. This option also forces the PDF version to be at least 1.5.
|
itself. This option also forces the PDF version to be at least 1.5.
|
||||||
|
|
||||||
If :samp:`@3@replaceable@3@key-length@4@replaceable@4@`
|
If :samp:`{key-length}`
|
||||||
is 256, the minimum PDF version is 1.7 with extension level 8, and the
|
is 256, the minimum PDF version is 1.7 with extension level 8, and the
|
||||||
AES-based encryption format used is the PDF 2.0 encryption method
|
AES-based encryption format used is the PDF 2.0 encryption method
|
||||||
supported by Acrobat X. the same options are available as with 128 bits
|
supported by Acrobat X. the same options are available as with 128 bits
|
||||||
@ -1154,8 +1154,8 @@ following pages in this order:
|
|||||||
|
|
||||||
Starting in qpdf version 10.2, you may specify a numeric argument to
|
Starting in qpdf version 10.2, you may specify a numeric argument to
|
||||||
:samp:`--collate`. With
|
:samp:`--collate`. With
|
||||||
:samp:`--collate=@3@replaceable@3@n@4@replaceable@4@`,
|
:samp:`--collate={n}`,
|
||||||
pull groups of :samp:`@1@replaceable@1@n@2@replaceable@2@` pages from each file,
|
pull groups of :samp:`{n}` pages from each file,
|
||||||
again, stopping when there are no more pages. For example, if you ran
|
again, stopping when there are no more pages. For example, if you ran
|
||||||
:command:`qpdf --collate=2 --empty --pages a.pdf 1-5 b.pdf 6-4 c.pdf
|
:command:`qpdf --collate=2 --empty --pages a.pdf 1-5 b.pdf 6-4 c.pdf
|
||||||
r1 -- out.pdf`, you would get the following pages in this
|
r1 -- out.pdf`, you would get the following pages in this
|
||||||
@ -1330,44 +1330,44 @@ from the command line. The following options are available:
|
|||||||
The key is usually but not always equal to the file name, and is
|
The key is usually but not always equal to the file name, and is
|
||||||
needed by some of the other options.
|
needed by some of the other options.
|
||||||
|
|
||||||
:samp:`--show-attachment=@3@replaceable@3@key@4@replaceable@4@`
|
:samp:`--show-attachment={key}`
|
||||||
Write the contents of the specified attachment to standard output as
|
Write the contents of the specified attachment to standard output as
|
||||||
binary data. The key should match one of the keys shown by
|
binary data. The key should match one of the keys shown by
|
||||||
:samp:`--list-attachments`. If specified multiple
|
:samp:`--list-attachments`. If specified multiple
|
||||||
times, only the last attachment will be shown.
|
times, only the last attachment will be shown.
|
||||||
|
|
||||||
:samp:`--add-attachment @3@replaceable@3@file@4@replaceable@4@ @3@replaceable@3@options@4@replaceable@4@ --`
|
:samp:`--add-attachment {file} {options} --`
|
||||||
Add or replace an attachment with the contents of
|
Add or replace an attachment with the contents of
|
||||||
:samp:`@1@replaceable@1@file@2@replaceable@2@`. This may be specified more
|
:samp:`{file}`. This may be specified more
|
||||||
than once. The following additional options may appear before the
|
than once. The following additional options may appear before the
|
||||||
``--`` that ends this option:
|
``--`` that ends this option:
|
||||||
|
|
||||||
:samp:`--key=@3@replaceable@3@key@4@replaceable@4@`
|
:samp:`--key={key}`
|
||||||
The key to use to register the attachment in the embedded files
|
The key to use to register the attachment in the embedded files
|
||||||
table. Defaults to the last path element of
|
table. Defaults to the last path element of
|
||||||
:samp:`@1@replaceable@1@file@2@replaceable@2@`.
|
:samp:`{file}`.
|
||||||
|
|
||||||
:samp:`--filename=@3@replaceable@3@name@4@replaceable@4@`
|
:samp:`--filename={name}`
|
||||||
The file name to be used for the attachment. This is what is
|
The file name to be used for the attachment. This is what is
|
||||||
usually displayed to the user and is the name most graphical PDF
|
usually displayed to the user and is the name most graphical PDF
|
||||||
viewers will use when saving a file. It defaults to the last path
|
viewers will use when saving a file. It defaults to the last path
|
||||||
element of :samp:`@1@replaceable@1@file@2@replaceable@2@`.
|
element of :samp:`{file}`.
|
||||||
|
|
||||||
:samp:`--creationdate=@3@replaceable@3@date@4@replaceable@4@`
|
:samp:`--creationdate={date}`
|
||||||
The attachment's creation date in PDF format; defaults to the
|
The attachment's creation date in PDF format; defaults to the
|
||||||
current time. The date format is explained below.
|
current time. The date format is explained below.
|
||||||
|
|
||||||
:samp:`--moddate=@3@replaceable@3@date@4@replaceable@4@`
|
:samp:`--moddate={date}`
|
||||||
The attachment's modification date in PDF format; defaults to the
|
The attachment's modification date in PDF format; defaults to the
|
||||||
current time. The date format is explained below.
|
current time. The date format is explained below.
|
||||||
|
|
||||||
:samp:`--mimetype=@3@replaceable@3@type/subtype@4@replaceable@4@`
|
:samp:`--mimetype={type/subtype}`
|
||||||
The mime type for the attachment, e.g. ``text/plain`` or
|
The mime type for the attachment, e.g. ``text/plain`` or
|
||||||
``application/pdf``. Note that the mimetype appears in a field
|
``application/pdf``. Note that the mimetype appears in a field
|
||||||
called ``/Subtype`` in the PDF but actually includes the full type
|
called ``/Subtype`` in the PDF but actually includes the full type
|
||||||
and subtype of the mime type.
|
and subtype of the mime type.
|
||||||
|
|
||||||
:samp:`--description=@3@replaceable@3@"text"@4@replaceable@4@`
|
:samp:`--description={"text"}`
|
||||||
Descriptive text for the attachment, displayed by some PDF
|
Descriptive text for the attachment, displayed by some PDF
|
||||||
viewers.
|
viewers.
|
||||||
|
|
||||||
@ -1377,7 +1377,7 @@ from the command line. The following options are available:
|
|||||||
:command:`qpdf` gives an error if an attachment
|
:command:`qpdf` gives an error if an attachment
|
||||||
with that key is already present.
|
with that key is already present.
|
||||||
|
|
||||||
:samp:`--remove-attachment=@3@replaceable@3@key@4@replaceable@4@`
|
:samp:`--remove-attachment={key}`
|
||||||
Remove the specified attachment. This doesn't only remove the
|
Remove the specified attachment. This doesn't only remove the
|
||||||
attachment from the embedded files table but also clears out the file
|
attachment from the embedded files table but also clears out the file
|
||||||
specification. That means that any potential internal links to the
|
specification. That means that any potential internal links to the
|
||||||
@ -1385,16 +1385,16 @@ from the command line. The following options are available:
|
|||||||
times. Run with :samp:`--verbose` to see status of
|
times. Run with :samp:`--verbose` to see status of
|
||||||
the removal.
|
the removal.
|
||||||
|
|
||||||
:samp:`--copy-attachments-from @3@replaceable@3@file@4@replaceable@4@ @3@replaceable@3@options@4@replaceable@4@ --`
|
:samp:`--copy-attachments-from {file} {options} --`
|
||||||
Copy attachments from another file. This may be specified more than
|
Copy attachments from another file. This may be specified more than
|
||||||
once. The following additional options may appear before the ``--``
|
once. The following additional options may appear before the ``--``
|
||||||
that ends this option:
|
that ends this option:
|
||||||
|
|
||||||
:samp:`--password=@3@replaceable@3@password@4@replaceable@4@`
|
:samp:`--password={password}`
|
||||||
If required, the password needed to open
|
If required, the password needed to open
|
||||||
:samp:`@1@replaceable@1@file@2@replaceable@2@`
|
:samp:`{file}`
|
||||||
|
|
||||||
:samp:`--prefix=@3@replaceable@3@prefix@4@replaceable@4@`
|
:samp:`--prefix={prefix}`
|
||||||
Only required if the file from which attachments are being copied
|
Only required if the file from which attachments are being copied
|
||||||
has attachments with keys that conflict with attachments already
|
has attachments with keys that conflict with attachments already
|
||||||
in the file. In this case, the specified prefix will be prepended
|
in the file. In this case, the specified prefix will be prepended
|
||||||
@ -1404,10 +1404,10 @@ from the command line. The following options are available:
|
|||||||
|
|
||||||
When a date is required, the date should conform to the PDF date format
|
When a date is required, the date should conform to the PDF date format
|
||||||
specification, which is
|
specification, which is
|
||||||
``D:``\ :samp:`@1@replaceable@1@yyyymmddhhmmss<z>@2@replaceable@2@`, where
|
``D:``\ :samp:`{yyyymmddhhmmss<z>}`, where
|
||||||
:samp:`@1@replaceable@1@<z>@2@replaceable@2@` is either ``Z`` for UTC or a
|
:samp:`{<z>}` is either ``Z`` for UTC or a
|
||||||
timezone offset in the form :samp:`@1@replaceable@1@-hh'mm'@2@replaceable@2@` or
|
timezone offset in the form :samp:`{-hh'mm'}` or
|
||||||
:samp:`@1@replaceable@1@+hh'mm'@2@replaceable@2@`. Examples:
|
:samp:`{+hh'mm'}`. Examples:
|
||||||
``D:20210207161528-05'00'``, ``D:20210207211528Z``.
|
``D:20210207161528-05'00'``, ``D:20210207211528Z``.
|
||||||
|
|
||||||
.. _ref.advanced-parsing:
|
.. _ref.advanced-parsing:
|
||||||
@ -1456,14 +1456,14 @@ output file. Mostly these are of use only to people who are very
|
|||||||
familiar with the PDF file format or who are PDF developers. The
|
familiar with the PDF file format or who are PDF developers. The
|
||||||
following options are available:
|
following options are available:
|
||||||
|
|
||||||
:samp:`--compress-streams=@3@replaceable@3@[yn]@4@replaceable@4@`
|
:samp:`--compress-streams={[yn]}`
|
||||||
By default, or with :samp:`--compress-streams=y`,
|
By default, or with :samp:`--compress-streams=y`,
|
||||||
qpdf will compress any stream with no other filters applied to it
|
qpdf will compress any stream with no other filters applied to it
|
||||||
with the ``/FlateDecode`` filter when it writes it. To suppress this
|
with the ``/FlateDecode`` filter when it writes it. To suppress this
|
||||||
behavior and preserve uncompressed streams as uncompressed, use
|
behavior and preserve uncompressed streams as uncompressed, use
|
||||||
:samp:`--compress-streams=n`.
|
:samp:`--compress-streams=n`.
|
||||||
|
|
||||||
:samp:`--decode-level=@3@replaceable@3@option@4@replaceable@4@`
|
:samp:`--decode-level={option}`
|
||||||
Controls which streams qpdf tries to decode. The default is
|
Controls which streams qpdf tries to decode. The default is
|
||||||
:samp:`generalized`. The following options are
|
:samp:`generalized`. The following options are
|
||||||
available:
|
available:
|
||||||
@ -1487,12 +1487,12 @@ following options are available:
|
|||||||
specialized, decode streams with supported lossy filters;
|
specialized, decode streams with supported lossy filters;
|
||||||
currently this is just ``/DCTDecode`` (JPEG)
|
currently this is just ``/DCTDecode`` (JPEG)
|
||||||
|
|
||||||
:samp:`--stream-data=@3@replaceable@3@option@4@replaceable@4@`
|
:samp:`--stream-data={option}`
|
||||||
Controls transformation of stream data. This option predates the
|
Controls transformation of stream data. This option predates the
|
||||||
:samp:`--compress-streams` and
|
:samp:`--compress-streams` and
|
||||||
:samp:`--decode-level` options. Those options can be
|
:samp:`--decode-level` options. Those options can be
|
||||||
used to achieve the same affect with more control. The value of
|
used to achieve the same affect with more control. The value of
|
||||||
:samp:`@3@replaceable@3@option@4@replaceable@4@` may
|
:samp:`{option}` may
|
||||||
be one of the following:
|
be one of the following:
|
||||||
|
|
||||||
- :samp:`compress`: recompress stream data when
|
- :samp:`compress`: recompress stream data when
|
||||||
@ -1519,7 +1519,7 @@ following options are available:
|
|||||||
want to use it if you specify
|
want to use it if you specify
|
||||||
:samp:`--compression-level`.
|
:samp:`--compression-level`.
|
||||||
|
|
||||||
:samp:`--compression-level=@3@replaceable@3@level@4@replaceable@4@`
|
:samp:`--compression-level={level}`
|
||||||
When writing new streams that are compressed with ``/FlateDecode``,
|
When writing new streams that are compressed with ``/FlateDecode``,
|
||||||
use the specified compression level. The value of
|
use the specified compression level. The value of
|
||||||
:samp:`level` should be a number from 1 to 9 and is
|
:samp:`level` should be a number from 1 to 9 and is
|
||||||
@ -1535,9 +1535,9 @@ following options are available:
|
|||||||
normalization is enabled by default in QDF mode. Please see `QDF
|
normalization is enabled by default in QDF mode. Please see `QDF
|
||||||
Mode <#ref.qdf>`__ for additional discussion of QDF mode.
|
Mode <#ref.qdf>`__ for additional discussion of QDF mode.
|
||||||
|
|
||||||
:samp:`--object-streams=@3@replaceable@3@mode@4@replaceable@4@`
|
:samp:`--object-streams={mode}`
|
||||||
Controls handling of object streams. The value of
|
Controls handling of object streams. The value of
|
||||||
:samp:`@3@replaceable@3@mode@4@replaceable@4@` may be
|
:samp:`{mode}` may be
|
||||||
one of the following:
|
one of the following:
|
||||||
|
|
||||||
- :samp:`preserve`: preserve original object streams
|
- :samp:`preserve`: preserve original object streams
|
||||||
@ -1565,8 +1565,8 @@ following options are available:
|
|||||||
See also :samp:`--preserve-unreferenced-resources`,
|
See also :samp:`--preserve-unreferenced-resources`,
|
||||||
which does something completely different.
|
which does something completely different.
|
||||||
|
|
||||||
:samp:`--remove-unreferenced-resources=@3@replaceable@3@option@4@replaceable@4@`
|
:samp:`--remove-unreferenced-resources={option}`
|
||||||
The :samp:`@1@replaceable@1@option@2@replaceable@2@` may be ``auto``,
|
The :samp:`{option}` may be ``auto``,
|
||||||
``yes``, or ``no``. The default is ``auto``.
|
``yes``, or ``no``. The default is ``auto``.
|
||||||
|
|
||||||
Starting with qpdf 8.1, when splitting pages, qpdf is able to attempt
|
Starting with qpdf 8.1, when splitting pages, qpdf is able to attempt
|
||||||
@ -1608,7 +1608,7 @@ following options are available:
|
|||||||
at least prevents it from removing compliance on already compliant
|
at least prevents it from removing compliance on already compliant
|
||||||
files.
|
files.
|
||||||
|
|
||||||
:samp:`--linearize-pass1=@3@replaceable@3@file@4@replaceable@4@`
|
:samp:`--linearize-pass1={file}`
|
||||||
Write the first pass of linearization to the named file. The
|
Write the first pass of linearization to the named file. The
|
||||||
resulting file is not a valid PDF file. This option is useful only
|
resulting file is not a valid PDF file. This option is useful only
|
||||||
for debugging ``QPDFWriter``'s linearization code. When qpdf
|
for debugging ``QPDFWriter``'s linearization code. When qpdf
|
||||||
@ -1625,7 +1625,7 @@ following options are available:
|
|||||||
with QDF mode or content normalization to make it easier to look at
|
with QDF mode or content normalization to make it easier to look at
|
||||||
all of a page's contents at once.
|
all of a page's contents at once.
|
||||||
|
|
||||||
:samp:`--flatten-annotations=@3@replaceable@3@option@4@replaceable@4@`
|
:samp:`--flatten-annotations={option}`
|
||||||
This option collapses annotations into the pages' contents with
|
This option collapses annotations into the pages' contents with
|
||||||
special handling for form fields. Ordinarily, an annotation is
|
special handling for form fields. Ordinarily, an annotation is
|
||||||
rendered separately and on top of the page. Combining annotations
|
rendered separately and on top of the page. Combining annotations
|
||||||
@ -1634,7 +1634,7 @@ following options are available:
|
|||||||
transformations. The library functionality backing this option was
|
transformations. The library functionality backing this option was
|
||||||
added for the benefit of programs that want to create *n-up* page
|
added for the benefit of programs that want to create *n-up* page
|
||||||
layouts and other similar things that don't work well with
|
layouts and other similar things that don't work well with
|
||||||
annotations. The :samp:`@1@replaceable@1@option@2@replaceable@2@` parameter
|
annotations. The :samp:`{option}` parameter
|
||||||
may be any of the following:
|
may be any of the following:
|
||||||
|
|
||||||
- :samp:`all`: include all annotations that are not
|
- :samp:`all`: include all annotations that are not
|
||||||
@ -1704,15 +1704,15 @@ following options are available:
|
|||||||
optimized as well. Use :samp:`--keep-inline-images`
|
optimized as well. Use :samp:`--keep-inline-images`
|
||||||
to prevent inline images from being included.
|
to prevent inline images from being included.
|
||||||
|
|
||||||
:samp:`--oi-min-width=@3@replaceable@3@width@4@replaceable@4@`
|
:samp:`--oi-min-width={width}`
|
||||||
Avoid optimizing images whose width is below the specified amount. If
|
Avoid optimizing images whose width is below the specified amount. If
|
||||||
omitted, the default is 128 pixels. Use 0 for no minimum.
|
omitted, the default is 128 pixels. Use 0 for no minimum.
|
||||||
|
|
||||||
:samp:`--oi-min-height=@3@replaceable@3@height@4@replaceable@4@`
|
:samp:`--oi-min-height={height}`
|
||||||
Avoid optimizing images whose height is below the specified amount.
|
Avoid optimizing images whose height is below the specified amount.
|
||||||
If omitted, the default is 128 pixels. Use 0 for no minimum.
|
If omitted, the default is 128 pixels. Use 0 for no minimum.
|
||||||
|
|
||||||
:samp:`--oi-min-area=@3@replaceable@3@area-in-pixels@4@replaceable@4@`
|
:samp:`--oi-min-area={area-in-pixels}`
|
||||||
Avoid optimizing images whose pixel count (width × height) is below
|
Avoid optimizing images whose pixel count (width × height) is below
|
||||||
the specified amount. If omitted, the default is 16,384 pixels. Use 0
|
the specified amount. If omitted, the default is 16,384 pixels. Use 0
|
||||||
for no minimum.
|
for no minimum.
|
||||||
@ -1726,7 +1726,7 @@ following options are available:
|
|||||||
:samp:`--keep-inline-images` to exclude inline images
|
:samp:`--keep-inline-images` to exclude inline images
|
||||||
from image optimization.
|
from image optimization.
|
||||||
|
|
||||||
:samp:`--ii-min-bytes=@3@replaceable@3@bytes@4@replaceable@4@`
|
:samp:`--ii-min-bytes={bytes}`
|
||||||
Avoid converting inline images whose size is below the specified
|
Avoid converting inline images whose size is below the specified
|
||||||
minimum size to regular images. If omitted, the default is 1,024
|
minimum size to regular images. If omitted, the default is 1,024
|
||||||
bytes. Use 0 for no minimum.
|
bytes. Use 0 for no minimum.
|
||||||
@ -1744,9 +1744,9 @@ following options are available:
|
|||||||
Mode <#ref.qdf>`__. Note that :samp:`--linearize`
|
Mode <#ref.qdf>`__. Note that :samp:`--linearize`
|
||||||
disables QDF mode.
|
disables QDF mode.
|
||||||
|
|
||||||
:samp:`--min-version=@3@replaceable@3@version@4@replaceable@4@`
|
:samp:`--min-version={version}`
|
||||||
Forces the PDF version of the output file to be at least
|
Forces the PDF version of the output file to be at least
|
||||||
:samp:`@1@replaceable@1@version@2@replaceable@2@`. In other words, if the
|
:samp:`{version}`. In other words, if the
|
||||||
input file has a lower version than the specified version, the
|
input file has a lower version than the specified version, the
|
||||||
specified version will be used. If the input file has a higher
|
specified version will be used. If the input file has a higher
|
||||||
version, the input file's original version will be used. It is seldom
|
version, the input file's original version will be used. It is seldom
|
||||||
@ -1755,14 +1755,14 @@ following options are available:
|
|||||||
readers.
|
readers.
|
||||||
|
|
||||||
The version number may be expressed in the form
|
The version number may be expressed in the form
|
||||||
:samp:`@1@replaceable@1@major.minor.extension-level@2@replaceable@2@`, in
|
:samp:`{major.minor.extension-level}`, in
|
||||||
which case the version is interpreted as
|
which case the version is interpreted as
|
||||||
:samp:`@1@replaceable@1@major.minor@2@replaceable@2@` at extension level
|
:samp:`{major.minor}` at extension level
|
||||||
:samp:`@1@replaceable@1@extension-level@2@replaceable@2@`. For example,
|
:samp:`{extension-level}`. For example,
|
||||||
version ``1.7.8`` represents version 1.7 at extension level 8. Note
|
version ``1.7.8`` represents version 1.7 at extension level 8. Note
|
||||||
that minimal syntax checking is done on the command line.
|
that minimal syntax checking is done on the command line.
|
||||||
|
|
||||||
:samp:`--force-version=@3@replaceable@3@version@4@replaceable@4@`
|
:samp:`--force-version={version}`
|
||||||
This option forces the PDF version to be the exact version specified
|
This option forces the PDF version to be the exact version specified
|
||||||
*even when the file may have content that is not supported in that
|
*even when the file may have content that is not supported in that
|
||||||
version*. The version number is interpreted in the same way as with
|
version*. The version number is interpreted in the same way as with
|
||||||
@ -3121,7 +3121,7 @@ works. Look at the code in ``QPDFWriter`` for exact details.
|
|||||||
|
|
||||||
- Store current offset into xref table.
|
- Store current offset into xref table.
|
||||||
|
|
||||||
- Write ``:samp:`@1@replaceable@1@n@2@replaceable@2@` 0 obj``.
|
- Write ``:samp:`{n}` 0 obj``.
|
||||||
|
|
||||||
- If object is null, whether direct or indirect, write out null,
|
- If object is null, whether direct or indirect, write out null,
|
||||||
thus eliminating unresolvable indirect object references.
|
thus eliminating unresolvable indirect object references.
|
||||||
@ -3561,11 +3561,11 @@ which are these:
|
|||||||
``/Size`` in the trailer dictionary)
|
``/Size`` in the trailer dictionary)
|
||||||
|
|
||||||
- ``/Index`` (optional): value
|
- ``/Index`` (optional): value
|
||||||
``[:samp:`@1@replaceable@1@n count@2@replaceable@2@` ...]`` used to determine
|
``[:samp:`{n count}` ...]`` used to determine
|
||||||
which objects' information is stored in this stream. The default is
|
which objects' information is stored in this stream. The default is
|
||||||
``[0 /Size]``.
|
``[0 /Size]``.
|
||||||
|
|
||||||
- ``/Prev``: value :samp:`@1@replaceable@1@offset@2@replaceable@2@`: byte
|
- ``/Prev``: value :samp:`{offset}`: byte
|
||||||
offset of previous xref stream (same as ``/Prev`` in the trailer
|
offset of previous xref stream (same as ``/Prev`` in the trailer
|
||||||
dictionary)
|
dictionary)
|
||||||
|
|
||||||
@ -3877,7 +3877,7 @@ For a detailed list of changes, please see the file
|
|||||||
that is out of spec but that works in most viewers anyway).
|
that is out of spec but that works in most viewers anyway).
|
||||||
|
|
||||||
- The option
|
- The option
|
||||||
:samp:`--password-file=@3@replaceable@3@filename@4@replaceable@4@`
|
:samp:`--password-file={filename}`
|
||||||
can now be used to read the decryption password from a file.
|
can now be used to read the decryption password from a file.
|
||||||
You can use ``-`` as the file name to read the password from
|
You can use ``-`` as the file name to read the password from
|
||||||
standard input. This is an easier/more obvious way to read
|
standard input. This is an easier/more obvious way to read
|
||||||
@ -3894,9 +3894,9 @@ For a detailed list of changes, please see the file
|
|||||||
obtained by following the reference to the file spec object.
|
obtained by following the reference to the file spec object.
|
||||||
|
|
||||||
- Add numeric option to :samp:`--collate`. If
|
- Add numeric option to :samp:`--collate`. If
|
||||||
:samp:`--collate=@3@replaceable@3@n@4@replaceable@4@`
|
:samp:`--collate={n}`
|
||||||
is given, take pages in groups of
|
is given, take pages in groups of
|
||||||
:samp:`@1@replaceable@1@n@2@replaceable@2@` from the given files.
|
:samp:`{n}` from the given files.
|
||||||
|
|
||||||
- It is now valid to provide :samp:`--rotate=0`
|
- It is now valid to provide :samp:`--rotate=0`
|
||||||
to clear rotation from a page.
|
to clear rotation from a page.
|
||||||
@ -4517,7 +4517,7 @@ For a detailed list of changes, please see the file
|
|||||||
:samp:`--compression-level`.
|
:samp:`--compression-level`.
|
||||||
|
|
||||||
- The
|
- The
|
||||||
:samp:`--compression-level=@3@replaceable@3@level@4@replaceable@4@`
|
:samp:`--compression-level={level}`
|
||||||
sets the zlib compression level used for any streams compressed
|
sets the zlib compression level used for any streams compressed
|
||||||
by ``/FlateDecode``. Most effective when combined with
|
by ``/FlateDecode``. Most effective when combined with
|
||||||
:samp:`--recompress-flate`.
|
:samp:`--recompress-flate`.
|
||||||
@ -4687,7 +4687,7 @@ For a detailed list of changes, please see the file
|
|||||||
get it again.
|
get it again.
|
||||||
|
|
||||||
- New option
|
- New option
|
||||||
:samp:`--keep-files-open-threshold=@3@replaceable@3@count@4@replaceable@4@`
|
:samp:`--keep-files-open-threshold={count}`
|
||||||
can be used to override number of files that qpdf will use to
|
can be used to override number of files that qpdf will use to
|
||||||
trigger the behavior of not keeping all files open when merging
|
trigger the behavior of not keeping all files open when merging
|
||||||
files. This may be necessary if your system allows fewer than
|
files. This may be necessary if your system allows fewer than
|
||||||
@ -5148,7 +5148,7 @@ For a detailed list of changes, please see the file
|
|||||||
- Command-line Enhancements
|
- Command-line Enhancements
|
||||||
|
|
||||||
- Add
|
- Add
|
||||||
:samp:`--keep-files-open=@3@replaceable@3@[yn]@4@replaceable@4@`
|
:samp:`--keep-files-open={[yn]}`
|
||||||
to override default determination of whether to keep files open
|
to override default determination of whether to keep files open
|
||||||
when merging. Please see the discussion of
|
when merging. Please see the discussion of
|
||||||
:samp:`--keep-files-open` in `Basic
|
:samp:`--keep-files-open` in `Basic
|
||||||
@ -5228,7 +5228,7 @@ For a detailed list of changes, please see the file
|
|||||||
|
|
||||||
- The :samp:`--rotate` option's syntax has been
|
- The :samp:`--rotate` option's syntax has been
|
||||||
extended to make the page range optional. If you specify
|
extended to make the page range optional. If you specify
|
||||||
:samp:`--rotate=@3@replaceable@3@angle@4@replaceable@4@`
|
:samp:`--rotate={angle}`
|
||||||
without specifying a page range, the rotation will be applied
|
without specifying a page range, the rotation will be applied
|
||||||
to all pages. This can be especially useful for adjusting a PDF
|
to all pages. This can be especially useful for adjusting a PDF
|
||||||
created from a multi-page document that was scanned upside
|
created from a multi-page document that was scanned upside
|
||||||
@ -5352,7 +5352,7 @@ For a detailed list of changes, please see the file
|
|||||||
`Running QPDF <#ref.using>`__.
|
`Running QPDF <#ref.using>`__.
|
||||||
|
|
||||||
- The option
|
- The option
|
||||||
:samp:`--linearize-pass1=@3@replaceable@3@file@4@replaceable@4@`
|
:samp:`--linearize-pass1={file}`
|
||||||
has been added for debugging qpdf's linearization code.
|
has been added for debugging qpdf's linearization code.
|
||||||
|
|
||||||
- The option :samp:`--coalesce-contents` can be
|
- The option :samp:`--coalesce-contents` can be
|
||||||
|
Loading…
Reference in New Issue
Block a user