summaryrefslogtreecommitdiff
path: root/support/chklref/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-11-06 03:00:54 +0000
committerNorbert Preining <norbert@preining.info>2019-11-06 03:00:54 +0000
commit590fd8b560523cdaea19c59aea61e781138e87f8 (patch)
tree0da2c5c68b4f6860feef746ecf9e8b76157c80bb /support/chklref/README.md
parenta78951f836b9edaab2dd593f38e33732f0d03cbd (diff)
CTAN sync 201911060300
Diffstat (limited to 'support/chklref/README.md')
-rw-r--r--support/chklref/README.md27
1 files changed, 22 insertions, 5 deletions
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 <jerome.lelong@gmail.com> 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 <compiler>`, `-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/