Index: README.md ================================================================== --- README.md +++ README.md @@ -32,10 +32,12 @@ Another location to find these sources at is the [github mirror](https://github.com/tcltk/tcllib). Please note the :warning: at the top. -# More reading +# Guides To Tcllib -Note that depending on your role with regard to Tcllib (developer, -release manager, installer) we have additional README documents -available with more information specific to that role. + * Guide to Kind Communication + * [License](embedded/www/tcllib/files/devdoc/tcllib_license.html) + * [How To Get The Sources](embedded/www/tcllib/files/devdoc/tcllib_sources.html) + * [How To Build And Install Tcllib](embedded/www/tcllib/files/devdoc/tcllib_installer.html) + * The Developer's Guide ADDED devdoc/parts/b_critcl.inc Index: devdoc/parts/b_critcl.inc ================================================================== --- /dev/null +++ devdoc/parts/b_critcl.inc @@ -0,0 +1,24 @@ +[subsection {Critcl & Accelerators}] + +[para] A number of packages come with [term accelerators], i.e. +[syscmd critcl]-based C code whose use will boost the performance of +the packages using them. As these accelerators are optional they are +not installed by default. + +[para] To build the accelerators the normally optional dependency on +[syscmd critcl] becomes required. + +[para] To install Tcllib with the accelerators run + +[example { + ./configure + make critcl # This builds the shared library holding the accelerators + make install +}] + +[para] The underlying tool is [file sak.tcl] in the toplevel directory +of Tcllib and the command [cmd {make critcl}] is just a wrapper around + +[example { + ./sak.tcl critcl +}] ADDED devdoc/parts/b_unix.inc Index: devdoc/parts/b_unix.inc ================================================================== --- /dev/null +++ devdoc/parts/b_unix.inc @@ -0,0 +1,38 @@ +[subsection Unix] + +This section describes the actions required to install Tcllib on Unix +systems (Linux, BSD, and related, including OS X). + +If you have to install Tcllib on a Windows machine instead then see +section [sectref Windows]. + +[para] Tcllib comes with a standard TEA buildsystem using a +[syscmd configure] script and a [file Makefile] generated by it. + +[para] To install Tcllib simply run + +[example { + ./configure + make install +}] + +in the toplevel directory of Tcllib itself. To build in a directory D +outside of Tcllib's toplevel directory simply make D the current +working directory and invoke [syscmd configure] with either its +absolute path or a proper relative path. + +[para] The above will non-interactively install all packages, +applications found in Tcllib, and their manpages, in directories +derived from what [syscmd configure] found out about the system. + +[para] The underlying tool is [file installer.tcl] in the toplevel +directory of Tcllib. + +[para] Invoking this tool via + +[example { + ./installer.tcl -help +}] + +will provide a short list of the available options. For more examples +see the various [term install] targets found in [file Makefile.in]. ADDED devdoc/parts/b_windows.inc Index: devdoc/parts/b_windows.inc ================================================================== --- /dev/null +++ devdoc/parts/b_windows.inc @@ -0,0 +1,36 @@ +[subsection Windows] + +This section describes the actions required to install Tcllib on Windows(tm) +systems. + +If you have to install Tcllib on a Unix machine (Linux, BSD, and +related, including OS X) instead then see section [sectref Unix]. + +[para] If the build environment is based on [term MSYS], +[term cygwin], or a similar emulation of a unix environment, then +[sectref Unix] still applies and should be used. + +[para] Alternatively, as mentioned in the previous section, the tool +underneath of the unix buildsystem is the [term Tcl]-based +[file installer.tcl] script. + +[para] Invoking this tool from a DOS shell via + +[example { + /path/to/tclsh ./installer.tcl -help +}] + +will provide a short list of the available options. For more examples +see the various [term install] targets found in [file Makefile.in]. + +Invoking this tool without any arguments, i.e. like + +[example { + /path/to/tclsh ./installer.tcl +}] + +will start a non-interactive installation showing its progress in a +Tk-based graphical interface. The directories to install the packages, +applications, etc. into are derived from the location of the +[syscmd tclsh] used to invoke the script, and where it expects +packages. ADDED devdoc/parts/rq_critcl.inc Index: devdoc/parts/rq_critcl.inc ================================================================== --- /dev/null +++ devdoc/parts/rq_critcl.inc @@ -0,0 +1,28 @@ + +[subsection CriTcl] + +The [syscmd critcl] tool is an [strong optional] dependency. + +[para] It is only required when trying to build the C-based +[term accelerators] for a number of packages, as explained in +[sectref {Critcl & Accelerators}] + +[para] Tcllib's build system accepts it as an application found in the +PATH (be it starkit or starpack). + +[para] Tcllib requires version 2 or higher. + +[para] The github repository providing releases of version 2 and +higher, and the associated sources, can be found at +[uri http://andreas-kupries.github.com/critcl]. + +[para] Any branch of the repository can be used (if not using the +prebuild starkit or starpack), although the use of the stable branch +[emph master] is recommended. + +[para] At the above url is also an explanation on how to build and +install CriTcl, including a list of its dependencies. + +[para] Its instructions will not be repeated here. If there are +problems with their directions please file a ticket against the +[term Critcl] project, and not Tcllib. ADDED devdoc/parts/rq_tcl.inc Index: devdoc/parts/rq_tcl.inc ================================================================== --- /dev/null +++ devdoc/parts/rq_tcl.inc @@ -0,0 +1,46 @@ + +[subsection Tcl] + +As we are installing a number of Tcl packages and applications it +should be pretty much obvious that a working installation of Tcl +itself is needed, and I will not belabor the point. + +[para] Out of the many possibilites use whatever you are comfortable +with, as long as it provides Tcl 8.2, or higher. + +This may be a Tcl installation provided by your operating system +distribution, from a distribution-independent vendor, or built by +yourself. + +[para] [strong Note] that the packages in Tcllib have begun to require +8.4, 8.5, and even 8.6. Older versions of Tcl will not be able to use +such packages. Trying to use them will result in +[strong {package not found}] errors, as their package index files will +not register them in versions of the core unable to use them. + +[para] Myself, I used (and still use) +[uri http://www.activestate.com ActiveState's] +ActiveTcl 8.5 distribution during development, as I am most familiar +with it. + +[para] [emph {(Disclosure: I, Andreas Kupries, worked for ActiveState until 2016, maintaining ActiveTcl and TclDevKit for them).}]. +I am currently working for SUSE Software Canada ULC, although not in +Tcl-related areas. + +[para] This distribution can be found at +[uri http://www.activestate.com/activetcl]. Retrieve the archive of +ActiveTcl 8.5 (or higher) for your platform and install it as directed +by ActiveState. + +[para] For those wishing to build and install Tcl on their own, the +relevant sources can be found at + +[list_begin definitions] +[def Tcl] [uri http://core.tcl-lang.org/tcl/] +[list_end] + +together with the necessary instructions on how to build it. + +[para] If there are problems with building, installing, or using Tcl +please file a ticket against [term Tcl], or the vendor of your +distribution, and [strong not] [term Tcllib]. ADDED devdoc/parts/welcome.inc Index: devdoc/parts/welcome.inc ================================================================== --- /dev/null +++ devdoc/parts/welcome.inc @@ -0,0 +1,6 @@ + +Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) [term Tcl] +packages that provide utility functions useful to a large collection +of Tcl programmers. + ADDED devdoc/tcllib_installer.man Index: devdoc/tcllib_installer.man ================================================================== --- /dev/null +++ devdoc/tcllib_installer.man @@ -0,0 +1,60 @@ +[comment {-*- tcl -*- doctools manpage}] +[manpage_begin tcllib_install_guide n 1] +[titledesc {Tcllib - The Installer's Guide}] +[description] +[include parts/welcome.inc] + +[para] + +The audience of this document is anyone wishing to build the packages, +for either themselves, or others. + +[para] + +For a developer intending to extend or modify the packages we +additionally provide + +[list_begin enum] +[enum] [term {Tcllib - The Developer's Guide}]. +[list_end] + +[para] + +Please read [term {Tcllib - How To Get The Sources}] first, if that +was not done already. Here we assume that the sources are already +available in a directory of your choice. + +[para] + +[comment {===================================================================}] +[section Requisites] + +Before Tcllib can be build and used a number of requisites must be installed. + +These are: + +[list_begin enumerated] +[enum] The scripting language Tcl. + For details see [sectref Tcl]. +[enum] Optionally, the [package critcl] package (C embedding) for [syscmd Tcl]. + For details see [sectref CriTcl]. +[list_end] + +This list assumes that the machine where Tcllib is to be installed is +essentially clean. Of course, if parts of the dependencies listed +below are already installed the associated steps can be skipped. It is +still recommended to read their sections though, to validate that the +dependencies they talk about are indeed installed. + +[include parts/rq_tcl.inc] +[include parts/rq_critcl.inc] + +[comment {= build instructions ==============================================}] +[section {Build & Installation Instructions}] + +[include parts/b_unix.inc] +[include parts/b_windows.inc] +[include parts/b_critcl.inc] + +[manpage_end] + ADDED devdoc/tcllib_license.man Index: devdoc/tcllib_license.man ================================================================== --- /dev/null +++ devdoc/tcllib_license.man @@ -0,0 +1,61 @@ +[comment {-*- tcl -*- doctools manpage}] +[manpage_begin tcllib_license n 1] +[titledesc {Tcllib - License}] +[description] +[include parts/welcome.inc] + +[para] The collection is under the BSD license. + +[section License] + +[para] + +This software is copyrighted by Ajuba Solutions and other parties. +The following terms apply to all files associated with the software +unless explicitly disclaimed in individual files. + +[para] + +The authors hereby grant permission to use, copy, modify, distribute, +and license this software and its documentation for any purpose, +provided that existing copyright notices are retained in all copies +and that this notice is included verbatim in any distributions. No +written agreement, license, or royalty fee is required for any of the +authorized uses. Modifications to this software may be copyrighted by +their authors and need not follow the licensing terms described here, +provided that the new terms are clearly indicated on the first page of +each file where they apply. + +[para] + +IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY +FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY +DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +[para] + +THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND +THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE +MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. + +[para] + +GOVERNMENT USE: If you are acquiring this software on behalf of the +U.S. government, the Government shall have only "Restricted Rights" in +the software and related documentation as defined in the Federal +Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you +are acquiring the software on behalf of the Department of Defense, the +software shall be classified as "Commercial Computer Software" and the +Government shall have only "Restricted Rights" as defined in Clause +252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the +authors grant the U.S. Government and others acting in its behalf +permission to use and distribute the software in accordance with the +terms specified in this license. + +[manpage_end] + ADDED devdoc/tcllib_sources.man Index: devdoc/tcllib_sources.man ================================================================== --- /dev/null +++ devdoc/tcllib_sources.man @@ -0,0 +1,69 @@ +[comment {-*- tcl -*- doctools manpage}] +[manpage_begin tcllib_sources n 1] +[titledesc {Tcllib - How To Get The Sources}] +[description] +[include parts/welcome.inc] + +[para] + +The audience of this document is anyone wishing to either have just a +look at Tcllib's source code, or build the packages, or to extend and +modify them. + +[para] For builders and developers we additionally provide + +[list_begin enum] +[enum] [term {Tcllib - The Installer's Guide}]. +[enum] [term {Tcllib - The Developer's Guide}]. +[list_end] + +respectively. + +[section {Source Location}] + +The official repository for Tcllib can be found at +[uri http://core.tcl-lang.org/tcllib] + +[section Retrieval] + +Assuming that you simply wish to look at the sources, or build a +specific revision, the easiest way of retrieving it is to: + +[list_begin enum] +[enum] Log into this site, as "anonymous", using the semi-random password in the captcha. +[enum] Go to the "Timeline". +[enum] Choose the revision you wish to have and +[enum] follow its link to its detailed information page. +[enum] On that page, choose either the "ZIP" or "Tarball" link to get +a copy of this revision in the format of your choice. +[list_end] + +[section {Source Code Management}] + +For the curious (or a developer-to-be), the sources are managed by the +[uri http://www.fossil-scm.org {Fossil SCM}]. + +Binaries for popular platforms can be found directly at its +[uri http://www.fossil-scm.org/download.html {download page}]. + +[para] + +With that tool available the full history can be retrieved via: + +[example { + fossil clone \ + http://core.tcl-lang.org/tcllib \ + tcllib.fossil +}] + +followed by + +[example { + mkdir tcllib + cd tcllib + fossil open ../tcllib.fossil +}] + +to get a checkout of the head of the trunk. + +[manpage_end] DELETED embedded/index.html Index: embedded/index.html ================================================================== --- embedded/index.html +++ /dev/null @@ -1,75 +0,0 @@ -
Tcllib has two mailing lists, -one for notifications, the other for general discussion. These are managed at SourceForge, -at the aforementioned link. A few direct links for various topics: -
tcllib-bugs: | -Subscribe | -Archive | -Search |
tcllib-devel: | -Subscribe | -Archive | -Search |
Please go to and use our - -Local Trackers. They are for -
Current: -1.19 (Feb 16, 2018) -Details - -
- - - -tcllib_install_guide - Tcllib - The Installer's Guide
+Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) Tcl +packages that provide utility functions useful to a large collection +of Tcl programmers.
+The audience of this document is anyone wishing to build the packages, +for either themselves, or others.
+For a developer intending to extend or modify the packages we +additionally provide
+Tcllib - The Developer's Guide.
Please read Tcllib - How To Get The Sources first, if that +was not done already. Here we assume that the sources are already +available in a directory of your choice.
+Before Tcllib can be build and used a number of requisites must be installed. +These are:
+The scripting language Tcl. + For details see Tcl.
Optionally, the critcl package (C embedding) for Tcl. + For details see CriTcl.
This list assumes that the machine where Tcllib is to be installed is +essentially clean. Of course, if parts of the dependencies listed +below are already installed the associated steps can be skipped. It is +still recommended to read their sections though, to validate that the +dependencies they talk about are indeed installed.
+As we are installing a number of Tcl packages and applications it +should be pretty much obvious that a working installation of Tcl +itself is needed, and I will not belabor the point.
+Out of the many possibilites use whatever you are comfortable +with, as long as it provides Tcl 8.2, or higher. +This may be a Tcl installation provided by your operating system +distribution, from a distribution-independent vendor, or built by +yourself.
+Note that the packages in Tcllib have begun to require +8.4, 8.5, and even 8.6. Older versions of Tcl will not be able to use +such packages. Trying to use them will result in +package not found errors, as their package index files will +not register them in versions of the core unable to use them.
+Myself, I used (and still use) +ActiveState's +ActiveTcl 8.5 distribution during development, as I am most familiar +with it.
+(Disclosure: I, Andreas Kupries, worked for ActiveState until 2016, maintaining ActiveTcl and TclDevKit for them).. +I am currently working for SUSE Software Canada ULC, although not in +Tcl-related areas.
+This distribution can be found at +http://www.activestate.com/activetcl. Retrieve the archive of +ActiveTcl 8.5 (or higher) for your platform and install it as directed +by ActiveState.
+For those wishing to build and install Tcl on their own, the +relevant sources can be found at
+together with the necessary instructions on how to build it.
+If there are problems with building, installing, or using Tcl +please file a ticket against Tcl, or the vendor of your +distribution, and not Tcllib.
+The critcl tool is an optional dependency.
+It is only required when trying to build the C-based +accelerators for a number of packages, as explained in +Critcl & Accelerators
+Tcllib's build system accepts it as an application found in the +PATH (be it starkit or starpack).
+Tcllib requires version 2 or higher.
+The github repository providing releases of version 2 and +higher, and the associated sources, can be found at +http://andreas-kupries.github.com/critcl.
+Any branch of the repository can be used (if not using the +prebuild starkit or starpack), although the use of the stable branch +master is recommended.
+At the above url is also an explanation on how to build and +install CriTcl, including a list of its dependencies.
+Its instructions will not be repeated here. If there are +problems with their directions please file a ticket against the +Critcl project, and not Tcllib.
+This section describes the actions required to install Tcllib on Unix +systems (Linux, BSD, and related, including OS X). +If you have to install Tcllib on a Windows machine instead then see +section Windows.
+Tcllib comes with a standard TEA buildsystem using a +configure script and a "Makefile" generated by it.
+To install Tcllib simply run
++ ./configure + make install ++
in the toplevel directory of Tcllib itself. To build in a directory D +outside of Tcllib's toplevel directory simply make D the current +working directory and invoke configure with either its +absolute path or a proper relative path.
+The above will non-interactively install all packages, +applications found in Tcllib, and their manpages, in directories +derived from what configure found out about the system.
+The underlying tool is "installer.tcl" in the toplevel +directory of Tcllib.
+Invoking this tool via
++ ./installer.tcl -help ++
will provide a short list of the available options. For more examples +see the various install targets found in "Makefile.in".
+This section describes the actions required to install Tcllib on Windows(tm) +systems. +If you have to install Tcllib on a Unix machine (Linux, BSD, and +related, including OS X) instead then see section Unix.
+If the build environment is based on MSYS, +cygwin, or a similar emulation of a unix environment, then +Unix still applies and should be used.
+Alternatively, as mentioned in the previous section, the tool +underneath of the unix buildsystem is the Tcl-based +"installer.tcl" script.
+Invoking this tool from a DOS shell via
++ /path/to/tclsh ./installer.tcl -help ++
will provide a short list of the available options. For more examples +see the various install targets found in "Makefile.in". +Invoking this tool without any arguments, i.e. like
++ /path/to/tclsh ./installer.tcl ++
will start a non-interactive installation showing its progress in a +Tk-based graphical interface. The directories to install the packages, +applications, etc. into are derived from the location of the +tclsh used to invoke the script, and where it expects +packages.
+A number of packages come with accelerators, i.e. +critcl-based C code whose use will boost the performance of +the packages using them. As these accelerators are optional they are +not installed by default.
+To build the accelerators the normally optional dependency on +critcl becomes required.
+To install Tcllib with the accelerators run
++ ./configure + make critcl # This builds the shared library holding the accelerators + make install ++
The underlying tool is "sak.tcl" in the toplevel directory +of Tcllib and the command make critcl is just a wrapper around
++ ./sak.tcl critcl ++
tcllib_license - Tcllib - License
+Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) Tcl +packages that provide utility functions useful to a large collection +of Tcl programmers.
+The collection is under the BSD license.
+This software is copyrighted by Ajuba Solutions and other parties. +The following terms apply to all files associated with the software +unless explicitly disclaimed in individual files.
+The authors hereby grant permission to use, copy, modify, distribute, +and license this software and its documentation for any purpose, +provided that existing copyright notices are retained in all copies +and that this notice is included verbatim in any distributions. No +written agreement, license, or royalty fee is required for any of the +authorized uses. Modifications to this software may be copyrighted by +their authors and need not follow the licensing terms described here, +provided that the new terms are clearly indicated on the first page of +each file where they apply.
+IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY +FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY +DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE.
+THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND +THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE +MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+GOVERNMENT USE: If you are acquiring this software on behalf of the +U.S. government, the Government shall have only "Restricted Rights" in +the software and related documentation as defined in the Federal +Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you +are acquiring the software on behalf of the Department of Defense, the +software shall be classified as "Commercial Computer Software" and the +Government shall have only "Restricted Rights" as defined in Clause +252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the +authors grant the U.S. Government and others acting in its behalf +permission to use and distribute the software in accordance with the +terms specified in this license.
+tcllib_sources - Tcllib - How To Get The Sources
+Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) Tcl +packages that provide utility functions useful to a large collection +of Tcl programmers.
+The audience of this document is anyone wishing to either have just a +look at Tcllib's source code, or build the packages, or to extend and +modify them.
+For builders and developers we additionally provide
+Tcllib - The Developer's Guide.
respectively.
+The official repository for Tcllib can be found at +http://core.tcl-lang.org/tcllib
+Assuming that you simply wish to look at the sources, or build a +specific revision, the easiest way of retrieving it is to:
+Log into this site, as "anonymous", using the semi-random password in the captcha.
Go to the "Timeline".
Choose the revision you wish to have and
follow its link to its detailed information page.
On that page, choose either the "ZIP" or "Tarball" link to get +a copy of this revision in the format of your choice.
For the curious (or a developer-to-be), the sources are managed by the +Fossil SCM. +Binaries for popular platforms can be found directly at its +download page.
+With that tool available the full history can be retrieved via:
++ fossil clone http://core.tcl-lang.org/tcllib tcllib.fossil ++
followed by
++ mkdir tcllib + cd tcllib + fossil open ../tcllib.fossil ++
to get a checkout of the head of the trunk.
+tcllib_install_guide - Tcllib - The Installer's Guide
+Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) Tcl +packages that provide utility functions useful to a large collection +of Tcl programmers.
+The audience of this document is anyone wishing to build the packages, +for either themselves, or others.
+For a developer intending to extend or modify the packages we +additionally provide
+Tcllib - The Developer's Guide.
Please read Tcllib - How To Get The Sources first, if that +was not done already. Here we assume that the sources are already +available in a directory of your choice.
+Before Tcllib can be build and used a number of requisites must be installed. +These are:
+The scripting language Tcl. + For details see Tcl.
Optionally, the critcl package (C embedding) for Tcl. + For details see CriTcl.
This list assumes that the machine where Tcllib is to be installed is +essentially clean. Of course, if parts of the dependencies listed +below are already installed the associated steps can be skipped. It is +still recommended to read their sections though, to validate that the +dependencies they talk about are indeed installed.
+As we are installing a number of Tcl packages and applications it +should be pretty much obvious that a working installation of Tcl +itself is needed, and I will not belabor the point.
+Out of the many possibilites use whatever you are comfortable +with, as long as it provides Tcl 8.2, or higher. +This may be a Tcl installation provided by your operating system +distribution, from a distribution-independent vendor, or built by +yourself.
+Note that the packages in Tcllib have begun to require +8.4, 8.5, and even 8.6. Older versions of Tcl will not be able to use +such packages. Trying to use them will result in +package not found errors, as their package index files will +not register them in versions of the core unable to use them.
+Myself, I used (and still use) +ActiveState's +ActiveTcl 8.5 distribution during development, as I am most familiar +with it.
+(Disclosure: I, Andreas Kupries, worked for ActiveState until 2016, maintaining ActiveTcl and TclDevKit for them).. +I am currently working for SUSE Software Canada ULC, although not in +Tcl-related areas.
+This distribution can be found at +http://www.activestate.com/activetcl. Retrieve the archive of +ActiveTcl 8.5 (or higher) for your platform and install it as directed +by ActiveState.
+For those wishing to build and install Tcl on their own, the +relevant sources can be found at
+together with the necessary instructions on how to build it.
+If there are problems with building, installing, or using Tcl +please file a ticket against Tcl, or the vendor of your +distribution, and not Tcllib.
+The critcl tool is an optional dependency.
+It is only required when trying to build the C-based +accelerators for a number of packages, as explained in +Critcl & Accelerators
+Tcllib's build system accepts it as an application found in the +PATH (be it starkit or starpack).
+Tcllib requires version 2 or higher.
+The github repository providing releases of version 2 and +higher, and the associated sources, can be found at +http://andreas-kupries.github.com/critcl.
+Any branch of the repository can be used (if not using the +prebuild starkit or starpack), although the use of the stable branch +master is recommended.
+At the above url is also an explanation on how to build and +install CriTcl, including a list of its dependencies.
+Its instructions will not be repeated here. If there are +problems with their directions please file a ticket against the +Critcl project, and not Tcllib.
+This section describes the actions required to install Tcllib on Unix +systems (Linux, BSD, and related, including OS X). +If you have to install Tcllib on a Windows machine instead then see +section Windows.
+Tcllib comes with a standard TEA buildsystem using a +configure script and a "Makefile" generated by it.
+To install Tcllib simply run
++ ./configure + make install ++
in the toplevel directory of Tcllib itself. To build in a directory D +outside of Tcllib's toplevel directory simply make D the current +working directory and invoke configure with either its +absolute path or a proper relative path.
+The above will non-interactively install all packages, +applications found in Tcllib, and their manpages, in directories +derived from what configure found out about the system.
+The underlying tool is "installer.tcl" in the toplevel +directory of Tcllib.
+Invoking this tool via
++ ./installer.tcl -help ++
will provide a short list of the available options. For more examples +see the various install targets found in "Makefile.in".
+This section describes the actions required to install Tcllib on Windows(tm) +systems. +If you have to install Tcllib on a Unix machine (Linux, BSD, and +related, including OS X) instead then see section Unix.
+If the build environment is based on MSYS, +cygwin, or a similar emulation of a unix environment, then +Unix still applies and should be used.
+Alternatively, as mentioned in the previous section, the tool +underneath of the unix buildsystem is the Tcl-based +"installer.tcl" script.
+Invoking this tool from a DOS shell via
++ /path/to/tclsh ./installer.tcl -help ++
will provide a short list of the available options. For more examples +see the various install targets found in "Makefile.in". +Invoking this tool without any arguments, i.e. like
++ /path/to/tclsh ./installer.tcl ++
will start a non-interactive installation showing its progress in a +Tk-based graphical interface. The directories to install the packages, +applications, etc. into are derived from the location of the +tclsh used to invoke the script, and where it expects +packages.
+A number of packages come with accelerators, i.e. +critcl-based C code whose use will boost the performance of +the packages using them. As these accelerators are optional they are +not installed by default.
+To build the accelerators the normally optional dependency on +critcl becomes required.
+To install Tcllib with the accelerators run
++ ./configure + make critcl # This builds the shared library holding the accelerators + make install ++
The underlying tool is "sak.tcl" in the toplevel directory +of Tcllib and the command make critcl is just a wrapper around
++ ./sak.tcl critcl ++
tcllib_license - Tcllib - License
+Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) Tcl +packages that provide utility functions useful to a large collection +of Tcl programmers.
+The collection is under the BSD license.
+This software is copyrighted by Ajuba Solutions and other parties. +The following terms apply to all files associated with the software +unless explicitly disclaimed in individual files.
+The authors hereby grant permission to use, copy, modify, distribute, +and license this software and its documentation for any purpose, +provided that existing copyright notices are retained in all copies +and that this notice is included verbatim in any distributions. No +written agreement, license, or royalty fee is required for any of the +authorized uses. Modifications to this software may be copyrighted by +their authors and need not follow the licensing terms described here, +provided that the new terms are clearly indicated on the first page of +each file where they apply.
+IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY +FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY +DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE.
+THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND +THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE +MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+GOVERNMENT USE: If you are acquiring this software on behalf of the +U.S. government, the Government shall have only "Restricted Rights" in +the software and related documentation as defined in the Federal +Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you +are acquiring the software on behalf of the Department of Defense, the +software shall be classified as "Commercial Computer Software" and the +Government shall have only "Restricted Rights" as defined in Clause +252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the +authors grant the U.S. Government and others acting in its behalf +permission to use and distribute the software in accordance with the +terms specified in this license.
+tcllib_sources - Tcllib - How To Get The Sources
+Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a +package itself. It is a collection of (semi-independent) Tcl +packages that provide utility functions useful to a large collection +of Tcl programmers.
+The audience of this document is anyone wishing to either have just a +look at Tcllib's source code, or build the packages, or to extend and +modify them.
+For builders and developers we additionally provide
+Tcllib - The Developer's Guide.
respectively.
+The official repository for Tcllib can be found at +http://core.tcl-lang.org/tcllib
+Assuming that you simply wish to look at the sources, or build a +specific revision, the easiest way of retrieving it is to:
+Log into this site, as "anonymous", using the semi-random password in the captcha.
Go to the "Timeline".
Choose the revision you wish to have and
follow its link to its detailed information page.
On that page, choose either the "ZIP" or "Tarball" link to get +a copy of this revision in the format of your choice.
For the curious (or a developer-to-be), the sources are managed by the +Fossil SCM. +Binaries for popular platforms can be found directly at its +download page.
+With that tool available the full history can be retrieved via:
++ fossil clone http://core.tcl-lang.org/tcllib tcllib.fossil ++
followed by
++ mkdir tcllib + cd tcllib + fossil open ../tcllib.fossil ++
to get a checkout of the head of the trunk.
+