From 590fd8b560523cdaea19c59aea61e781138e87f8 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Wed, 6 Nov 2019 03:00:54 +0000 Subject: CTAN sync 201911060300 --- support/chklref/README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) (limited to 'support/chklref/README.md') diff --git a/support/chklref/README.md b/support/chklref/README.md index a39c0948f1..528b9845f5 100644 --- a/support/chklref/README.md +++ b/support/chklref/README.md @@ -1,13 +1,18 @@ -# Installation +# chklref -## System wide installation +Written by Jerome Lelong and distributed under the terms of GNU GPLv3. -### Installation into the TeX structure +## Installation + +### System wide installation + +#### Installation into the TeX structure This package follows the TDS[1] - put the TeX package `chklref.sty` into `$(texmf_prefix)/tex/latex/chklref` -- put the manual `chklref.pdf` into `$(texmf_prefix)/doc/latex/chklref` +- put the documentation `doc/chklref.pdf` into `$(texmf_prefix)/doc/latex/chklref` +- put the man page `doc/chklref.1` into `$(texmf_prefix)/doc/man/man1` - put the Perl parser `chklref.pl` into `$(texmf_prefix)/scripts/chklref` Note that you will also need to make a link or copy `chklref.pl` to a location in your `PATH`. On Unix systems, you may need to set the script as executable. @@ -41,11 +46,23 @@ You typically just run: `perl chklref.pl file.tex` The full calling syntax is `perl chklref.pl [options] file.tex`, where `options` can be - `--tex `, `-t`: Specify the TeX compiler to be used. Default is `pdflatex`. -- `--tex-options`: List of options to pass to the TeX compiler. Note that we always add `-interaction nonstopmode` on top of these options. +- `--tex-options`: List of options to pass to the TeX compiler. It should be a quoted string of white space delimited options. Note that we always add `-interaction nonstopmode` on top of these options. - `--debug`, `-d`: Run in debug mode. Do not clean the generated `.chk` file. - `--quiet`, `-q`: Run in quiet mode. Do not print the output of the TeX compiler. - `--parse-only`: Do not run the LaTeX compiler but use the already existing `.chk` file. When this option is passed, the following other options are meaningless: `--tex`, `--tex-options`, `--quiet`, `--debug`. - `--version`, `-v`: Print the version of this script. - `--help,h`: Print this help. +Alternatively, you can directly add `\usepackage{chklref}` to your main LaTeX file and compile it normally. This will create a file with extension `.chk`, which can then be parsed by the Perl script: + + perl chklref.pl --parse-only file.tex + +Note that you need to pass the \verb!.tex! file to the parser not the `.chk` file. + +## Bugs + +Report bugs to https://github.com/jlelong/chklref. + +`chklref` is known not to work with `cleveref`. If you would like to contribute to `chklref`, feel free to open a PR on https://github.com/jlelong/chklref. + [1] : TeX Directory Structure http://www.tug.org/twg/tds/ -- cgit v1.2.3