summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/regstats/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-05-17 23:09:04 +0000
committerKarl Berry <karl@freefriends.org>2011-05-17 23:09:04 +0000
commit2890d22f6ec817ed72f4929071ba6d63ede0c4b4 (patch)
tree5ffdeee429658f7d04704e73189fbd81392734d9 /Master/texmf-dist/doc/latex/regstats/README
parent36dd34a850a6284be752b454845c199ef83f62af (diff)
new latex package regstats (17may11)
git-svn-id: svn://tug.org/texlive/trunk@22508 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/regstats/README')
-rw-r--r--Master/texmf-dist/doc/latex/regstats/README140
1 files changed, 140 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/regstats/README b/Master/texmf-dist/doc/latex/regstats/README
new file mode 100644
index 00000000000..63b93cbd867
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/regstats/README
@@ -0,0 +1,140 @@
+README for regstats package, 2011/05/16, v1.0b
+
+
+TABLE OF CONTENTS
+=================
+
+1 Introduction
+2 Download
+3 Installation
+4 Additional Packages
+5 New Features
+6 Package Compatibility
+7 Authors/Maintainers
+8 Bug Reports
+9 Known Problems
+
+
+1 INTRODUCTION
+==============
+
+This 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).
+
+
+2 DOWNLOAD
+==========
+
+`regstats' is available on CTAN:
+ CTAN:macros/latex/contrib/regstats/
+
+Also a ZIP file is provided that contains the files, already
+sorted in a TDS tree (should become available on CTAN soon):
+ 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/
+
+
+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 CTAN:tds.zip 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 or the TUG server.
+ If necessary, unpack them.
+b) Generate the package and driver files:
+ tex regstats.ins
+c) Install the file `*.sty' in your TDS tree:
+ cp *.sty TDS:tex/latex/regstats/
+ Replace `TDS:' by the prefix of your TDS tree
+ (texmf directory).
+d) Copy the documentation files to
+ "TDS:doc/latex/regstats/":
+ README, regstats.pdf, regstats-example.tex,
+ regstats-example.log, regstats-example.pdf.
+e) Update the databases if necessary, e.g. for teTeX:
+ mktexlsr .../texmf
+
+
+4 ADDITIONAL PACKAGES
+=====================
+
+regstats loads other packages:
+* kvoptions, CTAN:macros/latex/contrib/oberdiek/kvoptions.dtx
+* atveryend, CTAN:macros/latex/contrib/oberdiek/atveryend.dtx
+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 last (but can be loaded earlier).
+
+6 AUTHOR/MAINTAINER
+=====================
+
+* Hans-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 informations 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". Then
+ a list of version informations 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:
+ Hans-Martin Münch
+ <Martin [dot] Muench [at] Uni-Bonn [dot] de>
+
+
+8 KNOWN PROBLEMS
+=================
+
+* as yet: none... \ No newline at end of file