summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tools/README
blob: 791bf7981547e2db28deeeea3739b16f683f3cf7 (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
% \iffalse meta-comment
%
% Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
% 2006 2008 2009
% The LaTeX3 Project and any individual authors listed elsewhere
% in this file.
%
% This file is part of the Standard LaTeX `Tools Bundle'.
% -------------------------------------------------------
%
% It 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.
% 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.
%
% The list of all files belonging to the LaTeX `Tools Bundle' is
% given in the file `manifest.txt'.
%
% \fi

README for the `tools' bundle  (December 1999)
=============================

This `bundle' consists of LaTeX2e packages written and supported by
members of the LaTeX3 Project Team.

The documented source code of each package is in a file with extension
`.dtx'.  Running LaTeX on the file tools.ins will produce all the
package files, and some associated files.

So you should first process tools.ins:

  latex tools.ins

The files with extensions `.sty' and `.tex' (including a file whose
name is just `.tex') should then be moved to a directory on LaTeX's
standard input path.

See the Note at the end of this file if you have problems processing
the tools.ins file.

Documentation for the individual packages may then be obtained by
running LaTeX on the `.dtx' files.

For example:

  latex array.dtx

will produce the file array.dvi, documenting the array package.


The file manifest.txt contains a list of the main files in the
distribution together with a one-or-two line summary of each package.


Copyright
=========
Copyright is maintained on each of these packages by the author(s)
of the package.


Distribution Conditions
=======================

All the files in this bundle may be distributed under the conditions
of the LaTeX Project Public License, either version 1.1 of this
license or (at your option) any later version.  The latest version of
this license is in
   http://www.latex-project.org/lppl.txt
and version 1.1 or later is part of all distributions of LaTeX
version 1999/06/01 or later.

The list of all files belonging to the `Tools Bundle' is
given in the file `manifest.txt'.

Commercial users of the multicol package are asked to read the
notice at the head of the file multicol.dtx.

The use of these files is otherwise unrestricted.


Reporting Bugs
==============

If you wish to report a problem or bug in any of these packages, use
the latexbug.tex program that comes with the standard LaTeX
distribution.  Please ensure that you enter `tools' category when
prompted with a menu of categories, so that the message will be
automatically forwarded to the appropriate part of our database.

When reporting bugs, please produce a small test file that shows the
problem, and ensure that you are using the current version of the
package, and of the base LaTeX software.


NOTE (docstrip version)
=======================

If   latex tools.ins
produces the `docstrip interactive mode' prompt:

  * First type the extension of your input file(s):  *
  \infileext=

Then your version of docstrip is too old.
Quit (eg by hitting `enter' to all questions) and get a newer
docstrip.tex. It must be at least version 2.4.

A suitable docstrip.tex may be found from `CTAN' archives such as
ftp.dante.de   tex-archive/macros/latex/unpacked/docstrip.tex

Docstrip is part of the base LaTeX distribution, so if you have
an old docstrip then your LaTeX is out of date and you may consider
getting the whole of that directory and re-installing LaTeX.
However you need to fetch only the file docstrip.tex to unpack
this tools distribution with your existing format.