diff options
Diffstat (limited to 'support/chklref/doc')
-rw-r--r-- | support/chklref/doc/Makefile | 5 | ||||
-rw-r--r-- | support/chklref/doc/chklref.1 | 56 | ||||
-rw-r--r-- | support/chklref/doc/chklref.pdf | bin | 298764 -> 299035 bytes | |||
-rw-r--r-- | support/chklref/doc/chklref.tex | 3 |
4 files changed, 62 insertions, 2 deletions
diff --git a/support/chklref/doc/Makefile b/support/chklref/doc/Makefile index 4faf33d891..a12ad3b629 100644 --- a/support/chklref/doc/Makefile +++ b/support/chklref/doc/Makefile @@ -1,11 +1,14 @@ .PHONY: all clean cleanall -all: chklref.pdf clean +all: chklref.1 chklref.pdf clean chklref.pdf: chklref.tex pdflatex chklref.tex pdflatex chklref.tex +chklref.1: ../chklref.pl + help2man --output=$@ ../chklref.pl + clean: rm -f chklref.log chklref.aux chklref.out chklref.fls chklref.fdb_latexmk chklref.synctex.gz diff --git a/support/chklref/doc/chklref.1 b/support/chklref/doc/chklref.1 new file mode 100644 index 0000000000..8dc3b874ed --- /dev/null +++ b/support/chklref/doc/chklref.1 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.11. +.TH CHKLREF "1" "November 2019" "chklref 3.1.2" "User Commands" +.SH NAME +chklref \- manual page for chklref 3.1.2 +.SH SYNOPSIS +.B chklref +[\fI\,options\/\fR] \fI\,texfile\/\fR +.SH DESCRIPTION +Check unused labels and bibitems in a LaTeX file +.SH OPTIONS +.TP +\fB\-\-tex\fR <compiler>, \fB\-t\fR +Specify the TeX compiler to be used. Default is `pdflatex`. +.TP +\fB\-\-tex\-options\fR +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. +.TP +\fB\-\-debug\fR, \fB\-d\fR +Run in debug mode. Do not clean the generated `.chk` file. +.TP +\fB\-\-quiet\fR, \fB\-q\fR +Run in quiet mode. Do not print the output of the TeX compiler. +.TP +\fB\-\-parse\-only\fR +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`. +.TP +\fB\-\-version\fR, \fB\-v\fR +Print the version of this script. +.TP +\fB\-\-help\fR,h +Print this help. +.SH AUTHOR +Written by Jerome Lelong <jerome.lelong@gmail.com> +.SH "REPORTING 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. +.SH COPYRIGHT +Copyright 2005\-2019 Jerome Lelong <jerome.lelong@gmail.com>. +This program comes with ABSOLUTELY NO WARRANTY. +.br +This is free software, and you are welcome to redistribute it under GPLv3. +.SH "SEE ALSO" +The full documentation for +.B chklref +is maintained as a Texinfo manual. If the +.B info +and +.B chklref +programs are properly installed at your site, the command +.IP +.B info chklref +.PP +should give you access to the complete manual. diff --git a/support/chklref/doc/chklref.pdf b/support/chklref/doc/chklref.pdf Binary files differindex df3d7637c1..5a64429732 100644 --- a/support/chklref/doc/chklref.pdf +++ b/support/chklref/doc/chklref.pdf diff --git a/support/chklref/doc/chklref.tex b/support/chklref/doc/chklref.tex index 4a9b0baf8d..3f443ed8b4 100644 --- a/support/chklref/doc/chklref.tex +++ b/support/chklref/doc/chklref.tex @@ -98,7 +98,8 @@ This package follows the TDS\footnote{TeX Directory Structure \url{http://www.tug.org/twg/tds/}}: \begin{itemize} \item put the \TeX\ package \verb!chklref.sty! into \verb!$(texmf_prefix)/tex/latex/chklref! - \item put the manual \verb!chklref.pdf! into \verb!$(texmf_prefix)/doc/latex/chklref! + \item put the documentation \verb!doc/chklref.pdf! into \verb!$(texmf_prefix)/doc/latex/chklref! + \item put the man page \verb!doc/chklref.1! into \verb!$(texmf_prefix)/doc/man/man1! \item put the Perl parser \verb!chklref.pl! into \verb!$(texmf_prefix)/scripts/chklref! \end{itemize} Note that you will also need to make a link or copy \verb!chklref.pl! to a location in your \texttt{PATH}. On Unix systems, you may need to set the script executable. \\ |