CTAN Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/hyperref


README for hy­per­ref bun­dle



This pack­age is used to emend cross-ref­er­enc­ing com­mands in to pro­duce some sort of spe­cial com­mands; there are back­ends for the spe­cial set de­fined for Hyper dvi pro­ces­sors, for em­bed­ded pdf­mark com­mands for pro­cess­ing by Acro­bat Dis­tiller (dvips and dvip­sone), for dvi­windo, for pdf, for dvipdfm, for 4ht, and for VTEX's pdf and HTML back­ends.

In­cluded are:

  1. hyperef' The main hyperlinking functionality.
  2. backref' a package by David Carlisle to provide links back from bib­li­og­ra­phy to the main text; these are hy­per­text links af­ter us­ing hy­per­ref.
  3. nameref' a pack­age to al­low ref­er­ence to the names of sec­tions rather than their num­bers.


hyperref' is available on CTAN: CTAN:macros/la­tex/con­trib/hy­per­ref/

Also a ZIP file is pro­vided that con­tains the files, al­ready sorted in a TDS tree: CTAN:in­stall/macros/la­tex/con­trib/hy­per­ref.tds.zip

"CTAN:" means one of the Comprehensive TeX Archive Network'nodes or one of its mir­rors. This is ex­plained in https://tex­faq.org/FAQ-archives

The main repos­i­tory of hy­per­ref is lo­cated at github https://github.com/ho-tex/hy­per­ref


In­stal­la­tion with ZIP file in TDS for­mat

The ZIP file hyperref.tds.zip' contains the files sortedin a TDS tree. Thus you can di­rectly un­pack the ZIP file in­side a TDS tree. (See CTAN:tds.zip for an ex­pla­na­tion of TDS.) Ex­am­ple:

  cd /...somewhere.../texmf
  unzip /...downloadpath.../hyperref.tds.zip

Do not for­get to re­fresh the file name database of this TDS tree, Ex­am­ple:

  texhash /...somewhere.../texmf

Man­ual in­stal­la­tion

  1. Down­load the hy­per­ref files from CTAN or the TUG server. If nec­es­sary, un­pack them.
  2. If di­rec­tory beta' exists, replace the files by the counterparts in this di­rec­tory, if you want to use the lat­est ver­sions.
  3. Gen­er­ate the pack­age and driver files: tex hy­per­ref.ins
  4. In­stall the files *.sty', .def', and *.cfg' in your TDS tree: cp .sty .def .cfg TDS:tex/la­tex/hy­per­ref/ Re­place TDS:' by the prefix of your TDS tree (texmf directory). The ex­cep­tion is bmhy­doc.sty, it be­longs to the source files (TDS:source/la­tex/hy­per­ref/).
  5. Copy the doc­u­men­ta­tion files to "TDS:doc/la­tex/hy­per­ref/": man­ual.pdf, README, README.pdf, ChangeLog, ChangeLog.pdf, slides.pdf, pa­per.pdf, op­tions.pdf, hy­per­ref.pdf, back­ref.pdf, nameref.pdf (Also the HTML ver­sion of the man­ual can be put there.)
  6. Up­date the databases if nec­es­sary, eg. for te: mk­texlsr .../texmf


  • Se­bas­tian Rahtz (died 2016)
  • Heiko Oberdiek
  • David Carlisle (via GitHub ho-tex ori­g­an­i­sa­tion)


A bug re­port should con­tain:

  • Com­pre­hen­sive prob­lem de­scrip­tion. This in­cludes er­ror or warn­ing mes­sages.
    • er­ror­con­textlines=maxdi­men can be added in the code to get more in­for­ma­tions in er­ror mes­sages.
  • Min­i­mal test file that shows the prob­lem, but does not con­tain any un­nec­es­sary pack­ages and code.
  • Used drivers/pro­grams.
  • Ver­sion in­for­ma­tion about used pack­ages and pro­grams.
    • If you are us­ing , then add "list­files". Then a list of ver­sion in­for­ma­tions is printed at the end of the run.
  • Please no other files than the min­i­mal test file. The other files .log, .dvi, .ps, .pdf are sel­dom nec­es­sary, so send them only on re­quest.

## Bug ad­dress

A bug tracker is avail­able at github: https://github.com/ho-tex/oberdiek/is­sues

Al­ter­na­tively bug re­ports can be send to the sup­port group pub­lic email list: <ho-tex at tug dot org>

Viet­namese part

Re­spon­si­ble for the Viet­namese trans­la­tions of the au­toref names and pu­vnenc.def are: Han The Thanh <han­thethanh at gmail dot com> Rein­hard Ko­tucha <rein­hard dot ko­tucha at web dot de>

Ara­bic part

Re­spon­si­ble for the ad­di­tions to PU en­cod­ing for Arabi is Youssef Jabri <yjabri at ensa dot univ-ou­jda dot ac dot ma>


  • (half-done) hy­per im­ages (link from thumb­nail in text)
  • Rel­a­tive links are not sorted out or doc­u­mented well. For PDF gen­er­a­tion:
    • With baseurl: all links are con­sid­ered rel­a­tive to this URL.
    • Without baseurl: a rel­a­tive link with­out "file:" can be achieved by:
    •   \begingroup
  • ...


  • mod­ules
  • book­mark or­gan­i­sa­tion
  • doc­u­men­ta­tion
  • PDF threads
  • more for PDF forms
    • per ob­ject set­ting
    • vary gap be­tween text and box
  • PostScript driver: the cur­rent im­ple­men­ta­tion doesn't relly sup­port nested links. The start po­si­tions should be re­mem­bered in a stack, but there are com­pli­ca­tions with page breaks.
  • ...


Live hy­per­ref com­ment
TL 2016 2016/05/05 v6.83n (at time of first re­lease)
TL 2011 2011/04/17 v6.82g (at time of first re­lease)
TL 2010 2010/06/18 v6.81g (at time of first re­lease)
TL 2009 2009/10/09 v6.79a (at time of first re­lease)
TL 2008 2008/08/14 v6.78f (at time of first re­lease)
TL 2007 2007/02/07 v6.75r
TL 2005 2003/11/30 v6.74m
TL 2004 2003/11/30 v6.74m
TL 2003 2003/09/15 v6.74i
TL 7 (2002) 2002/05/27 v6.72r
TL 6b (2001) 2001/05/26 v6.71g
TL 5d (2000) 2000/07/02 v6.70m
TL 5c (2000) 2000/05/08 v6.70f
TL 4 (1999) 1999/04/13 v6.56
TL 3 (1998) 1998/03/25 v6.19

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

hy­per­ref – Ex­ten­sive sup­port for hy­per­text in

The hy­per­ref pack­age is used to han­dle cross-ref­er­enc­ing com­mands in to pro­duce hy­per­text links in the doc­u­ment. The pack­age pro­vides back­ends for the \spe­cial set de­fined for Hyper DVI pro­ces­sors; for em­bed­ded pdf­mark com­mands for pro­cess­ing by Acro­bat Dis­tiller (dvips and Y&Y’s dvip­sone); for Y&Y’s dvi­windo; for PDF con­trol within pdf and dvipdfm; for 4ht; and for V’s pdf and HTML back­ends.

The pack­age is dis­tributed with the back­ref and nameref pack­ages, which make use of the fa­cil­i­ties of hy­per­ref.

The pack­age de­pends on the au­thor’s kvop­tions, ltx­cmds and re­f­count pack­ages.

Home pagehttps://github.com/ho-tex/hy­per­ref
Bug trackerhttps://github.com/ho-tex/hy­per­ref/is­sues
Ver­sion6.88e 2018-11-30
Li­censesThe Project Public Li­cense 1.3
Copy­right2001–2012 Heiko Oberdiek
2016–2018 Oberdiek Pack­age Sup­port Group
Main­tainerHeiko Oberdiek
Se­bas­tian Rahtz pkg.au­thor.died
TDS archivehyperref.tds.zip
Con­tained inTeX Live as hy­per­ref
MiKTeX as hy­per­ref
TopicsAdobe Dis­tiller
PDF fea­tures
Guest Book Sitemap Contact Contact Author