% interface=english modes=letter,screen output=pdftex % vim: tw=79 % $Id: pdftex-t.tex 655 2010-11-23 00:37:25Z karl $ % The number of lines on the titlepage depends on exactly % what \PDF\ code is generated. % \setvariables[pdftex][titlepagelines=55] %D We use a multi purpose style (using modes) that enable us %D to generate an A4, letter and screen version. %D %D Default A4 size manual: %D %D texexec --result=pdftex-a.pdf pdftex-t %D %D Letter size manual: %D %D texexec --mode=letter --result=pdftex-l.pdf pdftex-t %D %D Booklet (given that A4 document is available): %D %D texexec --pdfarrange --paper=a5a4 --print=up --addempty=1,2 --result=pdftex-b.pdf pdftex-a %D %D Screen version %D %D texexec --mode=screen pdftex-t %D This is the \PDFTEX\ manual, so it makes sense to force \PDF\ output here. \setupoutput [pdftex] %D ConTeXt defaults to 1.5; we want to be maximally compatible (and we don't %D use any features from 1.4++ anyway, do we?) \pdfminorversion=3 %D First we define ourselves some abbreviations, if only to force %D consistency and to save typing. We use real small capitals, not pseudo %D ones. \setupsynonyms [abbreviation] [textstyle=smallcaps, style=smallcaps, location=left, width=broad, sample=\POSTSCRIPT] \setupcapitals [title=no] \def\svnscan $#1 #2 #3 #4-#5-#6 #7${ \def\rcsrevision{#3} \def\rcsyear{#4} \def\rcsmonth{#5} \def\rcsday{{\count0=#6\relax\the\count0}} \def\rcsmonthname{\ifcase\rcsmonth ERROR\or January\or February\or March\or April\or May\or June\or July\or August\or September\or October\or November\or December\else ERROR\fi} } \svnscan $Id: pdftex-t.tex 655 2010-11-23 00:37:25Z karl $ \def\currentpdftex{1.40.11} %*********************************************************************** \def\eTeX{{$\varepsilon$}-\kern-.125em\TeX} \def\eg{e.\,g.} \def\Eg{E.\,g.} \def\PDFReference{PDF Reference} % PDF with capital letters \abbreviation [AFM] {afm} {Adobe Font Metrics} %\abbreviation [AMIGA] {Amiga} {Amiga hardware platform} %\abbreviation [AMIWEB] {AmiWeb2c} {\AMIGA\ distribution} \abbreviation [BIBTEX] {Bib\TeX} {Handles bibliographies} \abbreviation [ASCII] {ascii} {American Standard Code for Information Interchange} \abbreviation [CONTEXT] {\ConTeXt} {general purpose macro package} \abbreviation [CTAN] {ctan} {global \TEX\ archive server} %\abbreviation [DJGPP] {djgpp} {DJ Delorie's \GNU\ Programming Platform} \abbreviation [DVI] {dvi} {native \TEX\ Device Independent file format} \abbreviation [ENCTEX] {enc\TeX} {enc\TeX\ extension to \TEX} \abbreviation [EPSTOPDF] {epstopdf} {\EPS\ to \PDF\ conversion tool} \abbreviation [EPS] {eps} {Encapsulated PostScript} \abbreviation [ETEX] {\eTeX} {an extension to \TEX} \abbreviation [EXIF] {exif} {Exchangeable Image File format (JPEG file variant)} \abbreviation [FPTEX] {fp\TeX} {\WIN\ \WEBC\ distribution} \abbreviation [GHOSTSCRIPT] {Ghostscript} {\PS\ and \PDF\ language interpreter} \abbreviation [GNU] {gnu} {GNU's Not Unix} \abbreviation [HZ] {hz} {Hermann Zapf optimization} \abbreviation [ISO] {iso} {International Organization for Standardization} \abbreviation [JBIG] {jbig} {Joint Bi-level Image Experts Group} \abbreviation [JBIGTWO] {jbig2} {Joint Bi-level Image Experts Group} \abbreviation [JPEG] {jpeg} {Joint Photographic Experts Group} \abbreviation [LATEX] {\LaTeX} {general purpose macro package} \abbreviation [MAC] {Macintosh} {Macintosh hardware platform} \abbreviation [MACOSX] {Mac\,OS\,X} {Macintosh operating system version 10} \abbreviation [MACTEX] {Mac\TeX} {\MAC\ \WEBC\ distribution} \abbreviation [MDFIVE] {md5} {MD5 message-digest algorithm} \abbreviation [METAFONT] {\MetaFont} {graphic programming environment, bitmap output} \abbreviation [METAPOST] {\MetaPost} {graphic programming environment, vector output} \abbreviation [MIKTEX] {MiK\TeX} {\WIN\ distribution} \abbreviation [MLTEX] {ml\TeX} {ML\TeX\ extension to \TEX} \abbreviation [MPTOPDF] {mptopdf} {\METAPOST\ to \PDF\ conversion tool} \abbreviation [MSDOS] {ms-dos} {Microsoft DOS platform (Intel)} \abbreviation [PDFETEX] {pdfe\TeX} {\ETEX\ extension producing \PDF\ output} \abbreviation [PDFLATEX] {pdf\LaTeX} {\TEX\ extension producing \PDF\ output (\LATEX\ format loaded)} \abbreviation [PDFTEX] {pdf\TeX} {\TEX\ extension producing \PDF\ output} \abbreviation [PDF] {pdf} {Portable Document Format} \abbreviation [PERL] {Perl} {Perl programming environment} \abbreviation [PFA] {PFA} {Adobe PostScript Font format (ASCII)} \abbreviation [PFB] {PFB} {Adobe PostScript Font format (Binary)} \abbreviation [PGC] {pgc} {\PDF\ Glyph Container} \abbreviation [PK] {pk} {Packed bitmap font} \abbreviation [PNG] {png} {Portable Network Graphics} \abbreviation [POSIX] {posix} {Portable Operating System Interface} \abbreviation [PROTEXT] {pro\TeX t} {\WIN\ \WEBC\ distribution based on \MIKTEX} \abbreviation [PS] {ps} {PostScript} \abbreviation [POSTSCRIPT] {PostScript} {PostScript} \abbreviation [PSTOPDF] {PStoPDF} {PostScript to \PDF\ converter (on top of \GHOSTSCRIPT)} \abbreviation [RGB] {rgb} {Red Green Blue color specification} \abbreviation [TCX] {tcx} {\TEX\ Character Translation} \abbreviation [TDS] {tds} {\TEX\ Directory Standard} \abbreviation [TETEX] {te\TeX} {\TEX\ distribution for \UNIX\ (based on \WEBC)} \abbreviation [TEXEXEC] {\TeX exec} {\CONTEXT\ command line interface} \abbreviation [TEXINFO] {Texinfo} {generate typeset documentation from info pages} \abbreviation [TEXUTIL] {\TeX util} {\CONTEXT\ utility tool} \abbreviation [TEX] {\TeX} {typographic language and program} \abbreviation [TEXLIVE] {\TeX\ Live} {\TeX\ Live distribution (multiple platform)} \abbreviation [TFM] {tfm} {\TEX\ Font Metrics} \abbreviation [TIF] {tiff} {Tagged Interchange File format} \abbreviation [TUG] {tug} {\TEX\ Users Group} \abbreviation [UNIX] {Unix} {Unix platform} \abbreviation [URL] {url} {Uniform Resource Locator} \abbreviation [WEBC] {Web2c} {official multi||platform \WEB\ environment} \abbreviation [WEB] {web} {literate programming environment} \abbreviation [WIN] {Windows} {Microsoft Windows platform} \abbreviation [XEMTEX] {XEm\TeX} {\WIN\ \WEBC\ distribution} \abbreviation [ZIP] {zip} {compressed file format} %D It makes sense to predefine the name of the author of \PDFTEX, doesn't it? \def\THANH{H\`an Th\^e\llap{\raise 0.5ex\hbox{\'{}}} Th\`anh} %D Because they are subjected to change and tend to spoil the visual %D appearance of the \TEX\ source, \URL's are defined here. \useURL [ptex_org] [http://www.pdftex.org] % links to ptex_examples \useURL [ptex_ctan] [http://mirror.ctan.org/systems/pdftex] \useURL [ptex_devel] [http://foundry.supelec.fr/gf/project/pdftex] % where bug reports should go: \useURL [ptex_bugs] [mailto:pdftex@tug.org] [] [pdftex@tug.org] % anything else pdftex related: \useURL [ptex_list] [mailto:pdftex@tug.org] [] [pdftex@tug.org] \useURL [texlive] [http://tug.org/texlive/] \useURL [ctan_systems] [http://mirror.ctan.org/systems] \useURL [win32] [http://mirror.ctan.org/systems/win32] \useURL [context] [http://www.pragma-ade.com] \useURL [tex_showcase] [http://tug.org/texshowcase] \useURL [pdfreference] [http://www.adobe.com/devnet/pdf/pdf_reference.html] \useURL [thanh_truetype_tub] [http://tug.org/TUGboat/tb30-1/tb94thanh.pdf] \useURL [jbig2enc] [https://github.com/agl/jbig2enc] %D The primitive definitions are specified a bit fuzzy using the next set of %D commands. Some day I'll write some proper macros to deal with this. % keep next 2 lines as temporary kludge for a while to make \type{} of % older ConTeXt versions handle these two new primitives; the original % problem with \type{} is already solved in ConTeXt as of 2006-02-14. \let\ifpdfabsnum\relax \let\ifpdfabsdim\relax \def\Sugar #1{\unskip\unskip\unskip\kern.25em{#1}\kern.25em\ignorespaces} \def\Something#1{\Sugar{\mathematics{\langle\hbox{#1}\rangle}}} \def\Lbrace {\Sugar{\tttf\leftargument}} \def\Rbrace {\Sugar{\tttf\rightargument}} \def\Or {\Sugar{\mathematics{\vert}}} \def\Optional #1{\Sugar{\mathematics{[\hbox{#1}]}}} \def\Means {\Sugar{\mathematics{\rightarrow}}} \def\Tex #1{\Sugar{\type{#1}}} \def\Literal #1{\Sugar{\type{#1}}} \def\Syntax #1{\strut\kern-.25em{#1}\kern-.25em} \def\Next {\crlf\hbox to 2em{}\nobreak} \def\Whatever #1{\Sugar{\mathematics{(\hbox{#1})}}} % hyphenates \def\Something#1{\Sugar{\mathematics{\langle}\prewordbreak {#1}\prewordbreak\mathematics{\rangle}}} % Break after these chars in urls, not before. \sethyphenatedurlafter / \sethyphenatedurlafter . \sethyphenatedurlafter _ % introduced \def\introduced#1{The primitive was introduced in \PDFTEX\ #1.} % to get bookmarks for primitives like \ifpdfprimitive \appendtoks\def\tex#1{\string\\#1}\to\simplifiedcommands %D We typeset the \URL's in a monospaced font. \setupurl [style=type] %D The basic layout is pretty simple. Because we want non european readers to %D read the whole text as well, a letter size based alternative is offered %D too. Mode switching is taken care of at the command line when running %D \TEXEXEC. \startmode[letter] \setuppapersize [letter][letter] \stopmode \setuplayout [topspace=1.5cm, backspace=2.5cm, leftmargin=2.5cm, width=middle, footer=1.5cm, header=1.5cm, height=middle] %D For the moment we use the description mechanism to typeset keywords etc. %D Well, I should have used capitals. \definedescription [description] [location=serried, width=broad] \definedescription [PathDescription] [location=left, sample=TEXPSHEADERS, width=broad, headstyle=type] \definehead [pdftexprimitive] [subsubsection] \setuphead [pdftexprimitive] [style=, before=\blank, after=\blank, numbercommand=\SubSub] %D This is typically a document where we want to save pages, %D so we don't start any matter (part) on a new page. \setupsectionblock [frontpart] [page=] \setupsectionblock [bodypart] [page=] \setupsectionblock [backpart] [page=] %D The \type{\SubSub} command is rather simple and generates a triangle. %D This makes the primitives stand out a bit more. \def\SubSub#1{\mathematics{\blacktriangleright}} %D But, for non Lucida users, the next one is more safe: \def\SubSub#1{\goforwardcharacter} %D I could have said: %D %D \starttyping %D \setupsection[section-5][previousnumber=no,bodypartconversion=empty] %D \setuplabeltext[subsubsection=\mathematics{\blacktriangleright}] %D \stoptyping %D %D but this is less clear. %D We use white space, but not too much. \setupwhitespace [medium] \setupblank [medium] %D Verbatim things get a small margin. \setuptyping [margin=standard] \definetyping [esctyping] \setuptyping [esctyping] [margin=standard,option=commands,escape=@] %D Due to the lots of verbatim we will be a bit more tolerant in breaking %D paragraphs into lines. \setuptolerance [verytolerant,stretch] %D We put the chapter and section numbers in the margin and use bold fonts. \setupheads [alternative=margin] \setuphead [section] [style=\bfb] \setuphead [subsection] [style=\bfa] %D The small table of contents is limited to section titles and is fully %D interactive. \setuplist [section] [criterium=all, interaction=all, width=2em, aligntitle=yes, alternative=a] %D Ah, this manual is in english! \mainlanguage [en] %D We use Palatino fonts, because they look so well on the screen. The %D version generated at \PRAGMA\ uses Optima Nova instead. Both fonts are %D designed by Hermann Zapf. \setupfonthandling [hz] [min=25,max=25,step=5] \setupalign [hz,hanging] \startnotmode[atpragma] \setupfontsynonym [Serif] [handling=quality] \setupfontsynonym [SerifBold] [handling=quality] \setupfontsynonym [SerifSlanted] [handling=quality] \setupfontsynonym [SerifItalic] [handling=quality] \setupfontsynonym [SerifBoldSlanted] [handling=quality] \setupfontsynonym [SerifBoldItalic] [handling=quality] %setupfontsynonym [Mono] [handling=quality] % sloooow % We use adobe metrics instead of urw metrics because tetex only % ships the former. Beware, these metrics differ! \loadmapfile[context-base.map] \usetypescript [adobekb] [\defaultencoding] \usetypescript [palatino][\defaultencoding] \setupbodyfont [palatino,10pt] \definefontsynonym[TitleFont][SerifBold] \stopnotmode \startmode[atpragma] \usetypescriptfile[type-ghz] \setupfontsynonym [Sans] [handling=quality] \setupfontsynonym [SansBold] [handling=quality] \setupfontsynonym [SansSlanted] [handling=quality] \setupfontsynonym [SansItalic] [handling=quality] \setupfontsynonym [SansBoldSlanted] [handling=quality] \setupfontsynonym [SansBoldItalic] [handling=quality] %setupfontsynonym [Mono] [handling=quality] % sloooow \definetypeface[optima][ss][sans][optima-nova] [default][encoding=\defaultencoding] \definetypeface[optima][tt][mono][latin-modern][default][encoding=\defaultencoding,rscale=1.1] \setupbodyfont[optima,10pt,ss] \definefontsynonym[TitleFont][SansBold] \stopmode %D This document is mildly interactive. Yes, Thanh's name will end up ok in %D the document information data. \setupinteraction [state=start, style=normal, color=, page=yes, openaction=firstpage, title=the pdfTeX users manual, author={H\`an Th\^e Th\`anh, Sebastian Rahtz, Hans Hagen, Hartmut Henkel, Pawe\l\ Jackowski, Martin Schr\"oder}] \setupinteractionscreen % still needed? \startnotmode[screen] \setupinteractionscreen [option=bookmark] \stopnotmode %D Some headers and footers will complete the layout. \setupheadertexts [The pdf\TeX\ user manual] \setupfootertexts [pagenumber] %D For Tobias Burnus, who loves bookmarks, I've enabled them. \placebookmarks [section,subsection,pdftexprimitive] %D Let's also define a screen layout: \startmode[screen] \environment pdftex-i \stopmode %D We auto-cross link the paper and screen version: \startnotmode[screen] %\coupledocument % [screenversion] % [pdftex-s] % [section,subsection,subsubsection,pdftexprimitive] % [the screen version] \setuphead [section,subsection,subsubsection,pdftexprimitive] [file=screenversion] \setuplist [section] [alternative=c] \stopnotmode %D The text starts here! \starttext %D Being lazy, I don't split the file, so paper and screen get %D mixed in one document. \startmode[screen] \getbuffer[screen] \stopmode \startnotmode[screen] %D But first we typeset the title page. It has a background. This %D background, showing a piece of \PDF\ code, will be referred to %D later on. %D We can use more modern \CONTEXT\ features, but for the moment %D stick to the old style and methods. \NormalizeFontWidth \TitleFont {\hskip.5mm The pdf\TeX\ user manual} % \hskip is fake offset \paperheight {TitleFont} \setupbackgrounds [page] [background={title,joke,names,content}] \defineoverlay [title] [\hbox to \paperwidth {\hfill \TitleFont\setstrut \rotate{The pdf\TeX\ user manual}% \hskip.5cm}] % \dp\strutbox}] % \defineoverlay % [joke] % [\hbox to \paperwidth % {\TitleFont\setstrut % \dimen0=\overlaywidth % \advance\dimen0 by -\ht\strutbox % \advance\dimen0 by -\dp\strutbox % \advance\dimen0 by -1cm % \dimen2=\overlayheight % \advance\dimen2 by -1cm % \hskip.5cm\expanded{\externalfigure % [pdftex-z.pdf] % [width=\the\dimen0,height=\the\dimen2]}% % \hfill}] % \defineoverlay % [names] % [\vbox to \paperheight % {\dontcomplain % \TitleFont\setstrut % \setbox0=\hbox{\TeX}% % \hsize\paperwidth % \rightskip\ht0 % \advance\rightskip\dp\strutbox % \advance\rightskip\dp\strutbox % \bfa \setupinterlinespace % \vfill % \hfill \THANH \endgraf % \hfill Sebastian Rahtz \endgraf % \hfill Hans Hagen % \hfill Hartmut Henkel % \hfill Pawe\l\ Jackowski % \vskip 1ex % \hfill \currentdate % \vskip 2ex}] \defineoverlay [content] [\overlaybutton{contents}] % title page \definelayout [titlepage] [backspace=.5cm, cutspace=3.5cm, topspace=.5cm, bottomspace=.5cm, header=0pt, footer=0pt, lines=\getvariable{pdftex}{titlepagelines}, grid=yes, width=middle] \definecolumnset [titlepage] [n=2,distance=0.2cm] \start \chardef\fontdigits=2 \switchtobodyfont[12pt,tt] \setupinterlinespace[line=\dimexpr((\paperheight-1cm)/\getvariable{pdftex}{titlepagelines})] \setuptyping[margin=,color=] \setuplayout[titlepage] \startcolumnset[titlepage] \typefile{pdftex-t.txt} \stopcolumnset \page \setuplayout \stop % \startstandardmakeup % % %D The titlepage is generated using the background overlay mechanism. This % %D saves me the trouble of determining funny skips and alignments. So no text % %D goes here. % % \stopstandardmakeup \setupbackgrounds [page] [background=] %D The inside title page is as follows. \startstandardmakeup[footerstate=none] \dontcomplain \setupalign[left] \start \bfd The pdf\TeX\ user manual \bfa \setupinterlinespace \vskip4ex \THANH\par Sebastian Rahtz\par Hans Hagen\par Hartmut Henkel\par Pawe\l\ Jackowski\par Martin Schr\"oder\par \vskip3ex \rcsmonthname\ \rcsday, \rcsyear\par \vskip1ex Rev.\ \rcsrevision \stop \vfill \startlines The title page is the result of this plain \TeX\ text: \stoplines \blank[2*big] \setuptyping[after=] \starttyping \pdfoutput=1 \pdfcompresslevel=0 \pdfobjcompresslevel=0 \pdfmapline{ptmr8r Times-Roman <8r.enc} \font\tenrm=ptmr8r \tenrm Welcome to pdf\TeX! \bye \stoptyping \stopstandardmakeup \setuppagenumber[number=1] % added in case of single sided usage %D So far for non screen mode. \stopnotmode %D We start with a small table of contents, typeset in double column format. \startfrontmatter \subject[contents]{Contents} \startcolumns[distance=3em] \placelist[section] \stopcolumns \stopfrontmatter %D And here it is: the main piece of text. \startbodymatter %*********************************************************************** \section{Introduction} The main purpose of the \PDFTEX\ project is to create and maintain an extension of \TEX\ that can produce \PDF\ directly from \TEX\ source files and improve|/|enhance the result of \TEX\ typesetting with the help of \PDF. When \PDF\ output is not selected, \PDFTEX\ produces normal \DVI\ output, otherwise it generates \PDF\ output that looks identical to the \DVI\ output. An important aspect of this project is to investigate alternative justification algorithms (\eg\ a font expansion algorithm akin to the \HZ\ micro||typography algorithm by Prof.~Hermann Zapf), optionally making use of Multiple Master fonts. \PDFTEX\ is based on the original \TEX\ sources and \WEBC, and has been successfully compiled on \UNIX, \WIN\ and \MSDOS\ systems. It is actively maintained, with new features trickling in. Great care is taken to keep new \PDFTEX\ versions backward compatible with earlier ones. For some years there has been a \quote {moderate} successor to \TEX\ available, called \ETEX. Because mainstream macro packages such as \LATEX\ have started supporting this welcome extension, the \ETEX\ functionality has also been integrated into the \PDFTEX\ code. For a while (\TEXLIVE~2004 and~2005) \PDFTEX\ therefore came in two flavours: the \ETEX\ enabled \PDFETEX\ engine and the standard one, \PDFTEX. The ability to produce both \PDF\ and \DVI\ output made \PDFETEX\ the primary \TEX\ engine in these distributions. Since \PDFTEX\ version 1.40 now the \ETEX\ extensions are part already of the \PDFTEX\ engine, so there is no longer any need to ship \PDFETEX. The \ETEX\ functionality of \PDFTEX\ can be disabled if not required. Other extensions are \MLTEX\ and \ENCTEX; these are also included in the current \PDFTEX\ code. \PDFTEX\ is maintained by \THANH, Martin Schr\"oder, Hans Hagen, Taco Hoekwater, Hartmut Henkel, and others. The \PDFTEX\ homepage is \from [ptex_org]. Please send \PDFTEX\ comments and bug reports to the mailing list \from [ptex_bugs]. We thank all readers who send us corrections and suggestions. We also wish to express the hope that \PDFTEX\ will be of as much use to you as it is to us. Since \PDFTEX\ is still being improved and extended, we strongly suggest tracking updates. %*********************************************************************** \subsection{About this manual} This manual revision (\rcsrevision) tries to keep track with the recent \PDFTEX\ development up to version \currentpdftex. Main text updates were done regarding the new configuration scheme, font mapping, and new or updated primitives. The primary repository for the manual and its sources is at \from[ptex_devel]. Copies in \PDF\ format can also be found on \CTAN\ in \from[ptex_ctan]. Thanks to the many people who have contributed to the manual. New errors might have slipped in afterwards by the editor. Please send questions or suggestions by email to \from[ptex_bugs]. %*********************************************************************** \subsection{Legal Notice} Copyright \copyright\ 1996||2010 \THANH. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''. %*********************************************************************** \section{About \PDF} The cover of this manual lists an almost minimal \PDF\ file generated by \PDFTEX, from the corresponding source on the next page. Since compression is not enabled, such a \PDF\ file is rather verbose and readable. The first line specifies the version used. \PDF\ viewers are supposed to silently skip over all elements they cannot handle. A \PDF\ file consists of objects. These objects can be recognized by their number and keywords: \starttyping 9 0 obj << /Type /Catalog /Pages 5 0 R >> endobj \stoptyping Here \typ{9 0 obj ... endobj} is the object capsule. The first number is the object number. The sequence \type{5 0 R} is an object reference, a pointer to another object (no.~5). The second number (here a zero) is currently not used in \PDFTEX; it is the version number of the object. It is for instance used by \PDF\ editors, when they replace objects by new ones. When a viewer opens a \PDF\ file, it goes to the end of the file, looking for the keyword \type{startxref}. The number after \type{startxref} gives the absolute position (byte offset from the file start) of the so called \quote {object cross-reference table} that begins with the keyword \type{xref}. This table in turn tells the byte offsets of all objects that make up the \PDF\ file, providing fast random access to the individual objects (here the \type{xref} table shows 11~objects, numbered from~0 to~10; the object no.~0 is always unused). The actual starting point of the file's object structure is defined after the \type{trailer}: The \type{/Root} entry points to the \type{/Catalog} object (no.~9). In this object the viewer can find the pointer \type{/Pages} to the page list object (no.~5). In our example we have only one page. The trailer also holds an \type{/Info} entry, which points to an object (no.~10) with a bit more about the document. Just follow the thread: \startnarrower \type{/Root} $\longrightarrow$ object~9 $\longrightarrow$ \type{/Pages} $\longrightarrow$ object~5 $\longrightarrow$ \type{/Kids} $\longrightarrow$ object~2 $\longrightarrow$ \type{/Contents} $\longrightarrow$ object~3 \stopnarrower As soon as we add annotations, a fancy word for hyperlinks and the like, some more entries will be present in the catalog. We invite users to take a look at the \PDF\ code of this file to get an impression of that. The page content is a stream of drawing operations. Such a stream can be compressed, where the level of compression can be set with \type {\pdfcompresslevel} (compression is switched off for the title page). Let's take a closer look at this stream in object~3. Often (but not in our example) there is a transformation matrix, six numbers followed by \type{cm}. As in \POSTSCRIPT, the operator comes after the operands. Between \type{BT} and \type{ET} comes the text. A font is selected by a \type{Tf} operator, which is given a font resource name \type{/F..} and the font size. The actual text goes into \type{()} bracket pairs so that it creates a \POSTSCRIPT\ string. The numbers in bracket pairs provide horizontal movements like spaces and fine glyph positioning (kerning). When one analyzes a file produced by a less sophisticated typesetting engine, whole sequences of words can be recognized. In \PDF\ files generated by \PDFTEX\ however, many words come out rather fragmented, mainly because a lot of kerning takes place; in our example the \type{80} moves the text \type{(elcome)} left towards the letter \type{(W)} by 80/1000 of the font size. \PDF\ viewers in search mode simply ignore the kerning information in these text streams. When a document is searched, the search engine reconstructs the text from these (string) snippets. Every \type{/Page} object points also to a \type{/Resources} object (no.~1) that gives all ingredients needed to assemble the page. In our example only a \type{/Font} object (no.~4) is referenced, which in turn tells that the text is typeset in \type{/Font} \type{/Times-Roman}. The \type{/Font} object points also to a \type{/Widths} array (object no.~7) that tells for each character by how much the viewer must move forward horizontally after typesetting a glyph. More details about the font can be found in the \type{/FontDescriptor} object (no.~8); if a font file is embedded, this object points to the font program stream. But as the Times-Roman font used for our example is one of the 14 so||called standard fonts that should always be present in any \PDF\ viewer and therefore need not be embedded in the \PDF\ file, it is left out here for brevity. However, when we use for instance a Computer Modern Roman font, we have to make sure that this font is later available to the \PDF\ viewer, and the best way to do this is to embed the font. It's highly recommended nowadays to embed even the standard fonts, as modern viewers often don't use the original 14~standard fonts anymore, but instead approximate them by instances of built||in Multiple Master fonts (\eg\ the Adobe Reader~7 approximates the Times-Roman variants by the Minion font). So you never really know how it looks exactly at the viewer side unless you embed every font. In this simple file we don't specify in what way the file should be opened, for instance full screen or clipped. A closer look at the page object no.~2 (\typ{/Type /Page}) shows that a mediabox (\typ{/MediaBox}) is part of the page description. A mediabox acts like the (high-resolution) bounding box in a \POSTSCRIPT\ file. \PDFTEX\ users can add dictionary stuff to page objects by the \type{\pdfpageattr} primitive. Although in most cases macro packages will shield users from these internals, \PDFTEX\ provides access to many of the entries described here, either automatically by translating the \TEX\ data structures into \PDF\ ones, or manually by pushing entries to the catalog, page, info or self-created objects. One can for instance create an object by using \type{\pdfobj} after which \type{\pdflastobj} returns its number. So \starttyping \pdfobj{<< /Type/ExtGState /LW 2 >>} \stoptyping inserts an object into the \PDF\ file (it creates a ``graphics state'' object setting the line width to 2~units), and \type{\pdflastobj} now returns the number \PDFTEX\ assigned to this object. Unless objects are referenced by others, they will just end up as isolated entities, not doing any real harm but bloating the \PDF\ file. In general this rather direct way of pushing objects in the \PDF\ files by primitives like \type{\pdfobj} is not very useful, and only makes sense when implementing, say, fill||in field support or annotation content reuse. We will come to that later. For those who want to learn more about the gory \PDF\ details, the best bet is to read the \PDFReference. As of the time of writing you can download this book as a big \PDF\ file from Adobe's \PDF\ Technology Center, \from[pdfreference] --- or get the heavy paper version. Those who, after this introduction, feel unsure how to proceed, are advised to read on but skip \in{section}[primitives]. Before we come to that section, we will describe how to get started with \PDFTEX. %*********************************************************************** \section{Getting started} This section describes the steps needed to get \PDFTEX\ running on a system where \PDFTEX\ is not yet installed. Nowadays virtually all \TEX\ distributions have \PDFTEX\ as a component, such as \TEXLIVE, \TETEX, \XEMTEX, \MIKTEX, \PROTEXT, and \MACTEX. The ready to run \TEXLIVE\ distribution comes with \PDFTEX\ versions for many \UNIX, \WIN, and \MACOSX\ systems; more information can be found at \hbox{\from[texlive].} There are also \WIN-specific distributions which contain \PDFTEX, under \from[win32]: \MIKTEX\ by Christian Schenk, and \PROTEXT\ (based on \MIKTEX) by Thomas Feuerstack. When you use any of these distributions, you don't need to bother with the \PDFTEX\ installation procedure in the next sections. If there is no precompiled \PDFTEX\ binary for your system, or the version coming with a distribution is not the current one and you would like to try out a fresh \PDFTEX\ immediately, you will need to build \PDFTEX\ from sources; read on. You should already have a working \TEX\ system, \eg\ \TEXLIVE\ or \TETEX, into which the freshly compiled \PDFTEX\ will be integrated. Note that the installation description in this manual is \WEBC||specific. %*********************************************************************** \subsection{Getting sources and binaries} The latest sources of \PDFTEX\ are currently distributed for compilation on \UNIX\ systems (including \GNU/Linux), and \WIN\ systems. The primary home page is \from[ptex_org], where you also find bug tracking information. Development sources are at \from[ptex_devel]. The \PDFTEX\ sources can also be found at their canonical place in the \CTAN\ network, \from[ptex_ctan]. Separate \PDFTEX\ binaries for various systems might also be available, check out the subdirectories below \from[ctan_systems]. %*********************************************************************** \subsection{Compiling} The compilation is expected to be easy on \UNIX||like systems and can be described best by example. Assuming that the file \filename {pdftex.zip} is downloaded to some working directory, \eg\ \filename {\$HOME/pdftex}, on a \UNIX\ system the following steps are needed to compile \PDFTEX: \startesctyping cd $HOME/pdftex unzip pdftex-@currentpdftex.zip cd pdftex-@currentpdftex ./build.sh \stopesctyping The binary \filename{pdftex} is then built in the subdirectory \filename{build/texk/web2c}. In the same directory also the corresponding pool file \filename{pdftex.pool} is generated; it's needed for creating the format files. The obsolescent binary \filename{pdfetex} is still generated for backward compatibility, but since version 1.40 it is just a file copy of the file \filename{pdftex}. Together with the \filename{pdftex} binary also the \filename{pdftosrc} and \filename{ttf2afm} binaries are generated. %*********************************************************************** \subsection{Placing files} The next step is to put the freshly compiled \filename{pdftex}, \filename{pdftosrc}, and \filename{ttf2afm} binaries and the pool file \filename{pdftex.pool} into their proper places within the \TDS\ structure of the \TEX\ system. Put the binary files into the binary directory (\eg\ for a typical \TEXLIVE\ system) \filename{/usr/local/texlive/2010/bin/x86_64-linux}, and the pool file into \filename{/usr/local/texlive/2010/texmf/web2c}. Don't forget to do a \filename{texconfig-sys init} afterwards, so that all formats are regenerated system-wide with the fresh \filename{pdftex} binary. %*********************************************************************** \subsection{Setting search paths} \WEBC||based programs, including \PDFTEX, use the \WEBC\ run||time configuration file called \filename {texmf.cnf}. The location of this file is the appropriate position within the \TDS\ tree relative to the place of the \PDFTEX\ binary; on a \TEXLIVE\ system, file \filename{texmf.cnf} typically is located either in directory \filename{texmf/web2c} or \filename{texmf-local/web2c}. The path to file \filename{texmf.cnf} can also be set up by the environment variable \type{TEXMFCNF}. Next you might need to edit \filename {texmf.cnf} so that \PDFTEX\ can find all necessary files, but the \filename{texmf.cnf} files coming with the major \TEX\ distributions should already be set up for normal use. You might check into the file \filename{texmf.cnf} to see where the various bits and pieces are going. \PDFTEX\ uses the search path variables shown in \in{table}[tbl:spathvar]. \startbuffer \starttabulate[|l|l|] \HL \NC \bf used for \NC \bf texmf.cnf \NC\NR \HL \NC output files \NC \type{TEXMFOUTPUT} \NC\NR \NC input files, images \NC \type{TEXINPUTS} \NC\NR \NC format files \NC \type{TEXFORMATS} \NC\NR \NC text pool files \NC \type{TEXPOOL} \NC\NR \NC encoding files \NC \type{ENCFONTS} \NC\NR \NC font map files \NC \type{TEXFONTMAPS} \NC\NR \NC \TFM\ files \NC \type{TFMFONTS} \NC\NR \NC virtual fonts \NC \type{VFFONTS} \NC\NR \NC type1 fonts \NC \type{T1FONTS} \NC\NR \NC TrueType fonts \NC \type{TTFONTS} \NC\NR \NC OpenType fonts \NC \type{OPENTYPEFONTS} \NC\NR \NC pixel fonts \NC \type{PKFONTS} \NC\NR \HL \stoptabulate \stopbuffer \placetable[here][tbl:spathvar] {The \WEBC\ variables.} {\getbuffer} \PathDescription {TEXMFOUTPUT} Normally, \PDFTEX\ puts its output files in the current directory. If any output file cannot be opened there, it tries to open it in the directory specified in the environment variable \type{TEXMFOUTPUT}. There is no default value for that variable. For example, if you type \type{pdftex paper} and the current directory is not writable, if \type{TEXMFOUTPUT} has the value \type{/tmp}, \PDFTEX\ attempts to create \type{/tmp/paper.log} (and \type{/tmp/paper.pdf}, if any output is produced.) \PathDescription {TEXINPUTS} This variable specifies where \PDFTEX\ finds its input files. Image files are considered input files and searched for along this path. \PathDescription {TEXFORMATS} Search path for format (\type{.fmt}) files. \PathDescription {TEXPOOL} Search path for pool (\type{.pool}) files. \PathDescription {ENCFONTS} Search path for encoding (\type{.enc}) files. \PathDescription {TEXFONTMAPS} Search path for font map (\type{.map}) files. \PathDescription {TFMFONTS} Search path for font metric (\type{.tfm}) files. \PathDescription {VFFONTS} Search path for virtual font (\type{.vf}) files. Virtual fonts are fonts made up of other fonts. Because \PDFTEX\ produces the final output code, it must consult those files. \PathDescription {T1FONTS} Search path for Type~1 font files (\type{.pfa} and \type{.pfb}). These outline (vector) fonts are to be preferred over bitmap \PK\ fonts. In most cases Type~1 fonts are used and this variable tells \PDFTEX\ where to find them. \PathDescription {TTFONTS,\hfil\break \hbox{OPENTYPEFONTS}} Search paths for TrueType (\type{.ttf}) and OpenType (\type{.otf}) font files. Like Type~1 fonts, TrueType and OpenType fonts are also outlines. \PathDescription {PKFONTS} Search path for packed (bitmap) font (\type{.pk}) files. Unfortunately bitmap fonts are still displayed poorly by some \PDF\ viewers, so when possible one should use outline fonts. When no outline is available, \PDFTEX\ tries to locate a suitable \PK\ font (or invoke a process that generates it). %*********************************************************************** \subsection[cfg]{The \PDFTEX\ configuration} One has to keep in mind that, as opposed to \TEX\ with its \DVI\ output, the \PDFTEX\ program does not require a separate postprocessing stage to transform the \TEX\ input into a \PDF\ file. As a consequence, all data needed for building a ready \PDF\ page must be available during the \PDFTEX\ run, in particular information on media dimensions and offsets, graphics files for embedding, and font information (font files, encodings). When \TEX\ builds a page, it places items relative to the top left page corner (the \DVI\ reference point). Separate \DVI\ postprocessors allow specifying the paper size (\eg\ \quote {A4} or \quote{letter}), so that this reference point is moved to the correct position on the paper, and the text ends up at the right place. In \PDF, the paper dimensions are part of the page definition, and \PDFTEX\ therefore requires that they be defined at the beginning of the \PDFTEX\ run. As with pages described by \POSTSCRIPT, the \PDF\ reference point is in the lower||left corner. Formerly, these dimensions and other \PDFTEX\ parameters were read in from a configuration file named \filename{pdftex.cfg}, which had a special (non-\TEX) format, at the start of processing. Nowadays such a file is ignored by \PDFTEX. Instead, the page dimensions and offsets, as well as many other parameters, can be set by \PDFTEX\ primitives during the \PDFTEX\ format building process, so that the settings are dumped into the fresh format and consequently will be used when \PDFTEX\ is later called with that format. All settings from the format can still be overridden during a \PDFTEX\ run by using the same primitives. This new configuration concept is a more unified approach, as it avoids the configuration file with a special format. A list of \PDFTEX\ primitives relevant to setting up the \PDFTEX\ engine is given in \in{table}[tbl:configparms]. All primitives are described in detail within later sections. \in{Figure}[in:pdftexconfig] shows a recent configuration file (\type{pdftexconfig.tex}) in \TEX\ format, using the primitives from \in{table}[tbl:configparms], which typically is read in during the format building process. It enables \PDF\ output, sets paper dimensions and the default pixel density for \PK\ font inclusion. The default values are chosen so that \PDFTEX\ often can be used (\eg\ in \type{-ini} mode) even without setting any parameters. \startbuffer \starttabulate[|l|l|l|l|l|] \HL \NC \bf internal name \NC \bf type \NC\bf default\NC\bf comment\NC\NR \HL \NC \type{\pdfoutput} \NC integer \NC 0 \NC \DVI \NC\NR \NC \type{\pdfadjustspacing} \NC integer \NC 0 \NC off \NC\NR \NC \type{\pdfcompresslevel} \NC integer \NC 9 \NC best \NC\NR \NC \type{\pdfobjcompresslevel} \NC integer \NC 0 \NC no object streams \NC\NR \NC \type{\pdfdecimaldigits} \NC integer \NC 4 \NC max. \NC\NR \NC \type{\pdfimageresolution} \NC integer \NC 72 \NC dpi \NC\NR \NC \type{\pdfpkresolution} \NC integer \NC 0 \NC 72\,dpi \NC\NR \NC \type{\pdfpkmode} \NC token reg.\NC empty \NC mode set in \type{mktex.cnf} \NC\NR \NC \type{\pdfuniqueresname} \NC integer \NC 0 \NC \NC\NR \NC \type{\pdfprotrudechars} \NC integer \NC 0 \NC \NC\NR \NC \type{\pdfgentounicode} \NC integer \NC 0 \NC \NC\NR \NC \type{\pdfminorversion} \NC integer \NC 4 \NC \PDF\ 1.4 \NC\NR \NC \type{\pdfpagebox} \NC integer \NC 0 \NC \NC\NR \NC \type{\pdfforcepagebox} \NC integer \NC 0 \NC \NC\NR \NC \type{\pdfinclusionerrorlevel} \NC integer \NC 0 \NC \NC\NR %----------------------------------------------------------------------- \NC \type{\pdfhorigin} \NC dimension \NC 1\,in \NC \NC\NR \NC \type{\pdfvorigin} \NC dimension \NC 1\,in \NC \NC\NR \NC \type{\pdfpagewidth} \NC dimension \NC 0\,pt \NC \NC\NR \NC \type{\pdfpageheight} \NC dimension \NC 0\,pt \NC \NC\NR %\NC \type{\pdffirstlineheight} \NC dimention \NC -1000\,pt \NC \NC\NR %\NC \type{\pdflastlinedepth} \NC dimention \NC -1000\,pt \NC \NC\NR %\NC \type{\pdfeachlineheight} \NC dimention \NC -1000\,pt \NC \NC\NR %\NC \type{\pdfeachlinedepth} \NC dimention \NC -1000\,pt \NC \NC\NR \NC \type{\pdflinkmargin} \NC dimension \NC 0\,pt \NC \NC\NR \NC \type{\pdfdestmargin} \NC dimension \NC 0\,pt \NC \NC\NR \NC \type{\pdfthreadmargin} \NC dimension \NC 0\,pt \NC \NC\NR \NC \type{\pdfmapfile} \NC text \NC \filename{pdftex.map} \NC not dumped\NC\NR \HL \stoptabulate \stopbuffer \placetable[here][tbl:configparms] {The set of \PDFTEX\ configuration parameters.} {\getbuffer} \startbuffer \tx\setupinterlinespace \startframedtext \starttyping % Set pdfTeX parameters for pdf mode (replacing pdftex.cfg file). % Thomas Esser, 2004. public domain. \pdfoutput=1 \pdfpagewidth=210 true mm \pdfpageheight=297 true mm \pdfpkresolution=600 \endinput \stoptyping \stopframedtext \stopbuffer \placefigure[here][in:pdftexconfig] {A typical configuration file (\filename{pdftexconfig.tex}).} {\getbuffer} Independent of whether such a configuration file is read or not, the first action in a \PDFTEX\ run is that the program reads the global \WEBC\ configuration file (\filename{texmf.cnf}), which is common to all programs in the \WEBC\ system. This file mainly defines file search paths, the memory layout (\eg\ pool and hash size), and other general parameters. %*********************************************************************** \subsection{Creating format files} \startbuffer \tx\setupinterlinespace \startframedtext \starttyping % Thomas Esser, 1998, 2004. public domain. \ifx\pdfoutput\undefined \else \ifx\pdfoutput\relax \else \input pdftexconfig \pdfoutput=0 \fi \fi \input etex.src \dump \endinput \stoptyping \stopframedtext \stopbuffer \placefigure[here][in:etexini] {File \type{etex.ini} for \ETEX\ format with \DVI\ output.} {\getbuffer} \startbuffer \tx\setupinterlinespace \startframedtext \starttyping \ifx\pdfoutput\undefined \else \ifx\pdfoutput\relax \else \input pdftexconfig \pdfoutput=1 \fi \fi \scrollmode \input latex.ltx \endinput \stoptyping \stopframedtext \stopbuffer \placefigure[here][in:pdflatexini] {File \type{pdflatex.ini} for \LATEX\ format with \PDF\ output.} {\getbuffer} The \PDFTEX\ engine allow building formats for \DVI\ and \PDF\ output in the same way as the classical \TEX\ engine does for \DVI. Format generation is enabled by the \type{-ini} option. The default mode (\DVI\ or \PDF) can be chosen either on the command line by setting the option \type{-output-format} to \type{dvi} or \type{pdf}, or by setting the \type{\pdfoutput} parameter. The format file then inherits this setting, so that a later call to \PDFTEX\ with this format starts in the preselected mode (which still can be overrun then). A format file can be read in only by the engine that has generated it; a format incompatible with an engine leads to a fatal error. It is customary to package the configuration and macro file input into a \type{.ini} file. \Eg, the file \type{etex.ini} in \in{figure}[in:etexini] is for generating an \ETEX\ format with \DVI\ output (it contains a few comparisons to be safe also for \TEX\ engines). A similar file \type{pdflatex.ini} can be used for generating a \LATEX\ format with \PDF\ output; refer to \in{figure}[in:pdflatexini]. One can see how the primitive \type{\pdfoutput} is used to override the output mode set by file \type{pdftexconfig.tex}. The corresponding \PDFTEX\ calls for format generation are: \starttyping pdftex -ini *etex.ini pdftex -ini pdflatex.ini \stoptyping These calls produce format files \filename{etex.fmt} and \filename{pdflatex.fmt}, as the default format file name is taken from the input file name. You can overrule this with the \type{-jobname} option. The asterisk \type{*} in the first example line below tells the \PDFTEX\ engine to go into extended \type{-ini} mode (\ETEX\ enabled); otherwise it stays in non||extended \type{-ini} mode. The extended \type{-ini} mode can also be forced by the \type{-etex} command line option, as shown in the 2nd line below. \starttyping pdftex -ini -jobname=pdfelatex *pdflatex.ini pdftex -ini -jobname=pdfelatex -etex pdflatex.ini \stoptyping In \CONTEXT\ the generation depends on the interface used. A format using the English user interface is generated with \starttyping pdftex -ini cont-en \stoptyping When properly set up, one can also use the \CONTEXT\ command line interface \TEXEXEC\ to generate one or more formats, like: \starttyping texexec --make en \stoptyping for an English format, or \starttyping texexec --make en de \stoptyping for an English and German one. Most users will simply say: \starttyping texexec --make --all [--alone] \stoptyping and so generate the \TEX\ and \METAPOST\ related formats that \CONTEXT\ needs. Whatever macro package used, the formats should be placed in the \type {TEXFORMATS} path. \subsection{Testing the installation} When everything is set up, you can test the installation. In the distribution there is a plain \TEX\ test file \filename{samplepdf.tex} in the \type{manual/samplepdf/} directory. Process this file by typing: \starttyping pdftex samplepdf \stoptyping If the installation is ok, this run should produce a file called \filename{samplepdf.pdf}. The file \filename {samplepdf.tex} is also a good place to look for how to use \PDFTEX's primitives. %*********************************************************************** \subsection{Common problems} The most common problem with installations is that \PDFTEX\ complains that something cannot be found. In such cases make sure that \type{TEXMFCNF} is set correctly, so \PDFTEX\ can find \filename {texmf.cnf}. The next best place to look|/|edit is the file \type{texmf.cnf}. When still in deep trouble, set \type{KPATHSEA_DEBUG=255} before running \PDFTEX\ or run \PDFTEX\ with option \type{-k 255}. This will cause \PDFTEX\ to write a lot of debugging information that can be useful to trace problems. More options can be found in the \WEBC\ documentation. Variables in \filename {texmf.cnf} can be overwritten by environment variables. Here are some of the most common problems you can encounter when getting started: \startitemize \head \type{I can't read pdftex.pool; bad path?} \type{TEXMFCNF} is not set correctly and so \PDFTEX\ cannot find \type{texmf.cnf}, or \type{TEXPOOL} in \filename {texmf.cnf} doesn't contain a path to the pool file \filename {pdftex.pool}. \head \type{You have to increase POOLSIZE.} \PDFTEX\ cannot find \filename {texmf.cnf}, or the value of \type {pool_size} specified in \filename {texmf.cnf} is not large enough and must be increased. If \type{pool_size} is not specified in \filename {texmf.cnf} then you can add something like \starttyping pool_size=500000 \stoptyping \head \type{I can't find the format file `pdftex.fmt'!} \crlf \type{I can't find the format file `pdflatex.fmt'!} The format file is not created (see above how to do that) or is not properly placed. Make sure that \type{TEXFORMATS} in \filename {texmf.cnf} contains the path to \filename {pdftex.fmt} or \filename {pdflatex.fmt}. \head \type{---! xx.fmt was written by tex} \crlf \type{Fatal format file error; I'm stymied} This appears \eg\ if you forgot to regenerate the \type{.fmt} files after installing a new version of the \PDFTEX\ binary and \filename {pdftex.pool}. The first line tells by which engine the offending format was generated. \head \type{TEX.POOL doesn't match; TANGLE me again!} \crlf \type{TEX.POOL doesn't match; TANGLE me again (or fix the path).} This might appear if you forgot to install the proper \filename {pdftex.pool} when installing a new version of the \PDFTEX\ binary. \Eg\ under \TEXLIVE\ then run \type{texconfig-sys init} as root. %\head \type{! I can't find file `*pdftex.ini'.} \crlf % \type{<*> *pdftex.ini} % % This typically appears when you try to generate an extended format % with the \PDFTEX\ engine (it does not know about the special asterisk % \type{*} notation). Use the \PDFETEX\ engine instead. \head \PDFTEX\ cannot find one or more map files (\type{*.map}), encoding vectors (\type{*.enc}), virtual fonts, Type~1 fonts, TrueType or OpenType fonts, or some image file. Make sure that the required file exists and the corresponding variable in \filename {texmf.cnf} contains a path to the file. See above which variables \PDFTEX\ needs apart from the ones \TEX\ uses. When you have installed new fonts, and your \PDF\ viewer complains about missing fonts, you should take a look at the log file produced by \PDFTEX. Missing fonts, map files, encoding vectors as well as missing characters (glyphs) are reported there. \stopitemize Normally the page content takes one object. This means that one seldom finds more than a few hundred objects in a simple file. This \PDFTEX\ manual for instance uses approx.~750 objects. In more complex applications this number can grow quite rapidly, especially when one uses a lot of widget annotations, shared annotations or other shared things. In any case \PDFTEX's internal object table size will automatically grow to the required size (the parameter \type{obj_tab_size} for manual control of the object table size is now obsolete and ignored). %*********************************************************************** \section{Macro packages supporting \PDFTEX} As \PDFTEX\ generates the final \PDF\ output without help of a postprocessor, macro packages that take care of these \PDF\ features have to be set up properly. Typical tasks are handling color, graphics, hyperlink support, threading, font||inclusion, as well as page imposition and manipulation. All these \PDF||specific tasks can be commanded by \PDFTEX's own primitives (a few also by a \PDFTEX||specific \type{\special{pdf: ...}} primitive). Any other \type{\special{}} commands, like the ones defined for various \DVI\ postprocessors, are simply ignored by \PDFTEX\ when in \PDF\ output mode; a warning is given only for non||empty \type{\special{}} commands. When a macro package already written for classical \TEX\ with \DVI\ output is to be modified for use with \PDFTEX, it is very helpful to get some insight to what extent \PDFTEX||specific support is needed. This info can be gathered \eg\ by outputting the various \type{\special} commands as \type{\message}. Simply type \starttyping \pdfoutput=1 \let\special\message \stoptyping or, if this leads to confusion, \starttyping \pdfoutput=1 \def\special#1{\write16{special: #1}} \stoptyping and see what happens. As soon as one \quote {special} message turns up, one knows for sure that some kind of \PDFTEX\ specific support is needed, and often the message itself gives a indication of what is needed. Currently all mainstream macro packages offer \PDFTEX\ support, with automatic detection of \PDFTEX\ as engine. So there is normally no need to turn on \PDFTEX\ support explicitly. \startitemize \item For \LATEX\ users, Sebastian Rahtz and Heiko Oberdiek's \type {hyperref} package has substantial support for \PDFTEX\ and provides access to most of its features. In the simplest and most common case, the user merely needs to load \type{hyperref}, and all cross||references will be converted to \PDF\ hypertext links. \PDF\ output is automatically selected, compression is turned on, and the page size is set up correctly. Bookmarks are created to match the table of contents. \item The standard \LATEX\ \type{graphics}, \type{graphicx}, and \type{color} packages also have automatic \pdfTeX\ support, which allow use of color, text rotation, and graphics inclusion commands. \item The \CONTEXT\ macro package by Hans Hagen has very full support for \PDFTEX\ in its generalized hypertext features. Support for \PDFTEX\ is implemented as a special driver, and is invoked by typing \type{\setupoutput[pdftex]} or feeding \TEXEXEC\ with the \type{--pdf} option. \item \PDF\ from \TEXINFO\ documents can be created by running \PDFTEX\ on the \TEXINFO\ file, instead of \TEX. Alternatively, run the shell command \type{texi2pdf} instead of \type{texi2dvi}. \item A small modification of \filename {webmac.tex}, called \filename {pdfwebmac.tex}, allows production of hyperlinked \PDF\ versions of the program code written in \WEB. \stopitemize Some nice samples of \PDFTEX\ output can be found at \from[ptex_org], \from[context], and \from[tex_showcase]. %*********************************************************************** \section{Setting up fonts} \PDFTEX\ can work with Type~1 and TrueType fonts (and to some extent also with OpenType fonts). Font files should be available and embedded for all fonts used in the document. It is possible to use \METAFONT||generated fonts in \PDFTEX\ --- but it is strongly recommended not to use these fonts if an equivalent is available in Type~1 or TrueType format, if only because bitmap Type~3 fonts render very poorly in (older versions of) Adobe Reader. Given the free availability of Type~1 versions of all the Computer Modern fonts, and the ability to use standard \POSTSCRIPT\ fonts, there is rarely a need to use bitmap fonts in \PDFTEX. %*********************************************************************** \subsection[mapfile]{Map files} Font map files provide the connection between \TEX\ \TFM\ font files and the outline font file names. They contain also information about re||encoding arrays, partial font embedding (``subsetting''), and character transformation parameters (like SlantFont and ExtendFont). Those map files were first created for \DVI\ postprocessors. But, as \PDFTEX\ in \PDF\ output mode includes all \PDF\ processing steps, it also needs to know about font mapping, and therefore reads in one or more map files. Map files are not read in when \PDFTEX\ is in \DVI\ mode. Pixel fonts can be used without being listed in the map file. By default, \PDFTEX\ reads the map file \filename{pdftex.map}. In \WEBC, map files are searched for using the \type{TEXFONTMAPS} config file value and environment variable. By default, the current directory and various system directories are searched. Within the map file, each font is listed on an individual line. The syntax of each line is upward||compatible with \type{dvips} map files and can contain the following fields (some are optional; explanations follow): \startnarrower {\em tfmname basename fontflags special encodingfile fontfile} \stopnarrower It is mandatory that {\em tfmname} is the first field. If a {\em basename} is given, it must be the second field. Similarly if {\em fontflags} is given it must be the third field (if {\em basename} is present) or the second field (if {\em basename} is left out). It is possible to mix the positions of {\em special}, {\em encodingfile}, and {\em fontfile}, however the first three fields must be given in fixed order. \startdescription {tfmname} sets the name of the \TFM\ file for a font --- the name \TEX\ sees. This name must always be given. \stopdescription \startdescription {basename} sets the (\POSTSCRIPT) base font name, which has two uses: First, when a \PDF\ file is embedded by \type{\pdfximage}, the \type{/BaseFont} names in the font dictionaries of Type~1 and Type~1C (CFF) fonts from the embedded \PDF\ file are checked against this {\em basename} field. If names match, the glyphs of that font will not be copied from the embedded \PDF\ file, but instead a local font is opened, and all needed glyphs will be taken from the Type~1 font file that is mentioned in the map line (see {\em fontfile} below). By this collecting mechanism Type~1 glyphs can be shared between several embedded \PDF\ files and with text that is typeset by \PDFTEX, which helps keeping the resulting \PDF\ file size small, if many files with similar Type~1(C) fonts are embedded. Replacing Type1 fonts from embedded \PDF\ files requires that also a Type1 font file name is in the {\em fontfile} field (see below). Second, if a font file is not to be embedded into the \PDF\ output ({\em fontfile} field missing), then the {\em basename} field will be copied to the \type{/BaseFont} and \type{/FontName} dictionary entries in the \PDF\ file, so that the \POSTSCRIPT\ font name will be known to the consumer application (\eg\ viewer). It is highly recommended to always use the {\em basename} field (but strictly speaking it's optional). \stopdescription \startdescription {fontflags} specify some characteristics of the font. The following description of these flags is taken, with slight modification, from the \PDFReference\ (the section on font descriptor flags). Viewers can adapt their rendering to these flags, especially when they substitute a non-embedded font by some own approximation. \startnarrower The value of the flags key in a font descriptor is a 32||bit integer that contains a collection of boolean attributes. These attributes are true if the corresponding bit is set to~1. \in{Table}[flags] specifies the meanings of the bits, with bit~1 being the least significant. Reserved bits must be set to zero. \startbuffer \starttabulate[|c|l|] \HL \NC \bf bit position \NC \bf semantics \NC\NR \HL \NC 1 \NC Fixed||width font \NC\NR \NC 2 \NC Serif font \NC\NR \NC 3 \NC Symbolic font \NC\NR \NC 4 \NC Script font \NC\NR \NC 5 \NC Reserved \NC\NR \NC 6 \NC Uses the Adobe Standard Roman Character Set \NC\NR \NC 7 \NC Italic \NC\NR \NC 8--16 \NC Reserved \NC\NR \NC 17 \NC All||cap font \NC\NR \NC 18 \NC Small||cap font \NC\NR \NC 19 \NC Force bold at small text sizes \NC\NR \NC 20--32 \NC Reserved \NC\NR \HL \stoptabulate \stopbuffer \placetable [here][flags] {The meaning of flags in the font descriptor.} {\getbuffer} All characters in a {\em fixed||width} font have the same width, while characters in a proportional font have different widths. Characters in a {\em serif font} have short strokes drawn at an angle on the top and bottom of character stems, while sans serif fonts do not have such strokes. A {\em symbolic font} contains symbols rather than letters and numbers. Characters in a {\em script font} resemble cursive handwriting. An {\em all||cap} font, which is typically used for display purposes such as titles or headlines, contains no lowercase letters. It differs from a {\em small||cap} font in that characters in the latter, while also capital letters, have been sized and their proportions adjusted so that they have the same size and stroke weight as lowercase characters in the same typeface family. Bit~6 in the flags field indicates that the font's character set conforms to the Adobe Standard Roman Character Set, or a subset of that, and that it uses the standard names for those characters. Finally, bit~19 is used to determine whether or not bold characters are drawn with extra pixels even at very small text sizes. Typically, when characters are drawn at small sizes on very low resolution devices such as display screens, features of bold characters may appear only one pixel wide. Because this is the minimum feature width on a pixel||based device, ordinary non||bold characters also appear with one||pixel wide features, and thus cannot be distinguished from bold characters. If bit~19 is set, features of bold characters may be thickened at small text sizes. \stopnarrower If the {\em fontflags} field is not given, \PDFTEX\ treats it as being~4, a symbolic font. If you do not know the correct value, it is best not to specify it at all, as specifying a bad value of font flags may cause troubles in viewers. On the other hand this option is not absolutely useless because it provides backward compatibility with older map files (see the {\em fontfile} description below). \stopdescription \startdescription {special} instructions can be used to manipulate fonts similar to the way \type{dvips} does. Currently only the keywords \type{SlantFont} and \type{ExtendFont} are interpreted, other instructions (as \type{ReEncodeFont} with parameters, see {\em encoding} below) are just ignored. The permitted \type{SlantFont} range is $-$1..1; for \type{ExtendFont} it's $-$2..2. The block of {\em special} instruction must be enclosed by double quotes \type{"}. \stopdescription \startdescription {encodingfile} specifies the name of the file containing the external encoding vector to be used for the font. The encoding file must have name extension \type{.enc}, and the full file name including this extension must be given with preceding~\type{<} character. The format of the encoding vector is identical to that used by \type{dvips}. If no encoding is specified, the font's built||in default encoding is used. The {\em encodingfile} field may be omitted if you are sure that the font resource has the correct built||in encoding. In general this option is highly recommended, and it is {\em required} when subsetting a TrueType font. \stopdescription \startdescription {fontfile} sets the name of the font file to be embedded into the \PDF\ output for a given \TeX\ font (the {\em tfmname}~$\longleftrightarrow$~{\em fontfile} mapping is the most prominent use of the \filename{pdftex.map} file). The font file name must belong to a Type~1 or TrueType font file. If the {\em fontfile} field is missing, no font embedding can take place; in case the {\em basename} field does not contain one of the 14 standard font names also a warning will be given. Not embedding a font into a \PDF\ file might be troublesome, as it requires that the font or some similar looking replacement font is available within the \PDF\ viewer, so that it can render the glyphs with its own font version. The font file name should be preceded by one or two special characters, which tells how to handle the font file: \startitemize \item If the font file name is preceded by a \type{<} character, the font file will be only partially embedded into the \PDF\ file (``subsetted''), meaning that only used glyphs are going into the \PDF\ file. This is the most common use and is {\em strongly recommended} for any font, as it ensures the portability and reduces the size of the \PDF\ output. Subsetted fonts are included in such a way that name and cache clashes are minimized. \item If the font file name is preceded by a double \type{<<}, the font file will be included entirely --- all glyphs of the font are embedded, including even the ones that are not used in the document. Apart from causing large size \PDF\ output, this option may cause troubles with TrueType fonts, so it is normally not recommended for Type1 or TrueType fonts. But this is currently the only mode that allows the use of OpenType fonts. This mode might also be useful in case the font is atypical and can not be subsetted well by \PDFTEX. {\em Beware: some font vendors forbid full font inclusion.} \item The case that no special character precedes the font file name is deprecated since \PDFTEX\ version 1.40.0. These font files are now completely ignored, and a corresponding warning is given. You achieve exactly the same \PDF\ result if you just remove the font file name from the map entry. Then the glyph widths that go into the \PDF~file are extracted from the \TFM~file, and a font descriptor object is created that contains approximations of the font metrics for the selected font. This option is useful only as fallback when you do not want to embed the font (\eg\ due to font license restrictions), but wish to use the font metrics and let the \PDF\ viewer generate instances that look close to the used font in case the font resource is not installed on the system where the \PDF\ output will be viewed or printed. To use this feature, the font flags {\em must} be specified, and it must have the bit~6 set on, which means that only fonts with the Adobe Standard Roman Character Set can be simulated. The only exception is the case of a Symbolic font, which is not very useful. \stopitemize When one suffers from invalid lookups, for instance when \PDFTEX\ tries to open a \type{.pfa} file instead of a \type{.pfb} one, one can add the suffix to the filename. In this respect, \PDFTEX\ completely relies on the \type{kpathsea} libraries. \stopdescription %HE Huh? pgc? If a used font is not present in the map files, first \PDFTEX\ will look for a source with suffix \type{.pgc}, which is a so||called \PGC\ source (\PDF\ Glyph Container) \footnote {This is a text file containing a \PDF\ Type~3 font, created by \METAPOST\ using some utilities by Hans Hagen. In general \PGC\ files can contain whatever is allowed in a \PDF\ page description, which may be used to support fonts that are not available in \METAFONT. \PGC\ fonts are not widely useful, as vector Type~3 fonts are not displayed very well in older versions of Acrobat Reader, but may be more useful when better Type~3 font handling is more common.}. If no \PGC\ source is available, \PDFTEX\ will try to use \PK~fonts as \DVI\ drivers do, creating \PK~fonts on||the||fly if needed. Lines containing nothing apart from {\em tfmname} stand for scalable Type~3 fonts. For scalable fonts as Type~1, TrueType and scalable Type~3 font, all the fonts loaded from a \TFM\ at various sizes will be included only once in the \PDF\ output. Thus if a font, let's say \type{csr10}, is described in one of the map files, then it will be treated as scalable. As a result the font source for csr10 will be included only once for \type{csr10}, \type{csr10 at 12pt} etc. So \PDFTEX\ tries to do its best to avoid multiple embedding of identical font sources. Thus vector \PGC\ fonts should be specified as scalable Type~3 in map files like: \starttyping csr10 \stoptyping It doesn't hurt much if a scalable Type~3 font is not given in map files, except that the font source will be embedded into the \PDF\ file multiple times for various sizes, which causes a much larger \PDF\ output. On the other hand if a font in the map files is defined as scalable Type~3 font and its \PGC\ source is not scalable or not available, \PDFTEX\ will use \PK\ fonts instead; the \PDF\ output is still valid but some fonts may look ugly because of the scaled bitmap. To summarize this rather confusing story, we include some example lines. The most common way is to embed only a glyph subset from a font like this, with re||encoding: \starttyping ptmri8r Times-Italic <8r.enc -o \stoptyping A TrueType file can be recognized by its suffix \filename {ttf}. The optional {\em encoding} specifies the encoding, which is the same as the encoding vector used in map files for \PDFTEX\ and \type{dvips}. If the encoding is not given, all the glyphs of the \AFM\ output will be mapped to \type {/.notdef}. \type{ttf2afm} writes the output \AFM\ to standard output. If we need to know which glyphs are available in the font, we can run \type {ttf2afm} without encoding to get all glyph names. The resulting \AFM\ file can be used to generate a \TFM\ one by applying \filename {afm2tfm}. To use a new TrueType font the minimal steps may look like below. We suppose that \filename {test.map} is used. \starttyping ttf2afm -e 8r.enc -o times.afm times.ttf afm2tfm times.afm -T 8r.enc echo "times TimesNewRomanPSMT <8r.enc >test.map \stoptyping There are a few limitations with TrueType fonts in comparison with Type~1 fonts: \startitemize[a,packed] \item The special effects SlantFont|/|ExtendFont did not work before version 1.40.0. \item To subset a TrueType font, the font must be specified as re||encoded, therefore an encoding vector must be given. \item TrueType fonts coming with embedded \PDF\ files are kept untouched; they are not replaced by local ones. \stopitemize For much more about \PDFTEX\ and TrueType fonts, including many details on handling glyph names, see ``A closer look at TrueType fonts and \PDFTEX'', {\em TUGboat} 30:1 (2009), pp.~32||34, \from[thanh_truetype_tub] %*********************************************************************** \section{Formal syntax specification} This section formally specifies the \PDFTEX\ specific extensions to the \TEX\ macro programming language. Most primitives are prefixed by \type{pdf}. %All primitives are prefixed by %\type {pdf} except for \type{\efcode}, \type{\lpcode}, \type{\rpcode}, %\type{\leftmarginkern}, \type{\rightmarginkern}, \type{\letterspacefont} %and the new conditionals (which begin with \type{ifpdf}). The general definitions and syntax rules follow after the list of primitives. Two new units of measure were introduced in \PDFTEX\ 1.30.0: the new Didot (1\,nd~=~0.375\,mm) and the new Cicero (1\,nc~=~12\,nd) (the former was proposed by \ISO\ in 1975). %%S This is the list of new or extended primitives provided by pdftex. %%S Don't edit this file, as it is now auto-generated from the %%S pdfTeX documentation file pdftex-t.tex by script syntaxform.awk. %%S Used convention for syntax rules is borrowed from `TeXbook naruby' %%S by Petr Olsak. %%S $Id: pdftex-t.tex 655 2010-11-23 00:37:25Z karl $ %%S NL %%S integer registers: \subsubject{Integer registers} \startpacked \Syntax { \Tex {\pdfoutput} \Whatever{integer} } \Syntax { \Tex {\pdfminorversion} \Whatever{integer} } %\Syntax { %\Tex {\pdfoptionpdfminorversion} \Whatever{integer} %} \Syntax { \Tex {\pdfcompresslevel} \Whatever{integer} } \Syntax { \Tex {\pdfobjcompresslevel} \Whatever{integer} } \Syntax { \Tex {\pdfdecimaldigits} \Whatever{integer} } \Syntax { \Tex {\pdfimageresolution} \Whatever{integer} } \Syntax { \Tex {\pdfpkresolution} \Whatever{integer} } \Syntax { \Tex {\pdftracingfonts} \Whatever{integer} } \Syntax { \Tex {\pdfuniqueresname} \Whatever{integer} } \Syntax { \Tex {\pdfadjustspacing} \Whatever{integer} } \Syntax { \Tex {\pdfprotrudechars} \Whatever{integer} } \Syntax { \Tex {\efcode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\lpcode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\rpcode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\pdfadjustinterwordglue} \Whatever{integer} } \Syntax { \Tex {\knbscode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\stbscode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\shbscode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\pdfprependkern} \Whatever{integer} } \Syntax { \Tex {\knbccode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\pdfappendkern} \Whatever{integer} } \Syntax { \Tex {\knaccode} \Something{font} \Something{8-bit number} \Whatever{integer} } \Syntax { \Tex {\pdfgentounicode} \Whatever{integer} } \Syntax { \Tex {\tagcode} \Something{font} \Something{character code} \Whatever{integer} } \Syntax { \Tex {\pdfpagebox} \Whatever{integer} } \Syntax { \Tex {\pdfforcepagebox} \Whatever{integer} } \Syntax { \Tex {\pdfoptionalwaysusepdfpagebox} \Whatever{integer} } \Syntax { \Tex {\pdfinclusionerrorlevel} \Whatever{integer} } \Syntax { \Tex {\pdfoptionpdfinclusionerrorlevel} \Whatever{integer} } \Syntax { \Tex {\pdfimagehicolor} \Whatever{integer} } \Syntax { \Tex {\pdfimageapplygamma} \Whatever{integer} } \Syntax { \Tex {\pdfgamma} \Whatever{integer} } \Syntax { \Tex {\pdfimagegamma} \Whatever{integer} } \Syntax { \Tex {\pdfinclusioncopyfonts} \Whatever{integer} } \Syntax { \Tex {\pdfdraftmode} \Whatever{integer} } \stoppacked %%S NL %%S dimen registers: \subsubject{Dimen registers} \startpacked \Syntax { \Tex {\pdfhorigin} \Whatever{dimen} } \Syntax { \Tex {\pdfvorigin} \Whatever{dimen} } \Syntax { \Tex {\pdfpagewidth} \Whatever{dimen} } \Syntax { \Tex {\pdfpageheight} \Whatever{dimen} } \Syntax { \Tex {\pdfignoreddimen} \Whatever{dimen} } \Syntax { \Tex {\pdffirstlineheight} \Whatever{dimen} } \Syntax { \Tex {\pdflastlinedepth} \Whatever{dimen} } \Syntax { \Tex {\pdfeachlineheight} \Whatever{dimen} } \Syntax { \Tex {\pdfeachlinedepth} \Whatever{dimen} } \Syntax { \Tex {\pdflinkmargin} \Whatever{dimen} } \Syntax { \Tex {\pdfdestmargin} \Whatever{dimen} } \Syntax { \Tex {\pdfthreadmargin} \Whatever{dimen} } \Syntax { \Tex {\pdfpxdimen} \Whatever{dimen} } \stoppacked %%S NL %%S token registers: \subsubject{Token registers} \startpacked \Syntax { \Tex {\pdfpagesattr} \Whatever{tokens} } \Syntax { \Tex {\pdfpageattr} \Whatever{tokens} } \Syntax { \Tex {\pdfpageresources} \Whatever{tokens} } \Syntax { \Tex {\pdfpkmode} \Whatever{tokens} } \stoppacked %%S NL %%S expandable commands: \subsubject{Expandable commands} \startpacked \Syntax { \Tex {\pdftexrevision} \Whatever{expandable} } \Syntax { \Tex {\pdftexbanner} \Whatever{expandable} } \Syntax { \Tex {\pdfcreationdate} \Whatever{expandable} } \Syntax { \Tex {\pdfpageref} \Something{page number} \Whatever{expandable} } \Syntax { \Tex {\pdfxformname} \Something{object number} \Whatever{expandable} } \Syntax { \Tex {\pdffontname} \Something{font} \Whatever{expandable} } \Syntax { \Tex {\pdffontobjnum} \Something{font} \Whatever{expandable} } \Syntax { \Tex {\pdffontsize} \Something{font} \Whatever{expandable} } \Syntax { \Tex {\pdfincludechars} \Something{font} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\leftmarginkern} \Something{box number} \Whatever{expandable} } \Syntax { \Tex {\rightmarginkern} \Something{box number} \Whatever{expandable} } \Syntax { \Tex {\pdfescapestring} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdfescapename} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdfescapehex} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdfunescapehex} \Something{general text} \Whatever{expandable} } \Syntax { \tex {ifpdfprimitive} \Something{control sequence} \Whatever{expandable} } \Syntax { \tex {ifincsname} \Whatever{expandable} } \Syntax { \Tex {\pdfstrcmp} \Something{general text} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdfmatch} \Optional{\Literal{icase}} \Optional{\Literal{subcount} \Something{number}} \Something{general text} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdflastmatch} \Something{integer} \Whatever{expandable} } \Syntax { \Tex {\ifpdfabsnum} \Whatever{expandable} } \Syntax { \Tex {\ifpdfabsdim} \Whatever{expandable} } \Syntax { \Tex {\pdfuniformdeviate} \Something{number} \Whatever{expandable} } \Syntax { \Tex {\pdfnormaldeviate} \Whatever{expandable} } \Syntax { \Tex {\pdfmdfivesum} \Optional{\Literal{file}} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdffilemoddate} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdffilesize} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdffiledump} \Optional{\Literal{offset} \Something{number}} \Optional{\Literal{length} \Something{number}} \Something{general text} \Whatever{expandable} } \Syntax { \Tex {\pdfcolorstackinit} \Optional{\Literal{page}} \Optional{\Literal{direct}} \Something{general text} \Whatever{expandable} } \Syntax { \Tex{\pdfinsetht} \Something{integer} \Whatever{expandable} } \Syntax { \Tex {\pdfximagebbox} \Something{integer} \Something{integer} \Whatever{expandable} } \stoppacked %%S NL %%S read-only integers: \subsubject{Read||only integers} \startpacked \Syntax { \Tex {\pdftexversion} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastobj} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastxform} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastximage} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastximagecolordepth} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastximagepages} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastannot} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastlink} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastxpos} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastypos} \Whatever{read||only integer} } \Syntax { \Tex {\pdflastdemerits} \Whatever{read||only integer} } \Syntax { \Tex {\pdfelapsedtime} \Whatever{read||only integer} } \Syntax { \Tex {\pdfrandomseed} \Whatever{read||only integer} } \Syntax { \Tex {\pdfretval} \Whatever{read||only integer} } \Syntax { \Tex {\pdfshellescape} \Whatever{read||only integer} } % No longer available %\Syntax { %\Tex {\pdflastvbreakpenalty} \Whatever{read||only integer} %} \stoppacked %%S NL %%S general commands: \subsubject{General commands} \startpacked \Syntax { \Tex {\pdfobj} \Something{object type spec} \Whatever{h, v, m} } \Syntax { \Tex {\pdfrefobj} \Something{object number} \Whatever{h, v, m} } \Syntax { \Tex {\pdfxform} \Optional{\Something{xform attr spec}} \Something{box number} \Whatever{h, v, m} } \Syntax { \Tex {\pdfrefxform} \Something{object number} \Whatever{h, v, m} } \Syntax { \Tex {\pdfximage} \Optional{\Something{image attr spec}} % \Something{general text} \Whatever{h, v, m} } \Syntax { \Tex {\pdfrefximage} \Something{object number} \Whatever{h, v, m} } \Syntax { \Tex {\pdfannot} \Something{annot type spec} \Whatever{h, v, m} } \Syntax { \Tex {\pdfstartlink} % \Optional{\Something{rule spec}} % \Optional{\Something{attr spec}} \Something{action spec} \Whatever{h, m} } \Syntax { \Tex {\pdfendlink} \Whatever{h, m} } \Syntax { \Tex {\pdfoutline} \Something{outline spec} \Whatever{h, v, m} } \Syntax { \Tex {\pdfdest} \Something{dest spec} \Whatever{h, v, m} } \Syntax { \Tex {\pdfthread} \Something{thread spec} \Whatever{h, v, m} } \Syntax { \Tex {\pdfstartthread} \Something{thread spec} \Whatever{v, m} } \Syntax { \Tex {\pdfendthread} \Whatever{v, m} } \Syntax { \Tex {\pdfsavepos} \Whatever{h, v, m} } \Syntax { \Tex {\pdfinfo} \Something{general text} } \Syntax { \Tex {\pdfcatalog} \Something{general text} % \Optional{\Something{open-action spec}} } \Syntax { \Tex {\pdfnames} \Something{general text} } \Syntax { \Tex {\pdfmapfile} \Something{map spec} } \Syntax { \Tex {\pdfmapline} \Something{map spec} } \Syntax { \Tex {\pdffontattr} \Something{font} \Something{general text} } \Syntax { \Tex {\pdftrailer} \Something{general text} } \Syntax { \Tex {\pdffontexpand} \Something{font} \Something{expand spec} } \Syntax { \Tex {\letterspacefont} \Something{control sequence} \Something{font} \Something{integer} } \Syntax { \Tex {\pdfcopyfont} \Something{control sequence} \Something{font} } \Syntax { \Tex {\pdfglyphtounicode} \Something{general text} \Something{general text} } \Syntax { \Tex {\vadjust} \Optional{\Something{pre spec}} \Something{filler} \Lbrace \Something{vertical mode material} \Rbrace \Whatever{h, m} } \Syntax { \Tex {\quitvmode} } \Syntax { \Tex {\pdfliteral} \Optional{\Something {pdfliteral spec}} \Something{general text} \Whatever{h, v, m} } \Syntax { \Tex {\special} \Something{pdfspecial spec} } \Syntax { \Tex {\pdfresettimer} } \Syntax { \Tex {\pdfsetrandomseed} \Something{number} } \Syntax { \Tex {\pdfnoligatures} \Something{font} } \Syntax { \Tex {\pdfprimitive} \Something{control sequence} } \Syntax { \Tex {\pdfcolorstack} \Something{stack number} \Something{stack action} \Something{general text} } \Syntax { \Tex {\pdfsetmatrix} } \Syntax { \Tex {\pdfsave} } \Syntax { \Tex {\pdfrestore} } \stoppacked \subsubject{General definitions and syntax rules} \startpacked %%S NL %%S syntax rules: \Syntax { \Something{general text} \Means % \Lbrace \Something{balanced text} \Rbrace } \Syntax { \Something{attr spec} \Means % \Literal {attr} \Something{general text} } \Syntax { \Something{resources spec} \Means % \Literal {resources} \Something{general text} } \Syntax { \Something{rule spec} \Means % (\Literal {width} \Or \Literal {height} \Or \Literal {depth}) % \Something{dimension} \Optional{\Something{rule spec}} } %\Syntax {\Something{object type spec} \Means % \Optional{\Literal {stream} % \Optional{\Something{attr spec}}} \Something{object contents}} \Syntax { \Something{object type spec} \Means % \Literal{reserveobjnum} \Or \Next % \Optional{\Literal{useobjnum} \Something{number}} \Next % \Optional{\Literal{stream} \Optional{\Something{attr spec}}} % \Something{object contents} } \Syntax { \Something{annot type spec} \Means % \Literal{reserveobjnum} \Or \Next % \Optional{\Literal{useobjnum} \Something{number}} % \Optional{\Something{rule spec}} % \Something{general text} } \Syntax { \Something{object contents} \Means % \Something{file spec} \Or \Something{general text} } \Syntax { \Something{xform attr spec} \Means % \Optional{\Something{attr spec}} \Optional{\Something{resources spec}} } \Syntax { \Something{image attr spec} \Means % \Optional{\Something{rule spec}} % \Optional{\Something{attr spec}} % \Optional{\Something{page spec}} % \Optional{\Something{colorspace spec}} % \Optional{\Something{pdf box spec}} } \Syntax { \Something{outline spec} \Means % \Optional{\Something{attr spec}} % \Something{action spec} % \Optional{\Literal{count} \Something{number}} % \Something{general text} } \Syntax { \Something{action spec} \Means % \Literal {user} \Something{user-action spec} \Or \Literal {goto} \Something{goto-action spec} \Or \Next \Literal {thread} \Something{thread-action spec} } \Syntax { \Something{user-action spec} \Means % \Something{general text} } %HE Check: \Syntax { \Something{goto-action spec} \Means % \Something{numid} \Or \Next \Optional{\Something{file spec}} \Something{nameid} \Or \Next \Optional{\Something{file spec}} \Optional{\Something{page spec}} \Something{general text} \Or \Next \Something{file spec} \Something{nameid} \Something{newwindow spec} \Or \Next \Something{file spec} \Optional{\Something{page spec}} \Something{general text} \Something{newwindow spec} } \Syntax { \Something{thread-action spec} \Means % \Optional{\Something{file spec}} \Something{numid} \Or \Optional{\Something{file spec}} \Something{nameid} } \Syntax { \Something{open-action spec} \Means % \Literal {openaction} \Something{action spec} } \Syntax { \Something{colorspace spec} \Means % \Literal {colorspace} \Something{number} } \Syntax{ \Something{pdf box spec} \Means % \Literal{mediabox} % \Or \Literal{cropbox} % \Or \Literal{bleedbox} % \Or \Literal{trimbox} % \Or \Literal{artbox} } \Syntax{ \Something{map spec} \Means % \Lbrace \Optional{\Something{map modifier}} % \Something{balanced text} \Rbrace } \Syntax{ \Something{map modifier} \Means % \Literal{+} \Or \Literal{=} \Or \Literal{-} } \Syntax { \Something{numid} \Means % \Literal {num} \Something{number} } \Syntax { \Something{nameid} \Means % \Literal {name} \Something{general text} } \Syntax { \Something{newwindow spec} \Means % \Literal {newwindow} \Or \Literal {nonewwindow} } \Syntax { \Something{dest spec} \Means % \Something{numid} \Something{dest type} \Or \Something{nameid} \Something{dest type} } \Syntax { \Something{dest type} \Means % \Literal {xyz} \Optional{\Literal {zoom} \Something{number}} \Or \Literal {fitr} \Something{rule spec} \Or \Next \Literal {fitbh} \Or \Literal {fitbv} \Or \Literal {fitb} \Or \Literal {fith} \Or \Literal {fitv} \Or \Literal {fit} } \Syntax { \Something{thread spec} \Means % \Optional{\Something{rule spec}} % \Optional{\Something{attr spec}} % \Something{id spec} } \Syntax { \Something{id spec} \Means % \Something{numid} \Or \Something{nameid} } \Syntax { \Something{file spec} \Means % \Literal {file} \Something{general text} } \Syntax { \Something{page spec} \Means % \Literal {page} \Something{number} } \Syntax { \Something{expand spec} \Means % \Something{stretch} % \Something{shrink} % \Something{step} % \Optional{\Literal{autoexpand}} } \Syntax { \Something{stretch} \Means % \Something{number} } \Syntax { \Something{shrink} \Means % \Something{number} } \Syntax { \Something{step} \Means % \Something{number} } \Syntax { \Something{pre spec} \Means % \Literal{pre} } \Syntax { \Something{pdfliteral spec} \Means % \Literal{direct} \Or \Literal{page} } \Syntax { \Something{pdfspecial spec} \Means % \Lbrace \Optional{\Something{pdfspecial id} \Optional{\Something{pdfspecial modifier}}} % \Something{balanced text} \Rbrace } \Syntax { \Something{pdfspecial id} \Means % \Literal{pdf:} \Or \Literal{PDF:} } \Syntax { \Something{pdfspecial modifier} \Means % \Literal{direct:} } \Syntax { \Something{stack action} \Means % \Literal{set} \Or \Literal{push} \Or \Literal{pop} \Or \Literal{current} } \stoppacked A \Something {general text} is expanded immediately, like \type{\special} in traditional \TEX, unless explicitly mentioned otherwise. Some of the object and image related primitives can be prefixed by \type {\immediate}. More about that in the next sections. %*********************************************************************** \section[primitives]{\PDFTEX\ primitives} Here follows a short description of the primitives added by \PDFTEX\ to the original \TEX\ engine (other extensions by \MLTEX\ and \ENCTEX\ are not listed). One way to learn more about how to use these new primitives is to have a look at the file \filename {samplepdf.tex} in the \PDFTEX\ distribution. Note that if the output is \DVI\ then the \PDFTEX\ specific dimension parameters are not used at all. However some \PDFTEX\ integer parameters can affect the \DVI\ as well as \PDF\ output (currently \type{\pdfoutput} and \type{\pdfadjustspacing}). %A warning to macro writers: The \PDFTEX-team reserves the namespaces %\type{\pdf*} and \type{\ptex*} for use by \PDFTEX; if you define macros %whose names start with \type{\pdf} or \type{\ptex}, you risk nameclashes %with new primitives introduced in future versions of \PDFTEX. General warning: many of these new primitives, for example \type{\pdfdest} and \type{\pdfoutline}, write their arguments directly to the \PDF\ output file (when producing \PDF), as \PDF\ string constants. This means that {\em you} (or, more likely, the macros you write) must escape characters as necessary (namely \type{\}, \type{(}, and \type{)}. Otherwise, an invalid \PDF\ file may result. The \type{hyperref} and \TEXINFO\ packages have code which may serve as a starting point for implementing this, although it will certainly need to be adapted to any particular situation. %*********************************************************************** \subsection{Document setup} \pdftexprimitive {\Syntax {\Tex {\pdfoutput} \Whatever{integer}}} \bookmark{\tex{pdfoutput}} This parameter specifies whether the output format should be \DVI\ or \PDF. A positive value means \PDF\ output, otherwise (default 0) one gets \DVI\ output. This primitive is the only one that must be set to produce \PDF\ output (unless the commandline option \type{-output-format=pdf} is used); all other primitives are optional. This parameter cannot be specified {\em after} shipping out the first page. In other words, if we want \PDF\ output, we have to set \type{\pdfoutput} before \PDFTEX\ ships out the first page. When \PDFTEX\ starts complaining about specials, one can be rather sure that a macro package is not aware of the \PDF\ mode. A simple way of making macros aware of \PDFTEX\ in \PDF\ or \DVI\ mode is: \starttyping \ifx\pdfoutput\undefined \csname newcount\endcsname\pdfoutput \fi \ifcase\pdfoutput DVI CODE \else PDF CODE \fi \stoptyping Using the \type{ifpdf.sty} file, which works with both \LATEX\ and plain \TeX, is a cleaner way of doing this. Historically, the simple test \type{\ifx\pdfoutput\undefined} was defined; but nowadays, the \PDFTEX\ engine is used in distributions also for non-\PDF\ formats (\eg\ \LATEX), so \type{\pdfoutput} may be defined even when the output format is \DVI. \pdftexprimitive {\Syntax {\Tex {\pdfminorversion} \Whatever{integer}}} \bookmark{\tex{pdfminorversion}} This primitive sets the \PDF\ version of the generated file and the latest allowed \PDF\ version of included \PDF{}s. \Eg, \type{\pdfminorversion=3} tells \PDFTEX\ to set the \PDF\ version to 1.3 and allows only included \PDF\ files with versions numbers up to 1.3. The default for \type{\pdfminorversion} is 5, producing files with \PDF\ version 1.5. If specified, this primitive must appear before any data is to be written to the generated \PDF\ file, so you should put it at the very start of your files. The command has been introduced in \PDFTEX\ 1.30.0 as a shortened synonym of \type{\pdfoptionpdfminorversion} command, that is obsolete by now. Distributions alter the default value here; for example, \TEXLIVE\ 2010 sets \type{\pdfminorversion=5} when its formats are built, so object compression can be enabled (described below). \pdftexprimitive {\Syntax {\Tex {\pdfcompresslevel} \Whatever{integer}}} \bookmark{\tex{pdfcompresslevel}} This integer parameter specifies the level of {\em stream} compression (text, inline graphics, and embedded \PNG\ images (only if they are un- and re-compressed during the embedding process); all done by the \type{zlib} library). Zero means no compression, 1~means fastest, 9~means best, $2..8$ means something in between. A value outside this range will be adjusted to the nearest meaningful value. This parameter is read each time \PDFTEX\ starts a stream. Setting \type{\pdfcompresslevel=0} is great for \PDF\ stream debugging. \pdftexprimitive {\Syntax {\Tex {\pdfobjcompresslevel} \Whatever{integer}}} \bookmark{\tex{pdfobjcompresslevel}} This integer parameter controls the compression of {\em non-stream} objects. In the \PDF-1.4 specification these objects still had to go into the \PDF\ file as clear text, uncompressed. The \PDF-1.5 specification now allows to collect non-stream objects as ``compressed objects'' into ``object stream'' objects (\type{/Type /ObjStm}, see \PDF\ Ref.\ 5th~ed., sect.~3.4.6). At the \PDF\ file end instead of the object table then an \type{/XRef} cross-reference stream is written out. This results in considerably smaller \PDF\ files, particularly if lots of annotations and links are used. \introduced{1.40.0} The writing of compressed objects is enabled by setting \type{\pdfobjcompresslevel} to a value between 1 and~3; it's disabled by value~0 (default). Enabling requires that also \type{\pdfminorversion}~$>$~4. If \type{\pdfobjcompresslevel}~$>$~0, but \type{\pdfminorversion}~$<$~5, a warning is given and object stream writing is disabled. The \type{\pdfobjcompresslevel} value is clipped to the range $0..3$. Using values outside this range is not recommended (for future extension). The \type{\pdfobjcompresslevel} settings have the following effects: When set to~0, no object streams are generated at all. When set to~1, all non-stream objects are compressed with the exception of any objects coming with embedded \PDF\ files (``paranoid'' mode, to avoid yet unknown problems), and also the \type{/Info} dictionary is not compressed for clear-text legibility. When set to~2, also all non-stream objects coming with embedded \PDF\ files are compressed, but the \type{/Info} dictionary is still not compressed. Finally, when set to~3, all non-stream objects are compressed, including the \type{/Info} dictionary (this means that the \type{/Info} can't be read as clear text any more). If object streams are to be used, currently \type{\pdfobjcompresslevel=2} is recommended, and set so in some distributions. \description{Caveat:} \PDF\ files generated with object streams enabled can't be read with (sufficiently old) \PDF\ viewers that don't understand \PDF-1.5 files. For widest distribution and unknown audience, don't activate object stream writing. The \PDF-1.5 standard describes also a hybrid object compression mode that gives some backward compatibility, but this is currently not implemented, as \PDF-1.5 was rather quickly adopted by modern \PDF\ viewers. Also not implemented is the optional \type{/Extends} key. \pdftexprimitive {\Syntax {\Tex {\pdfdecimaldigits} \Whatever{integer}}} \bookmark{\tex{pdfdecimaldigits}} This integer parameter specifies the numeric accuracy of real coordinates as written to the \PDF\ file. It gives the maximal number of decimal digits after the decimal point. Valid values are in range $0..4$. A higher value means more precise output, but also results in a larger file size and more time to display or print. In most cases the optimal value is~2. This parameter does not influence the precision of numbers used in raw \PDF\ code, like that used in \type{\pdfliteral} and annotation action specifications; also multiplication items (\eg\ scaling factors) are not affected and are always output with best precision. This parameter is read when \PDFTEX\ writes a real number to the \PDF\ output. When including huge \METAPOST\ images using \filename {supp-pdf.tex}, one can limit the accuracy to two digits by typing: \type{\twodigitMPoutput}. \pdftexprimitive {\Syntax {\Tex {\pdfhorigin} \Whatever{dimension}}} \bookmark{\tex{pdfhorigin}} This parameter can be used to set the horizontal offset the output box from the top left corner of the page. A value of 1~inch corresponds to the normal \TEX\ offset. This parameter is read when \PDFTEX\ starts shipping out a page to the \PDF\ output. For standard purposes, this parameter should always be kept at 1~true inch. If you want to shift text on the page, use \TEX's own \type{\hoffset} primitive. To avoid surprises, after global magnification has been changed by the \type{\mag} primitive, the \type{\pdfhorigin} parameter should still be 1~true inch, \eg\ by typing \type{\pdfhorigin=1 true in} after issuing the \type{\mag} command. Or, you can preadjust the \type{\pdfhorigin} value before typing \type{\mag}, so that its value after the \type{\mag} command ends up at 1~true inch again. \pdftexprimitive {\Syntax {\Tex {\pdfvorigin} \Whatever{dimension}}} \bookmark{\tex{pdfvorigin}} This parameter is the vertical companion of \type{\pdfhorigin}, and the notes above regarding \type{\mag} and true dimensions apply. Also keep in mind that the \TEX\ coordinate system starts in the top left corner (downward), while \PDF\ coordinates start at the bottom left corner (upward). \pdftexprimitive {\Syntax {\Tex {\pdfpagewidth} \Whatever{dimension}}} \bookmark{\tex{pdfpagewidth}} This dimension parameter specifies the page width of the \PDF\ output (the screen, the paper, etc.). \PDFTEX\ reads this parameter when it starts shipping out a page. After magnification has been changed by the \type{\mag} primitive, check that this parameter reflects the wished true page width. If the value is set to zero, the page width is calculated as $w_{\hbox{\txx box being shipped out}} + 2 \times (\hbox{horigin} + \hbox{\type{\hoffset}})$. When part of the page falls off the paper or screen, you can be rather sure that this parameter is set wrong. \pdftexprimitive {\Syntax {\Tex {\pdfpageheight} \Whatever{dimension}}} \bookmark{\tex{pdfpageheight}} Similar to the previous item, this dimension parameter specifies the page height of the \PDF\ output. If set to zero, the page height will be calculated analogously to the above. After magnification has been changed by the \type{\mag} primitive, check that this parameter reflects the wished true page height. %*********************************************************************** \subsection{The document info and catalog} \pdftexprimitive {\Syntax {\Tex {\pdfinfo} \Something{general text}}} \bookmark{\tex{pdfinfo}} This primitive allows the user to add information to the document info section; if this information is provided, it can be extracted, \eg\ by the pdfinfo program, or by the Adobe Reader (version 7.0: menu option {\em File $\longrightarrow$ Document Properties}). The \Something{general text} is a collection of key||value||pairs. The key names are preceded by a \type{/}, and the values, being strings, are given between parentheses. All keys are optional. Possible keys are \type{/Author}, \type{/CreationDate} (defaults to current date including time zone info), \type{/ModDate}, \type{/Creator} (defaults to \type {TeX}), \type{/Producer} (defaults to \hbox{\tt pdfTeX-\currentpdftex}), \type{/Title}, \type{/Subject}, and \type{/Keywords}. \type{/CreationDate} and \type{/ModDate} are expressed in the form \type{D:YYYYMMDDhhmmssTZ..}, where \type{YYYY} is the year, \type{MM} is the month, \type{DD} is the day, hh is the hour, \type{mm} is the minutes, \type{ss} is the seconds, and \type{TZ..} is an optional string denoting the time zone. An example of this format is shown below. For details please refer to the \PDFReference. Multiple appearances of \type{\pdfinfo} will be concatenated. In general, if a key is given more than once, one may expect that the first appearance will be used. Be aware however, that this behaviour is viewer dependent. Except expansion, \PDFTEX\ does not perform any further operations on \Something{general text} provided by the user. An example of the use of \type{\pdfinfo} is: \startesctyping \pdfinfo { /Title (example.pdf) /Creator (TeX) /Producer (pdfTeX @currentpdftex) /Author (Tom and Jerry) /CreationDate (D:20061226154343+01'00') /ModDate (D:20061226155343+01'00') /Subject (Example) /Keywords (mouse, cat) } \stopesctyping \pdftexprimitive {\Syntax {\Tex {\pdfcatalog} \Something{general text} \Optional{\Something{open-action spec}}}} \bookmark{\tex{pdfcatalog}} Similar to the document info section is the document catalog, where keys are \type{/URI}, which provides the base \URL\ of the document, and \type {/PageMode}, which determines how the \PDF\ viewer displays the document on startup. The possibilities for the latter are explained in \in {Table} [pagemode]: \startbuffer \starttabulate[|l|l|] \HL \NC \bf value \NC \bf meaning \NC\NR \HL \NC \tt /UseNone \NC neither outline nor thumbnails visible \NC\NR \NC \tt /UseOutlines \NC outline visible \NC\NR \NC \tt /UseThumbs \NC thumbnails visible \NC\NR \NC \tt /FullScreen \NC full||screen mode \NC\NR \HL \stoptabulate \stopbuffer \placetable [here][pagemode] {Supported \type{/PageMode} values.} {\getbuffer} In full||screen mode, there is no menu bar, window controls, nor any other window present. The default setting is \type{/UseNone}. The \Something{openaction} is the action provided when opening the document and is specified in the same way as internal links, see \in {section} [linking]. Instead of using this method, one can also write the open action directly into the catalog. \pdftexprimitive {\Syntax {\Tex {\pdfnames} \Something{general text}}} \bookmark{\tex{pdfnames}} This primitive inserts the \Something{general text} to the \type {/Names} array. The text must conform to the specifications as laid down in the \PDFReference, otherwise the document can be invalid. \pdftexprimitive {\Syntax {\Tex {\pdftrailer} \Something{general text}}} \bookmark{\tex{pdftrailer}} This command puts its argument text verbatim into the file trailer dictionary. \introduced{1.11a} %*********************************************************************** \subsection{Fonts} \pdftexprimitive {\Syntax {\Tex {\pdfpkresolution} \Whatever{integer}}} \bookmark{\tex{pdfpkresolution}} This integer parameter specifies the default resolution of embedded \PK\ fonts and is read when \PDFTEX\ embeds a \PK\ font during finishing the \PDF\ output. As bitmap fonts are still rendered poorly by some \PDF\ viewers, it is best to use Type~1 fonts when available. \pdftexprimitive {\Syntax {\Tex {\pdffontexpand} \Something{font} \Something{stretch} \Something{shrink} \Something{step} \Optional{\Literal{autoexpand}}}} \bookmark{\tex{pdffontexpand}} This extension to \TEX's font definitions controls a \PDFTEX\ automatism called {\em font expansion}. We describe this by an example: \starttyping \font\somefont=sometfm at 10pt \pdffontexpand\somefont 30 20 10 autoexpand \pdfadjustspacing=2 \stoptyping The \type{30 20 10} means this: \quotation {hey \TEX, when line breaking is going badly, you may stretch the glyphs from this font as much as 3\,\% or shrink them as much as 2\,\%}. For practical reasons \PDFTEX\ uses discrete expansion steps, in this example, 1\,\%. Roughly spoken, the trick is as follows. Consider a text typeset in triple column mode. When \TEX\ cannot break a line in the appropriate way, the unbreakable parts of the word will stick into the margin. When \PDFTEX\ notes this, it will try to scale (shrink) the glyphs in that line using fixed steps, until the line fits. When lines are too spacy, the opposite happens: \PDFTEX\ starts scaling (stretching) the glyphs until the white space gaps is acceptable. This glyph stretching and shrinking is called {\em font expansion}. To enable font expansion, don't forget to set \type{\pdfadjustspacing} to a value greater than zero. There are two different modes for font expansion: First, if the \type{autoexpand} option is there --- which is the recommended mode --- only a single map entry is needed for all expanded font versions, using the name of the unexpanded \TFM\ file ({\em tfmname}). No expanded {\em tfmname} versions need to mentioned (they are ignored), as \PDFTEX\ generates expanded copies of the unexpanded \TFM\ data structures and keeps them in its memory. Since \PDFTEX~1.40.0 the \type{autoexpand} mode happens within the page stream by modification of the text matrix (\PDF\ operator ``\type{Tm}''), and not anymore on font file level, giving the advantage that it now works not only with Type1 but also with TrueType and OpenType fonts (and even without embedding a font file; but that's not recommended). In this mode \PDFTEX\ requires only unexpanded font files. Second, if the \type{autoexpand} option is missing, setting up font expansion gets more tedious, as there must be map entries for \TFM\ files in all required expansion values. The expanded {\em tfmname} variants are constructed by adding the font expansion value to the {\em tfmname} of the base font, \eg\ there must be a map entry with {\em tfmname} \type{sometfm+10} for 1\,\% stretch or \type {sometfm-15} for 1.5\,\% shrink. This also means, that for each expanded font variant a \TFM\ file with properly expanded metrics must exist. Having several map entries for the various expansion values of a font requires to provide for each expansion value an individually crafted font file with expanded glyphs. Depending on how these glyphs are generated, this might give slightly better glyph forms than the rather simple glyph stretching used in \type{autoexpand mode}. The drawback is that several font files will be embedded in the \PDF\ output for each expanded font, leading to significantly larger \PDF\ files than in \type{autoexpand} mode. For moderate expansion values going without \type{autoexpand} mode is not worth the trouble. The font expansion mechanism is inspired by an optimization first introduced by Prof.~Hermann Zapf, which in itself goes back to optimizations used in the early days of typesetting: use different glyphs to optimize the grayness of a page. So, there are many, slightly different~a's, e's, etc. For practical reasons \PDFTEX\ does not use such huge glyph collections; it uses horizontal scaling instead. This is sub||optimal, and for many fonts, possibly offensive to the design. But, when using \PDF, it's not illogical: \PDF\ viewers use so||called Multiple Master fonts when no fonts are embedded and|/|or can be found on the target system. Such fonts are designed to adapt their design to the different scaling parameters. It is up to the user to determine to what extent mixing slightly remastered fonts can be used without violating the design. Think of an O: when geometrically stretched, the vertical part of the glyph becomes thicker, and looks incompatible with an unscaled original. With a Multiple Master situation, one can stretch while keeping this thickness compatible. \pdftexprimitive {\Syntax {\Tex {\pdfadjustspacing} \Whatever{integer}}} \bookmark{\tex{pdfadjustspacing}} This primitive provides a switch for enabling font expansion. By default, \type{\pdfadjustspacing} is set to~0; then font expansion is disabled, so that the \PDFTEX\ output is identical to that from the original \TEX\ engine. Font expansion can be activated in two modes. When \type{\pdfadjustspacing} is set to~1, font expansion is applied {\em after} \TEX's normal paragraph breaking routines have broken the paragraph into lines. In this case, line breaks are identical to standard \TEX\ behaviour. When set to~2, the width changes that are the result of stretching and shrinking are taken into account {\em while} the paragraph is broken into lines. In this case, line breaks are likely to be different from those of standard \TEX. In fact, paragraphs may even become longer or shorter. Both alternatives require a collection of \TFM\ files that are related to the \Something{stretch} and \Something{shrink} settings for the \type{\pdffontexpand} primitive, unless this is given with the \type{autoexpand} option. \pdftexprimitive {\Syntax {\Tex {\efcode} \Something{font} \Something{8-bit number} \Whatever{integer}}} \bookmark{\tex{efcode}} We didn't yet tell the whole story. One can imagine that some glyphs are visually more sensitive to stretching or shrinking than others. Then the \type{\efcode} primitive can be used to influence the expandability of individual glyphs within a given font, as a factor to the expansion setting from the \type{\pdffontexpand} primitive. The syntax is similar to \type{\sfcode} (but with the \Something{font} required), and it defaults to~1000, meaning 100\,\% expandability. The given integer value is clipped to the range $0..1000$, corresponding to a usable expandability range of 0..100\,\%. Example: \starttyping \efcode\somefont`A=800 \efcode\somefont`O=0 \stoptyping Here an A may stretch or shrink only by 80\,\% of the current expansion value for that font, and expansion for the~O is disabled. The actual expansion is still bound to the steps as defined by \type{\pdffontexpand} primitive, otherwise one would end up with more possible font inclusions than would be comfortable. \pdftexprimitive {\Syntax {\Tex {\pdfprotrudechars} \Whatever{integer}}} \bookmark{\tex{pdfprotrudechars}} Yet another way of optimizing paragraph breaking is to let certain characters move into the margin (`character protrusion'). When \type{\pdfprotrudechars=1}, the glyphs qualified as such will make this move when applicable, without changing the line-breaking. When \type{\pdfprotrudechars=2} (or greater), character protrusion will be taken into account while considering breakpoints, so line-breaking might be changed. This qualification and the amount of shift are set by the primitives \type{\rpcode} and \type{\lpcode}. Character protrusion is disabled when \type{\pdfprotrudechars=0} (or negative). If you want to protrude some item other than a character (\eg\ a \type{\hbox}), you can do so by padding the item with an invisible zero||width character, for which protrusion is activated. \pdftexprimitive {\Syntax {\Tex {\rpcode} \Something{font} \Something{8-bit number} \Whatever{integer}}} \bookmark{\tex{rpcode}} The amount that a character from a given font may shift into the right margin (`character protrusion') is set by the primitive \type {\rpcode}. The protrusion distance is the integer value given to \type {\rpcode}, multiplied with 0.001\,em from the current font. The given integer value is clipped to the range $-1000..1000$, corresponding to a usable protrusion range of $-$1\,em..1\,em. Example: \starttyping \rpcode\somefont`,=200 \rpcode\somefont`-=150 \stoptyping Here the comma may shift by 0.2\,em into the margin and the hyphen by 0.15\,em. All these small bits and pieces will help \PDFTEX\ to give you better paragraphs (use \type{\rpcode} judiciously; don't overdo it). Remark: old versions of \PDFTEX\ use the character width as measure. This was changed to a proportion of the em-width after \THANH\ finished his master's thesis. \pdftexprimitive {\Syntax {\Tex {\lpcode} \Something{font} \Something{8-bit number} \Whatever{integer}}} \bookmark{\tex{lpcode}} This is similar to \type{\rpcode}, but affects the amount by which characters may protrude into the left margin. Also here the given integer value is clipped to the range $-1000..1000$. \pdftexprimitive {\Syntax {\Tex {\leftmarginkern} \Something{box number} \Whatever{expandable}}} \bookmark{\tex{leftmarginkern}} The \Tex{\leftmarginkern} \Something{box number} primitive expands to the width of the margin kern at the left side of the horizontal list stored in \Tex{\box} \Something{box number}. The expansion string includes the unit \type{pt}. \Eg, when the left margin kern of \type{\box0} amounts to $-$10\,pt, \type{\leftmarginkern0} will expand to \type{-10pt}. A similar primitive \type{\rightmarginkern} exists for the right margin. \introduced{1.30.0} These are auxiliary primitives to make character protrusion more versatile. When using the \TEX\ primitive \type{\unhbox} or \type{\unhcopy}, the margin kerns at either end of the unpackaged hbox will be removed (\eg\ to avoid weird effects if several hboxes are unpackaged behind each other into the same horizontal list). These \type{\unhbox} or \type{\unhcopy} are often used together with \type{\vsplit} for dis- and re||assembling of paragraphs, \eg\ to add line numbers. Paragraphs treated like this do not show character protrusion by default, as the margin kerns have been removed during the unpackaging process. The \type{\leftmarginkern} and \type{\rightmarginkern} primitives allow to access the margin kerns and store them away before unpackaging the hbox. \Eg\, the following code snipplet restores margin kerning of a horizontal list stored in \type{\box\testline}, resulting in a hbox with proper margin kerning (which is then done by ordinary kerns). \starttyping \dimen0=\leftmarginkern\testline \dimen1=\rightmarginkern\testline \hbox to\hsize{\kern\dimen0\unhcopy\testline\kern\dimen1} \stoptyping \pdftexprimitive {\Syntax {\Tex {\rightmarginkern} \Something{box number} \Whatever{expandable}}} \bookmark{\tex{rightmarginkern}} The \Tex{\rightmarginkern} \Something{box number} primitive expands to the width of the margin kern at the right side of the horizontal list stored in \Tex{\box} \Something{box number}. See \type{\leftmarginkern} for more details. \introduced{1.30.0} \pdftexprimitive {\Syntax {\Tex {\letterspacefont} \Something{control sequence} \Something{font} \Something{integer}}} \bookmark{\tex{letterspacefont}} This primitive creates an instance of \Something{font} with the widths of all glyphs increased by \Something{integer} thousandths of an em (as set in \Something{font}). The effect is letter spacing, but the glyphs are actually larger (sidebearings are increased), so a single glyph will take more space. For instance, the following creates a font \type{\lsfont} whose glyphs are all 1.2\,pt larger than those of \type{\normalfont}: \starttyping \font\normalfont=myfont at 12pt \letterspacefont\lsfont\normalfont 100 \stoptyping Negative values are allowed for \Something{integer}. Letter spacing works natively in \PDF\ mode only, unless special fonts are devised (in our example, a \type{myfont+100ls} font), as with font expansion. \pdftexprimitive {\Syntax {\Tex {\pdfcopyfont} \Something{control sequence} \Something{font}}} \bookmark{\tex{pdfcopyfont}} This primitive defines \Something{control sequence} as a synonym for \Something{font}. \pdftexprimitive {\Syntax {\Tex {\pdffontattr} \Something{font} \Something{general text}}} \bookmark{\tex{pdffontattr}} This primitive inserts the \Something{general text} to the \type {/Font} dictionary. The text must conform to the specifications as laid down in the \PDFReference, otherwise the document can be invalid. \pdftexprimitive {\Syntax {\Tex {\pdffontname} \Something{font} \Whatever {expandable}}} \bookmark{\tex{pdffontname}} In \PDF\ files produced by \PDFTEX\ one can recognize a font resource by the prefix~\type{/F} followed by a number, for instance \type{/F12} or \type{/F54}. For a given \TEX\ \Something{font}, this primitive expands to the number from the corresponding font resource name. \Eg, if \type{/F12} corresponds to some \TEX\ font \type{\foo}, the \type{\pdffontname\foo} expands to the number~\type{12}. In the current implementation, when \type{\pdfuniqueresname} (see below) is set to a positive value, the \type{\pdffontname} still returns only the number from the font resource name, but not the appended random string. \pdftexprimitive {\Syntax {\Tex {\pdffontobjnum} \Something{font} \Whatever {expandable}}} \bookmark{\tex{pdffontobjnum}} This command is similar to \type{\pdffontname}, but it returns the \PDF\ object number of the font dictionary instead of the number from the font resource name. \Eg, if the font dictionary (\type{/Type /Font}) in \PDF\ object~3 corresponds to some \TEX\ font \type{\foo}, the \type{\pdffontobjnum\foo} gives the number~\type{3}. Use of \type{\pdffontname} and \type {\pdffontobjnum} allows users full access to all the font resources used in the document. \pdftexprimitive {\Syntax {\Tex {\pdffontsize} \Something{font} \Whatever {expandable}}} \bookmark{\tex{pdffontsize}} This primitive expands to the font size of the given font, with unit \type{pt}. \Eg, when using the plain \TeX\ macro package, the call \type{\pdffontsize\tenrm} expands to \type{10.0pt}. \pdftexprimitive {\Syntax {\Tex {\pdfincludechars} \Something{font} \Something{general text}}} \bookmark{\tex{pdfincludechars}} This command causes \PDFTEX\ to treat the characters in \Something{general text} as if they were used with \Something{font}\unkern, which means that the corresponding glyphs will be embedded into the font resources in the \PDF\ output. Nothing is appended to the list being built. \pdftexprimitive {\Syntax {\Tex {\pdfuniqueresname} \Whatever{integer}}} \bookmark{\tex{pdfuniqueresname}} When this primitive is assigned a positive number, \PDF\ resource names will be made reasonably unique by appending a random string consisting of six \ASCII\ characters. \pdftexprimitive {\Syntax {\Tex {\pdfmapfile} \Something{map spec}}} \bookmark{\tex{pdfmapfile}} This primitive is used for reading a font map file consisting of one or more font map lines. The name of the map file is given in the \Something{map spec} together with an optional leading modifier character. If no \type{\pdfmapfile} primitive is given, the default map file \filename{pdftex.map} will be read by \PDFTEX. There is a companion primitive \type{\pdfmapline} that allows to scan single map lines; its map line argument has the same syntax as the map lines from a map file. Both primitives can be used concurrently. The \type{\pdfmapfile} primitive is fast for reading external bulk font map information (many map lines collected in a map file), whereas the \type{\pdfmapline} allows to put the font map information for individual \TeX\ fonts right into the \TeX\ source or a style file. In any case the map line information is scanned by \PDFTEX, and in the most common case the data are put into a fresh internal map entry data structure, which is then consulted once a font is called. Normally there is no need for the \PDFTEX\ user to bother about the \type{\pdfmapfile} or \type{\pdfmapline} primitives, as the main \TEX\ distributions provide nice helper tools that automatically assemble the default font map file. Prominent tool examples are the scripts \type{updmap} and \type{updmap-sys} coming with \TEXLIVE\ and \TETEX. If your map file isn't in the current directory (or a standard system directory), you will need to set the \type{TEXFONTMAPS} variable (in \WEBC) or give an explicit path so that it will be found. When the \type{\pdfmapfile} or \type{\pdfmapline} primitive is read by \PDFTEX, the argument (map file or map line) will be processed {\em immediately}, and the internal map entry database is updated. The operation mode of the \type{\pdfmapfile} and \type{\pdfmapline} primitives is selected by an optional modifier character (\type{+}, \type{=}, \type{-}) in front of the {\em tfmname} field. This modifier defines how the individual map lines are going to be handled, and how a collision between an already registered map entry and a newer one is resolved; either ignoring a later entry, or replacing or deleting an existing entry. But in any case, map entries of fonts already in use are kept untouched. Here are two examples: \starttyping \pdfmapfile{+myfont.map} \pdfmapline{+ptmri8r Times-Italic <8r.enc