README for regstats package, 2025-01-28, v1.1b


TABLE OF CONTENTS
=================

1 Introduction
2 Download
3 Installation
4 Additional Packages
5 Package Compatibility
6 Author/Maintainer
7 Bug Reports
8 Known Problems


1 INTRODUCTION
==============

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,
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 LuaLaTeX with
\directlua{starttime = os.clock()}
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:
https://ctan.org/pkg/regstats

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:
https://mirror.ctan.org/install/macros/latex/contrib/regstats.tds.zip


3 INSTALLATION
==============

Installation with ZIP file in TDS format
----------------------------------------
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 https://ctan.org/TDS-guidelines for an explanation
of TDS.
Example:
  cd /...somewhere.../texmf
  unzip /...downloadpath.../regstats.tds.zip
Do not forget to refresh the file name database of this
TDS tree.
Example:
  texhash /...somewhere.../texmf

Manual installation
-------------------
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 "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.
     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 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()}"
   in the regstats-example.tex and use
     lualatex regstats-example.tex
     lualatex regstats-example.tex
     lualatex regstats-example.tex
g) Copy the documentation files to
   "TDS:doc/latex/regstats/":
   README, regstats.pdf, regstats-example.tex,
   regstats-example.log, regstats-example.pdf.


4 ADDITIONAL PACKAGES
=====================

regstats loads other packages:
- kvoptions, https://ctan.org/pkg/kvoptions
- iftex, https://ctan.org/pkg/iftex
with option timer additionally:
- 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).


5 PACKAGE COMPATIBILITY
=======================

regstats should be loaded very last (but can be loaded earlier).
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.
* Used drivers/programs.
* Version information about used packages and programs.
* 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
  necessary, so send them only on request.
* Please .zip or .tar.gz your file(s) before sending them!

Bug address
-----------
Bug reports can be send to the maintainer:
  H.-Martin Münch
  <Martin [dot] Muench [at] Uni-Bonn [dot] de>


8 KNOWN PROBLEMS
================

* Counting the used inserts is an issue.