"Fossies" - the Fresh Open Source Software Archive
Member "SAOImageDS9/tcllib/README" (13 Nov 2019, 3742 Bytes) of package /linux/misc/ds9.8.1.tar.gz:
As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard
) with prefixed line numbers.
Alternatively you can here view
the uninterpreted source code file.
1 RCS: @(#) $Id: README,v 1.9 2007/08/30 17:24:13 andreas_kupries Exp $
3 Welcome to the Tcllib, the Tcl Standard Library. This package is
4 intended to be a collection of Tcl packages that provide utility
5 functions useful to a large collection of Tcl programmers.
7 The home web site for this code is http://core.tcl.tk/tcllib/ .
8 At this web site, you will find mailing lists, web forums, databases
9 for bug reports and feature requests, the CVS repository (browsable on
10 the web, or read-only accessible via CVS ), and more.
12 The structure of the tcllib source hierarchy is:
15 +- modules
16 +- <module1>
17 +- <module2>
18 +- ...
21 The install hierarchy is:
24 +- <module1>
25 +- <module2>
26 +- ...
28 There are some base requirements that a module must meet before it
29 will be added to tcllib:
31 * the module must be a proper Tcl package
32 * the module must use a namespace for its commands and variables
33 * the name of the package must be the same as the name of the
35 * the module must reside in a subdirectory of the modules directory in
36 the source hierarchy, and that subdirectory must have the same name
37 as the package and namespace
38 * the module must be released under the BSD License, the terms of
39 which can be found in the toplevel tcllib source directory in the file
41 * the module should have both documentation ([*]) and a test suite
42 (in the form of a group of *.test files in the module directory).
44 [*] Possible forms: doctools, TMML/XML, nroff (man), or HTML.
45 The first format is the most preferred as it can be processed with
46 tools provided by tcllib itself (See module doctools). The first
47 two are preferred in general as they are semantic markup and thus
48 easier to convert into other formats.
50 * the module must have either documentation or a test suite. It can
51 not have neither.
52 * the module should adhere to Tcl coding standards
54 When adding a module to tcllib, be sure to add it to the files listed below.
56 * installed_modules.tcl
58 contains a table listing all modules to be installed, modules
59 excluded, and names the actions to be taken during installation
60 of each module. Add a line to this table naming your module and
61 its actions.
63 Three actions have to be specified, for the package itself, its
64 documentation, and the examples demonstrating it.
66 The _null action can be used everywhere and signals that there is
67 nothing to do. Although it is possible to use it for the package
68 action it does make no sense there, as that means that no package
69 code is installed.
71 Other package actions are _tcl, _tci, and _text. The first causes
72 the installer to copy all .tcl files from the source directory for
73 the module into the appropriate module directory. _tci does all that
74 and also expects a tclIndex file to copy. _tex is like _tcl, however
75 it also copies all .tex files found in the source directory for the
78 There is currently only one true documentation action. This action
79 is _doc. It converts all documentation in doctools format into the
80 format chosen by the user for installation and copies the result
81 into the appropriate directory.
83 There is currently one true action for examples, _exa. It copies all
84 files in the source directory for examples into the directory chosen
85 by the user as destination for examples.
87 Each module source directory should have no subdirectories (other than
88 the CVS directory), and should contain the following files:
90 * source code *.tcl
91 * package index pkgIndex.tcl
92 * tests *.test
93 * documentation *.man, *.n, *.xml
95 If you do not follow this directory structure, the tcllib Makefile
96 will fail to locate the files from the new module.