summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/regstats/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/regstats/README')
-rw-r--r--macros/latex/contrib/regstats/README106
1 files changed, 49 insertions, 57 deletions
diff --git a/macros/latex/contrib/regstats/README b/macros/latex/contrib/regstats/README
index f5021dabd3..0e7d52efc8 100644
--- a/macros/latex/contrib/regstats/README
+++ b/macros/latex/contrib/regstats/README
@@ -1,4 +1,4 @@
-README for regstats package, 2012/01/07, v1.0h
+README for regstats package, 2023-04-04, v1.1a
TABLE OF CONTENTS
@@ -20,49 +20,43 @@ TABLE OF CONTENTS
This LaTeX package allows to count the number of used registers (counter,
dimen, skip, muskip, box, token, input, output, math families, languages,
insertions). Therefore the according \count is read. While \count10 should
-be the number of the counters, \count11 the one of the dimens and so on,
-it is possible to use option proof, in which case a new one of each register
-is used and looked at \the\allocationnumber, and this is compared to the
-number determined by reading the \count. The result for each register is
-compared to the maximum available number of the respective register
-(comparison independent of usage of option proof).
+be the number of the counters, \count11 the one of the dimens, and so on,
+if there is enough room for another register of that type, then a new one
+of that register is used and looked at \the\allocationnumber. The result
+for each register is compared to the maximum available number of the
+respective register.
With option "left" additionally the number of remaining registers of each
type is given, and with option "timer" the time needed for the compilation
-run (when either pdf(la)tex or lua(la)tex with
+run (when either LuaLaTeX with
\directlua{starttime = os.clock()}
-before \documentclass is used).
-This material is subject to the LaTeX Project Public License
-(LPPL). See http://www.ctan.org/tex-archive/help/Catalogue/
-licenses.lppl.html for the details of that license.
+before \documentclass or pdf(la)tex is used).
+
+This material is published under the LPPL 1.3c: This work may be
+distributed and/or modified under the conditions of the LaTeX Project
+Public License, either version 1.3c of this license or (at your option)
+any later version. This version of this license is in
+https://www.latex-project.org/lppl/lppl-1-3c.txt
+and the latest version of this license is in
+https://www.latex-project.org/lppl.txt
+and version 1.3c or later is part of all distributions of
+LaTeX version 2005-12-01 or later.
2 DOWNLOAD
==========
-`regstats' is available on CTAN:
- CTAN:macros/latex/contrib/regstats/
-
-Running
-tex regstats.dtx
-generates the files
-regstats.ins, regstats.drv, regstats.sty,
-and regstats-example.tex.
+"regstats" is available on CTAN:
+https://ctan.org/pkg/regstats
-Also a ZIP file is provided that contains these files,
-the manual (regstats.pdf), the compiled example
-(regstats-example.pdf), its log-file (regstats-example.log),
+Also a ZIP file is provided that contains the files:
+the manual (regstats.pdf), the example (regstats-example.tex),
+the compiled example (regstats-example.pdf),
+the according log file (regstats-example.log)
+driver (regstats.drv), regstats.dtx,
+installation file (regstats.ins),
+the style file (regstats.sty),
and this README, already sorted in a TDS tree:
- CTAN:install/macros/latex/contrib/regstats.tds.zip
-
-`CTAN:' means one of the `Comprehensive TeX Archive Network'
-nodes or one of its mirrors. This is explained in
- http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives
-
-The CTAN stuff will be mirrored automatically from the
-ftp server, so
- ftp://ftp.tug.org/pub/tex/regstats/
-corresponds to
- CTAN:macros/latex/contrib/regstats/
+https://mirror.ctan.org/install/macros/latex/contrib/regstats.tds.zip
3 INSTALLATION
@@ -70,10 +64,11 @@ corresponds to
Installation with ZIP file in TDS format
----------------------------------------
-The ZIP file `regstats.tds.zip' contains the files
+The ZIP file "regstats.tds.zip" contains the files
sorted in a TDS tree. Thus you can directly unpack the
ZIP file inside a TDS tree.
-(See CTAN:tds.zip for an explanation of TDS.)
+See https://ctan.org/TDS-guidelines for an explanation
+of TDS.
Example:
cd /...somewhere.../texmf
unzip /...downloadpath.../regstats.tds.zip
@@ -88,19 +83,19 @@ a) Download the regstats files from CTAN.
If necessary, unpack them.
b) Generate the package and driver files:
tex regstats.dtx
-c) Install the file `*.sty' in your TDS tree:
- cp *.sty TDS:tex/latex/regstats/
- Replace `TDS:' by the prefix of your TDS tree
+c) Install the file "regstats.sty" in your TDS tree:
+ cp regstats.sty TDS:tex/latex/regstats/
+ Replace "TDS:" by the prefix of your TDS tree
(texmf directory).
-d) Create the documentation (if necessary), e.g.
+d) Create the documentation, if necessary, e.g.
pdflatex regstats.dtx
makeindex -s gind.ist regstats.idx
pdflatex regstats.dtx
makeindex -s gind.ist regstats.idx
pdflatex regstats.dtx
-e) Update the databases if necessary, e.g. for teTeX:
- mktexlsr .../texmf
-f) Create the regstats-example.pdf (if necessary), e.g.
+e) Update the databases if necessary, e.g. for TeXLive:
+ texhash or mktexlsr.
+f) Create the regstats-example.pdf, if necessary, e.g.
pdflatex regstats-example.tex
pdflatex regstats-example.tex
or remove the "%% " before "\directlua{starttime = os.clock()}"
@@ -118,13 +113,10 @@ g) Copy the documentation files to
=====================
regstats loads other packages:
-* kvoptions, http://ctan.org/pkg/kvoptions
-* atveryend, http://ctan.org/pkg/atveryend
-* ltxcmds, http://ctan.org/pkg/ltxcmds
+- kvoptions, https://ctan.org/pkg/kvoptions
+- iftex, https://ctan.org/pkg/iftex
with option timer additionally:
-* intcalc, http://ctan.org/pkg/intcalc
-* ifluatex, http://ctan.org/pkg/ifluatex
-* ifpdf, http://ctan.org/pkg/ifpdf
+- intcalc, https://ctan.org/pkg/intcalc
which again load other packages
(see the result of the \listfiles command in the log-file
of the example).
@@ -138,25 +130,25 @@ The timer option does not work with e.g. XeTeX, only with
(pdf)(la)tex or (lua)(la)tex. (Otherwise just do not use the option.)
6 AUTHOR/MAINTAINER
-=====================
+===================
* H.-Martin Münch
7 BUG REPORTS
-==============
+=============
A bug report should contain:
* Comprehensive problem description. This includes error or
warning messages.
* \errorcontextlines=\maxdimen can be added in the
TeX code to get more information in TeX error messages.
-* Minimal test file that shows the problem, but does not
- contain any unnecessary packages and code.
+* Minimal test file that shows the problem,
+ but does not contain any unnecessary packages and code.
* Used drivers/programs.
* Version information about used packages and programs.
-* If you are using LaTeX, then add "\listfiles". Then
- a list of version information is printed at the end
+* If you are using LaTeX, then add "\listfiles" to the document.
+ Then a list of version information is printed at the end
of the LaTeX run.
* Please no other files than the minimal test file.
The other files .log, .dvi, .ps, .pdf are seldom
@@ -171,6 +163,6 @@ Bug reports can be send to the maintainer:
8 KNOWN PROBLEMS
-=================
+================
-* as yet: none. \ No newline at end of file
+* Counting the used inserts is an issue. \ No newline at end of file