CTAN Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/bxpdfver

README.md

BXpdfver Pack­age

: To spec­ify the ver­sion and com­pres­sion level of out­put PDF files

This pack­age en­ables users to spec­ify in their sources the fol­low­ing set­tings on the PDF doc­u­ment to out­put:

  • PDF ver­sion (1.4, 1.5 etc.);
    • whether or not to com­press streams;
    • whether or not to use ob­ject streams.
    • pre­ci­sion of dec­i­mal num­bers used in PDF com­mands
    • whether or not to pre­serve (not shorten) PDF des­ti­na­tion names

SYSTEM REQUIREMENT

  • for­mat: .
    • en­gine: pdf, , Lua, and any DVI-out­put en­gines.
    • DVI-ware (in DVI mode): dvipdfmx.
    • Re­quired pack­ages:
      • at­begshi (when us­ing dvipdfmx driver)

INSTALLATION

  • *.sty → $TEXMF/tex/la­tex/BXpdfver

LICENSE

This pack­age is dis­tributed un­der the MIT li­cense.

bx­pdfver pack­age

PACKAGE LOADING

\usepackage[<option>,...]{bxpdfver}

The avail­able op­tions are:

  • 1.4, 1.5, 1.6, or 1.7: Sets PDF ver­sion.
    • nocompress: Sup­presses stream com­pres­sion.
    • compress (de­fault): Does not sup­press stream com­pres­sion.
    • noobjcompress: Sup­presses use of ob­ject streams.
    • objcompress (de­fault): Does not sup­press use of ob­ject streams.
    • Driver op­tions: As be­low:
      • When us­ing a PDF-out­put en­gine, you need not give driver op­tions since the ap­pro­pri­ate one is auto-de­tected.
        • dvipdfmx: Uses dvipdfmx driver.
        • disabled/nodvidriver: Dis­ables all func­tions of the pack­age.
    • lenient: Turns the er­rors for un­sup­ported fea­tures into warn­ings.

Note that the op­tions compress and objcompress mean that this pack­age does not sup­press a fea­ture. They do not ac­ti­vate a fea­ture when it is al­ready sup­pressed by other means.

USAGE

  • \setpdfversion{<version>}: Sets PDF ver­sion. Here <version> is ei­ther one of the fol­low­ing:
    • 1.4, 1.5, 1.6, or 1.7; the ver­sion it­self.
      • the name of a PDF file; the ver­sion is set equal to that of the given file.
    • \suppresspdfcompression: Sup­presses stream com­pres­sion.
    • \suppresspdfobjcompression: Sup­presses use of ob­ject streams.
    • \setpdfdecimaldigits{<precision>}: Sets the pre­ci­sion (the num­ber of dig­its af­ter dec­i­mal points) of the dec­i­mal num­bers that ap­pear in PDF com­mand se­quences.
    • \preservepdfdestinations: Stops short­en­ing the PDF des­ti­na­tion names and uses the orig­i­nal names given in the doc­u­ments. This is nec­es­sary for cross-doc­u­ment links to work cor­rectly.

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 pdf and Lua, PDF des­ti­na­tion names are never short­ened; that is, it can be thought as if \preservepdfdestinations were al­ways in ef­fect.
  2. Th­ese fea­tures are avail­able only when the ver­sion of (x)dvipdfmx is 20160307 or later. Also shell es­cape must be ac­cepted (with or with­out re­stric­tion) so that kpsewhich and extractbb will be al­lowed to run, be­cause those pro­grams are used in or­der to de­tect the dvipdfmx ver­sion.

More no­tices:

  • If you try to use un­avail­able fea­tures, an er­ror will oc­cur.
    • The pack­age rec­og­nizes some “un­sup­ported” driver op­tions such as dvips; when such drivers are used, use of any fea­ture will cause an er­ror.
    • When disabled is used, use of any fea­ture will do noth­ing (nor is­sue an er­ror).

REVISION HISTORY

  • Ver­sion 0.4 ‹2017/02/11›
    • Add \setpdfdecimaldigits and \preservepdfdestinations.
    • Ver­sion 0.3 ‹2016/08/11›
      • Sup­ported all fea­tures on dvipdfmx/.
    • Ver­sion 0.2b ‹2016/08/10›
      • Added the lenient op­tion.
        • Sup­ported the newer ver­sion of Lua.
    • Ver­sion 0.2a ‹2015/08/05›
      • Mi­nor fix.
    • Ver­sion 0.2 ‹2014/07/04›
      • First pub­lic ver­sion.

Takayuki YATO (aka. "ZR") https://github.com/zr-tex8r

Down­load the con­tents of this pack­age in one zip archive (11.5k).

bx­pdfver – Spec­ify ver­sion and com­pres­sion level of out­put PDF files

This pack­age en­ables users to spec­ify in their sources the fol­low­ing set­tings on the PDF doc­u­ment to out­put:

  • PDF ver­sion (1.4, 1.5 etc.);
  • whether or not to com­press streams;
  • whether or not to use ob­ject streams.

This pack­age sup­ports all ma­jor PDF-out­put en­gines and dvipdfmx.

Pack­agebx­pdfver
Ver­sion0.4
Li­censesMIT Li­cense
Main­tainerTakayuki Yato
Con­tained inTeX Live as bx­pdfver
MiKTeX as bx­pdfver
TopicsPDF fea­tures
...
Guest Book Sitemap Contact Contact Author