summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/regstats/regstats.dtx
blob: 903f08ab3d30e86969348b1560ca1aa7abf844cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
% \iffalse meta-comment
%
% File: regstats.dtx
% Version: 2012/01/07 v1.0h
%
% Copyright (C) 2011 - 2012 by
%    H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>
%
% 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
%    http://www.latex-project.org/lppl/lppl-1-3c.txt
% and the latest version of this license is in
%    http://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.
%
% This work has the LPPL maintenance status "maintained".
%
% The Current Maintainer of this work is H.-Martin Muench.
%
% This work consists of the main source file regstats.dtx,
% the README, and the derived files
%    regstats.sty, regstats.pdf,
%    regstats.ins, regstats.drv,
%    regstats-example.tex, regstats-example.pdf,
%    regstats-example.log.
%
% Distribution:
%    CTAN:macros/latex/contrib/regstats/regstats.dtx
%    CTAN:macros/latex/contrib/regstats/regstats.pdf
%    CTAN:install/macros/latex/contrib/regstats.tds.zip
%
% Cf. http://ctan.org/pkg/regstats and
% http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/regstats.html
%
% Unpacking:
%    (a) If regstats.ins is present:
%           tex regstats.ins
%    (b) Without regstats.ins:
%           tex regstats.dtx
%    (c) If you insist on using LaTeX
%           latex \let\install=y\input{regstats.dtx}
%        (quote the arguments according to the demands of your shell)
%
% Documentation:
%    (a) If regstats.drv is present:
%           (pdf)latex regstats.drv
%           makeindex -s gind.ist regstats.idx
%           (pdf)latex regstats.drv
%           makeindex -s gind.ist regstats.idx
%           (pdf)latex regstats.drv
%    (b) Without regstats.drv:
%           (pdf)latex regstats.dtx
%           makeindex -s gind.ist regstats.idx
%           (pdf)latex regstats.dtx
%           makeindex -s gind.ist regstats.idx
%           (pdf)latex regstats.dtx
%
%    The class ltxdoc loads the configuration file ltxdoc.cfg
%    if available. Here you can specify further options, e.g.
%    use DIN A4 as paper format:
%       \PassOptionsToClass{a4paper}{article}
%
% Installation:
%    TDS:tex/latex/regstats/regstats.sty
%    TDS:doc/latex/regstats/regstats.pdf
%    TDS:doc/latex/regstats/regstats-example.tex
%    TDS:doc/latex/regstats/regstats-example.pdf
%    TDS:doc/latex/regstats/regstats-example.log
%    TDS:source/latex/regstats/regstats.dtx
%
%<*ignore>
\begingroup
  \catcode123=1 %
  \catcode125=2 %
  \def\x{LaTeX2e}%
\expandafter\endgroup
\ifcase 0\ifx\install y1\fi\expandafter
         \ifx\csname processbatchFile\endcsname\relax\else1\fi
         \ifx\fmtname\x\else 1\fi\relax
\else\csname fi\endcsname
%</ignore>
%<*install>
\input docstrip.tex
\Msg{********************************************************************}
\Msg{* Installation                                                     *}
\Msg{* Package: regstats 2012/01/07 v1.0h Counting used registers (HMM) *}
\Msg{********************************************************************}

\keepsilent
\askforoverwritefalse

\let\MetaPrefix\relax
\preamble

This is a generated file.

Project: regstats
Version: 2012/01/07 v1.0h

Copyright (C) 2011 - 2012 by
    H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>

The usual disclaimer applies:
If it doesn't work right that's your problem.
(Nevertheless, send an e-mail to the maintainer
 when you find an error in this package.)

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
   http://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
   http://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.

This work has the LPPL maintenance status "maintained".

The Current Maintainer of this work is H.-Martin Muench.

This work consists of the main source file regstats.dtx,
the README, and the derived files
   regstats.sty, regstats.pdf,
   regstats.ins, regstats.drv,
   regstats-example.tex, regstats-example.pdf,
   regstats-example.log.

\endpreamble
\let\MetaPrefix\DoubleperCent

\generate{%
  \file{regstats.ins}{\from{regstats.dtx}{install}}%
  \file{regstats.drv}{\from{regstats.dtx}{driver}}%
  \usedir{tex/latex/regstats}%
  \file{regstats.sty}{\from{regstats.dtx}{package}}%
  \usedir{doc/latex/regstats}%
  \file{regstats-example.tex}{\from{regstats.dtx}{example}}%
}

\catcode32=13\relax% active space
\let =\space%
\Msg{************************************************************************}
\Msg{*}
\Msg{* To finish the installation you have to move the following}
\Msg{* file into a directory searched by TeX:}
\Msg{*}
\Msg{*     regstats.sty}
\Msg{*}
\Msg{* To produce the documentation run the file `regstats.drv'}
\Msg{* through (pdf)LaTeX, e.g.}
\Msg{*  pdflatex regstats.drv}
\Msg{*  makeindex -s gind.ist regstats.idx}
\Msg{*  pdflatex regstats.drv}
\Msg{*  makeindex -s gind.ist regstats.idx}
\Msg{*  pdflatex regstats.drv}
\Msg{*}
\Msg{* At least three runs are necessary e.g. to get the}
\Msg{*  references right!}
\Msg{*}
\Msg{* Happy TeXing!}
\Msg{*}
\Msg{************************************************************************}

\endbatchfile
%</install>
%<*ignore>
\fi
%</ignore>
%
% \section{The documentation driver file}
%
% The next bit of code contains the documentation driver file for
% \TeX{}, i.\,e., the file that will produce the documentation you
% are currently reading. It will be extracted from this file by the
% \texttt{docstrip} programme. That is, run \LaTeX{} on \texttt{docstrip}
% and specify the \texttt{driver} option when \texttt{docstrip}
% asks for options.
%
%    \begin{macrocode}
%<*driver>
\NeedsTeXFormat{LaTeX2e}[2011/06/27]
\ProvidesFile{regstats.drv}%
  [2012/01/07 v1.0h Counting used registers (HMM)]
\documentclass{ltxdoc}[2007/11/11]% v2.0u
\usepackage{pdflscape}[2008/08/11]% v0.10
\usepackage{holtxdoc}[2011/02/04]%  v0.21
%% regstats may work with earlier versions of LaTeX2e and those
%% class and packages, but this was not tested.
%% Please consider updating your LaTeX, class, and packages
%% to the most recent version (if they are not already the most
%% recent version).
\hypersetup{%
 pdfsubject={Information about used number of TeX registers (HMM)},%
 pdfkeywords={LaTeX, regstats, registers, read, write, language, box, dimen, counter, toks, skip, muskip, math family, insertion, H.-Martin Muench},%
 pdfencoding=auto,%
 pdflang={en},%
 breaklinks=true,%
 linktoc=all,%
 pdfstartview=FitH,%
 pdfpagelayout=OneColumn,%
 bookmarksnumbered=true,%
 bookmarksopen=true,%
 bookmarksopenlevel=3,%
 pdfmenubar=true,%
 pdftoolbar=true,%
 pdfwindowui=true,%
 pdfnewwindow=true%
}
\CodelineIndex
\hyphenation{printing docu-ment}
\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
\makeatletter
\@ifundefined{eTeX}{\gdef\eTeX{$\m@th \varepsilon $-\TeX }}{% else \relax
}
\makeatother
\begin{document}
  \DocInput{regstats.dtx}%
\end{document}
%</driver>
%    \end{macrocode}
%
% \fi
%
% \CheckSum{578}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
% \GetFileInfo{regstats.drv}
%
% \begingroup
%   \def\x{\#,\$,\^,\_,\~,\ ,\&,\{,\},\%}%
%   \makeatletter
%   \@onelevel@sanitize\x
% \expandafter\endgroup
% \expandafter\DoNotIndex\expandafter{\x}
% \expandafter\DoNotIndex\expandafter{\string\ }
% \begingroup
%   \makeatletter
%     \lccode`9=32\relax
%     \lowercase{%^^A
%       \edef\x{\noexpand\DoNotIndex{\@backslashchar9}}%^^A
%     }%^^A
%   \expandafter\endgroup\x
%
% \DoNotIndex{\\}
% \DoNotIndex{\documentclass,\usepackage,\ProvidesPackage,\begin,\end}
% \DoNotIndex{\message,\MessageBreak}
% \DoNotIndex{\NeedsTeXFormat,\DoNotIndex,\verb}
% \DoNotIndex{\def,\edef,\gdef,\global}
% \DoNotIndex{\ifx,\listfiles,\mathord,\mathrm}
% \DoNotIndex{\kvoptions,\SetupKeyvalOptions,\ProcessKeyvalOptions}
% \DoNotIndex{\bigskip,\space,\thinspace,\ldots}
% \DoNotIndex{\indent,\noindent,\newline,\linebreak,\pagebreak, \newpage}
% \DoNotIndex{\textbf,\textit,\textsf,\texttt,\textquotedblleft,\textquotedblright}
% \DoNotIndex{\plainTeX,\TeX,\LaTeX,\pdfLaTeX}
% \DoNotIndex{\chapter,\section,\the,\csname,\endscname}
% \DoNotIndex{\value,\setcounter,\addtocounter,\arabic}
% \DoNotIndex{\regstats@test}
%
% \title{The \xpackage{regstats} package}
% \date{2012/01/07 v1.0h}
% \author{H.-Martin M\"{u}nch\\\xemail{Martin.Muench at Uni-Bonn.de}}
%
% \maketitle
%
% \begin{abstract}
%  This \LaTeX{} package allows to count the number of used registers
%  (counter, dimen, skip, muskip, box, token, input, output,
%  math families, languages, insertions)
%  and compare these to the maximum available number of such registers.
%  The time needed for a compilation run can be announced.
% \end{abstract}
%
% \bigskip
%
% \noindent Disclaimer for web links: The author is not responsible for any contents
% referred to in this work unless he has full knowledge of illegal contents.
% If any damage occurs by the use of information presented there, only the
% author of the respective pages might be liable, not the one who has referred
% to these pages.
%
% \bigskip
%
% \noindent {\color{green} Save per page about $200\unit{ml}$ water,
% $2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\\
% Therefore please print only if this is really necessary.}
%
% \pagebreak
%
% \tableofcontents
%
% \pagebreak
%
% \section{Introduction}
%
% \indent 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|).
% 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 |\directlua{starttime = os.clock()}|
% before |\documentclass| is used).
%
% \bigskip
%
% \section{Usage}
%
% \indent Just load the package placing
% \begin{quote}
%   |\usepackage[<|\textit{options}|>]{regstats}|
% \end{quote}
% \noindent at the end of the preamble of your \LaTeXe{} source file. When you
% load packages |\AtBeginDocument|, \xpackage{regstats} should be the last one
% of those packages. The resulting message will be presented at the end of the
% compilation messages at the screen and in the \xfile{log} file.\\
%
% \subsection{Options}
% \DescribeMacro{options}
% \indent The \xpackage{regstats} package takes the following options:
%
% \subsubsection{proof\label{sss:proof}}
% \DescribeMacro{proof}
% \indent When option \texttt{proof} (or \texttt{proof=true}) is chosen,
% 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 default is \texttt{proof=false}.
%
% \subsubsection{left\label{sss:left}}
% \DescribeMacro{left}
% \indent When option \texttt{left} (or \texttt{left=true}) is chosen,
% also the number of remaining registers of each type is given. The default
% is \texttt{left=false}.
%
% \subsubsection{timer\label{sss:timer}}
% \DescribeMacro{timer}
% \indent When option \texttt{timer} (or \texttt{timer=true}) is chosen,
% also the time needed for the compilation run is given. The default
% is \texttt{timer=false}. The used |\pdfelapsedtime| is not available,
% when |lua(la)tex| is used instead of |pdf(la)tex| to compile the document.
% In that case at the very beginning of your \xfile{tex} file say\\
% \verb|\directlua{starttime = os.clock()}|\\
% (even before |\documentclass|!), and the \texttt{timer} option can also
% be used with |lua(la)tex|. When neither |lua(la)tex| nor |pdf(la)tex| is used
% to compile the document, the \texttt{timer}(-option) does not work.
%
% \section{Alternatives\label{sec:Alternatives}}
%
% \begin{description}
% \item[-] \xpackage{regcount}, 1999/08/03, v1.0, by \textsc{Jean-Pierre F. Drucbert},
%   provides the command |\rgcounts|, which can write the numbers of used registers
%   into the \xfile{log} file anywhere (not only at the end) and does this automatically
%   |\AtBeginDocument| and |\AtEndDocument| (but not |\AtVeryVeryEnd|). The number of
%   allocated insertions is \emph{wrong} in my opinion, because these are not numbered
%   $1, 2,\ldots$, but start at a high number, which is then decreased. The package is
%   compatible with the \xpackage{regstats} package (i.\,e.~you can use both packages
%   at the same time in one document) and available at
%   \url{http://www.ctan.org/pkg/regcount}.
%
% \item[-] One can manually search for the last appearance of
%   |\count|, |\dimen|, |\skip|, |\muskip|, |\box|, |\toks|, |\read| (input),
%   |\write| (output), |\mathgroup| (math family), |\language|, and |\insert|,
%   and find the according number there. (This does not provide any information
%   about the number of remaining registers, of course.)
% \end{description}
%
% \bigskip
%
% \noindent (You programmed or found another alternative,
%  which is available at \CTAN{}?\\
%  OK, send an e-mail to me with the name, location at \CTAN{},
%  and a short notice, and I will probably include it in
%  the list above.)
%
% \newpage
%
% \section{Example}
%
%    \begin{macrocode}
%<*example>
%% When compiling with lua(la)tex (and wanting to use option timer=true,
%% the following line must be uncommented (i.e. remove the "%% ").
%% \directlua{starttime = os.clock()}
\documentclass[british]{article}[2007/10/19]% v1.4h
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% \usepackage{etex}[1998/03/26]% v2.0
%% Uncomment the preceding line, if you want to use the eTeX-package
%% (which requires eTeX, of course).
\usepackage[%
 extension=pdf,%
 plainpages=false,%
 pdfpagelabels=true,%
 hyperindex=false,%
 pdflang={en},%
 pdftitle={regstats package example},%
 pdfauthor={H.-Martin Muench},%
 pdfsubject={Example for the regstats package},%
 pdfkeywords={LaTeX, registers, read, write, language, box, dimen,%
 count, toks, muskip, skip, counter, regstats, H.-Martin Muench},%
 pdfview=Fit,%
 pdfstartview=Fit,%
 pdfpagelayout=SinglePage%
]{hyperref}[2011/12/04]% v6.82m
\usepackage[proof=false,left=true,timer=true]{regstats}[2012/01/07]%
%%                                                              v1.0h
\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
\makeatletter
\@ifundefined{eTeX}{\gdef\eTeX{$\m@th \varepsilon $-\TeX }}{%
%% else \relax
}
\makeatother
\listfiles
\begin{document}
\pagenumbering{arabic}
\section*{Example for regstats}

This example demonstrates the use of package\newline
\textsf{regstats}, v1.0h as of 2012/01/07 (HMM).\newline
The used options were \texttt{proof=false,left=true,timer=true}.\newline
\texttt{proof=false} is the default, but neither \texttt{left=true}
nor \texttt{timer=true} are defaults (\texttt{left=false,timer=false}
would be the defaults).\newline

If \eTeX{} is available with your \LaTeX{}-distribution
and you want to use it, uncomment the\newline
\verb|%% \usepackage{etex}[1998/03/26]% v2.0|\newline
line in the preamble of this document.\newline

For more details please see the documentation!\newline

\noindent Save per page about $200\unit{ml}$ water,
$2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\newline
Therefore please print only if this is really necessary.\newline

For the resulting message, please compile regstats-example.tex and
have a look at the end of the log-file.

Because the compilation time for this example is usually quite short,
option \texttt{timer} is not demonstrated very spectacular.

\end{document}
%</example>
%    \end{macrocode}
%
% \StopEventually{}
%
% \newpage
%
% \section{The implementation}
%
% We start off by checking that we are loading into \LaTeXe\ and
% announcing the name and version of this package.
%
%    \begin{macrocode}
%<*package>
%    \end{macrocode}
%
%    \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}[2011/06/27]
\ProvidesPackage{regstats}[2012/01/07 v1.0h
              Counting used registers (HMM)]

%    \end{macrocode}
%
% A short description of the \xpackage{regstats} package:
%
%    \begin{macrocode}
%% Allows to count the number of used registers
%% (counter, dimen, skip, muskip, box, token, input, output,
%%  math families, languages, insertions)
%% and compare these to the maximum available number of such registers.

%    \end{macrocode}
%
% We need the \xpackage{kvoptions}, \xpackage{atveryend}, and
% \xpackage{ltxcmds} packages by \textsc{Heiko Oberdiek}:
%
%    \begin{macrocode}
\RequirePackage{kvoptions}[2010/12/23]% v3.10
\RequirePackage{atveryend}[2011/06/30]% v1.8
\RequirePackage{ltxcmds}[2011/04/18]%   v1.20

%    \end{macrocode}
%
% A last information for the user:
%
%    \begin{macrocode}
%% regstats may work with earlier versions of LaTeX and these
%% packages, but this was not tested. Please consider updating
%% your LaTeX and packages to the most recent version
%% (if they are not already the most recent version).

%    \end{macrocode}
%
% \indent See subsection~\ref{ss:Downloads} about how to get them.\\
%
% We process the options:
%
%    \begin{macrocode}
\SetupKeyvalOptions{family=regstats,prefix=regstats@}
\DeclareBoolOption{proof}% \regstats@proof
\DeclareBoolOption{left}
\DeclareBoolOption{timer}

\ProcessKeyvalOptions*

\ifregstats@proof
  \PackageInfo{regstats}{%
    This package will use one of each kind of register itself!%
    \MessageBreak%
    (And other packages used by this package\MessageBreak%
    probably use additional resources,\MessageBreak%
    if those packages are not used anyway.)\MessageBreak%
   }
\else
  \PackageInfo{regstats}{%
    This package will not use registers itself,\MessageBreak%
    but packages used by this package\MessageBreak%
    (and packages loaded by those packages)\MessageBreak%
    use additional resources,\MessageBreak%
    if those packages are not used anyway.\MessageBreak%
   }
\fi

%    \end{macrocode}
%
% The different kinds of registers used with option |proof=true|
% are used not before |\AtVeryVeryEnd|, therefore even if it is
% the one used register too much, it should not interfere
% with the creation of the document.\\
%
%    \begin{macrocode}
\ifregstats@timer
  \RequirePackage{intcalc}[2007/09/27]%  v1.1
  \RequirePackage{ifluatex}[2010/03/01]% v1.3
  \RequirePackage{ifpdf}[2011/01/30]%    v2.3
\fi

\newcommand{\regst@ts@timer}{%
  \message{^^J}
  \ifluatex
    \@tempcnta=%
      \directlua{
        if starttime then
          tex.sprint((os.clock()-starttime)*65536)
        else
          tex.sprint(0)
        end
       }\relax
    \ifnum \the\@tempcnta = 0
      \PackageError{regstats}{Did you forget to start the timer?}{%
        Before \string\documentclass\space you need to say%
        \MessageBreak%
        \string\directlua{starttime = os.clock()} \MessageBreak%
       }
    \fi
  \else
    \ifpdf
      \@tempcnta=\the\pdfelapsedtime\relax
    \else
      \PackageError{regstats}{Option timer only works with pdf(la)tex%
        \MessageBreak%
        and with lua(la)tex}{%
        Neither appear to be used here. Announced compilation time %
        will be zero.
       }
      \@tempcnta=0\relax
    \fi
  \fi
  \edef\regstatselapsedtime{\the\@tempcnta}
  \divide \@tempcnta by 65536% scaledseconds -> seconds
  \edef\regstatsseconds{\the\@tempcnta}
  \ifnum \regstatsseconds > 59
    \edef\regstatsseconds{\intcalcMod{\the\@tempcnta}{60}}
    \divide \@tempcnta by 60% seconds -> minutes
  \else
    \@tempcnta=0\relax% minutes = 0
  \fi
  \ifnum \regstatsseconds < 10
    \message{Time elapsed for the last compiler run:^^J%
      about \the\@tempcnta:0\regstatsseconds\space%
      (m:ss; \regstatselapsedtime /65536 s).^^J}
  \else
%    \end{macrocode}
%
% \pagebreak
%
%    \begin{macrocode}
    \message{Time elapsed for the last compiler run:^^J%
      about \the\@tempcnta:\regstatsseconds \space%
      (m:ss; \regstatselapsedtime /65536 s).^^J}
  \fi
  }

\ifregstats@timer
\else
\renewcommand{\regst@ts@timer}{\relax}
\fi

\let\regst@ts@statistics\AtVeryVeryEnd%

%    \end{macrocode}
%
% \LaTeXe{} 2011/06/27 changed the |\enddocument| command and thus
% broke the \xpackage{atveryend} package, which was then fixed.
% If new \LaTeXe{} and old \xpackage{atveryend} are combined,
% |\AtVeryVeryEnd| will never be called.
% |\@ifl@t@r\fmtversion| is from |\@needsf@rmat| as in\\
% \texttt{File L: ltclass.dtx Date: 2007/08/05 Version v1.1h}, line~259,\\
% of The \LaTeXe{} Sources\\
% by \textsc{Johannes Braams, David Carlisle, Alan Jeffrey, Leslie Lamport,%
% Frank Mittelbach, Chris Rowley, and Rainer Sch\"{o}pf},\\
% as of 2011/06/27, p.~464.
%
%    \begin{macrocode}
\@ifl@t@r\fmtversion{2011/06/27}% or possibly even newer
{\@ifpackagelater{atveryend}{2011/06/29}%
 {% 2011/06/30, v1.8, or even more recent: OK
 }{% else: older package version, no \AtVeryVeryEnd
   \let\regst@ts@statistics\ltx@firstofone%
 }
}{% else: older fmtversion: OK
%    \end{macrocode}
%
% In this case the used \TeX{} format is outdated, but when\\
% |\NeedsTeXFormat{LaTeX2e}[2011/06/27]|\\
% is executed at the beginning of \xpackage{regstats} package,
% the appropriate warning message is issued automatically.
% (And \xpackage{regstats} should also work with older versions,
% I~used it with a 2003/12/01 version myself.)
%
%    \begin{macrocode}
}

\AtBeginDocument{%
 \AtEndDocument{%
  \BeforeClearDocument{%
   \AfterLastShipout{%
    \AtVeryEndDocument{%
     \AtEndAfterFileList{%
%    \end{macrocode}
%
% The \xpackage{regstats} package uses the \xpackage{atveryend} package,
% which is not compatible with the \xclass{seminar} class nor the
% \xpackage{slidesec} package. |\AtVeryVeryEnd| cannot be used with that
% class or package.\\
% |\ltx@ifclassloaded| and |\ltx@ifpackageloaded| from the \xpackage{ltxcmds}
% package can be used after |\AtBeginDocument| (in contrast to
% |\@ifclassloaded| and |\@ifpackageloaded|).
%
%    \begin{macrocode}
      \ltx@ifclassloaded{seminar}{% no \AtVeryVeryEnd
        \let\regst@ts@statistics\ltx@firstofone%
       }{% else
         \ltx@ifpackageloaded{slidesec}{% no \AtVeryVeryEnd
           \let\regst@ts@statistics\ltx@firstofone%
          }{% else: OK
          }%
       }%
%    \end{macrocode}
%
% |\AtEndAfterFileList| we write to |\AtVeryVeryEnd| (if available) via\linebreak
% |\regst@ts@statistics|, thus the code will be executed quite late during
% the compilation. (Please load \xpackage{regstats} as very last package!)\\
%
%    \begin{macrocode}
      \regst@ts@statistics{%
%    \end{macrocode}
%
% We try to determine, whether the \xpackage{etex}-package was loaded by the user
% (which requires \eTeX{} being available in the \LaTeX{} distribution
% used to compile the document).
%
%    \begin{macrocode}
        \ltx@ifpackageloaded{etex}{%
          \PackageInfo{regstats}{e-TeX-package found.}
        }{% else
          \PackageWarning{regstats}{Could not find the e-TeX-package.%
            \MessageBreak%
            That can mean that e-TeX was disabled or\MessageBreak%
            that your distribution of TeX does not contain e-TeX%
            \MessageBreak%
            or that you simply forgot to say \string\usepackage{etex}%
            \MessageBreak%
            in the preamble of \jobname.tex.\MessageBreak%
            The number of available counter, dimen, skip,\MessageBreak%
            muskip, box, and toks registers as well as the\MessageBreak%
            number of insertions would be larger when using%
            \MessageBreak%
            the e-TeX-package.%
           }
        }
%    \end{macrocode}
%
% We define a new command to determine the singular/plural form,
% maximum of available registers, and (if option |left| was chosen)
% the number of remaining registers of that type.
%
%    \begin{macrocode}
        \def\regstats@lft{}%
        \newcommand{\regstats@regstat}[5]{%
%    \end{macrocode}
%
% The five parameters are: number of used registers of that type,
% singular ending, plural ending, number of available registers without
% \eTeX{}, number of available registers with \eTeX{} (in this order).
%
%    \begin{macrocode}
          \@tempcnta=#1 \relax
          \ifnum \the\@tempcnta = 0
            \@tempcnta=2 \relax
          \fi
          \ifnum \the\@tempcnta > 1
            \gdef\regstats@pl{#3}
          \else
            \gdef\regstats@pl{#2}
          \fi
          \ltx@ifpackageloaded{etex}{\edef\regstats@max{#5}}{%
            \edef\regstats@max{#4}}
          \ifregstats@left
            \@tempcnta=\regstats@max \relax
            \advance\@tempcnta by -#1%
            \ifnum \the\@tempcnta > 0
              \edef\regstats@lft{, left: \the\@tempcnta}
            \else
              \ifnum \the\@tempcnta = 0
                \edef\regstats@lft{, left: \the\@tempcnta !!!}
              \else% \the\@tempcnta < 0
                \edef\regstats@lft{, left: \the\@tempcnta **********}
              \fi
            \fi
%    \end{macrocode}
%
% |         \else| |\regstats@lft| will stay |\empty|.
%
%    \begin{macrocode}
          \fi
         }
%    \end{macrocode}
%
% When option |proof| was chosen, one new register of each named type
% is used and its number compared with the according |count| number.
% We give a warning about the use of additional registers.
%
%    \begin{macrocode}
        \ifregstats@proof
          \PackageWarning{regstats}{%
            Package regstats loaded with option 'proof'.\MessageBreak%
            This package itself will now use\MessageBreak%
             one of each register for testing!\MessageBreak%
            }%
          \def\regstats@proof{1}
          \newcounter{regstatscount}
          \edef\regstats@counter{\the\allocationnumber}
          \edef\regstats@test{\the\count10}
          \ifx\regstats@counter\regstats@test
          \else
            \message{Discrepancy when counting count registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newdimen{\regstatsdimen}
          \edef\regstats@dimen{\the\allocationnumber}
          \edef\regstats@test{\the\count11}
          \ifx\regstats@dimen\regstats@test
          \else
            \message{Discrepancy when counting dimen registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newskip\regstatsskip
          \edef\regstats@skip{\the\allocationnumber}
          \edef\regstats@test{\the\count12}
          \ifx\regstats@skip\regstats@test
          \else
            \message{Discrepancy when counting skip registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newmuskip\regstatsmuskip
          \edef\regstats@muskip{\the\allocationnumber}
          \edef\regstats@test{\the\count13}
          \ifx\regstats@muskip\regstats@test
          \else
            \message{Discrepancy when counting muskip registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newbox\regstatsbox
          \edef\regstats@box{\the\allocationnumber}
          \edef\regstats@test{\the\count14}
          \ifx\regstats@box\regstats@test
          \else
            \message{Discrepancy when counting box registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newtoks\regstatstoks
          \edef\regstats@toks{\the\allocationnumber}
          \edef\regstats@test{\the\count15}
          \ifx\regstats@toks\regstats@test
          \else
            \message{Discrepancy when counting toks registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newread\regstatsread
          \edef\regstats@read{\the\allocationnumber}
          \edef\regstats@test{\the\count16}
          \ifx\regstats@read\regstats@test
          \else
            \message{Discrepancy when counting read registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newwrite\regstatswrite
          \edef\regstats@write{\the\allocationnumber}
          \edef\regstats@test{\the\count17}
          \ifx\regstats@write\regstats@test
          \else
            \message{Discrepancy when counting write registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newfam\regstatsfam
          \edef\regstats@fam{\the\allocationnumber}
          \edef\regstats@test{\the\count18}
          \ifx\regstats@fam\regstats@test
          \else
            \message{Discrepancy when counting fam registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newlanguage\regstatslanguage
          \edef\regstats@language{\the\allocationnumber}
          \edef\regstats@test{\the\count19}
          \ifx\regstats@language\regstats@test
          \else
            \message{Discrepancy when counting language registers.^^J}
            \def\regstats@proof{0}
          \fi
          \newinsert\regstatsinsert
          \edef\regstats@insert{\the\allocationnumber}
          \edef\regstats@test{\the\count20}
          \ifx\regstats@insert\regstats@test
          \else
            \message{Discrepancy when counting insert registers.^^J}
            \def\regstats@proof{0}
          \fi
%    \end{macrocode}
%
% When there was a discrepancy somewhere, we give the according message.
%
%    \begin{macrocode}
        \edef\regstats@test{0}
        \ifx\regstats@proof\regstats@test
          \message{Regstats test for register numbers failed.^^J}
          \message{Therefore option 'proof' is necessary to get the %
                   right numbers.^^J}
        \fi
      \else
%    \end{macrocode}
%
% \pagebreak
%
% Without option |proof|, we just take the values of the various |count|s.
%
%    \begin{macrocode}
        \edef\regstats@counter{\the\count10}
        \edef\regstats@dimen{\the\count11}
        \edef\regstats@skip{\the\count12}
        \edef\regstats@muskip{\the\count13}
        \edef\regstats@box{\the\count14}
        \edef\regstats@toks{\the\count15}
        \edef\regstats@read{\the\count16}
        \edef\regstats@write{\the\count17}
        \edef\regstats@fam{\the\count18}
        \edef\regstats@language{\the\count19}
        \edef\regstats@insert{\the\count20}
      \fi
%    \end{macrocode}
%
% |insert|s are used starting with a high number and moving downward.
%
%    \begin{macrocode}
      \@tempcnta = 233 \relax
      \advance\@tempcnta by -\regstats@insert%
      \advance\@tempcnta by +1%
      \edef\regstats@insert{\the\@tempcnta}
%    \end{macrocode}
%
% \newpage
% \begin{landscape}
%
% The number of used registers of each type and the number of available ones
% (estimated, probably dependent on distribution and its version, here just
% distinguished according to availability of \eTeX{}) is written
% to screen and \xfile{log} file. (Additional spaces are just for increased ease
% of readability of the code and will appear neither at the scree output nor
% in the \xfile{log}~file.)
%
%    \begin{macrocode}
      \message{^^J}
      \message{Here is how much of TeX's registers you used^^J}%
      \message{\space (numbers of available registers are estimated!):^^J}%
      \regstats@regstat{\regstats@counter}{}{s}{233}{32767}
      \message{ \regstats@counter\space  counter register\regstats@pl\space      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@dimen}{}{s}{233}{32767}
      \message{ \regstats@dimen\space    dimen   register\regstats@pl\space      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@skip}{}{s}{233}{32767}
      \message{ \regstats@skip\space     skip    register\regstats@pl\space      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@muskip}{}{s}{255}{32767}
      \message{ \regstats@muskip\space   muskip  register\regstats@pl\space      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@box}{}{s}{233}{32767}
      \message{ \regstats@box\space      box     register\regstats@pl\space      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@toks}{}{s}{255}{32767}
      \message{ \regstats@toks\space     toks    register\regstats@pl\space      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@read}{}{s}{15}{15}
      \message{ \regstats@read\space     input stream\regstats@pl\space (read)   out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@write}{}{s}{15}{15}
      \message{ \regstats@write\space    output stream\regstats@pl\space (write) out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@fam}{y}{ies}{15}{15}
      \message{ \regstats@fam\space      math famil\regstats@pl\space (fam)      out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@language}{}{s}{255}{255}
      \message{ \regstats@language\space language code\regstats@pl\space         out of \regstats@max \regstats@lft ^^J}
      \regstats@regstat{\regstats@insert}{}{s}{101}{124}
      \message{ \regstats@insert\space   insertion\regstats@pl\space             out of \regstats@max \regstats@lft ^^J}
%    \end{macrocode}
%
% \pagebreak
% \end{landscape}
%
% When option |timer| (or |timer=true|) was used, the \xpackage{regstats} package
% additionally gives the time, which was needed for the (last) compilation (run).
% When more than one compilation run is necessary to compile the document,
% the individual times have to be added up manually.
% If~|\pdfelapsedtime| was reset by another package, the result is not correct,
% of course, but unfortunately it is not possible to check for this. You could say
% |\def\pdfresettimer{\relax}| immediately after |\documentclass[...]{...}|
% to prevent this. Better use\\
% |\long\def\pdfresettimer{%|\\
% \ |\PackageError{regstats}{\string\pdfresettimer\space used}}|\\
% to be notified thereof. This redefinition could be implemented in this
% \xpackage{regstats} package, but this would have no effect for the use of
% |\pdfresettimer| before this package is called. Because this package
% should be called as late as immediately before |\begin{document}|, this would mean
% that resetting would be possible during the whole loading of all packages.\\
%
% |\pdfelapsedtime| is not available when |lua(la)tex| is used instead of
% |pdf(la)tex| to compile the document. In that case at the very beginning
% of your \xfile{tex} file say\\
% \verb|\directlua{starttime = os.clock()}|\\
% (even before |\documentclass|!), and the \texttt{timer} option can also
% be used with |lualatex|. When neither |lualatex| nor |pdflatex| is used to
% compile the document, the timer(-option) does not work.
%
%    \begin{macrocode}
      \regst@ts@timer
      }%
     }%
    }%
   }%
  }%
 }%
}

%    \end{macrocode}
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}
%
% \newpage
%
% \section{Installation}
%
% \subsection{Downloads\label{ss:Downloads}}
%
% Everything is available at \CTAN{}, \url{http://www.ctan.org/tex-archive/},
% but may need additional packages themselves.\\
%
% \DescribeMacro{regstats.dtx}
% For unpacking the |regstats.dtx| file and constructing the documentation it is required:
% \begin{description}
% \item[-] \TeX Format \LaTeXe{}: \url{http://www.CTAN.org/}
%
% \item[-] document class \xpackage{ltxdoc}, 2007/11/11, v2.0u,\\
%           \CTAN{macros/latex/base/ltxdoc.dtx}
%
% \item[-] package \xpackage{pdflscape}, 2008/08/11, v0.10,
%           \url{http://ctan.org/pkg/pdflscape}
%
% \item[-] package \xpackage{holtxdoc}, 2011/02/04, v0.21,
%           \url{http://ctan.org/pkg/holtxdoc}
%
% \item[-] package \xpackage{hypdoc}, 2010/03/26, v1.9,
%           \url{http://ctan.org/pkg/hypdoc}
% \end{description}
%
% \DescribeMacro{regstats.sty}
% The \texttt{regstats.sty} for \LaTeXe{} (i.\,e.~each document using
% the \xpackage{regstats} package) requires:
% \begin{description}
% \item[-] \TeX Format \LaTeXe{}, \url{http://www.CTAN.org/}
%
% \item[-] package \xpackage{kvoptions}, 2010/12/23, v3.10,
%           \url{http://ctan.org/pkg/kvoptions}
%
% \item[-] package \xpackage{atveryend}, 2011/06/30, v1.8,
%           \url{http://ctan.org/pkg/atveryend}
% \end{description}
%
% When option |timer| is used, additionally
% \begin{description}
% \item[-] package \xpackage{intcalc}, 2007/09/27, v1.1,
%           \url{http://ctan.org/pkg/intcalc}
%
% \item[-] package \xpackage{ifluatex}, 2010/03/01, v1.3,
%           \url{http://ctan.org/pkg/ifluatex}
%
% \item[-] package \xpackage{ifpdf}, 2011/01/30, v2.3,
%           \url{http://ctan.org/pkg/ifpdf}
% \end{description}
% are needed.\\
%
% \DescribeMacro{regstats-example.tex}
% The \texttt{regstats-example.tex} requires the same files as all
% documents using the \xpackage{regstats} package, i.\,e. the ones
% named above and additionally:
% \begin{description}
% \item[-] class \xpackage{article}, 2007/10/19, v1.4h, from \xpackage{classes.dtx}:\\
%           \CTAN{macros/latex/base/classes.dtx}
%
% \item[-] package \xpackage{regstats}, 2012/01/07, v1.0h,
%           \url{http://ctan.org/pkg/regstats}\\
%   (Well, it is the example file for this package, and because you are reading the
%    documentation for the \xpackage{regstats} package, it can be assumed that you already
%    have some version of it -- is it the current one?)
% \end{description}
%
% \DescribeMacro{Alternative}
% As possible alternative in section \ref{sec:Alternatives} there is listed
% \begin{description}
% \item[-] \xpackage{regcount}, 1999/08/03, v1.0:
%            \url{http://www.ctan.org/pkg/regcount}
% \end{description}
%
% \pagebreak
%
% \DescribeMacro{Oberdiek}
% \DescribeMacro{holtxdoc}
% \DescribeMacro{kvoptions}
% \DescribeMacro{atveryend}
% \DescribeMacro{ifluatex}
% \DescribeMacro{ifpdf}
% \DescribeMacro{intcalc}
% \DescribeMacro{ltxcmds}
% \DescribeMacro{pdflscape}
% All packages of \textsc{Heiko Oberdiek's} bundle `oberdiek'
% (especially \xpackage{holtxdoc}, \xpackage{kvoptions}, \xpackage{atveryend},
% \xpackage{ifluatex}, \xpackage{ifpdf}, \xpackage{intcalc}, \xpackage{ltxcmds},
% and \xpackage{pdflscape}) are also available in a TDS compliant ZIP archive:\\
% \CTAN{install/macros/latex/contrib/oberdiek.tds.zip}.\\
% It is probably best to download and use this, because the packages in there
% are quite probably both recent and compatible among themselves.\\
%
% \vskip 1.2cm
%
% \DescribeMacro{hyperref}
% \noindent \xpackage{hyperref} is not included in that bundle and needs to be
% downloaded separately,\\
% \url{http://mirror.ctan.org/install/macros/latex/contrib/hyperref.tds.zip}.\\
%
% \DescribeMacro{M\"{u}nch}
% A hyperlinked list of my (other) packages can be found at
% \url{http://www.Uni-Bonn.de/~uzs5pv/LaTeX.html}.\\
%
% \subsection{Package, unpacking TDS}
%
% \paragraph{Package.} This package is available on \CTAN{}
% \begin{description}
% \item[\CTAN{macros/latex/contrib/regstats/regstats.dtx}]\hspace*{0.1cm} \\
%       The source file.
% \item[\CTAN{macros/latex/contrib/regstats/regstats.pdf}]\hspace*{0.1cm} \\
%       The documentation.
% \item[\CTAN{macros/latex/contrib/regstats/regstats-example.pdf}]\hspace*{0.1cm} \\
%       The compiled example file, as it should look like.
% \item[\CTAN{macros/latex/contrib/regstats/regstats-example.log}]\hspace*{0.1cm} \\
%       A \xfile{log} file for the example.
% \item[\CTAN{macros/latex/contrib/regstats/README}]\hspace*{0.1cm} \\
%       The README file.
% \end{description}
% There is also a regstats.tds.zip available:
% \begin{description}
% \item[\CTAN{install/macros/latex/contrib/regstats.tds.zip}]\hspace*{0.1cm} \\
%       Everything in \xfile{TDS} compliant, compiled format.
% \end{description}
% which additionally contains\\
% \begin{tabular}{ll}
% regstats.ins & The installation file.\\
% regstats.drv & The driver to generate the documentation.\\
% regstats.sty & The \xext{sty}le file.\\
% regstats-example.tex & The example file.\\
% regstats-example.log & A \xfile{log} file for the example.
% \end{tabular}
%
% \bigskip
%
% \noindent For required other packages, see the preceding subsection.
%
% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
% \docstrip{} archive. The files are extracted by running the
% \xfile{.dtx} through \plainTeX{}:
% \begin{quote}
%   \verb|tex regstats.dtx|
% \end{quote}
%
% About generating the documentation see paragraph~\ref{GenDoc} below.\\
%
% \paragraph{TDS.} Now the different files must be moved into
% the different directories in your installation TDS tree
% (also known as \xfile{texmf} tree):
% \begin{quote}
% \def\t{^^A
% \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\ttfamily}l@{}}
%   regstats.sty & tex/latex/regstats/regstats.sty\\
%   regstats.pdf & doc/latex/regstats/regstats.pdf\\
%   regstats-example.tex & doc/latex/regstats/regstats-example.tex\\
%   regstats-example.pdf & doc/latex/regstats/regstats-example.pdf\\
%   regstats-example.log & doc/latex/regstats/regstats-example.log\\
%   regstats.dtx & source/latex/regstats/regstats.dtx\\
% \end{tabular}^^A
% }^^A
% \sbox0{\t}^^A
% \ifdim\wd0>\linewidth
%   \begingroup
%     \advance\linewidth by\leftmargin
%     \advance\linewidth by\rightmargin
%   \edef\x{\endgroup
%     \def\noexpand\lw{\the\linewidth}^^A
%   }\x
%   \def\lwbox{^^A
%     \leavevmode
%     \hbox to \linewidth{^^A
%       \kern-\leftmargin\relax
%       \hss
%       \usebox0
%       \hss
%       \kern-\rightmargin\relax
%     }^^A
%   }^^A
%   \ifdim\wd0>\lw
%     \sbox0{\small\t}^^A
%     \ifdim\wd0>\linewidth
%       \ifdim\wd0>\lw
%         \sbox0{\footnotesize\t}^^A
%         \ifdim\wd0>\linewidth
%           \ifdim\wd0>\lw
%             \sbox0{\scriptsize\t}^^A
%             \ifdim\wd0>\linewidth
%               \ifdim\wd0>\lw
%                 \sbox0{\tiny\t}^^A
%                 \ifdim\wd0>\linewidth
%                   \lwbox
%                 \else
%                   \usebox0
%                 \fi
%               \else
%                 \lwbox
%               \fi
%             \else
%               \usebox0
%             \fi
%           \else
%             \lwbox
%           \fi
%         \else
%           \usebox0
%         \fi
%       \else
%         \lwbox
%       \fi
%     \else
%       \usebox0
%     \fi
%   \else
%     \lwbox
%   \fi
% \else
%   \usebox0
% \fi
% \end{quote}
% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip{}'s
% \xfile{TDS} installing feature, then some files can already be in the right
% place, see the documentation of \docstrip{}.
%
% \subsection{Refresh file name databases}
%
% If your \TeX{}~distribution (\teTeX{}, \mikTeX{},\dots{}) relies on file name
% databases, you must refresh these. For example, \teTeX{} users run
% \verb|texhash| or \verb|mktexlsr|.
%
% \subsection{Some details for the interested}
%
% \paragraph{Unpacking with \LaTeX{}.}
% The \xfile{.dtx} chooses its action depending on the format:
% \begin{description}
% \item[\plainTeX:] Run \docstrip{} and extract the files.
% \item[\LaTeX:] Generate the documentation.
% \end{description}
% If you insist on using \LaTeX{} for \docstrip{} (really,
% \docstrip{} does not need \LaTeX{}), then inform the autodetect routine
% about your intention:
% \begin{quote}
%   \verb|latex \let\install=y\input{regstats.dtx}|
% \end{quote}
% Do not forget to quote the argument according to the demands
% of your shell.
%
% \paragraph{Generating the documentation.\label{GenDoc}}
% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
% the documentation. The process can be configured by a
% configuration file \xfile{ltxdoc.cfg}. For instance, put the following
% line into this file, if you want to have A4 as paper format:
% \begin{quote}
%   \verb|\PassOptionsToClass{a4paper}{article}|
% \end{quote}
%
% \noindent An example follows how to generate the
% documentation with \pdfLaTeX{}:
%
% \begin{quote}
%\begin{verbatim}
%pdflatex regstats.dtx
%makeindex -s gind.ist regstats.idx
%pdflatex regstats.dtx
%makeindex -s gind.ist regstats.idx
%pdflatex regstats.dtx
%\end{verbatim}
% \end{quote}
%
% \subsection{Compiling the example}
%
% The example file, \textsf{regstats-example.tex}, can be compiled via\\
% |(pdf)(la)tex regstats-example.tex|\\
% or (after removing the |%% | before |\directlua{starttime = os.clock()}|
% in the line before |\documentclass|\ldots) via\\
% |lua(la)tex regstats-example.tex|.\\
%
% \section{Acknowledgements}
%
% I would like to thank \textsc{Heiko Oberdiek} for providing
% the \xpackage{hyperref}, \xpackage{holtxdoc}, \xpackage{kvoptions},
% \xpackage{atveryend}, \xpackage{ifluatex}, \xpackage{ifpdf},
% \xpackage{intcalc}, \xpackage{ltxcmds}, and \xpackage{pdflscape}
% as well as a~lot~(!) of other useful packages (from which I also got everything
% I know about creating a file in \xext{dtx} format, ok, say it: copying),
% \textsc{Jean-Pierre F. Drucbert} for his \xpackage{regcount} package,
% \textsc{Robin Fairbairns} for pointing me to the \xpackage{regcount} package,
% and the \Newsgroup{comp.text.tex} and \Newsgroup{de.comp.text.tex}
% newsgroups as well as \url{http://tex.stackexchange.com}
% for their help in all things \TeX{}.
%
% \bigskip
%
% \phantomsection
% \begin{History}\label{History}
%   \begin{Version}{2011/05/14 v1.0a}
%     \item Upload to \CTAN{}.
%   \end{Version}
%   \begin{Version}{2011/05/16 v1.0b}
%     \item Name clash with \xfile{regcount} package, fixed.
%     \item \xfile{regcount} package listed as possible alternative.
%     \item Bug: skip and muskip mixed up, fixed.
%     \item Counting of skips, math families, and insertions added.
%     \item Bug fix: insertions are numbered high to low.
%     \item Option |proof| added.
%     \item Diverse details.
%   \end{Version}
%   \begin{Version}{2011/06/08 v1.0c}
%     \item Bug Fix: Number of available |\skip| registers with \eTeX{}.
%     \item Change in \eTeX{}-detection.
%     \item New option |left|.
%     \item Minor details.
%   \end{Version}
%   \begin{Version}{2011/06/18 v1.0d}
%     \item Bug Fix: Information about used registers/counter fixed.
%     \item New option |timer|.
%     \item Some details.
%   \end{Version}
%   \begin{Version}{2011/08/22 v1.0e}
%     \item The information about the used registers is now presented even later.
%     \item Quite some details in the documentation.
%     \item Updated to \TeX{}live2011.
%     \item Hot fix: \TeX{} 2011/06/27 has changed |\enddocument| and
%             thus broken the |\AtVeryVeryEnd| command/hooking
%             of \xpackage{atveryend} package as of 2011/04/23, v1.7.
%             Until it is fixed, |\AtEndAfterFileList| is used.
%   \end{Version}
%   \begin{Version}{2011/08/23 v1.0f}
%     \item The \xpackage{atveryend} package was fixed (2011/06/30, v.1.8).
%             Now \xpackage{regstats} differentiates according to \TeX{} format
%             and \xpackage{atveryend} package version. 2011/06/30, v.1.8
%             should become available at CTAN soon. \xpackage{regstats} also
%             works with the old version, the information is just presented
%             a little bit earlier during compilation, thus theoretically
%             there could be missed some register use after that information,
%             which would be obvious in the \xfile{log}-file.
%     \item New \xpackage{hyperref} package used for the documentation.
%   \end{Version}
%   \begin{Version}{2012/01/01 v1.0g}
%     \item Now supports (but does not require) |lua(la)tex| for
%             option \texttt{timer}.
%     \item Bug fix: wrong path given in the documentation, fixed.
%     \item Due to the use of temporary counters, no longer a new counter is used
%             (except when option \texttt{proof=true} is chosen, of course).
%     \item Circumvention of the incompatibility of the \xpackage{atveryend}
%             package with \xclass{seminar} class and \xpackage{slidesec} package
%             introduced.
%     \item Quite some additional changes in the \xfile{dtx} and README files.
%   \end{Version}
%   \begin{Version}{2012/01/07 v1.0h}
%     \item Bug fix: |\ifluatex| undefined without \xpackage{ifluatex} leads to wrong
%            association of |\else|\ldots|\fi|. Fixed by moving |\ifregstats@timer|.
%   \end{Version}
% \end{History}
%
% \bigskip
%
% When you find a mistake or have a suggestion for an improvement of this package,
% please send an e-mail to the maintainer, thanks! (Please see BUG REPORTS in the README.)
%
% \pagebreak
%
% \PrintIndex
%
% \Finale
\endinput