guess we don't want the build dir
[latex2e.git] / trunk / required / tools / README.txt
blobbb363378c3858ec840832ccd62895281e12d6cb5
3 % Copyright 1993-2017
4 % The LaTeX3 Project and any individual authors listed elsewhere
5 % in this file. 
6
7 % This file is part of the Standard LaTeX `Tools Bundle'.
8 % -------------------------------------------------------
9
10 % It may be distributed and/or modified under the
11 % conditions of the LaTeX Project Public License, either version 1.3c
12 % of this license or (at your option) any later version.
13 % The latest version of this license is in
14 %    http://www.latex-project.org/lppl.txt
15 % and version 1.3c or later is part of all distributions of LaTeX 
16 % version 2005/12/01 or later.
17
18 % The list of all files belonging to the LaTeX `Tools Bundle' is
19 % given in the file `manifest.txt'.
20
23 README for the `tools' bundle
24 =============================
26 This `bundle' consists of LaTeX2e packages written and supported by
27 members of the LaTeX3 Project Team.
29 The documented source code of each package is in a file with extension
30 `.dtx'.  Running LaTeX on the file tools.ins will produce all the
31 package files, and some associated files.
33 So you should first process tools.ins:
35   latex tools.ins
37 The files with extensions `.sty' and `.tex' (including a file whose
38 name is just `.tex') should then be moved to a directory on LaTeX's
39 standard input path.
41 See the Note at the end of this file if you have problems processing
42 the tools.ins file.
44 Documentation for the individual packages may then be obtained by
45 running LaTeX on the `.dtx' files.
47 For example:
49   latex array.dtx
51 will produce the file array.dvi, documenting the array package.
54 The file manifest.txt contains a list of the main files in the
55 distribution together with a one-or-two line summary of each package.
58 Copyright
59 =========
60 Copyright is maintained on each of these packages by the author(s)
61 of the package. 
64 Distribution Conditions
65 =======================
67 All the files in this bundle may be distributed under the conditions
68 of the LaTeX Project Public License, either version 1.1 of this
69 license or (at your option) any later version.  The latest version of
70 this license is in
71    http://www.latex-project.org/lppl.txt
72 and version 1.1 or later is part of all distributions of LaTeX 
73 version 1999/06/01 or later.
75 The list of all files belonging to the `Tools Bundle' is
76 given in the file `manifest.txt'.
78 Commercial users of the multicol package are asked to read the
79 notice at the head of the file multicol.dtx.
81 The use of these files is otherwise unrestricted.
84 Reporting Bugs
85 ==============
87 If you wish to report a problem or bug in any of these packages, use
88 the latexbug.tex program that comes with the standard LaTeX
89 distribution.  Please ensure that you enter `tools' category when
90 prompted with a menu of categories, so that the message will be
91 automatically forwarded to the appropriate part of our database.
93 When reporting bugs, please produce a small test file that shows the
94 problem, and ensure that you are using the current version of the
95 package, and of the base LaTeX software.