-
Notifications
You must be signed in to change notification settings - Fork 33
/
hyperref-doc.tex
3834 lines (3174 loc) · 149 KB
/
hyperref-doc.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% This is the manual for the LaTeX hyperref package.
%
% Copyright (C) 1998-2003 Sebastian Rahtz.
% Copyright (C) 2003 Steve Peter and Karl Berry
% Copyright (C) 2006-2012 Heiko Oberdiek.
% Copyright (C) 2017-2019 David Carlisle Ulrike Fischer
% Copyright (C) 2019-2020 The LaTeX3 Project
%
% Permission is granted to copy, distribute and/or modify this document
% under the terms of the GNU Free Documentation License, Version 1.1 or
% any later version published by the Free Software Foundation; with no
% Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
% Texts. A copy of the license is included in the section entitled
% ``GNU Free Documentation License.''
%
\def\mydate{January 2020}
\RequirePackage{iftex}
\ifpdf % We are running pdfTeX in pdf mode
\ifx\directlua\undefinded
\documentclass[pdftex]{article}
\else
\documentclass[luatex]{article}
\fi
\else
\documentclass{article}
\fi
\usepackage{pifont}
\usepackage{calc}
\usepackage{hologo}
\def\OzTeX{O\kern-0.03em z\kern-0.15em \TeX}
\newcommand*{\cs}[1]{%
\texttt{\textbackslash #1}%
}
\newcommand*{\xpackage}[1]{\textsf{#1}}
\newcommand*{\xoption}[1]{\textsf{#1}}
% from doc.sty
\makeatletter
\ifx\l@nohyphenation\@undefined
\newlanguage\l@nohyphenation
\fi
\ifx\l@nohyphenation\@undefined
\newlanguage\l@nohyphenation
\fi
\DeclareRobustCommand\meta[1]{%
\ensuremath\langle
\ifmmode \expandafter \nfss@text \fi
{%
\meta@font@select
\edef\meta@hyphen@restore
{\hyphenchar\the\font\the\hyphenchar\font}%
\hyphenchar\font\m@ne
\language\l@nohyphenation
#1\/%
\meta@hyphen@restore
}%
\ensuremath\rangle
}
\def\meta@font@select{\ttfamily\itshape}
\makeatother
% Page layout.
\advance\textwidth by 1.1in
\advance\oddsidemargin by -.55in
\advance\evensidemargin by -.55in
%
\advance\textheight by 1in
\advance\topmargin by -.5in
\advance\footskip by -.5in
%
\pagestyle{headings}
%
% Avoid some overfull boxes.
\emergencystretch=.1\hsize
\hbadness = 3000
% these are from lshort.sty, but lshort.sty pulls in so many other
% packages it seems cleaner to just include them here.
%
\newcommand{\bs}{\symbol{'134}}%Print backslash
\newcommand{\ci}[1]{\texttt{\bs#1}}
\makeatletter
\@ifpackageloaded{tex4ht}{%
% separate definition for HTML case to avoid
% nasty borders with double horizontal lines with
% large gaps.
\newsavebox{\cmdsyntaxbox}%
\newenvironment{cmdsyntax}{%
\par
% \small
\addvspace{3.2ex plus 0.8ex minus 0.2ex}%
\vskip -\parskip
\noindent
\begin{lrbox}{\cmdsyntaxbox}%
\begin{tabular}{l}%
\rule{0pt}{1em}%
\ignorespaces
}{%
\end{tabular}%
\end{lrbox}%
\fbox{\usebox{\cmdsyntaxbox}}%
\par
\nopagebreak
\addvspace{3.2ex plus 0.8ex minus 0.2ex}%
\vskip -\parskip
}%
}{%
\newenvironment{cmdsyntax}{%
\par
\small
\addvspace{3.2ex plus 0.8ex minus 0.2ex}%
\vskip -\parskip
\noindent
\begin{tabular}{|l|}%
\hline
\rule{0pt}{1em}%
\ignorespaces
}{%
\\%
\hline
\end{tabular}%
\par
\nopagebreak
\addvspace{3.2ex plus 0.8ex minus 0.2ex}%
\vskip -\parskip
}%
}
\makeatother
\usepackage{array,longtable}
\ifnum 0\ifluatex 1\else\ifxetex 1\fi\fi=0 %
\usepackage[T1]{fontenc}%
\usepackage{lmodern}%
\renewcommand*{\ttdefault}{lmvtt}%
\else
\usepackage{fontspec}%
\renewcommand*{\ttdefault}{lmvtt}%
\fi
\newcommand*{\Quote}[1]{\textquotedblleft#1\textquotedblright}
\def\Hanh{H\`an Th\^e\llap{\raise 0.5ex\hbox{\'{}}} Th\`anh}
\ifpdf
\usepackage[%
% pdftex,% might be luatex, just allow automatic default
colorlinks,%
hyperindex,%
plainpages=false,%
bookmarksopen,%
bookmarksnumbered,
pdfusetitle,%
]{hyperref}
%%?? \def\pdfBorderAttrs{/Border [0 0 0] } % No border arround Links
\else
\usepackage{hyperref}
\fi
\makeatletter
\@ifpackageloaded{tex4ht}{%
\author{Sebastian Rahtz (deceased)\and
Heiko Oberdiek (inactive)\and
The \LaTeX3 Project (\url{https://github.com/latex3/hyperref/issues})}
}{%
\usepackage{bmhydoc}%
\author{Sebastian Rahtz\thanks{deceased}\and
Heiko Oberdiek\thanks{inactive}\and
The \LaTeX3 Project\thanks{\url{https://github.com/latex3/hyperref/issues}}}
}
\makeatother
\title{Hypertext marks in \hologo{LaTeX}: a manual for \xpackage{hyperref}}
\date{2021-02-07 v7.00h}
\begin{document}
% comes out too close to the toc, and we know it's page one anyway.
\thispagestyle{empty}
\maketitle
\tableofcontents
\setcounter{tocdepth}{2}% for bookmark levels
\section{Introduction}
The package derives from, and builds on, the work of the Hyper\hologo{TeX}
project, described at \texttt{http://xxx.lanl.gov/hypertex/}\footnote{Now: \url{https://ctan.org/tex-archive/support/hypertex/hypertex}}. It extends
the functionality of all the \hologo{LaTeX} cross-referencing commands
(including the table of contents, bibliographies etc) to produce
\cs{special} commands which a driver can turn into hypertext links;
it also provides new commands to allow the user to write \emph{ad hoc}
hypertext links, including those to external documents and URLs.
The package is currently maintained at \url{https://github.com/latex3/hyperref/} and issues should
be reported there.
This manual provides a brief overview of the \xpackage{hyperref}
package. For more details, you should read the additional documentation
distributed with the package, as well as the complete documentation by
processing \texttt{hyperref.dtx}. You should also read the chapter on
\xpackage{hyperref} in \textit{The \hologo{LaTeX} Web Companion}, where you will
find additional examples.
The Hyper\hologo{TeX} specification\footnote{This is borrowed from an article
by Arthur Smith.} says that conformant viewers/translators must
recognize the following set of \cs{special} constructs:
\begin{description}
\item[href:] \verb|html:<a href = "href_string">|
\item[name:] \verb|html:<a name = "name_string">|
\item[end:] \verb|html:</a>|
\item[image:] \verb|html:<img src = "href_string">|
\item[base\_name:] \verb|html:<base href = "href_string">|
\end{description}
The \emph{href}, \emph{name} and \emph{end} commands are used to do the
basic hypertext operations of establishing links between sections of
documents. The \emph{image} command is intended (as with current HTML
viewers) to place an image of arbitrary graphical format on the page in
the current location. The \emph{base\_name} command is be used to
communicate to the DVI viewer the full (URL) location of the current
document so that files specified by relative URLs may be retrieved
correctly.
The \emph{href} and \emph{name} commands must be paired with an
\emph{end} command later in the \TeX\ file---the \TeX\ commands between
the two ends of a pair form an \emph{anchor} in the document. In the
case of an \emph{href} command, the \emph{anchor} is to be highlighted
in the \emph{DVI viewer}, and when clicked on will cause the scene to
shift to the destination specified by \emph{href\_string}. The
\emph{anchor} associated with a name command represents a possible
location to which other hypertext links may refer, either as local
references (of the form \verb|href="#name_string"| with the
\emph{name\_string} identical to the one in the name command) or as part
of a URL (of the form \emph{URL\#name\_string}). Here
\emph{href\_string} is a valid URL or local identifier, while
\emph{name\_string} could be any string at all: the only caveat is that
`$\verb|"|$' characters should be escaped with a backslash
($\backslash$), and if it looks like a URL name it may cause problems.
However, the drivers intended to produce \emph{only} PDF use literal
PostScript or PDF \verb|\special| commands. The commands are defined in
configuration files for different drivers, selected by package options;
at present, the following drivers are supported:
\begin{description}
\item[hypertex] DVI processors conforming to the Hyper\TeX\ guidelines (i.e.\ \textsf{xdvi}, \textsf{dvips} (with
the \textsf{-z} option), \textsf{\OzTeX}, and \textsf{Textures})
\item[dvips] produces \verb|\special| commands tailored for \textsf{dvips}
\item[dvipsone] produces \verb|\special| commands tailored for \textsf{dvipsone}
\item[ps2pdf] a special case of output suitable for processing by earlier versions of Ghost\-script's
PDF writer; this is basically the same as that for \textsf{dvips}, but a few variations remained before version 5.21
\item[tex4ht] produces \verb|\special| commands for use with \textsf{\TeX4ht}
\item[pdftex] pdf\TeX, \Hanh{}'s \TeX{} variant that writes PDF directly
\item[luatex] lua\TeX, Unicode \TeX{} variant that writes PDF directly
\item[dvipdfm] produces \verb|\special| commands for Mark Wicks' DVI to PDF driver \textsf{dvipdfm}
\item[dvipdfmx] produces \verb|\special| commands for driver
\textsf{dvipdfmx}, a successor of \textsf{dvipdfm}
\item[dviwindo] produces \verb|\special| commands that Y\&Y's Windows previewer interprets as hypertext jumps within the previewer
\item[vtex] produces \verb|\special| commands that MicroPress' HTML and
PDF-producing \TeX\ variants interpret as hypertext jumps within the
previewer
\item[textures] produces \verb|\special| commands that \textsf{Textures} interprets as hypertext jumps within the previewer
\item[xetex] produces \verb|\special| commands for Xe\TeX{}
\end{description}
Output from \textsf{dvips} or \textsf{dvipsone} must be processed using
Acrobat Distiller to obtain a PDF file.\footnote{Make sure you turn off
the partial font downloading supported by \textsf{dvips} and
\textsf{dvipsone} in favor of Distiller's own system.} The result is
generally preferable to that produced by using the \textsf{hypertex}
driver, and then processing with \textsf{dvips -z}, but the DVI file is
not portable. The main advantage of using the Hyper\TeX\ \ci{special}
commands is that you can also use the document in hypertext DVI viewers,
such as \textsf{xdvi}.
\begin{description}
\item[driverfallback]
If a driver is not given and cannot be autodetected, then use
the driver option, given as value to this option \textsf{driverfallback}.
Example:
\begin{quote}
\texttt{driverfallback=dvipdfm}
\end{quote}
Autodetected drivers (\textsf{pdftex}, \textsf{xetex}, \textsf{vtex},
\textsf{vtexpdfmark}) are recognized from within \TeX\ and
therefore cannot be given as value to option \textsf{driverfallback}.
However a DVI driver program is run after the \TeX\ run is finished.
Thus it cannot be detected at \TeX\ macro level. Then package
\xpackage{hyperref}
uses the driver, given by \textsf{driverfallback}. If the driver
is already specified or can be autodetected, then option
\textsf{driverfallback} is ignored.
\end{description}
\section{Implicit behavior}
This package can be used with more or less any normal \LaTeX\ document
by specifying in the document preamble
\begin{verbatim}
\usepackage{hyperref}
\end{verbatim}
Make sure it comes \emph{last} of your loaded packages, to give it a
fighting chance of not being over-written, since its job is to redefine
many \LaTeX\ commands. Hopefully you will find that all cross-references
work correctly as hypertext. For example, \ci{section} commands will
produce a bookmark and a link, whereas \ci{section*} commands will only
show links when paired with a corresponding \ci{addcontentsline}
command.
In addition, the \texttt{hyperindex} option (see below) attempts to make
items in the index by hyperlinked back to the text, and the option
\texttt{backref} inserts extra `back' links into the bibliography for
each entry. Other options control the appearance of links, and give
extra control over PDF output. For example, \texttt{colorlinks}, as its
name well implies, colors the links instead of using boxes; this is the
option used in this document.
\section{Package options}
All user-configurable aspects of \xpackage{hyperref} are set using a
single `key=value' scheme (using the \xpackage{keyval} package) with the
key \texttt{Hyp}. The options can be set either in the optional argument
to the \cs{usepackage} command, or using the \cs{hypersetup}
macro. When the package is loaded, a file \texttt{hyperref.cfg} is read
if it can be found, and this is a convenient place to set options on a
site-wide basis.
Note however that some options (for example \texttt{unicode}) can only be used as
package options, and not in \verb|\hypersetup| as the option settings are processed
as the package is read.
As an example, the behavior of a particular file could be controlled by:
\begin{itemize}
\item a site-wide \texttt{hyperref.cfg} setting up the look of links,
adding backreferencing, and setting a PDF display default:
\begin{verbatim}
\hypersetup{backref,
pdfpagemode=FullScreen,
colorlinks=true}
\end{verbatim}
\item A global option in the file, which is passed down to
\textsf{hyperref}:
\begin{verbatim}
\documentclass[dvips]{article}
\end{verbatim}
\item File-specific options in the \cs{usepackage} commands, which
override the ones set in \texttt{hyperref.cfg}:
\begin{verbatim}
\usepackage[colorlinks=false]{hyperref}
\hypersetup{pdftitle={A Perfect Day}}
\end{verbatim}
\end{itemize}
As seen in the previous example, information entries
(pdftitle, pdfauthor, \dots) should be set after the package is loaded.
Otherwise \LaTeX\ expands the values of these options prematurely.
Also \LaTeX\ strips spaces in options. Especially option `pdfborder'
requires some care. Curly braces protect the value, if given
as package option. They are not necessary in \verb|\hypersetup|.
\begin{verbatim}
\usepackage[pdfborder={0 0 0}]{hyperref}
\hypersetup{pdfborder=0 0 0}
\end{verbatim}
Package `kvoptions-patch' patches \LaTeX\ to make it aware
of key value options and to prevent premature value expansions.
Some options can be given at any time, but many are restricted: before
\verb|\begin{document}|, only in \verb|\usepackage[...]{hyperref}|,
before first use, etc.
In the key descriptions that follow, many options do not need a value,
as they default to the value true if used. These are the ones classed as
`boolean'. The values true and false can always be specified, however.
\subsection{General options}
Firstly, the options to specify general behavior and page size.
\medskip
\begin{longtable}{>{\ttfamily}ll>{\itshape}ll}
draft & boolean & false & all hypertext options are turned off \\
final & boolean & true & all hypertext options are turned on \\
debug & boolean & false & extra diagnostic messages are printed in \\
& & & the log file \\
verbose & boolean & false & same as debug \\
implicit & boolean & true & redefines \LaTeX\ internals \\
setpagesize & boolean & true & sets page size by special driver commands
\end{longtable}
\subsection{Options for destination names}
Destinations names (also anchor, target or link names) are internal
names that identify a position on a page in the document. They
are used in link targets for inner document links or the bookmarks,
for example.
Usually anchor are set, if \cs{refstepcounter} is called.
Thus there is a counter name and value. Both are used to
construct the destination name. By default the counter value
follows the counter name separated by a dot. Example for
the fourth chapter:
\begin{quote}
\verb|chapter.4|
\end{quote}
This scheme is used by:
\begin{description}
\item[\cs{autoref}] displays the description label for the
reference depending on the counter name.
\item[\cs{hyperpage}] is used by the index to get
page links. Page anchor setting (\verb|pageanchor|) must not
be turned off.
\end{description}
It is very important that the destination names are unique,
because two destinations must not share the same name.
The counter value \cs{the<counter>} is not always unique
for the counter. For example, table and figures can be numbered
inside the chapter without having the chapter number in their
number. Therefore \xpackage{hyperref} has introduced \cs{theH<counter>}
that allows a unique counter value without messing up with
the appearance of the counter number. For example, the number
of the second table in the third chapter might be printed
as \texttt{2}, the result of \cs{thetable}. But the
destination name \texttt{table.2.4} is unique because it
has used \cs{theHtable} that gives \verb|2.4| in this case.
Often the user do not need to set \cs{theH<counter>}. Defaults
for standard cases (chapter, \dots) are provided. And after \xpackage{hyperref}
is loaded, new counters with parent counters also define
\cs{theH<counter>} automatically, if \cs{newcounter}, \cs{@addtoreset}
or \cs{numberwithin} of package \xpackage{amsmath} are used.
Usually problems with duplicate destination names can be solved
by an appropriate definition of \cs{theH<counter>}. If option
\texttt{hypertexnames} is disabled, then a unique artificial
number is used instead of the counter value. In case of page
anchors the absolute page anchor is used. With option \texttt{plainpages}
the page anchors use the arabic form. In both latter cases \cs{hyperpage}
for index links is affected and might not work properly.
If an unnumbered entity gets an anchor (starred forms of
chapters, sections, \dots) or \cs{phantomsection} is used,
then the dummy counter name \texttt{section*} and an artificial
unique number is used.
If the final PDF file is going to be merged with another file, than
the destination names might clash, because both documents might
contain \texttt{chapter.1} or \texttt{page.1}. Also \xpackage{hyperref}
sets anchor with name \texttt{Doc-Start} at the begin of the document.
This can be resolved by redefining \cs{HyperDestNameFilter}.
Package \xpackage{hyperref} calls this macro each time, it uses a
destination name.
The macro must be expandable and expects the destination name
as only argument. As example, the macro is redefined to add
a prefix to all destination names:
\begin{quote}
\begin{verbatim}
\renewcommand*{\HyperDestNameFilter}[1]{\jobname-#1}
\end{verbatim}
\end{quote}
In document \texttt{docA} the destination name \texttt{chapter.2}
becomes \texttt{docA-chapter.2}.
Destination names can also be used from the outside in URIs(, if the
driver has not removed or changed them), for example:
\begin{quote}
\begin{verbatim}
http://somewhere/path/file.pdf#nameddest=chapter.4
\end{verbatim}
\end{quote}
However using a number seems unhappy. If another chapter is added
before, the number changes. But it is very difficult to pass
a new name for the destination to the anchor setting process that
is usually deep hidden in the internals. The first name of
\cs{label} after the anchor setting seems a good approximation:
\begin{quote}
\begin{verbatim}
\section{Introduction}
\label{intro}
\end{verbatim}
\end{quote}
Option \texttt{destlabel} checks for each \cs{label}, if there is
a new destination name active and replaces the destination
name by the label name. Because the destination name is already in use
because of the anchor setting, the new name is recorded in the \texttt{.aux}
file and used in the subsequent \hologo{LaTeX} run. The renaming is done by
a redefinition of \cs{HyperDestNameFilter}. That leaves the old
destination names intact (e.g., they are needed for \cs{autoref}).
This redefinition is also available as \cs{HyperDestLabelReplace},
thus that an own redefinition can use it.
The following example also adds a prefix for \emph{all} destination names:
\begin{quote}
\begin{verbatim}
\renewcommand*{\HyperDestNameFilter}[1]{%
\jobname-\HyperDestLabelReplace{#1}%
}
\end{verbatim}
\end{quote}
The other case that only files prefixed that do not have a corresponding
\cs{label} is more complicate, because \cs{HyperDestLabelReplace} needs
the unmodified destination name as argument. This is solved by an
expandable string test (\cs{pdfstrcmp} of \hologo{pdfTeX}
or \cs{strcmp} of \hologo{XeTeX}, package \xpackage{pdftexcmds} also supports
\hologo{LuaTeX}):
\begin{quote}
\begin{verbatim}
\usepackage{pdftexcmds}
\makeatletter
\renewcommand*{\HyperDestNameFilter}[1]{%
\ifcase\pdf@strcmp{#1}{\HyperDestLabelReplace{#1}} %
\jobname-#1%
\else
\HyperDestLabelReplace{#1}%
\fi
}
\makeatother
\end{verbatim}
\end{quote}
With option \texttt{destlabel} destinations can also named manually,
if the destination is not yet renamed:
\begin{quote}
\verb|\HyperDestRename{|\meta{destination}\verb|}{|\meta{newname}\verb|}|
\end{quote}
Hint: Anchors can also be named and set by \cs{hypertarget}.
\medskip
\begin{longtable}{>{\ttfamily}ll>{\itshape}ll}
destlabel & boolean & false & destinations are named by first \cs{label}\\
& & & after anchor creation\\
hypertexnames & boolean & true & use guessable names for links \\
naturalnames & boolean & false & use \LaTeX-computed names for links \\
plainpages & boolean & false & Forces page anchors to be named by the Arabic form \\
& & & of the page number, rather than the formatted form. \\
\end{longtable}
\subsection{Configuration options}
\begin{longtable}{>{\ttfamily}ll>{\itshape}lp{9cm}}
raiselinks & boolean & true & In the hypertex driver, the height of links is normally calculated by the driver as
simply the base line of contained text; this options forces \verb|\special| commands to
reflect the real height of the link (which could contain a graphic) \\
breaklinks & boolean & both & This option is in hyperref only used in the dviwindo driver, in all other cases it doesn't do anything sensible---it neither allows nor prevents links to be broken. The ocgx2 package
checks the state of the boolean.\\
pageanchor & boolean & true & Determines whether every page is given an implicit anchor at the top left corner. If this
is turned off, \verb|\printindex| will not contain
valid hyperlinks. \\
nesting & boolean & false & Allows links to be nested; no drivers currently support this.
\end{longtable}
Note for option \verb|breaklinks|:
The correct value is automatically set according to the driver features.
It can be overwritten for drivers that do not support broken links.
However, at any case, the link area will be wrong and displaced.
\subsection{Backend drivers}
If no driver is specified, the package tries to find a driver in
the following order:
\begin{enumerate}
\item Autodetection, some \TeX\ processors can be detected at \TeX\ macro
level (pdf\TeX, Xe\TeX, V\TeX).
\item Option \textsf{driverfallback}. If this option is set, its value
is taken as driver option.
\item Macro \cs{Hy@defaultdriver}. The macro takes a driver file
name (without file extension).
\item Package default is \textsf{hypertex}.
\end{enumerate}
Many distributions are using a driver file \texttt{hypertex.cfg} that
define \cs{Hy@defaultdriver} with \texttt{hdvips}. This is recommended
because driver \textsf{dvips} provides much more features than
\textsf{hypertex} for PDF generation.
\begin{longtable}{@{}>{\ttfamily}lp{.8\hsize}@{}}
driverfallback & Its value is used as driver option\\
& if the driver is not given or autodetected.\\
dvipdfm & Sets up \textsf{hyperref} for use with the \textsf{dvipdfm} driver.\\
dvipdfmx & Sets up \textsf{hyperref} for use with the \textsf{dvipdfmx} driver.\\
dvips & Sets up \textsf{hyperref} for use with the \textsf{dvips} driver. \\
dvipsone & Sets up \textsf{hyperref} for use with the \textsf{dvipsone} driver. \\
dviwindo & Sets up \textsf{hyperref} for use with the \textsf{dviwindo} Windows previewer. \\
hypertex & Sets up \textsf{hyperref} for use with the Hyper\TeX-compliant drivers. \\
latex2html & Redefines a few macros for compatibility with \textsf{latex2html}. \\
nativepdf & An alias for \textsf{dvips} \\
pdfmark & An alias for \textsf{dvips} \\
pdftex & Sets up \textsf{hyperref} for use with the \textsf{pdftex} program.\\
ps2pdf & Redefines a few macros for compatibility with
Ghostscript's PDF writer, otherwise identical to
\textsf{dvips}. \\
tex4ht & For use with \textsf{\TeX4ht} \\
textures & For use with \textsf{Textures} \\
vtex & For use with MicroPress' \textsf{VTeX}; the PDF
and HTML backends are detected automatically. \\
vtexpdfmark & For use with \textsf{VTeX}'s PostScript backend. \\
xetex & For use with Xe\TeX\ (using backend for dvipdfm).
\end{longtable}
\smallskip
If you use \textsf{dviwindo}, you may need to redefine the macro
\ci{wwwbrowser} (the default is \verb|C:\netscape\netscape|) to tell
\textsf{dviwindo} what program to launch. Thus, users of Internet
Explorer might add something like this to hyperref.cfg:
\begin{verbatim}
\renewcommand{\wwwbrowser}{C:\string\Program\space
Files\string\Plus!\string\Microsoft\space
Internet\string\iexplore.exe}
\end{verbatim}
\subsection{Extension options}
\begin{longtable}{@{}>{\ttfamily}ll>{\itshape}lp{8cm}@{}}
extension & text & & Set the file extension (e.g.\ \textsf{dvi}) which will be appended to file links
created if you use the \xpackage{xr} package. \\
hyperfigures & boolean & & \\
backref & text & false & Adds `backlink' text to the end of each item in the bibliography, as a list of
section numbers. This can only work properly \emph{if} there is a blank line after
each \verb|\bibitem|. Supported values are \verb|section|, \verb|slide|, \verb|page|,
\verb|none|, or \verb|false|. If no value is given, \verb|section| is taken as default.\\
pagebackref & boolean & false & Adds `backlink' text to the end of each item in the bibliography, as a list of page
numbers. \\
hyperindex & boolean & true & Makes the page numbers of index entries into hyperlinks. Relays on unique
page anchors (\verb|pageanchor|, \ldots)
\verb|pageanchors| and \verb|plainpages=false|. \\
hyperfootnotes & boolean & true & Makes the footnote marks into hyperlinks to the footnote text.
Easily broken \ldots\\
encap & & & Sets encap character for hyperindex \\
linktoc & text & section & make text (\verb|section|), page number (\verb|page|), both (\verb|all|) or nothing (\verb|none|) be link on TOC, LOF and LOT \\
linktocpage & boolean & false & make page number, not text, be link on TOC, LOF and LOT \\
breaklinks & boolean & false & allow links to break over lines by making links over multiple lines into PDF links to
the same target \\
colorlinks & boolean & false & Colors the text of links and anchors. The colors chosen depend on the the type of
link. At present the only types of link distinguished are citations, page references,
URLs, local file references, and other links.
Unlike colored boxes, the colored
text remains when printing.\\
linkcolor & color & red & Color for normal internal links. \\
anchorcolor & color & black & Color for anchor text. Ignored by most drivers. \\
citecolor & color & green & Color for bibliographical citations in text. \\
filecolor & color & cyan & Color for URLs which open local files. \\
menucolor & color & red & Color for Acrobat menu items. \\
runcolor & color & filecolor & Color for run links (launch annotations). \\
urlcolor & color & magenta & Color for linked URLs. \\
allcolors & color & & Set all color options (without border and field options).\\
frenchlinks & boolean & false & Use small caps instead of color for links.\\
hidelinks & & & Hide links (removing color and border). \\
\end{longtable} \smallskip
Note that all color names must be defined before use, following the
normal system of the standard \LaTeX\ \xpackage{color} package.
\subsection{PDF-specific display options}
\begin{longtable}{@{}>{\ttfamily}ll>{\itshape}lp{7.6cm}@{}}
bookmarks & boolean & true & A set of Acrobat bookmarks are written, in a manner similar to the
table of contents, requiring two passes of \LaTeX. Some postprocessing
of the bookmark file (file extension \texttt{.out}) may be needed to
translate \LaTeX\ codes, since bookmarks must be written in PDFEncoding.
To aid this process, the \texttt{.out} file is not rewritten by \LaTeX\
if it is edited to contain a line \verb|\let\WriteBookmarks\relax| \\
bookmarksopen & boolean & false & If Acrobat bookmarks are requested, show them with all the subtrees
expanded. \\
bookmarksopenlevel & parameter & & level (\ci{maxdimen}) to which bookmarks are open \\
bookmarksnumbered & boolean & false & If Acrobat bookmarks are requested, include section numbers. \\
bookmarkstype & text & toc & to specify which `toc' file to mimic \\
CJKbookmarks & boolean & false &
This option should be used to produce CJK bookmarks.
Package \verb|hyperref|
supports both normal and preprocessed mode of the \xpackage{CJK} package;
during the creation of bookmarks, it simply replaces CJK's macros
with special versions which expand to the corresponding character
codes. Note that without the `unicode' option of hyperref you get
PDF files which actually violate the PDF specification because
non-Unicode character codes are used -- some PDF readers localized
for CJK languages (most notably Acroread itself) support this.
Also note that option `CJKbookmarks' cannot be used together
with option `unicode'.
No mechanism is provided to translate non-Unicode bookmarks to
Unicode; for portable PDF documents only Unicode encoding should
be used.\\
pdfhighlight & name & /I & How link buttons behave when selected; /I is for inverse (the default);
the other possibilities are /N (no effect), /O (outline), and /P (inset
highlighting). \\
citebordercolor & RGB color & 0 1 0 & The color of the box around citations \\
filebordercolor & RGB color & 0 .5 .5 & The color of the box around links to files \\
linkbordercolor & RGB color & 1 0 0 & The color of the box around normal links \\
menubordercolor & RGB color & 1 0 0 & The color of the box around Acrobat menu links \\
urlbordercolor & RGB color & 0 1 1 & The color of the box around links to URLs \\
runbordercolor & RGB color & 0 .7 .7 & Color of border around `run' links \\
allbordercolors & & & Set all border color options \\
pdfborder & & 0 0 1 & The style of box around links; defaults to a box with lines of 1pt thickness,
but the colorlinks option resets it to produce no border.
\end{longtable}
Note that the color of link borders can be specified \emph{only} as 3
numbers in the range 0..1, giving an RGB color. You cannot use colors
defined in \TeX. Since version 6.76a this is no longer true.
Especially with the help of package \xpackage{xcolor} the usual
color specifications of package \xpackage{(x)color} can be used.
For further information see description of package \xpackage{hycolor}.
The bookmark commands are stored in a file called
\textit{jobname}\texttt{.out}. The files is not processed by \LaTeX\ so
any markup is passed through. You can postprocess this file as needed;
as an aid for this, the \texttt{.out} file is not overwritten on the
next \TeX\ run if it is edited to contain the line
\begin{verbatim}
\let\WriteBookmarks\relax
\end{verbatim}
\subsection{PDF display and information options}
\begin{longtable}{@{}>{\ttfamily}l>{\raggedright}p{\widthof{key value}}>{\itshape}lp{7cm}@{}}
baseurl & URL & & Sets the base URL of the PDF document \\
pdfpagemode & name & empty & Determines how the file is opening in Acrobat; the possibilities are
\verb|UseNone|, \verb|UseThumbs| (show thumbnails), \verb|UseOutlines|
(show bookmarks), \verb|FullScreen|, \verb|UseOC| (PDF 1.5),
and \verb|UseAttachments| (PDF 1.6). If no mode if explicitly chosen, but the
bookmarks option is set, \verb|UseOutlines| is used. \\
pdftitle & text & & Sets the document information Title field \\
pdfauthor & text & & Sets the document information Author field \\
pdfsubject & text & & Sets the document information Subject field \\
pdfcreator & text & & Sets the document information Creator field \\
addtopdfcreator & text & & Adds additional text to the document information Creator field \\
pdfkeywords & text & & Sets the document information Keywords field \\
pdftrapped & name & empty & Sets the document information Trapped entry. Possible values are \verb|True|, \verb|False| and \verb|Unknown|.
An empty value means, the entry is not set.\\
%
pdfinfo & key value list & empty & Alternative interface for setting the
document information.\\
pdfview & name & XYZ & Sets the default PDF `view' for each link \\
pdfstartpage & integer & 1 & Determines on which page the PDF file is opened. An empty value means, the entry is not set.\\
pdfstartview & name & Fit & Set the startup page view \\
pdfremotestartview & name & Fit & Set the startup page view of remote PDF files \\
pdfpagescrop & n n n n & & Sets the default PDF crop box for pages. This should be a set of four numbers \\
pdfcenterwindow & boolean & false & position the document window in the center of the screen \\
pdfdirection & name & empty & direction setting. Possible values: \verb|L2R| (left to right) and
\verb|R2L| (right to left)\\
pdfdisplaydoctitle & boolean & false & display document title instead of file name in title bar\\
pdfduplex & name & empty & paper handling option for print dialog. Possible vatues are:
\verb|Simplex| (print single-sided),
\verb|DuplexFlipShortEdge| (duplex and flip on the short edge of the sheet),
\verb|DuplexFlipLongEdge| (duplex and flip on the long edge of the sheet)\\
pdffitwindow & boolean & false & resize document window to fit document size \\
pdflang & name & relax & PDF language identifier (RFC 3066)\\
pdfmenubar & boolean & true & make PDF viewer's menu bar visible \\
pdfnewwindow & boolean & false & make links that open another PDF file start a new window \\
pdfnonfullscreenpagemode
& name & empty & page mode setting on exiting full-screen mode. Possible values are
\verb|UseNone|, \verb|UseOutlines|, \verb|UseThumbs|, and \verb|UseOC|\\
pdfnumcopies & integer & empty & number of printed copies \\
pdfpagelayout & name & empty & set layout of PDF pages. Possible values:
\verb|SinglePage|, \verb|OneColumn|,
\verb|TwoColumnLeft|, \verb|TwoColumnRight|,
\verb|TwoPageLeft|, and \verb|TwoPageRight| \\
pdfpagelabels & boolean & true & set PDF page labels \\
pdfpagetransition & name & empty & set PDF page transition style. Possible values are
\verb|Split|, \verb|Blinds|, \verb|Box|, \verb|Wipe|,
\verb|Dissolve|, \verb|Glitter|, \verb|R|,
\verb|Fly|, \verb|Push|,
\verb|Cover|, \verb|Uncover|,
\verb|Fade|.
The default according to the PDF~Reference is \verb|R|,
which simply replaces the old page with the new one. \\
pdfpicktraybypdfsize
& boolean & false & specify whether PDF page size is used to select input paper tray in print dialog \\
pdfprintarea & name & empty & set /PrintArea of viewer preferences. Possible values are
\verb|MediaBox|, \verb|CropBox|,
\verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
The dafault according to the PDF~Refence is \verb|CropBox| \\
pdfprintclip & name & empty & set /PrintClip of viewer preferences. Possible values are
\verb|MediaBox|, \verb|CropBox|,
\verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
The dafault according to the PDF~Refence is \verb|CropBox| \\
pdfprintpagerange & n n (n n)*
& empty & set /PrintPageRange of viewer preferences\\
pdfprintscaling & name & empty & page scaling option for print dialog
(option /PrintScaling of viewer
preferences, PDF 1.6);
valid values are \verb|None| and
\verb|AppDefault| \\
pdftoolbar & boolean & true & make PDF toolbar visible \\
pdfviewarea & name & empty & set /ViewArea of viewer preferences. Possible values are
\verb|MediaBox|, \verb|CropBox|,
\verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
The dafault according to the PDF~Refence is \verb|CropBox| \\
pdfviewclip & name & empty & set /ViewClip of viewer preferences Possible values are
\verb|MediaBox|, \verb|CropBox|,
\verb|BleedBox|, \verb|TrimBox|, and \verb|ArtBox|.
The dafault according to the PDF~Refence is \verb|CropBox| \\
pdfwindowui & boolean & true & make PDF user interface elements visible \\
unicode & boolean & true & Unicode encoded PDF strings
\end{longtable}
Each link in Acrobat carries its own magnification level, which is set
using PDF coordinate space, which is not the same as \TeX's. The unit
is bp and the origin is in the lower left corner. See also
\verb|\hypercalcbp| that is explained on page \pageref{hypercalcbp}.
pdf\TeX\
works by supplying default values for \texttt{XYZ} (horizontal $\times$
vertical $\times$ zoom) and \texttt{FitBH}. However, drivers using
\texttt{pdfmark} do not supply defaults, so \textsf{hyperref} passes in
a value of -32768, which causes Acrobat to set (usually) sensible
defaults. The following are possible values for the \texttt{pdfview},
\texttt{pdfstartview} and \texttt{pdfremotestartview} parameters.
\begin{longtable}{@{}>{\ttfamily}l>{\itshape}lp{7cm}@{}}
XYZ & left top zoom & Sets a coordinate and a zoom factor. If any one is null, the source link value is used.
\textit{null null null} will give the same values as the current page. \\
Fit & & Fits the page to the window. \\
FitH & top & Fits the width of the page to the window. \\
FitV & left & Fits the height of the page to the window. \\
FitR & left bottom right top & Fits the rectangle specified by the four coordinates to the window. \\
FitB & & Fits the page bounding box to the window. \\
FitBH & top & Fits the width of the page bounding box to the window. \\
FitBV & left & Fits the height of the page bounding box to the window. \\
\end{longtable}
The \texttt{pdfpagelayout} can be one of the following values.
\begin{longtable}{@{}>{\ttfamily}lp{10cm}@{}}
SinglePage & Displays a single page; advancing flips the page \\
OneColumn & Displays the document in one column; continuous scrolling. \\
TwoColumnLeft & Displays the document in two columns, odd-numbered pages to the left. \\
TwoColumnRight & Displays the document in two columns, odd-numbered pages to the right.\\
TwoPageLeft & Displays two pages, odd-numbered pages to the left (since PDF 1.5).\\
TwoPageRight & Displays two pages, odd-numbered pages to the right (since PDF 1.5).
\end{longtable}
Finally, the \texttt{pdfpagetransition} can be one of the following
values, where \textit{/Di} stands for direction of motion in degrees,
generally in 90$^{\circ}$\ steps, \textit{/Dm} is a horizontal
(\texttt{/H}) or vertical (\texttt{/V}) dimension (e.g.\ \texttt{Blinds
/Dm /V}), and \textit{/M} is for motion, either in (\texttt{/I}) or out
(\texttt{/O}).
\begin{longtable}{@{}>{\ttfamily}llp{8.5cm}@{}}
Blinds & /Dm & Multiple lines distributed evenly across the screen sweep in the same direction to reveal the new
page. \\
Box & /M & A box sweeps in or out. \\
Dissolve & & The page image dissolves in a piecemeal fashion to reveal the new page. \\
Glitter & /Di & Similar to Dissolve, except the effect sweeps across the screen. \\
Split & /Dm /M & Two lines sweep across the screen to reveal the new page. \\
Wipe & /Di & A single line sweeps across the screen to reveal the new page. \\
R & & Simply replaces the old page with the new one. \\
Fly & /Di /M & Changes are flown out or in (as specified by /M), in the direction
specified by /Di, to or from a location that is
offscreen except when /Di is None. \\
Push & /Di & The old page slides off the screen while the new page slides in,
pushing the old page out in the direction
specified by /Di. \\
Cover & /Di & The new page slides on to the screen in the direction specified
by /Di, covering the old page. \\
Uncover & /Di & The old page slides off the screen in the direction specified by
/Di, uncovering the new page in the direction
specified by /Di. \\
Fade & & The new page gradually becomes visible through the old one.
\end{longtable}
\subsection{Option \texttt{pdfinfo}}
The information entries can be set using \texttt{pdftitle},
\texttt{pdfsubject}, \dots. Option \texttt{pdfinfo} provides an alternative
interface. It takes a key value list. The key names are the names that
appear in the PDF information dictionary directly. Known keys such as
\texttt{Title}, \texttt{Subject}, \texttt{Trapped} and other are mapped to
options \texttt{pdftitle}, \texttt{subject}, \texttt{trapped}, \dots
Unknown keys are added to the information dictionary. Their values are text
strings (see PDF specification).
Example:
\begin{quote}
\begin{verbatim}
\hypersetup{
pdfinfo={
Title={My Title},
Subject={My Subject},
NewKey={Foobar},
% ...
}
}
\end{verbatim}
\end{quote}
\subsection{Big alphabetical list}
The following is a complete listing of available options for
\textsf{hyperref}, arranged alphabetically.
\begin{longtable}{@{}>{\ttfamily}llp{7cm}@{}}
allbordercolors & & Set all border color options\\
allcolors & & Set all color options (without border and field options)\\
anchorcolor & \textit{black} & set color of anchors, ignored by most drivers. \\
backref & \textit{false} & do bibliographical back references \\
baseurl & \textit{empty} & set base URL for document \\
bookmarks & \textit{true} & make bookmarks \\
bookmarksnumbered & \textit{false} & put section numbers in bookmarks \\
bookmarksopen & \textit{false} & open up bookmark tree \\
bookmarksopenlevel & \ttfamily\ci{maxdimen} & level to which bookmarks are open \\
bookmarkstype & \textit{toc} & to specify which `toc' file to mimic \\
breaklinks & \textit{false} & allow links to break over lines \\
CJKbookmarks & \textit{false} & to produce CJK bookmarks\\
citebordercolor & \textit{0 1 0} & color of border around cites \\
citecolor & \textit{green} & color of citation links \\
colorlinks & \textit{false} & color links \\
& \textit{true} & (\textsf{tex4ht}, \textsf{dviwindo}) \\
debug & \textit{false} & provide details of anchors defined; same as verbose \\
destlabel & \textit{false} & destinations are named by the first \verb|\label| after the anchor creation \\
draft & \textit{false} & do not do any hyperlinking \\
driverfallback & & default if no driver specified or detected\\
dvipdfm & & use \textsf{dvipdfm} backend \\
dvipdfmx & & use \textsf{dvipdfmx} backend \\
dvips & & use \textsf{dvips} backend \\
dvipsone & & use \textsf{dvipsone} backend \\
dviwindo & & use \textsf{dviwindo} backend \\
encap & & to set encap character for hyperindex \\
extension & \textit{dvi} & suffix of linked files \\
filebordercolor & \textit{0 .5 .5} & color of border around file links \\
filecolor & \textit{cyan} & color of file links \\
final & \textit{true} & opposite of option draft \\
frenchlinks & \textit{false} & use small caps instead of color for links \\
hidelinks & & Hide links (removing color and border) \\
hyperfigures & \textit{false} & make figures hyper links \\
hyperfootnotes & \textit{true} & set up hyperlinked footnotes \\
hyperindex & \textit{true} & set up hyperlinked indices \\
hypertex & & use \textsf{Hyper\TeX} backend \\
hypertexnames & \textit{true} & use guessable names for links \\
implicit & \textit{true} & redefine \LaTeX\ internals \\
latex2html & & use \textsf{\LaTeX2HTML} backend \\
linkbordercolor & \textit{1 0 0} & color of border around links \\
linkcolor & \textit{red} & color of links \\
linktoc & \textit{section} & make text be link on TOC, LOF and LOT \\
linktocpage & \textit{false} & make page number, not text, be link on TOC, LOF and LOT \\
menubordercolor & \textit{1 0 0} & color of border around menu links \\
menucolor & \textit{red} & color for menu links \\
nativepdf & \textit{false} & an alias for \textsf{dvips} \\
naturalnames & \textit{false} & use \LaTeX-computed names for links \\
nesting & \textit{false} & allow nesting of links \\
pageanchor & \textit{true} & put an anchor on every page \\
pagebackref & \textit{false} & backreference by page number \\
pdfauthor & \textit{empty} & text for PDF Author field \\
pdfborder & \textit{0 0 1} & width of PDF link border \\
& \textit{0 0 0} & (\texttt{colorlinks)} \\
pdfborderstyle & & border style for links \\
pdfcenterwindow & \textit{false} & position the document window in the center of the screen \\
pdfcreator & \textit{LaTeX with} & text for PDF Creator field \\
& \textit{hyperref} & \\
pdfdirection & \textit{empty} & direction setting \\
pdfdisplaydoctitle & \textit{false} & display document title instead
of file name in title bar\\
pdfduplex & \textit{empty} & paper handling option for
print dialog\\
pdffitwindow & \textit{false} & resize document window to fit document size \\
pdfhighlight & \textit{/I} & set highlighting of PDF links \\
pdfinfo & \textit{empty} & alternative interface for setting document information\\
pdfkeywords & \textit{empty} & text for PDF Keywords field \\
pdflang & \textit{relax} & PDF language identifier (RFC 3066) \\
pdfmark & \textit{false} & an alias for \textsf{dvips} \\
pdfmenubar & \textit{true} & make PDF viewer's menu bar visible \\
pdfnewwindow & \textit{false} & make links that open another PDF \\
& & file start a new window \\
pdfnonfullscreenpagemode
& \textit{empty} & page mode setting on exiting
full-screen mode\\
pdfnumcopies & \textit{empty} & number of printed copies\\
pdfpagelabels & \textit{true} & set PDF page labels \\
pdfpagelayout & \textit{empty} & set layout of PDF pages \\
pdfpagemode & \textit{empty} & set default mode of PDF display \\
pdfpagescrop & \textit{empty} & set crop size of PDF document \\
pdfpagetransition & \textit{empty} & set PDF page transition style \\
pdfpicktraybypdfsize
& \textit{empty} & set option for print dialog \\
pdfprintarea & \textit{empty} & set /PrintArea of viewer preferences \\
pdfprintclip & \textit{empty} & set /PrintClip of viewer preferences \\
pdfprintpagerange & \textit{empty} & set /PrintPageRange of viewer preferences \\
pdfprintscaling & \textit{empty} & page scaling option for print dialog \\
pdfproducer & \textit{empty} & text for PDF Producer field \\
pdfremotestartview & \textit{Fit} & starting view of remote PDF documents \\
pdfstartpage & \textit{1} & page at which PDF document opens \\
pdfstartview & \textit{Fit} & starting view of PDF document \\
pdfsubject & \textit{empty} & text for PDF Subject field \\
pdftex & & use \textsf{pdf\TeX} backend \\