CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/hyperref


README for hyperref bundle

Version 2024-05-23 v7.01i


This package is used to emend cross-referencing commands in to produce some sort of \special commands; there are backends for the \special set defined for Hyper dvi processors, for embedded pdfmark commands for processing by Acrobat Distiller (dvips and dvipsone), for dviwindo, for pdf, for dvipdfm, for 4ht, and for VTEX's pdf and HTML backends.

Included are:

  1. hyperref The main hyperlinking functionality.
  2. backref a package by David Carlisle to provide links back from bibliography to the main text; these are hypertext links after using hyperref.
  3. nameref a package to allow reference to the names of sections rather than their numbers.


hyperref is available on CTAN:https://ctan.org/pkg/hyperref

Also a ZIP file is provided that contains the files, already sorted in a TDS tree: CTAN:http://mirrors.ctan.org/install/macros/latex/contrib/hyperref.tds.zip

"CTAN:" means one of the 'Comprehensive Archive Network' nodes or one of its mirrors. This is explained in https://texfaq.org/FAQ-archives

The main repository of hyperref is located at github https://github.com/latex3/hyperref


The easiest is to use the package manager of the System.

Installation with ZIP file in TDS format

The ZIP file hyperref.tds.zip contains the files sorted in a TDS tree. Thus you can directly unpack the ZIP file inside a TDS tree. (See CTAN:tds.zip for an explanation of TDS.) Example:

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

Do not forget to refresh the file name database of this TDS tree. Example for Live:

  mktexlsr /...somewhere.../texmf

Manual installation

  1. Download the hyperref files from CTAN or the TUG server. If necessary, unpack them.
  2. Generate the package and driver files: tex hyperref.ins
  3. Install the files *.sty, *.def, and *.cfg in your TDS tree: cp *.sty *.def *.cfg TDS:tex/latex/hyperref/. Replace TDS: by the prefix of your TDS tree (texmf directory). The exception is bmhydoc.sty, it belongs to the source files (TDS:source/latex/hyperref/).
  4. Copy the documentation files to "TDS:doc/latex/hyperref/": hyperref-doc.pdf, README.md, ChangeLog.txt, slides.pdf, paper.pdf, hyperref.pdf, backref.pdf, nameref.pdf (Also the HTML version of the manual can be put there).
  5. Update the databases if necessary, eg. for Live: mktexlsr .../texmf


  • Sebastian Rahtz (died 2016)
  • Heiko Oberdiek (inactive)
  • The Project


LATEX Project Public License, version 1.3c or later.


A bug report should contain:

  • Comprehensive problem description. This includes error or warning messages.
    • \errorcontextlines=\maxdimen can be added in the code to get more information in error messages.
  • Minimal test file that shows the problem, but does not contain any unnecessary packages and code.
  • Used drivers/programs.
  • Version information about used packages and programs.
    • If you are using , then add "\listfiles". Then a list of version informations is printed at the end of the run.
  • Please no other files than the minimal test file. The other files .log, .dvi, .ps, .pdf are seldom necessary, so send them only on request.

Bug address

A bug tracker is available at github: https://github.com/latex3/hyperref/issues

Vietnamese part

Responsible for the Vietnamese translations of the autoref names and puvnenc.def are:

  • Han The Thanh <hanthethanh [at] gmail [dot] com>
  • Reinhard Kotucha <reinhard [dot] kotucha at web [dot] de>

Arabic part

Responsible for the additions to PU encoding for Arabi is Youssef Jabri <yjabri [at] ensa [dot] univ-oujda [dot] ac [dot] ma>


  • (half-done) hyper images (link from thumbnail in text)
  • Relative links are not sorted out or documented well. For PDF generation:
    • With baseurl: all links are considered relative to this URL.
    • Without baseurl: a relative link without "file:" can be achieved by:
    •   \begingroup
  • ...

Download the contents of this package in one zip archive (4.4M).

hyperref – Extensive support for hypertext in

The hyperref package is used to handle cross-referencing commands in to produce hypertext links in the document. The package provides backends for the \special set defined for Hyper DVI processors; for embedded pdfmark commands for processing by Acrobat Distiller (dvips and Y&Y’s dvipsone); for Y&Y’s dviwindo; for PDF control within pdf and dvipdfm; for 4ht; and for V’s pdf and HTML backends.

The package is distributed with the backref and nameref packages, which make use of the facilities of hyperref.

The package depends on the author’s kvoptions, ltxcmds and refcount packages.

Home pagehttps://github.com/latex3/hyperref
Bug trackerhttps://github.com/latex3/hyperref/issues
Version7.01i 2024-05-23
LicensesThe Project Public License 1.3
Copyright1995–2001 Sebastian Rahtz et al.
2001–2015 Heiko Oberdiek
2016–2019 Oberdiek Package Support Group
2019–2024 3 Project
MaintainerThe Project Team
Oberdiek Package Support Group
Heiko Oberdiek (inactive)
Sebastian Rahtz (deceased)
TDS archivehyperref.tds.zip
Contained inTeX Live as hyperref
MiKTeX as hyperref
TopicsForm fillin
Adobe Distiller
PDF features
Guest Book Sitemap Contact Contact Author