summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bxpdfver/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-02-12 23:32:25 +0000
committerKarl Berry <karl@freefriends.org>2017-02-12 23:32:25 +0000
commit88ad6ed6179838d65a8c79c1867b8c1de2db3079 (patch)
tree927a6ccc9026d909a901963660b67e7dc210b9fb /Master/texmf-dist/doc/latex/bxpdfver/README.md
parent1b77359a5e97dbf40e82c6b0f4c5c70424dc2cba (diff)
bxpdfver (12feb17)
git-svn-id: svn://tug.org/texlive/trunk@43201 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bxpdfver/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/bxpdfver/README.md64
1 files changed, 43 insertions, 21 deletions
diff --git a/Master/texmf-dist/doc/latex/bxpdfver/README.md b/Master/texmf-dist/doc/latex/bxpdfver/README.md
index 2149826e3e0..e577a74252f 100644
--- a/Master/texmf-dist/doc/latex/bxpdfver/README.md
+++ b/Master/texmf-dist/doc/latex/bxpdfver/README.md
@@ -9,12 +9,14 @@ settings on the PDF document to output:
* PDF version (1.4, 1.5 etc.);
* whether or not to compress streams;
* whether or not to use object streams.
+ * precision of decimal numbers used in PDF commands
+ * whether or not to preserve (not shorten) PDF destination names
### SYSTEM REQUIREMENT
* TeX format: LaTeX.
* TeX engine: pdfTeX, XeTeX, LuaTeX, and any DVI-output engines.
- * DVI-ware: dvipdfmx.
+ * DVI-ware (in DVI mode): dvipdfmx.
* Required packages:
- atbegshi (when using dvipdfmx driver)
@@ -44,31 +46,14 @@ The available options are:
+ When using a PDF-output engine, you need not give driver options
since the appropriate one is auto-detected.
+ `dvipdfmx`: Uses dvipdfmx driver.
- + `disabled`: Disables all functions of the package.
+ + `disabled`/`nodvidriver`: Disables all functions of the package.
* `lenient`: Turns the errors for unsupported features into warnings.
Note that the options `compress` and `objcompress` mean that this
package *does not suppress* a feature. They do not activate a feature
when it is already suppressed by other means.
-### NOTE ON DRIVERS
-
- * pdfTeX and LuaTeX support all features.
- * When using XeTeX and dvipdfmx:
- - PDF version setting is always available.
- - Suppression of compression and suppression of object streams
- are available only when the version of (x)dvipdfmx is 20160307
- or later. Also shell escape must be accepted (with or without
- restriction), because external programs (such as kpsewhich)
- are invoked in order to detect the dvipdfmx version.
- * If you try to use unavailable features, an error will occur.
- * The package recognizes some “unsupported” driver options such as
- `dvips`; when such drivers are used, use of any feature will cause
- an error.
- * When `disabled` is used, use of any feature will do nothing (nor
- issue an error).
-
-### COMMANDS
+### USAGE
* `\setpdfversion{<version>}`: Sets PDF version.
Here `<version>` is either one of the following:
@@ -77,10 +62,47 @@ when it is already suppressed by other means.
the given file.
* `\suppresspdfcompression`: Suppresses stream compression.
* `\suppresspdfobjcompression`: Suppresses use of object streams.
+ * `\setpdfdecimaldigits{<precision>}`: Sets the precision (the number
+ of digits after decimal points) of the decimal numbers that appear
+ in PDF command sequences.
+ * `\preservepdfdestinations`: Stops shortening the PDF destination
+ names and uses the original names given in the TeX documents. This
+ is necessary for cross-document links to work correctly.
+
+### NOTE ON DRIVERS
+
+ \ Drivers (engines) pdfTeX dvipdfmx
+ Features / LuaTeX / XeTeX others
+ --------------------------- --------- --------- ------
+ \setpdfversion Yes Yes No
+ \suppresspdfcompression Yes Maybe(*2) No
+ \suppresspdfobjcompression Yes Maybe(*2) No
+ \setpdfdecimaldigits Yes Maybe(*2) No
+ \preservepdfdestinations No-op(*1) Maybe(*2) No
+
+ 1. In pdfTeX and LuaTeX, PDF destination names are never shortened;
+ that is, it can be thought as if `\preservepdfdestinations` were
+ always in effect.
+ 2. These features are available only when the version of (x)dvipdfmx
+ is 20160307 or later. Also shell escape must be accepted (with or
+ without restriction) so that `kpsewhich` and `extractbb` will be
+ allowed to run, because those programs are used in order to detect
+ the dvipdfmx version.
+
+More notices:
+
+ * If you try to use unavailable features, an error will occur.
+ * The package recognizes some “unsupported” driver options such as
+ `dvips`; when such drivers are used, use of any feature will cause
+ an error.
+ * When `disabled` is used, use of any feature will do nothing (nor
+ issue an error).
REVISION HISTORY
----------------
+ * Version 0.4 ‹2017/02/11›
+ - Add `\setpdfdecimaldigits` and `\preservepdfdestinations`.
* Version 0.3 ‹2016/08/11›
- Supported all features on dvipdfmx/XeTeX.
* Version 0.2b ‹2016/08/10›
@@ -93,4 +115,4 @@ REVISION HISTORY
--------------------
Takayuki YATO (aka. "ZR")
-http://zrbabbler.sp.land.to/
+https://github.com/zr-tex8r