summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bxpdfver
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
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')
-rw-r--r--Master/texmf-dist/doc/latex/bxpdfver/LICENSE8
-rw-r--r--Master/texmf-dist/doc/latex/bxpdfver/README-ja.md68
-rw-r--r--Master/texmf-dist/doc/latex/bxpdfver/README.md64
-rw-r--r--Master/texmf-dist/doc/latex/bxpdfver/sample-bxpdfver.tex3
4 files changed, 89 insertions, 54 deletions
diff --git a/Master/texmf-dist/doc/latex/bxpdfver/LICENSE b/Master/texmf-dist/doc/latex/bxpdfver/LICENSE
index 4acbc245013..8ada757fbc8 100644
--- a/Master/texmf-dist/doc/latex/bxpdfver/LICENSE
+++ b/Master/texmf-dist/doc/latex/bxpdfver/LICENSE
@@ -1,12 +1,6 @@
-$BK\%=%U%H%&%'%"$O(B MIT $B%i%$%;%s%9$N2<$GG[I[$5$l$^$9!#(B
-$BCx:n8"$O:n<T$G$"$k!VH,EP(B $B?rG7!JJLL>(B ZR$B!K!W$KB0$7$^$9!#(B
-$B$^$?K\%=%U%H%&%'%"$OL5J]>Z$G$9!#(B
-
-This software is distributed under the MIT License.
-
The MIT License
-Copyright (c) 2013 Takayuki YATO (aka. "ZR")
+Copyright (c) 2017 Takayuki YATO (aka. "ZR")
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/Master/texmf-dist/doc/latex/bxpdfver/README-ja.md b/Master/texmf-dist/doc/latex/bxpdfver/README-ja.md
index 368811e072b..dc466aa98bd 100644
--- a/Master/texmf-dist/doc/latex/bxpdfver/README-ja.md
+++ b/Master/texmf-dist/doc/latex/bxpdfver/README-ja.md
@@ -13,8 +13,8 @@ LaTeX 文書を PDF 文書に変換する際に出力 PDF に関する以下の
### 前提環境
* フォーマット: LaTeX
- * エンジン: 不問
- * DVIウェア: dvipdfmx、および PDF 出力のエンジン
+ * エンジン: pdfTeX、XeTeX、LuaTeX、および DVI 出力のエンジン
+ * DVIウェア(DVI出力時): dvipdfmx
* 依存パッケージ:
- atbegshi(dvipdfmx ドライバの場合)
@@ -45,48 +45,64 @@ bxpdfver パッケージ
+ PDF 出力のエンジンの場合は、既定で適切なドライバが選択される
のでドライバオプションは不要である。
+ `dvipdfmx`: dvipdfmx 用のドライバを指定する。
- + `disabled`: 全ての機能を無効化する。
+ + `disabled`/`nodvidriver`: 全ての機能を無効化する。
* `lenient`: サポートしない機能に対するエラーを警告に格下げする。
`compress`、`objcompress` はこのパッケージによる抑止を行わないという意味
であり、既に抑止されている場合にそれを再び有効化するものではない。
-### ドライバ指定
+### 機能
- * pdfTeX および LuaTeX では全ての機能が使用可能。
- * XeTeX および dvipdfmx の場合:
- - 「PDF バージョン指定」は無条件に使用可能。
- - 「オブジェクト圧縮抑止」および「オブジェクトストリーム抑止」の
- 機能を使用するためには、(x)dvipdfmx のバージョンが 20160307 以上
- である必要がある。またバージョン判定のために外部プログラムの
- 起動を利用するため、シェルエスケープが制限付許可または完全許可
- されている必要がある。
+ * `\setpdfversion{<バージョン>}`: 出力 PDF バージョンを指定する。
+ `<バージョン>` には以下の何れかを指定する。
+ + `1.4`、`1.5`、`1.6`、`1.7` の何れか。その値に設定する。
+ + PDF ファイルの名前。そのファイルのバージョンと同じ値に設定する。
+ * `\suppresspdfcompression`: ストリームの圧縮を抑止する。
+ * `\suppresspdfobjcompression`: オブジェクトストリームの使用を抑止
+ する。(実はこの指定自体は圧縮とは無関係であるが、pdfTeX エンジンの
+ プリミティブ `\pdfobjcompresslevel` に合わせた命令名を用いた。)
+ * `\setpdfdecimaldigits{<精度>}`: PDF 命令列中に現れる小数値の精度
+ (小数点以下の桁数)を指定する。
+ * `\preservepdfdestinations`: PDF 目的地(PDF destination)の名前の
+ 短縮を抑止し、TeX 文書で指定された名前を用いる。異なる PDF 文書間で
+ のリンクを正常に機能させるために必要である。
+
+### ドライバ指定に関する補足
+
+ \ 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. pdfTeX/LuaTeX では PDF 目的地の名前が短縮されるることはない。つまり
+ `\preservepdfdestinations` は常に有効になっていると見なせる。
+ 2. これらの機能を使用するためには、(x)dvipdfmx のバージョンが 20160307
+ 以上である必要がある。
+ - バージョン判定のために kpsewhich と extractbb の起動を利用する
+ ため、少なくともこれらのプログラムについて、シェルエスケープが
+ 許可されている必要がある。
- dvipdfmx のバージョン情報は補助ファイル(.aux)中にキャッシュ
される。このため、何か状況が変わった場合は、一旦補助ファイルを
削除する必要が生じる。
+
+以下のことにも注意されたい。
+
* 使用不可能な機能を使おうと試みるとエラーが発生する。
* `dvips` 等の“全く対応していない”若干のドライバオプションを認識
する。この場合、全ての機能の呼出でエラーが発生する。
* `disabled` は特殊で、これを指定した場合は、どの機能の呼出でも
エラーは発生しないが、全く何の動作も行わない。
-### 機能
-
- * `\setpdfversion{<バージョン>}`: 出力 PDF バージョンを指定する。
- `<バージョン>` には以下の何れかを指定する。
- + `1.4`、`1.5`、`1.6`、`1.7` の何れか。バージョンをその値に設定
- する。
- + PDF ファイルの名前。この場合、その PDF のバージョンと同じ値に
- 設定する。
- * `\suppresspdfcompression`: ストリームの圧縮を抑止する。
- * `\suppresspdfobjcompression`: オブジェクトストリームの使用を抑止
- する。(実はこの指定自体は圧縮とは無関係であるが、pdfTeX エンジンの
- プリミティブ `\pdfobjcompresslevel` に合わせた命令名を用いた。)
-
更新履歴
--------
+ * Version 0.4 ‹2017/02/11›
+ - `\setpdfdecimaldigits`、`\preservepdfdestinations` を追加。
* Version 0.3 ‹2016/08/11›
- dvipdfmx/XeTeX でも全ての機能がサポートされる。
* Version 0.2b ‹2016/08/10›
@@ -99,4 +115,4 @@ bxpdfver パッケージ
--------------------
Takayuki YATO (aka. "ZR")
-http://zrbabbler.sp.land.to/
+https://github.com/zr-tex8r
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
diff --git a/Master/texmf-dist/doc/latex/bxpdfver/sample-bxpdfver.tex b/Master/texmf-dist/doc/latex/bxpdfver/sample-bxpdfver.tex
index b421b75a3c9..41c795d1fef 100644
--- a/Master/texmf-dist/doc/latex/bxpdfver/sample-bxpdfver.tex
+++ b/Master/texmf-dist/doc/latex/bxpdfver/sample-bxpdfver.tex
@@ -6,6 +6,9 @@
noobjcompress% to suppress compression of strings for describing objects
]{bxpdfver}
%\setpdfversion{some.pdf}% to set output version equal to some other PDF file
+\setpdfdecimaldigits{4}% to set precision of decimals used in PDF commands
+%\setpdfpkresoluion{1200}% to set resolution (dpi) of PK bitmap fonts
+%\preservepdfdestinations % to preserve PDF destnation names as is
\begin{document}
Need to say hello {\TeX}!?
\end{document}