Comprehensive TeX Archive Network

Direc­tory support/chklref


I. Installation

    I.1. System wide installation

    You need the root privileges to perform this installation

    Simply run 

      sudo make install

    This package follows the TDS[1] and installs:
        * the main program in $(prefix)
        * the TeX package chklref.sty in $(texmf_prefix)/tex/latex/chklref
        * the manual chklref.pdf in $(texmf_prefix)/doc/latex/chklref
        * the Perl parser chkparser in $(texmf_prefix)/scripts/chklref

    The following default values are used
        * prefix=/usr/local
        * texmf_prefix=$(prefix)/share/texmf

    These default values can be changed with the flags --prefix
    and --with-texmf-prefix passed to the configure script.

    Note: Do not forget to run "sudo texhash" to update your TeX Directory 

    Notes for installation under MacOS X:

    Under MacOS X, your tex distribution is probably not installed under
    /usr/share/texmf nor /usr/local/share/texmf. You are most likely using
    the TeXlive distribution provided by MacTeX which installs under
    /usr/local/texlive. Hence, you should invoke configure with


    I.2. Installation on a single account

    This installation does not require any particular privileges.

    We assume that the directory $HOME/bin is in your PATH, if not you have to
    add it your PATH. You can install the software on your account using

        ./configure --prefix=$HOME --with-texmf-prefix=$HOME/texmf
        make install

    Note: For the installation on a single account, there is no need to run

    Notes for installation under MacOS X:

    The directory $HOME/texmf may not exist because it is replaced by
    $HOME/Library/texmf instead. So, either use

        ./configure --prefix=$HOME --with-texmf-prefix=$HOME/Library/texmf

    or create a symbolic link

        ln -s $HOME/Library/texmf $HOME/texmf

2. Execution

  Just run: chklref texfile

  To run ckhlref, you need a Perl interpreter. As no special Perl
  packages are needed, a very basic Perl distribution should be ok.

[1] : TeX Directory Structure http://www.tug.org/twg/tds/

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

chkl­ref – Check for prob­lems with la­bels in

It is quite com­mon that af­ter mod­i­fy­ing a file, many un­used la­bels re­main in it. The pur­pose of chkl­ref is to au­to­mat­i­cally find these use­less la­bels. It also looks for “non starred” math­e­mat­i­cal en­vi­ron­ments with no la­bels and ad­vises the user to use a starred ver­sion in­stead.

Li­cense GNU Gen­eral Public Li­cense, ver­sion 3
Copy­right2009 Jérôme Le­long
Main­tainerJérôme Le­long
Topics sup­port for pack­age or doc­u­ment de­bug­ging
Guest Book Sitemap Contact Contact Author