texlive[52649] trunk: chklref (5nov19)
commits+karl at tug.org
commits+karl at tug.org
Tue Nov 5 22:37:02 CET 2019
Revision: 52649
http://tug.org/svn/texlive?view=revision&revision=52649
Author: karl
Date: 2019-11-05 22:37:02 +0100 (Tue, 05 Nov 2019)
Log Message:
-----------
chklref (5nov19)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/chklref/chklref.pl
trunk/Master/texmf-dist/doc/support/chklref/Makefile.doc
trunk/Master/texmf-dist/doc/support/chklref/README.md
trunk/Master/texmf-dist/doc/support/chklref/VERSION
trunk/Master/texmf-dist/doc/support/chklref/chklref.pdf
trunk/Master/texmf-dist/doc/support/chklref/chklref.tex
trunk/Master/texmf-dist/doc/support/chklref/release.sh
trunk/Master/texmf-dist/scripts/chklref/chklref.pl
trunk/Master/tlpkg/libexec/ctan2tds
Added Paths:
-----------
trunk/Master/texmf-dist/doc/man/man1/chklref.1
trunk/Master/texmf-dist/doc/man/man1/chklref.man1.pdf
Modified: trunk/Build/source/texk/texlive/linked_scripts/chklref/chklref.pl
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/chklref/chklref.pl 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Build/source/texk/texlive/linked_scripts/chklref/chklref.pl 2019-11-05 21:37:02 UTC (rev 52649)
@@ -34,9 +34,6 @@
my $RUNQUIET = 0;
my $RUNDEBUG = 0;
my $PARSEONLY = 0;
-my $PRINTVERSION = 0;
-my $HELP = 0;
-my $VERSION = 'Version 3.0.1';
# Create a hash with three keys "str", "line", "file" and returns a
# reference to it
@@ -259,27 +256,43 @@
}
sub usage {
-print << 'EOT';
-chklref -- Check unused labels and bibitems
+ print << 'EOT';
+Usage: chklref [options] texfile
-Copyright (C) 2005-2019 Jérôme Lelong <jerome.lelong at gmail.com>
-This program comes with ABSOLUTELY NO WARRANTY;
-This is free software, and you are welcome to redistribute it under certain conditions;
+Check unused labels and bibitems in a LaTeX file
-Usage:
- chklref [options] texfile
+Options:
+ --tex <compiler>, -t Specify the TeX compiler to be used. Default is `pdflatex`.
+ --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.
-Options:
- --tex <compiler>, -t : Specify the TeX compiler to be used. Default = pdflatex.
- --tex-options : List of options to pass to the TeX compiler.
- --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 scirpt.
- --help,h : Print this help.
+
+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.
EOT
+ exit(0)
}
+sub version {
+ print << 'EOT';
+chklref 3.1.2
+
+Copyright 2005-2019 Jerome Lelong <jerome.lelong at gmail.com>.
+This program comes with ABSOLUTELY NO WARRANTY.
+This is free software, and you are welcome to redistribute it under GPLv3.
+
+Written by Jerome Lelong <jerome.lelong at gmail.com>
+EOT
+ exit(0)
+}
+
sub texcompile {
my ($texfile, $basetexfile) = @_;
print "Running $TEX $TEXOPTIONS $USERTEXOPTIONS \"$texfile\" to collect labels references and environment declarations\n\n";
@@ -292,25 +305,15 @@
Getopt::Long::Configure ("bundling");
GetOptions (
- 'version|v!' => \$PRINTVERSION,
+ 'version|v!' => \&version,
'quiet|q!' => \$RUNQUIET,
'debug|d!' => \$RUNDEBUG,
'tex|t=s' => \$TEX,
'texoptions=s' => \$USERTEXOPTIONS,
'parse-only' => \$PARSEONLY,
- 'help|h' => \$HELP
+ 'help|h' => \&usage
) || usage();
-if ($HELP) {
- usage();
- exit(0);
-}
-
-if ($PRINTVERSION) {
- print "chklref $VERSION\n";
- exit(0)
-}
-
if (@ARGV != 1) {
usage();
exit 0;
Added: trunk/Master/texmf-dist/doc/man/man1/chklref.1
===================================================================
--- trunk/Master/texmf-dist/doc/man/man1/chklref.1 (rev 0)
+++ trunk/Master/texmf-dist/doc/man/man1/chklref.1 2019-11-05 21:37:02 UTC (rev 52649)
@@ -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 at 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 at 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.
Property changes on: trunk/Master/texmf-dist/doc/man/man1/chklref.1
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/man/man1/chklref.man1.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/man/man1/chklref.man1.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/man/man1/chklref.man1.pdf 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/doc/man/man1/chklref.man1.pdf 2019-11-05 21:37:02 UTC (rev 52649)
Property changes on: trunk/Master/texmf-dist/doc/man/man1/chklref.man1.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/support/chklref/Makefile.doc
===================================================================
--- trunk/Master/texmf-dist/doc/support/chklref/Makefile.doc 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/doc/support/chklref/Makefile.doc 2019-11-05 21:37:02 UTC (rev 52649)
@@ -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
Modified: trunk/Master/texmf-dist/doc/support/chklref/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/support/chklref/README.md 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/doc/support/chklref/README.md 2019-11-05 21:37:02 UTC (rev 52649)
@@ -1,13 +1,18 @@
-# Installation
+# chklref
-## System wide installation
+Written by Jerome Lelong <jerome.lelong at 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,7 +46,7 @@
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`.
@@ -48,4 +53,16 @@
- `--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/
Modified: trunk/Master/texmf-dist/doc/support/chklref/VERSION
===================================================================
--- trunk/Master/texmf-dist/doc/support/chklref/VERSION 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/doc/support/chklref/VERSION 2019-11-05 21:37:02 UTC (rev 52649)
@@ -1 +1 @@
-3.0.1
+3.1.2
Modified: trunk/Master/texmf-dist/doc/support/chklref/chklref.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/support/chklref/chklref.tex
===================================================================
--- trunk/Master/texmf-dist/doc/support/chklref/chklref.tex 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/doc/support/chklref/chklref.tex 2019-11-05 21:37:02 UTC (rev 52649)
@@ -98,7 +98,8 @@
\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. \\
Modified: trunk/Master/texmf-dist/doc/support/chklref/release.sh
===================================================================
--- trunk/Master/texmf-dist/doc/support/chklref/release.sh 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/doc/support/chklref/release.sh 2019-11-05 21:37:02 UTC (rev 52649)
@@ -10,6 +10,7 @@
# Perform git archive
git_archive() {
+ echo '-- Creating an archive from the git repository'
cwd=$(pwd)
[[ -d "$LOCAL_TMPDIR" ]] && rm -rf "$LOCAL_TMPDIR"
mkdir -p "$CHKLREF_DIR"
@@ -19,6 +20,7 @@
}
compile_doc() {
+ echo '-- Compiling the documentation'
cwd=$(pwd)
cd "$CHKLREF_DIR/doc"
make
@@ -26,23 +28,34 @@
}
create_tds() {
+ echo '-- Creating chklref.tds.zip'
cwd=$(pwd)
mkdir -p "$CHKLREF_DIR/chklref.tds"
cd "$CHKLREF_DIR/chklref.tds"
mkdir -p tex/latex/chklref
mkdir -p doc/latex/chklref
+ mkdir -p doc/man/man1
mkdir -p scripts/chklref
cp ../chklref.sty tex/latex/chklref
cp ../doc/chklref.{tex,pdf} doc/latex/chklref
+ cp ../doc/chklref.1 doc/man/man1
cp ../README.md doc/latex/chklref
cp ../chklref.pl scripts/chklref
- cd ..
- zip -r chklref.tds.zip chklref.tds
- rm -rf chklref.tds
+ zip -r ../../chklref.tds.zip *
+ rm -rf "$CHKLREF_DIR/chklref.tds"
cd "$cwd"
}
+create_zip() {
+ echo '-- Creating chklref.zip'
+ cwd=$(pwd)
+ cd "$CHKLREF_DIR/.."
+ zip -r chklref.zip chklref chklref.tds.zip
+ cd "$cwd"
+}
+
git_archive
compile_doc
create_tds
-zip -r "$CHKLREF_DIR.zip" "$CHKLREF_DIR"
\ No newline at end of file
+create_zip
+echo "-- $CHKLREF_DIR"
Modified: trunk/Master/texmf-dist/scripts/chklref/chklref.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/chklref/chklref.pl 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/texmf-dist/scripts/chklref/chklref.pl 2019-11-05 21:37:02 UTC (rev 52649)
@@ -34,9 +34,6 @@
my $RUNQUIET = 0;
my $RUNDEBUG = 0;
my $PARSEONLY = 0;
-my $PRINTVERSION = 0;
-my $HELP = 0;
-my $VERSION = 'Version 3.0.1';
# Create a hash with three keys "str", "line", "file" and returns a
# reference to it
@@ -259,27 +256,43 @@
}
sub usage {
-print << 'EOT';
-chklref -- Check unused labels and bibitems
+ print << 'EOT';
+Usage: chklref [options] texfile
-Copyright (C) 2005-2019 Jérôme Lelong <jerome.lelong at gmail.com>
-This program comes with ABSOLUTELY NO WARRANTY;
-This is free software, and you are welcome to redistribute it under certain conditions;
+Check unused labels and bibitems in a LaTeX file
-Usage:
- chklref [options] texfile
+Options:
+ --tex <compiler>, -t Specify the TeX compiler to be used. Default is `pdflatex`.
+ --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.
-Options:
- --tex <compiler>, -t : Specify the TeX compiler to be used. Default = pdflatex.
- --tex-options : List of options to pass to the TeX compiler.
- --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 scirpt.
- --help,h : Print this help.
+
+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.
EOT
+ exit(0)
}
+sub version {
+ print << 'EOT';
+chklref 3.1.2
+
+Copyright 2005-2019 Jerome Lelong <jerome.lelong at gmail.com>.
+This program comes with ABSOLUTELY NO WARRANTY.
+This is free software, and you are welcome to redistribute it under GPLv3.
+
+Written by Jerome Lelong <jerome.lelong at gmail.com>
+EOT
+ exit(0)
+}
+
sub texcompile {
my ($texfile, $basetexfile) = @_;
print "Running $TEX $TEXOPTIONS $USERTEXOPTIONS \"$texfile\" to collect labels references and environment declarations\n\n";
@@ -292,25 +305,15 @@
Getopt::Long::Configure ("bundling");
GetOptions (
- 'version|v!' => \$PRINTVERSION,
+ 'version|v!' => \&version,
'quiet|q!' => \$RUNQUIET,
'debug|d!' => \$RUNDEBUG,
'tex|t=s' => \$TEX,
'texoptions=s' => \$USERTEXOPTIONS,
'parse-only' => \$PARSEONLY,
- 'help|h' => \$HELP
+ 'help|h' => \&usage
) || usage();
-if ($HELP) {
- usage();
- exit(0);
-}
-
-if ($PRINTVERSION) {
- print "chklref $VERSION\n";
- exit(0)
-}
-
if (@ARGV != 1) {
usage();
exit 0;
Modified: trunk/Master/tlpkg/libexec/ctan2tds
===================================================================
--- trunk/Master/tlpkg/libexec/ctan2tds 2019-11-05 21:36:14 UTC (rev 52648)
+++ trunk/Master/tlpkg/libexec/ctan2tds 2019-11-05 21:37:02 UTC (rev 52649)
@@ -3184,6 +3184,7 @@
'a2ping' => '\.1$',
'axodraw2' => '\.1$',
'bundledoc' => '\.1$',
+ 'chklref' => '\.1$',
'crossrefware' => '\.1$',
'ctanbib' => '\.1$',
'ctan-o-mat' => '\.1$',
More information about the tex-live-commits
mailing list