summaryrefslogtreecommitdiff
path: root/support/TVS/TVS/docs/tvs.html
blob: 328b711b8e1835240cbe197490d5b9c04a19d382 (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
<html lang="en"><head>
<title>TeX Versioning System</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name=description content="TeX Versioning System">
<meta name=generator content="makeinfo 4.0">
<link href="http://texinfo.org/" rel=generator-home>
</head><body>

<p><hr>
Node:<a name="Top">Top</a>,
Next:<a rel=next href="#Copying">Copying</a>,
Previous:<a rel=previous href="#(dir)">(dir)</a>,
Up:<a rel=up href="#(dir)">(dir)</a>
<br>

<h1>TeX Versioning System</h1>

<p>This is documentation of TeX Versioning System, software for storing
complete source codes of TeX documents.

<ul>
<li><a href="#Copying">Copying</a>: 
<li><a href="#Introduction">Introduction</a>: 
<li><a href="#Installation">Installation</a>: 
<li><a href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>: 
<li><a href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>: 
<li><a href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>: 
<li><a href="#Credits">Credits</a>: 
<li><a href="#Dealing%20with%20bugs%20in%20%3ccode%3eTVS%3c%2fcode%3e">Dealing with bugs in <code>TVS</code></a>:

<p>--- The Detailed Node Listing ---

<p>Introduction

</p><li><a href="#Why%20do%20you%20need%20%3ccode%3eTVS%3c%2fcode%3e%3f">Why do you need <code>TVS</code>?</a>: 
<li><a href="#What%20%3ccode%3eTVS%3c%2fcode%3e%20can%20do%3f">What <code>TVS</code> can do?</a>: 
<li><a href="#What%20do%20you%20need%20to%20run%20%3ccode%3eTVS%3c%2fcode%3e%3f">What do you need to run <code>TVS</code>?</a>:

<p>Using <code>TVS</code> step by step

</p><li><a href="#Useful%20commands">Useful commands</a>: 
<li><a href="#Basic%20running%20%3ccode%3eTVS%3c%2fcode%3e">Basic running <code>TVS</code></a>: 
<li><a href="#Ignoring%20files">Ignoring files</a>: 
<li><a href="#Format%20file%20sources">Format file sources</a>: 
<li><a href="#Configuration%20file">Configuration file</a>: 
<li><a href="#Limitations%20of%20%3ccode%3eTVS%3c%2fcode%3e">Limitations of <code>TVS</code></a>: 
<li><a href="#Fonts">Fonts</a>: 
<li><a href="#What%20to%20do%20with%20collected%20output">What to do with collected output</a>:

<p>Reference guide to <code>TVS</code> commands

</p><li><a href="#Invoking%20%3ccode%3eTVS%3c%2fcode%3e">Invoking <code>TVS</code></a>: 
<li><a href="#Global%20switches">Global switches</a>: 
<li><a href="#Ignoring%20files%20and%20cutting%20filenames">Ignoring files and cutting filenames</a>: 
<li><a href="#Output%20directory%20setting">Output directory setting</a>: 
<li><a href="#Storing%20format%20source%20files%20and%20fonts">Storing format source files and fonts</a>:

<p>Config file and pattern files

</p><li><a href="#Config%20file">Config file</a>: 
<li><a href="#Pattern%20file%20structure">Pattern file structure</a>:

<p>Pattern file structure

</p><li><a href="#Pathcuts%20pattern%20file">Pathcuts pattern file</a>: 
<li><a href="#Ignore%20pattern%20file">Ignore pattern file</a>:

</ul>

<p><hr>
Node:<a name="Copying">Copying</a>,
Next:<a rel=next href="#Introduction">Introduction</a>,
Previous:<a rel=previous href="#Top">Top</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Copying</h1>

<p>The program <code>TVS</code> and its documentation is written and
maintained by David Antos&lt;, <a href="mailto:xantos (at) fi.muni.cz">xantos (at) fi.muni.cz</a>. (Of course substitute (at) with @.) 
Contact him when in trouble, but please read the documentation first.

<p>Copyright &copy; 2000 David Antos&lt;

<p>Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

<p>Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

<p>Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Free Software Foundation.

<p><hr>
Node:<a name="Introduction">Introduction</a>,
Next:<a rel=next href="#Installation">Installation</a>,
Previous:<a rel=previous href="#Copying">Copying</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Introduction</h1>

<p>This is documentation of TeX Versioning System, software for storing
complete source codes of TeX documents.

<p>Version 1.0

<p>(Documentation CVS ver. $Id: tvs.texi,v 1.23 2000/08/16 17:00:24 antos Exp $)

<ul>
<li><a href="#Why%20do%20you%20need%20%3ccode%3eTVS%3c%2fcode%3e%3f">Why do you need <code>TVS</code>?</a>: 
<li><a href="#What%20%3ccode%3eTVS%3c%2fcode%3e%20can%20do%3f">What <code>TVS</code> can do?</a>: 
<li><a href="#What%20do%20you%20need%20to%20run%20%3ccode%3eTVS%3c%2fcode%3e%3f">What do you need to run <code>TVS</code>?</a>: 
</ul>

<p><hr>
Node:<a name="Why%20do%20you%20need%20%3ccode%3eTVS%3c%2fcode%3e%3f">Why do you need <code>TVS</code>?</a>,
Next:<a rel=next href="#What%20%3ccode%3eTVS%3c%2fcode%3e%20can%20do%3f">What <code>TVS</code> can do?</a>,
Previous:<a rel=previous href="#Introduction">Introduction</a>,
Up:<a rel=up href="#Introduction">Introduction</a>
<br>

<h2>Why do you need <code>TVS</code>?</h2>

<p>It must have happened to you. You use TeX at work. You run another
distribution at home. You wrote a beautiful document at home, you came to
work and got error message <code>I can't find file `foo.tex'</code>. There is a
package missing in your work installation.

<p>Or: You wrote a beautifully typeset book several years ago. 
You used em-TeX on M$-DOS machine. The book should be typeset again. You
have only my_book.tex and no macros you used. What to do?

<p>To be serious, there is nothing to be done now. But if you stored the
<em>complete</em> source of the documents, it didn't have to happen to you. 
And how to store the complete source? It's simple--use <code>TVS</code>.

<p>Please! Please! Packing complete TeX document sources is a delicate
and sensitive operation. Read the entire manual before you use
<code>TVS</code> to do something important. This kind of software can be
useful for you if and only if you use it correctly. I'm sorry for this
but it's the fact.

<p><hr>
Node:<a name="What%20%3ccode%3eTVS%3c%2fcode%3e%20can%20do%3f">What <code>TVS</code> can do?</a>,
Next:<a rel=next href="#What%20do%20you%20need%20to%20run%20%3ccode%3eTVS%3c%2fcode%3e%3f">What do you need to run <code>TVS</code>?</a>,
Previous:<a rel=previous href="#Why%20do%20you%20need%20%3ccode%3eTVS%3c%2fcode%3e%3f">Why do you need <code>TVS</code>?</a>,
Up:<a rel=up href="#Introduction">Introduction</a>
<br>

<h2>What <code>TVS</code> can do?</h2>

<p><code>TVS</code> can store complete source codes of TeX documents. It parses
logs of TeX and finds files which were used to typeset the document. 
<code>TVS</code> can work in three levels:

<ul>
<li>Only document log is examined. It stores all macros, styles,
included documents etc. you need. 
<li>Document log and format log is examined. It also stores all
source files needed to build up format file. 
<li>(experimental) Moreover dvips log is parsed and used fonts are
stored. This is not so useful as only <code>.pk</code>
files may be obtained this way. 
</ul>

<p>Files collected by <code>TVS</code> can be used on any TeX installation to
build up exactly the same document. 
Next, let us call the product of <code>TVS</code> a <em>complete source</em>.

<p>There are several important features of <code>TVS</code>:

<ul>
<li><code>TVS</code> is a Perl script, it runs wherever Perl is available (it
means nearly everywhere). 
<li>There is no difference in using of <code>TVS</code> when running LaTeX,
plain, or whatever you want. 
<li>On the destination (the place you typeset the complete source), there is
no need to run <code>TVS</code>. You only need to say TeX to find files
in working directory first. 
<li><code>TVS</code> is <em>not</em> a version control system. It cannot handle
versions of your documents. There are other systems, e.g., <code>RCS</code> or
<code>CVS</code>, designed to do this. 
</ul>

<p><hr>
Node:<a name="What%20do%20you%20need%20to%20run%20%3ccode%3eTVS%3c%2fcode%3e%3f">What do you need to run <code>TVS</code>?</a>,
Previous:<a rel=previous href="#What%20%3ccode%3eTVS%3c%2fcode%3e%20can%20do%3f">What <code>TVS</code> can do?</a>,
Up:<a rel=up href="#Introduction">Introduction</a>
<br>

<h2>What do you need to run <code>TVS</code>?</h2>

<p>Hardware and OS requirements are simple. <code>TVS</code> is a Perl script so it
runs wherever Perl 5.x is available. 
It uses packages Getopt::Long, File::Basename, File::Copy, and
File::Path. These packages should be nevertheless in standard Perl
distribution.

<p>For information on Perl for your OS check
&lt;<code>http://www.perl.com</code>&gt;. There should be no problem on most Unices, in
Linux, Perl is usually a part of standard distribution.

<p>Maybe you find useful having also <code>make</code> and <code>Texinfo</code>
utilities installed on your system, but <code>Texinfo</code> is only needed to
produce documentation in DVI, PostScript, Info, or HTML formats which
are pregenerated in <code>TVS</code> distribution. And <code>make</code> is only to
generate them comfortably.

<p>There are some requirements for your TeX source codes to be able to
handle them successfully. There is a problem with including files into your
source. The usual and best way to do it is to have the main source at the
top of the source tree and use relative paths in all variants of
<code>\input</code> command. 
Avoid pathological inputs like
<code>\includegraphics ../../pictures/pict1.ps</code>. 
This should not bother you as nearly everybody does it.

<p>Usually <code>TVS</code> is able to pack files referenced by "up-going"
relative path (if it makes a conflict, <code>TVS</code>
recognizes it), but you run into difficulties when re-typesetting the
complete source and you have to correct all the things by hand.

<p><hr>
Node:<a name="Installation">Installation</a>,
Next:<a rel=next href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>,
Previous:<a rel=previous href="#Introduction">Introduction</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Installation</h1>

<p>The program <code>TVS</code> and its documentation is written and
maintained by David Antos&lt;, <a href="mailto:xantos (at) fi.muni.cz">xantos (at) fi.muni.cz</a>. (Of course substitute (at) with @.) 
Contact him when in trouble, but please read the documentation first.

<p>The following instructions assume that Perl version &gt;=5 is installed on
your system. For information on Perl consult &lt;<code>http://www.perl.org</code>&gt;.

<p>The homepage of <code>TVS</code> is &lt;<code>http://www.fi.muni.cz/~xantos/tvs</code>&gt;. 
Here you can get <code>TVS</code> either file-by-file or as <code>tvs.tar.gz</code>
file. <code>TVS</code> can also be obtained on CTAN in <code>support/TVS</code>.

<p>Because of platform independence we decided not to prepare any
"instant" packages.

<p>If you downloaded <code>tvs.tar.gz</code>, gunzip and un-tar it somewhere. If
you downloaded separate files, reconstruct the original file structure
anywhere you want.

<p>On UNIX, make a link to <code>tvs.pl</code> from a directory which is in your
<code>PATH</code>, e.g. <code>/usr/local/bin</code>, if your system decodes first
lines of scripts to run them. In this case, it may be needed to correct
the very first line of <code>tvs.pl</code> and put the right path to your Perl
interpreter there. Otherwise you may still run <code>TVS</code>
running <code>perl tvs.pl</code>. Install the documentation in your favorite
format, where your docs-reader can find it. At least,
<code>/usr/doc/tvs</code> wouldn't be a bad choice to store Post Script or
HTML documentation.

<p>Generally speaking, there is no need to install <code>TVS</code> to global
directories if you are the only-one who runs it or you are not root.

<p>Try <code>tvs --help</code>. If a TVS header and help message written,
everything is OK.

<p>If your standard Perl distribution does not contain packages
Getopt::Long, File::Basename, File::Copy, and File::Path, get them from
&lt;<code>http://www.perl.org</code>&gt;.

<p>On M$ DOS/Window$ platforms the <code>.pl</code> suffix should be enough for
Perl script to run, of course if Perl is correctly installed. Please do
not expect me to make better support for M$ platforms as I do not run
them.

<p>On other platforms, if there are difficulties in installing or running
<code>TVS</code>, please drop me a line.

<p><hr>
Node:<a name="Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>,
Next:<a rel=next href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>,
Previous:<a rel=previous href="#Installation">Installation</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Using <code>TVS</code> step by step</h1>

<p>This chapter shows the usage of <code>TVS</code> and various examples. It also
points out the limitations of this system, in other words what it
<em>can</em> do for you (and it's quite a lot) and what it cannot. Yes, there
are some unpleasant things you must do manually.

<ul>
<li><a href="#Useful%20commands">Useful commands</a>: 
<li><a href="#Basic%20running%20%3ccode%3eTVS%3c%2fcode%3e">Basic running <code>TVS</code></a>: 
<li><a href="#Ignoring%20files">Ignoring files</a>: 
<li><a href="#Format%20file%20sources">Format file sources</a>: 
<li><a href="#Configuration%20file">Configuration file</a>: 
<li><a href="#Limitations%20of%20%3ccode%3eTVS%3c%2fcode%3e">Limitations of <code>TVS</code></a>: 
<li><a href="#Fonts">Fonts</a>: 
<li><a href="#What%20to%20do%20with%20collected%20output">What to do with collected output</a>: 
</ul>

<p><hr>
Node:<a name="Useful%20commands">Useful commands</a>,
Next:<a rel=next href="#Basic%20running%20%3ccode%3eTVS%3c%2fcode%3e">Basic running <code>TVS</code></a>,
Previous:<a rel=previous href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Useful commands</h2>

<p>To make sure that <code>TVS</code> is correctly installed on your system, run
<code>tvs -h</code>. 
You should obtain a short help on using <code>TVS</code>.

<p>There are two useful switches you should know before starting experiments
with <code>TVS</code>. You may increase verbosity level using <code>-v</code> or even
<code>-vv</code> switch. See <a href="#Global%20switches">Global switches</a>, for detailed information
on verbosity levels.

<p>In following examples you may also specify <code>--dummy</code> command. It means
that no files are really copied and no real output is produced. But
everything else looks like real operations were performed.

<p><hr>
Node:<a name="Basic%20running%20%3ccode%3eTVS%3c%2fcode%3e">Basic running <code>TVS</code></a>,
Next:<a rel=next href="#Ignoring%20files">Ignoring files</a>,
Previous:<a rel=previous href="#Useful%20commands">Useful commands</a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Basic running <code>TVS</code></h2>

<p>Now it's time to look to the <code>examples</code> directory in your
distribution. It contains source file <code>sample.tex</code> we will use to
demonstrate the usage of <code>TVS</code>.

<p>The first step you must not forget is to TeX your source correctly. 
Document <code>sample.tex</code> uses <code>\tableofcontents</code>, so you must run
<pre>latex sample.tex
</pre>

<p>twice. Make sure your document is TeXed correctly. It is <em>very
very</em> important.

<p>Let's try what <code>TVS</code> can do now. First try to run
<pre>tvs sample.log
</pre>

<p>The most important for <code>TVS</code> is log file <code>sample.log</code>. You do not
have to specify name with <code>.log</code> extension as it is tried to add
automatically. 
What <code>TVS</code> now does? It goes through the file <code>sample.log</code>
and finds
all the files which are needed to build up the final document.

<p><code>TVS</code> created an output directory named <code>TVS-OUT</code>. Check its
contents. In fact, on M$-DOS or M$-Windows machines this didn't work. 
<a rel=footnote href="#fn-1"><sup>1</sup></a>
On UN*X machines, there is stupidly deep directory structure containing
only one directory in another.

<p>There is a way to avoid this. 
Please copy file <code>pathcuts.tvs</code> into the <code>examples</code> directory. 
Edit <code>pathcuts.tvs</code>, replace path <code>/usr/TeX/texmf</code> with the path
to your TeX main directory.

<p>Delete the <code>TVS-OUT</code> directory and run
<pre>tvs -v -p pathcuts.tvs sample
</pre>

<p>See what <code>TVS</code> does now. 
You may also check what is in the <code>TVS-OUT</code> directory. 
By <code>-p file</code> we say that <code>file</code> contains paths we want to shorten. 
On M$ file system, there is in fact needed to use this to
cut things like <code>c:\</code> to be able to construct file names used in the
output directory.

<p><hr>
Node:<a name="Ignoring%20files">Ignoring files</a>,
Next:<a rel=next href="#Format%20file%20sources">Format file sources</a>,
Previous:<a rel=previous href="#Basic%20running%20%3ccode%3eTVS%3c%2fcode%3e">Basic running <code>TVS</code></a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Ignoring files</h2>

<p>As you can see, there is <code>sample.toc</code> in the output directory. We do
not really need it as it can be always generated. Now let us show the way
how to ignore files. Please copy file <code>ignpats.tvs</code> to the working
directory. This file contains patterns which are compared to ends of
files. Matching files are not copied to the output directory.

<p>If you want to try it, delete the output directory and run
<pre>tvs -v -p pathcuts.tvs -i ignpats.tvs sample
</pre>

<p>Now files ending with <code>toc</code> are missing.

<p><em>Warning:</em> use this feature with care and only if you know what you
are doing. Always make sure that files you want to ignore may be rebuilt up
from the rest of the source.

<p><hr>
Node:<a name="Format%20file%20sources">Format file sources</a>,
Next:<a rel=next href="#Configuration%20file">Configuration file</a>,
Previous:<a rel=previous href="#Ignoring%20files">Ignoring files</a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Format file sources</h2>

<p>In fact, storing the complete document source may not be enough to be able
to produce the same output. We must also store format source files. Storing
only the format file itself doesn't help as this file is not
binary compatible in general.

<p>The main thing you need is to know where log files of generated formats
are stored. To obtain this information consult your local documentation, or
you may try to find files <code>latex.log, tex.log, pdftex.log</code>, or ask
your TeX administrator. It is also possible that your administrator
deleted log files after generating formats. In this case ask him to
regenerate format files and leave the logs untouched. 
This is not a good manner to delete log files of this importance. 
Your administrator may have even delete format file sources. In this case,
ask him to reinstall them and better find a new TeX administrator.

<p>You should make sure that formats were really generated on your local
installation. They may have been generated on a binary compatible
machine with other organization of TeX directories. If so, you must
re-generate them. If you run a distribution which allows you to set
local TeX installation root directory, this is quite possible. For
example, on my texlive-4 I had to correct this.

<p>In emergency, if you do not have root privilegies and you cannot
globally make format logs correct, you still can generate formats in
your own directory and use them overriding your system defaults. 
In this case, give your root my regards.

<p>To store format sources, you need to tell <code>TVS</code> where logs are. 
It is done by <code>-f path</code> switch. Let's try to call
<pre>tvs -v -p pathcuts.tvs -f where_your_logs_are sample
</pre>

<p>You should obtain output directory similar to previous one but containing
subdirectory named <code>FORMAT</code>, where complete source for format
generating is stored.

<p>If <code>TVS</code> is not able to determine format name correctly, you may
force format name by adding <code>--fmtname name</code> into command line
similar to previous example. You may try
<pre>tvs -v -p pathcuts.tvs -f where_your_logs_are --fmtname latex sample
</pre>

<p><hr>
Node:<a name="Configuration%20file">Configuration file</a>,
Next:<a rel=next href="#Limitations%20of%20%3ccode%3eTVS%3c%2fcode%3e">Limitations of <code>TVS</code></a>,
Previous:<a rel=previous href="#Format%20file%20sources">Format file sources</a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Configuration file</h2>

<p>The command lines we use are getting too long. If file <code>tvsrc</code> is
located in the working directory, it is used as config file. You may
also specify the config file explicitly by <code>-c filename</code> or
<code>--config filename</code> switch.

<p>Please copy file <code>tvsrc</code> to the <code>examples</code> directory. Config file
has simple structure
<pre>&lt;variable&gt; &lt;value&gt;
</pre>
Values set here may be always overridden by the command line. Setting
values for ignore, pathcuts and format doesn't mean that files are
ignored, paths cut and format sources stored by default. You must use
switches <code>-i, -p</code> and <code>-f</code>, but there is no need to follow
them by values. 
It may seem a bit strange but it is done this way in order to prevent
you from doing something you do not want to. It doesn't save your
keystrokes but--we hope--your nerves.

<p>If you edit the <code>format</code> entry in <code>tvsrc</code> to the path to your
format logs, you may for example use
<pre>tvs -i -p -f -v sample
</pre>

<p>to store the source with format with ignoring files and cutting paths
instead of the long form without config file which goes
<pre>tvs -i ignpats.tvs -p pathcuts.tvs -f /usr/TeX/texmf/web2c -v sample
</pre>

<p>But if you use only
<pre>tvs -p sample
</pre>

<p>then no format file is examined and no files are ignored, no matter that
the config file exists.

<p>In the config file you may also specify the default output
directory name with
<code>output</code> entry and the default verbosity level using
<code>verbose</code> with value 0, 1, or 2. These values are used always
and may be overridden with
<code>-o</code> and <code>-v</code>.

<p><hr>
Node:<a name="Limitations%20of%20%3ccode%3eTVS%3c%2fcode%3e">Limitations of <code>TVS</code></a>,
Next:<a rel=next href="#Fonts">Fonts</a>,
Previous:<a rel=previous href="#Configuration%20file">Configuration file</a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Limitations of <code>TVS</code></h2>

<p>Work of <code>TVS</code> is limited by the files which are noticed in log files. 
If you use anything which is done by external program, you must take
special care on files you want to store. If you include graphics in
Post Script, it may be included only by <code>\special</code> command and may not
be noticed in log.

<p>You must always ask yourself the main important question: <em>Which
files--not used in TeX last run--I want to store?</em>

<p>For example if you use a bibliography, your source is a <code>.bib</code>
file. But
in the last TeX run only sorted part of it, <code>.bbl</code> file is included. 
If the <code>.bbl</code> file is enough for you, it's good. 
But if you want to store
sources for bibliography completely, you need also <code>.bib</code> file and
<code>.bst</code> file, which contains bibliography style. And there is no way
for <code>TVS</code> to know it as BibTeX is an external utility. 
That's why you must copy them to <code>TVS-OUT</code> by hand.

<p>If you don't do so, you are still able to obtain exactly the same document,
but you run into difficulties trying to do any  modifications.

<p>It is always better store more than you need. If you are a TeX beginner
and you are absolutely not
sure, it may be reasonable for you to preserve all the files from your
working directory. Includes from TeX directory (e.g.,
<code>c:\tex\texmf</code>) are handled correctly.

<p><hr>
Node:<a name="Fonts">Fonts</a>,
Next:<a rel=next href="#What%20to%20do%20with%20collected%20output">What to do with collected output</a>,
Previous:<a rel=previous href="#Limitations%20of%20%3ccode%3eTVS%3c%2fcode%3e">Limitations of <code>TVS</code></a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>Fonts</h2>

<p>This is experimental!

<p>Usually there is no reason to store also font source files. The exception
is if your national modification of fonts changed its encoding or you use
unusual fonts.

<p>If you want to,
you may run <code>dvips</code> with <code>-d</code> switch to produce a log file with
list of opened files. 
Consult your <code>dvips</code> documentation how to do it. 
This switch is followed by number indicating what should be logged.

<p>If you use <code>tvs -d dvips.log</code>, a subdirectory FONTS is created
in the output
directory and all files used by dvips are stored there. 
Only font bitmaps may
be obtained this way, so this feature is not very useful. If you want to
store Metafont sources, you must do it by hand.

<p>There is no guarantee of correct work of <code>-d</code> switch as <code>dvips</code>
log changed.

<p><hr>
Node:<a name="What%20to%20do%20with%20collected%20output">What to do with collected output</a>,
Previous:<a rel=previous href="#Fonts">Fonts</a>,
Up:<a rel=up href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<br>

<h2>What to do with collected output</h2>

<p>Currently <code>TVS</code> implements no way of packing nor extracting collected
complete source. Use any way of packing this directory you like depending
of the platform you run <code>TVS</code> and the platform you will want to
re-typeset your work in the future.

<p>There is no way to run TVS on the destination. You must only tell TeX
<ul>
<li>to generate the format file if format sources were stored,
<li>to generate fonts if fonts were stored,
<li>to find files in working directory and its subdirectories at first. 
</ul>
To do this, consult the local documentation.

<p><hr>
Node:<a name="Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>,
Next:<a rel=next href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>,
Previous:<a rel=previous href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Reference guide to <code>TVS</code> commands</h1>

<p>This chapter describes overall structure of <code>TVS</code> commands and
describes the function of the commands in detail.

<ul>
<li><a href="#Invoking%20%3ccode%3eTVS%3c%2fcode%3e">Invoking <code>TVS</code></a>: 
<li><a href="#Global%20switches">Global switches</a>: 
<li><a href="#Ignoring%20files%20and%20cutting%20filenames">Ignoring files and cutting filenames</a>: 
<li><a href="#Output%20directory%20setting">Output directory setting</a>: 
<li><a href="#Storing%20format%20source%20files%20and%20fonts">Storing format source files and fonts</a>: 
</ul>

<p><hr>
Node:<a name="Invoking%20%3ccode%3eTVS%3c%2fcode%3e">Invoking <code>TVS</code></a>,
Next:<a rel=next href="#Global%20switches">Global switches</a>,
Previous:<a rel=previous href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>,
Up:<a rel=up href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>
<br>

<h2>Invoking <code>TVS</code></h2>

<p>General structure of calling <code>TVS</code> is
<pre>tvs [switches] filename
</pre>

<p>where <code>filename</code> is a name of the main TeX log file. 
<code>TVS</code> must be run in the directory where main TeX log file is
located.

<p>Always make sure
that your document is TeX-ed correctly (index is sorted, bibliography is
present, pictures are included etc.)! Usually you have to run TeX
several times to typeset the document (but we hope this doesn't
surprise you).

<p><hr>
Node:<a name="Global%20switches">Global switches</a>,
Next:<a rel=next href="#Ignoring%20files%20and%20cutting%20filenames">Ignoring files and cutting filenames</a>,
Previous:<a rel=previous href="#Invoking%20%3ccode%3eTVS%3c%2fcode%3e">Invoking <code>TVS</code></a>,
Up:<a rel=up href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>
<br>

<h2>Global switches</h2>

<p>These switches may be used to change globally behavior of <code>TVS</code>.

<dl>

<br><dt><code>-h, --help</code>
<dd>Prints short usage and version information and exits successfully. 
This switch doesn't need a filename as a parameter.

<br><dt><code>-v, --verbose</code>
<dd>Sets verbosity level. May used several times. There are three verbosity
levels:
<ul>
<li>Level 0--only examined files and errors are written. 
This is the default. 
<li>Level 1--found files, copying info and errors are written. 
<li>Level 2--extra talkative, writes all it does. 
</ul>
For level 1, use <code>-v</code> or <code>--verbose</code> once, for level 2, use it
twice. You may also specify <code>-vv</code>, which is the most comfortable way
to do it.

<br><dt><code>-c file, --config file</code>
<dd>Specifies the configuration file name. See <a href="#Config%20file">Config file</a>, for
details about configuration file.

<p>If <code>--config</code> switch is not specified, file <code>tvsrc</code> in working
directory is used as a config file if it exists. There is no need of having
config file as all options may be set from command line.

<br><dt><code>--dummy</code>
<dd>Sets <code>TVS</code> to dummy mode. No files are changed, no files are really
copied to output directory, it is only shown what has to be done. Useful if
used with <code>--verbose</code>. (Inspired by similar switch in cdrecord.) 
</dl>

<p><hr>
Node:<a name="Ignoring%20files%20and%20cutting%20filenames">Ignoring files and cutting filenames</a>,
Next:<a rel=next href="#Output%20directory%20setting">Output directory setting</a>,
Previous:<a rel=previous href="#Global%20switches">Global switches</a>,
Up:<a rel=up href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>
<br>

<h2>Ignoring files and cutting filenames</h2>

<p>Using following settings we may set files which shouldn't be copied to
output and set usual paths we don't want to store completely.

<dl>

<br><dt><code>-i [file], --ignore [file]</code>
<dd>Sets file with patterns of filenames which we don't want to be copied to
output. See <a href="#Ignore%20pattern%20file">Ignore pattern file</a>, for details about ignore pattern file.

<p>If <code>file</code> name is omitted, value from config file is used. If
<code>ignore</code> parameter is not set in config file, <code>TVS</code> terminates
with an error.

<br><dt><code>-p [file], --pathcuts [file]</code>
<dd>Sets file with path patterns to cut. See <a href="#Pathcuts%20pattern%20file">Pathcuts pattern file</a>,
for information about file
path names handling.

<p>If <code>file</code> name is not specified, value from config file is used. If
<code>pathcuts</code> parameter in config file is not specified,
<code>--pathcuts</code> parameter is silently ignored. It makes no harm to
function of <code>TVS</code> and if it causes filename conflict, <code>TVS</code> stops
with an error. 
</dl>

<p><hr>
Node:<a name="Output%20directory%20setting">Output directory setting</a>,
Next:<a rel=next href="#Storing%20format%20source%20files%20and%20fonts">Storing format source files and fonts</a>,
Previous:<a rel=previous href="#Ignoring%20files%20and%20cutting%20filenames">Ignoring files and cutting filenames</a>,
Up:<a rel=up href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>
<br>

<h2>Output directory setting</h2>

<dl>

<br><dt><code>-o dirname, --output dirname</code>
<dd>Sets the name of output directory to <code>dirname</code>. This may be only
useful to override setting in config file. If config file doesn't set
output directory name, default name <code>TVS-OUT</code> is used and this is
created in working directory. 
</dl>

<p><hr>
Node:<a name="Storing%20format%20source%20files%20and%20fonts">Storing format source files and fonts</a>,
Previous:<a rel=previous href="#Output%20directory%20setting">Output directory setting</a>,
Up:<a rel=up href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>
<br>

<h2>Storing format source files and fonts</h2>

<dl>

<br><dt><code>-f [dirname], --format [dirname]</code>
<dd>Specifies directory where format log files are and packs format file
sources. If <code>dirname</code> is
omitted, value from config file is taken. If <code>format</code> parameter is not
specified in config file, <code>TVS</code> dies with an error. See <a href="#Format%20file%20sources">Format file sources</a>, for
details about format source files extracting. 
Format file name is taken from the main document log from the first line
which contains <code>format=name</code>.

<br><dt><code>--fmtname [name]</code>
<dd>Specifies format name, e.g. <code>plain</code>, <code>latex</code>, etc. Useful, if
format name cannot be found in log of document in form
<code>format=name</code>. 
Specifying <code>--fmtname [name]</code> doesn't imply packing format sources. 
You must specify <code>--format</code>, too. 
This option cannot be specified in <code>TVS</code>'s
config file.

<br><dt><code>-d file, --dvips file</code>
<dd>Sets name of <code>dvips</code> log file. This cannot be specified in config
file. This is only experimental. See <a href="#Fonts">Fonts</a>, for information on dvips
log file
examining and font storing. You would better not to use this feature unless
you know what you are doing. 
</dl>

<p><hr>
Node:<a name="Config%20file%20and%20pattern%20files">Config file and pattern files</a>,
Next:<a rel=next href="#Credits">Credits</a>,
Previous:<a rel=previous href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Config file and pattern files</h1>

<p>In this chapter we discuss config file setting and structure and usage of
files with patterns. These are used to shorten (cut) filenames to use
reasonable short paths in output directory and to set files which we do not
want to store at all.

<ul>
<li><a href="#Config%20file">Config file</a>: 
<li><a href="#Pattern%20file%20structure">Pattern file structure</a>: 
</ul>

<p><hr>
Node:<a name="Config%20file">Config file</a>,
Next:<a rel=next href="#Pattern%20file%20structure">Pattern file structure</a>,
Previous:<a rel=previous href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>,
Up:<a rel=up href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>
<br>

<h2>Config file</h2>

<p>We may set values for <code>verbose, format, ignore, pathcuts,</code> and
<code>output</code> variables in config file.

<p>If <code>TVS</code> is run with <code>--config</code> switch, it sets used config file
name. If this is not used, default config file named <code>tvsrc</code> in
working directory is tried. 
If it doesn't exist, no config file is used at all. 
There is no default config file location (e.g. 
<code>/etc/tvsrc</code> or something similar) because of the platform independence
of <code>TVS</code>.

<p>The structure of config file is quite simple. Everything after <code>#</code> and
<code>%</code> characters is ignored. Lines with structure
<pre>&lt;variable&gt; &lt;value&gt;
</pre>

<p>set values of variables. There must be just one white character between
the <code>&lt;variable&gt;</code> and the <code>&lt;value&gt;</code>. There may be any count of
white spaces before and after this structure on the line. Lines with
other structure or specifying variables not listed below are silently
ignored.

<p>For example of config file, see file <code>tvsrc</code> enclosed with the
distribution.

<p>Variables have meanings as follows:

<dl>

<br><dt><code>verbose</code>
<dd>Sets the default verbosity level. Reasonable values are
<dl>
<dt><code>0</code>
<dd>This is the default. 
<br><dt><code>1, 2</code>
<dd>Set verbosity level to 1 or 2. See <a href="#Global%20switches">Global switches</a>, for description
of verbosity levels. 
</dl>

<br><dt><code>format</code>
<dd>Sets the name of the directory where format log files are stored. This is
used only of <code>--format</code> or <code>-f</code> switch is set and may be
overridden by this. You should specify <code>format</code> parameter in config
file if you want to store format sources. And you should store format
sources. Simply--use it.

<br><dt><code>ignore</code>
<dd>Sets the name of file with patterns used to ignore files. See <a href="#Ignore%20pattern%20file">Ignore pattern file</a>, for
information about ignoring files. 
This is used only if <code>--ignore</code> or <code>-i</code> switch is set and may be
overridden by this.

<br><dt><code>pathcuts</code>
<dd>Sets the name of file with patterns used to shorten the stored filenames. 
Used only if <code>--pathcuts</code> or <code>-p</code> switch is set and may be
overridden by these.

<br><dt><code>output</code>
<dd>Sets the default output directory name. May be overridden by <code>--output</code>
or <code>-o</code> switch. If not set, default value <code>TVS-OUT</code> is used. 
</dl>

<p><hr>
Node:<a name="Pattern%20file%20structure">Pattern file structure</a>,
Previous:<a rel=previous href="#Config%20file">Config file</a>,
Up:<a rel=up href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>
<br>

<h2>Pattern file structure</h2>

<p>The structure of files which contain patterns is quite simple. Everything
after <code>#</code> or <code>%</code> characters is ignored. A line of the file may
start and end with white characters. These white characters are ignored. 
The remaining part of the line (if it is nonempty) is considered to be a
pattern.

<p>A pattern is treated as a Perl regular expression. 
It doesn't matter if you don't know what it is, all you need to know is
seen from the examples. Nevertheless you may try <code>man perlre</code> or
equivalent for reading documentation on you system.

<p>Next, we'll discuss the usage of pattern files.

<ul>
<li><a href="#Pathcuts%20pattern%20file">Pathcuts pattern file</a>: 
<li><a href="#Ignore%20pattern%20file">Ignore pattern file</a>: 
</ul>

<p><hr>
Node:<a name="Pathcuts%20pattern%20file">Pathcuts pattern file</a>,
Next:<a rel=next href="#Ignore%20pattern%20file">Ignore pattern file</a>,
Previous:<a rel=previous href="#Pattern%20file%20structure">Pattern file structure</a>,
Up:<a rel=up href="#Pattern%20file%20structure">Pattern file structure</a>
<br>

<h3>Pathcuts pattern file</h3>

<p>This file is used if <code>--pathcuts</code> or <code>-p</code> switch is specified. 
An example is enclosed with the distribution and named <code>pathcuts.tvs</code>.

<p>The file specifies list of patterns which are compared to the
<em>beginnings</em> of
filenames. On <em>first match</em> the matching part is cut
and the rest of pattern
list is not used. So it has no sense to have a pattern list
<pre>/usr/TeX
/usr/TeX/texmf
</pre>

<p>as the second entry will be never used. 
But sequence
<pre>/usr/TeX/texmf
/usr/TeX
</pre>

<p>may be reasonable. (It's an exercise why and when <code>:-)</code>.)

<p>An example: Let us have pattern list containing <code>/usr/TeX/texmf</code>. If
filename is
<pre></pre>

<p>it matches and is cut to
<pre>tex/latex/algorith/algorithm.sty
</pre>

<p>File <code>inputs/my_macro.tex</code> doesn't match the pattern and is
left untouched.

<p><hr>
Node:<a name="Ignore%20pattern%20file">Ignore pattern file</a>,
Previous:<a rel=previous href="#Pathcuts%20pattern%20file">Pathcuts pattern file</a>,
Up:<a rel=up href="#Pattern%20file%20structure">Pattern file structure</a>
<br>

<h3>Ignore pattern file</h3>

<p>This file is used when <code>--ignore</code> or <code>-i</code> switch is specified. An
example named <code>ignpats.tvs</code> is enclosed.

<p>This file specifies list of patterns which are compared to <em>ends</em>
of filenames. If <em>any</em> of them matches, file is ignored and is not
copied to output. Usually, suffices of files (e.g. <code>toc, bbl</code>) are
used here. If you want make sure that there is a dot before <code>toc</code>
or <code>bbl</code>, use <code>\.toc</code> and <code>\.bbl</code> entries in pattern file
as entries are PERL regular expressions. For detailed information see
<code>perlre(1)</code>.

<p>Use this feature with care, it is usually better to have a superset of
needed complete source then have <em>incomplete</em> source. There may be
files which loaded (and you don't know about them) with suffices you
don't expect. Use it only if you know what you are doing. You've been
warned.

<p><hr>
Node:<a name="Credits">Credits</a>,
Next:<a rel=next href="#Dealing%20with%20bugs%20in%20%3ccode%3eTVS%3c%2fcode%3e">Dealing with bugs in <code>TVS</code></a>,
Previous:<a rel=previous href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Credits</h1>

<p>I would like to thank to:
<ul>
<li>Petr Sojka, who made me to write <code>TVS</code> and helped me very much with
all the troubles and decisions we have had to make,
<li>Richard Bot&acute;ik, who lent me the
"Perl Camel Book" for a fortnight,
<li>many others,
<li>Bubo, my home computer, as it surprisingly didn't get overheated too much
during the terribly hot spring of year 2000 in middle Europe. 
</ul>

<p><hr>
Node:<a name="Dealing%20with%20bugs%20in%20%3ccode%3eTVS%3c%2fcode%3e">Dealing with bugs in <code>TVS</code></a>,
Previous:<a rel=previous href="#Credits">Credits</a>,
Up:<a rel=up href="#Top">Top</a>
<br>

<h1>Dealing with bugs in <code>TVS</code></h1>

<p>Please send bug-reports to <a href="mailto:xantos (at) fi.muni.cz">xantos (at) fi.muni.cz</a> with subject
<code>TVS bug</code>. Add information on platform, TeX installation and
include log files which were parsed. Also please note version of TVS,
both version number and CVS version code (it's the line containing
<code>$Id: tvs.pl,v...</code>). You can get this information by running
<code>tvs --help</code>.

<p>If you tried to compare <code>.dvi</code> files obtained running TeX on
various platforms using <code>TVS</code> complete source, please keep in mind
they may differ if something depending on "the state of the computer"
(especially date) was included.


<h1>Table of Contents</h1>
<ul>
<li><a href="#Top">TeX Versioning System</a>
<li><a href="#Copying">Copying</a>
<li><a href="#Introduction">Introduction</a>
<ul>
<li><a href="#Why%20do%20you%20need%20%3ccode%3eTVS%3c%2fcode%3e%3f">Why do you need <code>TVS</code>?</a>
<li><a href="#What%20%3ccode%3eTVS%3c%2fcode%3e%20can%20do%3f">What <code>TVS</code> can do?</a>
<li><a href="#What%20do%20you%20need%20to%20run%20%3ccode%3eTVS%3c%2fcode%3e%3f">What do you need to run <code>TVS</code>?</a>
</ul>
<li><a href="#Installation">Installation</a>
<li><a href="#Using%20%3ccode%3eTVS%3c%2fcode%3e%20step%20by%20step">Using <code>TVS</code> step by step</a>
<ul>
<li><a href="#Useful%20commands">Useful commands</a>
<li><a href="#Basic%20running%20%3ccode%3eTVS%3c%2fcode%3e">Basic running <code>TVS</code></a>
<li><a href="#Ignoring%20files">Ignoring files</a>
<li><a href="#Format%20file%20sources">Format file sources</a>
<li><a href="#Configuration%20file">Configuration file</a>
<li><a href="#Limitations%20of%20%3ccode%3eTVS%3c%2fcode%3e">Limitations of <code>TVS</code></a>
<li><a href="#Fonts">Fonts</a>
<li><a href="#What%20to%20do%20with%20collected%20output">What to do with collected output</a>
</ul>
<li><a href="#Reference%20guide%20to%20%3ccode%3eTVS%3c%2fcode%3e%20commands">Reference guide to <code>TVS</code> commands</a>
<ul>
<li><a href="#Invoking%20%3ccode%3eTVS%3c%2fcode%3e">Invoking <code>TVS</code></a>
<li><a href="#Global%20switches">Global switches</a>
<li><a href="#Ignoring%20files%20and%20cutting%20filenames">Ignoring files and cutting filenames</a>
<li><a href="#Output%20directory%20setting">Output directory setting</a>
<li><a href="#Storing%20format%20source%20files%20and%20fonts">Storing format source files and fonts</a>
</ul>
<li><a href="#Config%20file%20and%20pattern%20files">Config file and pattern files</a>
<ul>
<li><a href="#Config%20file">Config file</a>
<li><a href="#Pattern%20file%20structure">Pattern file structure</a>
<ul>
<li><a href="#Pathcuts%20pattern%20file">Pathcuts pattern file</a>
<li><a href="#Ignore%20pattern%20file">Ignore pattern file</a>
</ul>
</ul>
<li><a href="#Credits">Credits</a>
<li><a href="#Dealing%20with%20bugs%20in%20%3ccode%3eTVS%3c%2fcode%3e">Dealing with bugs in <code>TVS</code></a>
</ul>

<hr><h4>Footnotes</h4>
<ol type="1">
<li><a name="fn-1"></a>
<p>Do not install Linux immediately, we will correct it in the
next paragraph. <code>;-)</code></p>

</ol><hr>

</body></html>