Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Integrated testsuite fixups Merged latest work from trunk Regenerated documentation. - Fixed outdated references to feedback.inc Use `modules/common-text/feedback.inc` now. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | hypnotoad |
Files: | files | file ages | folders |
SHA3-256: |
e3ae2af3f4799a6561757a03dc4a497e |
User & Date: | aku 2019-06-05 05:02:36.698 |
Context
2019-06-05
| ||
13:30 | Pulling changes from trunk check-in: 147792792a user: hypnotoad tags: hypnotoad | |
06:31 | Integrated last of hypnotoad branch check-in: 8ec2d6ea79 user: aku tags: trunk | |
05:02 | Integrated testsuite fixups Merged latest work from trunk Regenerated documentation. - Fixed outdated references to feedback.inc Use `modules/common-text/feedback.inc` now. check-in: e3ae2af3f4 user: aku tags: hypnotoad | |
2019-06-04
| ||
20:08 | Added demonstrations of passing configuration parameters and seeing the data reflected in behavior in httpd Closed-Leaf check-in: 367088a3b3 user: hypnotoad tags: aku-the-big-httpd-testsuite-cleanup | |
2019-06-03
| ||
23:44 | Update to clay, practcl, and httpd brought over from the clay project. clay - fixes a typo in the ensemble generator - Removed a call to cron::object_destroy (we don't always run with cron) - Added a tool-like event manager - Removed where the amalgamater was adding dictargs twice - Added a "short" uuid for local projects httpd - updates to clay - Test fixes - Remove CSS templating from the vanilla httpd - Some behind the scenes tweaks to accomodate the cuneiform module when httpd is used in external packages practcl - updates to clay - Static packages are now advertised in the tclpreinitscript, eliminating the need for the master process to throw a bootstrap to new threads check-in: 6ae00eec07 user: hypnotoad tags: hypnotoad | |
2019-05-07
| ||
19:05 | Add two tests for the quasirandom packages; describe and test the estimates for the number of primes in an interval check-in: c2db185801 user: arjenmarkus tags: trunk | |
Changes
Changes to .github/CONTRIBUTING.md.
1 |
| | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | Hello. __Attention please__ You are currently using the github __mirror__ of the Tcllib sources. This is __not__ the location where Tcllib development takes place. We are __not tracking issues entered here__. With the exception of the maintainer of the mirroring setup nobody will even see such issues. Please go to the [official location of the sources](https://core.tcl-lang.org/tcllib) and enter your ticket into the [official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist) instead. Thank you for your consideration. |
Changes to .github/ISSUE_TEMPLATE.md.
1 |
| | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | Hello. __Attention please__ You are currently using the github __mirror__ of the Tcllib sources. This is __not__ the location where Tcllib development takes place. We are __not tracking issues entered here__. With the exception of the maintainer of the mirroring setup nobody will even see such issues. Please go to the [official location of the sources](https://core.tcl-lang.org/tcllib) and enter your ticket into the [official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist) instead. Thank you for your consideration. |
Changes to .github/PULL_REQUEST_TEMPLATE.md.
1 |
| | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | Hello. __Attention please__ You are currently using the github __mirror__ of the Tcllib sources. This is __not__ the location where Tcllib development takes place. We are __not tracking issues entered here__. With the exception of the maintainer of the mirroring setup nobody will even see such issues. Please go to the [official location of the sources](https://core.tcl-lang.org/tcllib) and enter your ticket into the [official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist) instead. Thank you for your consideration. |
Deleted INSTALL.txt.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Deleted README.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Changes to README.md.
|
| | < < < | < | < < | | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # Attention :warning: This repository is mirrored to [github](https://github.com/tcltk/tcllib). We are __not tracking issues at github__. With the exeception of the maintainer of the mirroring setup nobody will even see issues created at github. Please use the [official ticket tracker](https://core.tcl-lang.org/tcllib/reportlist) instead. # Welcome 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. At our [home site](http://core.tcl-lang.org/tcllib) you will find the official fossil repository used to manage our sources, together with the bug tracker. This is also the main location for releases to download from. We have a [secondary download location](https://sourceforge.net/projects/tcllib/files) where the Tcllib sources were hosted in the past. SourceForge is also where our [mailing lists](https://sourceforge.net/p/tcllib/mailman) are (still) hosted. Another location to find these sources at is the [github mirror](https://github.com/tcltk/tcllib). Please note the :warning: at the top. # Guides To Tcllib * [Tcl Community - Kind Communication](embedded/www/tcllib/files/devdoc/tcl_community_communication.html) * [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](embedded/www/tcllib/files/devdoc/tcllib_devguide.html) * [The Release Manager's Guide](embedded/www/tcllib/files/devdoc/tcllib_releasemgr.html) |
Deleted README.releasemgr.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Changes to apps/dtplite.man.
︙ | ︙ | |||
439 440 441 442 443 444 445 | They are left in place, i.e. not deleted, to serve as demonstrations of doctoc and docidx markup. [list_end] [vset CATEGORY doctools] | | | 439 440 441 442 443 444 445 446 447 | They are left in place, i.e. not deleted, to serve as demonstrations of doctoc and docidx markup. [list_end] [vset CATEGORY doctools] [include ../modules/common-text/feedback.inc] [manpage_end] |
Changes to apps/nns.man.
︙ | ︙ | |||
135 136 137 138 139 140 141 | If this option is not specified it defaults to [const 38573]. It specifies the TCP port the name service to talk to is listening on for requests. [list_end] [vset CATEGORY nameserv] | | | 135 136 137 138 139 140 141 142 143 | If this option is not specified it defaults to [const 38573]. It specifies the TCP port the name service to talk to is listening on for requests. [list_end] [vset CATEGORY nameserv] [include ../modules/common-text/feedback.inc] [manpage_end] |
Changes to apps/nnsd.man.
︙ | ︙ | |||
83 84 85 86 87 88 89 | If this option is not specified it defaults to [const 38573]. It specifies the TCP port the server has to listen on for requests. [list_end] [vset CATEGORY nameserv] | | | 83 84 85 86 87 88 89 90 91 | If this option is not specified it defaults to [const 38573]. It specifies the TCP port the server has to listen on for requests. [list_end] [vset CATEGORY nameserv] [include ../modules/common-text/feedback.inc] [manpage_end] |
Changes to apps/nnslog.man.
︙ | ︙ | |||
85 86 87 88 89 90 91 | If this option is not specified it defaults to [const 38573]. It specifies the TCP port the name service to talk to is listening on for requests. [list_end] [vset CATEGORY nameserv] | | | 85 86 87 88 89 90 91 92 93 | If this option is not specified it defaults to [const 38573]. It specifies the TCP port the name service to talk to is listening on for requests. [list_end] [vset CATEGORY nameserv] [include ../modules/common-text/feedback.inc] [manpage_end] |
Changes to apps/page.man.
︙ | ︙ | |||
459 460 461 462 463 464 465 | [para] The contents of both environment variables and registry entries are interpreted as a list of paths, with the elements separated by either colon (Unix), or semicolon (Windows). [vset CATEGORY page] | | | 459 460 461 462 463 464 465 466 467 | [para] The contents of both environment variables and registry entries are interpreted as a list of paths, with the elements separated by either colon (Unix), or semicolon (Windows). [vset CATEGORY page] [include ../modules/common-text/feedback.inc] [manpage_end] |
Changes to apps/tcldocstrip.man.
︙ | ︙ | |||
189 190 191 192 193 194 195 | Preambles, when active, are written before the actual content of a generated file. In the same manner postambles are, when active, written after the actual content of a generated file. [list_end] [vset CATEGORY docstrip] | | | 189 190 191 192 193 194 195 196 197 | Preambles, when active, are written before the actual content of a generated file. In the same manner postambles are, when active, written after the actual content of a generated file. [list_end] [vset CATEGORY docstrip] [include ../modules/common-text/feedback.inc] [manpage_end] |
Name change from README.developer to devdoc/README.developer.
︙ | ︙ |
Deleted devdoc/cvs.branches.fig.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Deleted devdoc/devguide.html.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Deleted devdoc/installation.txt.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Added devdoc/parts/b_critcl.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | While the majority of Tcllib consists of packages written in pure Tcl a number of packages also have [term accelerators] associated with them. These are [syscmd critcl]-based C packages whose use will boost the performance of the packages using them. These accelerators are optional, and they are not installed by default. [para] To build the accelerators the normally optional dependency on [syscmd critcl] becomes required. [para] To build and install Tcllib with the accelerators in a Unix-like environment invoke: [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 }] [para] Therefore in a Windows environment instead invoke [example { ./sak.tcl critcl ./installer.tcl }] from within a DOS window, i.e. [syscmd cmd.exe]. |
Added devdoc/parts/b_tooling.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | The core of Tcllib's build system is the script [file installer.tcl] found in the toplevel directory of a checkout or release. [para] The [example { configure ; make install }] setup available to developers on Unix-like systems is just a wrapper around it. To go beyond the standard embodied in the wrapper it is necessary to directly invoke this script. [para] On Windows system using it directly is the only way to invoke it. [para] For basic help invoke it as [example { ./installer.tcl -help }] This will print a short list of all the available options to the standard output channel. [para] The commands associated with the various [term install] targets in the [term Makefile.in] for Unix can be used as additional examples on how to use this tool as well. [para] The installer can operate in GUI and CLI modes. By default it chooses the mode automatically, based on if the Tcl package [package Tk] can be used or not. The option [option -no-gui] can be used to force CLI mode. [para] Note that it is possible to specify options on the command line even if the installer ultimatively selects GUI mode. In that case the hardwired defaults and the options determine the data presented to the user for editing. [para] The installer will select a number of defaults for the locations of packages, examples, and documentation, and also the format of the documentation. The user can overide these defaults in the GUI, or by specifying additional options. The defaults depend on the platform detected (Unix/Windows) and on the [syscmd tclsh] executable used to run the installer. [para][emph Options] [list_begin options] [opt_def -help] Show the list of options explained here on the standard output channel and exit. [opt_def +excluded] Include deprecated packages in the installation. [opt_def -no-gui] Force command line operation of the installer [opt_def -no-wait] In CLI mode the installer will by default ask the user to confirm that the chosen configuration (destination paths, things to install) is correct before performing any action. Using this option causes the installer to skip this query and immediately jump to installation. [opt_def -app-path [arg path]] [opt_def -example-path [arg path]] [opt_def -html-path [arg path]] [opt_def -nroff-path [arg path]] [opt_def -pkg-path [arg path]] Declare the destination paths for the applications, examples, html documentation, nroff manpages, and packages. The defaults are derived from the location of the [syscmd tclsh] used to run the installer. [opt_def -dry-run] [opt_def -simulate] Run the installer without modifying the destination directories. [opt_def -apps] [opt_def -no-apps] [opt_def -examples] [opt_def -no-examples] [opt_def -pkgs] [opt_def -no-pkgs] [opt_def -html] [opt_def -no-html] [opt_def -nroff] [opt_def -no-nroff] (De)activate the installation of applications, examples, packages, html documentation, and nroff manpages. [para] Applications, examples, and packages are installed by default. [para] On Windows the html documentation is installed by default. [para] On Unix the nroff manpages are installed by default. [list_end] |
Added devdoc/parts/b_unix.inc.
> > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | For [term Unix]-like environments Tcllib comes with the standard set of files to make [example { ./configure make install }] a suitable way of installing it. This is a standard non-interactive install automatically figuring out where to place everything, i.e. packages, applications, and the manpages. [para] To get a graphical installer invoke [example { ./installer.tcl }] instead. |
Added devdoc/parts/b_windows.inc.
> > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | In a Windows environment we have the [cmd installer.tcl] script to perform installation. [para] If the desired [syscmd tclsh] is associated [file .tcl] files then double-clicking / opening the [cmd installer.tcl] is enough to invoke it in graphical mode. This assumes that [term Tk] is installed and available as well. [para] Without [term Tk] the only way to invoke the installer are to open a DOS window, i.e. [syscmd cmd.exe], and then to invoke [example { ./installer.tcl }] inside it. |
Added devdoc/parts/d_bf_branchcmds.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | In the hope of engendering good work practices now a few example operations which will come up with branches, and their associated fossil command (sequences). [list_begin definitions] [comment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~] [def [emph Awareness]] [include d_op_aware.inc] [comment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~] [def [emph {Clean checkouts}]] [include d_op_clean.inc] [comment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~] [def [emph {Starting a new branch}]] [include d_op_branch_open.inc] [comment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~] [def [emph {Merging a branch into trunk}]] [include d_op_branch_close.inc] [comment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~] [def [emph {Merging from trunk}]] [include d_op_branch_import.inc] [list_end] |
Added devdoc/parts/d_bf_branches.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | Given the constraints placed on the [term trunk] branch of the repository it is (strongly) recommended to perform any development going beyond trivial changes on a non-trunk branch. [para] Outside of the trunk developers are allowed to commit intermediate broken states of their work. Only at the end of a development cycle, when the relevant branch is considered ready for merging, will it be necessary to perform full the set of validations ensuring that the merge to come will create a good commit on trunk. [para] Note that while a review from a second developer is not a required condition for merging a branch it is recommended to seek out such an independent opinion as a means of cross-checking the work. [para] It also recommended to give any new branch a name which aids in determining additional details about it. Examples of good things to stick into a branch name would be [list_begin itemized] [item] Developer (nick)name [item] Ticket hash/reference [item] One or two keywords applicable to the work [item] ... [list_end] [para] Further, while most development branches are likely quite short-lived, no prohibitions exist against making longer-lived branches. Creators should however be mindful that the longer such a branch exists without merges the more divergent they will tend to be, with an associated increase in the effort which will have to be spent on either merging from and merging to trunk. |
Added devdoc/parts/d_bf_dependencies.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | Regarding packages and dependencies between them Tcllib occupies a middle position between two extremes: [list_begin enumerated] [enum] On one side a strongly interdependent set of packages, usually by a single author, for a single project. Looking at my (Andreas Kupries) own work examples of such are [uri https://core.tcl.tk/akupries/marpa/index Marpa], [uri https://core.tcl.tk/akupries/crimp/index CRIMP], [uri https://core.tcl.tk/akupries/kinetcl/index Kinetcl], etc. [para] For every change the author of the project handles all the modifications cascading from any incompatibilities it introduced to the system. [enum] On the other side, the world of semi-independent projects by many different authors where authors know what packages their own creations depend on, yet usually do not know who else depends on them. [para] The best thing an author making an (incompatible) change to their project can do is to for one announce such changes in some way, and for two use versioning to distinguish the code before and after the change. [para] The world is then responsible for adapting, be it by updating their own projects to the new version, or by sticking to the old. [list_end] As mentioned already, Tcllib lives in the middle of that. [para] While we as maintainers cannot be aware of all users of Tcllib's packages, and thus have to rely on the mechanisms touched on in point 2 above for that, the dependencies between the packages contained in Tcllib are a different matter. [para] As we are collectively responsible for the usability of Tcllib in toto to the outside world, it behooves us to be individually mindful even of Tcllib packages we are not directly maintaining, when they depend on packages under our maintainership. This may be as simple as coordinating with the maintainers of the affected packages. It may also require us to choose how to adapt affected packages which do not have maintainers, i.e. modify them to use our changed package properly, or modify them to properly depend on the unchanged version of our package. [para] Note that the above is not only a chore but an opportunity as well. Additional insight can be had by forcing ourselves to look at our package and the planned change(s) from an outside perspective, to consider the ramifications of our actions on others in general, and on dependent packages in particular. |
Added devdoc/parts/d_bf_trunk.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | The management and use of branches is an important part of working with a [term {Distributed Version Control System}] ([term DVCS]) like [uri https://www.fossil-scm.org/ fossil]. [para] For Tcllib the main branch of the collection is [term trunk]. In [term git] this branch would be called [term master], and this is exactly the case in the [uri https://github.com/tcltk/tcllib/ {github mirror}] of Tcllib. [para] To properly support debugging [emph {each commit}] on this branch [emph {has to pass the entire testsuite}] of the collection. Using bisection to determine when an issue appeared is an example of an action made easier by this constraint. [para] This is part of our collective responsibility for the usability of Tcllib in toto to the outside world. As [term fossil] has no mechanism to enforce this condition this is handled on the honor system for developers and maintainers. [para] To make the task easier Tcllib comes with a tool ([file sak.tcl]) providing a number of commands in support. These commands are explained in the following sections of this guide. [para] While it is possible and allowed to commit directly to trunk remember the above constraint regarding the testsuite, and the coming notes about other possible issues with a commit. |
Added devdoc/parts/d_bf_versions.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | In Tcllib all changes to a package have to come with an increment of its version number. What part is incremented (patchlevel, minor, major version) depends on the kind of change made. With multiple changes in a commit the highest "wins". [para] When working in a development branch the version change can be deferred until it is time to merge, and then has to cover all the changes in the branch. [para] Below a list of the kinds of changes and their associated version increments: [list_begin definitions] [def [term {D - documentation}]] No increment [def [term {T - testsuite}]] No increment [def [term {B - bugfix}]] Patchlevel [def [term {I - implementation tweak}]] Patchlevel [def [term {P - performance tweak}]] Patchlevel [def [term {E - backward-compatible extension}]] Minor [def [term {API - incompatible change}]] Major [list_end] [para] Note that a commit containing a version increment has to mention the new version number in its commit message, as well as the kind of change which caused it. [para] Note further that the version number of a package currently exists in three places. An increment has to update all of them: [list_begin enumerated] [enum] The package implementation. [enum] The package index ([file pkgIndex.tcl]) [enum] The package documentation. [list_end] [para] The [file sak.tcl] command [cmd {validate version}] helps finding discrepancies between the first two. All the other [cmd validate] methods are also of interest to any developer. Invoke it with [example { sak.tcl help validate }] to see their documentation. |
Added devdoc/parts/d_branchflow.inc.
> > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | [comment {===================================================================}] [subsection {Package Dependencies}] [include d_bf_dependencies.inc] [comment {===================================================================}] [subsection Trunk] [include d_bf_trunk.inc] [comment {===================================================================}] [subsection Branches] [include d_bf_branches.inc] [comment {===================================================================}] [subsection {Working with Branches}] [include d_bf_branchcmds.inc] [comment {===================================================================}] [subsection {Version numbers}] [include d_bf_versions.inc] |
Added devdoc/parts/d_contrib.inc.
> > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | As a contributor to Tcllib you are committing yourself to: [list_begin enumerated] [enum] keep the guidelines written down in [term {Tcl Community - Kind Communication}] in your mind. The main point to take away from there is [emph {to be kind to each other}]. [enum] Your contributions getting distributed under a BSD/MIT license. For the details see [term {Tcllib - License}] [list_end] Contributions are made by entering tickets into our tracker, providing patches, bundles or branches of code for inclusion, or posting to the Tcllib related mailing lists. |
Added devdoc/parts/d_dirlayout.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [subsection {Main Directories}] The main directories in the Tcllib toplevel directory and of interest to a developer are: [list_begin definitions] [def [file modules]] Each child directory represents one or more packages. In the case of the latter the packages are usually related in some way. Examples are [file base64], [file math], and [file struct], with loose (base64) to strong (math) relations between the packages in the directory. [def [file apps]] This directory contains all the installable applications, with their documentation. Note that this directory is currently [emph not] split into sub-directories. [def [file examples]] Each child directory [file foo] contains one or more example application for the packages in [file modules/foo]. These examples are generally not polished enough to be considered for installation. [list_end] [subsection {More Directories}] [list_begin definitions] [def [file config]] This directory contains files supporting the Unix build system, i.e. [file configure] and [file Makefile.in]. [def [file devdoc]] This directories contains the doctools sources for the global documentation, like this document and its sibling guides. [def [file embedded]] This directory contains the entire documentation formatted for [term HTML] and styled to properly mix into the web site generated by fossil for the repository. [para] This is the documentation accessible from the Tcllib home directory, represented in the repository as [file embedded/index.md]. [def [file idoc]] This directory contains the entire documentation formatted for [term nroff] and [term HTML], the latter without any styling. This is the documentation which will be installed. [def [file support]] This directory contains the sources of internal packages and utilities used in the implementation of the [file installer.tcl] and [file sak.tcl] scripts/tools. [list_end] [subsection {Top Files}] [list_begin definitions] [def [file aclocal.m4]] [def [file configure]] [def [file configure.in]] [def [file Makefile.in]] These four files comprise the Unix build system layered on top of the [file installer.tcl] script. [def [file installer.tcl]] The Tcl-based installation script/tool. [def [file project.shed]] Configuration file for [term {Sean Wood}]'s [syscmd PracTcl] buildsystem. [def [file sak.tcl]] This is the main tool for developers and release managers, the [term {Swiss Army Knife}] of management operations on the collection. [def [file ChangeLog]] The log of changes to the global support, when the sources were held in [term CVS]. Not relevant any longer with the switch to the [term fossil] SCM. [def [file license.terms]] The license in plain ASCII. See also [term {Tcllib - License}] for the nicely formatted form. The text is identical. [def [file README.md]] [def [file .github/CONTRIBUTING.md]] [def [file .github/ISSUE_TEMPLATE.md]] [def [file .github/PULL_REQUEST_TEMPLATE.md]] These markdown-formatted documents are used and shown by the github mirror of these sources, pointing people back to the official location and issue trackers. [def [file DESCRIPTION.txt]] [def [file STATUS]] [def [file tcllib.spec]] [def [file tcllib.tap]] [def [file tcllib.yml]] ???? [list_end] [subsection {File Types}] The most common file types, by file extension, are: [list_begin definitions] [def [file .tcl]] Tcl code for a package, application, or example. [def [file .man]] Doctools-formatted documentation, usually for a package. [def [file .test]] Test suite for a package, or part of. Based on [package tcltest]. [def [file .bench]] Performance benchmarks for a package, or part of. Based on [file modules/bench]. [def [file .pcx]] Syntax rules for [term TclDevKit]'s [syscmd tclchecker]. Using these rules allows the checker to validate the use of commands of a Tcllib package [package foo] without having to scan the [file .tcl] files implementing it. [list_end] |
Added devdoc/parts/d_documentation.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | The standard format used for documentation of packages and other things in Tcllib is [term doctools]. Its supporting packages are a part of Tcllib, see the directories [file modules/doctools] and [file modules/dtplite]. The latter is an application package, with the actual application [file apps/dtplite] a light wrapper around it. [para] Tcllib developers gain access to these through the [cmd doc] method of the [file sak.tcl] tool, another (internal) wrapper around the [file modules/dtplite] application package. [comment {===================================================================}] [subsection {Generate documentation for a specific module}] Invoke either [example { ./sak.tcl doc html foo }] or [example { ./sak.tcl doc html modules/foo }] to generate HTML for the documentation found in the module [file foo]. Instead of [const html] any other supported format can be used here, of course. [para] The generated formatted documentation will be placed into a directory [file doc] in the current working directory. [comment {===================================================================}] [subsection {Generate documentation for all modules}] Invoke the tool without a module name, i.e. [example { ./sak.tcl doc html }] to generate HTML for the documentation found in all modules. Instead of [const html] any other supported format can be used here, of course. [para] The generated formatted documentation will be placed into a directory [file doc] in the current working directory. [comment {===================================================================}] [subsection {Available output formats, help}] Invoke the tool as [example { ./sak.tcl help doc }] to see the entire set of supported output formats which can be generated. [comment {===================================================================}] [subsection {Validation without output}] Note the special format [const validate]. [para] Using this value as the name of the format to generate forces the tool to simply check that the documentation is syntactically correct, without generating actual output. [para] Invoke it as either [example { ./sak.tcl doc validate (modules/)foo }] or [example { ./sak.tcl doc validate }] to either check the packages of a specific module or check all of them. |
Added devdoc/parts/d_installation.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | A last thing to consider when adding a new package to the collection is installation. [para] How to [emph use] the [file installer.tcl] script is documented in [term {Tcllib - The Installer's Guide}]. [para] Here we document how to extend said installer so that it may install new package(s) and/or application(s). [para] In most cases only a single file has to be modified, the [file support/installation/modules.tcl] holding one command per module and application to install. [para] The relevant commands are: [list_begin definitions] [call [cmd Module] [arg name] \ [arg code-action] \ [arg doc-action] \ [arg example-action]] Install the packages of module [arg name], found in [file modules/[arg name]]. [para] The [arg code-action] is responsible for installing the packages and their index. The system currently provides [list_begin definitions] [def [cmd _tcl]] Copy all [file .tcl] files found in [file modules/[arg name]] into the installation. [def [cmd _tcr]] As [cmd _tcl], copy the [file .tcl] files found in the subdirectories of [file modules/[arg name]] as well. [def [cmd _tci]] As [cmd _tcl], and copy the [file tclIndex.tcl] file as well. [def [cmd _msg]] As [cmd _tcl], and copy the subdirectory [file msgs] as well. [def [cmd _doc]] As [cmd _tcl], and copy the subdirectory [file mpformats] as well. [def [cmd _tex]] As [cmd _tcl], and copy [file .tex] files as well. [list_end] [para] The [arg doc-action] is responsible for installing the package documentation. The system currently provides [list_begin definitions] [def [cmd _null]] No documentation available, do nothing. [def [cmd _man]] Process the [file .man] files found in [file modules/[arg name]] and install the results (nroff and/or HTML) in the proper location, as given to the installer. [para] This is actually a fallback, normally the installer uses the pre-made formatted documentation found under [file idoc]. [list_end] [para] The [arg example-action] is responsible for installing the examples. The system currently provides [list_begin definitions] [def [cmd _null]] No examples available, do nothing. [def [cmd _exa]] Copy the the directory [file examples/[arg name]] recursively to the install location for examples. [list_end] [call [cmd Application] [arg name]] Install the application with [arg name], found in [file apps]. [call [cmd Exclude] [arg name]] This command signals to the installer which of the listed modules to [emph not] install. I.e. they name the deprecated modules of Tcllib. [list_end] [para] If, and only if the above actions are not suitable for the new module then a second file has to be modified, [file support/installation/actions.tcl]. [para] This file contains the implementations of the available actions, and is the place where any custom action needed to handle the special circumstances of module has to be added. |
Added devdoc/parts/d_maintain.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | When contributing one or more packages for full inclusion into Tcllib you are committing yourself to [list_begin enumerated] [enum] Keep the guidelines written down in [term {Tcl Community - Kind Communication}] (as any contributor) in your mind. The main point to take away from there is [emph {to be kind to each other}]. [enum] Your packages getting distributed under a BSD/MIT license. For the details see [term {Tcllib - License}] [enum] Maintenance of the new packages for a period of two years under the following rules, and responsibilities: [list_begin enumerated] [enum] A maintainer may step down after the mandatory period as they see fit. [enum] A maintainer may step down before the end of the mandatory period, under the condition that a replacement maintainer is immediately available and has agreed to serve the remainder of the period, plus their own mandatory period (see below). [enum] When stepping down without a replacement maintainer taking over the relevant packages have to be flagged as [const unmaintained]. [enum] When a replacement mantainer is brought in for a package it is (kept) marked as [const maintained] (again). [para] A replacement maintainer is bound by the same rules as the original maintainer, except that the mandatory period of maintenance is shortened to one year. [enum] For any [const unmaintained] package a contributor interested in becoming its maintainer can become so by flagging them as [const maintained] with their name and contact information, committing themselves to the rules of a replacement maintainer (see previous point). [enum] For any already [const maintained] package a contributor interested in becoming a co-maintainer can become so with the agreement of the existing maintainer(s), committing themselves to the rules of a replacement maintainer (see two points previous). [list_end] [para] The responsibilities as a maintainer include: [list_begin enumerated] [enum] Watching Tcllib's ticket tracker for bugs, bug fixes, and feature requests related to the new packages. [enum] Reviewing the aforementioned tickets, rejecting or applying them [enum] Coordination and discussion with ticket submitter during the development and/or application of bug fixes. [list_end] [enum] Follow the [sectref {Branching and Workflow}] of this guide. [list_end] |
Added devdoc/parts/d_op_aware.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | When developing we have to keep ourselves aware of the context of our work. On what branch are we ? What files have we changed ? What new files are not yet known to the repository ? What has happened remotely since we used our checkout ? The answers to these questions become especially important when using a long-lived checkout and coming back to it after some time away. [para] Commands to answer questions like the above are: [list_begin definitions] [def [cmd {fossil pull}]] Get all changes done on the remote since the last pull or sync from it. This has to be done first, before any of the commands below. [para] Even if the commit in our checkout refers to the branch we want right now control operations committed to the remote may have changed that from underneath us. [def [cmd {fossil info | grep tags}]] [def [cmd {fossil branch list | grep '\*'}]] Two different ways of determining the branch our checkout is on. [def [cmd {fossil timeline}]] What have we (and others) done recently ? [para] [emph Attention], this information is very likely outdated, the more the longer we did not use this checkout. Run [cmd {fossil pull}] first to get latest information from the remote repository of the project. [def [cmd {fossil timeline current}]] Place the commit our checkout is based on at the top of the timeline. [def [cmd {fossil changes}]] Lists the files we have changed compared to the commit the checkout is based on. [def [cmd {fossil extra}]] Lists the files we have in the checkout the repository does not know about. This may be leftover chaff from our work, or something we have forgotten to [cmd {fossil add}] to the repository yet. [list_end] |
Added devdoc/parts/d_op_branch_close.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | Be aware of where you are (see first definition). [para] Ensure that you have clean checkout (see second definition). In the full-blown sequence (zig-zag) it is [emph required], due to the merging from trunk. In the shorter sequence it is only desired. That said, keeping the checkout clean before any major operations is a good habit to have, in my opinion. [para] The full-blown sequencing with checks all the way is to [list_begin enumerated] [enum] Validate the checkout, i.e. last commit on your branch. Run the full test suite and other validations, fix all the issues which have cropped up. [enum] Merge the latest state of the [term trunk] (see next definition). [enum] Validate the checkout again. The incoming trunk changes may have broken something now. Do any required fixes. [enum] Now merge to the trunk using [example { fossil update trunk fossil merge --integrate YOUR_BRANCH }] [enum] At this point the checkout should be in the same state as at the end of point (3) above, because we resolved any issues with the trunk already. Thus a simple [example { fossil commit ... }] should be sufficient now to commit the merge back and close the branch (due to the [option --integrate] we used on the merge). [para] The more paranoid may validate the checkout a third time before commiting. [list_end] [para] I call this a [term {zig-zag merge}] because of how the arrows look in the timeline, from trunk to feature branch for the first merge, and then back for the final merge. [para] A less paranoid can do what I call a [term {simple merge}], which moves step (2) after step (4) and skips step (3) entirely. The resulting shorter sequence is [list_begin enumerated] [enum] Validate [enum] Merge to trunk [enum] Validate again [enum] Commit to trunk [list_end] The last step after either zig-zag or plain merge is to [example { fossil sync }] This saves our work to the remote side, and further gives us any other work done while we were doing our merge. It especially allows us to check if we raced somebody else, resulting in a split trunk. [para] When that happens we should coordinate with the other developer on who fixes the split, to ensure that we do not race each other again. |
Added devdoc/parts/d_op_branch_import.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | Be aware of where you are (see first definition). [para] Ensure that you have clean checkout (see second definition). It is [emph required]. [para] In most situations you want to import the latest commit of branch [term trunk] (or other origin). To get it use [example { fossil pull }] [para] With that done we can now import this commit into our current branch with [example { fossil merge trunk }] [para] Even if [syscmd fossil] does not report any conflicts it is a good idea to check that the operation has not broken the new and/or changed functionality we are working on. [para] With the establishment of a good merge we then save the state with [example { fossil commit ... }] before continuing development. |
Added devdoc/parts/d_op_branch_open.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | Be aware of where you are (see first definition). [para] Ensure that you have clean checkout (see second definition). It is [emph required]. [para] In most situations you want to be on branch [term trunk], and you want to be on the latest commit for it. To get there use [example { fossil pull fossil update trunk }] If some other branch is desired as the starting point for the coming work replace [term trunk] in the commands above with the name of that branch. [para] With the base line established we now have two ways of creating the new branch, with differing (dis)advantages. The simpler way is to [example { fossil branch new NAME_OF_NEW_BRANCH }] and start developing. The advantage here is that you cannot forget to create the branch. The disadvantages are that we have a branch commit unchanged from where we branched from, and that we have to use high-handed techniques like hiding or shunning to get rid of the commit should we decide to abandon the work before the first actual commit on the branch. [para] The other way of creating the branch is to start developing, and then on the first commit use the option [option --branch] to tell [syscmd fossil] that we are starting a branch now. I.e. run [example { fossil commit --branch NAME_OF_NEW_BRANCH ... }] where [term ...] are any other options used to supply the commit message, files to commit, etc. [para] The (dis)advantages are now reversed. [para] We have no superflous commit, only what is actually developed. The work is hidden until we commit to make our first commit. [para] We may forget to use [option {--branch NAME_OF_NEW_BRANCH}] and then have to correct that oversight via the fossil web interface (I am currently unaware of ways of doing such from the command line, although some magic incantantion of [cmd {fossil tag create}] may work). [para] It helps to keep awareness, like checking before any commit that we are on the desired branch. |
Added devdoc/parts/d_op_clean.inc.
> > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | Be aware of where you are (see first definition). [para] For pretty much all the operation recipes below a clean checkout is at least desired, often required. To check that a checkout is clean invoke [example { fossil changes fossil extra }] How to clean up when uncommitted changes of all sorts are found is context-specific and outside of the scope of this guide. |
Added devdoc/parts/d_testing.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | Testsuites in Tcllib are based on Tcl's standard test package [package tcltest], plus utilities found in the directory [file modules/devtools] [para] Tcllib developers invoke the suites through the [cmd {test run}] method of the [file sak.tcl] tool, with other methods of [cmd test] providing management operations, for example setting a list of standard Tcl shells to use. [comment {===================================================================}] [subsection {Invoke the testsuites of a specific module}] Invoke either [example { ./sak.tcl test run foo }] or [example { ./sak.tcl test run modules/foo }] to invoke the testsuites found in a specific module [file foo]. [comment {===================================================================}] [subsection {Invoke the testsuites of all modules}] Invoke the tool without a module name, i.e. [example { ./sak.tcl test run }] to invoke the testsuites of all modules. [comment {===================================================================}] [subsection {Detailed Test Logs}] In all the previous examples the test runner will write a combination of progress display and testsuite log to the standard output, showing for each module only the tests that passed or failed and how many of each in a summary at the end. [para] To get a detailed log, it is necessary to invoke the test runner with additional options. [para] For one: [example { ./sak.tcl test run --log LOG foo }] While this shows the same short log on the terminal as before, it also writes a detailed log to the file [file LOG.log], and excerpts to other files ([file LOG.summary], [file LOG.failures], etc.). [para] For two: [example { ./sak.tcl test run -v foo }] This writes the detailed log to the standard output, instead of the short log. [para] Regardless of form, the detailed log contains a list of all test cases executed, which failed, and how they failed (expected versus actual results). [comment {===================================================================}] [subsection {Shell Selection}] By default the test runner will use all the Tcl shells specified via [cmd {test add}] to invoke the specified testsuites, if any. If no such are specified it will fall back to the Tcl shell used to run the tool itself. [para] Use option [option --shell] to explicitly specify the Tcl shell to use, like [example { ./sak.tcl test run --shell /path/to/tclsh ... }] [comment {===================================================================}] [subsection Help] Invoke the tool as [example { ./sak.tcl help test }] to see the detailed help for all methods of [cmd test], and the associated options. |
Added devdoc/parts/d_testwrite.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | While previous sections talked about running the testsuites for a module and the packages therein, this has no meaning if the module in question has no testsuites at all. [para] This section gives a very basic overview on possible methodologies for writing tests and testsuites. [para] First there are "drudgery" tests. Written to check absolutely basic assumptions which should never fail. [para] For example for a command FOO taking two arguments, three tests calling it with zero, one, and three arguments. The basic checks that the command fails if it has not enough arguments, or too many. [para] After that come the tests checking things based on our knowledge of the command, about its properties and assumptions. Some examples based on the graph operations added during Google's Summer of Code 2009 are: [list_begin itemized] [item] The BellmanFord command in struct::graph::ops takes a [arg startnode] as argument, and this node should be a node of the graph. This equals one test case checking the behavior when the specified node is not a node of the graph. [para] This often gives rise to code in the implementation which explicitly checks the assumption and throws an understandable error, instead of letting the algorithm fail later in some weird non-deterministic way. [para] It is not always possible to do such checks. The graph argument for example is just a command in itself, and while we expect it to exhibit a certain interface, i.e. a set of sub-commands aka methods, we cannot check that it has them, except by actually trying to use them. That is done by the algorithm anyway, so an explicit check is just overhead we can get by without. [item] IIRC one of the distinguishing characteristic of either BellmanFord and/or Johnson is that they are able to handle negative weights. Whereas Dijkstra requires positive weights. [para] This induces (at least) three testcases ... Graph with all positive weights, all negative, and a mix of positive and negative weights. Thinking further does the algorithm handle the weight [const 0] as well ? Another test case, or several, if we mix zero with positive and negative weights. [item] The two algorithms we are currently thinking about are about distances between nodes, and distance can be 'Inf'inity, i.e. nodes may not be connected. This means that good test cases are [list_begin enumerated] [enum] Strongly connected graph [enum] Connected graph [enum] Disconnected graph. [list_end] [para] At the extremes of strongly connected and disconnected we have the fully connected graphs and graphs without edges, only nodes, i.e. completely disconnected. [item] IIRC both of the algorithms take weighted arcs, and fill in a default if arcs are left unweighted in the input graph. [para] This also induces three test cases: [list_begin enumerated] [enum] Graph will all arcs with explicit weights. [enum] Graph without weights at all. [enum] Graph with mixture of weighted and unweighted graphs. [list_end] [list_end] [para] What was described above via examples is called [term black-box] testing. Test cases are designed and written based on the developer's knowledge of the properties of the algorithm and its inputs, without referencing a particular implementation. [para] Going further, a complement to [term black-box] testing is [term white-box]. For this we know the implementation of the algorithm, we look at it and design our tests cases so that they force the code through all possible paths in the implementation. Wherever a decision is made we have a test case forcing a specific direction of the decision, for all possible combinations and directions. It is easy to get a combinatorial explosion in the number of needed test-cases. [para] In practice I often hope that the black-box tests I have made are enough to cover all the paths, obviating the need for white-box tests. [para] The above should be enough to make it clear that writing tests for an algorithm takes at least as much time as coding the algorithm, and often more time. Much more time. See for example also [uri http://sqlite.org/testing.html], a writeup on how the Sqlite database engine is tested. Another article of interest might be [uri https://www.researchgate.net/publication/298896236]. While geared to a particular numerical algorithm it still shows that even a simple-looking algorithm can lead to an incredible number of test cases. [para] An interesting connection is to documentation. In one direction, the properties checked with black-box testing are exactly the properties which should be documented in the algorithm's man page. And conversely, the documentation of the properties of an algorithm makes a good reference to base the black-box tests on. [para] In practice test cases and documentation often get written together, cross-influencing each other. And the actual writing of test cases is a mix of black and white box, possibly influencing the implementation while writing the tests. Like writing a test for a condition like [term {startnode not in input graph}] serving as reminder to put a check for this condition into the code. |
Added devdoc/parts/rm_distribute.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | With the release made it has to be published and the world notified of its existence. [list_begin enumerated] [enum] Create a proper fossil event for the release, via [uri http://core.tcl-lang.org/tcllib/eventedit]. [para] An [uri http://core.tcl-lang.org/tcllib/event/dac0ddcd2e990234143196b4dc438fe01e7b9817 {existing event}] should be used as template. [enum] Update a number of web locations: [list_begin enumerated] [enum] [uri http://core.tcl-lang.org/tcllib/doc/trunk/embedded/index.md {Home page}] [enum] [uri http://core.tcl-lang.org/tcllib/wiki?name=Downloads Downloads] [enum] [uri http://core.tcl-lang.org/tcllib/wiki?name=Past+Releases {Past Releases}] [enum] [uri http://www.tcl-lang.org/home/release.txt ] [enum] [uri http://www.tcl-lang.org/software/tcllib/*.tml] [enum] [uri http://wiki.tcl-lang.org/page/Tcllib] [list_end] The first location maps to the file [file embedded/index.md] in the repository itself, as such it can edited as part of the release process. This is where reference to the new fossil event is added, as the new current release. [para] The next two locations are in the fossil tcllib wiki and require admin or wiki write permissions for [uri http://core.tcl-lang.org/tcllib]. [para] The last two locations require ssh access to [uri http://www.tcl-lang.org] and permission to edit files in the web area. [enum] ***TODO*** mailing lists and other places to send notes to. [list_end] |
Added devdoc/parts/rm_final.inc.
> | 1 | todo: finalize release, make candidate official |
Added devdoc/parts/rm_start.inc.
> | 1 | todo: open a candidate for release |
Added devdoc/parts/rm_tooling.inc.
> > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | The [file sak.tcl] script in the toplevel directory of a Tcllib checkout is the one tool used by the release manager to perform its [sectref Tasks]. [para] The main commands to be used are [example { sak.tcl validate sak.tcl test run sak.tcl review sak.tcl readme sak.tcl localdoc sak.tcl release }] More detail will be provided in the explanations of the various [sectref Tasks]. |
Added devdoc/parts/rm_work.inc.
> > > > > > > | 1 2 3 4 5 6 7 | todo: test, validate and check that the candidate is worthy of release fix testsuites, possibly fix packages, documentation regenerate docs coordinate with package maintainers wrt fixes big thing: going over the packages, classify changes since last release to generate a nice readme. |
Added devdoc/parts/rq_critcl.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [subsection Critcl] The [syscmd critcl] tool is an [emph 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 looks for it in the [variable PATH], using the name [syscmd critcl]. This is for Unix. On Windows on the other hand the search is more complex. First we look for a proper application [syscmd critcl.exe]. When that is not found we look for a combination of interpreter ([syscmd tclkitsh.exe], [syscmd tclsh.exe]) and starkit ([syscmd critcl.kit], [syscmd critcl]) instead. [emph Note] that the choice of starkit can be overriden via the environment variable [variable CRITCL]. [para] Tcllib requires Critcl 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 these directions please file a ticket against the [term Critcl] project, and not Tcllib. |
Added devdoc/parts/rq_tcl.inc.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [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 possibilities use whatever you are comfortable with, as long as it provides at the very least 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] [emph 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 [emph {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 [emph not] [term Tcllib]. |
Added devdoc/parts/welcome.inc.
> > > > > > | 1 2 3 4 5 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. |
Deleted devdoc/releaseguide.html.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Added devdoc/tcl_community_communication.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [comment {-*- tcl -*- doctools manpage}] [manpage_begin tcl_community_communication n 1] [titledesc {Tcl Community - Kind Communication}] [description] The Tcl Community encourages contributions from anyone who wishes to advance the development of: [list_begin itemized] [item] The Tcl Language [item] Tcl derived languages [item] Tcl related libraries [item] Tcl extensions [item] External Projects that Integrate Tcl [list_end] [para] We welcome those contributions from anyone. We are blind to gender, race, religion, cultural background, cybernetic nature, and any other demographic characteristics, as well as personal political views. [para] A community lives and dies by communications. And occasionally our communications are peppered with patterns that are harsh, unfriendly, unwelcoming and/or otherwise unkind. As a volunteer community, we need all of the help we can get. Therefore, we ask all contributors to make a conscious effort, in Tcl Community discussions, to communicate in ways that are welcoming. Ways that are friendly. Ways that are, in a word: kind. [para] These guidelines suggest specific ways to accomplish that goal. [para] Please note: for the balance of this document any reference to "People", "Persons", "anybody" or "somebody" can refer to any sentient being, not merely corporeal members of the species Homo Sapien. [list_begin definitions] [def {We are a Sanctuary not a Clubhouse}] The Tcl Community is a collective of amateurs and professionals who code, test, and use tools. Our community is open to all. There is no velvet rope. There is no bouncer at the door. There are no secret handshakes. Any sentient being who enters our midst is welcome. If someone is ever asked to leave, it is only because they are being disruptive to the functioning of the community. [def {We Merit Ideas, Not People}] A good idea can come from anyone, regardless of how little time they have been with us. A bad idea can come from anyone, regardless of how much time or how little time they have been with us. We judge a concept by how it stands up to scrutiny of logic, implementation, and regression testing. We don’t judge ideas based on who had the idea first, who agrees with the idea, or who disagrees with it. [def {Treat Everyone with Respect}] Everyone is deserving of respect and courtesy at all times. [def {Refer to people by the names they use.}] If grammar requires you to state a gender for a person, honor their preferences about their gender identity. If you are unsure as to the gender of an individual, ask. If someone had to guess about your gender and got it wrong, please correct them and do not take it personally. [def {Do not take a harsh tone towards other participants.}] Do not make personal attacks against anyone (participant or not.) [para] Criticize statements and actions, never people. [def {Don’t Take Things Personally}] When in doubt, assume the best in people. A criticism of your statements is not a personal attack on you. [def {Persons, not People}] Stereotypes are an unhelpful tool on many accounts. They are generally oversimplified. They are usually flat out wrong. And even if "right" they are of absolutely no utility in determining the capabilities, motivations, or fitness of an individual. [para] Don’t use them in Tcl Community communications. [def {Mistakes Happen}] The human condition is a series of trials and errors. Progress is when we get one more trial than error. Being wrong or making a mistake is the default state of humanity. Accept the errors of your fellow sentient beings, and be aware that you are also fallible. [def {Keep it Real}] Please respond to what people actually say. We are all amazing individuals, but none among us are mind readers. If you find yourself responding to what you imagine someone is thinking, odds are you are going to be wrong. [para] If you must criticize someone, stick to things they have actually done. Never criticize for something you speculate they have done. Or imagine they have done. Or something someone who shares some attribute with them has done in the past. [para] Keep discussions about any non-Tcl subjects to what can be stated factually and without emotion or judgement. [def {When Trouble Arises, Don’t Escalate}] If you feel you are being personally attacked or offended, take the high road. Punching back in a public forum will only makes things worse. Address the matter in a private correspondence. Be polite. Express your feelings, but note that you are expressing your feelings. When writing, look for a way to calm matters down. And when in doubt, sleep on your letter before pressing send. And when not in doubt, sleep on it for another day after that. [para] If you are a spectator to a fight in progress, politely request the two parties take the matter to a more private forum. [def {Always get the Last Word: I’m Sorry}] If an personal argument does arise, be the first to apologize. An apology does not concede a logical point. It merely acknowledges that at some point the discussion left either logic, community decency, or both. Return to the topic when cooler heads can prevail. [def {Nobody is Keeping Score}] There is no prize for being right. There is no cost for being wrong. A hard sell is not going to advance your idea along any more than a logical argument. You aren’t running for office. This isn’t debate club. If you find yourself continuing a discussion beyond where a topic can be logically discussed, stop. [def {No Evangelizing}] The Tcl Community is not the place to promote your chosen operating system, political outlook, religion, marketing scheme, or economic model. Period. [para] (And if you do bring it up, be prepared to have your chosen topic discussed logically. And odds are, not favorably.) [def {Respect the Community}] If the Community has come to a decision on a course of action, please stop arguing. [para] If someone complains about how you are expressing your ideas, listen. [para] If your words are hurting people, stop. There is no amount of being "right" that makes up for someone leaving our midst because they felt insulted, threatened, or ignored. [list_end] By following these guidelines, we will build our community, encourage more contribution to our projects, and our discussions will be friendlier and reach conclusions more easily. [para] Thank You. [section Signatories] [list_begin itemized] [item] Sean "the Hypnotoad" Woods [item] Andreas Kupries [list_end] [section Authors] [list_begin definitions] [def Primary] Sean "the Hypnotoad" Woods [def {Light editing}] Andreas Kupries [list_end] [manpage_end] |
Added devdoc/tcllib_devguide.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [comment {-*- tcl -*- doctools manpage}] [manpage_begin tcllib_devguide n 1] [titledesc {Tcllib - The Developer's Guide}] [description] [include parts/welcome.inc] [para] This document is a guide for developers working on Tcllib, i.e. maintainers fixing bugs, extending the collection's functionality, etc. [para] Please read [list_begin enum] [enum] [term {Tcllib - How To Get The Sources}] and [enum] [term {Tcllib - The Installer's Guide}] [list_end] first, if that was not done already. [para] Here we assume that the sources are already available in a directory of your choice, and that you not only know how to build and install them, but also have all the necessary requisites to actually do so. The guide to the sources in particular also explains which source code management system is used, where to find it, how to set it up, etc. [comment {===================================================================}] [section Commitments] [subsection Contributor][include parts/d_contrib.inc] [subsection Maintainer][include parts/d_maintain.inc] [comment {===================================================================}] [section {Branching and Workflow}] [include parts/d_branchflow.inc] [comment {===================================================================}] [section {Structural Overview}] [include parts/d_dirlayout.inc] [comment {===================================================================}] [section {Testsuite Tooling}] [include parts/d_testing.inc] [comment {===================================================================}] [section {Documentation Tooling}] [include parts/d_documentation.inc] [comment {===================================================================}] [section {Notes On Writing A Testsuite}] [include parts/d_testwrite.inc] [comment {===================================================================}] [section {Installation Tooling}] [include parts/d_installation.inc] [comment {===================================================================}] [manpage_end] |
Added devdoc/tcllib_installer.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [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 and install the packages found in Tcllib, for either themselves, or others. [para] For developers intending to work on the packages themselves 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}] As Tcllib is mainly a bundle of packages written in pure Tcl building it is the same as installing it. The exceptions to this have their own subsection, [sectref {Critcl & Accelerators}], later on. [para] Before that however comes the standard case, differentiated by the platforms with material differences in the instruction, i.e. [term Unix]-like, versus [term Windows]. [para] Regarding the latter it should also be noted that it is possible set up an [term Unix]-like environment using projects like [term MSYS], [term Cygwin], and others. In that case the user has the choice of which instructions to follow. [para] Regardless of environment or platform, a suitable [term Tcl] has to be installed, and its [syscmd tclsh] should be placed on the [variable PATH] ([term Unix]) or associated with [file .tcl] files ([term Windows]). [comment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%] [subsection {Installing on Unix}] [include parts/b_unix.inc] [comment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%] [subsection {Installing on Windows}] [include parts/b_windows.inc] [comment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%] [subsection {Critcl & Accelerators}] [include parts/b_critcl.inc] [comment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%] [subsection Tooling] [include parts/b_tooling.inc] [manpage_end] |
Added devdoc/tcllib_license.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [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_releasemgr.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [comment {-*- tcl -*- doctools manpage}] [manpage_begin tcllib_releasemgr n 1] [titledesc {Tcllib - The Release Manager's Guide}] [description] [include parts/welcome.inc] [para] The audience of this document is the release manager for Tcllib, their deputies, and anybody else interested in the task of creating an official release of Tcllib for distribution. [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 Tools] [include parts/rm_tooling.inc] [comment {===================================================================}] [section Tasks] [comment {===================================================================}] [subsection {Start a release candidate}] [include parts/rm_start.inc] [comment {===================================================================}] [subsection {Ready the candidate}] [include parts/rm_work.inc] [comment {===================================================================}] [subsection {Make it official}] [include parts/rm_final.inc] [comment {===================================================================}] [subsection {Distribute the release}] [include parts/rm_distribute.inc] [manpage_end] |
Added devdoc/tcllib_sources.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [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. [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] |
Changes to embedded/index.md.
1 2 3 4 5 | <div class='fossil-doc' data-title='Tcl Library Source Code'> <h1 align="center">Tcl Library Source Code</h1> <center> | < | > | > > > > > > > > > | 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 | <div class='fossil-doc' data-title='Tcl Library Source Code'> <h1 align="center">Tcl Library Source Code</h1> <center> Packages - [Table Of Contents](md/toc.md) [Keyword Index](md/index.md) </center> <center> <form action='../../../docsrch' method='GET'> <input type="text" name="s" size="40" autofocus> <input type="submit" value="Search Package Documentation"> </form> </center> ## Guides to Tcllib * [Tcl Community - Kind Communication](md/tcllib/files/devdoc/tcl_community_communication.md) * [License](md/tcllib/files/devdoc/tcllib_license.md) * [How To Get The Sources](md/tcllib/files/devdoc/tcllib_sources.md) * [How To Build And Install Tcllib](md/tcllib/files/devdoc/tcllib_installer.md) * [The Developer's Guide](md/tcllib/files/devdoc/tcllib_devguide.md) * [The Release Manager's Guide](md/tcllib/files/devdoc/tcllib_releasemgr.md) ## Discussion & Contact Tcllib has two [mailing lists](https://sourceforge.net/p/tcllib/mailman/). One for notifications (commits, ticket changes), the other for general discussion. These are managed at SourceForge, at the aforementioned |
︙ | ︙ |
Changes to embedded/md/index.md.
︙ | ︙ | |||
392 393 394 395 396 397 398 | |<a name='hex'></a>hex|[base32::hex](tcllib/files/modules/base32/base32hex\.md)| |<a name='hexadecimal'></a>hexadecimal|[tcl::transform::hex](tcllib/files/modules/virtchannel\_transform/hex\.md)| |<a name='histogram'></a>histogram|[counter](tcllib/files/modules/counter/counter\.md)| |<a name='hook'></a>hook|[hook](tcllib/files/modules/hook/hook\.md) · [uevent](tcllib/files/modules/uev/uevent\.md)| |<a name='horspool'></a>horspool|[grammar::aycock](tcllib/files/modules/grammar\_aycock/aycock\.md)| |<a name='html'></a>HTML|[doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools::html::cssdefaults](tcllib/files/modules/doctools2base/html\_cssdefaults\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::export::html](tcllib/files/modules/doctools2idx/idx\_export\_html\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::export::html](tcllib/files/modules/doctools2toc/toc\_export\_html\.md) · [dtplite](tcllib/files/modules/dtplite/pkg\_dtplite\.md) · [dtplite](tcllib/files/apps/dtplite\.md) · [mpexpand](tcllib/files/modules/doctools/mpexpand\.md)| |<a name='html'></a>html|[html](tcllib/files/modules/html/html\.md) · [htmlparse](tcllib/files/modules/htmlparse/htmlparse\.md) · [javascript](tcllib/files/modules/javascript/javascript\.md) · [ncgi](tcllib/files/modules/ncgi/ncgi\.md)| | | | | | 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 | |<a name='hex'></a>hex|[base32::hex](tcllib/files/modules/base32/base32hex\.md)| |<a name='hexadecimal'></a>hexadecimal|[tcl::transform::hex](tcllib/files/modules/virtchannel\_transform/hex\.md)| |<a name='histogram'></a>histogram|[counter](tcllib/files/modules/counter/counter\.md)| |<a name='hook'></a>hook|[hook](tcllib/files/modules/hook/hook\.md) · [uevent](tcllib/files/modules/uev/uevent\.md)| |<a name='horspool'></a>horspool|[grammar::aycock](tcllib/files/modules/grammar\_aycock/aycock\.md)| |<a name='html'></a>HTML|[doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools::html::cssdefaults](tcllib/files/modules/doctools2base/html\_cssdefaults\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::export::html](tcllib/files/modules/doctools2idx/idx\_export\_html\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::export::html](tcllib/files/modules/doctools2toc/toc\_export\_html\.md) · [dtplite](tcllib/files/modules/dtplite/pkg\_dtplite\.md) · [dtplite](tcllib/files/apps/dtplite\.md) · [mpexpand](tcllib/files/modules/doctools/mpexpand\.md)| |<a name='html'></a>html|[html](tcllib/files/modules/html/html\.md) · [htmlparse](tcllib/files/modules/htmlparse/htmlparse\.md) · [javascript](tcllib/files/modules/javascript/javascript\.md) · [ncgi](tcllib/files/modules/ncgi/ncgi\.md)| |<a name='http'></a>http|[autoproxy](tcllib/files/modules/http/autoproxy\.md) · [httpd](tcllib/files/modules/httpd/httpd\.md) · [map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) · [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) · [uri](tcllib/files/modules/uri/uri\.md) · [websocket](tcllib/files/modules/websocket/websocket\.md)| |<a name='httpd'></a>httpd|[httpd](tcllib/files/modules/httpd/httpd\.md)| |<a name='https'></a>https|[uri](tcllib/files/modules/uri/uri\.md)| |<a name='httpserver'></a>httpserver|[httpd](tcllib/files/modules/httpd/httpd\.md)| |<a name='huddle'></a>huddle|[huddle](tcllib/files/modules/yaml/huddle\.md) · [yaml](tcllib/files/modules/yaml/yaml\.md)| |<a name='human\_readable'></a>human readable|[bench::in](tcllib/files/modules/bench/bench\_read\.md) · [bench::out::text](tcllib/files/modules/bench/bench\_wtext\.md)| |<a name='hyphenation'></a>hyphenation|[textutil](tcllib/files/modules/textutil/textutil\.md) · [textutil::adjust](tcllib/files/modules/textutil/adjust\.md)| #### <a name='cI'></a>Keywords: I |
︙ | ︙ | |||
529 530 531 532 533 534 535 | |<a name='manpage'></a>manpage|[doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::import](tcllib/files/modules/doctools2idx/idx\_import\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::import](tcllib/files/modules/doctools2toc/toc\_import\.md) · [doctools\_plugin\_apiref](tcllib/files/modules/doctools/doctools\_plugin\_apiref\.md) · [dtplite](tcllib/files/modules/dtplite/pkg\_dtplite\.md) · [dtplite](tcllib/files/apps/dtplite\.md) · [mpexpand](tcllib/files/modules/doctools/mpexpand\.md)| |<a name='map'></a>map|[generator](tcllib/files/modules/generator/generator\.md) · [map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) · [map::slippy](tcllib/files/modules/map/map\_slippy\.md) · [map::slippy::cache](tcllib/files/modules/map/map\_slippy\_cache\.md) · [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) · [mapproj](tcllib/files/modules/mapproj/mapproj\.md) · [struct::list](tcllib/files/modules/struct/struct\_list\.md)| |<a name='markdown'></a>markdown|[doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md)| |<a name='markup'></a>markup|[docidx\_intro](tcllib/files/modules/doctools/docidx\_intro\.md) · [docidx\_lang\_cmdref](tcllib/files/modules/doctools/docidx\_lang\_cmdref\.md) · [docidx\_lang\_faq](tcllib/files/modules/doctools/docidx\_lang\_faq\.md) · [docidx\_lang\_intro](tcllib/files/modules/doctools/docidx\_lang\_intro\.md) · [docidx\_lang\_syntax](tcllib/files/modules/doctools/docidx\_lang\_syntax\.md) · [docidx\_plugin\_apiref](tcllib/files/modules/doctools/docidx\_plugin\_apiref\.md) · [doctoc\_intro](tcllib/files/modules/doctools/doctoc\_intro\.md) · [doctoc\_lang\_cmdref](tcllib/files/modules/doctools/doctoc\_lang\_cmdref\.md) · [doctoc\_lang\_faq](tcllib/files/modules/doctools/doctoc\_lang\_faq\.md) · [doctoc\_lang\_intro](tcllib/files/modules/doctools/doctoc\_lang\_intro\.md) · [doctoc\_lang\_syntax](tcllib/files/modules/doctools/doctoc\_lang\_syntax\.md) · [doctoc\_plugin\_apiref](tcllib/files/modules/doctools/doctoc\_plugin\_apiref\.md) · [doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools2idx\_introduction](tcllib/files/modules/doctools2idx/idx\_introduction\.md) · [doctools2toc\_introduction](tcllib/files/modules/doctools2toc/toc\_introduction\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::import](tcllib/files/modules/doctools2idx/idx\_import\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::import](tcllib/files/modules/doctools2toc/toc\_import\.md) · [doctools\_intro](tcllib/files/modules/doctools/doctools\_intro\.md) · [doctools\_lang\_cmdref](tcllib/files/modules/doctools/doctools\_lang\_cmdref\.md) · [doctools\_lang\_faq](tcllib/files/modules/doctools/doctools\_lang\_faq\.md) · [doctools\_lang\_intro](tcllib/files/modules/doctools/doctools\_lang\_intro\.md) · [doctools\_lang\_syntax](tcllib/files/modules/doctools/doctools\_lang\_syntax\.md) · [doctools\_plugin\_apiref](tcllib/files/modules/doctools/doctools\_plugin\_apiref\.md) · [dtplite](tcllib/files/modules/dtplite/pkg\_dtplite\.md) · [dtplite](tcllib/files/apps/dtplite\.md) · [mpexpand](tcllib/files/modules/doctools/mpexpand\.md) · [tcldocstrip](tcllib/files/apps/tcldocstrip\.md)| |<a name='mastercard'></a>MasterCard|[valtype::creditcard::mastercard](tcllib/files/modules/valtype/cc\_mastercard\.md)| |<a name='matching'></a>matching|[grammar::me\_intro](tcllib/files/modules/grammar\_me/me\_intro\.md) · [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) · [pt](tcllib/files/apps/pt\.md) · [pt::ast](tcllib/files/modules/pt/pt\_astree\.md) · [pt::cparam::configuration::critcl](tcllib/files/modules/pt/pt\_cparam\_config\_critcl\.md) · [pt::cparam::configuration::tea](tcllib/files/modules/pt/pt\_cparam\_config\_tea\.md) · [pt::json\_language](tcllib/files/modules/pt/pt\_json\_language\.md) · [pt::param](tcllib/files/modules/pt/pt\_param\.md) · [pt::pe](tcllib/files/modules/pt/pt\_pexpression\.md) · [pt::pe::op](tcllib/files/modules/pt/pt\_pexpr\_op\.md) · [pt::peg](tcllib/files/modules/pt/pt\_pegrammar\.md) · [pt::peg::container](tcllib/files/modules/pt/pt\_peg\_container\.md) · [pt::peg::container::peg](tcllib/files/modules/pt/pt\_peg\_container\_peg\.md) · [pt::peg::export](tcllib/files/modules/pt/pt\_peg\_export\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::container](tcllib/files/modules/pt/pt\_peg\_from\_container\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import](tcllib/files/modules/pt/pt\_peg\_import\.md) · [pt::peg::import::container](tcllib/files/modules/pt/pt\_peg\_import\_container\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::interp](tcllib/files/modules/pt/pt\_peg\_interp\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [pt::peg\_language](tcllib/files/modules/pt/pt\_peg\_language\.md) · [pt::pegrammar](tcllib/files/modules/pt/pt\_peg\_introduction\.md) · [pt::pgen](tcllib/files/modules/pt/pt\_pgen\.md) · [pt::rde](tcllib/files/modules/pt/pt\_rdengine\.md) · [pt::tclparam::configuration::nx](tcllib/files/modules/pt/pt\_tclparam\_config\_nx\.md) · [pt::tclparam::configuration::snit](tcllib/files/modules/pt/pt\_tclparam\_config\_snit\.md) · [pt::tclparam::configuration::tcloo](tcllib/files/modules/pt/pt\_tclparam\_config\_tcloo\.md) · [pt::util](tcllib/files/modules/pt/pt\_util\.md) · [pt\_export\_api](tcllib/files/modules/pt/pt\_to\_api\.md) · [pt\_import\_api](tcllib/files/modules/pt/pt\_from\_api\.md) · [pt\_introduction](tcllib/files/modules/pt/pt\_introduction\.md) · [pt\_parse\_peg](tcllib/files/modules/pt/pt\_parse\_peg\.md) · [pt\_parser\_api](tcllib/files/modules/pt/pt\_parser\_api\.md) · [pt\_peg\_op](tcllib/files/modules/pt/pt\_peg\_op\.md) · [struct::graph::op](tcllib/files/modules/struct/graphops\.md)| |<a name='math'></a>math|[math](tcllib/files/modules/math/math\.md) · [math::bigfloat](tcllib/files/modules/math/bigfloat\.md) · [math::bignum](tcllib/files/modules/math/bignum\.md) · [math::calculus](tcllib/files/modules/math/calculus\.md) · [math::complexnumbers](tcllib/files/modules/math/qcomplex\.md) · [math::constants](tcllib/files/modules/math/constants\.md) · [math::decimal](tcllib/files/modules/math/decimal\.md) · [math::fuzzy](tcllib/files/modules/math/fuzzy\.md) · [math::geometry](tcllib/files/modules/math/math\_geometry\.md) · [math::interpolate](tcllib/files/modules/math/interpolate\.md) · [math::linearalgebra](tcllib/files/modules/math/linalg\.md) · [math::optimize](tcllib/files/modules/math/optimize\.md) · [math::PCA](tcllib/files/modules/math/pca\.md) · [math::polynomials](tcllib/files/modules/math/polynomials\.md) · [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) · [math::special](tcllib/files/modules/math/special\.md) · [math::trig](tcllib/files/modules/math/trig\.md) · [simulation::annealing](tcllib/files/modules/simulation/annealing\.md) · [simulation::montecarlo](tcllib/files/modules/simulation/montecarlo\.md) · [simulation::random](tcllib/files/modules/simulation/simulation\_random\.md)| | | | 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 | |<a name='manpage'></a>manpage|[doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::import](tcllib/files/modules/doctools2idx/idx\_import\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::import](tcllib/files/modules/doctools2toc/toc\_import\.md) · [doctools\_plugin\_apiref](tcllib/files/modules/doctools/doctools\_plugin\_apiref\.md) · [dtplite](tcllib/files/modules/dtplite/pkg\_dtplite\.md) · [dtplite](tcllib/files/apps/dtplite\.md) · [mpexpand](tcllib/files/modules/doctools/mpexpand\.md)| |<a name='map'></a>map|[generator](tcllib/files/modules/generator/generator\.md) · [map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) · [map::slippy](tcllib/files/modules/map/map\_slippy\.md) · [map::slippy::cache](tcllib/files/modules/map/map\_slippy\_cache\.md) · [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) · [mapproj](tcllib/files/modules/mapproj/mapproj\.md) · [struct::list](tcllib/files/modules/struct/struct\_list\.md)| |<a name='markdown'></a>markdown|[doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md)| |<a name='markup'></a>markup|[docidx\_intro](tcllib/files/modules/doctools/docidx\_intro\.md) · [docidx\_lang\_cmdref](tcllib/files/modules/doctools/docidx\_lang\_cmdref\.md) · [docidx\_lang\_faq](tcllib/files/modules/doctools/docidx\_lang\_faq\.md) · [docidx\_lang\_intro](tcllib/files/modules/doctools/docidx\_lang\_intro\.md) · [docidx\_lang\_syntax](tcllib/files/modules/doctools/docidx\_lang\_syntax\.md) · [docidx\_plugin\_apiref](tcllib/files/modules/doctools/docidx\_plugin\_apiref\.md) · [doctoc\_intro](tcllib/files/modules/doctools/doctoc\_intro\.md) · [doctoc\_lang\_cmdref](tcllib/files/modules/doctools/doctoc\_lang\_cmdref\.md) · [doctoc\_lang\_faq](tcllib/files/modules/doctools/doctoc\_lang\_faq\.md) · [doctoc\_lang\_intro](tcllib/files/modules/doctools/doctoc\_lang\_intro\.md) · [doctoc\_lang\_syntax](tcllib/files/modules/doctools/doctoc\_lang\_syntax\.md) · [doctoc\_plugin\_apiref](tcllib/files/modules/doctools/doctoc\_plugin\_apiref\.md) · [doctools](tcllib/files/modules/doctools/doctools\.md) · [doctools2idx\_introduction](tcllib/files/modules/doctools2idx/idx\_introduction\.md) · [doctools2toc\_introduction](tcllib/files/modules/doctools2toc/toc\_introduction\.md) · [doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::import](tcllib/files/modules/doctools2idx/idx\_import\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::import](tcllib/files/modules/doctools2toc/toc\_import\.md) · [doctools\_intro](tcllib/files/modules/doctools/doctools\_intro\.md) · [doctools\_lang\_cmdref](tcllib/files/modules/doctools/doctools\_lang\_cmdref\.md) · [doctools\_lang\_faq](tcllib/files/modules/doctools/doctools\_lang\_faq\.md) · [doctools\_lang\_intro](tcllib/files/modules/doctools/doctools\_lang\_intro\.md) · [doctools\_lang\_syntax](tcllib/files/modules/doctools/doctools\_lang\_syntax\.md) · [doctools\_plugin\_apiref](tcllib/files/modules/doctools/doctools\_plugin\_apiref\.md) · [dtplite](tcllib/files/modules/dtplite/pkg\_dtplite\.md) · [dtplite](tcllib/files/apps/dtplite\.md) · [mpexpand](tcllib/files/modules/doctools/mpexpand\.md) · [tcldocstrip](tcllib/files/apps/tcldocstrip\.md)| |<a name='mastercard'></a>MasterCard|[valtype::creditcard::mastercard](tcllib/files/modules/valtype/cc\_mastercard\.md)| |<a name='matching'></a>matching|[grammar::me\_intro](tcllib/files/modules/grammar\_me/me\_intro\.md) · [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) · [pt](tcllib/files/apps/pt\.md) · [pt::ast](tcllib/files/modules/pt/pt\_astree\.md) · [pt::cparam::configuration::critcl](tcllib/files/modules/pt/pt\_cparam\_config\_critcl\.md) · [pt::cparam::configuration::tea](tcllib/files/modules/pt/pt\_cparam\_config\_tea\.md) · [pt::json\_language](tcllib/files/modules/pt/pt\_json\_language\.md) · [pt::param](tcllib/files/modules/pt/pt\_param\.md) · [pt::pe](tcllib/files/modules/pt/pt\_pexpression\.md) · [pt::pe::op](tcllib/files/modules/pt/pt\_pexpr\_op\.md) · [pt::peg](tcllib/files/modules/pt/pt\_pegrammar\.md) · [pt::peg::container](tcllib/files/modules/pt/pt\_peg\_container\.md) · [pt::peg::container::peg](tcllib/files/modules/pt/pt\_peg\_container\_peg\.md) · [pt::peg::export](tcllib/files/modules/pt/pt\_peg\_export\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::container](tcllib/files/modules/pt/pt\_peg\_from\_container\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import](tcllib/files/modules/pt/pt\_peg\_import\.md) · [pt::peg::import::container](tcllib/files/modules/pt/pt\_peg\_import\_container\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::interp](tcllib/files/modules/pt/pt\_peg\_interp\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [pt::peg\_language](tcllib/files/modules/pt/pt\_peg\_language\.md) · [pt::pegrammar](tcllib/files/modules/pt/pt\_peg\_introduction\.md) · [pt::pgen](tcllib/files/modules/pt/pt\_pgen\.md) · [pt::rde](tcllib/files/modules/pt/pt\_rdengine\.md) · [pt::tclparam::configuration::nx](tcllib/files/modules/pt/pt\_tclparam\_config\_nx\.md) · [pt::tclparam::configuration::snit](tcllib/files/modules/pt/pt\_tclparam\_config\_snit\.md) · [pt::tclparam::configuration::tcloo](tcllib/files/modules/pt/pt\_tclparam\_config\_tcloo\.md) · [pt::util](tcllib/files/modules/pt/pt\_util\.md) · [pt\_export\_api](tcllib/files/modules/pt/pt\_to\_api\.md) · [pt\_import\_api](tcllib/files/modules/pt/pt\_from\_api\.md) · [pt\_introduction](tcllib/files/modules/pt/pt\_introduction\.md) · [pt\_parse\_peg](tcllib/files/modules/pt/pt\_parse\_peg\.md) · [pt\_parser\_api](tcllib/files/modules/pt/pt\_parser\_api\.md) · [pt\_peg\_op](tcllib/files/modules/pt/pt\_peg\_op\.md) · [struct::graph::op](tcllib/files/modules/struct/graphops\.md)| |<a name='math'></a>math|[math](tcllib/files/modules/math/math\.md) · [math::bigfloat](tcllib/files/modules/math/bigfloat\.md) · [math::bignum](tcllib/files/modules/math/bignum\.md) · [math::calculus](tcllib/files/modules/math/calculus\.md) · [math::complexnumbers](tcllib/files/modules/math/qcomplex\.md) · [math::constants](tcllib/files/modules/math/constants\.md) · [math::decimal](tcllib/files/modules/math/decimal\.md) · [math::fuzzy](tcllib/files/modules/math/fuzzy\.md) · [math::geometry](tcllib/files/modules/math/math\_geometry\.md) · [math::interpolate](tcllib/files/modules/math/interpolate\.md) · [math::linearalgebra](tcllib/files/modules/math/linalg\.md) · [math::optimize](tcllib/files/modules/math/optimize\.md) · [math::PCA](tcllib/files/modules/math/pca\.md) · [math::polynomials](tcllib/files/modules/math/polynomials\.md) · [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) · [math::special](tcllib/files/modules/math/special\.md) · [math::trig](tcllib/files/modules/math/trig\.md) · [simulation::annealing](tcllib/files/modules/simulation/annealing\.md) · [simulation::montecarlo](tcllib/files/modules/simulation/montecarlo\.md) · [simulation::random](tcllib/files/modules/simulation/simulation\_random\.md)| |<a name='mathematics'></a>mathematics|[math::fourier](tcllib/files/modules/math/fourier\.md) · [math::quasirandom](tcllib/files/modules/math/quasirandom\.md) · [math::statistics](tcllib/files/modules/math/statistics\.md)| |<a name='matrices'></a>matrices|[math::linearalgebra](tcllib/files/modules/math/linalg\.md)| |<a name='matrix'></a>matrix|[csv](tcllib/files/modules/csv/csv\.md) · [math::linearalgebra](tcllib/files/modules/math/linalg\.md) · [report](tcllib/files/modules/report/report\.md) · [struct::matrix](tcllib/files/modules/struct/matrix\.md) · [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) · [struct::queue](tcllib/files/modules/struct/queue\.md) · [struct::stack](tcllib/files/modules/struct/stack\.md)| |<a name='max\_cut'></a>max cut|[struct::graph::op](tcllib/files/modules/struct/graphops\.md)| |<a name='maximum'></a>maximum|[math::optimize](tcllib/files/modules/math/optimize\.md)| |<a name='maximum\_flow'></a>maximum flow|[struct::graph::op](tcllib/files/modules/struct/graphops\.md)| |<a name='md4'></a>md4|[md4](tcllib/files/modules/md4/md4\.md) · [ripemd128](tcllib/files/modules/ripemd/ripemd128\.md) · [ripemd160](tcllib/files/modules/ripemd/ripemd160\.md)| |<a name='md5'></a>md5|[md5](tcllib/files/modules/md5/md5\.md) · [md5crypt](tcllib/files/modules/md5crypt/md5crypt\.md)| |
︙ | ︙ | |||
610 611 612 613 614 615 616 617 618 619 620 621 622 623 | |<a name='oauth'></a>oauth|[oauth](tcllib/files/modules/oauth/oauth\.md)| |<a name='object'></a>object|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md) · [stooop](tcllib/files/modules/stooop/stooop\.md) · [switched](tcllib/files/modules/stooop/switched\.md)| |<a name='object\_oriented'></a>object oriented|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md) · [stooop](tcllib/files/modules/stooop/stooop\.md) · [switched](tcllib/files/modules/stooop/switched\.md)| |<a name='observer'></a>observer|[hook](tcllib/files/modules/hook/hook\.md) · [tcl::transform::observe](tcllib/files/modules/virtchannel\_transform/observe\.md)| |<a name='odie'></a>odie|[cron](tcllib/files/modules/cron/cron\.md) · [nettool](tcllib/files/modules/nettool/nettool\.md) · [processman](tcllib/files/modules/processman/processman\.md)| |<a name='on\_idle'></a>on\-idle|[uevent::onidle](tcllib/files/modules/uev/uevent\_onidle\.md)| |<a name='one\_time\_pad'></a>one time pad|[tcl::transform::otp](tcllib/files/modules/virtchannel\_transform/vt\_otp\.md)| |<a name='optimization'></a>optimization|[math::optimize](tcllib/files/modules/math/optimize\.md) · [simulation::annealing](tcllib/files/modules/simulation/annealing\.md)| |<a name='ordered\_list'></a>ordered list|[struct::prioqueue](tcllib/files/modules/struct/prioqueue\.md)| |<a name='otp'></a>otp|[tcl::transform::otp](tcllib/files/modules/virtchannel\_transform/vt\_otp\.md)| |<a name='outer\_join'></a>outer join|[struct::list](tcllib/files/modules/struct/struct\_list\.md)| #### <a name='cP'></a>Keywords: P | > | 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 | |<a name='oauth'></a>oauth|[oauth](tcllib/files/modules/oauth/oauth\.md)| |<a name='object'></a>object|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md) · [stooop](tcllib/files/modules/stooop/stooop\.md) · [switched](tcllib/files/modules/stooop/switched\.md)| |<a name='object\_oriented'></a>object oriented|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md) · [stooop](tcllib/files/modules/stooop/stooop\.md) · [switched](tcllib/files/modules/stooop/switched\.md)| |<a name='observer'></a>observer|[hook](tcllib/files/modules/hook/hook\.md) · [tcl::transform::observe](tcllib/files/modules/virtchannel\_transform/observe\.md)| |<a name='odie'></a>odie|[cron](tcllib/files/modules/cron/cron\.md) · [nettool](tcllib/files/modules/nettool/nettool\.md) · [processman](tcllib/files/modules/processman/processman\.md)| |<a name='on\_idle'></a>on\-idle|[uevent::onidle](tcllib/files/modules/uev/uevent\_onidle\.md)| |<a name='one\_time\_pad'></a>one time pad|[tcl::transform::otp](tcllib/files/modules/virtchannel\_transform/vt\_otp\.md)| |<a name='oo'></a>oo|[clay](tcllib/files/modules/clay/clay\.md)| |<a name='optimization'></a>optimization|[math::optimize](tcllib/files/modules/math/optimize\.md) · [simulation::annealing](tcllib/files/modules/simulation/annealing\.md)| |<a name='ordered\_list'></a>ordered list|[struct::prioqueue](tcllib/files/modules/struct/prioqueue\.md)| |<a name='otp'></a>otp|[tcl::transform::otp](tcllib/files/modules/virtchannel\_transform/vt\_otp\.md)| |<a name='outer\_join'></a>outer join|[struct::list](tcllib/files/modules/struct/struct\_list\.md)| #### <a name='cP'></a>Keywords: P |
︙ | ︙ | |||
683 684 685 686 687 688 689 690 691 692 693 694 695 696 | |<a name='push\_down\_automaton'></a>push down automaton|[grammar::me\_intro](tcllib/files/modules/grammar\_me/me\_intro\.md) · [grammar::peg](tcllib/files/modules/grammar\_peg/peg\.md) · [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) · [pt](tcllib/files/apps/pt\.md) · [pt::ast](tcllib/files/modules/pt/pt\_astree\.md) · [pt::cparam::configuration::critcl](tcllib/files/modules/pt/pt\_cparam\_config\_critcl\.md) · [pt::cparam::configuration::tea](tcllib/files/modules/pt/pt\_cparam\_config\_tea\.md) · [pt::json\_language](tcllib/files/modules/pt/pt\_json\_language\.md) · [pt::param](tcllib/files/modules/pt/pt\_param\.md) · [pt::pe](tcllib/files/modules/pt/pt\_pexpression\.md) · [pt::pe::op](tcllib/files/modules/pt/pt\_pexpr\_op\.md) · [pt::peg](tcllib/files/modules/pt/pt\_pegrammar\.md) · [pt::peg::container](tcllib/files/modules/pt/pt\_peg\_container\.md) · [pt::peg::container::peg](tcllib/files/modules/pt/pt\_peg\_container\_peg\.md) · [pt::peg::export](tcllib/files/modules/pt/pt\_peg\_export\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::container](tcllib/files/modules/pt/pt\_peg\_from\_container\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import](tcllib/files/modules/pt/pt\_peg\_import\.md) · [pt::peg::import::container](tcllib/files/modules/pt/pt\_peg\_import\_container\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::interp](tcllib/files/modules/pt/pt\_peg\_interp\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [pt::peg\_language](tcllib/files/modules/pt/pt\_peg\_language\.md) · [pt::pegrammar](tcllib/files/modules/pt/pt\_peg\_introduction\.md) · [pt::pgen](tcllib/files/modules/pt/pt\_pgen\.md) · [pt::rde](tcllib/files/modules/pt/pt\_rdengine\.md) · [pt::tclparam::configuration::nx](tcllib/files/modules/pt/pt\_tclparam\_config\_nx\.md) · [pt::tclparam::configuration::snit](tcllib/files/modules/pt/pt\_tclparam\_config\_snit\.md) · [pt::tclparam::configuration::tcloo](tcllib/files/modules/pt/pt\_tclparam\_config\_tcloo\.md) · [pt::util](tcllib/files/modules/pt/pt\_util\.md) · [pt\_export\_api](tcllib/files/modules/pt/pt\_to\_api\.md) · [pt\_import\_api](tcllib/files/modules/pt/pt\_from\_api\.md) · [pt\_introduction](tcllib/files/modules/pt/pt\_introduction\.md) · [pt\_parse\_peg](tcllib/files/modules/pt/pt\_parse\_peg\.md) · [pt\_parser\_api](tcllib/files/modules/pt/pt\_parser\_api\.md) · [pt\_peg\_op](tcllib/files/modules/pt/pt\_peg\_op\.md)| #### <a name='cQ'></a>Keywords: Q ||| |---|---| |<a name='queue'></a>queue|[csv](tcllib/files/modules/csv/csv\.md) · [htmlparse](tcllib/files/modules/htmlparse/htmlparse\.md) · [struct::stack](tcllib/files/modules/struct/stack\.md) · [transfer::copy::queue](tcllib/files/modules/transfer/tqueue\.md)| |<a name='quoting'></a>quoting|[page\_util\_quote](tcllib/files/modules/page/page\_util\_quote\.md)| #### <a name='cR'></a>Keywords: R ||| | > | 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 | |<a name='push\_down\_automaton'></a>push down automaton|[grammar::me\_intro](tcllib/files/modules/grammar\_me/me\_intro\.md) · [grammar::peg](tcllib/files/modules/grammar\_peg/peg\.md) · [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) · [pt](tcllib/files/apps/pt\.md) · [pt::ast](tcllib/files/modules/pt/pt\_astree\.md) · [pt::cparam::configuration::critcl](tcllib/files/modules/pt/pt\_cparam\_config\_critcl\.md) · [pt::cparam::configuration::tea](tcllib/files/modules/pt/pt\_cparam\_config\_tea\.md) · [pt::json\_language](tcllib/files/modules/pt/pt\_json\_language\.md) · [pt::param](tcllib/files/modules/pt/pt\_param\.md) · [pt::pe](tcllib/files/modules/pt/pt\_pexpression\.md) · [pt::pe::op](tcllib/files/modules/pt/pt\_pexpr\_op\.md) · [pt::peg](tcllib/files/modules/pt/pt\_pegrammar\.md) · [pt::peg::container](tcllib/files/modules/pt/pt\_peg\_container\.md) · [pt::peg::container::peg](tcllib/files/modules/pt/pt\_peg\_container\_peg\.md) · [pt::peg::export](tcllib/files/modules/pt/pt\_peg\_export\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::container](tcllib/files/modules/pt/pt\_peg\_from\_container\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import](tcllib/files/modules/pt/pt\_peg\_import\.md) · [pt::peg::import::container](tcllib/files/modules/pt/pt\_peg\_import\_container\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::interp](tcllib/files/modules/pt/pt\_peg\_interp\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [pt::peg\_language](tcllib/files/modules/pt/pt\_peg\_language\.md) · [pt::pegrammar](tcllib/files/modules/pt/pt\_peg\_introduction\.md) · [pt::pgen](tcllib/files/modules/pt/pt\_pgen\.md) · [pt::rde](tcllib/files/modules/pt/pt\_rdengine\.md) · [pt::tclparam::configuration::nx](tcllib/files/modules/pt/pt\_tclparam\_config\_nx\.md) · [pt::tclparam::configuration::snit](tcllib/files/modules/pt/pt\_tclparam\_config\_snit\.md) · [pt::tclparam::configuration::tcloo](tcllib/files/modules/pt/pt\_tclparam\_config\_tcloo\.md) · [pt::util](tcllib/files/modules/pt/pt\_util\.md) · [pt\_export\_api](tcllib/files/modules/pt/pt\_to\_api\.md) · [pt\_import\_api](tcllib/files/modules/pt/pt\_from\_api\.md) · [pt\_introduction](tcllib/files/modules/pt/pt\_introduction\.md) · [pt\_parse\_peg](tcllib/files/modules/pt/pt\_parse\_peg\.md) · [pt\_parser\_api](tcllib/files/modules/pt/pt\_parser\_api\.md) · [pt\_peg\_op](tcllib/files/modules/pt/pt\_peg\_op\.md)| #### <a name='cQ'></a>Keywords: Q ||| |---|---| |<a name='quasi\_random'></a>quasi\-random|[math::quasirandom](tcllib/files/modules/math/quasirandom\.md)| |<a name='queue'></a>queue|[csv](tcllib/files/modules/csv/csv\.md) · [htmlparse](tcllib/files/modules/htmlparse/htmlparse\.md) · [struct::stack](tcllib/files/modules/struct/stack\.md) · [transfer::copy::queue](tcllib/files/modules/transfer/tqueue\.md)| |<a name='quoting'></a>quoting|[page\_util\_quote](tcllib/files/modules/page/page\_util\_quote\.md)| #### <a name='cR'></a>Keywords: R ||| |
︙ | ︙ | |||
795 796 797 798 799 800 801 | |<a name='seed'></a>seed|[tcl::randomseed](tcllib/files/modules/virtchannel\_base/randseed\.md)| |<a name='selectionbox'></a>selectionbox|[javascript](tcllib/files/modules/javascript/javascript\.md)| |<a name='semantic\_markup'></a>semantic markup|[docidx\_intro](tcllib/files/modules/doctools/docidx\_intro\.md) · [docidx\_lang\_cmdref](tcllib/files/modules/doctools/docidx\_lang\_cmdref\.md) · [docidx\_lang\_faq](tcllib/files/modules/doctools/docidx\_lang\_faq\.md) · [docidx\_lang\_intro](tcllib/files/modules/doctools/docidx\_lang\_intro\.md) · [docidx\_lang\_syntax](tcllib/files/modules/doctools/docidx\_lang\_syntax\.md) · [docidx\_plugin\_apiref](tcllib/files/modules/doctools/docidx\_plugin\_apiref\.md) · [doctoc\_intro](tcllib/files/modules/doctools/doctoc\_intro\.md) · [doctoc\_lang\_cmdref](tcllib/files/modules/doctools/doctoc\_lang\_cmdref\.md) · [doctoc\_lang\_faq](tcllib/files/modules/doctools/doctoc\_lang\_faq\.md) · [doctoc\_lang\_intro](tcllib/files/modules/doctools/doctoc\_lang\_intro\.md) · [doctoc\_lang\_syntax](tcllib/files/modules/doctools/doctoc\_lang\_syntax\.md) · [doctoc\_plugin\_apiref](tcllib/files/modules/doctools/doctoc\_plugin\_apiref\.md) · [doctools2idx\_introduction](tcllib/files/modules/doctools2idx/idx\_introduction\.md) · [doctools2toc\_introduction](tcllib/files/modules/doctools2toc/toc\_introduction\.md) · [doctools\_intro](tcllib/files/modules/doctools/doctools\_intro\.md) · [doctools\_lang\_cmdref](tcllib/files/modules/doctools/doctools\_lang\_cmdref\.md) · [doctools\_lang\_faq](tcllib/files/modules/doctools/doctools\_lang\_faq\.md) · [doctools\_lang\_intro](tcllib/files/modules/doctools/doctools\_lang\_intro\.md) · [doctools\_lang\_syntax](tcllib/files/modules/doctools/doctools\_lang\_syntax\.md) · [doctools\_plugin\_apiref](tcllib/files/modules/doctools/doctools\_plugin\_apiref\.md)| |<a name='send'></a>send|[comm](tcllib/files/modules/comm/comm\.md)| |<a name='serialization'></a>serialization|[bee](tcllib/files/modules/bee/bee\.md) · [doctools::idx::export::docidx](tcllib/files/modules/doctools2idx/export\_docidx\.md) · [doctools::idx::export::html](tcllib/files/modules/doctools2idx/idx\_export\_html\.md) · [doctools::idx::export::json](tcllib/files/modules/doctools2idx/idx\_export\_json\.md) · [doctools::idx::export::nroff](tcllib/files/modules/doctools2idx/idx\_export\_nroff\.md) · [doctools::idx::export::text](tcllib/files/modules/doctools2idx/idx\_export\_text\.md) · [doctools::idx::export::wiki](tcllib/files/modules/doctools2idx/idx\_export\_wiki\.md) · [doctools::idx::structure](tcllib/files/modules/doctools2idx/idx\_structure\.md) · [doctools::toc::export::doctoc](tcllib/files/modules/doctools2toc/export\_doctoc\.md) · [doctools::toc::export::html](tcllib/files/modules/doctools2toc/toc\_export\_html\.md) · [doctools::toc::export::json](tcllib/files/modules/doctools2toc/toc\_export\_json\.md) · [doctools::toc::export::nroff](tcllib/files/modules/doctools2toc/toc\_export\_nroff\.md) · [doctools::toc::export::text](tcllib/files/modules/doctools2toc/toc\_export\_text\.md) · [doctools::toc::export::wiki](tcllib/files/modules/doctools2toc/toc\_export\_wiki\.md) · [doctools::toc::structure](tcllib/files/modules/doctools2toc/toc\_structure\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [struct::graph](tcllib/files/modules/struct/graph\.md) · [struct::tree](tcllib/files/modules/struct/struct\_tree\.md)| |<a name='server'></a>server|[map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) · [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) · [nameserv::common](tcllib/files/modules/nns/nns\_common\.md) · [nameserv::server](tcllib/files/modules/nns/nns\_server\.md) · [nns\_intro](tcllib/files/modules/nns/nns\_intro\.md) · [nnsd](tcllib/files/apps/nnsd\.md) · [udpcluster](tcllib/files/modules/udpcluster/udpcluster\.md)| |<a name='service'></a>service|[logger](tcllib/files/modules/log/logger\.md)| | | | 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 | |<a name='seed'></a>seed|[tcl::randomseed](tcllib/files/modules/virtchannel\_base/randseed\.md)| |<a name='selectionbox'></a>selectionbox|[javascript](tcllib/files/modules/javascript/javascript\.md)| |<a name='semantic\_markup'></a>semantic markup|[docidx\_intro](tcllib/files/modules/doctools/docidx\_intro\.md) · [docidx\_lang\_cmdref](tcllib/files/modules/doctools/docidx\_lang\_cmdref\.md) · [docidx\_lang\_faq](tcllib/files/modules/doctools/docidx\_lang\_faq\.md) · [docidx\_lang\_intro](tcllib/files/modules/doctools/docidx\_lang\_intro\.md) · [docidx\_lang\_syntax](tcllib/files/modules/doctools/docidx\_lang\_syntax\.md) · [docidx\_plugin\_apiref](tcllib/files/modules/doctools/docidx\_plugin\_apiref\.md) · [doctoc\_intro](tcllib/files/modules/doctools/doctoc\_intro\.md) · [doctoc\_lang\_cmdref](tcllib/files/modules/doctools/doctoc\_lang\_cmdref\.md) · [doctoc\_lang\_faq](tcllib/files/modules/doctools/doctoc\_lang\_faq\.md) · [doctoc\_lang\_intro](tcllib/files/modules/doctools/doctoc\_lang\_intro\.md) · [doctoc\_lang\_syntax](tcllib/files/modules/doctools/doctoc\_lang\_syntax\.md) · [doctoc\_plugin\_apiref](tcllib/files/modules/doctools/doctoc\_plugin\_apiref\.md) · [doctools2idx\_introduction](tcllib/files/modules/doctools2idx/idx\_introduction\.md) · [doctools2toc\_introduction](tcllib/files/modules/doctools2toc/toc\_introduction\.md) · [doctools\_intro](tcllib/files/modules/doctools/doctools\_intro\.md) · [doctools\_lang\_cmdref](tcllib/files/modules/doctools/doctools\_lang\_cmdref\.md) · [doctools\_lang\_faq](tcllib/files/modules/doctools/doctools\_lang\_faq\.md) · [doctools\_lang\_intro](tcllib/files/modules/doctools/doctools\_lang\_intro\.md) · [doctools\_lang\_syntax](tcllib/files/modules/doctools/doctools\_lang\_syntax\.md) · [doctools\_plugin\_apiref](tcllib/files/modules/doctools/doctools\_plugin\_apiref\.md)| |<a name='send'></a>send|[comm](tcllib/files/modules/comm/comm\.md)| |<a name='serialization'></a>serialization|[bee](tcllib/files/modules/bee/bee\.md) · [doctools::idx::export::docidx](tcllib/files/modules/doctools2idx/export\_docidx\.md) · [doctools::idx::export::html](tcllib/files/modules/doctools2idx/idx\_export\_html\.md) · [doctools::idx::export::json](tcllib/files/modules/doctools2idx/idx\_export\_json\.md) · [doctools::idx::export::nroff](tcllib/files/modules/doctools2idx/idx\_export\_nroff\.md) · [doctools::idx::export::text](tcllib/files/modules/doctools2idx/idx\_export\_text\.md) · [doctools::idx::export::wiki](tcllib/files/modules/doctools2idx/idx\_export\_wiki\.md) · [doctools::idx::structure](tcllib/files/modules/doctools2idx/idx\_structure\.md) · [doctools::toc::export::doctoc](tcllib/files/modules/doctools2toc/export\_doctoc\.md) · [doctools::toc::export::html](tcllib/files/modules/doctools2toc/toc\_export\_html\.md) · [doctools::toc::export::json](tcllib/files/modules/doctools2toc/toc\_export\_json\.md) · [doctools::toc::export::nroff](tcllib/files/modules/doctools2toc/toc\_export\_nroff\.md) · [doctools::toc::export::text](tcllib/files/modules/doctools2toc/toc\_export\_text\.md) · [doctools::toc::export::wiki](tcllib/files/modules/doctools2toc/toc\_export\_wiki\.md) · [doctools::toc::structure](tcllib/files/modules/doctools2toc/toc\_structure\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [struct::graph](tcllib/files/modules/struct/graph\.md) · [struct::tree](tcllib/files/modules/struct/struct\_tree\.md)| |<a name='server'></a>server|[map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) · [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) · [nameserv::common](tcllib/files/modules/nns/nns\_common\.md) · [nameserv::server](tcllib/files/modules/nns/nns\_server\.md) · [nns\_intro](tcllib/files/modules/nns/nns\_intro\.md) · [nnsd](tcllib/files/apps/nnsd\.md) · [udpcluster](tcllib/files/modules/udpcluster/udpcluster\.md)| |<a name='service'></a>service|[logger](tcllib/files/modules/log/logger\.md)| |<a name='services'></a>services|[ftpd](tcllib/files/modules/ftpd/ftpd\.md) · [httpd](tcllib/files/modules/httpd/httpd\.md) · [smtpd](tcllib/files/modules/smtpd/smtpd\.md)| |<a name='set'></a>set|[struct::queue](tcllib/files/modules/struct/queue\.md) · [struct::set](tcllib/files/modules/struct/struct\_set\.md)| |<a name='sha1'></a>sha1|[sha1](tcllib/files/modules/sha1/sha1\.md)| |<a name='sha256'></a>sha256|[sha256](tcllib/files/modules/sha1/sha256\.md)| |<a name='shell'></a>shell|[string::token::shell](tcllib/files/modules/string/token\_shell\.md)| |<a name='shortest\_path'></a>shortest path|[struct::graph::op](tcllib/files/modules/struct/graphops\.md)| |<a name='shuffle'></a>shuffle|[struct::list](tcllib/files/modules/struct/struct\_list\.md)| |<a name='simulated\_annealing'></a>simulated annealing|[simulation::annealing](tcllib/files/modules/simulation/annealing\.md)| |
︙ | ︙ | |||
871 872 873 874 875 876 877 | |<a name='tape\_archive'></a>tape archive|[tar](tcllib/files/modules/tar/tar\.md)| |<a name='tar'></a>tar|[tar](tcllib/files/modules/tar/tar\.md)| |<a name='tcl'></a>tcl|[math::bigfloat](tcllib/files/modules/math/bigfloat\.md) · [math::bignum](tcllib/files/modules/math/bignum\.md) · [math::decimal](tcllib/files/modules/math/decimal\.md) · [math::PCA](tcllib/files/modules/math/pca\.md)| |<a name='tcl\_module'></a>Tcl module|[docstrip\_util](tcllib/files/modules/docstrip/docstrip\_util\.md)| |<a name='tcl\_syntax'></a>Tcl syntax|[doctools::tcl::parse](tcllib/files/modules/doctools2base/tcl\_parse\.md)| |<a name='tcler\_s\_wiki'></a>tcler's wiki|[doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md)| |<a name='tcllib'></a>tcllib|[csv](tcllib/files/modules/csv/csv\.md)| | | | 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 | |<a name='tape\_archive'></a>tape archive|[tar](tcllib/files/modules/tar/tar\.md)| |<a name='tar'></a>tar|[tar](tcllib/files/modules/tar/tar\.md)| |<a name='tcl'></a>tcl|[math::bigfloat](tcllib/files/modules/math/bigfloat\.md) · [math::bignum](tcllib/files/modules/math/bignum\.md) · [math::decimal](tcllib/files/modules/math/decimal\.md) · [math::PCA](tcllib/files/modules/math/pca\.md)| |<a name='tcl\_module'></a>Tcl module|[docstrip\_util](tcllib/files/modules/docstrip/docstrip\_util\.md)| |<a name='tcl\_syntax'></a>Tcl syntax|[doctools::tcl::parse](tcllib/files/modules/doctools2base/tcl\_parse\.md)| |<a name='tcler\_s\_wiki'></a>tcler's wiki|[doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md)| |<a name='tcllib'></a>tcllib|[csv](tcllib/files/modules/csv/csv\.md)| |<a name='tcloo'></a>TclOO|[clay](tcllib/files/modules/clay/clay\.md) · [httpd](tcllib/files/modules/httpd/httpd\.md) · [oo::util](tcllib/files/modules/tool/meta\.md) · [oo::util](tcllib/files/modules/ooutil/ooutil\.md) · [oometa](tcllib/files/modules/oometa/oometa\.md) · [tool](tcllib/files/modules/tool/tool\.md) · [tool::dict\_ensemble](tcllib/files/modules/tool/tool\_dict\_ensemble\.md)| |<a name='tclparam'></a>TCLPARAM|[pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md)| |<a name='tdpl'></a>TDPL|[grammar::peg](tcllib/files/modules/grammar\_peg/peg\.md) · [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) · [pt](tcllib/files/apps/pt\.md) · [pt::ast](tcllib/files/modules/pt/pt\_astree\.md) · [pt::cparam::configuration::critcl](tcllib/files/modules/pt/pt\_cparam\_config\_critcl\.md) · [pt::cparam::configuration::tea](tcllib/files/modules/pt/pt\_cparam\_config\_tea\.md) · [pt::json\_language](tcllib/files/modules/pt/pt\_json\_language\.md) · [pt::param](tcllib/files/modules/pt/pt\_param\.md) · [pt::pe](tcllib/files/modules/pt/pt\_pexpression\.md) · [pt::pe::op](tcllib/files/modules/pt/pt\_pexpr\_op\.md) · [pt::peg](tcllib/files/modules/pt/pt\_pegrammar\.md) · [pt::peg::container](tcllib/files/modules/pt/pt\_peg\_container\.md) · [pt::peg::container::peg](tcllib/files/modules/pt/pt\_peg\_container\_peg\.md) · [pt::peg::export](tcllib/files/modules/pt/pt\_peg\_export\.md) · [pt::peg::export::container](tcllib/files/modules/pt/pt\_peg\_export\_container\.md) · [pt::peg::export::json](tcllib/files/modules/pt/pt\_peg\_export\_json\.md) · [pt::peg::export::peg](tcllib/files/modules/pt/pt\_peg\_export\_peg\.md) · [pt::peg::from::container](tcllib/files/modules/pt/pt\_peg\_from\_container\.md) · [pt::peg::from::json](tcllib/files/modules/pt/pt\_peg\_from\_json\.md) · [pt::peg::from::peg](tcllib/files/modules/pt/pt\_peg\_from\_peg\.md) · [pt::peg::import](tcllib/files/modules/pt/pt\_peg\_import\.md) · [pt::peg::import::container](tcllib/files/modules/pt/pt\_peg\_import\_container\.md) · [pt::peg::import::json](tcllib/files/modules/pt/pt\_peg\_import\_json\.md) · [pt::peg::import::peg](tcllib/files/modules/pt/pt\_peg\_import\_peg\.md) · [pt::peg::interp](tcllib/files/modules/pt/pt\_peg\_interp\.md) · [pt::peg::to::container](tcllib/files/modules/pt/pt\_peg\_to\_container\.md) · [pt::peg::to::cparam](tcllib/files/modules/pt/pt\_peg\_to\_cparam\.md) · [pt::peg::to::json](tcllib/files/modules/pt/pt\_peg\_to\_json\.md) · [pt::peg::to::param](tcllib/files/modules/pt/pt\_peg\_to\_param\.md) · [pt::peg::to::peg](tcllib/files/modules/pt/pt\_peg\_to\_peg\.md) · [pt::peg::to::tclparam](tcllib/files/modules/pt/pt\_peg\_to\_tclparam\.md) · [pt::peg\_language](tcllib/files/modules/pt/pt\_peg\_language\.md) · [pt::pegrammar](tcllib/files/modules/pt/pt\_peg\_introduction\.md) · [pt::pgen](tcllib/files/modules/pt/pt\_pgen\.md) · [pt::rde](tcllib/files/modules/pt/pt\_rdengine\.md) · [pt::tclparam::configuration::nx](tcllib/files/modules/pt/pt\_tclparam\_config\_nx\.md) · [pt::tclparam::configuration::snit](tcllib/files/modules/pt/pt\_tclparam\_config\_snit\.md) · [pt::tclparam::configuration::tcloo](tcllib/files/modules/pt/pt\_tclparam\_config\_tcloo\.md) · [pt::util](tcllib/files/modules/pt/pt\_util\.md) · [pt\_export\_api](tcllib/files/modules/pt/pt\_to\_api\.md) · [pt\_import\_api](tcllib/files/modules/pt/pt\_from\_api\.md) · [pt\_introduction](tcllib/files/modules/pt/pt\_introduction\.md) · [pt\_parse\_peg](tcllib/files/modules/pt/pt\_parse\_peg\.md) · [pt\_parser\_api](tcllib/files/modules/pt/pt\_parser\_api\.md) · [pt\_peg\_op](tcllib/files/modules/pt/pt\_peg\_op\.md)| |<a name='temp\_file'></a>temp file|[fileutil](tcllib/files/modules/fileutil/fileutil\.md)| |<a name='template\_processing'></a>template processing|[textutil::expander](tcllib/files/modules/textutil/expander\.md)| |<a name='terminal'></a>terminal|[term](tcllib/files/modules/term/term\.md) · [term::ansi::code](tcllib/files/modules/term/ansi\_code\.md) · [term::ansi::code::attr](tcllib/files/modules/term/ansi\_cattr\.md) · [term::ansi::code::ctrl](tcllib/files/modules/term/ansi\_cctrl\.md) · [term::ansi::code::macros](tcllib/files/modules/term/ansi\_cmacros\.md) · [term::ansi::ctrl::unix](tcllib/files/modules/term/ansi\_ctrlu\.md) · [term::ansi::send](tcllib/files/modules/term/ansi\_send\.md) · [term::interact::menu](tcllib/files/modules/term/imenu\.md) · [term::interact::pager](tcllib/files/modules/term/ipager\.md) · [term::receive](tcllib/files/modules/term/receive\.md) · [term::receive::bind](tcllib/files/modules/term/term\_bind\.md) · [term::send](tcllib/files/modules/term/term\_send\.md)| |<a name='test'></a>test|[fileutil](tcllib/files/modules/fileutil/fileutil\.md)| |<a name='testing'></a>Testing|[valtype::common](tcllib/files/modules/valtype/valtype\_common\.md) · [valtype::creditcard::amex](tcllib/files/modules/valtype/cc\_amex\.md) · [valtype::creditcard::discover](tcllib/files/modules/valtype/cc\_discover\.md) · [valtype::creditcard::mastercard](tcllib/files/modules/valtype/cc\_mastercard\.md) · [valtype::creditcard::visa](tcllib/files/modules/valtype/cc\_visa\.md) · [valtype::gs1::ean13](tcllib/files/modules/valtype/ean13\.md) · [valtype::iban](tcllib/files/modules/valtype/iban\.md) · [valtype::imei](tcllib/files/modules/valtype/imei\.md) · [valtype::isbn](tcllib/files/modules/valtype/isbn\.md) · [valtype::luhn](tcllib/files/modules/valtype/luhn\.md) · [valtype::luhn5](tcllib/files/modules/valtype/luhn5\.md) · [valtype::usnpi](tcllib/files/modules/valtype/usnpi\.md) · [valtype::verhoeff](tcllib/files/modules/valtype/verhoeff\.md)| |
︙ | ︙ | |||
981 982 983 984 985 986 987 | ||| |---|---| |<a name='wais'></a>wais|[uri](tcllib/files/modules/uri/uri\.md)| |<a name='widget'></a>widget|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md)| |<a name='widget\_adaptors'></a>widget adaptors|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md)| |<a name='wiki'></a>wiki|[doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::export::wiki](tcllib/files/modules/doctools2idx/idx\_export\_wiki\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::export::wiki](tcllib/files/modules/doctools2toc/toc\_export\_wiki\.md)| |<a name='word'></a>word|[doctools::tcl::parse](tcllib/files/modules/doctools2base/tcl\_parse\.md) · [wip](tcllib/files/modules/wip/wip\.md)| | | | 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 | ||| |---|---| |<a name='wais'></a>wais|[uri](tcllib/files/modules/uri/uri\.md)| |<a name='widget'></a>widget|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md)| |<a name='widget\_adaptors'></a>widget adaptors|[snit](tcllib/files/modules/snit/snit\.md) · [snitfaq](tcllib/files/modules/snit/snitfaq\.md)| |<a name='wiki'></a>wiki|[doctools::idx](tcllib/files/modules/doctools/docidx\.md) · [doctools::idx](tcllib/files/modules/doctools2idx/idx\_container\.md) · [doctools::idx::export](tcllib/files/modules/doctools2idx/idx\_export\.md) · [doctools::idx::export::wiki](tcllib/files/modules/doctools2idx/idx\_export\_wiki\.md) · [doctools::toc](tcllib/files/modules/doctools2toc/toc\_container\.md) · [doctools::toc](tcllib/files/modules/doctools/doctoc\.md) · [doctools::toc::export](tcllib/files/modules/doctools2toc/toc\_export\.md) · [doctools::toc::export::wiki](tcllib/files/modules/doctools2toc/toc\_export\_wiki\.md)| |<a name='word'></a>word|[doctools::tcl::parse](tcllib/files/modules/doctools2base/tcl\_parse\.md) · [wip](tcllib/files/modules/wip/wip\.md)| |<a name='www'></a>WWW|[httpd](tcllib/files/modules/httpd/httpd\.md)| |<a name='www'></a>www|[uri](tcllib/files/modules/uri/uri\.md)| #### <a name='cX'></a>Keywords: X ||| |---|---| |
︙ | ︙ |
Added embedded/md/tcllib/files/devdoc/tcl_community_communication.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (tcl\_community\_communication \- ) [//000000002]: # (Generated from file 'tcl\_community\_communication\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (tcl\_community\_communication\(n\) 1 tcllib "") <hr> [ <a href="../../../toc.md">Main Table Of Contents</a> | <a href="../../toc.md">Table Of Contents</a> | <a href="../../../index.md">Keyword Index</a> | <a href="../../../toc0.md">Categories</a> | <a href="../../../toc1.md">Modules</a> | <a href="../../../toc2.md">Applications</a> ] <hr> # NAME tcl\_community\_communication \- Tcl Community \- Kind Communication # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Signatories](#section2) - [Authors](#section3) # <a name='description'></a>DESCRIPTION The Tcl Community encourages contributions from anyone who wishes to advance the development of: - The Tcl Language - Tcl derived languages - Tcl related libraries - Tcl extensions - External Projects that Integrate Tcl We welcome those contributions from anyone\. We are blind to gender, race, religion, cultural background, cybernetic nature, and any other demographic characteristics, as well as personal political views\. A community lives and dies by communications\. And occasionally our communications are peppered with patterns that are harsh, unfriendly, unwelcoming and/or otherwise unkind\. As a volunteer community, we need all of the help we can get\. Therefore, we ask all contributors to make a conscious effort, in Tcl Community discussions, to communicate in ways that are welcoming\. Ways that are friendly\. Ways that are, in a word: kind\. These guidelines suggest specific ways to accomplish that goal\. Please note: for the balance of this document any reference to "People", "Persons", "anybody" or "somebody" can refer to any sentient being, not merely corporeal members of the species Homo Sapien\. - We are a Sanctuary not a Clubhouse The Tcl Community is a collective of amateurs and professionals who code, test, and use tools\. Our community is open to all\. There is no velvet rope\. There is no bouncer at the door\. There are no secret handshakes\. Any sentient being who enters our midst is welcome\. If someone is ever asked to leave, it is only because they are being disruptive to the functioning of the community\. - We Merit Ideas, Not People A good idea can come from anyone, regardless of how little time they have been with us\. A bad idea can come from anyone, regardless of how much time or how little time they have been with us\. We judge a concept by how it stands up to scrutiny of logic, implementation, and regression testing\. We don’t judge ideas based on who had the idea first, who agrees with the idea, or who disagrees with it\. - Treat Everyone with Respect Everyone is deserving of respect and courtesy at all times\. - Refer to people by the names they use\. If grammar requires you to state a gender for a person, honor their preferences about their gender identity\. If you are unsure as to the gender of an individual, ask\. If someone had to guess about your gender and got it wrong, please correct them and do not take it personally\. - Do not take a harsh tone towards other participants\. Do not make personal attacks against anyone \(participant or not\.\) Criticize statements and actions, never people\. - Don’t Take Things Personally When in doubt, assume the best in people\. A criticism of your statements is not a personal attack on you\. - Persons, not People Stereotypes are an unhelpful tool on many accounts\. They are generally oversimplified\. They are usually flat out wrong\. And even if "right" they are of absolutely no utility in determining the capabilities, motivations, or fitness of an individual\. Don’t use them in Tcl Community communications\. - Mistakes Happen The human condition is a series of trials and errors\. Progress is when we get one more trial than error\. Being wrong or making a mistake is the default state of humanity\. Accept the errors of your fellow sentient beings, and be aware that you are also fallible\. - Keep it Real Please respond to what people actually say\. We are all amazing individuals, but none among us are mind readers\. If you find yourself responding to what you imagine someone is thinking, odds are you are going to be wrong\. If you must criticize someone, stick to things they have actually done\. Never criticize for something you speculate they have done\. Or imagine they have done\. Or something someone who shares some attribute with them has done in the past\. Keep discussions about any non\-Tcl subjects to what can be stated factually and without emotion or judgement\. - When Trouble Arises, Don’t Escalate If you feel you are being personally attacked or offended, take the high road\. Punching back in a public forum will only makes things worse\. Address the matter in a private correspondence\. Be polite\. Express your feelings, but note that you are expressing your feelings\. When writing, look for a way to calm matters down\. And when in doubt, sleep on your letter before pressing send\. And when not in doubt, sleep on it for another day after that\. If you are a spectator to a fight in progress, politely request the two parties take the matter to a more private forum\. - Always get the Last Word: I’m Sorry If an personal argument does arise, be the first to apologize\. An apology does not concede a logical point\. It merely acknowledges that at some point the discussion left either logic, community decency, or both\. Return to the topic when cooler heads can prevail\. - Nobody is Keeping Score There is no prize for being right\. There is no cost for being wrong\. A hard sell is not going to advance your idea along any more than a logical argument\. You aren’t running for office\. This isn’t debate club\. If you find yourself continuing a discussion beyond where a topic can be logically discussed, stop\. - No Evangelizing The Tcl Community is not the place to promote your chosen operating system, political outlook, religion, marketing scheme, or economic model\. Period\. \(And if you do bring it up, be prepared to have your chosen topic discussed logically\. And odds are, not favorably\.\) - Respect the Community If the Community has come to a decision on a course of action, please stop arguing\. If someone complains about how you are expressing your ideas, listen\. If your words are hurting people, stop\. There is no amount of being "right" that makes up for someone leaving our midst because they felt insulted, threatened, or ignored\. By following these guidelines, we will build our community, encourage more contribution to our projects, and our discussions will be friendlier and reach conclusions more easily\. Thank You\. # <a name='section2'></a>Signatories - Sean "the Hypnotoad" Woods - Andreas Kupries # <a name='section3'></a>Authors - Primary Sean "the Hypnotoad" Woods - Light editing Andreas Kupries |
Added embedded/md/tcllib/files/devdoc/tcllib_devguide.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (tcllib\_devguide \- ) [//000000002]: # (Generated from file 'tcllib\_devguide\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (tcllib\_devguide\(n\) 1 tcllib "") <hr> [ <a href="../../../toc.md">Main Table Of Contents</a> | <a href="../../toc.md">Table Of Contents</a> | <a href="../../../index.md">Keyword Index</a> | <a href="../../../toc0.md">Categories</a> | <a href="../../../toc1.md">Modules</a> | <a href="../../../toc2.md">Applications</a> ] <hr> # NAME tcllib\_devguide \- Tcllib \- The Developer's Guide # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [Commitments](#section2) - [Contributor](#subsection1) - [Maintainer](#subsection2) - [Branching and Workflow](#section3) - [Package Dependencies](#subsection3) - [Trunk](#subsection4) - [Branches](#subsection5) - [Working with Branches](#subsection6) - [Version numbers](#subsection7) - [Structural Overview](#section4) - [Main Directories](#subsection8) - [More Directories](#subsection9) - [Top Files](#subsection10) - [File Types](#subsection11) - [Testsuite Tooling](#section5) - [Invoke the testsuites of a specific module](#subsection12) - [Invoke the testsuites of all modules](#subsection13) - [Detailed Test Logs](#subsection14) - [Shell Selection](#subsection15) - [Help](#subsection16) - [Documentation Tooling](#section6) - [Generate documentation for a specific module](#subsection17) - [Generate documentation for all modules](#subsection18) - [Available output formats, help](#subsection19) - [Validation without output](#subsection20) - [Notes On Writing A Testsuite](#section7) - [Installation Tooling](#section8) # <a name='synopsis'></a>SYNOPSIS [__[Module](\.\./\.\./\.\./index\.md\#module)__ *name* *code\-action* *doc\-action* *example\-action*](#1) [__[Application](\.\./\.\./\.\./index\.md\#application)__ *name*](#2) [__Exclude__ *name*](#3) # <a name='description'></a>DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\. Note that Tcllib is not a package itself\. It is a collection of \(semi\-independent\) *[Tcl](\.\./\.\./\.\./index\.md\#tcl)* packages that provide utility functions useful to a large collection of Tcl programmers\. This document is a guide for developers working on Tcllib, i\.e\. maintainers fixing bugs, extending the collection's functionality, etc\. Please read 1. *[Tcllib \- How To Get The Sources](tcllib\_sources\.md)* and 1. *[Tcllib \- The Installer's Guide](tcllib\_installer\.md)* first, if that was not done already\. Here we assume that the sources are already available in a directory of your choice, and that you not only know how to build and install them, but also have all the necessary requisites to actually do so\. The guide to the sources in particular also explains which source code management system is used, where to find it, how to set it up, etc\. # <a name='section2'></a>Commitments ## <a name='subsection1'></a>Contributor As a contributor to Tcllib you are committing yourself to: 1. keep the guidelines written down in *[Tcl Community \- Kind Communication](tcl\_community\_communication\.md)* in your mind\. The main point to take away from there is *to be kind to each other*\. 1. Your contributions getting distributed under a BSD/MIT license\. For the details see *[Tcllib \- License](tcllib\_license\.md)* Contributions are made by entering tickets into our tracker, providing patches, bundles or branches of code for inclusion, or posting to the Tcllib related mailing lists\. ## <a name='subsection2'></a>Maintainer When contributing one or more packages for full inclusion into Tcllib you are committing yourself to 1. Keep the guidelines written down in *[Tcl Community \- Kind Communication](tcl\_community\_communication\.md)* \(as any contributor\) in your mind\. The main point to take away from there is *to be kind to each other*\. 1. Your packages getting distributed under a BSD/MIT license\. For the details see *[Tcllib \- License](tcllib\_license\.md)* 1. Maintenance of the new packages for a period of two years under the following rules, and responsibilities: 1) A maintainer may step down after the mandatory period as they see fit\. 1) A maintainer may step down before the end of the mandatory period, under the condition that a replacement maintainer is immediately available and has agreed to serve the remainder of the period, plus their own mandatory period \(see below\)\. 1) When stepping down without a replacement maintainer taking over the relevant packages have to be flagged as __unmaintained__\. 1) When a replacement mantainer is brought in for a package it is \(kept\) marked as __maintained__ \(again\)\. A replacement maintainer is bound by the same rules as the original maintainer, except that the mandatory period of maintenance is shortened to one year\. 1) For any __unmaintained__ package a contributor interested in becoming its maintainer can become so by flagging them as __maintained__ with their name and contact information, committing themselves to the rules of a replacement maintainer \(see previous point\)\. 1) For any already __maintained__ package a contributor interested in becoming a co\-maintainer can become so with the agreement of the existing maintainer\(s\), committing themselves to the rules of a replacement maintainer \(see two points previous\)\. The responsibilities as a maintainer include: 1) Watching Tcllib's ticket tracker for bugs, bug fixes, and feature requests related to the new packages\. 1) Reviewing the aforementioned tickets, rejecting or applying them 1) Coordination and discussion with ticket submitter during the development and/or application of bug fixes\. 1. Follow the [Branching and Workflow](#section3) of this guide\. # <a name='section3'></a>Branching and Workflow ## <a name='subsection3'></a>Package Dependencies Regarding packages and dependencies between them Tcllib occupies a middle position between two extremes: 1. On one side a strongly interdependent set of packages, usually by a single author, for a single project\. Looking at my \(Andreas Kupries\) own work examples of such are [Marpa](https://core\.tcl\.tk/akupries/marpa/index), [CRIMP](https://core\.tcl\.tk/akupries/crimp/index), [Kinetcl](https://core\.tcl\.tk/akupries/kinetcl/index), etc\. For every change the author of the project handles all the modifications cascading from any incompatibilities it introduced to the system\. 1. On the other side, the world of semi\-independent projects by many different authors where authors know what packages their own creations depend on, yet usually do not know who else depends on them\. The best thing an author making an \(incompatible\) change to their project can do is to for one announce such changes in some way, and for two use versioning to distinguish the code before and after the change\. The world is then responsible for adapting, be it by updating their own projects to the new version, or by sticking to the old\. As mentioned already, Tcllib lives in the middle of that\. While we as maintainers cannot be aware of all users of Tcllib's packages, and thus have to rely on the mechanisms touched on in point 2 above for that, the dependencies between the packages contained in Tcllib are a different matter\. As we are collectively responsible for the usability of Tcllib in toto to the outside world, it behooves us to be individually mindful even of Tcllib packages we are not directly maintaining, when they depend on packages under our maintainership\. This may be as simple as coordinating with the maintainers of the affected packages\. It may also require us to choose how to adapt affected packages which do not have maintainers, i\.e\. modify them to use our changed package properly, or modify them to properly depend on the unchanged version of our package\. Note that the above is not only a chore but an opportunity as well\. Additional insight can be had by forcing ourselves to look at our package and the planned change\(s\) from an outside perspective, to consider the ramifications of our actions on others in general, and on dependent packages in particular\. ## <a name='subsection4'></a>Trunk The management and use of branches is an important part of working with a *Distributed Version Control System* \(*DVCS*\) like [fossil](https://www\.fossil\-scm\.org/)\. For Tcllib the main branch of the collection is *trunk*\. In *git* this branch would be called *master*, and this is exactly the case in the [github mirror](https://github\.com/tcltk/tcllib/) of Tcllib\. To properly support debugging *each commit* on this branch *has to pass the entire testsuite* of the collection\. Using bisection to determine when an issue appeared is an example of an action made easier by this constraint\. This is part of our collective responsibility for the usability of Tcllib in toto to the outside world\. As *fossil* has no mechanism to enforce this condition this is handled on the honor system for developers and maintainers\. To make the task easier Tcllib comes with a tool \("sak\.tcl"\) providing a number of commands in support\. These commands are explained in the following sections of this guide\. While it is possible and allowed to commit directly to trunk remember the above constraint regarding the testsuite, and the coming notes about other possible issues with a commit\. ## <a name='subsection5'></a>Branches Given the constraints placed on the *trunk* branch of the repository it is \(strongly\) recommended to perform any development going beyond trivial changes on a non\-trunk branch\. Outside of the trunk developers are allowed to commit intermediate broken states of their work\. Only at the end of a development cycle, when the relevant branch is considered ready for merging, will it be necessary to perform full the set of validations ensuring that the merge to come will create a good commit on trunk\. Note that while a review from a second developer is not a required condition for merging a branch it is recommended to seek out such an independent opinion as a means of cross\-checking the work\. It also recommended to give any new branch a name which aids in determining additional details about it\. Examples of good things to stick into a branch name would be - Developer \(nick\)name - Ticket hash/reference - One or two keywords applicable to the work - \.\.\. Further, while most development branches are likely quite short\-lived, no prohibitions exist against making longer\-lived branches\. Creators should however be mindful that the longer such a branch exists without merges the more divergent they will tend to be, with an associated increase in the effort which will have to be spent on either merging from and merging to trunk\. ## <a name='subsection6'></a>Working with Branches In the hope of engendering good work practices now a few example operations which will come up with branches, and their associated fossil command \(sequences\)\. - *Awareness* When developing we have to keep ourselves aware of the context of our work\. On what branch are we ? What files have we changed ? What new files are not yet known to the repository ? What has happened remotely since we used our checkout ? The answers to these questions become especially important when using a long\-lived checkout and coming back to it after some time away\. Commands to answer questions like the above are: * __fossil pull__ Get all changes done on the remote since the last pull or sync from it\. This has to be done first, before any of the commands below\. Even if the commit in our checkout refers to the branch we want right now control operations committed to the remote may have changed that from underneath us\. * __fossil info | grep tags__ * __fossil branch list | grep '\\\*'__ Two different ways of determining the branch our checkout is on\. * __fossil timeline__ What have we \(and others\) done recently ? *Attention*, this information is very likely outdated, the more the longer we did not use this checkout\. Run __fossil pull__ first to get latest information from the remote repository of the project\. * __fossil timeline current__ Place the commit our checkout is based on at the top of the timeline\. * __fossil changes__ Lists the files we have changed compared to the commit the checkout is based on\. * __fossil extra__ Lists the files we have in the checkout the repository does not know about\. This may be leftover chaff from our work, or something we have forgotten to __fossil add__ to the repository yet\. - *Clean checkouts* Be aware of where you are \(see first definition\)\. For pretty much all the operation recipes below a clean checkout is at least desired, often required\. To check that a checkout is clean invoke fossil changes fossil extra How to clean up when uncommitted changes of all sorts are found is context\-specific and outside of the scope of this guide\. - *Starting a new branch* Be aware of where you are \(see first definition\)\. Ensure that you have clean checkout \(see second definition\)\. It is *required*\. In most situations you want to be on branch *trunk*, and you want to be on the latest commit for it\. To get there use fossil pull fossil update trunk If some other branch is desired as the starting point for the coming work replace *trunk* in the commands above with the name of that branch\. With the base line established we now have two ways of creating the new branch, with differing \(dis\)advantages\. The simpler way is to fossil branch new NAME_OF_NEW_BRANCH and start developing\. The advantage here is that you cannot forget to create the branch\. The disadvantages are that we have a branch commit unchanged from where we branched from, and that we have to use high\-handed techniques like hiding or shunning to get rid of the commit should we decide to abandon the work before the first actual commit on the branch\. The other way of creating the branch is to start developing, and then on the first commit use the option __\-\-branch__ to tell __fossil__ that we are starting a branch now\. I\.e\. run fossil commit --branch NAME_OF_NEW_BRANCH ... where *\.\.\.* are any other options used to supply the commit message, files to commit, etc\. The \(dis\)advantages are now reversed\. We have no superflous commit, only what is actually developed\. The work is hidden until we commit to make our first commit\. We may forget to use __\-\-branch NAME\_OF\_NEW\_BRANCH__ and then have to correct that oversight via the fossil web interface \(I am currently unaware of ways of doing such from the command line, although some magic incantantion of __fossil tag create__ may work\)\. It helps to keep awareness, like checking before any commit that we are on the desired branch\. - *Merging a branch into trunk* Be aware of where you are \(see first definition\)\. Ensure that you have clean checkout \(see second definition\)\. In the full\-blown sequence \(zig\-zag\) it is *required*, due to the merging from trunk\. In the shorter sequence it is only desired\. That said, keeping the checkout clean before any major operations is a good habit to have, in my opinion\. The full\-blown sequencing with checks all the way is to 1. Validate the checkout, i\.e\. last commit on your branch\. Run the full test suite and other validations, fix all the issues which have cropped up\. 1. Merge the latest state of the *trunk* \(see next definition\)\. 1. Validate the checkout again\. The incoming trunk changes may have broken something now\. Do any required fixes\. 1. Now merge to the trunk using fossil update trunk fossil merge --integrate YOUR_BRANCH 1. At this point the checkout should be in the same state as at the end of point \(3\) above, because we resolved any issues with the trunk already\. Thus a simple fossil commit ... should be sufficient now to commit the merge back and close the branch \(due to the __\-\-integrate__ we used on the merge\)\. The more paranoid may validate the checkout a third time before commiting\. I call this a *zig\-zag merge* because of how the arrows look in the timeline, from trunk to feature branch for the first merge, and then back for the final merge\. A less paranoid can do what I call a *simple merge*, which moves step \(2\) after step \(4\) and skips step \(3\) entirely\. The resulting shorter sequence is 1. Validate 1. Merge to trunk 1. Validate again 1. Commit to trunk The last step after either zig\-zag or plain merge is to fossil sync This saves our work to the remote side, and further gives us any other work done while we were doing our merge\. It especially allows us to check if we raced somebody else, resulting in a split trunk\. When that happens we should coordinate with the other developer on who fixes the split, to ensure that we do not race each other again\. - *Merging from trunk* Be aware of where you are \(see first definition\)\. Ensure that you have clean checkout \(see second definition\)\. It is *required*\. In most situations you want to import the latest commit of branch *trunk* \(or other origin\)\. To get it use fossil pull With that done we can now import this commit into our current branch with fossil merge trunk Even if __fossil__ does not report any conflicts it is a good idea to check that the operation has not broken the new and/or changed functionality we are working on\. With the establishment of a good merge we then save the state with fossil commit ... before continuing development\. ## <a name='subsection7'></a>Version numbers In Tcllib all changes to a package have to come with an increment of its version number\. What part is incremented \(patchlevel, minor, major version\) depends on the kind of change made\. With multiple changes in a commit the highest "wins"\. When working in a development branch the version change can be deferred until it is time to merge, and then has to cover all the changes in the branch\. Below a list of the kinds of changes and their associated version increments: - *D \- documentation* No increment - *T \- testsuite* No increment - *B \- bugfix* Patchlevel - *I \- implementation tweak* Patchlevel - *P \- performance tweak* Patchlevel - *E \- backward\-compatible extension* Minor - *API \- incompatible change* Major Note that a commit containing a version increment has to mention the new version number in its commit message, as well as the kind of change which caused it\. Note further that the version number of a package currently exists in three places\. An increment has to update all of them: 1. The package implementation\. 1. The package index \("pkgIndex\.tcl"\) 1. The package documentation\. The "sak\.tcl" command __validate version__ helps finding discrepancies between the first two\. All the other __validate__ methods are also of interest to any developer\. Invoke it with sak.tcl help validate to see their documentation\. # <a name='section4'></a>Structural Overview ## <a name='subsection8'></a>Main Directories The main directories in the Tcllib toplevel directory and of interest to a developer are: - "modules" Each child directory represents one or more packages\. In the case of the latter the packages are usually related in some way\. Examples are "base64", "math", and "struct", with loose \(base64\) to strong \(math\) relations between the packages in the directory\. - "apps" This directory contains all the installable applications, with their documentation\. Note that this directory is currently *not* split into sub\-directories\. - "examples" Each child directory "foo" contains one or more example application for the packages in "modules/foo"\. These examples are generally not polished enough to be considered for installation\. ## <a name='subsection9'></a>More Directories - "config" This directory contains files supporting the Unix build system, i\.e\. "configure" and "Makefile\.in"\. - "devdoc" This directories contains the doctools sources for the global documentation, like this document and its sibling guides\. - "embedded" This directory contains the entire documentation formatted for *[HTML](\.\./\.\./\.\./index\.md\#html)* and styled to properly mix into the web site generated by fossil for the repository\. This is the documentation accessible from the Tcllib home directory, represented in the repository as "embedded/index\.md"\. - "idoc" This directory contains the entire documentation formatted for *[nroff](\.\./\.\./\.\./index\.md\#nroff)* and *[HTML](\.\./\.\./\.\./index\.md\#html)*, the latter without any styling\. This is the documentation which will be installed\. - "support" This directory contains the sources of internal packages and utilities used in the implementation of the "installer\.tcl" and "sak\.tcl" scripts/tools\. ## <a name='subsection10'></a>Top Files - "aclocal\.m4" - "configure" - "configure\.in" - "Makefile\.in" These four files comprise the Unix build system layered on top of the "installer\.tcl" script\. - "installer\.tcl" The Tcl\-based installation script/tool\. - "project\.shed" Configuration file for *Sean Wood*'s __[PracTcl](\.\./modules/practcl/practcl\.md)__ buildsystem\. - "sak\.tcl" This is the main tool for developers and release managers, the *Swiss Army Knife* of management operations on the collection\. - "ChangeLog" The log of changes to the global support, when the sources were held in *[CVS](\.\./\.\./\.\./index\.md\#cvs)*\. Not relevant any longer with the switch to the *fossil* SCM\. - "license\.terms" The license in plain ASCII\. See also *[Tcllib \- License](tcllib\_license\.md)* for the nicely formatted form\. The text is identical\. - "README\.md" - "\.github/CONTRIBUTING\.md" - "\.github/ISSUE\_TEMPLATE\.md" - "\.github/PULL\_REQUEST\_TEMPLATE\.md" These markdown\-formatted documents are used and shown by the github mirror of these sources, pointing people back to the official location and issue trackers\. - "DESCRIPTION\.txt" - "STATUS" - "tcllib\.spec" - "tcllib\.tap" - "tcllib\.yml" ???? ## <a name='subsection11'></a>File Types The most common file types, by file extension, are: - "\.tcl" Tcl code for a package, application, or example\. - "\.man" Doctools\-formatted documentation, usually for a package\. - "\.test" Test suite for a package, or part of\. Based on __tcltest__\. - "\.bench" Performance benchmarks for a package, or part of\. Based on "modules/bench"\. - "\.pcx" Syntax rules for *TclDevKit*'s __tclchecker__\. Using these rules allows the checker to validate the use of commands of a Tcllib package __foo__ without having to scan the "\.tcl" files implementing it\. # <a name='section5'></a>Testsuite Tooling Testsuites in Tcllib are based on Tcl's standard test package __tcltest__, plus utilities found in the directory "modules/devtools" Tcllib developers invoke the suites through the __test run__ method of the "sak\.tcl" tool, with other methods of __[test](\.\./\.\./\.\./index\.md\#test)__ providing management operations, for example setting a list of standard Tcl shells to use\. ## <a name='subsection12'></a>Invoke the testsuites of a specific module Invoke either ./sak.tcl test run foo or ./sak.tcl test run modules/foo to invoke the testsuites found in a specific module "foo"\. ## <a name='subsection13'></a>Invoke the testsuites of all modules Invoke the tool without a module name, i\.e\. ./sak.tcl test run to invoke the testsuites of all modules\. ## <a name='subsection14'></a>Detailed Test Logs In all the previous examples the test runner will write a combination of progress display and testsuite log to the standard output, showing for each module only the tests that passed or failed and how many of each in a summary at the end\. To get a detailed log, it is necessary to invoke the test runner with additional options\. For one: ./sak.tcl test run --log LOG foo While this shows the same short log on the terminal as before, it also writes a detailed log to the file "LOG\.log", and excerpts to other files \("LOG\.summary", "LOG\.failures", etc\.\)\. For two: ./sak.tcl test run -v foo This writes the detailed log to the standard output, instead of the short log\. Regardless of form, the detailed log contains a list of all test cases executed, which failed, and how they failed \(expected versus actual results\)\. ## <a name='subsection15'></a>Shell Selection By default the test runner will use all the Tcl shells specified via __test add__ to invoke the specified testsuites, if any\. If no such are specified it will fall back to the Tcl shell used to run the tool itself\. Use option __\-\-shell__ to explicitly specify the Tcl shell to use, like ./sak.tcl test run --shell /path/to/tclsh ... ## <a name='subsection16'></a>Help Invoke the tool as ./sak.tcl help test to see the detailed help for all methods of __[test](\.\./\.\./\.\./index\.md\#test)__, and the associated options\. # <a name='section6'></a>Documentation Tooling The standard format used for documentation of packages and other things in Tcllib is *[doctools](\.\./\.\./\.\./index\.md\#doctools)*\. Its supporting packages are a part of Tcllib, see the directories "modules/doctools" and "modules/dtplite"\. The latter is an application package, with the actual application "apps/dtplite" a light wrapper around it\. Tcllib developers gain access to these through the __doc__ method of the "sak\.tcl" tool, another \(internal\) wrapper around the "modules/dtplite" application package\. ## <a name='subsection17'></a>Generate documentation for a specific module Invoke either ./sak.tcl doc html foo or ./sak.tcl doc html modules/foo to generate HTML for the documentation found in the module "foo"\. Instead of __html__ any other supported format can be used here, of course\. The generated formatted documentation will be placed into a directory "doc" in the current working directory\. ## <a name='subsection18'></a>Generate documentation for all modules Invoke the tool without a module name, i\.e\. ./sak.tcl doc html to generate HTML for the documentation found in all modules\. Instead of __html__ any other supported format can be used here, of course\. The generated formatted documentation will be placed into a directory "doc" in the current working directory\. ## <a name='subsection19'></a>Available output formats, help Invoke the tool as ./sak.tcl help doc to see the entire set of supported output formats which can be generated\. ## <a name='subsection20'></a>Validation without output Note the special format __validate__\. Using this value as the name of the format to generate forces the tool to simply check that the documentation is syntactically correct, without generating actual output\. Invoke it as either ./sak.tcl doc validate (modules/)foo or ./sak.tcl doc validate to either check the packages of a specific module or check all of them\. # <a name='section7'></a>Notes On Writing A Testsuite While previous sections talked about running the testsuites for a module and the packages therein, this has no meaning if the module in question has no testsuites at all\. This section gives a very basic overview on possible methodologies for writing tests and testsuites\. First there are "drudgery" tests\. Written to check absolutely basic assumptions which should never fail\. For example for a command FOO taking two arguments, three tests calling it with zero, one, and three arguments\. The basic checks that the command fails if it has not enough arguments, or too many\. After that come the tests checking things based on our knowledge of the command, about its properties and assumptions\. Some examples based on the graph operations added during Google's Summer of Code 2009 are: - The BellmanFord command in struct::graph::ops takes a *startnode* as argument, and this node should be a node of the graph\. This equals one test case checking the behavior when the specified node is not a node of the graph\. This often gives rise to code in the implementation which explicitly checks the assumption and throws an understandable error, instead of letting the algorithm fail later in some weird non\-deterministic way\. It is not always possible to do such checks\. The graph argument for example is just a command in itself, and while we expect it to exhibit a certain interface, i\.e\. a set of sub\-commands aka methods, we cannot check that it has them, except by actually trying to use them\. That is done by the algorithm anyway, so an explicit check is just overhead we can get by without\. - IIRC one of the distinguishing characteristic of either BellmanFord and/or Johnson is that they are able to handle negative weights\. Whereas Dijkstra requires positive weights\. This induces \(at least\) three testcases \.\.\. Graph with all positive weights, all negative, and a mix of positive and negative weights\. Thinking further does the algorithm handle the weight __0__ as well ? Another test case, or several, if we mix zero with positive and negative weights\. - The two algorithms we are currently thinking about are about distances between nodes, and distance can be 'Inf'inity, i\.e\. nodes may not be connected\. This means that good test cases are 1. Strongly connected graph 1. Connected graph 1. Disconnected graph\. At the extremes of strongly connected and disconnected we have the fully connected graphs and graphs without edges, only nodes, i\.e\. completely disconnected\. - IIRC both of the algorithms take weighted arcs, and fill in a default if arcs are left unweighted in the input graph\. This also induces three test cases: 1. Graph will all arcs with explicit weights\. 1. Graph without weights at all\. 1. Graph with mixture of weighted and unweighted graphs\. What was described above via examples is called *black\-box* testing\. Test cases are designed and written based on the developer's knowledge of the properties of the algorithm and its inputs, without referencing a particular implementation\. Going further, a complement to *black\-box* testing is *white\-box*\. For this we know the implementation of the algorithm, we look at it and design our tests cases so that they force the code through all possible paths in the implementation\. Wherever a decision is made we have a test case forcing a specific direction of the decision, for all possible combinations and directions\. It is easy to get a combinatorial explosion in the number of needed test\-cases\. In practice I often hope that the black\-box tests I have made are enough to cover all the paths, obviating the need for white\-box tests\. The above should be enough to make it clear that writing tests for an algorithm takes at least as much time as coding the algorithm, and often more time\. Much more time\. See for example also [http://sqlite\.org/testing\.html](http://sqlite\.org/testing\.html), a writeup on how the Sqlite database engine is tested\. Another article of interest might be [https://www\.researchgate\.net/publication/298896236](https://www\.researchgate\.net/publication/298896236)\. While geared to a particular numerical algorithm it still shows that even a simple\-looking algorithm can lead to an incredible number of test cases\. An interesting connection is to documentation\. In one direction, the properties checked with black\-box testing are exactly the properties which should be documented in the algorithm's man page\. And conversely, the documentation of the properties of an algorithm makes a good reference to base the black\-box tests on\. In practice test cases and documentation often get written together, cross\-influencing each other\. And the actual writing of test cases is a mix of black and white box, possibly influencing the implementation while writing the tests\. Like writing a test for a condition like *startnode not in input graph* serving as reminder to put a check for this condition into the code\. # <a name='section8'></a>Installation Tooling A last thing to consider when adding a new package to the collection is installation\. How to *use* the "installer\.tcl" script is documented in *[Tcllib \- The Installer's Guide](tcllib\_installer\.md)*\. Here we document how to extend said installer so that it may install new package\(s\) and/or application\(s\)\. In most cases only a single file has to be modified, the "support/installation/modules\.tcl" holding one command per module and application to install\. The relevant commands are: - <a name='1'></a>__[Module](\.\./\.\./\.\./index\.md\#module)__ *name* *code\-action* *doc\-action* *example\-action* Install the packages of module *name*, found in "modules/*name*"\. The *code\-action* is responsible for installing the packages and their index\. The system currently provides * __\_tcl__ Copy all "\.tcl" files found in "modules/*name*" into the installation\. * __\_tcr__ As __\_tcl__, copy the "\.tcl" files found in the subdirectories of "modules/*name*" as well\. * __\_tci__ As __\_tcl__, and copy the "tclIndex\.tcl" file as well\. * __\_msg__ As __\_tcl__, and copy the subdirectory "msgs" as well\. * __\_doc__ As __\_tcl__, and copy the subdirectory "mpformats" as well\. * __\_tex__ As __\_tcl__, and copy "\.tex" files as well\. The *doc\-action* is responsible for installing the package documentation\. The system currently provides * __\_null__ No documentation available, do nothing\. * __\_man__ Process the "\.man" files found in "modules/*name*" and install the results \(nroff and/or HTML\) in the proper location, as given to the installer\. This is actually a fallback, normally the installer uses the pre\-made formatted documentation found under "idoc"\. The *example\-action* is responsible for installing the examples\. The system currently provides * __\_null__ No examples available, do nothing\. * __\_exa__ Copy the the directory "examples/*name*" recursively to the install location for examples\. - <a name='2'></a>__[Application](\.\./\.\./\.\./index\.md\#application)__ *name* Install the application with *name*, found in "apps"\. - <a name='3'></a>__Exclude__ *name* This command signals to the installer which of the listed modules to *not* install\. I\.e\. they name the deprecated modules of Tcllib\. If, and only if the above actions are not suitable for the new module then a second file has to be modified, "support/installation/actions\.tcl"\. This file contains the implementations of the available actions, and is the place where any custom action needed to handle the special circumstances of module has to be added\. |
Added embedded/md/tcllib/files/devdoc/tcllib_installer.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (tcllib\_install\_guide \- ) [//000000002]: # (Generated from file 'tcllib\_installer\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (tcllib\_install\_guide\(n\) 1 tcllib "") <hr> [ <a href="../../../toc.md">Main Table Of Contents</a> | <a href="../../toc.md">Table Of Contents</a> | <a href="../../../index.md">Keyword Index</a> | <a href="../../../toc0.md">Categories</a> | <a href="../../../toc1.md">Modules</a> | <a href="../../../toc2.md">Applications</a> ] <hr> # NAME tcllib\_install\_guide \- Tcllib \- The Installer's Guide # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Requisites](#section2) - [Tcl](#subsection1) - [Critcl](#subsection2) - [Build & Installation Instructions](#section3) - [Installing on Unix](#subsection3) - [Installing on Windows](#subsection4) - [Critcl & Accelerators](#subsection5) - [Tooling](#subsection6) # <a name='description'></a>DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\. Note that Tcllib is not a package itself\. It is a collection of \(semi\-independent\) *[Tcl](\.\./\.\./\.\./index\.md\#tcl)* packages that provide utility functions useful to a large collection of Tcl programmers\. The audience of this document is anyone wishing to build and install the packages found in Tcllib, for either themselves, or others\. For developers intending to work on the packages themselves we additionally provide 1. *[Tcllib \- The Developer's Guide](tcllib\_devguide\.md)*\. Please read *[Tcllib \- How To Get The Sources](tcllib\_sources\.md)* first, if that was not done already\. Here we assume that the sources are already available in a directory of your choice\. # <a name='section2'></a>Requisites Before Tcllib can be build and used a number of requisites must be installed\. These are: 1. The scripting language Tcl\. For details see [Tcl](#subsection1)\. 1. Optionally, the __critcl__ package \(C embedding\) for __[Tcl](\.\./\.\./\.\./index\.md\#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\. ## <a name='subsection1'></a>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\. Out of the many possibilities use whatever you are comfortable with, as long as it provides at the very least 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](http://www\.activestate\.com) 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](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 - Tcl [http://core\.tcl\-lang\.org/tcl/](http://core\.tcl\-lang\.org/tcl/) 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](\.\./\.\./\.\./index\.md\#tcl)*, or the vendor of your distribution, and *not* *[Tcllib](\.\./\.\./\.\./index\.md\#tcllib)*\. ## <a name='subsection2'></a>Critcl 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](#subsection5) Tcllib's build system looks for it in the , using the name __critcl__\. This is for Unix\. On Windows on the other hand the search is more complex\. First we look for a proper application __critcl\.exe__\. When that is not found we look for a combination of interpreter \(__tclkitsh\.exe__, __tclsh\.exe__\) and starkit \(__critcl\.kit__, __critcl__\) instead\. *Note* that the choice of starkit can be overriden via the environment variable \. Tcllib requires Critcl 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](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 these directions please file a ticket against the *Critcl* project, and not Tcllib\. # <a name='section3'></a>Build & Installation Instructions As Tcllib is mainly a bundle of packages written in pure Tcl building it is the same as installing it\. The exceptions to this have their own subsection, [Critcl & Accelerators](#subsection5), later on\. Before that however comes the standard case, differentiated by the platforms with material differences in the instruction, i\.e\. *Unix*\-like, versus *Windows*\. Regarding the latter it should also be noted that it is possible set up an *Unix*\-like environment using projects like *MSYS*, *Cygwin*, and others\. In that case the user has the choice of which instructions to follow\. Regardless of environment or platform, a suitable *[Tcl](\.\./\.\./\.\./index\.md\#tcl)* has to be installed, and its __tclsh__ should be placed on the \(*Unix*\) or associated with "\.tcl" files \(*Windows*\)\. ## <a name='subsection3'></a>Installing on Unix For *Unix*\-like environments Tcllib comes with the standard set of files to make ./configure make install a suitable way of installing it\. This is a standard non\-interactive install automatically figuring out where to place everything, i\.e\. packages, applications, and the manpages\. To get a graphical installer invoke ./installer.tcl instead\. ## <a name='subsection4'></a>Installing on Windows In a Windows environment we have the __installer\.tcl__ script to perform installation\. If the desired __tclsh__ is associated "\.tcl" files then double\-clicking / opening the __installer\.tcl__ is enough to invoke it in graphical mode\. This assumes that *[Tk](\.\./\.\./\.\./index\.md\#tk)* is installed and available as well\. Without *[Tk](\.\./\.\./\.\./index\.md\#tk)* the only way to invoke the installer are to open a DOS window, i\.e\. __cmd\.exe__, and then to invoke ./installer.tcl inside it\. ## <a name='subsection5'></a>Critcl & Accelerators While the majority of Tcllib consists of packages written in pure Tcl a number of packages also have *accelerators* associated with them\. These are __critcl__\-based C packages whose use will boost the performance of the packages using them\. These accelerators are optional, and they are not installed by default\. To build the accelerators the normally optional dependency on __critcl__ becomes required\. To build and install Tcllib with the accelerators in a Unix\-like environment invoke: ./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 Therefore in a Windows environment instead invoke ./sak.tcl critcl ./installer.tcl from within a DOS window, i\.e\. __cmd\.exe__\. ## <a name='subsection6'></a>Tooling The core of Tcllib's build system is the script "installer\.tcl" found in the toplevel directory of a checkout or release\. The configure ; make install setup available to developers on Unix\-like systems is just a wrapper around it\. To go beyond the standard embodied in the wrapper it is necessary to directly invoke this script\. On Windows system using it directly is the only way to invoke it\. For basic help invoke it as ./installer.tcl -help This will print a short list of all the available options to the standard output channel\. The commands associated with the various *install* targets in the *Makefile\.in* for Unix can be used as additional examples on how to use this tool as well\. The installer can operate in GUI and CLI modes\. By default it chooses the mode automatically, based on if the Tcl package __[Tk](\.\./\.\./\.\./index\.md\#tk)__ can be used or not\. The option __\-no\-gui__ can be used to force CLI mode\. Note that it is possible to specify options on the command line even if the installer ultimatively selects GUI mode\. In that case the hardwired defaults and the options determine the data presented to the user for editing\. The installer will select a number of defaults for the locations of packages, examples, and documentation, and also the format of the documentation\. The user can overide these defaults in the GUI, or by specifying additional options\. The defaults depend on the platform detected \(Unix/Windows\) and on the __tclsh__ executable used to run the installer\. *Options* - __\-help__ Show the list of options explained here on the standard output channel and exit\. - __\+excluded__ Include deprecated packages in the installation\. - __\-no\-gui__ Force command line operation of the installer - __\-no\-wait__ In CLI mode the installer will by default ask the user to confirm that the chosen configuration \(destination paths, things to install\) is correct before performing any action\. Using this option causes the installer to skip this query and immediately jump to installation\. - __\-app\-path__ *path* - __\-example\-path__ *path* - __\-html\-path__ *path* - __\-nroff\-path__ *path* - __\-pkg\-path__ *path* Declare the destination paths for the applications, examples, html documentation, nroff manpages, and packages\. The defaults are derived from the location of the __tclsh__ used to run the installer\. - __\-dry\-run__ - __\-simulate__ Run the installer without modifying the destination directories\. - __\-apps__ - __\-no\-apps__ - __\-examples__ - __\-no\-examples__ - __\-pkgs__ - __\-no\-pkgs__ - __\-html__ - __\-no\-html__ - __\-nroff__ - __\-no\-nroff__ \(De\)activate the installation of applications, examples, packages, html documentation, and nroff manpages\. Applications, examples, and packages are installed by default\. On Windows the html documentation is installed by default\. On Unix the nroff manpages are installed by default\. |
Added embedded/md/tcllib/files/devdoc/tcllib_license.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (tcllib\_license \- ) [//000000002]: # (Generated from file 'tcllib\_license\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (tcllib\_license\(n\) 1 tcllib "") <hr> [ <a href="../../../toc.md">Main Table Of Contents</a> | <a href="../../toc.md">Table Of Contents</a> | <a href="../../../index.md">Keyword Index</a> | <a href="../../../toc0.md">Categories</a> | <a href="../../../toc1.md">Modules</a> | <a href="../../../toc2.md">Applications</a> ] <hr> # NAME tcllib\_license \- Tcllib \- License # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [License](#section2) # <a name='description'></a>DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\. Note that Tcllib is not a package itself\. It is a collection of \(semi\-independent\) *[Tcl](\.\./\.\./\.\./index\.md\#tcl)* packages that provide utility functions useful to a large collection of Tcl programmers\. The collection is under the BSD license\. # <a name='section2'></a>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\. |
Added embedded/md/tcllib/files/devdoc/tcllib_releasemgr.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (tcllib\_releasemgr \- ) [//000000002]: # (Generated from file 'tcllib\_releasemgr\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (tcllib\_releasemgr\(n\) 1 tcllib "") <hr> [ <a href="../../../toc.md">Main Table Of Contents</a> | <a href="../../toc.md">Table Of Contents</a> | <a href="../../../index.md">Keyword Index</a> | <a href="../../../toc0.md">Categories</a> | <a href="../../../toc1.md">Modules</a> | <a href="../../../toc2.md">Applications</a> ] <hr> # NAME tcllib\_releasemgr \- Tcllib \- The Release Manager's Guide # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Tools](#section2) - [Tasks](#section3) - [Start a release candidate](#subsection1) - [Ready the candidate](#subsection2) - [Make it official](#subsection3) - [Distribute the release](#subsection4) # <a name='description'></a>DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\. Note that Tcllib is not a package itself\. It is a collection of \(semi\-independent\) *[Tcl](\.\./\.\./\.\./index\.md\#tcl)* packages that provide utility functions useful to a large collection of Tcl programmers\. The audience of this document is the release manager for Tcllib, their deputies, and anybody else interested in the task of creating an official release of Tcllib for distribution\. Please read *[Tcllib \- How To Get The Sources](tcllib\_sources\.md)* first, if that was not done already\. Here we assume that the sources are already available in a directory of your choice\. # <a name='section2'></a>Tools The "sak\.tcl" script in the toplevel directory of a Tcllib checkout is the one tool used by the release manager to perform its [Tasks](#section3)\. The main commands to be used are sak.tcl validate sak.tcl test run sak.tcl review sak.tcl readme sak.tcl localdoc sak.tcl release More detail will be provided in the explanations of the various [Tasks](#section3)\. # <a name='section3'></a>Tasks ## <a name='subsection1'></a>Start a release candidate todo: open a candidate for release ## <a name='subsection2'></a>Ready the candidate todo: test, validate and check that the candidate is worthy of release fix testsuites, possibly fix packages, documentation regenerate docs coordinate with package maintainers wrt fixes big thing: going over the packages, classify changes since last release to generate a nice readme\. ## <a name='subsection3'></a>Make it official todo: finalize release, make candidate official ## <a name='subsection4'></a>Distribute the release With the release made it has to be published and the world notified of its existence\. 1. Create a proper fossil event for the release, via [http://core\.tcl\-lang\.org/tcllib/eventedit](http://core\.tcl\-lang\.org/tcllib/eventedit)\. An [existing event](http://core\.tcl\-lang\.org/tcllib/event/dac0ddcd2e990234143196b4dc438fe01e7b9817) should be used as template\. 1. Update a number of web locations: 1) [Home page](http://core\.tcl\-lang\.org/tcllib/doc/trunk/embedded/index\.md) 1) [Downloads](http://core\.tcl\-lang\.org/tcllib/wiki?name=Downloads) 1) [Past Releases](http://core\.tcl\-lang\.org/tcllib/wiki?name=Past\+Releases) 1) [http://www\.tcl\-lang\.org/home/release\.txt](http://www\.tcl\-lang\.org/home/release\.txt) 1) [http://www\.tcl\-lang\.org/software/tcllib/\*\.tml](http://www\.tcl\-lang\.org/software/tcllib/\*\.tml) 1) [http://wiki\.tcl\-lang\.org/page/Tcllib](http://wiki\.tcl\-lang\.org/page/Tcllib) The first location maps to the file "embedded/index\.md" in the repository itself, as such it can edited as part of the release process\. This is where reference to the new fossil event is added, as the new current release\. The next two locations are in the fossil tcllib wiki and require admin or wiki write permissions for [http://core\.tcl\-lang\.org/tcllib](http://core\.tcl\-lang\.org/tcllib)\. The last two locations require ssh access to [http://www\.tcl\-lang\.org](http://www\.tcl\-lang\.org) and permission to edit files in the web area\. 1. \*\*\*TODO\*\*\* mailing lists and other places to send notes to\. |
Added embedded/md/tcllib/files/devdoc/tcllib_sources.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (tcllib\_sources \- ) [//000000002]: # (Generated from file 'tcllib\_sources\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (tcllib\_sources\(n\) 1 tcllib "") <hr> [ <a href="../../../toc.md">Main Table Of Contents</a> | <a href="../../toc.md">Table Of Contents</a> | <a href="../../../index.md">Keyword Index</a> | <a href="../../../toc0.md">Categories</a> | <a href="../../../toc1.md">Modules</a> | <a href="../../../toc2.md">Applications</a> ] <hr> # NAME tcllib\_sources \- Tcllib \- How To Get The Sources # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Source Location](#section2) - [Retrieval](#section3) - [Source Code Management](#section4) # <a name='description'></a>DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\. Note that Tcllib is not a package itself\. It is a collection of \(semi\-independent\) *[Tcl](\.\./\.\./\.\./index\.md\#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 1. *[Tcllib \- The Installer's Guide](tcllib\_installer\.md)*\. 1. *[Tcllib \- The Developer's Guide](tcllib\_devguide\.md)*\. respectively\. # <a name='section2'></a>Source Location The official repository for Tcllib can be found at [http://core\.tcl\-lang\.org/tcllib](http://core\.tcl\-lang\.org/tcllib) # <a name='section3'></a>Retrieval Assuming that you simply wish to look at the sources, or build a specific revision, the easiest way of retrieving it is to: 1. Log into this site, as "anonymous", using the semi\-random password in the captcha\. 1. Go to the "Timeline"\. 1. Choose the revision you wish to have\. 1. Follow its link to its detailed information page\. 1. On that page, choose either the "ZIP" or "Tarball" link to get a copy of this revision in the format of your choice\. # <a name='section4'></a>Source Code Management For the curious \(or a developer\-to\-be\), the sources are managed by the [Fossil SCM](http://www\.fossil\-scm\.org)\. Binaries for popular platforms can be found directly at its [download page](http://www\.fossil\-scm\.org/download\.html)\. 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\. |
Changes to embedded/md/tcllib/files/modules/aes/aes.md.
1 2 3 | [//000000001]: # (aes \- Advanced Encryption Standard \(AES\)) [//000000002]: # (Generated from file 'aes\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (aes \- Advanced Encryption Standard \(AES\)) [//000000002]: # (Generated from file 'aes\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2005, Pat Thoyts <patthoyts@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2012\-2014, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (aes\(n\) 1\.2\.1 tcllib "Advanced Encryption Standard \(AES\)") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/asn/asn.md.
1 2 3 | [//000000001]: # (asn \- ASN\.1 processing) [//000000002]: # (Generated from file 'asn\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (asn \- ASN\.1 processing) [//000000002]: # (Generated from file 'asn\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004 Jochen Loewer <loewerj@web\.de>) [//000000005]: # (Copyright © 2004\-2011 Michael Schlenker <mic42@users\.sourceforge\.net>) [//000000006]: # (asn\(n\) 0\.8 tcllib "ASN\.1 processing") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/base64/base64.md.
1 2 3 | [//000000001]: # (base64 \- Text encoding & decoding binary data) [//000000002]: # (Generated from file 'base64\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (base64 \- Text encoding & decoding binary data) [//000000002]: # (Generated from file 'base64\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2000, Eric Melski) [//000000004]: # (Copyright © 2001, Miguel Sofer) [//000000005]: # (base64\(n\) 2\.4\.2 tcllib "Text encoding & decoding binary data") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/bench/bench_lang_intro.md.
︙ | ︙ | |||
76 77 78 79 80 81 82 | __\-post__\-body, respectively\. In our example, directly drawn from the benchmark suite of Tcllib's __[aes](\.\./aes/aes\.md)__ package, the concrete initialization code constructs the key schedule used by the encryption command whose speed we measure, and the cleanup code releases any resources bound to that schedule\. | | | | | | | < > | 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | __\-post__\-body, respectively\. In our example, directly drawn from the benchmark suite of Tcllib's __[aes](\.\./aes/aes\.md)__ package, the concrete initialization code constructs the key schedule used by the encryption command whose speed we measure, and the cleanup code releases any resources bound to that schedule\. > bench \-desc "AES\-$\{len\} ECB encryption core" __\-pre__ \{ > set key \[aes::Init ecb $k $i\] > \} \-body \{ > aes::Encrypt $key $p > \} __\-post__ \{ > aes::Final $key > \} ## <a name='subsection4'></a>Advanced pre\- and postprocessing Our last example again deals with initialization and cleanup code\. To see the difference to the regular initialization and cleanup discussed in the last section it is necessary to know a bit more about how bench actually measures the speed of the the __\-body__\. |
︙ | ︙ | |||
127 128 129 130 131 132 133 | example we used above to demonstrate the necessity for the advanced initialization and cleanup\. Its concrete initialization code constructs a variable refering to a set with specific properties \(The set has a string representation, which is shared\) affecting the speed of the inclusion command, and the cleanup code releases the temporary variables created by this initialization\. | | | | | | | | < > | 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | example we used above to demonstrate the necessity for the advanced initialization and cleanup\. Its concrete initialization code constructs a variable refering to a set with specific properties \(The set has a string representation, which is shared\) affecting the speed of the inclusion command, and the cleanup code releases the temporary variables created by this initialization\. > bench \-desc "set include, missing <SC> x$times $n" __\-ipre__ \{ > set A $sx\($times,$n\) > set B $A > \} \-body \{ > struct::set include A x > \} __\-ipost__ \{ > unset A B > \} # <a name='section2'></a>FURTHER READING Now that this document has been digested the reader, assumed to be a *writer* of benchmarks, he should be fortified enough to be able to understand the formal *bench language specfication*\. It will also serve as the detailed specification and cheat sheet for all available commands and their syntax\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/comm/comm.md.
1 2 3 | [//000000001]: # (comm \- Remote communication) [//000000002]: # (Generated from file 'comm\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (comm \- Remote communication) [//000000002]: # (Generated from file 'comm\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 1995\-1998 The Open Group\. All Rights Reserved\.) [//000000004]: # (Copyright © 2003\-2004 ActiveState Corporation\.) [//000000005]: # (Copyright © 2006\-2009 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000006]: # (comm\(n\) 4\.6\.3 tcllib "Remote communication") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/debug/debug.md.
1 2 3 | [//000000001]: # (debug \- debug narrative) [//000000002]: # (Generated from file 'debug\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (debug \- debug narrative) [//000000002]: # (Generated from file 'debug\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 200?, Colin McCormack, Wub Server Utilities) [//000000004]: # (Copyright © 2012\-2014, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (debug\(n\) 1\.0\.6 tcllib "debug narrative") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/debug/debug_heartbeat.md.
1 2 3 | [//000000001]: # (debug::heartbeat \- debug narrative) [//000000002]: # (Generated from file 'debug\_heartbeat\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (debug::heartbeat \- debug narrative) [//000000002]: # (Generated from file 'debug\_heartbeat\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 200?, Colin McCormack, Wub Server Utilities) [//000000004]: # (Copyright © 2012, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (debug::heartbeat\(n\) 1 tcllib "debug narrative") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/debug/debug_timestamp.md.
1 2 3 | [//000000001]: # (debug::timestamp \- debug narrative) [//000000002]: # (Generated from file 'debug\_timestamp\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (debug::timestamp \- debug narrative) [//000000002]: # (Generated from file 'debug\_timestamp\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 200?, Colin McCormack, Wub Server Utilities) [//000000004]: # (Copyright © 2012, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (debug::timestamp\(n\) 1 tcllib "debug narrative") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/dicttool/dicttool.md.
︙ | ︙ | |||
30 31 32 33 34 35 36 37 38 39 40 41 42 43 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 [__ladd__ *varname* *args*](#1) [__ldelete__ *varname* *args*](#2) [__dict getnull__ *args*](#3) [__dict print__ *dict*](#4) [__dict is\_dict__ *value*](#5) [__rmerge__ *args*](#6) | > | 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require dicttool ?1\.0? [__ladd__ *varname* *args*](#1) [__ldelete__ *varname* *args*](#2) [__dict getnull__ *args*](#3) [__dict print__ *dict*](#4) [__dict is\_dict__ *value*](#5) [__rmerge__ *args*](#6) |
︙ | ︙ | |||
53 54 55 56 57 58 59 | - <a name='1'></a>__ladd__ *varname* *args* This command will add a new instance of each element in *args* to *varname*, but only if that element is not already present\. - <a name='2'></a>__ldelete__ *varname* *args* | | | | 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | - <a name='1'></a>__ladd__ *varname* *args* This command will add a new instance of each element in *args* to *varname*, but only if that element is not already present\. - <a name='2'></a>__ldelete__ *varname* *args* This command will delete all instances of each element in *args* from *varname*\. - <a name='3'></a>__dict getnull__ *args* Operates like __dict get__, however if the key *args* does not exist, it returns an empty list instead of throwing an error\. - <a name='4'></a>__dict print__ *dict* |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/dns/tcllib_ip.md.
1 2 3 | [//000000001]: # (tcllib\_ip \- Domain Name Service) [//000000002]: # (Generated from file 'tcllib\_ip\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (tcllib\_ip \- Domain Name Service) [//000000002]: # (Generated from file 'tcllib\_ip\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004, Pat Thoyts) [//000000004]: # (Copyright © 2005 Aamer Akhter <aakhter@cisco\.com>) [//000000005]: # (tcllib\_ip\(n\) 1\.4 tcllib "Domain Name Service") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/docstrip/docstrip.md.
︙ | ︙ | |||
391 392 393 394 395 396 397 | that files employing that document format are given the suffix "\.ddt", to distinguish them from the more traditional LaTeX\-based "\.dtx" files\. Master source files with "\.dtx" extension are usually set up so that they can be typeset directly by __[latex](\.\./\.\./\.\./\.\./index\.md\#latex)__ without any support from other files\. This is achieved by beginning the file with the lines | | | | | | | | | | 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | that files employing that document format are given the suffix "\.ddt", to distinguish them from the more traditional LaTeX\-based "\.dtx" files\. Master source files with "\.dtx" extension are usually set up so that they can be typeset directly by __[latex](\.\./\.\./\.\./\.\./index\.md\#latex)__ without any support from other files\. This is achieved by beginning the file with the lines > % \\iffalse > %<\*driver> > \\documentclass\{tclldoc\} > \\begin\{document\} > \\DocInput\{*filename\.dtx*\} > \\end\{document\} > %</driver> > % \\fi or some variation thereof\. The trick is that the file gets read twice\. With normal LaTeX reading rules, the first two lines are comments and therefore ignored\. The third line is the document preamble, the fourth line begins the document body, and the sixth line ends the document, so LaTeX stops there — non\-comments below that point in the file are never subjected to the normal LaTeX reading rules\. Before that, however, the \\DocInput command on the fifth |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools/docidx_lang_intro.md.
︙ | ︙ | |||
59 60 61 62 63 64 65 | Each markup command is a Tcl command surrounded by a matching pair of __\[__ and __\]__\. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc\. I\.e\. ... [key {markup language}] ... | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | Each markup command is a Tcl command surrounded by a matching pair of __\[__ and __\]__\. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc\. I\.e\. ... [key {markup language}] ... ... [manpage thefile \ {file description}] ... ## <a name='subsection2'></a>Basic structure The most simple document which can be written in docidx is [index_begin GROUPTITLE TITLE] [index_end] Not very useful, but valid\. This also shows us that all docidx documents consist of only one part where we will list all keys and their references\. A more useful index will contain at least keywords, or short 'keys', i\.e\. the phrases which were indexed\. So: > \[index\_begin GROUPTITLE TITLE\] > \[__key markup__\] > \[__key \{semantic markup\}\]__\] > \[__key \{docidx markup\}__\] > \[__key \{docidx language\}__\] > \[__key \{docidx commands\}__\] > \[index\_end\] In the above example the command __key__ is used to declare the keyword phrases we wish to be part of the index\. However a truly useful index does not only list the keyword phrases, but will also contain references to documents associated with the keywords\. Here is a made\-up index for all the manpages in the module *[base64](\.\./\.\./\.\./\.\./index\.md\#base64)*: > \[index\_begin tcllib/base64 \{De\- & Encoding\}\] > \[key base64\] > \[__manpage base64__\] > \[key encoding\] > \[__manpage base64__\] > \[__manpage uuencode__\] > \[__manpage yencode__\] > \[key uuencode\] > \[__manpage uuencode__\] > \[key yEnc\] > \[__manpage yencode__\] > \[key ydecode\] > \[__manpage yencode__\] > \[key yencode\] > \[__manpage yencode__\] > \[index\_end\] In the above example the command __[manpage](\.\./\.\./\.\./\.\./index\.md\#manpage)__ is used to insert references to documents, using symbolic file names, with each command belonging to the last __key__ command coming before it\. The other command to insert references is |
︙ | ︙ | |||
130 131 132 133 134 135 136 | to be used before the __index\_begin__ command opening the document\. Instead of only whitespace the two templating commands __include__ and __vset__ are also allowed, to enable the writer to either set and/or import configuration settings relevant to the table of contents\. I\.e\. it is possible to write | | | | | | | | | | | | | | | | | 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 | to be used before the __index\_begin__ command opening the document\. Instead of only whitespace the two templating commands __include__ and __vset__ are also allowed, to enable the writer to either set and/or import configuration settings relevant to the table of contents\. I\.e\. it is possible to write > \[__include FILE__\] > \[__vset VAR VALUE__\] > \[index\_begin GROUPTITLE TITLE\] > \.\.\. > \[index\_end\] Even more important, these two commands are allowed anywhere where a markup command is allowed, without regard for any other structure\. > \[index\_begin GROUPTITLE TITLE\] > \[__include FILE__\] > \[__vset VAR VALUE__\] > \.\.\. > \[index\_end\] The only restriction __include__ has to obey is that the contents of the included file must be valid at the place of the inclusion\. I\.e\. a file included before __index\_begin__ may contain only the templating commands __vset__ and __include__, a file included after a key may contain only manape or url references, and other keys, etc\. ## <a name='subsection4'></a>Escapes Beyond the 6 commands shown so far we have two more available\. However their function is not the marking up of index structure, but the insertion of characters, namely __\[__ and __\]__\. These commands, __lb__ and __rb__ respectively, are required because our use of \[ and \] to bracket markup commands makes it impossible to directly use \[ and \] within the text\. Our example of their use are the sources of the last sentence in the previous paragraph, with some highlighting added\. > \.\.\. > These commands, \[cmd lb\] and \[cmd lb\] respectively, are required > because our use of \[__lb__\] and \[__rb__\] to bracket markup commands makes it > impossible to directly use \[__lb__\] and \[__rb__\] within the text\. > \.\.\. # <a name='section2'></a>FURTHER READING Now that this document has been digested the reader, assumed to be a *writer* of documentation should be fortified enough to be able to understand the formal *[docidx language syntax](docidx\_lang\_syntax\.md)* specification as well\. From here on out the *[docidx language command |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools/doctoc_lang_intro.md.
︙ | ︙ | |||
63 64 65 66 67 68 69 | Each markup command is a Tcl command surrounded by a matching pair of __\[__ and __\]__\. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc\. I\.e\. ... [division_start {Appendix 1}] ... | | | 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | Each markup command is a Tcl command surrounded by a matching pair of __\[__ and __\]__\. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc\. I\.e\. ... [division_start {Appendix 1}] ... ... [item thefile \ label {file description}] ... ## <a name='subsection2'></a>Basic structure The most simple document which can be written in doctoc is [toc_begin GROUPTITLE TITLE] |
︙ | ︙ | |||
98 99 100 101 102 103 104 | Symbolic names are used to preserve the convertibility of this format to any output format\. The actual name of any file will be inserted by the chosen formatting engine when converting the input, based on a mapping from symbolic to actual names given to the engine\. Here a made up example for a table of contents of this document: | | | | | | | | | 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | Symbolic names are used to preserve the convertibility of this format to any output format\. The actual name of any file will be inserted by the chosen formatting engine when converting the input, based on a mapping from symbolic to actual names given to the engine\. Here a made up example for a table of contents of this document: > \[toc\_begin Doctoc \{Language Introduction\}\] > \[__item 1 DESCRIPTION__\] > \[__item 1\.1 \{Basic structure\}__\] > \[__item 1\.2 Items__\] > \[__item 1\.3 Divisions__\] > \[__item 2 \{FURTHER READING\}__\] > \[toc\_end\] ## <a name='subsection4'></a>Divisions One thing of notice in the last example in the previous section is that the referenced sections actually had a nested structure, something which was expressed in the item labels, by using a common prefix for all the sections nested under section 1\. |
︙ | ︙ | |||
137 138 139 140 141 142 143 | - __division\_end__ This command closes the last opened and not yet closed division\. Using this we can recast the last example like this | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | - __division\_end__ This command closes the last opened and not yet closed division\. Using this we can recast the last example like this > \[toc\_begin Doctoc \{Language Introduction\}\] > \[__division\_start DESCRIPTION__\] > \[item 1 \{Basic structure\}\] > \[item 2 Items\] > \[item 3 Divisions\] > \[__division\_end__\] > \[__division\_start \{FURTHER READING\}__\] > \[__division\_end__\] > \[toc\_end\] Or, to demonstrate deeper nesting > \[toc\_begin Doctoc \{Language Introduction\}\] > \[__division\_start DESCRIPTION__\] > \[__division\_start \{Basic structure\}__\] > \[item 1 Do\] > \[item 2 Re\] > \[__division\_end__\] > \[__division\_start Items__\] > \[item a Fi\] > \[item b Fo\] > \[item c Fa\] > \[__division\_end__\] > \[__division\_start Divisions__\] > \[item 1 Sub\] > \[item 1 Zero\] > \[__division\_end__\] > \[__division\_end__\] > \[__division\_start \{FURTHER READING\}__\] > \[__division\_end__\] > \[toc\_end\] And do not forget, it is possible to freely mix items and divisions, and to have empty divisions\. > \[toc\_begin Doctoc \{Language Introduction\}\] > \[item 1 Do\] > \[__division\_start DESCRIPTION__\] > \[__division\_start \{Basic structure\}__\] > \[item 2 Re\] > \[__division\_end__\] > \[item a Fi\] > \[__division\_start Items__\] > \[item b Fo\] > \[item c Fa\] > \[__division\_end__\] > \[__division\_start Divisions__\] > \[__division\_end__\] > \[__division\_end__\] > \[__division\_start \{FURTHER READING\}__\] > \[__division\_end__\] > \[toc\_end\] ## <a name='subsection5'></a>Advanced structure In all previous examples we fudged a bit regarding the markup actually allowed to be used before the __toc\_begin__ command opening the document\. Instead of only whitespace the two templating commands __include__ and __vset__ are also allowed, to enable the writer to either set and/or import configuration settings relevant to the table of contents\. I\.e\. it is possible to write > \[__include FILE__\] > \[__vset VAR VALUE__\] > \[toc\_begin GROUPTITLE TITLE\] > \.\.\. > \[toc\_end\] Even more important, these two commands are allowed anywhere where a markup command is allowed, without regard for any other structure\. > \[toc\_begin GROUPTITLE TITLE\] > \[__include FILE__\] > \[__vset VAR VALUE__\] > \.\.\. > \[toc\_end\] The only restriction __include__ has to obey is that the contents of the included file must be valid at the place of the inclusion\. I\.e\. a file included before __toc\_begin__ may contain only the templating commands __vset__ and __include__, a file included in a division may contain only items or divisions commands, etc\. ## <a name='subsection6'></a>Escapes Beyond the 6 commands shown so far we have two more available\. However their function is not the marking up of toc structure, but the insertion of characters, namely __\[__ and __\]__\. These commands, __lb__ and __rb__ respectively, are required because our use of \[ and \] to bracket markup commands makes it impossible to directly use \[ and \] within the text\. Our example of their use are the sources of the last sentence in the previous paragraph, with some highlighting added\. > \.\.\. > These commands, \[cmd lb\] and \[cmd lb\] respectively, are required > because our use of \[__lb__\] and \[__rb__\] to bracket markup commands makes it > impossible to directly use \[__lb__\] and \[__rb__\] within the text\. > \.\.\. # <a name='section2'></a>FURTHER READING Now that this document has been digested the reader, assumed to be a *writer* of documentation should be fortified enough to be able to understand the formal *[doctoc language syntax](doctoc\_lang\_syntax\.md)* specification as well\. From here on out the *[doctoc language command |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools/doctools.md.
1 2 3 4 | [//000000001]: # (doctools \- Documentation tools) [//000000002]: # (Generated from file 'doctools\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2003\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools \- Documentation tools) [//000000002]: # (Generated from file 'doctools\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2003\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools\(n\) 1\.5\.6 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
46 47 48 49 50 51 52 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.2 | | | 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.2 package require doctools ?1\.5\.6? [__::doctools::new__ *objectName* ?*option value*\.\.\.?](#1) [__::doctools::help__](#2) [__::doctools::search__ *path*](#3) [__objectName__ __method__ ?*arg arg \.\.\.*?](#4) [*objectName* __configure__](#5) [*objectName* __configure__ *option*](#6) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools/doctools_lang_intro.md.
︙ | ︙ | |||
68 69 70 71 72 73 74 | Each markup command is a Tcl command surrounded by a matching pair of __\[__ and __\]__\. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc\. I\.e\. ... [list_begin enumerated] ... | | | 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | Each markup command is a Tcl command surrounded by a matching pair of __\[__ and __\]__\. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc\. I\.e\. ... [list_begin enumerated] ... ... [call [cmd foo] \ [arg bar]] ... ... [term {complex concept}] ... ... [opt "[arg key] [arg value]"] ... ## <a name='subsection2'></a>Basic structure |
︙ | ︙ | |||
92 93 94 95 96 97 98 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] This also shows us that all doctools documents are split into two parts, the *header* and the *body*\. Everything coming before \[__description__\] belongs to the header, and everything coming after belongs to the body, with the whole document bracketed by the two __manpage\_\*__ commands\. Before and after these opening and closing commands we have only *whitespace*\. |
︙ | ︙ | |||
128 129 130 131 132 133 134 | and they can be used in any order\. However for __titledesc__ and __moddesc__ only the last occurrence is taken\. For the other two the specified information is accumulated, in the given order\. Regular text is not allowed within the header\. Given the above a less minimal example of a document is | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | and they can be used in any order\. However for __titledesc__ and __moddesc__ only the last occurrence is taken\. For the other two the specified information is accumulated, in the given order\. Regular text is not allowed within the header\. Given the above a less minimal example of a document is > \[manpage\_begin NAME SECTION VERSION\] > \[__copyright \{YEAR AUTHOR\}__\] > \[__titledesc TITLE__\] > \[__moddesc MODULE\_TITLE__\] > \[__require PACKAGE VERSION__\] > \[__require PACKAGE__\] > \[description\] > \[manpage\_end\] Remember that the whitespace is optional\. The document [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] has the same meaning as the example before\. On the other hand, if *whitespace* is present it consists not only of any sequence of characters containing the space character, horizontal and vertical tabs, carriage return, and newline, but it may contain comment markup as well, in the form of the __[comment](\.\./\.\./\.\./\.\./index\.md\#comment)__ command\. > \[__comment \{ \.\.\. \}__\] > \[manpage\_begin NAME SECTION VERSION\] > \[copyright \{YEAR AUTHOR\}\] > \[titledesc TITLE\] > \[moddesc MODULE\_TITLE\]\[__comment \{ \.\.\. \}__\] > \[require PACKAGE VERSION\] > \[require PACKAGE\] > \[description\] > \[manpage\_end\] > \[__comment \{ \.\.\. \}__\] ## <a name='subsection3'></a>Advanced structure In the simple examples of the last section we fudged a bit regarding the markup actually allowed to be used before the __manpage\_begin__ command opening the document\. Instead of only whitespace the two templating commands __include__ and __vset__ are also allowed, to enable the writer to either set and/or import configuration settings relevant to the document\. I\.e\. it is possible to write > \[__include FILE__\] > \[__vset VAR VALUE__\] > \[manpage\_begin NAME SECTION VERSION\] > \[description\] > \[manpage\_end\] Even more important, these two commands are allowed anywhere where a markup command is allowed, without regard for any other structure\. I\.e\. for example in the header as well\. > \[manpage\_begin NAME SECTION VERSION\] > \[__include FILE__\] > \[__vset VAR VALUE__\] > \[description\] > \[manpage\_end\] The only restriction __include__ has to obey is that the contents of the included file must be valid at the place of the inclusion\. I\.e\. a file included before __manpage\_begin__ may contain only the templating commands __vset__ and __include__, a file included in the header may contain only header commands, etc\. |
︙ | ︙ | |||
213 214 215 216 217 218 219 | The simplest way of structuring the body is through the introduction of paragraphs\. The command for doing so is __para__\. Each occurrence of this command closes the previous paragraph and automatically opens the next\. The first paragraph is automatically opened at the beginning of the body, by __description__\. In the same manner the last paragraph automatically ends at __manpage\_end__\. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | The simplest way of structuring the body is through the introduction of paragraphs\. The command for doing so is __para__\. Each occurrence of this command closes the previous paragraph and automatically opens the next\. The first paragraph is automatically opened at the beginning of the body, by __description__\. In the same manner the last paragraph automatically ends at __manpage\_end__\. > \[manpage\_begin NAME SECTION VERSION\] > \[description\] > \.\.\. > \[__para__\] > \.\.\. > \[__para__\] > \.\.\. > \[manpage\_end\] Empty paragraphs are ignored\. A structure coarser than paragraphs are sections, which allow the writer to split a document into larger, and labeled, pieces\. The command for doing so is __section__\. Each occurrence of this command closes the previous section and automatically opens the next, including its first paragraph\. The first section is automatically opened at the beginning of the body, by __description__ \(This section is labeled "DESCRIPTION"\)\. In the same manner the last section automatically ends at __manpage\_end__\. Empty sections are *not* ignored\. We are free to \(not\) use paragraphs within sections\. > \[manpage\_begin NAME SECTION VERSION\] > \[description\] > \.\.\. > \[__section \{Section A\}__\] > \.\.\. > \[para\] > \.\.\. > \[__section \{Section B\}__\] > \.\.\. > \[manpage\_end\] Between sections and paragraphs we have subsections, to split sections\. The command for doing so is __subsection__\. Each occurrence of this command closes the previous subsection and automatically opens the next, including its first paragraph\. A subsection is automatically opened at the beginning of the body, by __description__, and at the beginning of each section\. In the same manner the last subsection automatically ends at __manpage\_end__\. Empty subsections are *not* ignored\. We are free to \(not\) use paragraphs within subsections\. > \[manpage\_begin NAME SECTION VERSION\] > \[description\] > \.\.\. > \[section \{Section A\}\] > \.\.\. > \[__subsection \{Sub 1\}__\] > \.\.\. > \[para\] > \.\.\. > \[__subsection \{Sub 2\}__\] > \.\.\. > \[section \{Section B\}\] > \.\.\. > \[manpage\_end\] ## <a name='subsection5'></a>Text markup Having handled the overall structure a writer can impose on the document we now take a closer at the text in a paragraph\. While most often this is just the unadorned content of the document we do have |
︙ | ︙ | |||
375 376 377 378 379 380 381 | Its argument is a widget name\. The example demonstrating the use of text markup is an excerpt from the *[doctools language command reference](doctools\_lang\_cmdref\.md)*, with some highlighting added\. It shows their use within a block of text, as the arguments of a list item command \(__call__\), and our ability to nest them\. | | | | | | | | | | | | | | | 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 | Its argument is a widget name\. The example demonstrating the use of text markup is an excerpt from the *[doctools language command reference](doctools\_lang\_cmdref\.md)*, with some highlighting added\. It shows their use within a block of text, as the arguments of a list item command \(__call__\), and our ability to nest them\. > \.\.\. > \[call \[__cmd arg\_def__\] \[__arg type__\] \[__arg name__\] \[__opt__ \[__arg mode__\]\]\] > > Text structure\. List element\. Argument list\. Automatically closes the > previous list element\. Specifies the data\-\[__arg type__\] of the described > argument of a command, its \[__arg name__\] and its i/o\-\[__arg mode__\]\. The > latter is optional\. > \.\.\. ## <a name='subsection6'></a>Escapes Beyond the 20 commands for simple markup shown in the previous section we have two more available which are technically simple markup\. However their function is not the marking up of phrases as specific types of things, but the insertion of characters, namely __\[__ and __\]__\. These commands, __lb__ and __rb__ respectively, are required because our use of \[ and \] to bracket markup commands makes it impossible to directly use \[ and \] within the text\. Our example of their use are the sources of the last sentence in the previous paragraph, with some highlighting added\. > \.\.\. > These commands, \[cmd lb\] and \[cmd lb\] respectively, are required > because our use of \[__lb__\] and \[__rb__\] to bracket markup commands makes it > impossible to directly use \[__lb__\] and \[__rb__\] within the text\. > \.\.\. ## <a name='subsection7'></a>Cross\-references The last two commands we have to discuss are for the declaration of cross\-references between documents, explicit and implicit\. They are __[keywords](\.\./\.\./\.\./\.\./index\.md\#keywords)__ and __see\_also__\. Both take an arbitrary number of arguments, all of which have to be plain unmarked |
︙ | ︙ | |||
432 433 434 435 436 437 438 | whether she wants to have them at the beginning of the body, or at its end, maybe near the place a keyword is actually defined by the main content, or considers them as meta data which should be in the header, etc\. Our example shows the sources for the cross\-references of this document, with some highlighting added\. Incidentally they are found at the end of the body\. | | | | | | | | | | | | | | | | 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 | whether she wants to have them at the beginning of the body, or at its end, maybe near the place a keyword is actually defined by the main content, or considers them as meta data which should be in the header, etc\. Our example shows the sources for the cross\-references of this document, with some highlighting added\. Incidentally they are found at the end of the body\. > \.\.\. > \[__see\_also doctools\_intro__\] > \[__see\_also doctools\_lang\_syntax__\] > \[__see\_also doctools\_lang\_cmdref__\] > \[__keywords markup \{semantic markup\}__\] > \[__keywords \{doctools markup\} \{doctools language\}__\] > \[__keywords \{doctools syntax\} \{doctools commands\}__\] > \[manpage\_end\] ## <a name='subsection8'></a>Examples Where ever we can write plain text we can write examples too\. For simple examples we have the command __example__ which takes a single argument, the text of the argument\. The example text must not contain markup\. If we wish to have markup within an example we have to use the 2\-command combination __example\_begin__ / __example\_end__ instead\. The first opens an example block, the other closes it, and in between we can write plain text and use all the regular text markup commands\. Note that text structure commands are not allowed\. This also means that it is not possible to embed examples and lists within an example\. On the other hand, we *can* use templating commands within example blocks to read their contents from a file \(Remember section [Advanced structure](#subsection3)\)\. The source for the very first example in this document \(see section [Fundamentals](#subsection1)\), with some highlighting added, is > \[__example__ \{ > \.\.\. \[list\_begin enumerated\] \.\.\. > \}\] Using __example\_begin__ / __example\_end__ this would look like > \[__example\_begin__\] > \.\.\. \[list\_begin enumerated\] \.\.\. > \[__example\_end__\] ## <a name='subsection9'></a>Lists Where ever we can write plain text we can write lists too\. The main commands are __list\_begin__ to start a list, and __list\_end__ to close one\. The opening command takes an argument specifying the type of list started it, and this in turn determines which of the eight existing list item commands are |
︙ | ︙ | |||
530 531 532 533 534 535 536 | is a specialized form of a term definition list where the term is the name of a configuration option for a widget, with its name and class in the option database\. Our example is the source of the definition list in the previous paragraph, with most of the content in the middle removed\. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | is a specialized form of a term definition list where the term is the name of a configuration option for a widget, with its name and class in the option database\. Our example is the source of the definition list in the previous paragraph, with most of the content in the middle removed\. > \.\.\. > \[__list\_begin__ definitions\] > \[__def__ \[const arg\]\] > > \(\[cmd arg\_def\]\) This opens an argument \(declaration\) list\. It is a > specialized form of a definition list where the term is an argument > name, with its type and i/o\-mode\. > > \[__def__ \[const itemized\]\] > > \(\[cmd item\]\) > This opens a general itemized list\. > > \.\.\. > \[__def__ \[const tkoption\]\] > > \(\[cmd tkoption\_def\]\) This opens a widget option \(declaration\) list\. It > is a specialized form of a definition list where the term is the name > of a configuration option for a widget, with its name and class in the > option database\. > > \[__list\_end__\] > \.\.\. Note that a list cannot begin in one \(sub\)section and end in another\. Differently said, \(sub\)section breaks are not allowed within lists and list items\. An example of this *illegal* construct is > \.\.\. > \[list\_begin itemized\] > \[item\] > \.\.\. > \[__section \{ILLEGAL WITHIN THE LIST\}__\] > \.\.\. > \[list\_end\] > \.\.\. # <a name='section2'></a>FURTHER READING Now that this document has been digested the reader, assumed to be a *writer* of documentation should be fortified enough to be able to understand the formal *[doctools language syntax](doctools\_lang\_syntax\.md)* specification as well\. From here on out the *[doctools language command |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools/mpexpand.md.
1 2 3 | [//000000001]: # (mpexpand \- Documentation toolbox) [//000000002]: # (Generated from file 'mpexpand\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (mpexpand \- Documentation toolbox) [//000000002]: # (Generated from file 'mpexpand\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2002 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2003 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (mpexpand\(n\) 1\.0 tcllib "Documentation toolbox") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools2idx/export_docidx.md.
1 2 3 | [//000000001]: # (doctools::idx::export::docidx \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::idx::export::docidx \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export::docidx\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
38 39 40 41 42 43 44 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 | | | 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 package require doctools::idx::export::docidx ?0\.2\.1? [__[export](\.\./\.\./\.\./\.\./index\.md\#export)__ *serial* *configuration*](#1) # <a name='description'></a>DESCRIPTION This package implements the doctools keyword index export plugin for the generation of docidx markup\. |
︙ | ︙ | |||
246 247 248 249 250 251 252 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 246 247 248 249 250 251 252 253 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_export.md.
1 2 3 | [//000000001]: # (doctools::idx::export \- Documentation tools) [//000000002]: # (Generated from file 'idx\_export\.man' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::idx::export \- Documentation tools) [//000000002]: # (Generated from file 'idx\_export\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
43 44 45 46 47 48 49 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require doctools::idx::export ?0\.2\.1? package require Tcl 8\.4 package require struct::map package require doctools::idx::structure package require snit package require pluginmgr [__::doctools::idx::export__ *objectName*](#1) [__objectName__ __method__ ?*arg arg \.\.\.*?](#2) [*objectName* __destroy__](#3) |
︙ | ︙ | |||
465 466 467 468 469 470 471 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT | | | 465 466 467 468 469 470 471 472 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_export_html.md.
1 2 3 | [//000000001]: # (doctools::idx::export::html \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::idx::export::html \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export::html\(n\) 0\.2 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
344 345 346 347 348 349 350 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 344 345 346 347 348 349 350 351 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_export_json.md.
1 2 3 | [//000000001]: # (doctools::idx::export::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::idx::export::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export::json\(n\) 0\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
253 254 255 256 257 258 259 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 253 254 255 256 257 258 259 260 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_export_nroff.md.
1 2 3 | [//000000001]: # (doctools::idx::export::nroff \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::idx::export::nroff \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export::nroff\(n\) 0\.3 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
208 209 210 211 212 213 214 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 208 209 210 211 212 213 214 215 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_export_text.md.
1 2 3 | [//000000001]: # (doctools::idx::export::text \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::idx::export::text \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export::text\(n\) 0\.2 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
192 193 194 195 196 197 198 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 192 193 194 195 196 197 198 199 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_export_wiki.md.
1 2 3 | [//000000001]: # (doctools::idx::export::wiki \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::idx::export::wiki \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::export::wiki\(n\) 0\.2 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
208 209 210 211 212 213 214 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 208 209 210 211 212 213 214 215 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_import.md.
1 2 3 | [//000000001]: # (doctools::idx::import \- Documentation tools) [//000000002]: # (Generated from file 'idx\_import\.man' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::idx::import \- Documentation tools) [//000000002]: # (Generated from file 'idx\_import\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::import\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
43 44 45 46 47 48 49 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require doctools::idx::import ?0\.2\.1? package require Tcl 8\.4 package require struct::map package require doctools::idx::structure package require snit package require pluginmgr [__::doctools::idx::import__ *objectName*](#1) [__objectName__ __method__ ?*arg arg \.\.\.*?](#2) [*objectName* __destroy__](#3) |
︙ | ︙ | |||
522 523 524 525 526 527 528 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT | | | 522 523 524 525 526 527 528 529 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_import_json.md.
1 2 3 | [//000000001]: # (doctools::idx::import::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::idx::import::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::import::json\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
35 36 37 38 39 40 41 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require doctools::idx::import::json ?0\.2\.1? package require doctools::idx::structure package require json [__[import](\.\./\.\./\.\./\.\./index\.md\#import)__ *string* *configuration*](#1) # <a name='description'></a>DESCRIPTION |
︙ | ︙ | |||
225 226 227 228 229 230 231 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 225 226 227 228 229 230 231 232 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2idx/idx_introduction.md.
︙ | ︙ | |||
131 132 133 134 135 136 137 | ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | | | | 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct::map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::idx::export::<*> | | | doctools::idx::import::<*> docidx | | | docidx, json json | | | | \ html | | | doctools::idx::parse \ nroff | | | | \ wiki | | | +---------------+ json text | | | | | doctools::idx::structure | | +-------+---------------+ | | doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/doctools2idx/import_docidx.md.
1 2 3 | [//000000001]: # (doctools::idx::import::docidx \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::idx::import::docidx \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::idx::import::docidx\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
35 36 37 38 39 40 41 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require doctools::idx::import::docidx ?0\.2\.1? package require doctools::idx::parse package require doctools::idx::structure package require doctools::msgcat package require doctools::tcl::parse package require fileutil package require logger package require snit |
︙ | ︙ | |||
204 205 206 207 208 209 210 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 204 205 206 207 208 209 210 211 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/export_doctoc.md.
1 2 3 | [//000000001]: # (doctools::toc::export::doctoc \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::toc::export::doctoc \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export::doctoc\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
38 39 40 41 42 43 44 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 | | | 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 package require doctools::toc::export::doctoc ?0\.2\.1? [__[export](\.\./\.\./\.\./\.\./index\.md\#export)__ *serial* *configuration*](#1) # <a name='description'></a>DESCRIPTION This package implements the doctools table of contents export plugin for the generation of doctoc markup\. |
︙ | ︙ | |||
274 275 276 277 278 279 280 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 274 275 276 277 278 279 280 281 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/import_doctoc.md.
1 2 3 | [//000000001]: # (doctools::toc::import::doctoc \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::toc::import::doctoc \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::import::doctoc\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
35 36 37 38 39 40 41 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require doctools::toc::import::doctoc ?0\.2\.1? package require doctools::toc::parse package require doctools::toc::structure package require doctools::msgcat package require doctools::tcl::parse package require fileutil package require logger package require snit |
︙ | ︙ | |||
233 234 235 236 237 238 239 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 233 234 235 236 237 238 239 240 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_export.md.
1 2 3 | [//000000001]: # (doctools::toc::export \- Documentation tools) [//000000002]: # (Generated from file 'toc\_export\.man' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::toc::export \- Documentation tools) [//000000002]: # (Generated from file 'toc\_export\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
43 44 45 46 47 48 49 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require doctools::toc::export ?0\.2\.1? package require Tcl 8\.4 package require struct::map package require doctools::toc::structure package require snit package require pluginmgr [__::doctools::toc::export__ *objectName*](#1) [__objectName__ __method__ ?*arg arg \.\.\.*?](#2) [*objectName* __destroy__](#3) |
︙ | ︙ | |||
479 480 481 482 483 484 485 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT | | | 479 480 481 482 483 484 485 486 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_export_html.md.
1 2 3 | [//000000001]: # (doctools::toc::export::html \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::toc::export::html \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export::html\(n\) 0\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
333 334 335 336 337 338 339 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 333 334 335 336 337 338 339 340 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_export_json.md.
1 2 3 | [//000000001]: # (doctools::toc::export::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::toc::export::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export::json\(n\) 0\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
302 303 304 305 306 307 308 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 302 303 304 305 306 307 308 309 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_export_nroff.md.
1 2 3 | [//000000001]: # (doctools::toc::export::nroff \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::toc::export::nroff \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export::nroff\(n\) 0\.2 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
238 239 240 241 242 243 244 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 238 239 240 241 242 243 244 245 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_export_text.md.
1 2 3 | [//000000001]: # (doctools::toc::export::text \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::toc::export::text \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export::text\(n\) 0\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
221 222 223 224 225 226 227 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 221 222 223 224 225 226 227 228 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_export_wiki.md.
1 2 3 | [//000000001]: # (doctools::toc::export::wiki \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | 1 2 3 4 5 6 7 8 9 10 11 | [//000000001]: # (doctools::toc::export::wiki \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::export::wiki\(n\) 0\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a |
︙ | ︙ | |||
230 231 232 233 234 235 236 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 230 231 232 233 234 235 236 237 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_import.md.
1 2 3 | [//000000001]: # (doctools::toc::import \- Documentation tools) [//000000002]: # (Generated from file 'toc\_import\.man' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::toc::import \- Documentation tools) [//000000002]: # (Generated from file 'toc\_import\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::import\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
43 44 45 46 47 48 49 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require doctools::toc::import ?0\.2\.1? package require Tcl 8\.4 package require struct::map package require doctools::toc::structure package require snit package require pluginmgr [__::doctools::toc::import__ *objectName*](#1) [__objectName__ __method__ ?*arg arg \.\.\.*?](#2) [*objectName* __destroy__](#3) |
︙ | ︙ | |||
539 540 541 542 543 544 545 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT | | | 539 540 541 542 543 544 545 546 | # <a name='category'></a>CATEGORY Documentation tools # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_import_json.md.
1 2 3 | [//000000001]: # (doctools::toc::import::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (doctools::toc::import::json \- Documentation tools) [//000000002]: # (Generated from file 'plugin\.inc' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (doctools::toc::import::json\(n\) 0\.2\.1 tcllib "Documentation tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
35 36 37 38 39 40 41 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS | | | | 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require doctools::toc::import::json ?0\.2\.1? package require doctools::toc::structure package require json [__[import](\.\./\.\./\.\./\.\./index\.md\#import)__ *string* *configuration*](#1) # <a name='description'></a>DESCRIPTION |
︙ | ︙ | |||
274 275 276 277 278 279 280 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT | | | 274 275 276 277 278 279 280 281 | # <a name='category'></a>CATEGORY Text formatter plugin # <a name='copyright'></a>COPYRIGHT Copyright © 2009\-2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/doctools2toc/toc_introduction.md.
︙ | ︙ | |||
131 132 133 134 135 136 137 | ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | | | | 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct:map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::toc::export::<*> | | | doctools::toc::import::<*> doctoc | | | doctoc, json json | | | | \ html | | | doctools::toc::parse \ nroff | | | | \ wiki | | | +---------------+ json text | | | | | doctools::toc::structure | | +-------+---------------+ | | doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/fileutil/multiop.md.
︙ | ︙ | |||
398 399 400 401 402 403 404 | Returns the current path type limiter\. # <a name='section5'></a>EXAMPLES The following examples assume that the variable __F__ contains a reference to a multi\-file operation object\. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | Returns the current path type limiter\. # <a name='section5'></a>EXAMPLES The following examples assume that the variable __F__ contains a reference to a multi\-file operation object\. $F do copy \ the *.dll \ from c:/TDK/PrivateOpenSSL/bin \ to [installdir_of tls] $F do move \ the * \ from /sources \ into /scratch \ but not *.html # Alternatively use 'except for *.html'. $F do \ move \ the index \ from /sources \ into /scratch \ as pkgIndex.tcl $F do \ remove \ the *.txt \ in /scratch Note that the fact that most commands just modify the object state allows us to use more off forms as specifications instead of just nearly\-natural language sentences\. For example the second example in this section can re\-arranged into: $F do \ from /sources \ into /scratch \ but not *.html \ move \ the * and the result is not only still a valid specification, but even stays relatively readable\. Further note that the information collected by the commands __but__, __except__, and __as__ is automatically reset after the associated __the__ was executed\. However no other state is reset in that manner, allowing the user to avoid repetitions of unchanging information\. For example the second and third examples of this section can be merged and rewritten into the equivalent: $F do \ move \ the * \ from /sources \ into /scratch \ but not *.html not index \ the index \ as pkgIndex.tcl # <a name='section6'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *fileutil* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas |
︙ | ︙ |
Added embedded/md/tcllib/files/modules/fileutil/paths.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (fileutil::paths \- ) [//000000002]: # (Generated from file 'paths\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (fileutil::paths\(n\) 1 tcllib "") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> # NAME fileutil::paths \- Manage search path pools # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [API](#section2) - [Bugs, Ideas, Feedback](#section3) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 package require fileutil::paths ?1? [__::fileutil::paths__ *poolName*](#1) [__poolName__ __method__ ?*arg arg \.\.\.*?](#2) [*poolName* __add__ *path*](#3) [*poolName* __clear__](#4) [*poolName* __paths__](#5) [*poolName* __remove__ *path*](#6) # <a name='description'></a>DESCRIPTION Provides a snit class whose instances manage a pool of \(search\) paths\. # <a name='section2'></a>API The main command provides construction of search path pools: - <a name='1'></a>__::fileutil::paths__ *poolName* Creates a new, empty pool of search paths with an associated global Tcl command whose name is *poolName*\. It may be used to invoke various operations on the pool\. It has the following general form: * <a name='2'></a>__poolName__ __method__ ?*arg arg \.\.\.*? __method__ and *arg*uments determine the exact behavior of the command\. If *poolName* is specified as __%AUTO%__ a unique name will be generated by the package itself\. The result of the command is the fully\-qualified name of the instance command\. The following commands are possible for pool objects: - <a name='3'></a>*poolName* __add__ *path* Adds the *path* to the pool\. Nothing is done if the *path* is already known to the pool\. The result of the command is the empty string\. - <a name='4'></a>*poolName* __clear__ Clears the entire pool\. In other words, removes all paths from it\. The result of the command is the empty string\. - <a name='5'></a>*poolName* __paths__ Returns the list of all paths known to the pool, in the order they were added\. - <a name='6'></a>*poolName* __remove__ *path* Removes the *path* from the pool, if it is known to the pool\. Unknown paths are ignored without error\. The result of the command is the empty string\. # <a name='section3'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *fileutil* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. When proposing code changes, please provide *unified diffs*, i\.e the output of __diff \-u__\. Note further that *attachments* are strongly preferred over inlined patches\. Attachments can be made by going to the __Edit__ form of the ticket immediately after its creation, and then using the left\-most button in the secondary navigation bar\. |
Changes to embedded/md/tcllib/files/modules/grammar_aycock/aycock.md.
1 2 3 | [//000000001]: # (grammar::aycock \- Aycock\-Horspool\-Earley parser generator for Tcl) [//000000002]: # (Generated from file 'aycock\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (grammar::aycock \- Aycock\-Horspool\-Earley parser generator for Tcl) [//000000002]: # (Generated from file 'aycock\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2006 by Kevin B\. Kenny <kennykb@acm\.org>) [//000000004]: # (Redistribution permitted under the terms of the Open Publication License <http://www\.opencontent\.org/openpub/>) [//000000005]: # (grammar::aycock\(n\) 1\.0 tcllib "Aycock\-Horspool\-Earley parser generator for Tcl") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/grammar_fa/dexec.md.
1 2 3 | [//000000001]: # (grammar::fa::dexec \- Finite automaton operations and usage) [//000000002]: # (Generated from file 'dexec\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (grammar::fa::dexec \- Finite automaton operations and usage) [//000000002]: # (Generated from file 'dexec\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2007 Bogdan <rftghost@users\.sourceforge\.net>) [//000000005]: # (grammar::fa::dexec\(n\) 0\.2 tcllib "Finite automaton operations and usage") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/grammar_fa/fa.md.
︙ | ︙ | |||
165 166 167 168 169 170 171 | overwriting any existing definition\. This is the assignment operator for automatons\. It copies the automaton contained in the FA object *srcFA* over the automaton definition in *faName*\. The old contents of *faName* are deleted by this operation\. This operation is in effect equivalent to | | | | 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 | overwriting any existing definition\. This is the assignment operator for automatons\. It copies the automaton contained in the FA object *srcFA* over the automaton definition in *faName*\. The old contents of *faName* are deleted by this operation\. This operation is in effect equivalent to > *faName* __deserialize__ \[*srcFA* __serialize__\] - <a name='6'></a>*faName* __\-\->__ *dstFA* This is the reverse assignment operator for automatons\. It copies the automation contained in the object *faName* over the automaton definition in the object *dstFA*\. The old contents of *dstFA* are deleted by this operation\. This operation is in effect equivalent to > *dstFA* __deserialize__ \[*faName* __serialize__\] - <a name='7'></a>*faName* __serialize__ This method serializes the automaton stored in *faName*\. In other words it returns a tcl *value* completely describing that automaton\. This allows, for example, the transfer of automatons over arbitrary channels, persistence, etc\. This method is also the basis for both the copy |
︙ | ︙ | |||
225 226 227 228 229 230 231 | very simple way :\) Drive -- yellow --> Brake -- red --> (Stop) -- red/yellow --> Attention -- green --> Drive (...) is the start state. a possible serialization is | | | | | | | 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | very simple way :\) Drive -- yellow --> Brake -- red --> (Stop) -- red/yellow --> Attention -- green --> Drive (...) is the start state. a possible serialization is grammar::fa \ {yellow red green red/yellow} \ {Drive {0 0 {yellow Brake}} \ Brake {0 0 {red Stop}} \ Stop {1 0 {red/yellow Attention}} \ Attention {0 0 {green Drive}}} A possible one, because I did not care about creation order here - <a name='8'></a>*faName* __deserialize__ *serialization* This is the complement to __serialize__\. It replaces the automaton |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/grammar_peg/peg.md.
︙ | ︙ | |||
219 220 221 222 223 224 225 | overwriting any existing definition\. This is the assignment operator for grammars\. It copies the grammar contained in the grammar object *srcPEG* over the grammar definition in *pegName*\. The old contents of *pegName* are deleted by this operation\. This operation is in effect equivalent to | | | | 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 | overwriting any existing definition\. This is the assignment operator for grammars\. It copies the grammar contained in the grammar object *srcPEG* over the grammar definition in *pegName*\. The old contents of *pegName* are deleted by this operation\. This operation is in effect equivalent to > *pegName* __deserialize__ \[*srcPEG* __serialize__\] - <a name='5'></a>*pegName* __\-\->__ *dstPEG* This is the reverse assignment operator for grammars\. It copies the automation contained in the object *pegName* over the grammar definition in the object *dstPEG*\. The old contents of *dstPEG* are deleted by this operation\. This operation is in effect equivalent to > *dstPEG* __deserialize__ \[*pegName* __serialize__\] - <a name='6'></a>*pegName* __serialize__ This method serializes the grammar stored in *pegName*\. In other words it returns a tcl *value* completely describing that grammar\. This allows, for example, the transfer of grammars over arbitrary channels, persistence, etc\. This method is also the basis for both the copy constructor and the |
︙ | ︙ | |||
273 274 275 276 277 278 279 | MulOp <- '*' / '/' Factor <- Term (AddOp Term)* AddOp <- '+'/'-' Term <- Number a possible serialization is | | | | | | | | | | | | | | | | 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 | MulOp <- '*' / '/' Factor <- Term (AddOp Term)* AddOp <- '+'/'-' Term <- Number a possible serialization is grammar::peg \ {Expression {/ {x ( Expression )} {x Factor {* {x MulOp Factor}}}} \ Factor {x Term {* {x AddOp Term}}} \ Term Number \ MulOp {/ * /} \ AddOp {/ + -} \ Number {x {? Sign} {+ Digit}} \ Sign {/ + -} \ Digit {/ 0 1 2 3 4 5 6 7 8 9} \ } \ {Expression value Factor value \ Term value MulOp value \ AddOp value Number value \ Sign value Digit value \ } Expression A possible one, because the order of the nonterminals in the dictionary is not relevant\. - <a name='7'></a>*pegName* __deserialize__ *serialization* |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/hook/hook.md.
︙ | ︙ | |||
78 79 80 81 82 83 84 | events, and via callback options like the text widget's __\-yscrollcommand__ option\. Tk events are available only in Tk, and callback options require tight coupling between the modules sending and receiving the notification\. Loose coupling between sender and receiver is often desirable, however\. In Model/View/Controller terms, a View can send a command \(stemming from user input\) to the Controller, which updates the Model\. The Model can then call a | | | | | | | 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | events, and via callback options like the text widget's __\-yscrollcommand__ option\. Tk events are available only in Tk, and callback options require tight coupling between the modules sending and receiving the notification\. Loose coupling between sender and receiver is often desirable, however\. In Model/View/Controller terms, a View can send a command \(stemming from user input\) to the Controller, which updates the Model\. The Model can then call a hook *to which all relevant* *Views subscribe\.* The Model is decoupled from the Views, and indeed need not know whether any Views actually exist\. At present, Tcl/Tk has no standard mechanism for implementing loose coupling of this kind\. This package defines a new command, __hook__, which implements just such a mechanism\. ## <a name='subsection2'></a>Bindings The __hook__ command manages a collection of hook bindings\. A hook binding has four elements: 1. A *[subject](\.\./\.\./\.\./\.\./index\.md\#subject)*: the name of the entity |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/httpd/httpd.md.
1 |
| | | | | | | | > | > > | > | | | | | | > > | > | > | | | | | < | < < < < | | | < | | < | | | | | | | < | < | < < | < | | | | | | > > > | | | | | | > | > | > > > > > > > > > > > | > | > > > > | > > | > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > | | > | < | | < < | > | | > | | | < < < > > < < > < | > | | | | | | | < < < | | < > | < > | < < < | < < | < | < | < | < < | | < | < < | < < | < < < < < | < < < < < | < | 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 | [//000000001]: # (httpd \- Tcl Web Server) [//000000002]: # (Generated from file 'httpd\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2018 Sean Woods <yoda@etoyoc\.com>) [//000000004]: # (httpd\(n\) 4\.3\.3 tcllib "Tcl Web Server") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> # NAME httpd \- A TclOO and coroutine based web server # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [Minimal Example](#section2) - [Classes](#section3) - [Class httpd::mime](#subsection1) - [Class httpd::reply](#subsection2) - [Class httpd::server](#subsection3) - [Class httpd::server::dispatch](#subsection4) - [Class httpd::content\.redirect](#subsection5) - [Class httpd::content\.cache](#subsection6) - [Class httpd::content\.template](#subsection7) - [Class httpd::content\.file](#subsection8) - [Class httpd::content\.exec](#subsection9) - [Class httpd::content\.proxy](#subsection10) - [Class httpd::content\.cgi](#subsection11) - [Class httpd::protocol\.scgi](#subsection12) - [Class httpd::content\.scgi](#subsection13) - [Class httpd::server\.scgi](#subsection14) - [Class httpd::content\.websocket](#subsection15) - [Class httpd::plugin](#subsection16) - [Class httpd::plugin\.dict\_dispatch](#subsection17) - [Class httpd::reply\.memchan](#subsection18) - [Class httpd::plugin\.local\_memchan](#subsection19) - [AUTHORS](#section4) - [Bugs, Ideas, Feedback](#section5) - [Keywords](#keywords) - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.6 package require uuid package require clay package require coroutine package require fileutil package require fileutil::magic::filetype package require websocket package require mime package require cron package require uri package require Markdown [method __ChannelCopy__ *in* *out* ?*args*?](#1) [method __html\_header__ ?*title* ____? ?*args*?](#2) [method __html\_footer__ ?*args*?](#3) [method __http\_code\_string__ *code*](#4) [method __HttpHeaders__ *sock* ?*debug* ____?](#5) [method __HttpHeaders\_Default__](#6) [method __HttpServerHeaders__](#7) [method __MimeParse__ *mimetext*](#8) [method __Url\_Decode__ *data*](#9) [method __Url\_PathCheck__ *urlsuffix*](#10) [method __wait__ *mode* *sock*](#11) [variable __ChannelRegister__](#12) [variable __reply__](#13) [variable __request__](#14) [delegate __<server>__](#15) [method __constructor__ *ServerObj* ?*args*?](#16) [method __destructor__ ?*dictargs*?](#17) [method __ChannelRegister__ ?*args*?](#18) [method __close__](#19) [method __Log\_Dispatched__](#20) [method __dispatch__ *newsock* *datastate*](#21) [method __Dispatch__](#22) [method __html\_header__ *title* ?*args*?](#23) [method __html\_footer__ ?*args*?](#24) [method __[error](\.\./\.\./\.\./\.\./index\.md\#error)__ *code* ?*msg* ____? ?*errorInfo* ____?](#25) [method __content__](#26) [method __EncodeStatus__ *status*](#27) [method __[log](\.\./log/log\.md)__ *type* ?*info* ____?](#28) [method __CoroName__](#29) [method __DoOutput__](#30) [method __FormData__](#31) [method __PostData__ *length*](#32) [method __Session\_Load__](#33) [method __puts__ *line*](#34) [method __RequestFind__ *field*](#35) [method __request__ *subcommand* ?*args*?](#36) [method __reply__ *subcommand* ?*args*?](#37) [method __reset__](#38) [method __timeOutCheck__](#39) [method __[timestamp](\.\./\.\./\.\./\.\./index\.md\#timestamp)__](#40) [variable __template__](#41) [variable __url\_patterns__](#42) [method __constructor__ *args* ?*port* __auto__? ?*myaddr* __127\.0\.0\.1__? ?*string* __auto__? ?*name* __auto__? ?*doc\_root* ____? ?*reverse\_dns* __0__? ?*configuration\_file* ____? ?*protocol* __HTTP/1\.1__?](#43) [method __destructor__ ?*dictargs*?](#44) [method __connect__ *sock* *ip* *port*](#45) [method __ServerHeaders__ *ip* *http\_request* *mimetxt*](#46) [method __Connect__ *uuid* *sock* *ip*](#47) [method __[counter](\.\./counter/counter\.md)__ *which*](#48) [method __CheckTimeout__](#49) [method __[debug](\.\./debug/debug\.md)__ ?*args*?](#50) [method __dispatch__ *data*](#51) [method __Dispatch\_Default__ *reply*](#52) [method __Dispatch\_Local__ *data*](#53) [method __Headers\_Local__ *varname*](#54) [method __Headers\_Process__ *varname*](#55) [method __HostName__ *ipaddr*](#56) [method __[log](\.\./log/log\.md)__ ?*args*?](#57) [method __[plugin](\.\./\.\./\.\./\.\./index\.md\#plugin)__ *slot* ?*class* ____?](#58) [method __port\_listening__](#59) [method __PrefixNormalize__ *prefix*](#60) [method __[source](\.\./\.\./\.\./\.\./index\.md\#source)__ *filename*](#61) [method __start__](#62) [method __stop__](#63) [method __SubObject \{\} db__](#64) [method __SubObject \{\} default__](#65) [method __template__ *page*](#66) [method __TemplateSearch__ *page*](#67) [method __Thread\_start__](#68) [method __Uuid\_Generate__](#69) [method __Validate\_Connection__ *sock* *ip*](#70) [method __reset__](#71) [method __content__](#72) [method __Dispatch__](#73) [method __content__](#74) [method __FileName__](#75) [method __DirectoryListing__ *local\_file*](#76) [method __content__](#77) [method __Dispatch__](#78) [variable __exename__](#79) [method __CgiExec__ *execname* *script* *arglist*](#80) [method __Cgi\_Executable__ *script*](#81) [method __proxy\_channel__](#82) [method __proxy\_path__](#83) [method __ProxyRequest__ *chana* *chanb*](#84) [method __ProxyReply__ *chana* *chanb* ?*args*?](#85) [method __Dispatch__](#86) [method __FileName__](#87) [method __proxy\_channel__](#88) [method __ProxyRequest__ *chana* *chanb*](#89) [method __ProxyReply__ *chana* *chanb* ?*args*?](#90) [method __DirectoryListing__ *local\_file*](#91) [method __EncodeStatus__ *status*](#92) [method __scgi\_info__](#93) [method __proxy\_channel__](#94) [method __ProxyRequest__ *chana* *chanb*](#95) [method __ProxyReply__ *chana* *chanb* ?*args*?](#96) [method __[debug](\.\./debug/debug\.md)__ ?*args*?](#97) [method __Connect__ *uuid* *sock* *ip*](#98) [method __Dispatch\_Dict__ *data*](#99) [method __uri \{\} add__ *vhosts* *patterns* *info*](#100) [method __uri \{\} direct__ *vhosts* *patterns* *info* *body*](#101) [method __output__](#102) [method __DoOutput__](#103) [method __close__](#104) [method __local\_memchan__ *command* ?*args*?](#105) [method __Connect\_Local__ *uuid* *sock* ?*args*?](#106) # <a name='description'></a>DESCRIPTION This module implements a web server, suitable for embedding in an application\. The server is object oriented, and contains all of the fundamentals needed for a full service website\. # <a name='section2'></a>Minimal Example Starting a web service requires starting a class of type __httpd::server__, and providing that server with one or more URIs to service, and __httpd::reply__ derived classes to generate them\. oo::class create ::reply.hello { method content {} { my puts "<HTML><HEAD><TITLE>IRM Dispatch Server</TITLE></HEAD><BODY>" my puts "<h1>Hello World!</h1>" my puts </BODY></HTML> } } ::httpd::server create HTTPD port 8015 myaddr 127.0.0.1 doc_root ~/htdocs HTTPD plugin dispatch httpd::server::dispatch HTTPD uri add * /hello [list mixin reply.hello] The bare module does have facilities to hose a files from a file system\. Files that end in a \.tml will be substituted in the style of Tclhttpd: <!-- hello.tml --> [my html_header {Hello World!}] Your Server is running. <p> The time is now [clock format [clock seconds]] [my html_footer] A complete example of an httpd server is in the /examples directory of Tcllib\. It also show how to dispatch URIs to other processes via SCGI and HTTP proxies\. cd ~/tcl/sandbox/tcllib tclsh examples/httpd.tcl # <a name='section3'></a>Classes ## <a name='subsection1'></a>Class httpd::mime A metaclass for MIME handling behavior across a live socket __Methods__ - <a name='1'></a>method __ChannelCopy__ *in* *out* ?*args*? - <a name='2'></a>method __html\_header__ ?*title* ____? ?*args*? Returns a block of HTML - <a name='3'></a>method __html\_footer__ ?*args*? - <a name='4'></a>method __http\_code\_string__ *code* - <a name='5'></a>method __HttpHeaders__ *sock* ?*debug* ____? - <a name='6'></a>method __HttpHeaders\_Default__ - <a name='7'></a>method __HttpServerHeaders__ - <a name='8'></a>method __MimeParse__ *mimetext* Converts a block of mime encoded text to a key/value list\. If an exception is encountered, the method will generate its own call to the __[error](\.\./\.\./\.\./\.\./index\.md\#error)__ method, and immediately invoke the __output__ method to produce an error code and close the connection\. - <a name='9'></a>method __Url\_Decode__ *data* De\-httpizes a string\. - <a name='10'></a>method __Url\_PathCheck__ *urlsuffix* - <a name='11'></a>method __wait__ *mode* *sock* ## <a name='subsection2'></a>Class httpd::reply *ancestors*: __httpd::mime__ A class which shephards a request through the process of generating a reply\. The socket associated with the reply is available at all times as the *chan* variable\. The process of generating a reply begins with an __httpd::server__ generating a __http::class__ object, mixing in a set of behaviors and then invoking the reply object's __dispatch__ method\. In normal operations the __dispatch__ method: |
︙ | ︙ | |||
268 269 270 271 272 273 274 | 1. Invokes the __content__ method for the object, generating an call to the __[error](\.\./\.\./\.\./\.\./index\.md\#error)__ method if an exception is raised\. 1. Invokes the __output__ method for the object | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | | | | | | | | | | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > > > > > > > < | < < < < < < < < < < < > > > > | > > > > > > > | > > | > | > > | > | > | > | > > > | > | > | > > > > > > | > | > | > | > | > | > | > > > | > > > > | > > > > | > > > > > > > > > > > > > > > > > > > > > | > > > | > > | > > | > > > | > | > > > > > > > > > > > | > > > > > > > | > | > | > > > > | > > > > | > > | > | > > > > > | > > | > > > > > > | > | > > | > > | > | > > | > > > > > > > > > > > > > > > > > > > > > | > | > | > | > | > > | > > | > | > > > > > > > | > > > > > > > > > > > > > | > | > | > | > | > > | > > | > | > > | > > > > > > > > > > > > > > > > | > | > | > > | > > | > | > > | > > | > | > > > > > > > > > > > > | | | 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 | 1. Invokes the __content__ method for the object, generating an call to the __[error](\.\./\.\./\.\./\.\./index\.md\#error)__ method if an exception is raised\. 1. Invokes the __output__ method for the object Developers have the option of streaming output to a buffer via the __puts__ method of the reply, or simply populating the *reply\_body* variable of the object\. The information returned by the __content__ method is not interpreted in any way\. If an exception is thrown \(via the __[error](\.\./\.\./\.\./\.\./index\.md\#error)__ command in Tcl, for example\) the caller will auto\-generate a 500 \{Internal Error\} message\. A typical implementation of __content__ look like: clay::define ::test::content.file { superclass ::httpd::content.file # Return a file # Note: this is using the content.file mixin which looks for the reply_file variable # and will auto-compute the Content-Type method content {} { my reset set doc_root [my request get DOCUMENT_ROOT] my variable reply_file set reply_file [file join $doc_root index.html] } } clay::define ::test::content.time { # return the current system time method content {} { my variable reply_body my reply set Content-Type text/plain set reply_body [clock seconds] } } clay::define ::test::content.echo { method content {} { my variable reply_body my reply set Content-Type [my request get CONTENT_TYPE] set reply_body [my PostData [my request get CONTENT_LENGTH]] } } clay::define ::test::content.form_handler { method content {} { set form [my FormData] my reply set Content-Type {text/html; charset=UTF-8} my puts [my html_header {My Dynamic Page}] my puts "<BODY>" my puts "You Sent<p>" my puts "<TABLE>" foreach {f v} $form { my puts "<TR><TH>$f</TH><TD><verbatim>$v</verbatim></TD>" } my puts "</TABLE><p>" my puts "Send some info:<p>" my puts "<FORM action=/[my request get REQUEST_PATH] method POST>" my puts "<TABLE>" foreach field {name rank serial_number} { set line "<TR><TH>$field</TH><TD><input name=\"$field\" " if {[dict exists $form $field]} { append line " value=\"[dict get $form $field]\""" } append line " /></TD></TR>" my puts $line } my puts "</TABLE>" my puts [my html footer] } } __Variable__ - <a name='12'></a>variable __ChannelRegister__ - <a name='13'></a>variable __reply__ A dictionary which will converted into the MIME headers of the reply - <a name='14'></a>variable __request__ A dictionary containing the SCGI transformed HTTP headers for the request __Delegate__ - <a name='15'></a>delegate __<server>__ The server object which spawned this reply __Methods__ - <a name='16'></a>method __constructor__ *ServerObj* ?*args*? - <a name='17'></a>method __destructor__ ?*dictargs*? clean up on exit - <a name='18'></a>method __ChannelRegister__ ?*args*? Registers a channel to be closed by the close method - <a name='19'></a>method __close__ Close channels opened by this object - <a name='20'></a>method __Log\_Dispatched__ Record a dispatch event - <a name='21'></a>method __dispatch__ *newsock* *datastate* Accept the handoff from the server object of the socket *newsock* and feed it the state *datastate*\. Fields the *datastate* are looking for in particular are: \* __mixin__ \- A key/value list of slots and classes to be mixed into the object prior to invoking __Dispatch__\. \* __http__ \- A key/value list of values to populate the object's *request* ensemble All other fields are passed along to the __clay__ structure of the object\. - <a name='22'></a>method __Dispatch__ - <a name='23'></a>method __html\_header__ *title* ?*args*? - <a name='24'></a>method __html\_footer__ ?*args*? - <a name='25'></a>method __[error](\.\./\.\./\.\./\.\./index\.md\#error)__ *code* ?*msg* ____? ?*errorInfo* ____? - <a name='26'></a>method __content__ REPLACE ME: This method is the "meat" of your application\. It writes to the result buffer via the "puts" method and can tweak the headers via "clay put header\_reply" - <a name='27'></a>method __EncodeStatus__ *status* Formulate a standard HTTP status header from he string provided\. - <a name='28'></a>method __[log](\.\./log/log\.md)__ *type* ?*info* ____? - <a name='29'></a>method __CoroName__ - <a name='30'></a>method __DoOutput__ Generates the the HTTP reply, streams that reply back across *chan*, and destroys the object\. - <a name='31'></a>method __FormData__ For GET requests, converts the QUERY\_DATA header into a key/value list\. For POST requests, reads the Post data and converts that information to a key/value list for application/x\-www\-form\-urlencoded posts\. For multipart posts, it composites all of the MIME headers of the post to a singular key/value list, and provides MIME\_\* information as computed by the __[mime](\.\./mime/mime\.md)__ package, including the MIME\_TOKEN, which can be fed back into the mime package to read out the contents\. - <a name='32'></a>method __PostData__ *length* Stream *length* bytes from the *chan* socket, but only of the request is a POST or PUSH\. Returns an empty string otherwise\. - <a name='33'></a>method __Session\_Load__ Manage session data - <a name='34'></a>method __puts__ *line* Appends the value of *string* to the end of *reply\_body*, as well as a trailing newline character\. - <a name='35'></a>method __RequestFind__ *field* - <a name='36'></a>method __request__ *subcommand* ?*args*? - <a name='37'></a>method __reply__ *subcommand* ?*args*? - <a name='38'></a>method __reset__ Clear the contents of the *reply\_body* variable, and reset all headers in the __reply__ structure back to the defaults for this object\. - <a name='39'></a>method __timeOutCheck__ Called from the __http::server__ object which spawned this reply\. Checks to see if too much time has elapsed while waiting for data or generating a reply, and issues a timeout error to the request if it has, as well as destroy the object and close the *chan* socket\. - <a name='40'></a>method __[timestamp](\.\./\.\./\.\./\.\./index\.md\#timestamp)__ Return the current system time in the format: %a, %d %b %Y %T %Z ## <a name='subsection3'></a>Class httpd::server *ancestors*: __httpd::mime__ __Variable__ - <a name='41'></a>variable __template__ - <a name='42'></a>variable __url\_patterns__ __Methods__ - <a name='43'></a>method __constructor__ *args* ?*port* __auto__? ?*myaddr* __127\.0\.0\.1__? ?*string* __auto__? ?*name* __auto__? ?*doc\_root* ____? ?*reverse\_dns* __0__? ?*configuration\_file* ____? ?*protocol* __HTTP/1\.1__? - <a name='44'></a>method __destructor__ ?*dictargs*? - <a name='45'></a>method __connect__ *sock* *ip* *port* Reply to an open socket\. This method builds a coroutine to manage the remainder of the connection\. The coroutine's operations are driven by the __Connect__ method\. - <a name='46'></a>method __ServerHeaders__ *ip* *http\_request* *mimetxt* - <a name='47'></a>method __Connect__ *uuid* *sock* *ip* This method reads HTTP headers, and then consults the __dispatch__ method to determine if the request is valid, and/or what kind of reply to generate\. Under normal cases, an object of class __::http::reply__ is created, and that class's __dispatch__ method\. This action passes control of the socket to the reply object\. The reply object manages the rest of the transaction, including closing the socket\. - <a name='48'></a>method __[counter](\.\./counter/counter\.md)__ *which* Increment an internal counter\. - <a name='49'></a>method __CheckTimeout__ Check open connections for a time out event\. - <a name='50'></a>method __[debug](\.\./debug/debug\.md)__ ?*args*? - <a name='51'></a>method __dispatch__ *data* Given a key/value list of information, return a data structure describing how the server should reply\. - <a name='52'></a>method __Dispatch\_Default__ *reply* Method dispatch method of last resort before returning a 404 NOT FOUND error\. The default behavior is to look for a file in *DOCUMENT\_ROOT* which matches the query\. - <a name='53'></a>method __Dispatch\_Local__ *data* Method dispatch method invoked prior to invoking methods implemented by plugins\. If this method returns a non\-empty dictionary, that structure will be passed to the reply\. The default is an empty implementation\. - <a name='54'></a>method __Headers\_Local__ *varname* Introspect and possibly modify a data structure destined for a reply\. This method is invoked before invoking Header methods implemented by plugins\. The default implementation is empty\. - <a name='55'></a>method __Headers\_Process__ *varname* Introspect and possibly modify a data structure destined for a reply\. This method is built dynamically by the __[plugin](\.\./\.\./\.\./\.\./index\.md\#plugin)__ method\. - <a name='56'></a>method __HostName__ *ipaddr* Convert an ip address to a host name\. If the server/ reverse\_dns flag is false, this method simply returns the IP address back\. Internally, this method uses the *dns* module from tcllib\. - <a name='57'></a>method __[log](\.\./log/log\.md)__ ?*args*? Log an event\. The input for args is free form\. This method is intended to be replaced by the user, and is a noop for a stock http::server object\. - <a name='58'></a>method __[plugin](\.\./\.\./\.\./\.\./index\.md\#plugin)__ *slot* ?*class* ____? Incorporate behaviors from a plugin\. This method dynamically rebuilds the __Dispatch__ and __Headers__ method\. For every plugin, the server looks for the following entries in *clay plugin/*: *load* \- A script to invoke in the server's namespace during the __[plugin](\.\./\.\./\.\./\.\./index\.md\#plugin)__ method invokation\. *dispatch* \- A script to stitch into the server's __Dispatch__ method\. *headers* \- A script to stitch into the server's __Headers__ method\. *thread* \- A script to stitch into the server's __Thread\_start__ method\. - <a name='59'></a>method __port\_listening__ Return the actual port that httpd is listening on\. - <a name='60'></a>method __PrefixNormalize__ *prefix* For the stock version, trim trailing /'s and \*'s from a prefix\. This method can be replaced by the end user to perform any other transformations needed for the application\. - <a name='61'></a>method __[source](\.\./\.\./\.\./\.\./index\.md\#source)__ *filename* - <a name='62'></a>method __start__ Open the socket listener\. - <a name='63'></a>method __stop__ Shut off the socket listener, and destroy any pending replies\. - <a name='64'></a>method __SubObject \{\} db__ - <a name='65'></a>method __SubObject \{\} default__ - <a name='66'></a>method __template__ *page* Return a template for the string *page* - <a name='67'></a>method __TemplateSearch__ *page* Perform a search for the template that best matches *page*\. This can include local file searches, in\-memory structures, or even database lookups\. The stock implementation simply looks for files with a \.tml or \.html extension in the ?doc\_root? directory\. - <a name='68'></a>method __Thread\_start__ Built by the __[plugin](\.\./\.\./\.\./\.\./index\.md\#plugin)__ method\. Called by the __start__ method\. Intended to allow plugins to spawn worker threads\. - <a name='69'></a>method __Uuid\_Generate__ Generate a GUUID\. Used to ensure every request has a unique ID\. The default implementation is: return [::clay::uuid generate] - <a name='70'></a>method __Validate\_Connection__ *sock* *ip* Given a socket and an ip address, return true if this connection should be terminated, or false if it should be allowed to continue\. The stock implementation always returns 0\. This is intended for applications to be able to implement black lists and/or provide security based on IP address\. ## <a name='subsection4'></a>Class httpd::server::dispatch *ancestors*: __httpd::server__ Provide a backward compadible alias ## <a name='subsection5'></a>Class httpd::content\.redirect __Methods__ - <a name='71'></a>method __reset__ - <a name='72'></a>method __content__ ## <a name='subsection6'></a>Class httpd::content\.cache __Methods__ - <a name='73'></a>method __Dispatch__ ## <a name='subsection7'></a>Class httpd::content\.template __Methods__ - <a name='74'></a>method __content__ ## <a name='subsection8'></a>Class httpd::content\.file Class to deliver Static content When utilized, this class is fed a local filename by the dispatcher __Methods__ - <a name='75'></a>method __FileName__ - <a name='76'></a>method __DirectoryListing__ *local\_file* - <a name='77'></a>method __content__ - <a name='78'></a>method __Dispatch__ ## <a name='subsection9'></a>Class httpd::content\.exec __Variable__ - <a name='79'></a>variable __exename__ __Methods__ - <a name='80'></a>method __CgiExec__ *execname* *script* *arglist* - <a name='81'></a>method __Cgi\_Executable__ *script* ## <a name='subsection10'></a>Class httpd::content\.proxy *ancestors*: __httpd::content\.exec__ Return data from an proxy process __Methods__ - <a name='82'></a>method __proxy\_channel__ - <a name='83'></a>method __proxy\_path__ - <a name='84'></a>method __ProxyRequest__ *chana* *chanb* - <a name='85'></a>method __ProxyReply__ *chana* *chanb* ?*args*? - <a name='86'></a>method __Dispatch__ ## <a name='subsection11'></a>Class httpd::content\.cgi *ancestors*: __httpd::content\.proxy__ __Methods__ - <a name='87'></a>method __FileName__ - <a name='88'></a>method __proxy\_channel__ - <a name='89'></a>method __ProxyRequest__ *chana* *chanb* - <a name='90'></a>method __ProxyReply__ *chana* *chanb* ?*args*? - <a name='91'></a>method __DirectoryListing__ *local\_file* For most CGI applications a directory list is vorboten ## <a name='subsection12'></a>Class httpd::protocol\.scgi Return data from an SCGI process __Methods__ - <a name='92'></a>method __EncodeStatus__ *status* ## <a name='subsection13'></a>Class httpd::content\.scgi *ancestors*: __httpd::content\.proxy__ __Methods__ - <a name='93'></a>method __scgi\_info__ - <a name='94'></a>method __proxy\_channel__ - <a name='95'></a>method __ProxyRequest__ *chana* *chanb* - <a name='96'></a>method __ProxyReply__ *chana* *chanb* ?*args*? ## <a name='subsection14'></a>Class httpd::server\.scgi *ancestors*: __httpd::server__ Act as an SCGI Server __Methods__ - <a name='97'></a>method __[debug](\.\./debug/debug\.md)__ ?*args*? - <a name='98'></a>method __Connect__ *uuid* *sock* *ip* ## <a name='subsection15'></a>Class httpd::content\.websocket Upgrade a connection to a websocket ## <a name='subsection16'></a>Class httpd::plugin httpd plugin template ## <a name='subsection17'></a>Class httpd::plugin\.dict\_dispatch A rudimentary plugin that dispatches URLs from a dict data structure __Methods__ - <a name='99'></a>method __Dispatch\_Dict__ *data* Implementation of the dispatcher - <a name='100'></a>method __uri \{\} add__ *vhosts* *patterns* *info* - <a name='101'></a>method __uri \{\} direct__ *vhosts* *patterns* *info* *body* ## <a name='subsection18'></a>Class httpd::reply\.memchan *ancestors*: __httpd::reply__ __Methods__ - <a name='102'></a>method __output__ - <a name='103'></a>method __DoOutput__ - <a name='104'></a>method __close__ ## <a name='subsection19'></a>Class httpd::plugin\.local\_memchan __Methods__ - <a name='105'></a>method __local\_memchan__ *command* ?*args*? - <a name='106'></a>method __Connect\_Local__ *uuid* *sock* ?*args*? A modified connection method that passes simple GET request to an object and pulls data directly from the reply\_body data variable in the object Needed because memchan is bidirectional, and we can't seem to communicate that the server is one side of the link and the reply is another # <a name='section4'></a>AUTHORS Sean Woods # <a name='section5'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *network* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. When proposing code changes, please provide *unified diffs*, i\.e the output of |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/imap4/imap4.md.
︙ | ︙ | |||
31 32 33 34 35 36 37 38 39 40 41 | - [REFERENCES](#section5) - [Bugs, Ideas, Feedback](#section6) - [See Also](#seealso) - [Keywords](#keywords) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 | > > | | 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | - [REFERENCES](#section5) - [Bugs, Ideas, Feedback](#section6) - [See Also](#seealso) - [Keywords](#keywords) - [Category](#category) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require imap4 ?0\.5\.3? [__::imap4::open__ *hostname* ?*port*?](#1) [__::imap4::starttls__ *chan*](#2) [__::imap4::login__ *chan* *user* *pass*](#3) [__::imap4::folders__ *chan* ?*\-inline*? ?*mboxref*? ?*mboxname*?](#4) [__::imap4::select__ *chan* ?*mailbox*?](#5) [__::imap4::examine__ *chan* ?*mailbox*?](#6) |
︙ | ︙ | |||
509 510 511 512 513 514 515 | # <a name='keywords'></a>KEYWORDS [email](\.\./\.\./\.\./\.\./index\.md\#email), [imap](\.\./\.\./\.\./\.\./index\.md\#imap), [internet](\.\./\.\./\.\./\.\./index\.md\#internet), [mail](\.\./\.\./\.\./\.\./index\.md\#mail), [net](\.\./\.\./\.\./\.\./index\.md\#net), [rfc3501](\.\./\.\./\.\./\.\./index\.md\#rfc3501), [ssl](\.\./\.\./\.\./\.\./index\.md\#ssl), [tls](\.\./\.\./\.\./\.\./index\.md\#tls) | > > > > | 511 512 513 514 515 516 517 518 519 520 521 | # <a name='keywords'></a>KEYWORDS [email](\.\./\.\./\.\./\.\./index\.md\#email), [imap](\.\./\.\./\.\./\.\./index\.md\#imap), [internet](\.\./\.\./\.\./\.\./index\.md\#internet), [mail](\.\./\.\./\.\./\.\./index\.md\#mail), [net](\.\./\.\./\.\./\.\./index\.md\#net), [rfc3501](\.\./\.\./\.\./\.\./index\.md\#rfc3501), [ssl](\.\./\.\./\.\./\.\./index\.md\#ssl), [tls](\.\./\.\./\.\./\.\./index\.md\#tls) # <a name='category'></a>CATEGORY Networking |
Changes to embedded/md/tcllib/files/modules/jpeg/jpeg.md.
1 2 3 | [//000000001]: # (jpeg \- JPEG image manipulation) [//000000002]: # (Generated from file 'jpeg\.man' by tcllib/doctools with format 'markdown') | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | [//000000001]: # (jpeg \- JPEG image manipulation) [//000000002]: # (Generated from file 'jpeg\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004\-2005, Code: Aaron Faupell <afaupell@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2007, Code: Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (Copyright © 2004\-2009, Doc: Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000006]: # (Copyright © 2011, Code: Pat Thoyts <patthoyts@users\.sourceforge\.net>) [//000000007]: # (jpeg\(n\) 0\.5 tcllib "JPEG image manipulation") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/json/json.md.
1 2 3 | [//000000001]: # (json \- JSON) [//000000002]: # (Generated from file 'json\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (json \- JSON) [//000000002]: # (Generated from file 'json\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2006 ActiveState Software Inc\.) [//000000004]: # (Copyright © 2009 Thomas Maeder, Glue Software Engineering AG) [//000000005]: # (json\(n\) 1\.3\.4 tcllib "JSON") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/ldap/ldap.md.
1 2 3 | [//000000001]: # (ldap \- LDAP client) [//000000002]: # (Generated from file 'ldap\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (ldap \- LDAP client) [//000000002]: # (Generated from file 'ldap\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004 Jochen Loewer <loewerj@web\.de>) [//000000005]: # (Copyright © 2006 Michael Schlenker <mic42@users\.sourceforge\.net>) [//000000006]: # (ldap\(n\) 1\.9\.2 tcllib "LDAP client") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/bignum.md.
1 2 3 | [//000000001]: # (math::bignum \- Tcl Math Library) [//000000002]: # (Generated from file 'bignum\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (math::bignum \- Tcl Math Library) [//000000002]: # (Generated from file 'bignum\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Salvatore Sanfilippo <antirez at invece dot org>) [//000000004]: # (Copyright © 2004 Arjen Markus <arjenmarkus at users dot sourceforge dot net>) [//000000005]: # (math::bignum\(n\) 3\.1 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/exact.md.
1 2 3 | [//000000001]: # (math::exact \- Tcl Math Library) [//000000002]: # (Generated from file 'exact\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (math::exact \- Tcl Math Library) [//000000002]: # (Generated from file 'exact\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2015 Kevin B\. Kenny <kennykb@acm\.org>) [//000000004]: # (Redistribution permitted under the terms of the Open Publication License <http://www\.opencontent\.org/openpub/>) [//000000005]: # (math::exact\(n\) 1\.0\.1 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/interpolate.md.
1 2 3 | [//000000001]: # (math::interpolate \- Tcl Math Library) [//000000002]: # (Generated from file 'interpolate\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (math::interpolate \- Tcl Math Library) [//000000002]: # (Generated from file 'interpolate\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Arjen Markus <arjenmarkus@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004 Kevn B\. Kenny <kennykb@users\.sourceforge\.net>) [//000000005]: # (math::interpolate\(n\) 1\.1 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/linalg.md.
1 2 3 | [//000000001]: # (math::linearalgebra \- Tcl Math Library) [//000000002]: # (Generated from file 'linalg\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (math::linearalgebra \- Tcl Math Library) [//000000002]: # (Generated from file 'linalg\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004\-2008 Arjen Markus <arjenmarkus@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004 Ed Hume <http://www\.hume\.com/contact\.us\.htm>) [//000000005]: # (Copyright © 2008 Michael Buadin <relaxkmike@users\.sourceforge\.net>) [//000000006]: # (math::linearalgebra\(n\) 1\.1\.5 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/math_geometry.md.
1 2 3 | [//000000001]: # (math::geometry \- Tcl Math Library) [//000000002]: # (Generated from file 'math\_geometry\.man' by tcllib/doctools with format 'markdown') | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | [//000000001]: # (math::geometry \- Tcl Math Library) [//000000002]: # (Generated from file 'math\_geometry\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2001 by Ideogramic ApS and other parties) [//000000004]: # (Copyright © 2010 by Andreas Kupries) [//000000005]: # (Copyright © 2010 by Kevin Kenny) [//000000006]: # (Copyright © 2018 by Arjen Markus) [//000000007]: # (math::geometry\(n\) 1\.3\.0 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/numtheory.md.
︙ | ︙ | |||
49 50 51 52 53 54 55 56 57 58 59 60 61 62 | [__math::numtheory::legendre__ *a* *p*](#11) [__math::numtheory::jacobi__ *a* *b*](#12) [__math::numtheory::gcd__ *m* *n*](#13) [__math::numtheory::lcm__ *m* *n*](#14) [__math::numtheory::numberPrimesGauss__ *N*](#15) [__math::numtheory::numberPrimesLegendre__ *N*](#16) [__math::numtheory::numberPrimesLegendreModified__ *N*](#17) # <a name='description'></a>DESCRIPTION This package is for collecting various number\-theoretic operations, with a slight bias to prime numbers\. - <a name='1'></a>__math::numtheory::isprime__ *N* ?*option* *value* \.\.\.? | > | 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | [__math::numtheory::legendre__ *a* *p*](#11) [__math::numtheory::jacobi__ *a* *b*](#12) [__math::numtheory::gcd__ *m* *n*](#13) [__math::numtheory::lcm__ *m* *n*](#14) [__math::numtheory::numberPrimesGauss__ *N*](#15) [__math::numtheory::numberPrimesLegendre__ *N*](#16) [__math::numtheory::numberPrimesLegendreModified__ *N*](#17) [__math::numtheory::differenceNumberPrimesLegendreModified__ *lower* *upper*](#18) # <a name='description'></a>DESCRIPTION This package is for collecting various number\-theoretic operations, with a slight bias to prime numbers\. - <a name='1'></a>__math::numtheory::isprime__ *N* ?*option* *value* \.\.\.? |
︙ | ︙ | |||
213 214 215 216 217 218 219 | - <a name='15'></a>__math::numtheory::numberPrimesGauss__ *N* Estimate the number of primes according the formula by Gauss\. * integer *N* \(in\) | | | | > > > > > > > > > > > > > | 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 | - <a name='15'></a>__math::numtheory::numberPrimesGauss__ *N* Estimate the number of primes according the formula by Gauss\. * integer *N* \(in\) Number in question, should be larger than 0 - <a name='16'></a>__math::numtheory::numberPrimesLegendre__ *N* Estimate the number of primes according the formula by Legendre\. * integer *N* \(in\) Number in question, should be larger than 0 - <a name='17'></a>__math::numtheory::numberPrimesLegendreModified__ *N* Estimate the number of primes according the modified formula by Legendre\. * integer *N* \(in\) Number in question, should be larger than 0 - <a name='18'></a>__math::numtheory::differenceNumberPrimesLegendreModified__ *lower* *upper* Estimate the number of primes between tow limits according the modified formula by Legendre\. * integer *lower* \(in\) Lower limit for the primes, should be larger than 0 * integer *upper* \(in\) Upper limit for the primes, should be larger than 0 # <a name='section2'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *math :: numtheory* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/math/optimize.md.
1 2 3 | [//000000001]: # (math::optimize \- Tcl Math Library) [//000000002]: # (Generated from file 'optimize\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (math::optimize \- Tcl Math Library) [//000000002]: # (Generated from file 'optimize\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Arjen Markus <arjenmarkus@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004,2005 Kevn B\. Kenny <kennykb@users\.sourceforge\.net>) [//000000005]: # (math::optimize\(n\) 1\.0 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Added embedded/md/tcllib/files/modules/math/quasirandom.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (math::quasirandom \- Tcl Math Library) [//000000002]: # (Generated from file 'quasirandom\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (math::quasirandom\(n\) 1 tcllib "Tcl Math Library") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> # NAME math::quasirandom \- Quasi\-random points for integration and Monte Carlo type methods # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [COMMANDS](#section2) - [TODO](#section3) - [References](#section4) - [Keywords](#keywords) - [Category](#category) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require TclOO package require math::quasirandom 1 [__::math::quasirandom::qrpoint create__ *NAME* *DIM* ?ARGS?](#1) [__gen next__](#2) [__gen set\-start__ *index*](#3) [__gen set\-evaluations__ *number*](#4) [__gen integral__ *func* *minmax* *args*](#5) # <a name='description'></a>DESCRIPTION In many applications pseudo\-random numbers and pseudo\-random points in a \(limited\) sample space play an important role\. For instance in any type of Monte Carlo simulation\. Pseudo\-random numbers, however, may be too random and as a consequence a large number of data points is required to reduce the error or fluctuation in the results to the desired value\. Quasi\-random numbers can be used as an alternative: instead of "completely" arbitrary points, points are generated that are diverse enough to cover the entire sample space in a more or less uniform way\. As a consequence convergence to the limit can be much faster, when such quasi\-random numbers are well\-chosen\. The package defines a *[class](\.\./\.\./\.\./\.\./index\.md\#class)* "qrpoint" that creates a command to generate quasi\-random points in 1, 2 or more dimensions\. The command can either generate separate points, so that they can be used in a user\-defined algorithm or use these points to calculate integrals of functions defined over 1, 2 or more dimensions\. It also holds several other common algorithms\. \(NOTE: these are not implemented yet\) One particular characteristic of the generators is that there are no tuning parameters involved, which makes the use particularly simple\. # <a name='section2'></a>COMMANDS A quasi\-random point generator is created using the *qrpoint* class: - <a name='1'></a>__::math::quasirandom::qrpoint create__ *NAME* *DIM* ?ARGS? This command takes the following arguments: * string *NAME* The name of the command to be created \(alternatively: the *new* subcommand will generate a unique name\) * integer/string *DIM* The number of dimensions or one of: "circle", "disk", "sphere" or "ball" * strings *ARGS* Zero or more key\-value pairs\. The supported options are: + *\-start index*: The index for the next point to be generated \(default: 1\) + *\-evaluations number*: The number of evaluations to be used by default \(default: 100\) The points that are returned lie in the hyperblock \[0,1\[^n \(n the number of dimensions\) or on the unit circle, within the unit disk, on the unit sphere or within the unit ball\. Each generator supports the following subcommands: - <a name='2'></a>__gen next__ Return the coordinates of the next quasi\-random point - <a name='3'></a>__gen set\-start__ *index* Reset the index for the next quasi\-random point\. This is useful to control which list of points is returned\. Returns the new or the current value, if no value is given\. - <a name='4'></a>__gen set\-evaluations__ *number* Reset the default number of evaluations in compound algorithms\. Note that the actual number is the smallest 4\-fold larger or equal to the given number\. \(The 4\-fold plays a role in the detailed integration routine\.\) - <a name='5'></a>__gen integral__ *func* *minmax* *args* Calculate the integral of the given function over the block \(or the circle, sphere etc\.\) * string *func* The name of the function to be integrated * list *minmax* List of pairs of minimum and maximum coordinates\. This can be used to map the quasi\-random coordinates to the desired hyper\-block\. If the space is a circle, disk etc\. then this argument should be a single value, the radius\. The circle, disk, etc\. is centred at the origin\. If this is not what is required, then a coordinate transformation should be made within the function\. * strings *args* Zero or more key\-value pairs\. The following options are supported: + *\-evaluations number*: The number of evaluations to be used\. If not specified use the default of the generator object\. # <a name='section3'></a>TODO Implement other algorithms and variants Implement more unit tests\. Comparison to pseudo\-random numbers for integration\. # <a name='section4'></a>References Various algorithms exist for generating quasi\-random numbers\. The generators created in this package are based on: [http://extremelearning\.com\.au/unreasonable\-effectiveness\-of\-quasirandom\-sequences/](http://extremelearning\.com\.au/unreasonable\-effectiveness\-of\-quasirandom\-sequences/) # <a name='keywords'></a>KEYWORDS [mathematics](\.\./\.\./\.\./\.\./index\.md\#mathematics), [quasi\-random](\.\./\.\./\.\./\.\./index\.md\#quasi\_random) # <a name='category'></a>CATEGORY Mathematics |
Changes to embedded/md/tcllib/files/modules/math/symdiff.md.
1 2 3 | [//000000001]: # (math::calculus::symdiff \- Symbolic differentiation for Tcl) [//000000002]: # (Generated from file 'symdiff\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (math::calculus::symdiff \- Symbolic differentiation for Tcl) [//000000002]: # (Generated from file 'symdiff\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2010 by Kevin B\. Kenny <kennykb@acm\.org>) [//000000004]: # (Redistribution permitted under the terms of the Open Publication License <http://www\.opencontent\.org/openpub/>) [//000000005]: # (math::calculus::symdiff\(n\) 1\.0\.1 tcllib "Symbolic differentiation for Tcl") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/mime/mime.md.
1 2 3 4 | [//000000001]: # (mime \- Mime) [//000000002]: # (Generated from file 'mime\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 1999\-2000 Marshall T\. Rose) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (mime \- Mime) [//000000002]: # (Generated from file 'mime\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 1999\-2000 Marshall T\. Rose) [//000000004]: # (mime\(n\) 1\.6\.1 tcllib "Mime") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
34 35 36 37 38 39 40 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 | | | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require mime ?1\.6\.1? [__::mime::initialize__ ?__\-canonical__ *type/subtype* ?__\-param__ \{*key value*\}\.\.\.? ?__\-encoding__ *value*? ?__\-header__ \{*key value*\}\.\.\.?? \(__\-file__ *name* | __\-string__ *value* | __\-parts__ \{*token1* \.\.\. *tokenN*\}\)](#1) [__::mime::finalize__ *token* ?__\-subordinates__ __all__ | __dynamic__ | __none__?](#2) [__::mime::getproperty__ *token* ?*property* | __\-names__?](#3) [__::mime::getheader__ *token* ?*key* | __\-names__?](#4) [__::mime::setheader__ *token* *key value* ?__\-mode__ __write__ | __append__ | __delete__?](#5) [__::mime::getbody__ *token* ?__\-decode__? ?__\-command__ *callback* ?__\-blocksize__ *octets*??](#6) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/mime/smtp.md.
︙ | ︙ | |||
179 180 181 182 183 184 185 | # <a name='section3'></a>EXAMPLE proc send_simple_message {recipient email_server subject body} { package require smtp package require mime | | | | | 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | # <a name='section3'></a>EXAMPLE proc send_simple_message {recipient email_server subject body} { package require smtp package require mime set token [mime::initialize -canonical text/plain \ -string $body] mime::setheader $token Subject $subject smtp::sendmessage $token \ -recipients $recipient -servers $email_server mime::finalize $token } send_simple_message [email protected] localhost \ "This is the subject." "This is the message." # <a name='section4'></a>TLS Security Considerations This package uses the __[TLS](\.\./\.\./\.\./\.\./index\.md\#tls)__ package to handle the security for __https__ urls and other socket connections\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/namespacex/namespacex.md.
1 2 3 | [//000000001]: # (namespacex \- Namespace utility commands) [//000000002]: # (Generated from file 'namespacex\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (namespacex \- Namespace utility commands) [//000000002]: # (Generated from file 'namespacex\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 200? Neil Madden \(http://wiki\.tcl\.tk/12790\)) [//000000004]: # (Copyright © 200? Various \(http://wiki\.tcl\.tk/1489\)) [//000000005]: # (Copyright © 2010 Documentation, Andreas Kupries) [//000000006]: # (namespacex\(n\) 0\.2 tcllib "Namespace utility commands") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/oauth/oauth.md.
1 2 3 4 | [//000000001]: # (oauth \- oauth) [//000000002]: # (Generated from file 'oauth\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2014 Javi P\. <hxm@eggdrop\.es>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (oauth \- oauth) [//000000002]: # (Generated from file 'oauth\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2014 Javi P\. <hxm@eggdrop\.es>) [//000000004]: # (oauth\(n\) 1\.0\.3 tcllib "oauth") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
34 35 36 37 38 39 40 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 | | | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require oauth ?1\.0\.3? [__::oauth::config__](#1) [__::oauth::config__ ?*options*\.\.\.?](#2) [__::oauth::header__ *baseURL* ?*postQuery*?](#3) [__::oauth::query__ *baseURL* ?*postQuery*?](#4) # <a name='description'></a>DESCRIPTION |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pki/pki.md.
︙ | ︙ | |||
201 202 203 204 205 206 207 208 209 210 211 212 213 214 | to specify as a boolean value whether or not we can be used a certificate authority \(CA\)\. The *caDepth* argument indicates how many children CAs can be children of this CA in a depth\-wise fashion\. A value of "0" for the *caDepth* argument means that this CA cannot sign a CA certificate and have the result be valid\. A value of "\-1" indicates infinite depth\. # <a name='section3'></a>EXAMPLES # <a name='section4'></a>REFERENCES # <a name='section5'></a>AUTHORS Roy Keene | > > > > | 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | to specify as a boolean value whether or not we can be used a certificate authority \(CA\)\. The *caDepth* argument indicates how many children CAs can be children of this CA in a depth\-wise fashion\. A value of "0" for the *caDepth* argument means that this CA cannot sign a CA certificate and have the result be valid\. A value of "\-1" indicates infinite depth\. # <a name='section3'></a>EXAMPLES # <a name='section4'></a>REFERENCES # <a name='section5'></a>AUTHORS Roy Keene |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/png/png.md.
1 2 3 | [//000000001]: # (png \- Image manipulation) [//000000002]: # (Generated from file 'png\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (png \- Image manipulation) [//000000002]: # (Generated from file 'png\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004, Code: Aaron Faupell <afaupell@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004, Doc: Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (png\(n\) 0\.3 tcllib "Image manipulation") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pop3/pop3.md.
︙ | ︙ | |||
257 258 259 260 261 262 263 | suitable for POP3 servers which expect SSL connections only\. These will generally be listening on port 995\. package require tls tls::init -cafile /path/to/ca/cert -keyfile ... # Create secured pop3 channel | | | | 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 | suitable for POP3 servers which expect SSL connections only\. These will generally be listening on port 995\. package require tls tls::init -cafile /path/to/ca/cert -keyfile ... # Create secured pop3 channel pop3::open -socketcmd tls::socket \ $thehost $theuser $thepassword ... The second method, option __\-stls__, will connect to the standard POP3 port and then perform an STARTTLS handshake\. This will only work for POP3 servers which have this capability\. The package will confirm that the server supports STARTTLS and the handshake was performed correctly before proceeding with authentication\. package require tls tls::init -cafile /path/to/ca/cert -keyfile ... # Create secured pop3 channel pop3::open -stls 1 \ $thehost $theuser $thepassword ... # <a name='section5'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pop3d/pop3d.md.
1 2 3 | [//000000001]: # (pop3d \- Tcl POP3 Server Package) [//000000002]: # (Generated from file 'pop3d\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (pop3d \- Tcl POP3 Server Package) [//000000002]: # (Generated from file 'pop3d\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2002\-2009 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2005 Reinhard Max <max@suse\.de>) [//000000005]: # (pop3d\(n\) 1\.1\.0 tcllib "Tcl POP3 Server Package") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
258 259 260 261 262 263 264 | The option __\-socket__ \(see [Options](#section2)\) enables users of the package to override how the server opens its listening socket\. The envisioned main use is the specification of the __tls::socket__ command, see package __[tls](\.\./\.\./\.\./\.\./index\.md\#tls)__, to secure the communication\. package require tls | | | 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 | The option __\-socket__ \(see [Options](#section2)\) enables users of the package to override how the server opens its listening socket\. The envisioned main use is the specification of the __tls::socket__ command, see package __[tls](\.\./\.\./\.\./\.\./index\.md\#tls)__, to secure the communication\. package require tls tls::init \ ... pop3d::new S -socket tls::socket ... # <a name='section6'></a>References |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/practcl/practcl.md.
1 2 3 4 | [//000000001]: # (practcl \- The The Proper Rational API for C to Tool Command Language Module) [//000000002]: # (Generated from file 'practcl\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2016\-2018 Sean Woods <yoda@etoyoc\.com>) | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > > | > | < > > > > > > > > > > > > > > > > > | > > | < > > > > > > > | > > > > > > > > > > > > > > > > | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 | [//000000001]: # (practcl \- The The Proper Rational API for C to Tool Command Language Module) [//000000002]: # (Generated from file 'practcl\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2016\-2018 Sean Woods <yoda@etoyoc\.com>) [//000000004]: # (practcl\(n\) 0\.16\.3 tcllib "The The Proper Rational API for C to Tool Command Language Module") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> # NAME practcl \- The Practcl Module # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [Commands](#section2) - [Classes](#section3) - [Class practcl::doctool](#subsection1) - [Class practcl::metaclass](#subsection2) - [Class practcl::toolset](#subsection3) - [Class practcl::toolset\.gcc](#subsection4) - [Class practcl::toolset\.msvc](#subsection5) - [Class practcl::make\_obj](#subsection6) - [Class practcl::object](#subsection7) - [Class practcl::dynamic](#subsection8) - [Class practcl::product](#subsection9) - [Class practcl::product\.cheader](#subsection10) - [Class practcl::product\.csource](#subsection11) - [Class practcl::product\.clibrary](#subsection12) - [Class practcl::product\.dynamic](#subsection13) - [Class practcl::product\.critcl](#subsection14) - [Class practcl::module](#subsection15) - [Class practcl::project](#subsection16) - [Class practcl::library](#subsection17) - [Class practcl::tclkit](#subsection18) - [Class practcl::distribution](#subsection19) - [Class practcl::distribution\.snapshot](#subsection20) - [Class practcl::distribution\.fossil](#subsection21) - [Class practcl::distribution\.git](#subsection22) - [Class practcl::subproject](#subsection23) - [Class practcl::subproject\.source](#subsection24) - [Class practcl::subproject\.teapot](#subsection25) - [Class practcl::subproject\.kettle](#subsection26) - [Class practcl::subproject\.critcl](#subsection27) - [Class practcl::subproject\.sak](#subsection28) - [Class practcl::subproject\.practcl](#subsection29) - [Class practcl::subproject\.binary](#subsection30) - [Class practcl::subproject\.tea](#subsection31) - [Class practcl::subproject\.library](#subsection32) - [Class practcl::subproject\.external](#subsection33) - [Class practcl::subproject\.core](#subsection34) - [Bugs, Ideas, Feedback](#section4) - [Keywords](#keywords) - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require TclOO 1\.0 [proc __practcl::cat__ *fname*](#1) [proc __practcl::docstrip__ *text*](#2) [proc __putb__ ?*map*? *text*](#3) [proc __[Proc](\.\./\.\./\.\./\.\./index\.md\#proc)__ *name* *arglist* *body*](#4) [proc __noop__ ?*args*?](#5) [proc __practcl::debug__ ?*args*?](#6) [proc __practcl::doexec__ ?*args*?](#7) [proc __practcl::doexec\_in__ *path* ?*args*?](#8) [proc __practcl::dotclexec__ ?*args*?](#9) [proc __practcl::domake__ *path* ?*args*?](#10) [proc __practcl::domake\.tcl__ *path* ?*args*?](#11) [proc __practcl::fossil__ *path* ?*args*?](#12) [proc __practcl::fossil\_status__ *dir*](#13) [proc __practcl::os__](#14) [proc __practcl::mkzip__ *exename* *barekit* *vfspath*](#15) [proc __practcl::sort\_dict__ *list*](#16) [proc __practcl::local\_os__](#17) [proc __practcl::config\.tcl__ *path*](#18) [proc __practcl::read\_configuration__ *path*](#19) [proc __practcl::tcllib\_require__ *pkg* ?*args*?](#20) [proc __practcl::platform::tcl\_core\_options__ *os*](#21) [proc __practcl::platform::tk\_core\_options__ *os*](#22) [proc __practcl::read\_rc\_file__ *filename* ?*localdat* ____?](#23) [proc __practcl::read\_sh\_subst__ *line* *info*](#24) [proc __practcl::read\_sh\_file__ *filename* ?*localdat* ____?](#25) [proc __practcl::read\_Config\.sh__ *filename*](#26) [proc __practcl::read\_Makefile__ *filename*](#27) [proc __practcl::cputs__ *varname* ?*args*?](#28) [proc __practcl::tcl\_to\_c__ *body*](#29) [proc __practcl::\_tagblock__ *text* ?*style* __tcl__? ?*note* ____?](#30) [proc __practcl::de\_shell__ *data*](#31) [proc __practcl::grep__ *pattern* ?*files* ____?](#32) [proc __practcl::file\_lexnormalize__ *sp*](#33) [proc __practcl::file\_relative__ *base* *dst*](#34) [proc __practcl::findByPattern__ *basedir* *patterns*](#35) [proc __practcl::log__ *fname* *comment*](#36) [proc __practcl::\_pkgindex\_simpleIndex__ *path*](#37) [proc __practcl::\_pkgindex\_directory__ *path*](#38) [proc __practcl::\_pkgindex\_path\_subdir__ *path*](#39) [proc __practcl::pkgindex\_path__ ?*args*?](#40) [proc __practcl::installDir__ *d1* *d2*](#41) [proc __practcl::copyDir__ *d1* *d2* ?*toplevel* __1__?](#42) [proc __practcl::buildModule__ *modpath*](#43) [proc __practcl::installModule__ *modpath* *DEST*](#44) [proc __practcl::trigger__ ?*args*?](#45) [proc __practcl::depends__ ?*args*?](#46) [proc __practcl::target__ *name* *info* ?*action* ____?](#47) [method __constructor__](#48) [method __argspec__ *argspec*](#49) [method __[comment](\.\./\.\./\.\./\.\./index\.md\#comment)__ *block*](#50) [method __keyword\.Annotation__ *resultvar* *commentblock* *type* *name* *body*](#51) [method __keyword\.Class__ *resultvar* *commentblock* *name* *body*](#52) [method __keyword\.class__ *resultvar* *commentblock* *name* *body*](#53) [method __keyword\.Class\_Method__ *resultvar* *commentblock* *name* ?*args*?](#54) [method __keyword\.method__ *resultvar* *commentblock* *name* ?*args*?](#55) [method __keyword\.proc__ *commentblock* *name* *argspec*](#56) [method __reset__](#57) [method __Main__](#58) [method __section\.method__ *keyword* *method* *minfo*](#59) [method __section\.annotation__ *type* *name* *iinfo*](#60) [method __section\.class__ *class\_name* *class\_info*](#61) [method __section\.command__ *procinfo*](#62) [method __[manpage](\.\./\.\./\.\./\.\./index\.md\#manpage)__ ?__header *value*__? ?__footer *value*__? ?__authors *list*__?](#63) [method __scan\_text__ *text*](#64) [method __scan\_file__ *filename*](#65) [method __\_MorphPatterns__](#66) [method __[define](\.\./\.\./\.\./\.\./index\.md\#define)__ *submethod* ?*args*?](#67) [method __graft__ ?*args*?](#68) [method __initialize__](#69) [method __link__ *command* ?*args*?](#70) [method __morph__ *classname*](#71) [method __script__ *script*](#72) [method __select__](#73) [method __[source](\.\./\.\./\.\./\.\./index\.md\#source)__ *filename*](#74) [classmethod __select__ *object*](#75) [method __config\.sh__](#76) [method __BuildDir__ *PWD*](#77) [method __MakeDir__ *srcdir*](#78) [method __read\_configuration__](#79) [method __build\-cflags__ *PROJECT* *DEFS* *namevar* *versionvar* *defsvar*](#80) [method __critcl__ ?*args*?](#81) [method __Autoconf__](#82) [method __BuildDir__ *PWD*](#83) [method __ConfigureOpts__](#84) [method __MakeDir__ *srcdir*](#85) [method __make \{\} autodetect__](#86) [method __make \{\} clean__](#87) [method __make \{\} compile__](#88) [method __make \{\} install__ *DEST*](#89) [method __build\-compile\-sources__ *PROJECT* *COMPILE* *CPPCOMPILE* *INCLUDES*](#90) [method __build\-Makefile__ *path* *PROJECT*](#91) [method __build\-library__ *outfile* *PROJECT*](#92) [method __build\-tclsh__ *outfile* *PROJECT* ?*path* __auto__?](#93) [method __BuildDir__ *PWD*](#94) [method __make \{\} autodetect__](#95) [method __make \{\} clean__](#96) [method __make \{\} compile__](#97) [method __make \{\} install__ *DEST*](#98) [method __MakeDir__ *srcdir*](#99) [method __NmakeOpts__](#100) [method __constructor__ *module\_object* *name* *info* ?*action\_body* ____?](#101) [method __[do](\.\./\.\./\.\./\.\./index\.md\#do)__](#102) [method __check__](#103) [method __output__](#104) [method __reset__](#105) [method __triggers__](#106) [method __constructor__ *parent* ?*args*?](#107) [method __child__ *method*](#108) [method __go__](#109) [method __cstructure__ *name* *definition* ?*argdat* ____?](#110) [method __include__ *header*](#111) [method __include\_dir__ ?*args*?](#112) [method __include\_directory__ ?*args*?](#113) [method __c\_header__ *body*](#114) [method __c\_code__ *body*](#115) [method __c\_function__ *header* *body* ?*info* ____?](#116) [method __c\_tcloomethod__ *name* *body* ?*arginfo* ____?](#117) [method __cmethod__ *name* *body* ?*arginfo* ____?](#118) [method __c\_tclproc\_nspace__ *nspace*](#119) [method __c\_tclcmd__ *name* *body* ?*arginfo* ____?](#120) [method __c\_tclproc\_raw__ *name* *body* ?*arginfo* ____?](#121) [method __tcltype__ *name* *argdat*](#122) [method __project\-compile\-products__](#123) [method __implement__ *path*](#124) [method __initialize__](#125) [method __linktype__](#126) [method __generate\-cfile\-constant__](#127) [method __generate\-cfile\-header__](#128) [method __generate\-cfile\-tclapi__](#129) [method __generate\-loader\-module__](#130) [method __Collate\_Source__ *CWD*](#131) [method __select__](#132) [classmethod __select__ *object*](#133) [method __code__ *section* *body*](#134) [method __Collate\_Source__ *CWD*](#135) [method __project\-compile\-products__](#136) [method __generate\-debug__ ?*spaces* ____?](#137) [method __generate\-cfile\-constant__](#138) [method __generate\-cfile\-public\-structure__](#139) [method __generate\-cfile\-header__](#140) [method __generate\-cfile\-global__](#141) [method __generate\-cfile\-private\-typedef__](#142) [method __generate\-cfile\-private\-structure__](#143) [method __generate\-cfile\-functions__](#144) [method __generate\-cfile\-tclapi__](#145) [method __generate\-hfile\-public\-define__](#146) [method __generate\-hfile\-public\-macro__](#147) [method __generate\-hfile\-public\-typedef__](#148) [method __generate\-hfile\-public\-structure__](#149) [method __generate\-hfile\-public\-headers__](#150) [method __generate\-hfile\-public\-function__](#151) [method __generate\-hfile\-public\-includes__](#152) [method __generate\-hfile\-public\-verbatim__](#153) [method __generate\-loader\-external__](#154) [method __generate\-loader\-module__](#155) [method __generate\-stub\-function__](#156) [method __IncludeAdd__ *headervar* ?*args*?](#157) [method __generate\-tcl\-loader__](#158) [method __generate\-tcl\-pre__](#159) [method __generate\-tcl\-post__](#160) [method __linktype__](#161) [method __Ofile__ *filename*](#162) [method __project\-static\-packages__](#163) [method __toolset\-include\-directory__](#164) [method __target__ *method* ?*args*?](#165) [method __project\-compile\-products__](#166) [method __generate\-loader\-module__](#167) [method __project\-compile\-products__](#168) [method __linker\-products__ *configdict*](#169) [method __initialize__](#170) [variable __make\_object__](#171) [method __\_MorphPatterns__](#172) [method __add__ ?*args*?](#173) [method __install\-headers__ ?*args*?](#174) [method __make \{\} \_preamble__](#175) [method __make \{\} pkginfo__](#176) [method __make \{\} objects__](#177) [method __make \{\} object__ *name*](#178) [method __make \{\} reset__](#179) [method __make \{\} trigger__ ?*args*?](#180) [method __make \{\} depends__ ?*args*?](#181) [method __make \{\} filename__ *name*](#182) [method __make \{\} target__ *name* *Info* *body*](#183) [method __make \{\} todo__](#184) [method __make \{\} do__](#185) [method __child__ *which*](#186) [method __generate\-c__](#187) [method __generate\-h__](#188) [method __generate\-loader__](#189) [method __initialize__](#190) [method __implement__ *path*](#191) [method __linktype__](#192) [method __\_MorphPatterns__](#193) [method __constructor__ ?*args*?](#194) [method __add\_object__ *object*](#195) [method __add\_project__ *pkg* *info* ?*oodefine* ____?](#196) [method __add\_tool__ *pkg* *info* ?*oodefine* ____?](#197) [method __build\-tclcore__](#198) [method __child__ *which*](#199) [method __linktype__](#200) [method __project__ *pkg* ?*args*?](#201) [method __tclcore__](#202) [method __tkcore__](#203) [method __[tool](\.\./tool/tool\.md)__ *pkg* ?*args*?](#204) [method __clean__ *PATH*](#205) [method __project\-compile\-products__](#206) [method __go__](#207) [method __generate\-decls__ *pkgname* *path*](#208) [method __implement__ *path*](#209) [method __generate\-make__ *path*](#210) [method __linktype__](#211) [method __package\-ifneeded__ ?*args*?](#212) [method __shared\_library__ ?*filename* ____?](#213) [method __static\_library__ ?*filename* ____?](#214) [method __build\-tclkit\_main__ *PROJECT* *PKG\_OBJS*](#215) [method __Collate\_Source__ *CWD*](#216) [method __wrap__ *PWD* *exename* *vfspath* ?*args*?](#217) [classmethod __Sandbox__ *object*](#218) [classmethod __select__ *object*](#219) [classmethod __claim\_option__](#220) [classmethod __claim\_object__ *object*](#221) [classmethod __claim\_path__ *path*](#222) [method __scm\_info__](#223) [method __DistroMixIn__](#224) [method __Sandbox__](#225) [method __SrcDir__](#226) [method __ScmTag__](#227) [method __ScmClone__](#228) [method __ScmUnpack__](#229) [method __ScmUpdate__](#230) [method __Unpack__](#231) [classmethod __claim\_object__ *object*](#232) [classmethod __claim\_option__](#233) [classmethod __claim\_path__ *path*](#234) [method __ScmUnpack__](#235) [classmethod __claim\_object__ *obj*](#236) [classmethod __claim\_option__](#237) [classmethod __claim\_path__ *path*](#238) [method __scm\_info__](#239) [method __ScmClone__](#240) [method __ScmTag__](#241) [method __ScmUnpack__](#242) [method __ScmUpdate__](#243) [classmethod __claim\_object__ *obj*](#244) [classmethod __claim\_option__](#245) [classmethod __claim\_path__ *path*](#246) [method __ScmTag__](#247) [method __ScmUnpack__](#248) [method __ScmUpdate__](#249) [method __\_MorphPatterns__](#250) [method __BuildDir__ *PWD*](#251) [method __child__ *which*](#252) [method __compile__](#253) [method __go__](#254) [method __install__ ?*args*?](#255) [method __linktype__](#256) [method __linker\-products__ *configdict*](#257) [method __linker\-external__ *configdict*](#258) [method __linker\-extra__ *configdict*](#259) [method __env\-bootstrap__](#260) [method __env\-exec__](#261) [method __env\-install__](#262) [method __env\-load__](#263) [method __env\-present__](#264) [method __sources__](#265) [method __[update](\.\./\.\./\.\./\.\./index\.md\#update)__](#266) [method __unpack__](#267) [method __env\-bootstrap__](#268) [method __env\-present__](#269) [method __linktype__](#270) [method __env\-bootstrap__](#271) [method __env\-install__](#272) [method __env\-present__](#273) [method __install__ *DEST*](#274) [method __kettle__ *path* ?*args*?](#275) [method __install__ *DEST*](#276) [method __install__ *DEST*](#277) [method __env\-bootstrap__](#278) [method __env\-install__](#279) [method __env\-present__](#280) [method __install__ *DEST*](#281) [method __install\-module__ *DEST* ?*args*?](#282) [method __env\-bootstrap__](#283) [method __env\-install__](#284) [method __install__ *DEST*](#285) [method __install\-module__ *DEST* ?*args*?](#286) [method __clean__](#287) [method __env\-install__](#288) [method __project\-compile\-products__](#289) [method __ComputeInstall__](#290) [method __go__](#291) [method __linker\-products__ *configdict*](#292) [method __project\-static\-packages__](#293) [method __BuildDir__ *PWD*](#294) [method __compile__](#295) [method __Configure__](#296) [method __install__ *DEST*](#297) [method __install__ *DEST*](#298) [method __install__ *DEST*](#299) [method __env\-bootstrap__](#300) [method __env\-present__](#301) [method __env\-install__](#302) [method __go__](#303) [method __linktype__](#304) # <a name='description'></a>DESCRIPTION The Practcl module is a tool for integrating large modules for C API Tcl code that requires custom Tcl types and TclOO objects\. The concept with Practcl is that is a single file package that can assist any tcl based project with distribution, compilation, linking, VFS preparation, executable assembly, and installation\. Practcl also allows one project to invoke the build system from another project, allowing complex projects such as a statically linked basekit to be assembled with relative ease\. Practcl ships as a single file, and aside from a Tcl 8\.6 interpreter, has no external dependencies\. Making a practcl project # <a name='section2'></a>Commands - <a name='1'></a>proc __practcl::cat__ *fname* Concatenate a file - <a name='2'></a>proc __practcl::docstrip__ *text* Strip the global comments from tcl code\. Used to prevent the documentation markup comments from clogging up files intended for distribution in machine readable format\. - <a name='3'></a>proc __putb__ ?*map*? *text* Append a line of text to a variable\. Optionally apply a string mapping\. - <a name='4'></a>proc __[Proc](\.\./\.\./\.\./\.\./index\.md\#proc)__ *name* *arglist* *body* Generate a proc if no command already exists by that name - <a name='5'></a>proc __noop__ ?*args*? A command to do nothing\. A handy way of negating an instruction without having to comment it completely out\. It's also a handy attachment point for an object to be named later - <a name='6'></a>proc __practcl::debug__ ?*args*? - <a name='7'></a>proc __practcl::doexec__ ?*args*? Drop in a static copy of Tcl - <a name='8'></a>proc __practcl::doexec\_in__ *path* ?*args*? - <a name='9'></a>proc __practcl::dotclexec__ ?*args*? - <a name='10'></a>proc __practcl::domake__ *path* ?*args*? - <a name='11'></a>proc __practcl::domake\.tcl__ *path* ?*args*? - <a name='12'></a>proc __practcl::fossil__ *path* ?*args*? - <a name='13'></a>proc __practcl::fossil\_status__ *dir* - <a name='14'></a>proc __practcl::os__ - <a name='15'></a>proc __practcl::mkzip__ *exename* *barekit* *vfspath* Build a zipfile\. On tcl8\.6 this invokes the native Zip implementation on older interpreters this invokes zip via exec - <a name='16'></a>proc __practcl::sort\_dict__ *list* Dictionary sort a key/value list\. Needed because pre tcl8\.6 does not have *lsort \-stride 2* - <a name='17'></a>proc __practcl::local\_os__ - <a name='18'></a>proc __practcl::config\.tcl__ *path* Detect local platform - <a name='19'></a>proc __practcl::read\_configuration__ *path* - <a name='20'></a>proc __practcl::tcllib\_require__ *pkg* ?*args*? Try to load a package, and failing that retrieve tcllib - <a name='21'></a>proc __practcl::platform::tcl\_core\_options__ *os* - <a name='22'></a>proc __practcl::platform::tk\_core\_options__ *os* - <a name='23'></a>proc __practcl::read\_rc\_file__ *filename* ?*localdat* ____? Read a stylized key/value list stored in a file - <a name='24'></a>proc __practcl::read\_sh\_subst__ *line* *info* Converts a XXX\.sh file into a series of Tcl variables - <a name='25'></a>proc __practcl::read\_sh\_file__ *filename* ?*localdat* ____? - <a name='26'></a>proc __practcl::read\_Config\.sh__ *filename* A simpler form of read\_sh\_file tailored to pulling data from \(tcl|tk\)Config\.sh - <a name='27'></a>proc __practcl::read\_Makefile__ *filename* A simpler form of read\_sh\_file tailored to pulling data from a Makefile - <a name='28'></a>proc __practcl::cputs__ *varname* ?*args*? Append arguments to a buffer The command works like puts in that each call will also insert a line feed\. Unlike puts, blank links in the interstitial are suppressed - <a name='29'></a>proc __practcl::tcl\_to\_c__ *body* - <a name='30'></a>proc __practcl::\_tagblock__ *text* ?*style* __tcl__? ?*note* ____? - <a name='31'></a>proc __practcl::de\_shell__ *data* - <a name='32'></a>proc __practcl::grep__ *pattern* ?*files* ____? Search for the pattern *pattern* amongst $files - <a name='33'></a>proc __practcl::file\_lexnormalize__ *sp* - <a name='34'></a>proc __practcl::file\_relative__ *base* *dst* Calculate a relative path between base and dst Example: ::practcl::file_relative ~/build/tcl/unix ~/build/tcl/library > ../library - <a name='35'></a>proc __practcl::findByPattern__ *basedir* *patterns* - <a name='36'></a>proc __practcl::log__ *fname* *comment* Record an event in the practcl log - <a name='37'></a>proc __practcl::\_pkgindex\_simpleIndex__ *path* - <a name='38'></a>proc __practcl::\_pkgindex\_directory__ *path* Return true if the pkgindex file contains any statement other than "package ifneeded" and/or if any package ifneeded loads a DLL - <a name='39'></a>proc __practcl::\_pkgindex\_path\_subdir__ *path* Helper function for ::practcl::pkgindex\_path - <a name='40'></a>proc __practcl::pkgindex\_path__ ?*args*? Index all paths given as though they will end up in the same virtual file system - <a name='41'></a>proc __practcl::installDir__ *d1* *d2* Delete the contents of *d2*, and then recusively Ccopy the contents of *d1* to *d2*\. - <a name='42'></a>proc __practcl::copyDir__ *d1* *d2* ?*toplevel* __1__? Recursively copy the contents of *d1* to *d2* - <a name='43'></a>proc __practcl::buildModule__ *modpath* - <a name='44'></a>proc __practcl::installModule__ *modpath* *DEST* - <a name='45'></a>proc __practcl::trigger__ ?*args*? Trigger build targets, and recompute dependencies Internals: ::practcl::LOCAL make trigger {*}$args foreach {name obj} [::practcl::LOCAL make objects] { set ::make($name) [$obj do] } - <a name='46'></a>proc __practcl::depends__ ?*args*? Calculate if a dependency for any of the arguments needs to be fulfilled or rebuilt\. Internals: ::practcl::LOCAL make depends {*}$args - <a name='47'></a>proc __practcl::target__ *name* *info* ?*action* ____? Declare a build product\. This proc is just a shorthand for *::practcl::LOCAL make task $name $info $action* Registering a build product with this command will create an entry in the global array, and populate a value in the global array\. Internals: set obj [::practcl::LOCAL make task $name $info $action] set ::make($name) 0 set filename [$obj define get filename] if {$filename ne {}} { set ::target($name) $filename } # <a name='section3'></a>Classes ## <a name='subsection1'></a>Class practcl::doctool { set authors { {John Doe} {[email protected]} {Tom RichardHarry} {[email protected]} } # Create the object ::practcl::doctool create AutoDoc set fout [open [file join $moddir module.tcl] w] foreach file [glob [file join $srcdir *.tcl]] { set content [::practcl::cat [file join $srcdir $file]] # Scan the file AutoDoc scan_text $content # Strip the comments from the distribution puts $fout [::practcl::docstrip $content] } # Write out the manual page set manout [open [file join $moddir module.man] w] dict set args header [string map $modmap [::practcl::cat [file join $srcdir manual.txt]]] dict set args footer [string map $modmap [::practcl::cat [file join $srcdir footer.txt]]] dict set args authors $authors puts $manout [AutoDoc manpage {*}$args] close $manout } Tool for build scripts to dynamically generate manual files from comments in source code files __Methods__ - <a name='48'></a>method __constructor__ - <a name='49'></a>method __argspec__ *argspec* Process an argument list into an informational dict\. This method also understands non\-positional arguments expressed in the notation of Tip 471 [https://core\.tcl\-lang\.org/tips/doc/trunk/tip/479\.md](https://core\.tcl\-lang\.org/tips/doc/trunk/tip/479\.md)\. The output will be a dictionary of all of the fields and whether the fields are __positional__, __mandatory__, and whether they have a __default__ value\. Example: my argspec {a b {c 10}} > a {positional 1 mandatory 1} b {positional 1 mandatory 1} c {positional 1 mandatory 0 default 10} - <a name='50'></a>method __[comment](\.\./\.\./\.\./\.\./index\.md\#comment)__ *block* Convert a block of comments into an informational dictionary\. If lines in the comment start with a single word ending in a colon, all subsequent lines are appended to a dictionary field of that name\. If no fields are given, all of the text is appended to the __description__ field\. Example: my comment {Does something cool} > description {Does something cool} my comment { title : Something really cool author : Sean Woods author : John Doe description : This does something really cool! } > description {This does something really cool!} title {Something really cool} author {Sean Woods John Doe} - <a name='51'></a>method __keyword\.Annotation__ *resultvar* *commentblock* *type* *name* *body* - <a name='52'></a>method __keyword\.Class__ *resultvar* *commentblock* *name* *body* Process an oo::objdefine call that modifies the class object itself - <a name='53'></a>method __keyword\.class__ *resultvar* *commentblock* *name* *body* Process an oo::define, clay::define, etc statement\. - <a name='54'></a>method __keyword\.Class\_Method__ *resultvar* *commentblock* *name* ?*args*? Process a statement for a clay style class method - <a name='55'></a>method __keyword\.method__ *resultvar* *commentblock* *name* ?*args*? Process a statement for a tcloo style object method - <a name='56'></a>method __keyword\.proc__ *commentblock* *name* *argspec* Process a proc statement - <a name='57'></a>method __reset__ Reset the state of the object and its embedded coroutine - <a name='58'></a>method __Main__ Main body of the embedded coroutine for the object - <a name='59'></a>method __section\.method__ *keyword* *method* *minfo* Generate the manual page text for a method or proc - <a name='60'></a>method __section\.annotation__ *type* *name* *iinfo* - <a name='61'></a>method __section\.class__ *class\_name* *class\_info* Generate the manual page text for a class - <a name='62'></a>method __section\.command__ *procinfo* Generate the manual page text for the commands section - <a name='63'></a>method __[manpage](\.\./\.\./\.\./\.\./index\.md\#manpage)__ ?__header *value*__? ?__footer *value*__? ?__authors *list*__? Generate the manual page\. Returns the completed text suitable for saving in \.man file\. The header argument is a block of doctools text to go in before the machine generated section\. footer is a block of doctools text to go in after the machine generated section\. authors is a list of individual authors and emails in the form of AUTHOR EMAIL ?AUTHOR EMAIL?\.\.\. - <a name='64'></a>method __scan\_text__ *text* Scan a block of text - <a name='65'></a>method __scan\_file__ *filename* Scan a file of text ## <a name='subsection2'></a>Class practcl::metaclass The metaclass for all practcl objects __Methods__ - <a name='66'></a>method __\_MorphPatterns__ - <a name='67'></a>method __[define](\.\./\.\./\.\./\.\./index\.md\#define)__ *submethod* ?*args*? - <a name='68'></a>method __graft__ ?*args*? - <a name='69'></a>method __initialize__ - <a name='70'></a>method __link__ *command* ?*args*? - <a name='71'></a>method __morph__ *classname* - <a name='72'></a>method __script__ *script* - <a name='73'></a>method __select__ - <a name='74'></a>method __[source](\.\./\.\./\.\./\.\./index\.md\#source)__ *filename* ## <a name='subsection3'></a>Class practcl::toolset Ancestor\-less class intended to be a mixin which defines a family of build related behaviors that are modified when targetting either gcc or msvc __Class Methods__ - <a name='75'></a>classmethod __select__ *object* Perform the selection for the toolset mixin __Methods__ - <a name='76'></a>method __config\.sh__ find or fake a key/value list describing this project - <a name='77'></a>method __BuildDir__ *PWD* Compute the location where the product will be built - <a name='78'></a>method __MakeDir__ *srcdir* Return where the Makefile is located relative to *srcdir*\. For this implementation the MakeDir is always srcdir\. - <a name='79'></a>method __read\_configuration__ Read information about the build process for this package\. For this implementation, data is sought in the following locations in the following order: config\.tcl \(generated by practcl\.\) PKGConfig\.sh\. The Makefile If the Makefile needs to be consulted, but does not exist, the Configure method is invoked - <a name='80'></a>method __build\-cflags__ *PROJECT* *DEFS* *namevar* *versionvar* *defsvar* method DEFS This method populates 4 variables: name \- The name of the package version \- The version of the package defs \- C flags passed to the compiler includedir \- A list of paths to feed to the compiler for finding headers - <a name='81'></a>method __critcl__ ?*args*? Invoke critcl in an external process ## <a name='subsection4'></a>Class practcl::toolset\.gcc *ancestors*: __practcl::toolset__ __Methods__ - <a name='82'></a>method __Autoconf__ - <a name='83'></a>method __BuildDir__ *PWD* - <a name='84'></a>method __ConfigureOpts__ - <a name='85'></a>method __MakeDir__ *srcdir* Detect what directory contains the Makefile template - <a name='86'></a>method __make \{\} autodetect__ - <a name='87'></a>method __make \{\} clean__ - <a name='88'></a>method __make \{\} compile__ - <a name='89'></a>method __make \{\} install__ *DEST* - <a name='90'></a>method __build\-compile\-sources__ *PROJECT* *COMPILE* *CPPCOMPILE* *INCLUDES* - <a name='91'></a>method __build\-Makefile__ *path* *PROJECT* - <a name='92'></a>method __build\-library__ *outfile* *PROJECT* Produce a static or dynamic library - <a name='93'></a>method __build\-tclsh__ *outfile* *PROJECT* ?*path* __auto__? Produce a static executable ## <a name='subsection5'></a>Class practcl::toolset\.msvc *ancestors*: __practcl::toolset__ __Methods__ - <a name='94'></a>method __BuildDir__ *PWD* MSVC always builds in the source directory - <a name='95'></a>method __make \{\} autodetect__ Do nothing - <a name='96'></a>method __make \{\} clean__ - <a name='97'></a>method __make \{\} compile__ - <a name='98'></a>method __make \{\} install__ *DEST* - <a name='99'></a>method __MakeDir__ *srcdir* Detect what directory contains the Makefile template - <a name='100'></a>method __NmakeOpts__ ## <a name='subsection6'></a>Class practcl::make\_obj *ancestors*: __practcl::metaclass__ A build deliverable object\. Normally an object file, header, or tcl script which must be compiled or generated in some way __Methods__ - <a name='101'></a>method __constructor__ *module\_object* *name* *info* ?*action\_body* ____? - <a name='102'></a>method __[do](\.\./\.\./\.\./\.\./index\.md\#do)__ - <a name='103'></a>method __check__ - <a name='104'></a>method __output__ - <a name='105'></a>method __reset__ - <a name='106'></a>method __triggers__ ## <a name='subsection7'></a>Class practcl::object *ancestors*: __practcl::metaclass__ A generic Practcl object __Methods__ - <a name='107'></a>method __constructor__ *parent* ?*args*? - <a name='108'></a>method __child__ *method* - <a name='109'></a>method __go__ ## <a name='subsection8'></a>Class practcl::dynamic Dynamic blocks do not generate their own \.c files, instead the contribute to the amalgamation of the main library file __Methods__ - <a name='110'></a>method __cstructure__ *name* *definition* ?*argdat* ____? Parser functions - <a name='111'></a>method __include__ *header* - <a name='112'></a>method __include\_dir__ ?*args*? - <a name='113'></a>method __include\_directory__ ?*args*? - <a name='114'></a>method __c\_header__ *body* - <a name='115'></a>method __c\_code__ *body* - <a name='116'></a>method __c\_function__ *header* *body* ?*info* ____? - <a name='117'></a>method __c\_tcloomethod__ *name* *body* ?*arginfo* ____? - <a name='118'></a>method __cmethod__ *name* *body* ?*arginfo* ____? Alias to classic name - <a name='119'></a>method __c\_tclproc\_nspace__ *nspace* - <a name='120'></a>method __c\_tclcmd__ *name* *body* ?*arginfo* ____? - <a name='121'></a>method __c\_tclproc\_raw__ *name* *body* ?*arginfo* ____? Alias to classic name - <a name='122'></a>method __tcltype__ *name* *argdat* - <a name='123'></a>method __project\-compile\-products__ Module interactions - <a name='124'></a>method __implement__ *path* - <a name='125'></a>method __initialize__ Practcl internals - <a name='126'></a>method __linktype__ - <a name='127'></a>method __generate\-cfile\-constant__ - <a name='128'></a>method __generate\-cfile\-header__ - <a name='129'></a>method __generate\-cfile\-tclapi__ Generate code that provides implements Tcl API calls - <a name='130'></a>method __generate\-loader\-module__ Generate code that runs when the package/module is initialized into the interpreter - <a name='131'></a>method __Collate\_Source__ *CWD* - <a name='132'></a>method __select__ Once an object marks itself as some flavor of dynamic, stop trying to morph it into something else ## <a name='subsection9'></a>Class practcl::product A deliverable for the build system __Class Methods__ - <a name='133'></a>classmethod __select__ *object* __Methods__ - <a name='134'></a>method __code__ *section* *body* - <a name='135'></a>method __Collate\_Source__ *CWD* - <a name='136'></a>method __project\-compile\-products__ - <a name='137'></a>method __generate\-debug__ ?*spaces* ____? - <a name='138'></a>method __generate\-cfile\-constant__ - <a name='139'></a>method __generate\-cfile\-public\-structure__ Populate const static data structures - <a name='140'></a>method __generate\-cfile\-header__ - <a name='141'></a>method __generate\-cfile\-global__ - <a name='142'></a>method __generate\-cfile\-private\-typedef__ - <a name='143'></a>method __generate\-cfile\-private\-structure__ - <a name='144'></a>method __generate\-cfile\-functions__ Generate code that provides subroutines called by Tcl API methods - <a name='145'></a>method __generate\-cfile\-tclapi__ Generate code that provides implements Tcl API calls - <a name='146'></a>method __generate\-hfile\-public\-define__ - <a name='147'></a>method __generate\-hfile\-public\-macro__ - <a name='148'></a>method __generate\-hfile\-public\-typedef__ - <a name='149'></a>method __generate\-hfile\-public\-structure__ - <a name='150'></a>method __generate\-hfile\-public\-headers__ - <a name='151'></a>method __generate\-hfile\-public\-function__ - <a name='152'></a>method __generate\-hfile\-public\-includes__ - <a name='153'></a>method __generate\-hfile\-public\-verbatim__ - <a name='154'></a>method __generate\-loader\-external__ - <a name='155'></a>method __generate\-loader\-module__ - <a name='156'></a>method __generate\-stub\-function__ - <a name='157'></a>method __IncludeAdd__ *headervar* ?*args*? - <a name='158'></a>method __generate\-tcl\-loader__ - <a name='159'></a>method __generate\-tcl\-pre__ This methods generates any Tcl script file which is required to pre\-initialize the C library - <a name='160'></a>method __generate\-tcl\-post__ - <a name='161'></a>method __linktype__ - <a name='162'></a>method __Ofile__ *filename* - <a name='163'></a>method __project\-static\-packages__ Methods called by the master project - <a name='164'></a>method __toolset\-include\-directory__ Methods called by the toolset - <a name='165'></a>method __target__ *method* ?*args*? ## <a name='subsection10'></a>Class practcl::product\.cheader *ancestors*: __practcl::product__ A product which generated from a C header file\. Which is to say, nothing\. __Methods__ - <a name='166'></a>method __project\-compile\-products__ - <a name='167'></a>method __generate\-loader\-module__ ## <a name='subsection11'></a>Class practcl::product\.csource *ancestors*: __practcl::product__ A product which generated from a C source file\. Normally an object \(\.o\) file\. __Methods__ - <a name='168'></a>method __project\-compile\-products__ ## <a name='subsection12'></a>Class practcl::product\.clibrary *ancestors*: __practcl::product__ A product which is generated from a compiled C library\. Usually a \.a or a \.dylib file, but in complex cases may actually just be a conduit for one project to integrate the source code of another __Methods__ - <a name='169'></a>method __linker\-products__ *configdict* ## <a name='subsection13'></a>Class practcl::product\.dynamic *ancestors*: __practcl::dynamic__ __practcl::product__ A product which is generated from C code that itself is generated by practcl or some other means\. This C file may or may not produce its own \.o file, depending on whether it is eligible to become part of an amalgamation __Methods__ - <a name='170'></a>method __initialize__ ## <a name='subsection14'></a>Class practcl::product\.critcl *ancestors*: __practcl::dynamic__ __practcl::product__ A binary product produced by critcl\. Note: The implementation is not written yet, this class does nothing\. ## <a name='subsection15'></a>Class practcl::module *ancestors*: __practcl::object__ __practcl::product\.dynamic__ In the end, all C code must be loaded into a module This will either be a dynamically loaded library implementing a tcl extension, or a compiled in segment of a custom shell/app __Variable__ - <a name='171'></a>variable __make\_object__ __Methods__ - <a name='172'></a>method __\_MorphPatterns__ - <a name='173'></a>method __add__ ?*args*? - <a name='174'></a>method __install\-headers__ ?*args*? - <a name='175'></a>method __make \{\} \_preamble__ - <a name='176'></a>method __make \{\} pkginfo__ - <a name='177'></a>method __make \{\} objects__ Return a dictionary of all handles and associated objects - <a name='178'></a>method __make \{\} object__ *name* Return the object associated with handle *name* - <a name='179'></a>method __make \{\} reset__ Reset all deputy objects - <a name='180'></a>method __make \{\} trigger__ ?*args*? Exercise the triggers method for all handles listed - <a name='181'></a>method __make \{\} depends__ ?*args*? Exercise the check method for all handles listed - <a name='182'></a>method __make \{\} filename__ *name* Return the file name of the build product for the listed handle - <a name='183'></a>method __make \{\} target__ *name* *Info* *body* - <a name='184'></a>method __make \{\} todo__ Return a list of handles for object which return true for the do method - <a name='185'></a>method __make \{\} do__ For each target exercise the action specified in the *action* definition if the *do* method returns true - <a name='186'></a>method __child__ *which* - <a name='187'></a>method __generate\-c__ This methods generates the contents of an amalgamated \.c file which implements the loader for a batch of tools - <a name='188'></a>method __generate\-h__ This methods generates the contents of an amalgamated \.h file which describes the public API of this module - <a name='189'></a>method __generate\-loader__ - <a name='190'></a>method __initialize__ - <a name='191'></a>method __implement__ *path* - <a name='192'></a>method __linktype__ ## <a name='subsection16'></a>Class practcl::project *ancestors*: __practcl::module__ A toplevel project that is a collection of other projects __Methods__ - <a name='193'></a>method __\_MorphPatterns__ - <a name='194'></a>method __constructor__ ?*args*? - <a name='195'></a>method __add\_object__ *object* - <a name='196'></a>method __add\_project__ *pkg* *info* ?*oodefine* ____? - <a name='197'></a>method __add\_tool__ *pkg* *info* ?*oodefine* ____? - <a name='198'></a>method __build\-tclcore__ Compile the Tcl core\. If the define *tk* is true, compile the Tk core as well - <a name='199'></a>method __child__ *which* - <a name='200'></a>method __linktype__ - <a name='201'></a>method __project__ *pkg* ?*args*? Exercise the methods of a sub\-object - <a name='202'></a>method __tclcore__ - <a name='203'></a>method __tkcore__ - <a name='204'></a>method __[tool](\.\./tool/tool\.md)__ *pkg* ?*args*? ## <a name='subsection17'></a>Class practcl::library *ancestors*: __practcl::project__ A toplevel project that produces a library __Methods__ - <a name='205'></a>method __clean__ *PATH* - <a name='206'></a>method __project\-compile\-products__ - <a name='207'></a>method __go__ - <a name='208'></a>method __generate\-decls__ *pkgname* *path* - <a name='209'></a>method __implement__ *path* - <a name='210'></a>method __generate\-make__ *path* Backward compadible call - <a name='211'></a>method __linktype__ - <a name='212'></a>method __package\-ifneeded__ ?*args*? Create a "package ifneeded" Args are a list of aliases for which this package will answer to - <a name='213'></a>method __shared\_library__ ?*filename* ____? - <a name='214'></a>method __static\_library__ ?*filename* ____? ## <a name='subsection18'></a>Class practcl::tclkit *ancestors*: __practcl::library__ A toplevel project that produces a self\-contained executable __Methods__ - <a name='215'></a>method __build\-tclkit\_main__ *PROJECT* *PKG\_OBJS* - <a name='216'></a>method __Collate\_Source__ *CWD* - <a name='217'></a>method __wrap__ *PWD* *exename* *vfspath* ?*args*? Wrap an executable ## <a name='subsection19'></a>Class practcl::distribution Standalone class to manage code distribution This class is intended to be mixed into another class \(Thus the lack of ancestors\) __Class Methods__ - <a name='218'></a>classmethod __Sandbox__ *object* - <a name='219'></a>classmethod __select__ *object* - <a name='220'></a>classmethod __claim\_option__ - <a name='221'></a>classmethod __claim\_object__ *object* - <a name='222'></a>classmethod __claim\_path__ *path* __Methods__ - <a name='223'></a>method __scm\_info__ - <a name='224'></a>method __DistroMixIn__ - <a name='225'></a>method __Sandbox__ - <a name='226'></a>method __SrcDir__ - <a name='227'></a>method __ScmTag__ - <a name='228'></a>method __ScmClone__ - <a name='229'></a>method __ScmUnpack__ - <a name='230'></a>method __ScmUpdate__ - <a name='231'></a>method __Unpack__ ## <a name='subsection20'></a>Class practcl::distribution\.snapshot *ancestors*: __practcl::distribution__ A file distribution from zip, tarball, or other non\-scm archive format __Class Methods__ - <a name='232'></a>classmethod __claim\_object__ *object* - <a name='233'></a>classmethod __claim\_option__ - <a name='234'></a>classmethod __claim\_path__ *path* __Methods__ - <a name='235'></a>method __ScmUnpack__ ## <a name='subsection21'></a>Class practcl::distribution\.fossil *ancestors*: __practcl::distribution__ A file distribution based on fossil __Class Methods__ - <a name='236'></a>classmethod __claim\_object__ *obj* Check for markers in the metadata - <a name='237'></a>classmethod __claim\_option__ - <a name='238'></a>classmethod __claim\_path__ *path* Check for markers in the source root __Methods__ - <a name='239'></a>method __scm\_info__ - <a name='240'></a>method __ScmClone__ Clone the source - <a name='241'></a>method __ScmTag__ - <a name='242'></a>method __ScmUnpack__ - <a name='243'></a>method __ScmUpdate__ ## <a name='subsection22'></a>Class practcl::distribution\.git *ancestors*: __practcl::distribution__ A file distribution based on git __Class Methods__ - <a name='244'></a>classmethod __claim\_object__ *obj* - <a name='245'></a>classmethod __claim\_option__ - <a name='246'></a>classmethod __claim\_path__ *path* __Methods__ - <a name='247'></a>method __ScmTag__ - <a name='248'></a>method __ScmUnpack__ - <a name='249'></a>method __ScmUpdate__ ## <a name='subsection23'></a>Class practcl::subproject *ancestors*: __practcl::module__ A subordinate project __Methods__ - <a name='250'></a>method __\_MorphPatterns__ - <a name='251'></a>method __BuildDir__ *PWD* - <a name='252'></a>method __child__ *which* - <a name='253'></a>method __compile__ - <a name='254'></a>method __go__ - <a name='255'></a>method __install__ ?*args*? Install project into the local build system - <a name='256'></a>method __linktype__ - <a name='257'></a>method __linker\-products__ *configdict* - <a name='258'></a>method __linker\-external__ *configdict* - <a name='259'></a>method __linker\-extra__ *configdict* - <a name='260'></a>method __env\-bootstrap__ Methods for packages/tools that can be downloaded possibly built and used internally by this Practcl process Load the facility into the interpreter - <a name='261'></a>method __env\-exec__ Return a file path that exec can call - <a name='262'></a>method __env\-install__ Install the tool into the local environment - <a name='263'></a>method __env\-load__ Do whatever is necessary to get the tool into the local environment - <a name='264'></a>method __env\-present__ Check if tool is available for load/already loaded - <a name='265'></a>method __sources__ - <a name='266'></a>method __[update](\.\./\.\./\.\./\.\./index\.md\#update)__ - <a name='267'></a>method __unpack__ ## <a name='subsection24'></a>Class practcl::subproject\.source *ancestors*: __practcl::subproject__ __practcl::library__ A project which the kit compiles and integrates the source for itself __Methods__ - <a name='268'></a>method __env\-bootstrap__ - <a name='269'></a>method __env\-present__ - <a name='270'></a>method __linktype__ ## <a name='subsection25'></a>Class practcl::subproject\.teapot *ancestors*: __practcl::subproject__ a copy from the teapot __Methods__ - <a name='271'></a>method __env\-bootstrap__ - <a name='272'></a>method __env\-install__ - <a name='273'></a>method __env\-present__ - <a name='274'></a>method __install__ *DEST* ## <a name='subsection26'></a>Class practcl::subproject\.kettle *ancestors*: __practcl::subproject__ __Methods__ - <a name='275'></a>method __kettle__ *path* ?*args*? - <a name='276'></a>method __install__ *DEST* ## <a name='subsection27'></a>Class practcl::subproject\.critcl *ancestors*: __practcl::subproject__ __Methods__ - <a name='277'></a>method __install__ *DEST* ## <a name='subsection28'></a>Class practcl::subproject\.sak *ancestors*: __practcl::subproject__ __Methods__ - <a name='278'></a>method __env\-bootstrap__ - <a name='279'></a>method __env\-install__ - <a name='280'></a>method __env\-present__ - <a name='281'></a>method __install__ *DEST* - <a name='282'></a>method __install\-module__ *DEST* ?*args*? ## <a name='subsection29'></a>Class practcl::subproject\.practcl *ancestors*: __practcl::subproject__ __Methods__ - <a name='283'></a>method __env\-bootstrap__ - <a name='284'></a>method __env\-install__ - <a name='285'></a>method __install__ *DEST* - <a name='286'></a>method __install\-module__ *DEST* ?*args*? ## <a name='subsection30'></a>Class practcl::subproject\.binary *ancestors*: __practcl::subproject__ A subordinate binary package __Methods__ - <a name='287'></a>method __clean__ - <a name='288'></a>method __env\-install__ - <a name='289'></a>method __project\-compile\-products__ - <a name='290'></a>method __ComputeInstall__ - <a name='291'></a>method __go__ - <a name='292'></a>method __linker\-products__ *configdict* - <a name='293'></a>method __project\-static\-packages__ - <a name='294'></a>method __BuildDir__ *PWD* - <a name='295'></a>method __compile__ - <a name='296'></a>method __Configure__ - <a name='297'></a>method __install__ *DEST* ## <a name='subsection31'></a>Class practcl::subproject\.tea *ancestors*: __practcl::subproject\.binary__ A subordinate TEA based binary package ## <a name='subsection32'></a>Class practcl::subproject\.library *ancestors*: __practcl::subproject\.binary__ __practcl::library__ A subordinate C library built by this project __Methods__ - <a name='298'></a>method __install__ *DEST* ## <a name='subsection33'></a>Class practcl::subproject\.external *ancestors*: __practcl::subproject\.binary__ A subordinate external C library __Methods__ - <a name='299'></a>method __install__ *DEST* ## <a name='subsection34'></a>Class practcl::subproject\.core *ancestors*: __practcl::subproject\.binary__ __Methods__ - <a name='300'></a>method __env\-bootstrap__ - <a name='301'></a>method __env\-present__ - <a name='302'></a>method __env\-install__ - <a name='303'></a>method __go__ - <a name='304'></a>method __linktype__ # <a name='section4'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *practcl* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. When proposing code changes, please provide *unified diffs*, i\.e the output of |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pt/pt_peg_container.md.
︙ | ︙ | |||
187 188 189 190 191 192 193 | This method assigns the contents of the PEG object *source* to ourselves, overwriting the existing definition\. This is the assignment operator for grammars\. This operation is in effect equivalent to | | | | 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 | This method assigns the contents of the PEG object *source* to ourselves, overwriting the existing definition\. This is the assignment operator for grammars\. This operation is in effect equivalent to > *objectName* __deserialize =__ \[*source* __serialize__\] - <a name='9'></a>*objectName* __\-\->__ *destination* This method assigns our contents to the PEG object *destination*, overwriting the existing definition\. This is the reverse assignment operator for grammars\. This operation is in effect equivalent to > *destination* __deserialize =__ \[*objectName* __serialize__\] - <a name='10'></a>*objectName* __serialize__ ?*format*? This method returns our grammar in some textual form usable for transfer, persistent storage, etc\. If no *format* is not specified the returned result is the canonical serialization of the grammar, as specified in the section [PEG serialization format](#section2)\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pt/pt_peg_export.md.
1 2 3 4 | [//000000001]: # (pt::peg::export \- Parser Tools) [//000000002]: # (Generated from file 'pt\_peg\_export\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (pt::peg::export \- Parser Tools) [//000000002]: # (Generated from file 'pt\_peg\_export\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (pt::peg::export\(n\) 1\.0\.1 tcllib "Parser Tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
47 48 49 50 51 52 53 | - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require snit | | | | 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require snit package require struct::map package require pt::peg package require pluginmgr package require pt::peg::export ?1\.0\.1? [__::pt::peg::export__ *objectName*](#1) [__objectName__ __method__ ?*arg arg \.\.\.*?](#2) [*objectName* __destroy__](#3) [*objectName* __export serial__ *serial* ?*format*?](#4) [*objectName* __export object__ *object* ?*format*?](#5) [*objectName* __configuration names__](#6) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pt/pt_peg_import.md.
1 2 3 4 | [//000000001]: # (pt::peg::import \- Parser Tools) [//000000002]: # (Generated from file 'pt\_peg\_import\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (pt::peg::import \- Parser Tools) [//000000002]: # (Generated from file 'pt\_peg\_import\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (pt::peg::import\(n\) 1\.0\.1 tcllib "Parser Tools") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
46 47 48 49 50 51 52 53 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require snit | > | | | 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require Tcl 8\.5 package require snit package require fileutil::paths package require pt::peg package require pluginmgr package require pt::peg::import ?1\.0\.1? [__::pt::peg::import__ *objectName*](#1) [__objectName__ __method__ ?*arg arg \.\.\.*?](#2) [*objectName* __destroy__](#3) [*objectName* __import text__ *text* ?*format*?](#4) [*objectName* __import file__ *path* ?*format*?](#5) [*objectName* __import object text__ *object* *text* ?*format*?](#6) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pt/pt_peg_to_tclparam.md.
︙ | ︙ | |||
246 247 248 249 250 251 252 | - __[pt::tclparam::configuration::snit](pt\_tclparam\_config\_snit\.md)__ Generated parsers are classes based on the __[snit](\.\./snit/snit\.md)__ package, i\.e\. snit::type's\. - __[pt::tclparam::configuration::tcloo](pt\_tclparam\_config\_tcloo\.md)__ | | > | 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | - __[pt::tclparam::configuration::snit](pt\_tclparam\_config\_snit\.md)__ Generated parsers are classes based on the __[snit](\.\./snit/snit\.md)__ package, i\.e\. snit::type's\. - __[pt::tclparam::configuration::tcloo](pt\_tclparam\_config\_tcloo\.md)__ Generated parsers are classes based on the __[OO](\.\./\.\./\.\./\.\./index\.md\#oo)__ package\. # <a name='section4'></a>Tcl/PARAM code representation of parsing expression grammars The Tcl/PARAM representation of parsing expression grammars is Tcl code whose execution will parse input per the grammar\. The code is based on the virtual machine documented in the *[PackRat Machine Specification](pt\_param\.md)*, using its instructions and a few more to handle control flow\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/pt/pt_tclparam_config_tcloo.md.
︙ | ︙ | |||
48 49 50 51 52 53 54 | system the current package is a part of\. This package is an adjunct to __[pt::peg::to::tclparam](pt\_peg\_to\_tclparam\.md)__, to make the use of this highly configurable package easier by providing a canned configuration\. When applied this configuration causes the package __[pt::peg::to::tclparam](pt\_peg\_to\_tclparam\.md)__ to generate | | | > | | 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 | system the current package is a part of\. This package is an adjunct to __[pt::peg::to::tclparam](pt\_peg\_to\_tclparam\.md)__, to make the use of this highly configurable package easier by providing a canned configuration\. When applied this configuration causes the package __[pt::peg::to::tclparam](pt\_peg\_to\_tclparam\.md)__ to generate __[OO](\.\./\.\./\.\./\.\./index\.md\#oo)__\-based parser packages\. It is a supporting package in the Core Layer of Parser Tools\.  # <a name='section2'></a>API - <a name='1'></a>__::pt::tclparam::configuration::tcloo__ __def__ *name* *pkg* *version* *cmdprefix* The command applies the configuration provided by this package to the *cmdprefix*, causing the creation of __[OO](\.\./\.\./\.\./\.\./index\.md\#oo)__\-based parsers whose class is *name*, in package *pkg* with *version*\. The use of a command prefix as API allows application of the configuration to not only __[pt::peg::to::tclparam](pt\_peg\_to\_tclparam\.md)__ \(__pt::peg::to::tclparam configure__\), but also export manager instances and PEG containers \(__$export configuration set__ and __\[$container exporter\] configuration set__ respectively\)\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/rcs/rcs.md.
1 2 3 | [//000000001]: # (rcs \- RCS low level utilities) [//000000002]: # (Generated from file 'rcs\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (rcs \- RCS low level utilities) [//000000002]: # (Generated from file 'rcs\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2005, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2005, Colin McCormack <coldstore@users\.sourceforge\.net>) [//000000005]: # (rcs\(n\) 2\.0\.2 tcllib "RCS low level utilities") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/sha1/sha1.md.
1 2 3 4 | [//000000001]: # (sha1 \- SHA\-x Message\-Digest Algorithm) [//000000002]: # (Generated from file 'sha1\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2005, Pat Thoyts <patthoyts@users\.sourceforge\.net>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (sha1 \- SHA\-x Message\-Digest Algorithm) [//000000002]: # (Generated from file 'sha1\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2005, Pat Thoyts <patthoyts@users\.sourceforge\.net>) [//000000004]: # (sha1\(n\) 2\.0\.4 tcllib "SHA\-x Message\-Digest Algorithm") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
40 41 42 43 44 45 46 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.2 | | | 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.2 package require sha1 ?2\.0\.4? [__::sha1::sha1__ ?__\-hex|\-bin__? \[ __\-channel channel__ | __\-file filename__ | ?__\-\-__? *string* \]](#1) [__::sha1::hmac__ *key* *string*](#2) [__::sha1::hmac__ ?__\-hex|\-bin__? __\-key key__ \[ __\-channel channel__ | __\-file filename__ | ?__\-\-__? *string* \]](#3) [__::sha1::SHA1Init__](#4) [__::sha1::SHA1Update__ *token* *data*](#5) [__::sha1::SHA1Final__ *token*](#6) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/sha1/sha256.md.
1 2 3 4 | [//000000001]: # (sha256 \- SHA\-x Message\-Digest Algorithm) [//000000002]: # (Generated from file 'sha256\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2008, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (sha256 \- SHA\-x Message\-Digest Algorithm) [//000000002]: # (Generated from file 'sha256\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2008, Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (sha256\(n\) 1\.0\.4 tcllib "SHA\-x Message\-Digest Algorithm") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
40 41 42 43 44 45 46 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.2 | | | 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.2 package require sha256 ?1\.0\.4? [__::sha2::sha256__ ?__\-hex|\-bin__? \[ __\-channel channel__ | __\-file filename__ | ?__\-\-__? *string* \]](#1) [__::sha2::sha224__ ?__\-hex|\-bin__? \[ __\-channel channel__ | __\-file filename__ | ?__\-\-__? *string* \]](#2) [__::sha2::hmac__ *key* *string*](#3) [__::sha2::hmac__ ?__\-hex|\-bin__? __\-key key__ \[ __\-channel channel__ | __\-file filename__ | ?__\-\-__? *string* \]](#4) [__::sha2::SHA256Init__](#5) [__::sha2::SHA224Init__](#6) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/soundex/soundex.md.
1 2 3 | [//000000001]: # (soundex \- Soundex) [//000000002]: # (Generated from file 'soundex\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (soundex \- Soundex) [//000000002]: # (Generated from file 'soundex\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © ????, Algorithm: Donald E\. Knuth) [//000000004]: # (Copyright © 2003, Documentation: Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (Copyright © 1998, Tcl port: Evan Rempel <erempel@uvic\.ca>) [//000000006]: # (soundex\(n\) 1\.0 tcllib "Soundex") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/struct/graph.md.
1 2 3 | [//000000001]: # (struct::graph \- Tcl Data Structures) [//000000002]: # (Generated from file 'graph\.man' by tcllib/doctools with format 'markdown') | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (struct::graph \- Tcl Data Structures) [//000000002]: # (Generated from file 'graph\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2002\-2009,2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (struct::graph\(n\) 2\.4\.2 tcllib "Tcl Data Structures") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
32 33 34 35 36 37 38 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 | | | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.4 package require struct::graph ?2\.4\.2? package require struct::list ?1\.5? package require struct::set ?2\.2\.3? [__::struct::graph__ ?*graphName*? ?__=__|__:=__|__as__|__deserialize__ *source*?](#1) [__graphName__ *option* ?*arg arg \.\.\.*?](#2) [*graphName* __=__ *sourcegraph*](#3) [*graphName* __\-\->__ *destgraph*](#4) |
︙ | ︙ | |||
194 195 196 197 198 199 200 | This is the *assignment* operator for graph objects\. It copies the graph contained in the graph object *sourcegraph* over the graph data in *graphName*\. The old contents of *graphName* are deleted by this operation\. This operation is in effect equivalent to | | | | 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 | This is the *assignment* operator for graph objects\. It copies the graph contained in the graph object *sourcegraph* over the graph data in *graphName*\. The old contents of *graphName* are deleted by this operation\. This operation is in effect equivalent to > *graphName* __deserialize__ \[*sourcegraph* __serialize__\] The operation assumes that the *sourcegraph* provides the method __serialize__ and that this method returns a valid graph serialization\. - <a name='4'></a>*graphName* __\-\->__ *destgraph* This is the *reverse assignment* operator for graph objects\. It copies the graph contained in the graph object *graphName* over the graph data in the object *destgraph*\. The old contents of *destgraph* are deleted by this operation\. This operation is in effect equivalent to > *destgraph* __deserialize__ \[*graphName* __serialize__\] The operation assumes that the *destgraph* provides the method __deserialize__ and that this method takes a graph serialization\. - <a name='5'></a>*graphName* __append__ *key* *value* Appends a *value* to one of the keyed values associated with the graph\. |
︙ | ︙ | |||
403 404 405 406 407 408 409 | containing all arcs is returned\. Restrictions can limit the list of returned arcs based on the nodes that are connected by the arc, on the keyed values associated with the arc, or both\. A general filter command can be used as well\. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself\. The restrictions imposed by either __\-in__, __\-out__, __\-adj__, | | | | 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 | containing all arcs is returned\. Restrictions can limit the list of returned arcs based on the nodes that are connected by the arc, on the keyed values associated with the arc, or both\. A general filter command can be used as well\. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself\. The restrictions imposed by either __\-in__, __\-out__, __\-adj__, __\-inner__, or __\-embedding__ are applied first\. Specifying more than one of them is illegal\. After that the restrictions set via __\-key__ \(and __\-value__\) are applied\. Specifying more than one __\-key__ \(and __\-value__\) is illegal\. Specifying __\-value__ alone, without __\-key__ is illegal as well\. Any restriction set through __\-filter__ is applied last\. Specifying more |
︙ | ︙ | |||
446 447 448 449 450 451 452 453 454 455 456 457 458 459 | nodes\. * __\-embedding__ Return a list of all arcs adjacent to exactly one of the nodes in the set\. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph\. * __\-key__ *key* Limit the list of arcs that are returned to those arcs that have an associated key *key*\. * __\-value__ *value* | > > > > > > > > | 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 | nodes\. * __\-embedding__ Return a list of all arcs adjacent to exactly one of the nodes in the set\. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph\. *Attention*: After the above options any word with a leading dash which is not a valid option is treated as a node name instead of an invalid option to error out on\. This condition holds until either a valid option terminates the list of nodes, or the end of the command is reached, whichever comes first\. The remaining filter options are: * __\-key__ *key* Limit the list of arcs that are returned to those arcs that have an associated key *key*\. * __\-value__ *value* |
︙ | ︙ | |||
588 589 590 591 592 593 594 | Return a list of nodes in the graph\. Restrictions can limit the list of returned nodes based on neighboring nodes, or based on the keyed values associated with the node\. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself\. | | | > > > | | 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 | Return a list of nodes in the graph\. Restrictions can limit the list of returned nodes based on neighboring nodes, or based on the keyed values associated with the node\. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself\. The possible restrictions are the same as for method __arcs__\. Note that while the exact meanings change slightly, as they operate on nodes instead of arcs, the general behaviour is the same, especially when it comes to the handling of words with a leading dash in node lists\. The command recognizes: * __\-in__ Return a list of all nodes with at least one outgoing arc ending in a node found in the specified set of nodes\. Alternatively specified as the set of source nodes for the __\-in__ arcs of the node set\. The *incoming neighbours*\. |
︙ | ︙ | |||
727 728 729 730 731 732 733 | *Note:* The order of the nodes in the serialization has no relevance, nor has the order of the arcs per node\. # A possible serialization for the graph structure # # d -----> %2 | | | | | | 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 | *Note:* The order of the nodes in the serialization has no relevance, nor has the order of the arcs per node\. # A possible serialization for the graph structure # # d -----> %2 # / ^ \ # / / \ # / b \ # / / \ # %1 <- a - %0 e # ^ \\ / # \\ c / # \\ \\ / # \\ v v # f ------ %3 # is |
︙ | ︙ | |||
867 868 869 870 871 872 873 | # <a name='category'></a>CATEGORY Data structures # <a name='copyright'></a>COPYRIGHT | | | 878 879 880 881 882 883 884 885 | # <a name='category'></a>CATEGORY Data structures # <a name='copyright'></a>COPYRIGHT Copyright © 2002\-2009,2019 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net> |
Changes to embedded/md/tcllib/files/modules/struct/graphops.md.
1 2 3 | [//000000001]: # (struct::graph::op \- Tcl Data Structures) [//000000002]: # (Generated from file 'graphops\.man' by tcllib/doctools with format 'markdown') | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [//000000001]: # (struct::graph::op \- Tcl Data Structures) [//000000002]: # (Generated from file 'graphops\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2008 Alejandro Paz <vidriloco@gmail\.com>) [//000000004]: # (Copyright © 2008 \(docs\) Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (Copyright © 2009 Michal Antoniewski <antoniewski\.m@gmail\.com>) [//000000006]: # (struct::graph::op\(n\) 0\.11\.3 tcllib "Tcl Data Structures") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/struct/matrix.md.
︙ | ︙ | |||
147 148 149 150 151 152 153 | This is the assignment operator for matrix objects\. It copies the matrix contained in the matrix object *sourcematrix* over the matrix data in *matrixName*\. The old contents of *matrixName* are deleted by this operation\. This operation is in effect equivalent to | | | | 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 | This is the assignment operator for matrix objects\. It copies the matrix contained in the matrix object *sourcematrix* over the matrix data in *matrixName*\. The old contents of *matrixName* are deleted by this operation\. This operation is in effect equivalent to > *matrixName* __deserialize__ \[*sourcematrix* __serialize__\] - <a name='4'></a>*matrixName* __\-\->__ *destmatrix* This is the reverse assignment operator for matrix objects\. It copies the matrix contained in the matrix object *matrixName* over the matrix data in the object *destmatrix*\. The old contents of *destmatrix* are deleted by this operation\. This operation is in effect equivalent to > *destmatrix* __deserialize__ \[*matrixName* __serialize__\] - <a name='5'></a>*matrixName* __add column__ ?*values*? Extends the matrix by one column and then acts like __set column__ \(see below\) on this new column if there were *values* supplied\. Without *values* the new cells will be set to the empty string\. The new column is appended immediately behind the last existing column\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/struct/struct_list.md.
1 2 3 | [//000000001]: # (struct::list \- Tcl Data Structures) [//000000002]: # (Generated from file 'struct\_list\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (struct::list \- Tcl Data Structures) [//000000002]: # (Generated from file 'struct\_list\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2003\-2005 by Kevin B\. Kenny\. All rights reserved) [//000000004]: # (Copyright © 2003\-2012 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (struct::list\(n\) 1\.8\.4 tcllib "Tcl Data Structures") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Added embedded/md/tcllib/files/modules/struct/struct_map.md.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (struct::map \- ) [//000000002]: # (Generated from file 'struct\_map\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (struct::map\(n\) 1 tcllib "") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> # NAME struct::map \- Manage key/value maps # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Synopsis](#synopsis) - [Description](#section1) - [API](#section2) - [Bugs, Ideas, Feedback](#section3) # <a name='synopsis'></a>SYNOPSIS package require struct::map ?1? [__::struct::map__ *mapName*](#1) [__mapName__ __method__ ?*arg arg \.\.\.*?](#2) [*mapName* __get__](#3) [*mapName* __names__](#4) [*mapName* __set__ *name* ?*value*?](#5) [*mapName* __unset__ ?*pattern*\.\.\.?](#6) # <a name='description'></a>DESCRIPTION Provides a snit class whose instances manage a key/value map\. In other words, an object wrapper around Tcl arrays\. # <a name='section2'></a>API The main command provides construction of maps: - <a name='1'></a>__::struct::map__ *mapName* Creates a new, empty map with an associated global Tcl command whose name is *mapName*\. It may be used to invoke various operations on the map\. It has the following general form: * <a name='2'></a>__mapName__ __method__ ?*arg arg \.\.\.*? __method__ and *arg*uments determine the exact behavior of the command\. If *mapName* is specified as __%AUTO%__ a unique name will be generated by the package itself\. The result of the command is the fully\-qualified name of the instance command\. The following commands are possible for map objects: - <a name='3'></a>*mapName* __get__ Returns the entire map as a Tcl dictionary\. - <a name='4'></a>*mapName* __names__ Returns the list of all keys known to the map, in arbitrary order\. - <a name='5'></a>*mapName* __set__ *name* ?*value*? Sets key *name* to the specified *value*, if the value specified\. Returns the value for the key\. Throws an error if the key is not known\. - <a name='6'></a>*mapName* __unset__ ?*pattern*\.\.\.? Removes all keys matching at least one of the glob *pattern*s from the map\. If no pattern is specified all keys are removed\. In other words, the default pattern is __\*__\. The result of the command is the empty string\. # <a name='section3'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *struct :: list* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. When proposing code changes, please provide *unified diffs*, i\.e the output of __diff \-u__\. Note further that *attachments* are strongly preferred over inlined patches\. Attachments can be made by going to the __Edit__ form of the ticket immediately after its creation, and then using the left\-most button in the secondary navigation bar\. |
Changes to embedded/md/tcllib/files/modules/struct/struct_tree.md.
︙ | ︙ | |||
194 195 196 197 198 199 200 | This is the assignment operator for tree objects\. It copies the tree contained in the tree object *sourcetree* over the tree data in *treeName*\. The old contents of *treeName* are deleted by this operation\. This operation is in effect equivalent to | | | | 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 | This is the assignment operator for tree objects\. It copies the tree contained in the tree object *sourcetree* over the tree data in *treeName*\. The old contents of *treeName* are deleted by this operation\. This operation is in effect equivalent to > *treeName* __deserialize__ \[*sourcetree* __serialize__\] - <a name='5'></a>*treeName* __\-\->__ *desttree* This is the reverse assignment operator for tree objects\. It copies the tree contained in the tree object *treeName* over the tree data in the object *desttree*\. The old contents of *desttree* are deleted by this operation\. This operation is in effect equivalent to > *desttree* __deserialize__ \[*treeName* __serialize__\] - <a name='6'></a>*treeName* __ancestors__ *node* This method extends the method __parent__ and returns a list containing all ancestor nodes to the specified *node*\. The immediate ancestor, in other words, parent node, is the first element in that list, its parent the second element, and so on until the root node is reached, making it the last |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/tepam/tepam_argument_dialogbox.md.
︙ | ︙ | |||
77 78 79 80 81 82 83 | been acknowledged \(via the *OK* button\) and validated by a data checker\. If the entered data have been rejected \(via the *Cancel* button\) the __argument\_dialogbox__ returns __cancel__\. A small example illustrates how the __argument\_dialogbox__ can be employed: | | | | | | | | | | | | | | | | | | | | | | | | | | | < | < | | | | | | | | | | | | | | | | | | | | | | | | | | < < > > > | | | | | | | | | | | | | | | | | | | | | | | | 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 | been acknowledged \(via the *OK* button\) and validated by a data checker\. If the entered data have been rejected \(via the *Cancel* button\) the __argument\_dialogbox__ returns __cancel__\. A small example illustrates how the __argument\_dialogbox__ can be employed: > set DialogResult \[__tepam::argument\_dialogbox__ \\ > __\-title__ "Itinerary selection" \\ > __\-file__ \{*\-label "Itinerary report" \-variable report\_file*\} \\ > __\-frame__ \{*\-label "Itinerary start"*\} \\ > __\-comment__ \{*\-text "Specify your itinerary start location"*\} \\ > __\-entry__ \{*\-label "City" \-variable start\_city \-type string*\} \\ > __\-entry__ \{*\-label "Street" \-variable start\_street \-type string \-optional 1*\} \\ > __\-entry__ \{*\-label "Street number" \-variable start\_street\_nbr \-type integer \-optional 1*\} \\ > __\-frame__ \{*\-label "Itinerary destination"*\} \\ > __\-comment__ \{*\-text "Specify your itinerary destination"*\} \\ > __\-entry__ \{*\-label "City" \-variable dest\_city \-type string*\} \\ > __\-entry__ \{*\-label "Street" \-variable dest\_street \-type string \-optional 1*\} \\ > __\-entry__ \{*\-label "Street number" \-variable dest\_street\_nbr \-type integer \-optional 1*\} \\ > __\-frame__ \{\} \\ > __\-checkbutton__ \{*\-label "Don't use highways" \-variable no\_highway*\}\] This example opens a dialog box that has the title *Itinerary selection*\. A first entry widget in this box allows selecting a report file\. It follows two frames to define respectively an itinerary start and end location\. Each of these locations that are described with a comment has three entry widgets to specify respectively the city, street and the street number\. Bellow the second frame there is a check button that allows specifying if eventual highways should be ignored\. - <a name='2'></a>__tepam::argument\_dialogbox__ \{*item\_name item\_attributes ?item\_name item\_attributes? ?\.\.\.?*\} Sometimes it is simpler to provide all the data entry item definitions in form of a single list to __argument\_dialogbox__, and not as individual arguments\. The second format that is supported by __argument\_dialogbox__ corresponds exactly to the first one, except that all item definitions are packed into a single list that is provided to __argument\_dialogbox__\. The previous example can therefore also be written in the following way: > set DialogResult \[__tepam::argument\_dialogbox \{__ > __\-title__ "Itinerary selection" > __\-file__ \{*\-label "Itinerary report" \-variable report\_file*\} > \.\.\. > __\-checkbutton__ \{*\-label "Don't use highways" \-variable no\_highway*\} __\}__\] The commands __argument\_dialogbox__ as well as __[procedure](\.\./\.\./\.\./\.\./index\.md\#procedure)__ are exported from the namespace __tepam__\. To use these commands without the __tepam::__ namespace prefix, it is sufficient to import them into the main namespace: > __namespace import tepam::\*__ > > set DialogResult \[__argument\_dialogbox__ \\ > \-title "Itinerary selection" > \.\.\. The following subsections explain the different argument item types that are accepted by the __argument\_dialogbox__, classified into three groups\. The first data entry item definition format will be used in the remaining document, knowing that this format can always be transformed into the second format by putting all arguments into a single list that is then provided to __argument\_dialogbox__\. ## <a name='subsection1'></a>Context Definition Items The first item group allows specifying some context aspects of an argument dialog box\. These items are taking a simple character string as item attribute: > tepam::argument\_dialogbox \\ > __\-<argument\_name>__ *string* \\ > \.\.\. The following items are classified into this group: - \-title *string* The dialog box window title which is by default *Dialog* can be changed with the *\-title* item: > tepam::argument\_dialogbox \\ > __\-title__ "System configuration" \\ > \.\.\. - \-window *string* The argument dialog box uses by default *\.dialog* as dialog top level window\. This path can be changed with the *\-window* item: > tepam::argument\_dialogbox \\ > __\-window__ \.dialog \\ > \.\.\. - \-parent *string* By defining a parent window, the argument dialog box will be displayed beside this one\. Without explicit parent window definition, the top\-level window will be considered as parent window\. > tepam::argument\_dialogbox \\ > __\-parent__ \.my\_appl \\ > \.\.\. - \-context *string* If a context is defined the dialog box state, e\.g\. the entered data as well as the window size and position, is restored the next time the argument dialog box is called\. The assignment of a context allows saving the dialog box state in its context to distinguish between different usages of the argument dialog box\. > tepam::argument\_dialogbox \\ > __\-context__ destination\_definitions \\ > \.\.\. ## <a name='subsection2'></a>Formatting and Display Options Especially for big, complex forms it becomes important that the different data entry widgets are graphically well organized and commented to provide an immediate and clear overview to the user\. A couple of items allow structuring and commenting the dialog boxes\. The items of this classification group require as item attributes a definition list, which contains itself attribute name and value pairs: > tepam::argument\_dialogbox \\ > \.\.\. > __\-<argument\_name>__ \{ > *?\-<attribute\_name> <attribute\_value>?* > *?\-<attribute\_name> <attribute\_value>?* > *?\.\.\.?* > > \} > \.\.\. The following items are classified into this group: - \-frame *list* The *\-frame* item allows packing all following entry widgets into a labeled frame, until a next frame item is defined or until the last entry widget has been defined\. It recognizes the following attributes inside the item attribute list: * \-label *string* An optional frame label can be specified with the *\-label* statement\. Example: > tepam::argument\_dialogbox \\ > \.\.\. > __\-frame__ \{*\-label "Destination address"*\} > \.\.\. To close an open frame without opening a new one, an empty list has to be provided to the *\-frame* statement\. > tepam::argument\_dialogbox \\ > \.\.\. > __\-frame__ \{\} > \.\.\. - \-sep \[const \{\{\}\}\] Entry widgets can be separated with the *\-sep* statement which doesn't require additional definitions\. The related definition list has to exist, but its content is ignored\. > tepam::argument\_dialogbox \\ > \.\.\. > __\-sep__ \{\} > \.\.\. - \-comment *string* Comments and descriptions can be added with the *\-text* attribute of the *\-comment* item\. Please note that each entry widget itself can also contain a *\-text* attribute for comments and descriptions\. But the *\-comment* item allows for example adding a description between two frames\. > tepam::argument\_dialogbox \\ > \.\.\. > __\-comment__ \{*\-text "Specify bellow the destination address"*\} > \.\.\. - \-yscroll __0__|__1__|__auto__ This attribute allows controlling an eventual vertical scrollbar\. Setting it to __0__ will permanently disable the scrollbar, setting it to __1__ will enable it\. By default it is set to __auto__\. The scrollbar is enabled in this mode only if the vertical data entry form size exceeds 66% of the screen height\. > tepam::argument\_dialogbox \\ > \.\.\. > __\-yscroll__ __auto__ > \.\.\. ## <a name='subsection3'></a>Global Custom Data Validation This item group allows specifying global custom checks to validate the entered data\. - \-validatecommand *script* Custom data checks can be performed via validation commands that are defined with the *\-validatecommand* item\. Example: > tepam::argument\_dialogbox \\ > \-entry \{\-label "Your comment" \-variable YourCom\} \\ > __\-validatecommand__ \{IllegalWordDetector $YourCom\} The validation command is executed in the context of the calling procedure, once all the basic data checks have been performed and data variables are assigned\. All data is accessed via the data variables\. Note that there is also an entry widget specific attribute *\-validatecommand* that allows declaring custom checks for specific data entries\. |
︙ | ︙ | |||
316 317 318 319 320 321 322 | ## <a name='subsection4'></a>Data Entry Widget Items Data entry widgets are created with the widget items\. These items require as item attributes a definition list, which contains itself attribute name and value pairs: | | | | | | | < < > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | ## <a name='subsection4'></a>Data Entry Widget Items Data entry widgets are created with the widget items\. These items require as item attributes a definition list, which contains itself attribute name and value pairs: > tepam::argument\_dialogbox \\ > \.\.\. > __\-<argument\_name>__ \{ > *?\-<attribute\_name> <attribute\_value>?* > *?\-<attribute\_name> <attribute\_value>?* > *?\.\.\.?* > > \} > \.\.\. The attribute list can contain various attributes to describe and comment an entry widget and to constrain its entered value\. All entry widgets are accepting a common set of attributes that are described in the section [Entry Widget Item Attributes](#subsection5)\. TEPAM defines a rich set of entry widgets\. If necessary, this set can be extended with additional application specific entry widgets \(see [APPLICATION SPECIFIC ENTRY WIDGETS](#section3)\): - \-entry *list* The *\-entry* item generates the simplest but most universal data entry widget\. It allows entering any kind of data in form of single line strings\. > tepam::argument\_dialogbox \\ > __\-entry__ \{\-label Name \-variable Entry\} - \-text *list* The *\-text* item generates a multi line text entry widget\. The widget height can be selected with the *\-height* attribute\. > tepam::argument\_dialogbox \\ > __\-text__ \{\-label Name \-variable Text \-height 5\} - \-checkbox *list* A group of check boxes is created with the *\-checkbox* item\. The number of check boxes and their option values are specified with a list assigned to the *\-choices* attribute or via a variable declared with the *\-choicevariable* attribute: > tepam::argument\_dialogbox \\ > __\-checkbox__ \{\-label "Font sytle" \-variable FontStyle \\ > \-choices \{bold italic underline\} \-default italic\} If the labels of the check boxes should differ from the option values, their labels can be defined with the *\-choicelabels* attribute: > tepam::argument\_dialogbox \\ > __\-checkbox__ \{\-label "Font sytle" \-variable FontStyle \\ > \-choices \{bold italic underline\} \\ > \-choicelabels \{Bold Italic Underline\} \\ > \-default italic\} In contrast to a radio box group, a check box group allows selecting simultaneously several choice options\. The selection is stored for this reason inside the defined variable in form of a list, even if only one choice option has been selected\. - \-radiobox *list* A group of radio boxes is created with the *\-radiobox* item\. The number of radio boxes and their option values are specified with a list assigned to the *\-choices* attribute or via a variable declared with the *\-choicevariable* attribute\. In contrast to a check box group, a radio box group allows selecting simultaneously only one choice option\. The selected option value is stored directly, and not in form of a list, inside the defined variable\. > tepam::argument\_dialogbox \\ > __\-radiobox__ \{\-label "Text adjustment" \-variable Adjustment \\ > \-choices \{left center right\} \-default left\} If the labels of the radio boxes should differ from the option values, their labels can be defined with the *\-choicelabels* attribute: > tepam::argument\_dialogbox \\ > __\-radiobox__ \{\-label "Text adjustment" \-variable Adjustment \\ > \-choices \{left center right\} \\ > \-choicelabels \{Left Center Right\} \-default left\} - \-checkbutton *list* The *\-checkbutton* entry widget allows activating or deactivating a single choice option\. The result written into the variable will either be __0__ if the check button was not activated or __1__ if it was activated\. An eventually provided default value has also to be either __0__ or __1__\. > tepam::argument\_dialogbox \\ > __\-checkbutton__ \{\-label Capitalize \-variable Capitalize \-default 1\} Several types of list and combo boxes are available to handle selection lists\. - \-combobox *list* The combobox is a combination of a normal entry widget together with a drop\-down list box\. The combobox allows selecting from this drop\-down list box a single element\. The list of the available elements can be provided either as a list to the *\-choices* attribute, or via a variable that is specified with the *\-choicevariable* attribute\. > tepam::argument\_dialogbox \\ > __\-combobox__ \{\-label "Text size" \-variable Size \-choices \{8 9 10 12 15 18\} \-default 12\} And here is an example of using a variable to define the selection list: > set TextSizes \{8 9 10 12 15 18\} > tepam::argument\_dialogbox \\ > __\-combobox__ \{\-label "Text size" \-variable Size \-choicevariable TextSizes \-default 12\} - \-listbox *list* In contrast to the combo box, the list box is always displayed by the *listbox* entry widget\. Only one element is selectable unless the *\-multiple\_selection* attribute is set\. The list box height can be selected with the *\-height* attribute\. If the height is not explicitly defined, the list box height is automatically adapted to the argument dialog box size\. The first example uses a variable to define the available choices: > set set AvailableSizes > for \{set k 0\} \{$k<16\} \{incr k\} \{lappend AvailableSizes \[expr 1<<$k\]\} > > tepam::argument\_dialogbox \\ > __\-listbox__ \{\-label "Distance" \-variable Distance \\ > \-choicevariable AvailableSizes \-default 6 \-height 5\} Here is a multi\-element selection example\. Please note that also the default selection can contain multiple elements: > tepam::argument\_dialogbox \\ > __\-listbox__ \{\-label "Text styles" \-variable Styles \\ > \-choices \{bold italic underline overstrike\} \\ > \-choicelabels \{Bold Italic Underline Overstrike\} \\ > \-default \{bold underline\} \-multiple\_selection 1 \\ > \-height 3\} - \-disjointlistbox *list* A disjoint list box has to be used instead of a normal list box if the selection order is important\. The disjoint list box entry widget has in fact two list boxes, one to select elements and one to display the selected elements in the chosen order\. Disjoint listboxes allow always selecting multiple elements\. With the exception of the *\-multiple\_selection* attribute, disjointed list boxes are accepting the same attributes as the normal listbox, e\.g\. *\-height, \-choices, \-choicevariable, \-default*\. > tepam::argument\_dialogbox \\ > __\-disjointlistbox__ \{\-label "Preferred scripting languages" \-variable Languages \\ > \-comment "Please select your preferred languages in the order" \\ > \-choices \{JavaScript Lisp Lua Octave PHP Perl Python Ruby Scheme Tcl\} \\ > \-default \{Tcl Perl Python\}\} The file and directory selectors are building a next group of data entry widgets\. A paragraph of section [Entry Widget Item Attributes](#subsection5) explains the widget specific attributes that allow specifying the targeted file types, active directory etc\. - \-file *list* The item *\-file* creates a group composed by an entry widget together with a button that allows opening a file browser\. The data type *file* is automatically selected for this entry if no data type has been explicitly defined with the *\-type* attribute\. > tepam::argument\_dialogbox \\ > __\-file__ \{\-label "Image file" \-variable ImageF \\ > \-filetypes \{\{"GIF" \{\*\.gif\}\} \{"JPG" \{\*\.jpg\}\}\} \\ > \-initialfile "picture\.gif"\} - \-existingfile *list* The item *\-existingfile* creates a group composed by an entry widget together with a button that allows opening a browser to select an existing file\. The data type *existingfile* is automatically selected for this entry if no data type has been explicitly defined with the *\-type* attribute\. > tepam::argument\_dialogbox \\ > __\-existingfile__ \{\-label "Image file" \-variable ImageF \\ > \-filetypes \{\{"GIF" \{\*\.gif\}\} \{"JPG" \{\*\.jpg\}\}\} \\ > \-initialfile "picture\.gif"\} - \-directory *list* The item *\-directory* creates a group composed by an entry widget together with a button that allows opening a directory browser\. The data type *directory* is automatically selected for this entry if no data type has been explicitly defined with the *\-type* attribute\. > tepam::argument\_dialogbox \\ > __\-directory__ \{\-label "Report directory" \-variable ReportDir\} - \-existingdirectory *list* The item *\-existingdirectory* creates a group composed by an entry widget together with a button that allows opening a browser to select an existing directory\. The data type *existingdirectory* is automatically selected for this entry if no data type has been explicitly defined with the *\-type* attribute\. > tepam::argument\_dialogbox \\ > __\-existingdirectory__ \{\-label "Report directory" \-variable ReportDir\} Finally, there is a last group of some other special data entry widgets\. - \-color *list* The color selector is composed by an entry widget together with a button that allows opening a color browser\. The data type *color* is automatically selected for this entry widget type if no data type has been explicitly defined with the *\-type* attribute\. > tepam::argument\_dialogbox \\ > __\-color__ \{\-label "Background color" \-variable Color \-default red\} - \-font *list* The font selector is composed by an entry widget together with a button that allows opening a font browser\. The data type *font* is automatically selected for this entry widget type if no data type has been explicitly defined with the *\-type* attribute\. The entry widget displays an example |
︙ | ︙ | |||
556 557 558 559 560 561 562 | If no default font is provided via the *\-default* attribute, the default font of the label widget to display the selected font will be used as default selected font\. If the font family of this label widget is not part of the available families the first available family is used as default\. If the font size of this label widget is not part of the available sizes the next close available size is selected as default size\. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | < < > > | 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 | If no default font is provided via the *\-default* attribute, the default font of the label widget to display the selected font will be used as default selected font\. If the font family of this label widget is not part of the available families the first available family is used as default\. If the font size of this label widget is not part of the available sizes the next close available size is selected as default size\. > tepam::argument\_dialogbox \\ > __\-font__ \{\-label "Font" \-variable Font \\ > \-font\_sizes \{8 10 12 16\} \\ > \-default \{Arial 20 italic\}\} ## <a name='subsection5'></a>Entry Widget Item Attributes All the entry widget items are accepting the following attributes: - \-text *string* Eventual descriptions and comments specified with the *\-text* attribute are displayed above the entry widget\. > tepam::argument\_dialogbox \\ > \-entry \{__\-text "Please enter your name bellow"__ \-variable Name\} - \-label *string* The label attribute creates left to the entry widget a label using the provided string as label text: > tepam::argument\_dialogbox \\ > \-entry \{__\-label Name__ \-variable Name\} - \-variable *string* All entry widgets require a specified variable\. After accepting the entered information with the OK button, the entry widget data is stored inside the defined variables\. > tepam::argument\_dialogbox \\ > \-existingdirectory \{\-label "Report directory" __\-variable ReportDir__\} - \-default *string* Eventual default data for the entry widgets can be provided via the *\-default* attribute\. The default value is overridden if an argument dialog box with a defined context is called another time\. The value acknowledged in a previous call will be used in this case as default value\. > tepam::argument\_dialogbox \\ > \-checkbox \{\-label "Font sytle" \-variable FontStyle \\ > \-choices \{bold italic underline\} __\-default italic__\} - \-optional __0__|__1__ Data can be specified as optional or mandatory with the *\-optional* attribute that requires either __0__ \(mandatory\) or __1__ \(optional\) as attribute data\. In case an entry is optional and no data has been entered, e\.g\. the entry contains an empty character string, the entry will be considered as undefined and the assigned variable will not be defined\. > tepam::argument\_dialogbox \\ > \-entry \{\-label "City" \-variable start\_city \-type string\} \\ > \-entry \{\-label "Street" \-variable start\_street \-type string __\-optional 0__\} \\ > \-entry \{\-label "Street number" \-variable start\_street\_nbr \-type integer __\-optional 1__\} \\ - \-type *string* If the data type is defined with the *\-type* attribute the argument dialog box will automatically perform a data type check after acknowledging the entered values and before the dialog box is closed\. If a type incompatible value is found an error message box appears and the user can correct the value\. The argument dialog box accepts all types that have been specified by the TEPAM package and that are also used by __[tepam::procedure](tepam\_procedure\.md)__ \(see the *tepam::procedure reference manual*\)\. Some entry widgets like the file and directory widgets, as well as the color and font widgets are specifying automatically the default data type if no type has been specified explicitly with the *\-type* attribute\. > tepam::argument\_dialogbox \\ > __\-entry__ \{\-label "Street number" \-variable start\_street\_nbr __\-type integer__\} \\ - \-range *string* Values can be constrained with the *\-range* attribute\. The valid range is defined with a list containing the minimum valid value and a maximum valid value\. The *\-range* attribute has to be used only for numerical arguments, like integers and doubles\. > tepam::argument\_dialogbox \\ > \-entry \{\-label Month \-variable Month \-type integer __\-range \{1 12\}__\} - \-validatecommand *string* Custom argument value validations can be performed via specific validation commands that are defined with the *\-validatecommand* attribute\. The provided validation command can be a complete script in which the pattern *%P* is placeholder for the argument value that has to be validated\. > tepam::argument\_dialogbox \\ > \-entry \{\-label "Your comment" \-variable YourCom \\ > __\-validatecommand__ "IllegalWordDetector %P"\} While the purpose of this custom argument validation attribute is the validation of a specific argument, there is also a global data validation attribute *\-validatecommand* that allows performing validation that involves multiple arguments\. - \-validatecommand\_error\_text *string* This attribute allows overriding the default error message for a custom argument validation \(defined by *\-validatecommand*\)\. Some other attributes are supported by the list and combo boxes as well as by the radio and check buttons\. - \-choices *string* Choice lists can directly be defined with the *\-choices* attribute\. This way to define choice lists is especially adapted for smaller, fixed selection lists\. > tepam::argument\_dialogbox \\ > \-listbox \{\-label "Text styles" \-variable Styles \\ > __\-choices \{bold italic underline\}__ \-default underline - \-choicelabels *string* *\(only check and radio buttons\)* If the labels of the check and radio boxes should differ from the option values, they can be defined with the *\-choicelabels* attribute: > tepam::argument\_dialogbox \\ > \-checkbox \{\-label "Font sytle" \-variable FontStyle \\ > \-choices \{bold italic underline\} \\ > __\-choicelabels \{Bold Italic Underline\}__ - \-choicevariable *string* Another way to define the choice lists is using the *\-choicevariable* attribute\. This way to define choice lists is especially adapted for huge and eventually variable selection lists\. > set TextSizes \{8 9 10 12 15 18\} > tepam::argument\_dialogbox \\ > \-combobox \{\-label "Text size" \-variable Size __\-choicevariable TextSizes__\} - \-multiple\_selection __0__|__1__ The list box item \(__\-listbox__\) allows by default selecting only one list element\. By setting the *\-multiple\_selection* attribute to __1__, multiple elements can be selected\. > tepam::argument\_dialogbox \\ > \-listbox \{\-label "Text styles" \-variable Styles \\ > \-choices \{bold italic underline\} \-default underline \\ > __\-multiple\_selection 1__ \-height 3\} Some additional attributes are supported by the file and directory selection widgets\. - \-filetypes *string* The file type attribute is used by the __\-file__ and __\-existingfile__ items to define the file endings that are searched by the file browser\. > tepam::argument\_dialogbox \\ > \-file \{\-label "Image file" \-variable ImageF \\ > __\-filetypes \{\{"GIF" \{\*\.gif\}\} \{"JPG" \{\*\.jpg\}\}\}__\} - \-initialfile *string* The initial file used by the file browsers of the __\-file__ and __\-existingfile__ widgets are by default the file defined with the *\-default* attribute, unless a file is specified with the *\-initialfile* attribute\. > tepam::argument\_dialogbox \\ > \-file \{\-variable ImageF __\-initialfile "picture\.gif"__\} - \-activedir *string* The *\-activedir* attribute will override the default active search directory used by the file browsers of all file and directory entry widgets\. The default active search directory is defined by the directory of a specified initial file \(*\-initialfile*\) if defined, and otherwise by the directory of the default file/directory, specified with the *\-default* attribute\. > tepam::argument\_dialogbox \\ > \-file "\-variable ImageF __\-activedir $pwd__" Finally, there is a last attribute supported by some widgets: - \-height *string* All widgets containing a selection list \(__\-listbox__, __\-disjointlistbox__, __\-font__\) as well as the multi line __\-text__ widget are accepting the *\-height* attribute that defines the number of displayed rows of the selection lists\. > tepam::argument\_dialogbox \\ > \-listbox \{\-label "Text size" \-variable Size \\ > \-choices \{8 9 10 12 15 18\} \-default 12 __\-height 3__\} If the no height has been explicitly specified the height of the widget will be dynamically adapted to the argument dialog box size\. # <a name='section3'></a>APPLICATION SPECIFIC ENTRY WIDGETS An application specific entry widget can be made available to the argument dialog box by adding a dedicated procedure to the __tepam__ namespace\. This procedure has three arguments; the first one is the widget path, the second one a subcommand and the third argument has various purposes: > *proc* tepam::ad\_form\(<WidgetName>\) \{W Command \{Par ""\}\} \{ > *upvar Option Option; \# if required* > *variable argument\_dialogbox; \# if required* > switch $Command \{ > "create" <CreateCommandSequence> > "set\_choice" <SetChoiceCommandSequence> > "set" <SetCommandv> > "get" <GetCommandSequence> > \} > \} __Argument\_dialogbox__ takes care about the *\-label* and *\-text* attributes for all entry widgets\. For any data entry widget it creates a frame into which the data entry widget components can be placed\. The path to this frame is provided via the *W* argument\. The entry widget procedure has to support 3 mandatory and an optional command |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/tepam/tepam_doc_gen.md.
︙ | ︙ | |||
240 241 242 243 244 245 246 | Support for a new document format can be added by defining in the __tepam::doc\_gen__ namespace a set of procedures that generate the different document components\. The following documentation listing contains tokens that refer to the different document generation procedures: | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | Support for a new document format can be added by defining in the __tepam::doc\_gen__ namespace a set of procedures that generate the different document components\. The following documentation listing contains tokens that refer to the different document generation procedures: > *<01>* > *<03> <20s>* NAME*<20e>* > *<30s>* message\_box \- Displays text in a message box*<30e>* > *<20s>* SYNOPSYS*<20e>* > *<40s>* message\_box \[\-mtype <mtype>\] <text>*<40e>* > *<20s>* DESCRIPTION*<20e>* > *<21s> message\_box<21e>* > *<54s> message\_box \[\-mtype <mtype>\] <text><54e>* > *<50s>* This procedure allows displaying a text in an message box\. The following > ** message types are supported:*<50e>* > *<51> <53s>* \* Info*<53e>* > *<53s>* \* Warning*<53e>* > *<53s>* \* Error*<53e>* *<52>* > *<50s>* If the text parameter is use multiple times the different texts are > ** concatenated to create the message text\.*<50e>* > *<20s>* ARGUMENTS*<20e>* > *<60> <62s>* \[\-mtype <mtype>\]*<62e>* > *<63> <65s>* Message type*<65e>* > *<66s>* Default: "Warning"*<66e>* > *<66s>* Multiple: yes*<66e>* > *<66s>* Choices: Info, Warning, Error*<66e>* *<64>* > *<62s>* <text>*<62e>* > *<63> <65s>* One or multiple text lines to display*<65e>* > *<66s>* Type: string*<66e>* > *<66s>* Multiple: yes*<66e>* *<64><61>* > *<20s>* EXAMPLE*<20e>* > *<70> <72s>* message\_box "Please save first the document"*<72e>* > *<73s>* \-> 1*<73e>* *<71><04>* > *<02>* There are 2 types of document generation procedures: - Content generation procedures \(e\.g\. <40s>\.\.\.<40e>\) These procedures generate some document content based on the text that is provided as procedure argument\. The listing above shows two tokens for these |
︙ | ︙ | |||
428 429 430 431 432 433 434 | * *IsOptional* If true \(=__1__\) the argument is optional which should be indicated by the generated string \(for example by putting the argument into brackets \{\[\]\} or into question marks '?'\): | | < < | | < < | < < | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | < > | | | > | | | 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 | * *IsOptional* If true \(=__1__\) the argument is optional which should be indicated by the generated string \(for example by putting the argument into brackets \{\[\]\} or into question marks '?'\): > gen\(TXT,ArgumentString\) mtype 1 0 string \-> *"\[mtype\]"* * *IsNamed* If true \(=__1__\) an argument is a named argument \(option\)\. The generated string should in this case contain the argument/option name, followed by the argument itself: > gen\(TXT,ArgumentString\) mtype 0 1 string \-> *"\-mtype <mtype>"* Named arguments can also be optional: > gen\(TXT,ArgumentString\) mtype 1 1 string \-> *"\[\-mtype <mtype>\]"* * *Type* Indicates the type of the argument\. If the type is set to __none__ the argument is a flag, which needs to be indicated by the generated string\. Example: > gen\(TXT,ArgumentString\) close 1 1 none \-> *"\[\-close\]"* # <a name='section5'></a>EXAMPLES ## <a name='subsection5'></a>tepam::doc\_gen::generate The __TEPAM Doc Gen__ package can be explored by generating the documentation of the command __tepam::doc\_gen::generate__\. The following example generates the document in text format \(default format\): > __tepam::doc\_gen::generate__ tepam::doc\_gen::generate The next example generates the documentation in HTML format: > __tepam::doc\_gen::generate__ \-format HTML tepam::doc\_gen::generate The flag ?header\_footer? adds also the file header and footer: > __tepam::doc\_gen::generate__ \-format HTML \-header\_footer tepam::doc\_gen::generate The documentation can directly be stored in a file\. The file header and footer are automatically generated in this way: > __tepam::doc\_gen::generate__ \-format HTML \-dest\_file doc\_gen\.html tepam::doc\_gen::generate The generated HTML file refers a CSS stylesheet file \(default: tepam\_doc\_stylesheet\.css\)\. To display the HTML file correctly this CSS stylesheet file needs to be copied into the directory of the generated HTML file\. The Tcl DOC Tools format can be used as intermediate format to generate other formats, for example HTML: > *\# Generate the documentation in Tcl Doc Tool format* > set dt \[__tepam::doc\_gen::generate__ \-format DT \-header\_footer tepam::doc\_gen::generate\] > ** > *\# Create a new doc tools object \(HTML format\)* > package require doctools > ::doctools::new myDoc \-format html > ** > *\# Open the HTML file, and write the HTML formatted documentation* > set fHtml \[open doc\_gen\.dt\.html w\] > puts $fHtml \[myDoc format $dt\] > close $fHtml ## <a name='subsection6'></a>tepam::doc\_gen::patch While __generate__ provides a limited number of possibilities to vary the document structure, __[patch](\.\./\.\./\.\./\.\./index\.md\#patch)__ offers more flexibility\. Multiple documentations for different procedures and meta information can for example be added\. The following listing shows how the __[patch](\.\./\.\./\.\./\.\./index\.md\#patch)__ command works\. It defines first a HTML master document string that contains 2 procedure documentation placeholders \(*\{\*<ProcedureName>\*\}*\)\. There placeholders are replaced by __[patch](\.\./\.\./\.\./\.\./index\.md\#patch)__ with the generated documentation of the referred procedures\. Since nonstandard placeholders are used, __[patch](\.\./\.\./\.\./\.\./index\.md\#patch)__ is called with an explicit placeholder pattern definition \(argument *search\_pattern*\)\. > *\# Define the HTML master document* > set HtmlMasterDoc \{\\ > <html> > <head> > <title>tepam::doc\_gen</title> > <link rel="stylesheet" href="tepam\_doc\_stylesheet\.css"> > <meta content="documentation" name="keywords"></meta> > </head> > <body> > <h1>tepam::doc\_gen</h1> > <h2>Generate</h2> > __\{\*tepam::doc\_gen::generate\*\}__ > <h2>Patch</h2> > __\{\*tepam::doc\_gen::patch\*\}__ > </body> > <html>\\ > \} > ** > *\# Patch the master document: This will replace the placeholders by the * > *\# procedure documentation divisions:* > > __tepam::doc\_gen::patch__ \-format HTML \-search\_pattern \{\\\{\\\*\(\.\*?\)\\\*\\\}\} \\ > \-src\_string $HtmlMasterDoc \-dest\_file tepam\_doc\_gen\.html # <a name='seealso'></a>SEE ALSO [tepam\(n\)](tepam\_introduction\.md), [tepam::procedure\(n\)](tepam\_procedure\.md) # <a name='keywords'></a>KEYWORDS |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/tepam/tepam_introduction.md.
︙ | ︙ | |||
130 131 132 133 134 135 136 | takes as __[proc](\.\./\.\./\.\./\.\./index\.md\#proc)__ also 3 arguments: The procedure name, the procedure header and the procedure body\. The following example declares the subcommand __[message](\.\./\.\./\.\./\.\./index\.md\#message)__ of the procedure __display__\. This command has several named and unnamed arguments: | | | | | | | | | | | | | | < > | | | | | | | < > | 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 | takes as __[proc](\.\./\.\./\.\./\.\./index\.md\#proc)__ also 3 arguments: The procedure name, the procedure header and the procedure body\. The following example declares the subcommand __[message](\.\./\.\./\.\./\.\./index\.md\#message)__ of the procedure __display__\. This command has several named and unnamed arguments: > __[tepam::procedure](tepam\_procedure\.md)__ \{display message\} \{ > \-return \- > \-short\_description "Displays a simple message box" > \-description "This procedure allows displaying a configurable message box\." > \-args \{ > \{\-mtype \-default Warning \-choices \{Info Warning Error\} \-description "Message type"\} > \{\-font \-type font \-default \{Arial 10 italic\} \-description "Message text font"\} > \{\-level \-type integer \-optional \-range \{1 10\} \-description "Message level"\} > \{\-fg \-type color \-default black \-description "Message color"\} > \{\-bg \-type color \-optional \-description "Background color"\} > \{\-no\_border \-type none \-description "Use a splash window style \(no border\)"\} > \{\-log\_file \-type file \-optional \-description "Optional message log file"\} > \{text \-type string \-multiple \-description "Multiple text lines to display"\} > \} > \} \{ > *puts "display message:"* > *foreach var \{mtype font level fg bg no\_border log\_file text\} \{* > *if \{\[info exists $var\]\} \{* > *puts " $var=\[set $var\]"* > *\}* > *\}* > \} A call of procedure that has been declared in this way will first invoke the TEPAM argument manager, before the procedure body is executed\. The argument manager parses the provided arguments, validates them, completes them eventually with some default values, and makes them finally available to the procedure body as local variables\. In case an argument is missing or has a wrong type, the argument manager generates an error message that explains the reason for the |
︙ | ︙ | |||
201 202 203 204 205 206 207 | the named arguments \(Tk style\)\. # <a name='section4'></a>PROCEDURE HELP The declared procedure can simply be called with the *\-help* option to get the information about the usage of the procedure and its arguments: | | | > | > > > | > | > | > | > > > | > | > > | | | | | | | | | | > | | | | | | | | | > | | | | | | | | > | | | > | > > > | > | > < | | > < | | | > < | | > < | | < | | | 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 | the named arguments \(Tk style\)\. # <a name='section4'></a>PROCEDURE HELP The declared procedure can simply be called with the *\-help* option to get the information about the usage of the procedure and its arguments: > __display message__ \-help > *\->* > *NAME* > *display message \- Displays a simple message box* > *SYNOPSYS* > *display message* > *\[\-mtype <mtype>\] :* > *Message type, default: "Warning", choices: \{Info Warning Error\}* > *\[\-font <font>\] :* > *Message text font, type: font, default: Arial 10 italic* > *\[\-level <level>\] :* > *Message level, type: integer, range: 1\.\.10* > *\[\-fg <fg>\] :* > *Message color, type: color, default: black* > *\[\-bg <bg>\] :* > *Background color, type: color* > *\[\-no\_border \] :* > *Use a splash window style \(no border\)* > *\[\-log\_file <log\_file>\] :* > *Optional message log file, type: file* > *<text> :* > *Multiple text lines to display, type: string* > *DESCRIPTION* > *This procedure allows displaying a configurable message box\.* # <a name='section5'></a>PROCEDURE CALL The specified procedure can be called in many ways\. The following listing shows some valid procedure calls: > __display message__ "The document hasn't yet been saved\!" > *\-> display message:* > *mtype=Warning* > *font=Arial 10 italic* > *fg=black* > *no\_border=0* > *text=\{The document hasn't yet been saved\!\}* > > > __display message__ \-fg red \-bg black "Please save first the document" > *\-> display message:* > *mtype=Warning* > *font=Arial 10 italic* > *fg=red* > *bg=black* > *no\_border=0* > *text=\{Please save first the document\}* > > > __display message__ \-mtype Error \-no\_border "Why is here no border?" > *\-> display message:* > *mtype=Error* > *font=Arial 10 italic* > *fg=black* > *no\_border=1* > *text=\{Why is here no border?\}* > > > __display message__ \-font \{Courier 12\} \-level 10 \\ > "Is there enough space?" "Reduce otherwise the font size\!" > *\-> display message:* > *mtype=Warning* > *font=Courier 12* > *level=10* > *fg=black* > *no\_border=0* > *text=\{Is there enough space?\} \{Reduce otherwise the font size\!\}* The next lines show how wrong arguments are recognized\. The *text* argument that is mandatory is missing in the first procedure call: > __display message__ \-font \{Courier 12\} > *\-> display message: Required argument is missing: text* Only known arguments are accepted: > __display message__ \-category warning Hello > *\-> display message: Argument '\-category' not known* Argument types are automatically checked and an error message is generated in case the argument value has not the expected type: > __display message__ \-fg MyColor "Hello" > *\-> display message: Argument 'fg' requires type 'color'\. Provided value: 'MyColor'* Selection choices have to be respected \.\.\. > __display message__ \-mtype Fatal Hello > *\-> display message: Argument \(mtype\) has to be one of the following elements: Info, Warning, Error* \.\.\. as well as valid value ranges: > __display message__ \-level 12 Hello > *\-> display message: Argument \(level\) has to be between 1 and 10* # <a name='section6'></a>INTERACTIVE PROCEDURE CALLS The most intuitive way to call the procedure is using an form that allows specifying all arguments interactively\. This form will automatically be generated if the declared procedure is called with the *\-interactive* flag\. To use this feature the Tk library has to be loaded\. > __display message__ \-interactive The generated form contains for each argument a data entry widget that is adapted to the argument type\. Check buttons are used to specify flags, radio boxes for tiny choice lists, disjoint list boxes for larger choice lists and files, directories, fonts and colors can be selected with dedicated browsers\. After acknowledging the specified argument data via an OK button, the entered |
︙ | ︙ | |||
314 315 316 317 318 319 320 | entry forms\. It creates an input mask that allows specifying a file to copy, a destination folder as well as a checkbox that allows specifying if an eventual existing file can be overwritten\. Comfortable browsers can be used to select files and directories\. And finally, the form offers also the possibility to accept and decline the selection\. Here is the code snippet that is doing all this: | | | | | | 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | entry forms\. It creates an input mask that allows specifying a file to copy, a destination folder as well as a checkbox that allows specifying if an eventual existing file can be overwritten\. Comfortable browsers can be used to select files and directories\. And finally, the form offers also the possibility to accept and decline the selection\. Here is the code snippet that is doing all this: > __[tepam::argument\_dialogbox](tepam\_argument\_dialogbox\.md)__ \\ > __\-existingfile__ \{\-label "Source file" \-variable SourceFile\} \\ > __\-existingdirectory__ \{\-label "Destination folder" \-variable DestDir\} \\ > __\-checkbutton__ \{\-label "Overwrite existing file" \-variable Overwrite\} The __argument\_dialogbox__ returns __ok__ if the entered data are validated\. It will return __cancel__ if the data entry has been canceled\. After the validation of the entered data, the __argument\_dialogbox__ defines all the specified variables with the entered data inside the calling context\. An __argument\_dialogbox__ requires a pair of arguments for each variable |
︙ | ︙ | |||
346 347 348 349 350 351 352 | expected data types, valid data ranges, etc\. The next example of a more complex argument dialog box provides a good overview about the different available entry widget types and parameter attributes\. The example contains also some formatting instructions like *\-frame* and *\-sep* which allows organizing the different entry widgets in frames and sections: | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | < < | > > | > > > | > > | > > | > | > | | 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 | expected data types, valid data ranges, etc\. The next example of a more complex argument dialog box provides a good overview about the different available entry widget types and parameter attributes\. The example contains also some formatting instructions like *\-frame* and *\-sep* which allows organizing the different entry widgets in frames and sections: > set ChoiceList \{"Choice 1" "Choice 2" "Choice 3" "Choice 4" "Choice 5" "Choice 6"\} > > set Result \[__[tepam::argument\_dialogbox](tepam\_argument\_dialogbox\.md)__ \\ > __\-title__ "System configuration" \\ > __\-context__ test\_1 \\ > __\-frame__ \{\-label "Entries"\} \\ > __\-entry__ \{\-label Entry1 \-variable Entry1\} \\ > __\-entry__ \{\-label Entry2 \-variable Entry2 \-default "my default"\} \\ > __\-frame__ \{\-label "Listbox & combobox"\} \\ > __\-listbox__ \{\-label "Listbox, single selection" \-variable Listbox1 \\ > \-choices \{1 2 3 4 5 6 7 8\} \-default 1 \-height 3\} \\ > __\-listbox__ \{\-label "Listbox, multiple selection" \-variable Listbox2 > \-choicevariable ChoiceList \-default \{"Choice 2" "Choice 3"\} > \-multiple\_selection 1 \-height 3\} \\ > __\-disjointlistbox__ \{\-label "Disjoined listbox" \-variable DisJntListbox > \-choicevariable ChoiceList \\ > \-default \{"Choice 3" "Choice 5"\} \-height 3\} \\ > __\-combobox__ \{\-label "Combobox" \-variable Combobox \\ > \-choices \{1 2 3 4 5 6 7 8\} \-default 3\} \\ > __\-frame__ \{\-label "Checkbox, radiobox and checkbutton"\} \\ > __\-checkbox__ \{\-label Checkbox \-variable Checkbox > \-choices \{bold italic underline\} \-choicelabels \{Bold Italic Underline\} \\ > \-default italic\} \\ > __\-radiobox__ \{\-label Radiobox \-variable Radiobox > \-choices \{bold italic underline\} \-choicelabels \{Bold Italic Underline\} \\ > \-default underline\} \\ > __\-checkbutton__ \{\-label CheckButton \-variable Checkbutton \-default 1\} \\ > __\-frame__ \{\-label "Files & directories"\} \\ > __\-existingfile__ \{\-label "Input file" \-variable InputFile\} \\ > __\-file__ \{\-label "Output file" \-variable OutputFile\} \\ > __\-sep__ \{\} \\ > __\-existingdirectory__ \{\-label "Input directory" \-variable InputDirectory\} \\ > __\-directory__ \{\-label "Output irectory" \-variable OutputDirectory\} \\ > __\-frame__ \{\-label "Colors and fonts"\} \\ > __\-color__ \{\-label "Background color" \-variable Color \-default red\} \\ > __\-sep__ \{\} \\ > __\-font__ \{\-label "Font" \-variable Font \-default \{Courier 12 italic\}\}\] The __argument\_dialogbox__ defines all the specified variables with the entered data and returns __ok__ if the data have been validated via the Ok button\. If the data entry is cancelled by activating the Cancel button, the __argument\_dialogbox__ returns __cancel__\. > if \{$Result=="cancel"\} \{ > puts "Canceled" > \} else \{ \# $Result=="ok" > puts "Arguments: " > foreach Var \{ > Entry1 Entry2 > Listbox1 Listbox2 DisJntListbox > Combobox Checkbox Radiobox Checkbutton > InputFile OutputFile InputDirectory OutputDirectory > Color Font > \} \{ > puts " $Var: '\[set $Var\]'" > \} > \} > *\-> Arguments:* > *Entry1: 'Hello, this is a trial'* > *Entry2: 'my default'* > *Listbox1: '1'* > *Listbox2: '\{Choice 2\} \{Choice 3\}'* > *DisJntListbox: '\{Choice 3\} \{Choice 5\}'* > *Combobox: '3'* > *Checkbox: 'italic'* > *Radiobox: 'underline'* > *Checkbutton: '1'* > *InputFile: 'c:\\tepam\\in\.txt'* > *OutputFile: 'c:\\tepam\\out\.txt'* > *InputDirectory: 'c:\\tepam\\input'* > *OutputDirectory: 'c:\\tepam\\output'* > *Color: 'red'* > *Font: 'Courier 12 italic'* # <a name='seealso'></a>SEE ALSO [tepam::argument\_dialogbox\(n\)](tepam\_argument\_dialogbox\.md), [tepam::procedure\(n\)](tepam\_procedure\.md) # <a name='keywords'></a>KEYWORDS |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/tepam/tepam_procedure.md.
︙ | ︙ | |||
106 107 108 109 110 111 112 | commands are incorporated into a single main command and are selectable via the first argument\. The __string__ command is an example of such a command that implements for example subcommands to check a character string length, to compare strings, to extract substrings, etc: | | | | | | | | | | < | | 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 | commands are incorporated into a single main command and are selectable via the first argument\. The __string__ command is an example of such a command that implements for example subcommands to check a character string length, to compare strings, to extract substrings, etc: > __string length__ *string* > __string compare__ *string* *string* > __string range__ *string* *first* *last* > \.\.\. TEPAM provides a framework that allows implementing easily such subcommands in form of Tcl procedures\. It allows not only defining a first level of subcommands, but also a higher level of subcommands\. The __string__ command class check could be implemented as independent sub\-sub\-commands of the __string__ command: > __string is alnum__ *string* > __string is integer__ *string* > __string is double__ *string* > \.\.\. - *Procedure attribute* TEPAM allows attaching to a declared procedure different kind of attributes\. Some of these attributes are *just* used for documentation purposes, but other attributes specify the way how the procedure has to be called\. Also the procedure arguments are defined in form of a procedure attribute\. - *Argument* TEPAM uses the term *argument* for the parameters of a procedure\. The following example calls the subcommand __string compare__ with several arguments: > __string compare__ *\-nocase \-length 3 "emphasized" "emphasised"* The following paragraphs discuss these different argument types\. - *Named argument* Some parameters, as *\-length 3* of the subcommand __string compare__ have to be provided as pairs of argument names and argument values\. This parameter type is often also called *option*\. |
︙ | ︙ | |||
181 182 183 184 185 186 187 | - *Named arguments first, unnamed arguments later* The __string compare__ command of the previous example requires that the *named arguments* \(options, flags\) are provided first\. The two mandatory \(unnamed\) arguments have to be provided as last argument\. | | | | | | | | < | | | | | | | | | | | | | | | | < > | | | < > | | | | | | | | | | | | 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 | - *Named arguments first, unnamed arguments later* The __string compare__ command of the previous example requires that the *named arguments* \(options, flags\) are provided first\. The two mandatory \(unnamed\) arguments have to be provided as last argument\. > __string compare__ *\-nocase \-length 3 Water $Text* This is the usual Tcl style \(exceptions exist\) which is referred in the TEPAM documentation as *named arguments first, unnamed arguments later style*\. - *Unnamed arguments first, named arguments later* In contrast to most Tcl commands, Tk uses generally \(exceptions exist also here\) a different calling style where the *unnamed arguments* have to be provided first, before the *named arguments* have to be provided: > __pack__ *\.ent1 \.ent2 \-fill x \-expand yes \-side left* This style is referred in the TEPAM documentation as *unnamed arguments first, named arguments later style*\. # <a name='section3'></a>PROCEDURE DECLARATION TEPAM allows declaring new Tcl procedures with the command __tepam::procedure__ that has similar to the standard Tcl command __proc__ also 3 arguments: - <a name='1'></a>__tepam::procedure__ *name* *attributes* *body* The TEPAM procedure declaration syntax is demonstrated by the following example: > __tepam::procedure__ \{display message\} \{ > \-short\_description > "Displays a simple message box" > \-description > "This procedure allows displaying a configurable\\ > message box\. The default message type that is\\ > created is a warning, but also errors and info can\\ > be generated\. > The procedure accepts multiple text lines\." > \-example > \{display message \-mtype Warning "Save first your job"\} > \-args \{ > \{\-mtype \-choices \{Info Warning Error\} \\ > \-default Warning \-description "Message type"\} > \{text \-type string \-multiple \\ > \-description "Multiple text lines to display"\} > \} > \} \{ > puts "Message type: $mtype" > puts "Message: $text" > \} The 3 arguments of __procedure__ are: - *name* The procedure name can be used in very flexible ways\. Procedure names can have namespace qualifiers\. By providing a two element name list as procedure name, a subcommand of a procedure will be declared\. It is even possible to declare sub\-sub\-commands of a procedure by providing name lists with three elements\. Here are some valid procedure declarations using different procedure names \(the attribute and body arguments are empty for simplicity\): > *\# Simple procedure name:* > tepam::procedure __display\_message__ \{\} \{\} > ** > *\# Procedure declared in the main namespace:* > tepam::procedure __::display\_message__ \{\} \{\} > ** > *\# Procedure in the namespace* __::ns__*:* > tepam::procedure __::ns::display\_message__ \{\} \{\} > ** > *\# Declaration of the subcommand* __message__ *of the procedure* __display__*:* > tepam::procedure __\{display message\}__ \{\} \{\} - *attributes* All procedure attributes are provided in form of an option list that contains pairs of option names and option values\. The example above has as procedure attribute a short and a normal description, but also the procedure arguments are defined in form of a procedure attribute\. |
︙ | ︙ | |||
284 285 286 287 288 289 290 | This is the normal procedure body\. The declared arguments will be available to the procedure body in form of variables\. The procedure body will only be executed if the provided set of arguments could be validated by the TEPAM argument manager\. | | | | | < > | | | < > | | | | | | 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 | This is the normal procedure body\. The declared arguments will be available to the procedure body in form of variables\. The procedure body will only be executed if the provided set of arguments could be validated by the TEPAM argument manager\. > tepam::procedure \{display\_message\} \{ > \-args \{ > \{\-__mtype__ \-default Warning \-choices \{Warning Error\}\} > \{__text__ \-type string\} > \} > \} \{ > puts "Message type: __$mtype__" > puts "Message: __$text__" > \} The commands __[procedure](\.\./\.\./\.\./\.\./index\.md\#procedure)__ as well as __argument\_dialogbox__ are exported from the namespace __tepam__\. To use these commands without the __tepam::__ namespace prefix, it is sufficient to import them into the main namespace: > __namespace import tepam::\*__ > > __[procedure](\.\./\.\./\.\./\.\./index\.md\#procedure)__ \{display\_message\} \{ > \-args \{ > \.\.\. ## <a name='subsection1'></a>Procedure Attributes The first group of attributes affect the behavior of the declared procedure: - \-named\_arguments\_first __0__|__1__ |
︙ | ︙ | |||
363 364 365 366 367 368 369 | - \-validatecommand *script* Custom argument validations can be performed via specific validation commands that are defined with the *\-validatecommand* attribute\. Validation command declaration example: | | | | | | < > | 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | - \-validatecommand *script* Custom argument validations can be performed via specific validation commands that are defined with the *\-validatecommand* attribute\. Validation command declaration example: > tepam::procedure \{display\_message\} \{ > \-args \{ > \{text \-type string \-description "Message text"\} \} > __\-validatecommand \{IllegalWordDetector $text\}__ > \} \{ > \} The validation command is executed in the context of the declared procedure body\. The different argument values are accessed via the argument names\. Note there is also an argument attribute *\-validatecommand* that allows declaring custom checks for specific arguments\. The attribute *\-validatecommand* can be repeated to declare multiple |
︙ | ︙ | |||
433 434 435 436 437 438 439 | examples, using the *\-example* attribute\. ## <a name='subsection2'></a>Argument Declaration The following example shows the structure that is used for the argument definitions in the context of a procedure declaration: | | | | | | | | | > > | | < | | | | | | > | | | | < > | | < | < | > | | | | < > | | < > | | < | | | | | | | | | | < > | | < > | | | | | | | | | | < > | | < > | 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 | examples, using the *\-example* attribute\. ## <a name='subsection2'></a>Argument Declaration The following example shows the structure that is used for the argument definitions in the context of a procedure declaration: > tepam::procedure \{display\_message\} \{ > \-args __\{__ > __\{\-mtype \-default Warning \-choices \{Info Warning Error\} \-description "Message type"\}__ > __\{\-font \-type font \-default \{Arial 10 italic\} \-description "Message text font"\}__ > __\{\-level \-type integer \-optional \-range \{1 10\} \-description "Message level"\}__ > __\{\-fg \-type color \-optional \-description "Message color"\}__ > __\{\-log\_file \-type file \-optional \-description "Optional message log file"\}__ > __\{text \-type string \-multiple \-description "Multiple text lines to display"\}__ > __\}__ > > \} \{ > \} Each of the procedure arguments is declared with a list that has as first element the argument name, followed by eventual attributes\. The argument definition syntax can be formalized in the following way: > tepam::procedure <name> \{ > \-args __\{__ > __\{<argument\_name\_1> <arg\_attr\_name\_1a> <arg\_attr\_value\_1a> <arg\_attr\_name\_1b> <arg\_attr\_value\_1b> \.\.\.\}__ > __\{<argument\_name\_2> <arg\_attr\_name\_2a> <arg\_attr\_value\_2a> <arg\_attr\_name\_2b> <arg\_attr\_value\_2b> \.\.\.\}__ > __\.\.\.__ > __\}__ > > \} <body> The argument names and attributes have to be used in the following way: - Argument name \(*<argument\_name\_<n>>*\) The provided argument name specifies whether the argument is an *unnamed argument* or a *named argument*\. In addition to this, an argument name can also be blank to indicate an argument comment, or it can start with \# to indicate a section comment\. * *"<Name>"* This is the simplest form of an argument name: An argument whose name is not starting with '\-' is an *unnamed argument*\. The parameter provided during a procedure call will be assigned to a variable with the name *<Name>*\. > tepam::procedure \{print\_string\} \{ > \-args \{ > \{__[text](\.\./\.\./\.\./\.\./index\.md\#text)__ \-type string \-description "This is an unnamed argument"\} > \} > \} \{ > puts __$text__ > \} > > print\_string __"Hello"__ > *\-> Hello* * *"\-<Name>"* An argument whose name starts with '\-' is a *named argument* \(also called *option*\)\. The parameter provided during a procedure call will be assigned to a variable with the name *<Name>* \(not *\-<Name>*\)\. > tepam::procedure \{print\_string\} \{ > \-args \{ > \{__\-text__ \-type string \-description "This is a named argument"\} > \} > \} \{ > puts __$text__ > \} > > print\_string __\-text "Hello"__ > *\-> Hello* * *"\-\-"* This flag allows clearly specifying the end of the named arguments and the beginning of the unnamed arguments, in case the *named arguments first, unnamed arguments later style \(Tcl\)* has been selected\. If the *unnamed arguments first, named arguments later style \(Tk\)* style is selected, this flag is ignored if the unnamed arguments have already been parsed\. Otherwise it will be assigned to the corresponding unnamed argument\. * *"\-"* or *""* A blank argument name \(either '\-' or *''*\) starts a comment for the following arguments\. > tepam::procedure \{print\_time\} \{ > \-interactive\_display\_format short > \-args \{ > \{hours \-type integer \-description "Hour"\} > \{minutes \-type integer \-description "Minute"\} > > __\{\- The following arguments are optional:\}__ > \{seconds \-type integer \-default 0 \-description "Seconds"\} > \{milliseconds \-type integer \-default 0 \-description "Milliseconds"\} > \} > \} \{ > puts "$\{hour\}h$\{minutes\}:\[expr $seconds\+0\.001\*$milliseconds\]" > \} Argument comments are basically used in the graphical argument definition forms that are created if a procedure is called interactively\. * *"\#\*"* An argument definition list that starts with '\#' is considered as a section comment\. The argument definition list will be trimmed from the '\#' characters and the remaining string will be used as section comment\. Section comments can be used to structure visually the argument definition code\. Section comments are also used to structure the generated help texts and the interactive argument definition forms\. > tepam::procedure \{complex\_multiply\} \{ > \-description "This function perform a complex multiplication" > \-args \{ > __\{\#\#\#\# First complex number \#\#\#\#\}__ > \{\-r0 \-type double \-description "First number real part"\} > \{\-i0 \-type double \-description "First number imaginary part"\} > > __\{\#\#\#\# Second complex number \#\#\#\#\}__ > \{\-r1 \-type double \-description "Second number real part"\} > \{\-i1 \-type double \-description "Second number imaginary part"\} > \} > \} \{ > return \[expr $r0\*$r1 \- $i0\*$i1\] > \} - Argument attributes \(*<arg\_attr\_name\_<mn>> <arg\_attr\_value\_<mn>>*\) The following argument attributes are supported: * \-description *string* |
︙ | ︙ | |||
651 652 653 654 655 656 657 | validation commands that are defined with the *\-validatecommand* attribute\. The provided validation command can be a complete script in which the pattern *%P* is replaced by the argument value that has to be validated\. Validation command declaration example: | | | | | | < > | 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 | validation commands that are defined with the *\-validatecommand* attribute\. The provided validation command can be a complete script in which the pattern *%P* is replaced by the argument value that has to be validated\. Validation command declaration example: > tepam::procedure \{display\_message\} \{ > \-args \{ > \{text \-type string \-description "Message text" \\ > __\-validatecommand \{IllegalWordDetector %P\}__\} > \} \{ > \} While the purpose of this custom argument validation attribute is the validation of a specific argument, there is also a global attribute *\-validatecommand* that allows performing validation that involves multiple arguments\. * \-validatecommand\_error\_text *string* |
︙ | ︙ | |||
682 683 684 685 686 687 688 | * \-auxargs *list* In case a procedure is called interactively, additional argument attributes can be provided to the interactive argument definition form via the *\-auxargs* attribute that is itself a list of attribute name/attribute value pairs: | | | | | | | | | > | | < | | | | | | | | | 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 | * \-auxargs *list* In case a procedure is called interactively, additional argument attributes can be provided to the interactive argument definition form via the *\-auxargs* attribute that is itself a list of attribute name/attribute value pairs: -auxargs {-<arg_attr_name_1a> <arg_attr_value_1a> \ -<arg_attr_name_1b> <arg_attr_value_1b> ... } For example, if a procedure takes as argument a file name it may be beneficial to specify the required file type for the interactive argument definition form\. This information can be provided via the *\-auxargs* attribute to the argument definition form: > tepam::procedure LoadPicture \{ > \-args \{ > \{FileName \-type existingfile \-description "Picture file" \\ > __\-auxargs \{\-filetypes \{\{"GIF" \{\*\.gif\}\} \{"JPG" \{\*\.jpg\}\} \}\}__\} > \} > \} \{ > \} * \-auxargs\_commands *script* If the auxiliary argument attributes are not static but have to be dynamically adaptable, the *\-auxargs\_commands* allows defining them via commands that are executed during a procedure call\. A list of pairs of auxiliary attribute names and commands has to be provided to the *\-auxargs\_commands* attribute\. The provided commands are executed in the context of the calling procedure\. -auxargs_commands {-<arg_attr_name_1a> <arg_attr_command_1a> \ -<arg_attr_name_1b> <arg_attr_command_1b> ... } # <a name='section4'></a>VARIABLES Several variables defined inside the __::tepam__ namespace impact the mode of operation of the procedures that have been declared with the TEPAM __procedure__ command\. - __named\_arguments\_first__ This variable defines the general calling style of the procedures\. It is by default set to __1__ which selects the *named arguments first, unnamed arguments later* style \(Tcl style\)\. By setting this variable to __0__, the *named arguments first, unnamed arguments later* style is globally selected \(Tk style\): set tepam::named_arguments_first 0 While this variable defines the general calling style, the procedure attribute *\-named\_arguments\_first* can adapt this style individually for each declared procedure\. - __auto\_argument\_name\_completion__ This variable controls the general automatic argument name matching mode\. By default it is set to __1__, meaning that the called procedures are trying to match eventually abbreviated argument names with the declared argument names\. By setting this variable to __0__ the automatic argument name matching mode is disabled: set tepam::auto_argument_name_completion 0 While this variable defines the general matching mode, the procedure attribute *\-auto\_argument\_name\_completion* can adapt this mode individually for each declared procedure\. - __interactive\_display\_format__ A procedure declared via the TEPAM __procedure__ command can always be called with the __\-interactive__ switch\. By doing so, a graphical form will be generated that allows entering interactively all procedure arguments\. There are two display modes for these interactive forms\. The *extended* mode which is the default mode is more adapted for small procedure argument sets\. The __short__ form is more adequate for huge procedure argument sets: set tepam::interactive_display_format "short" The choice to use short or extended forms can be globally configured via the variable __interactive\_display\_format__\. This global setting can be changed individually for a procedure with the procedure attribute *\-interactive\_display\_format*\. - __help\_line\_length__ The maximum line length used by the procedure help text generator can be specified with this variable\. The default length which is set to 80 \(characters\) can easily be adapted to the need of an application: set tepam::help_line_length 120 Since this variable is applied directly during the help text generation, its value can continuously be adapted to the current need\. - __command\_log__ Procedure calls can be logged inside the list variable |
︙ | ︙ | |||
808 809 810 811 812 813 814 | TEPAM provides a comprehensive set of procedure argument types\. They can easily be completed with application specific types if necessary\. ## <a name='subsection3'></a>Predefined Argument Types To remember, a type can be assigned to each specified procedure argument: | | | | | | | > | > | < < | | | < > | | < > | | | | | < | | 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 | TEPAM provides a comprehensive set of procedure argument types\. They can easily be completed with application specific types if necessary\. ## <a name='subsection3'></a>Predefined Argument Types To remember, a type can be assigned to each specified procedure argument: > tepam::procedure \{warning\} \{ > \-args \{ > \{\-font __\-type font__ \-default \{Arial 10 italic\}\} > \{\-severity\_level __\-type integer__ \-optional \-range \{1 10\}\} > \{\-fg __\-type color__ \-optional \-description "Message color"\} > \{text __\-type string__ \-multiple \-description "Multiple text lines to display"\} > \} > \} \{ > \.\.\. > \} There are some *special purpose types* that are building the first category of predefined argument types: - __none__ A *flag*, also called *switch*, is defined as a named argument that has the type __none__\. Flags are always optional and the default value of the assigned variable is set to __0__\. In contrast to the \(normal\) named arguments, no argument value has to be provided to a flag\. > tepam::procedure flag\_test \{ > \-args \{ > __\{\-flag \-type none \-description "This is a flag"\}__ > \} > \} \{ > puts __$flag__ > \} > > flag\_test > *\-> 0* > > flag\_test \-flag > *\-> 1* Since no argument value has to be provided to a flag, also no data check is performed for this argument type\. - __string__ __String__ is a generic argument data type\. Any data string can be provided to a string type argument and no data type checks are therefore performed\. The string type allows defining single line strings |
︙ | ︙ | |||
869 870 871 872 873 874 875 | Several *numerical types* are defined by TEPAM\. The type validation procedures are using the __string is <type> \-strict__ commands to check the validity of the provided arguments, which assures that no empty strings are accepted as argument value\. The type validation expression for the numerical types and the argument types to which this expression is applied are: | < < | < < | | 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 | Several *numerical types* are defined by TEPAM\. The type validation procedures are using the __string is <type> \-strict__ commands to check the validity of the provided arguments, which assures that no empty strings are accepted as argument value\. The type validation expression for the numerical types and the argument types to which this expression is applied are: > string is __<type\_to\_check>__ \-strict *<argument\_value>* - *boolean* - *integer* - *double* Empty strings are accepted as argument value for all the alpha numeric argument types\. The argument types that are falling into this category and validation expression used for them are: > string is *<type\_to\_check>* *<argument\_value>* - *alnum* - *alpha* - *ascii* |
︙ | ︙ | |||
919 920 921 922 923 924 925 | In addition to the data types checked with the __string is <type>__ commands, TEPAM specifies some other useful data types: - *char* Each string that has a length of 1 character meets the *character* type\. The type check is made with the following expression: | | < | < | < < | < < | | | 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 | In addition to the data types checked with the __string is <type>__ commands, TEPAM specifies some other useful data types: - *char* Each string that has a length of 1 character meets the *character* type\. The type check is made with the following expression: > expr \[string length *<argument\_value>*\]==1 - *color* Any character strings that are accepted by Tk as a color are considered as valid color argument\. Please note that the Tk package has to be loaded to use the type *color*\. TEPAM is using the following command to validate the color type: > expr \!\[catch \{winfo rgb \. *<argument\_value>*\}\] - *font* Any character strings that are accepted by Tk as a font are considered as valid font argument\. Please note that the Tk package has to be loaded to use the *font* type\. TEPAM is using the following command to validate the color type: expr ![catch {font measure <argument_value> ""}] - *file* Any strings that are not containing one of the following characters are considered as valid file names: \* ? " < >\. It is not necessary that the file and its containing directory exist\. Zero\-length strings are not considered as valid file names\. The following expression is used to validate the file names: expr [string length <argument_value>]>0 && ![regexp {[\"*?<>:]} <argument_value>] - *existingfile* The argument is valid if it matches with an existing file\. The following check is performed to validate the arguments of this type: file exists <argument_value> - *directory* The directory argument is validated exactly in the same way as the file arguments\. - *existingdirectory* The argument is valid if it matches with an existing directory\. The following check is performed to validate the arguments of this type: file isdirectory <argument_value> ## <a name='subsection4'></a>Defining Application Specific Argument Types To add support for a new application specific argument type it is just necessary to add into the namespace __tepam__ a validation function __Validation\(<type>\)__\. This function requires one argument\. It has to returns __1__ if the provided argument matches with the relevant data type\. |
︙ | ︙ | |||
993 994 995 996 997 998 999 | Each procedure can be called with the *\-help* flag\. The procedure will then print a generated help text to *stdout* and will then return without performing any additional actions\. Taking the first procedure declared in [PROCEDURE CALLS](#section6), the help request and the printed help text would be: | | | > | > > > | > | > | | > | > > > | | | | > | | | | | > | | | | | < < | | | | > < | | > | | | | | | | | | < | | | 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 | Each procedure can be called with the *\-help* flag\. The procedure will then print a generated help text to *stdout* and will then return without performing any additional actions\. Taking the first procedure declared in [PROCEDURE CALLS](#section6), the help request and the printed help text would be: > __display message \-help__ > *\->* > *NAME* > *display message \- Displays a simple message box* > *SYNOPSIS* > *display message* > *\[\-mtype <mtype>\]* > *Message type, default: "Warning", choices: \{Info, Warning, Error\}* > *<text>* > *Multiple text lines to display, type: string* > *DESCRIPTION* > *This procedure allows displaying a configurable message box\. The default* > *message type that is created is a warning, but also errors and info can* > *be generated\.* > *The procedure accepts multiple text lines\.* > *EXAMPLE* > *display message \-mtype Warning "Save first your job"* The argument manager is checking if the last provided argument is *\-help* and generates the requested help message if this is the case\. So, also the following example will print the help message: > __display message \-mtype Info "It is 7:00" \-help__ On the other hand, the following call will result in an error: > __display message \-help \-mtype Info "It is 7:00"__ > *\->* > *display message: Argument '\-help' not known* ## <a name='subsection6'></a>Interactive Procedure Call If Tk has been loaded a procedure can be called with the *\-interactive* flag to open a graphical form that allows specifying interactively all procedure arguments\. The following example assures that the Tk library is loaded and shows the command line to call interactively the procedure declared in [PROCEDURE CALLS](#section6): > package require Tk > __display message \-interactive__ Also the *\-interactive* flag has to be placed at the last argument position as this is also required for the *\-help* flag\. Arguments defined before the *\-interactive* flag will be ignored\. The following example is therefore also a valid interactive procedure call: > __display message__ \-mtype Info "It is 7:00" __\-interactive__ ## <a name='subsection7'></a>Unnamed Arguments Unnamed arguments are typically provided to the called procedure as simple parameters\. This procedure calling form requires that the provided arguments are strictly following the order of the specified arguments\. Several parameters can be assigned to the last argument if this one has the *\-multiple* attribute\. So, the following declared procedure \.\.\. tepam::procedure {display_message} { -args { {mtype -choices {Info Warning Error}} {text -type string -multiple} } } { puts "$mtype: [join $text]" } \.\.\. can for example be called in the following ways: > __display\_message Info "It is PM 7:00\."__ > *\-> Info: It is PM 7:00\.* > > __display\_message Info "It is PM 7:00\." "You should go home\."__ > *\-> Info: It is PM 7:00\. You should go home\.* The nice thing is that unnamed arguments can also be called as named arguments, which can be handy, for example if the exact specified argument order is not known to a user: > __display\_message \-mtype Info \-text "It is PM 7:00\."__ > *\-> Info: It is PM 7:00\.* > > __display\_message \-text "It is PM 7:00\." \-mtype Info__ > *\-> Info: It is PM 7:00\.* > > __display\_message \-mtype Info \-text "It is PM 7:00\." \-text "You should go home\."__ > *\-> Info: It is PM 7:00\. You should go home\.* > > __display\_message \-text "It is PM 7:00\." \-text "You should go home\." \-mtype Info__ > *\-> Info: It is PM 7:00\. You should go home\.* ## <a name='subsection8'></a>Named Arguments Named arguments have to be provided to a procedure in form of a parameter pairs composed by the argument names and the argument values\. The order how they are provided during a procedure call is irrelevant and has not to match with the argument specification order\. |
︙ | ︙ | |||
1092 1093 1094 1095 1096 1097 1098 | } } { puts "$mtype: [join $text]" } \.\.\. can be called in the following ways: | | | | | | | | | | > | < | | < | | | | | | | | | < > | | < > | > < | | | > | | | < | > < | | | | | | | | | | | | | | < | | | | | | | | | < > | | < > | > < | | | | > < | | > | | | < | > | | | | | > < | | | | > | > | | | | > > > | > > > > > > > | > > < | < < < < < < < < < < | | < | | | | | | | < > | | < > | < | | 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 | } } { puts "$mtype: [join $text]" } \.\.\. can be called in the following ways: > __display\_message \-mtype Info \-text "It is PM 7:00\."__ > *\-> Info: It is PM 7:00\.* > > __display\_message \-text "It is PM 7:00\." \-mtype Info__ > *\-> Info: It is PM 7:00\.* > > __display\_message \-mtype Info \-text "It is PM 7:00\." \-text "You should go home\."__ > *\-> Info: It is PM 7:00\. You should go home\.* > > __display\_message \-text "It is PM 7:00\." \-text "You should go home\." \-mtype Info__ > *\-> Info: It is PM 7:00\. You should go home\.* Also named arguments that have not the *\-multiple* attribute can be provided multiple times\. Only the last provided argument will be retained in such a case: > __display\_message \-mtype Info \-text "It is PM 7:00\." \-mtype Warning__ > *\-> Warning: It is PM 7:00\.* ## <a name='subsection9'></a>Unnamed Arguments First, Named Arguments Later \(Tk Style\) A procedure that has been defined while the variable __tepam::named\_arguments\_first__ was set to 1, or with the procedure attribute *\-named\_arguments\_first* set to 1 has to be called in the Tcl style\. The following procedure declaration will be used in this section to illustrate the meaning of this calling style: > __set tepam::named\_arguments\_first 1__ > tepam::procedure my\_proc \{ > \-args \{ > \{\-n1 \-default ""\} > \{\-n2 \-default ""\} > \{u1 \-default ""\} > \{u2 \-default ""\} > \} > \} \{ > puts "n1:'$n1', n2:'$n2', u1:'$u1', u2:'$u2'" > \} The unnamed arguments are placed at the end of procedure call, after the named arguments: > my\_proc __\-n1 N1 \-n2 N2 U1 U2__ > *\-> n1:'N1', n2:'N2', u1:'U1', u2:'U2'* The argument parser considers the first argument that doesn't start with the '\-' character as well as all following arguments as unnamed argument: > my\_proc __U1 U2__ > *\-> n1:'', n2:'', u1:'U1', u2:'U2'* Named arguments can be defined multiple times\. If the named argument has the *\-multiply* attribute, all argument values will be collected in a list\. Otherwise, only the last provided attribute value will be retained: > my\_proc __\-n1 N1 \-n2 N2 \-n1 M1 U1 U2__ > *\-> n1:'M1', n2:'N2', u1:'U1', u2:'U2'* The name of the first unnamed argument has therefore not to start with the '\-' character\. The unnamed argument is otherwise considered as name of another named argument\. This is especially important if the first unnamed argument is given by a variable that can contain any character strings: > my\_proc __\-n1 N1 \-n2 N2 "\->" "<\-"__ > *\-> my\_proc: Argument '\->' not known* > > set U1 "\->" > my\_proc __\-n1 N1 \-n2 N2 $U1 U2__ > my\_proc: Argument '\->' not known The '\-\-' flag allows separating unambiguously the unnamed arguments from the named arguments\. All data after the '\-\-' flag will be considered as unnamed argument: > my\_proc __\-n1 N1 \-n2 N2 \-\- "\->" "<\-"__ > *\-> n1:'N1', n2:'N2', u1:'\->', u2:'<\-'* > > set U1 "\->" > my\_proc __\-n1 N1 \-n2 N2 \-\- $U1 U2__ > *\-> n1:'N1', n2:'N2', u1:'\->', u2:'<\-'* ## <a name='subsection10'></a>Named Arguments First, Unnamed Arguments Later \(Tcl Style\) The Tk calling style will be chosen if a procedure is defined while the variable __tepam::named\_arguments\_first__ is set to 0, or if the procedure attribute *\-named\_arguments\_first* has been set to 0\. The following procedure will be used in this section to illustrate this calling style: > __set tepam::named\_arguments\_first 0__ > tepam::procedure my\_proc \{ > \-args \{ > \{\-n1 \-default ""\} > \{\-n2 \-default ""\} > \{u1\} > \{u2 \-default "" \-multiple\} > \} > \} \{ > puts "n1:'$n1', n2:'$n2', u1:'$u1', u2:'$u2'" > \} The unnamed arguments have to be provided first in this case\. The named arguments are provided afterwards: > my\_proc __U1 U2 \-n1 N1 \-n2 N2__ > *\-> n1:'N1', n1:'N1', u1:'U1', u2:'U2'* The argument parser will assign to each defined unnamed argument a value before it switches to read the named arguments\. This default behavior changes a bit if there are unnamed arguments that are optional or that can take multiple values\. An argument value will only be assigned to an unnamed argument that is optional \(that has either the *\-optional* attribute or that has a default value\), if the value is not beginning with the '\-' character or if no named arguments are defined\. The value that starts with '\-' is otherwise considered as the name of a named argument\. Argument values are assigned to an argument that has the *\-multiple* attribute as long as the parameter value doesn't starts with the '\-' character\. Values that start with the '\-' character can therefore not be assigned to optional unnamed arguments, which restricts the usage of the Tcl procedure calling style\. The Tk style may be preferable in some cases, since it allows separating unambiguously the named arguments from the unnamed ones with the '\-\-' flag\. Let's explore in a bit less theoretically the ways how the previously defined procedure can be called: The first example calls the procedure without any parameters, which leads to an error since *u1* is a mandatory argument: > my\_proc > *\-> my\_proc: Required argument is missing: u1* The procedure call is valid if one parameter is provided for *u1*: > my\_proc __U1__ > *\-> n1:'', n2:'', u1:'U1', u2:''* If more parameters are provided that are not starting with the '\-' character, they will be attributed to the unnamed arguments\. *U2* will receive 3 of these parameters, since it accepts multiple values: > my\_proc __U1 U2 U3 U4__ > *\-> n1:'', n2:'', u1:'U1', u2:'U2 U3 U4'* As soon as one parameter starts with '\-' and all unnamed arguments have been assigned, the argument manager tries to interpret the parameter as name of a named argument\. The procedure call will fail if a value beginning with '\-' is assigned to an unnamed argument: > my\_proc __U1 U2 U3 U4 \-U5__ > *\-> my\_proc: Argument '\-U5' not known* The attribution of a parameter to a named argument will fail if there are undefined unnamed \(non optional\) arguments\. The name specification will in this case simply be considered as a parameter value that is attributed to the *next* unnamed argument\. This was certainly not the intention in the following example: > my\_proc __\-n1 N1__ > *\-> n1:'', n2:'', u1:'\-n1', u2:'N1'* The situation is completely different if values have already been assigned to all mandatory unnamed arguments\. A parameter beginning with the '\-' character will in this case be considered as a name identifier for a named argument: > my\_proc __U1 \-n1 N1__ > *\-> n1:'N1', n2:'', u1:'U1', u2:''* No unnamed arguments are allowed behind the named arguments: > my\_proc __U1 \-n1 N1 U2__ > *\-> my\_proc: Argument 'U2' is not an option* The '\-\-' flag has no special meaning if not all mandatory arguments have got assigned a value\. This flag will simply be attributed to one of the unnamed arguments: > my\_proc __\-\- \-n1 N1__ > *\-> n1:'N1', n2:'', u1:'\-\-', u2:''* But the '\-\-' flag is simply ignored if the argument parser has started to handle the named arguments: > my\_proc __U1 \-\- \-n1 N1__ > *\-> n1:'N1', n2:'', u1:'U1', u2:''* > > my\_proc __U1 \-n1 N1 \-\- \-n2 N2__ > *\-> n1:'N1', n2:'N2', u1:'U1', u2:''* ## <a name='subsection11'></a>Raw Argument List It may be necessary sometimes that the procedure body is able to access the entire list of arguments provided during a procedure call\. This can happen via the __args__ variable that contains always the unprocessed argument list: > tepam::procedure \{display\_message\} \{ > \-args \{ > \{\-mtype \-choices \{Warning Error\} \-default Warning\} > \{text \-type string \-multiple\} > > \} > \} \{ > puts "args: __$args__" > \} > display\_message \-mtype Warning "It is 7:00" > *\-> args: \-mtype Warning \{It is 7:00\}* # <a name='seealso'></a>SEE ALSO [tepam\(n\)](tepam\_introduction\.md), [tepam::argument\_dialogbox\(n\)](tepam\_argument\_dialogbox\.md) # <a name='keywords'></a>KEYWORDS |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/textutil/expander.md.
︙ | ︙ | |||
126 127 128 129 130 131 132 | The command creates a new expander object with an associated Tcl command whose name is *expanderName*\. This command may be used to invoke various operations on the graph\. If the *expanderName* is not fully qualified it is interpreted as relative to the current namespace\. The command has the following general form: | | | 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | The command creates a new expander object with an associated Tcl command whose name is *expanderName*\. This command may be used to invoke various operations on the graph\. If the *expanderName* is not fully qualified it is interpreted as relative to the current namespace\. The command has the following general form: > *expanderName* option ?*arg arg \.\.\.*? *Option* and the *arg*s determine the exact behavior of the command\. The following commands are possible for expander objects: - <a name='2'></a>*expanderName* __cappend__ *text* |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/treeql/treeql.md.
1 2 3 | [//000000001]: # (treeql \- Tree Query Language) [//000000002]: # (Generated from file 'treeql\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (treeql \- Tree Query Language) [//000000002]: # (Generated from file 'treeql\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2004 Colin McCormack <coldstore@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2004 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000005]: # (treeql\(n\) 1\.3\.1 tcllib "Tree Query Language") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
183 184 185 186 187 188 189 | # have such an attribute. # - And returns this information. # Below we can see the same query, but rewritten # to show the structure as it is seen by the query # interpreter. | | | | | 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | # have such an attribute. # - And returns this information. # Below we can see the same query, but rewritten # to show the structure as it is seen by the query # interpreter. q query \ root \ children \ get data The operators of the TreeQL language available for this are explained in the section about [The Tree Query Language](#section3)\. This section also explains the term *node set* used above\. - <a name='3'></a>*qo* __result__ |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/try/tcllib_throw.md.
︙ | ︙ | |||
51 52 53 54 55 56 57 | - <a name='1'></a>__::throw__ *error\_code* *error\_message* throw is merely a reordering of the arguments of the error command\. It throws an error with the indicated error code and error message\. # <a name='section2'></a>EXAMPLES | | | 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | - <a name='1'></a>__::throw__ *error\_code* *error\_message* throw is merely a reordering of the arguments of the error command\. It throws an error with the indicated error code and error message\. # <a name='section2'></a>EXAMPLES > __throw__ \{MYERROR CODE\} "My error message" # <a name='section3'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *try* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/try/tcllib_try.md.
︙ | ︙ | |||
106 107 108 109 110 111 112 | original exception's status dictionary will be added to the new exception's status dictionary under the __\-during__ key\. # <a name='section2'></a>EXAMPLES Ensure that a file is closed no matter what: | | | | | | > | | < | | | | | | < > | 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 | original exception's status dictionary will be added to the new exception's status dictionary under the __\-during__ key\. # <a name='section2'></a>EXAMPLES Ensure that a file is closed no matter what: > set f \[open /some/file/name a\] > __try__ \{ > puts \\$f "some message" > \# \.\.\. > \} __finally__ \{ > close \\$f > \} Handle different reasons for a file to not be openable for reading: > __try__ \{ > set f \[open /some/file/name\] > \} __trap__ \{POSIX EISDIR\} \{\} \{ > puts "failed to open /some/file/name: it's a directory" > \} __trap__ \{POSIX ENOENT\} \{\} \{ > puts "failed to open /some/file/name: it doesn't exist" > \} # <a name='section3'></a>Bugs, Ideas, Feedback This document, and the package it describes, will undoubtedly contain bugs and other problems\. Please report such in the category *try* of the [Tcllib Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas for enhancements you may have for either package and/or documentation\. |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/units/units.md.
︙ | ︙ | |||
178 179 180 181 182 183 184 | 30second 30.0 second 30 second 30.0 second 30 seconds 30.0 second 200*meter/20.5*second 9.75609756098 meter / second # <a name='section4'></a>SI UNITS | | | | | | 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | 30second 30.0 second 30 second 30.0 second 30 seconds 30.0 second 200*meter/20.5*second 9.75609756098 meter / second # <a name='section4'></a>SI UNITS The standard SI units are predefined according to *NIST Special* *Publication 330* \. Standard units for both SI Base Units \(Table 1\) and SI Derived Units with Special Names \(Tables 3a and 3b\) are included here for reference\. Each standard unit name and abbreviation are included in this package\. ## <a name='subsection2'></a>SI Base Units Quantity Unit Name Abbr. --------------------------------------------- Length meter m Mass kilogram kg |
︙ | ︙ | |||
235 236 237 238 239 240 241 | \(kelvins\) to absolute degrees Celsius or Farenheit\. Conversion of thermodynamic quantities, such as thermal expansion \(per unit temperature\), however, are easy to add to the units library\. SI Units can have a multiple or sub\-multiple prefix\. The prefix or its abbreviation should appear before the unit, without spaces\. Compound prefixes are not allowed, and a prefix should never be used alone\. These prefixes are | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | \(kelvins\) to absolute degrees Celsius or Farenheit\. Conversion of thermodynamic quantities, such as thermal expansion \(per unit temperature\), however, are easy to add to the units library\. SI Units can have a multiple or sub\-multiple prefix\. The prefix or its abbreviation should appear before the unit, without spaces\. Compound prefixes are not allowed, and a prefix should never be used alone\. These prefixes are defined in Table 5 of *Special Publication* *330* \. ## <a name='subsection4'></a>SI Prefixes Prefix Name Abbr. Factor --------------------------------------- yotta Y 1e24 zetta Z 1e21 |
︙ | ︙ | |||
337 338 339 340 341 342 343 | types \(e\.g\., *typedef float Length*\), and target units \(expected by the C application code\) are specified in an associative array\. Default units are also defined for each quantity type, and are applied to any unit\-less quantity strings\. A units system enhanced with quantity type checking might benefit from inclusion of other derived types which are expressed in terms of special units, as | | | | | | | | 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 | types \(e\.g\., *typedef float Length*\), and target units \(expected by the C application code\) are specified in an associative array\. Default units are also defined for each quantity type, and are applied to any unit\-less quantity strings\. A units system enhanced with quantity type checking might benefit from inclusion of other derived types which are expressed in terms of special units, as illustrated in Table 2 of *NIST Publication* *330* \. The quantity *area*, for example, could be defined as units properly reducing to *meter^2*, although the utility of defining a unit named *square meter* is arguable\. # <a name='section5'></a>REFERENCES The unit names, abbreviations, and conversion values are derived from those published by the United States Department of Commerce Technology Administration, National Institute of Standards and Technology \(NIST\) in *NIST Special Publication 330: The International System of* *Units \(SI\)* and *NIST Special Publication 811: Guide for* *the Use of the International System of Units \(SI\)* \. Both of these publications are available \(as of December 2000\) from [http://physics\.nist\.gov/cuu/Reference/contents\.html](http://physics\.nist\.gov/cuu/Reference/contents\.html) The ideas behind implementation of this package is based in part on code written in 1993 by Adrian Mariano which performed dimensional analysis of unit strings using fixed size tables of C structs\. After going missing in the late 1990's, Adrian's code has reappeared in the GNU Units program at [http://www\.gnu\.org/software/units/](http://www\.gnu\.org/software/units/) |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/virtchannel_base/cat.md.
1 2 3 4 | [//000000001]: # (tcl::chan::cat \- Reflected/virtual channel support) [//000000002]: # (Generated from file 'cat\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2011 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (tcl::chan::cat \- Reflected/virtual channel support) [//000000002]: # (Generated from file 'cat\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2011 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>) [//000000004]: # (tcl::chan::cat\(n\) 1\.0\.3 tcllib "Reflected/virtual channel support") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
34 35 36 37 38 39 40 | - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require TclOO package require tcl::chan::core ?1? | | | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.5 package require TclOO package require tcl::chan::core ?1? package require tcl::chan::cat ?1\.0\.3? [__::tcl::chan::cat__ *chan*\.\.\.](#1) # <a name='description'></a>DESCRIPTION The __tcl::chan::cat__ package provides a command creating concatenation channels\. These are non\-seekable channels owning a list of subordinate channels |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/yaml/huddle.md.
1 2 3 | [//000000001]: # (huddle \- HUDDLE) [//000000002]: # (Generated from file 'huddle\.man' by tcllib/doctools with format 'markdown') | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | [//000000001]: # (huddle \- HUDDLE) [//000000002]: # (Generated from file 'huddle\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2008\-2011 KATO Kanryu <kanryu6@users\.sourceforge\.net>) [//000000004]: # (Copyright © 2015 Miguel MartÃnez López <aplicacionamedida@gmail\.com>) [//000000005]: # (huddle\(n\) 0\.3 tcllib "HUDDLE") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ |
Changes to embedded/md/tcllib/files/modules/zip/mkzip.md.
1 2 3 4 | [//000000001]: # (zipfile::mkzip \- Zip archive creation) [//000000002]: # (Generated from file 'mkzip\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Pat Thoyts) | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [//000000001]: # (zipfile::mkzip \- Zip archive creation) [//000000002]: # (Generated from file 'mkzip\.man' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2009 Pat Thoyts) [//000000004]: # (zipfile::mkzip\(n\) 1\.2\.1 tcllib "Zip archive creation") <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> | <a href="../../../toc.md">Table Of Contents</a> | <a href="../../../../index.md">Keyword Index</a> | <a href="../../../../toc0.md">Categories</a> | <a href="../../../../toc1.md">Modules</a> | <a href="../../../../toc2.md">Applications</a> ] <hr> |
︙ | ︙ | |||
32 33 34 35 36 37 38 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.6 | | | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | - [Category](#category) - [Copyright](#copyright) # <a name='synopsis'></a>SYNOPSIS package require Tcl 8\.6 package require zipfile::mkzip ?1\.2\.1? [__::zipfile::mkzip::mkzip__ *zipfile* ?__\-zipkit__? ?__\-runtime__ *prefix*? ?__\-comment__ *string*? ?__\-directory__ *rootpath*? ?__\-exclude__ *exclude*? ?__\-\-__? ?*path*\.\.\.?](#1) # <a name='description'></a>DESCRIPTION This package utilizes the zlib functions in Tcl 8\.6 to build zip archives\. |
︙ | ︙ | |||
58 59 60 61 62 63 64 | particularly on Windows the __info\-zip__ and the Windows built\-in zip view have rather poor support for this part of the ZIP file specification\. The __7\-Zip__ program does correctly display utf8 filenames however and the __vfs::zip__ package will use these of course\. If you use | | | 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | particularly on Windows the __info\-zip__ and the Windows built\-in zip view have rather poor support for this part of the ZIP file specification\. The __7\-Zip__ program does correctly display utf8 filenames however and the __vfs::zip__ package will use these of course\. If you use > __::mkzip::mkzip__ mystuff\.tm \-zipkit \-directory mystuff\.vfs it will pack your "mystuff\.vfs/" virtual filesystem tree into a zip archive with a suitable header such that on unix you may mark it executable and it should run with tclkit\. Or you can run it with __tclsh__ or __wish__ 8\.6 if you like\. To change the executable header, specify the __\-runtime__ "preface" |
︙ | ︙ |
Changes to embedded/md/tcllib/toc.md.
︙ | ︙ | |||
39 40 41 42 43 44 45 46 47 48 49 50 51 52 | - [blowfish](tcllib/files/modules/blowfish/blowfish\.md) Implementation of the Blowfish block cipher - [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache - [cksum](tcllib/files/modules/crc/cksum\.md) Calculate a cksum\(1\) compatible checksum - [clock\_iso8601](tcllib/files/modules/clock/iso8601\.md) Parsing ISO 8601 dates/times - [clock\_rfc2822](tcllib/files/modules/clock/rfc2822\.md) Parsing ISO 8601 dates/times - [cmdline](tcllib/files/modules/cmdline/cmdline\.md) Procedures to process command lines and options\. - [comm](tcllib/files/modules/comm/comm\.md) A remote communication facility for Tcl \(8\.3 and later\) | > > | 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | - [blowfish](tcllib/files/modules/blowfish/blowfish\.md) Implementation of the Blowfish block cipher - [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache - [cksum](tcllib/files/modules/crc/cksum\.md) Calculate a cksum\(1\) compatible checksum - [clay](tcllib/files/modules/clay/clay\.md) A minimalist framework for large scale OO Projects - [clock\_iso8601](tcllib/files/modules/clock/iso8601\.md) Parsing ISO 8601 dates/times - [clock\_rfc2822](tcllib/files/modules/clock/rfc2822\.md) Parsing ISO 8601 dates/times - [cmdline](tcllib/files/modules/cmdline/cmdline\.md) Procedures to process command lines and options\. - [comm](tcllib/files/modules/comm/comm\.md) A remote communication facility for Tcl \(8\.3 and later\) |
︙ | ︙ | |||
232 233 234 235 236 237 238 239 240 241 242 243 244 245 | - [fileutil::magic::filetype](tcllib/files/modules/fumagic/filetypes\.md) Procedures implementing file\-type recognition - [fileutil::magic::rt](tcllib/files/modules/fumagic/rtcore\.md) Runtime core for file type recognition engines written in pure Tcl - [fileutil::multi](tcllib/files/modules/fileutil/multi\.md) Multi\-file operation, scatter/gather, standard object - [fileutil::multi::op](tcllib/files/modules/fileutil/multiop\.md) Multi\-file operation, scatter/gather - [fileutil\_traverse](tcllib/files/modules/fileutil/traverse\.md) Iterative directory traversal - [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol - [ftp::geturl](tcllib/files/modules/ftp/ftp\_geturl\.md) Uri handler for ftp urls | > > | 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | - [fileutil::magic::filetype](tcllib/files/modules/fumagic/filetypes\.md) Procedures implementing file\-type recognition - [fileutil::magic::rt](tcllib/files/modules/fumagic/rtcore\.md) Runtime core for file type recognition engines written in pure Tcl - [fileutil::multi](tcllib/files/modules/fileutil/multi\.md) Multi\-file operation, scatter/gather, standard object - [fileutil::multi::op](tcllib/files/modules/fileutil/multiop\.md) Multi\-file operation, scatter/gather - [fileutil::paths](tcllib/files/modules/fileutil/paths\.md) Manage search path pools - [fileutil\_traverse](tcllib/files/modules/fileutil/traverse\.md) Iterative directory traversal - [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol - [ftp::geturl](tcllib/files/modules/ftp/ftp\_geturl\.md) Uri handler for ftp urls |
︙ | ︙ | |||
280 281 282 283 284 285 286 287 288 289 290 291 292 293 | - [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) Interpreter for parsing expression grammars - [hook](tcllib/files/modules/hook/hook\.md) Hooks - [html](tcllib/files/modules/html/html\.md) Procedures to generate HTML structures - [htmlparse](tcllib/files/modules/htmlparse/htmlparse\.md) Procedures to parse HTML strings - [huddle](tcllib/files/modules/yaml/huddle\.md) Create and manipulate huddle object - [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client - [imap4](tcllib/files/modules/imap4/imap4\.md) imap client\-side tcl implementation of imap protocol | > > | 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | - [grammar::peg::interp](tcllib/files/modules/grammar\_peg/peg\_interp\.md) Interpreter for parsing expression grammars - [hook](tcllib/files/modules/hook/hook\.md) Hooks - [html](tcllib/files/modules/html/html\.md) Procedures to generate HTML structures - [htmlparse](tcllib/files/modules/htmlparse/htmlparse\.md) Procedures to parse HTML strings - [httpd](tcllib/files/modules/httpd/httpd\.md) A TclOO and coroutine based web server - [huddle](tcllib/files/modules/yaml/huddle\.md) Create and manipulate huddle object - [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client - [imap4](tcllib/files/modules/imap4/imap4\.md) imap client\-side tcl implementation of imap protocol |
︙ | ︙ | |||
368 369 370 371 372 373 374 375 376 377 378 379 380 381 | - [math::numtheory](tcllib/files/modules/math/numtheory\.md) Number Theory - [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines - [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis - [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions - [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions - [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals - [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions | > > | 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | - [math::numtheory](tcllib/files/modules/math/numtheory\.md) Number Theory - [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines - [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis - [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions - [math::quasirandom](tcllib/files/modules/math/quasirandom\.md) Quasi\-random points for integration and Monte Carlo type methods - [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions - [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals - [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions |
︙ | ︙ | |||
616 617 618 619 620 621 622 623 624 625 626 627 628 629 | - [struct::graph](tcllib/files/modules/struct/graph\.md) Create and manipulate directed graph objects - [struct::graph::op](tcllib/files/modules/struct/graphops\.md) Operation for \(un\)directed graph objects - [struct::graph\_v1](tcllib/files/modules/struct/graph1\.md) Create and manipulate directed graph objects - [struct::list](tcllib/files/modules/struct/struct\_list\.md) Procedures for manipulating lists - [struct::matrix](tcllib/files/modules/struct/matrix\.md) Create and manipulate matrix objects - [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) Create and manipulate matrix objects - [struct::pool](tcllib/files/modules/struct/pool\.md) Create and manipulate pool objects \(of discrete items\) | > > | 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 | - [struct::graph](tcllib/files/modules/struct/graph\.md) Create and manipulate directed graph objects - [struct::graph::op](tcllib/files/modules/struct/graphops\.md) Operation for \(un\)directed graph objects - [struct::graph\_v1](tcllib/files/modules/struct/graph1\.md) Create and manipulate directed graph objects - [struct::list](tcllib/files/modules/struct/struct\_list\.md) Procedures for manipulating lists - [struct::map](tcllib/files/modules/struct/struct\_map\.md) Manage key/value maps - [struct::matrix](tcllib/files/modules/struct/matrix\.md) Create and manipulate matrix objects - [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) Create and manipulate matrix objects - [struct::pool](tcllib/files/modules/struct/pool\.md) Create and manipulate pool objects \(of discrete items\) |
︙ | ︙ | |||
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 | - [tcl::transform::rot](tcllib/files/modules/virtchannel\_transform/rot\.md) rot\-encryption - [tcl::transform::spacer](tcllib/files/modules/virtchannel\_transform/spacer\.md) Space insertation and removal - [tcl::transform::zlib](tcllib/files/modules/virtchannel\_transform/tcllib\_zlib\.md) zlib \(de\)compression - [tclDES](tcllib/files/modules/des/tcldes\.md) Implementation of the DES and triple\-DES ciphers - [tclDESjr](tcllib/files/modules/des/tcldesjr\.md) Implementation of the DES and triple\-DES ciphers - [tcldocstrip](tcllib/files/apps/tcldocstrip\.md) Tcl\-based Docstrip Processor - [tcllib\_ip](tcllib/files/modules/dns/tcllib\_ip\.md) IPv4 and IPv6 address manipulation - [tclrep/machineparameters](tcllib/files/modules/math/machineparameters\.md) Compute double precision machine parameters\. - [tepam](tcllib/files/modules/tepam/tepam\_introduction\.md) An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager - [tepam::argument\_dialogbox](tcllib/files/modules/tepam/tepam\_argument\_dialogbox\.md) TEPAM argument\_dialogbox, reference manual - [tepam::doc\_gen](tcllib/files/modules/tepam/tepam\_doc\_gen\.md) TEPAM DOC Generation, reference manual | > > > > > > > > > > > > | 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 | - [tcl::transform::rot](tcllib/files/modules/virtchannel\_transform/rot\.md) rot\-encryption - [tcl::transform::spacer](tcllib/files/modules/virtchannel\_transform/spacer\.md) Space insertation and removal - [tcl::transform::zlib](tcllib/files/modules/virtchannel\_transform/tcllib\_zlib\.md) zlib \(de\)compression - [tcl\_community\_communication](tcllib/files/devdoc/tcl\_community\_communication\.md) Tcl Community \- Kind Communication - [tclDES](tcllib/files/modules/des/tcldes\.md) Implementation of the DES and triple\-DES ciphers - [tclDESjr](tcllib/files/modules/des/tcldesjr\.md) Implementation of the DES and triple\-DES ciphers - [tcldocstrip](tcllib/files/apps/tcldocstrip\.md) Tcl\-based Docstrip Processor - [tcllib\_devguide](tcllib/files/devdoc/tcllib\_devguide\.md) Tcllib \- The Developer's Guide - [tcllib\_install\_guide](tcllib/files/devdoc/tcllib\_installer\.md) Tcllib \- The Installer's Guide - [tcllib\_ip](tcllib/files/modules/dns/tcllib\_ip\.md) IPv4 and IPv6 address manipulation - [tcllib\_license](tcllib/files/devdoc/tcllib\_license\.md) Tcllib \- License - [tcllib\_releasemgr](tcllib/files/devdoc/tcllib\_releasemgr\.md) Tcllib \- The Release Manager's Guide - [tcllib\_sources](tcllib/files/devdoc/tcllib\_sources\.md) Tcllib \- How To Get The Sources - [tclrep/machineparameters](tcllib/files/modules/math/machineparameters\.md) Compute double precision machine parameters\. - [tepam](tcllib/files/modules/tepam/tepam\_introduction\.md) An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager - [tepam::argument\_dialogbox](tcllib/files/modules/tepam/tepam\_argument\_dialogbox\.md) TEPAM argument\_dialogbox, reference manual - [tepam::doc\_gen](tcllib/files/modules/tepam/tepam\_doc\_gen\.md) TEPAM DOC Generation, reference manual |
︙ | ︙ | |||
771 772 773 774 775 776 777 | - [tie](tcllib/files/modules/tie/tie\_std\.md) Array persistence, standard data sources - [tie](tcllib/files/modules/tie/tie\.md) Array persistence - [tiff](tcllib/files/modules/tiff/tiff\.md) TIFF reading, writing, and querying and manipulation of meta data | < < | 793 794 795 796 797 798 799 800 801 802 803 804 805 806 | - [tie](tcllib/files/modules/tie/tie\_std\.md) Array persistence, standard data sources - [tie](tcllib/files/modules/tie/tie\.md) Array persistence - [tiff](tcllib/files/modules/tiff/tiff\.md) TIFF reading, writing, and querying and manipulation of meta data - [tool](tcllib/files/modules/tool/tool\.md) TclOO Library \(TOOL\) Framework - [tool::dict\_ensemble](tcllib/files/modules/tool/tool\_dict\_ensemble\.md) Dictionary Tools - [transfer::connect](tcllib/files/modules/transfer/connect\.md) Connection setup - [transfer::copy](tcllib/files/modules/transfer/copyops\.md) Data transfer foundation |
︙ | ︙ |
Changes to embedded/md/toc.md.
︙ | ︙ | |||
399 400 401 402 403 404 405 406 407 408 409 410 411 412 | + [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines + [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis + [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions + [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions + [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals + [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions + [math::statistics](tcllib/files/modules/math/statistics\.md) Basic statistical functions and procedures | > > | 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | + [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines + [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis + [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions + [math::quasirandom](tcllib/files/modules/math/quasirandom\.md) Quasi\-random points for integration and Monte Carlo type methods + [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions + [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals + [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions + [math::statistics](tcllib/files/modules/math/statistics\.md) Basic statistical functions and procedures |
︙ | ︙ | |||
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 | + [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol + [ftp::geturl](tcllib/files/modules/ftp/ftp\_geturl\.md) Uri handler for ftp urls + [ftpd](tcllib/files/modules/ftpd/ftpd\.md) Tcl FTP server implementation + [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client + [irc](tcllib/files/modules/irc/irc\.md) Create IRC connection and interface\. + [ldap](tcllib/files/modules/ldap/ldap\.md) LDAP client + [ldapx](tcllib/files/modules/ldap/ldapx\.md) LDAP extended object interface | > > > > | 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | + [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol + [ftp::geturl](tcllib/files/modules/ftp/ftp\_geturl\.md) Uri handler for ftp urls + [ftpd](tcllib/files/modules/ftpd/ftpd\.md) Tcl FTP server implementation + [httpd](tcllib/files/modules/httpd/httpd\.md) A TclOO and coroutine based web server + [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client + [imap4](tcllib/files/modules/imap4/imap4\.md) imap client\-side tcl implementation of imap protocol + [irc](tcllib/files/modules/irc/irc\.md) Create IRC connection and interface\. + [ldap](tcllib/files/modules/ldap/ldap\.md) LDAP client + [ldapx](tcllib/files/modules/ldap/ldapx\.md) LDAP extended object interface |
︙ | ︙ | |||
491 492 493 494 495 496 497 | + [smtp](tcllib/files/modules/mime/smtp\.md) Client\-side tcl implementation of the smtp protocol + [smtpd](tcllib/files/modules/smtpd/smtpd\.md) Tcl SMTP server implementation + [tcllib\_ip](tcllib/files/modules/dns/tcllib\_ip\.md) IPv4 and IPv6 address manipulation | < < | 497 498 499 500 501 502 503 504 505 506 507 508 509 510 | + [smtp](tcllib/files/modules/mime/smtp\.md) Client\-side tcl implementation of the smtp protocol + [smtpd](tcllib/files/modules/smtpd/smtpd\.md) Tcl SMTP server implementation + [tcllib\_ip](tcllib/files/modules/dns/tcllib\_ip\.md) IPv4 and IPv6 address manipulation + [udpcluster](tcllib/files/modules/udpcluster/udpcluster\.md) UDP Peer\-to\-Peer cluster + [uri](tcllib/files/modules/uri/uri\.md) URI utilities + [uri\_urn](tcllib/files/modules/uri/urn\-scheme\.md) URI utilities, URN scheme + [websocket](tcllib/files/modules/websocket/websocket\.md) Tcl implementation of the websocket protocol |
︙ | ︙ | |||
614 615 616 617 618 619 620 621 622 623 624 625 626 627 | * [Procedures, arguments, parameters, options]() + [tepam](tcllib/files/modules/tepam/tepam\_introduction\.md) An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager + [tepam::procedure](tcllib/files/modules/tepam/tepam\_procedure\.md) TEPAM procedure, reference manual * [Programming tools]() + [cmdline](tcllib/files/modules/cmdline/cmdline\.md) Procedures to process command lines and options\. + [comm](tcllib/files/modules/comm/comm\.md) A remote communication facility for Tcl \(8\.3 and later\) + [comm\_wire](tcllib/files/modules/comm/comm\_wire\.md) The comm wire protocol | > > | 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | * [Procedures, arguments, parameters, options]() + [tepam](tcllib/files/modules/tepam/tepam\_introduction\.md) An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager + [tepam::procedure](tcllib/files/modules/tepam/tepam\_procedure\.md) TEPAM procedure, reference manual * [Programming tools]() + [clay](tcllib/files/modules/clay/clay\.md) A minimalist framework for large scale OO Projects + [cmdline](tcllib/files/modules/cmdline/cmdline\.md) Procedures to process command lines and options\. + [comm](tcllib/files/modules/comm/comm\.md) A remote communication facility for Tcl \(8\.3 and later\) + [comm\_wire](tcllib/files/modules/comm/comm\_wire\.md) The comm wire protocol |
︙ | ︙ | |||
826 827 828 829 830 831 832 833 834 835 836 837 | + [transfer::receiver](tcllib/files/modules/transfer/receiver\.md) Data source + [transfer::transmitter](tcllib/files/modules/transfer/transmitter\.md) Data source * [Unfiled]() + [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache + [generator](tcllib/files/modules/generator/generator\.md) Procedures for creating and using generators\. + [huddle](tcllib/files/modules/yaml/huddle\.md) Create and manipulate huddle object | > > < < > > | 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 | + [transfer::receiver](tcllib/files/modules/transfer/receiver\.md) Data source + [transfer::transmitter](tcllib/files/modules/transfer/transmitter\.md) Data source * [Unfiled]() + [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache + [fileutil::paths](tcllib/files/modules/fileutil/paths\.md) Manage search path pools + [generator](tcllib/files/modules/generator/generator\.md) Procedures for creating and using generators\. + [huddle](tcllib/files/modules/yaml/huddle\.md) Create and manipulate huddle object + [map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) Resolving geographical names with a Nominatim service + [map::slippy](tcllib/files/modules/map/map\_slippy\.md) Common code for slippy based map packages + [map::slippy::cache](tcllib/files/modules/map/map\_slippy\_cache\.md) Management of a tile cache in the local filesystem + [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) Accessing a server providing tiles for slippy\-based maps + [mapproj](tcllib/files/modules/mapproj/mapproj\.md) Map projection routines + [math::calculus::symdiff](tcllib/files/modules/math/symdiff\.md) Symbolic differentiation for Tcl + [namespacex](tcllib/files/modules/namespacex/namespacex\.md) Namespace utility commands + [rest](tcllib/files/modules/rest/rest\.md) define REST web APIs and call them inline or asychronously + [stringprep](tcllib/files/modules/stringprep/stringprep\.md) Implementation of stringprep + [stringprep::data](tcllib/files/modules/stringprep/stringprep\_data\.md) stringprep data tables, generated, internal + [struct::map](tcllib/files/modules/struct/struct\_map\.md) Manage key/value maps + [tclrep/machineparameters](tcllib/files/modules/math/machineparameters\.md) Compute double precision machine parameters\. + [uevent::onidle](tcllib/files/modules/uev/uevent\_onidle\.md) Request merging and deferal to idle time + [unicode](tcllib/files/modules/stringprep/unicode\.md) Implementation of Unicode normalization |
︙ | ︙ | |||
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 | - [blowfish](tcllib/files/modules/blowfish/blowfish\.md) Implementation of the Blowfish block cipher + [cache]() - [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache + [clock]() - [clock\_iso8601](tcllib/files/modules/clock/iso8601\.md) Parsing ISO 8601 dates/times - [clock\_rfc2822](tcllib/files/modules/clock/rfc2822\.md) Parsing ISO 8601 dates/times + [cmdline]() | > > > > | 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 | - [blowfish](tcllib/files/modules/blowfish/blowfish\.md) Implementation of the Blowfish block cipher + [cache]() - [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache + [clay]() - [clay](tcllib/files/modules/clay/clay\.md) A minimalist framework for large scale OO Projects + [clock]() - [clock\_iso8601](tcllib/files/modules/clock/iso8601\.md) Parsing ISO 8601 dates/times - [clock\_rfc2822](tcllib/files/modules/clock/rfc2822\.md) Parsing ISO 8601 dates/times + [cmdline]() |
︙ | ︙ | |||
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 | + [fileutil]() - [fileutil](tcllib/files/modules/fileutil/fileutil\.md) Procedures implementing some file utilities - [fileutil::multi](tcllib/files/modules/fileutil/multi\.md) Multi\-file operation, scatter/gather, standard object - [fileutil::multi::op](tcllib/files/modules/fileutil/multiop\.md) Multi\-file operation, scatter/gather - [fileutil\_traverse](tcllib/files/modules/fileutil/traverse\.md) Iterative directory traversal + [ftp]() - [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol | > > | 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 | + [fileutil]() - [fileutil](tcllib/files/modules/fileutil/fileutil\.md) Procedures implementing some file utilities - [fileutil::multi](tcllib/files/modules/fileutil/multi\.md) Multi\-file operation, scatter/gather, standard object - [fileutil::multi::op](tcllib/files/modules/fileutil/multiop\.md) Multi\-file operation, scatter/gather - [fileutil::paths](tcllib/files/modules/fileutil/paths\.md) Manage search path pools - [fileutil\_traverse](tcllib/files/modules/fileutil/traverse\.md) Iterative directory traversal + [ftp]() - [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol |
︙ | ︙ | |||
1319 1320 1321 1322 1323 1324 1325 | + [http]() - [autoproxy](tcllib/files/modules/http/autoproxy\.md) Automatic HTTP proxy usage and authentication + [httpd]() | | | 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 | + [http]() - [autoproxy](tcllib/files/modules/http/autoproxy\.md) Automatic HTTP proxy usage and authentication + [httpd]() - [httpd](tcllib/files/modules/httpd/httpd\.md) A TclOO and coroutine based web server + [ident]() - [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client + [imap4]() |
︙ | ︙ | |||
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 | - [math::numtheory](tcllib/files/modules/math/numtheory\.md) Number Theory - [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines - [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis - [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions - [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions - [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals - [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions | > > | 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 | - [math::numtheory](tcllib/files/modules/math/numtheory\.md) Number Theory - [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines - [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis - [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions - [math::quasirandom](tcllib/files/modules/math/quasirandom\.md) Quasi\-random points for integration and Monte Carlo type methods - [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions - [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals - [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions |
︙ | ︙ | |||
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 | - [struct::graph](tcllib/files/modules/struct/graph\.md) Create and manipulate directed graph objects - [struct::graph::op](tcllib/files/modules/struct/graphops\.md) Operation for \(un\)directed graph objects - [struct::graph\_v1](tcllib/files/modules/struct/graph1\.md) Create and manipulate directed graph objects - [struct::list](tcllib/files/modules/struct/struct\_list\.md) Procedures for manipulating lists - [struct::matrix](tcllib/files/modules/struct/matrix\.md) Create and manipulate matrix objects - [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) Create and manipulate matrix objects - [struct::pool](tcllib/files/modules/struct/pool\.md) Create and manipulate pool objects \(of discrete items\) | > > | 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 | - [struct::graph](tcllib/files/modules/struct/graph\.md) Create and manipulate directed graph objects - [struct::graph::op](tcllib/files/modules/struct/graphops\.md) Operation for \(un\)directed graph objects - [struct::graph\_v1](tcllib/files/modules/struct/graph1\.md) Create and manipulate directed graph objects - [struct::list](tcllib/files/modules/struct/struct\_list\.md) Procedures for manipulating lists - [struct::map](tcllib/files/modules/struct/struct\_map\.md) Manage key/value maps - [struct::matrix](tcllib/files/modules/struct/matrix\.md) Create and manipulate matrix objects - [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) Create and manipulate matrix objects - [struct::pool](tcllib/files/modules/struct/pool\.md) Create and manipulate pool objects \(of discrete items\) |
︙ | ︙ |
Changes to embedded/md/toc0.md.
︙ | ︙ | |||
399 400 401 402 403 404 405 406 407 408 409 410 411 412 | + [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines + [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis + [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions + [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions + [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals + [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions + [math::statistics](tcllib/files/modules/math/statistics\.md) Basic statistical functions and procedures | > > | 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | + [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines + [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis + [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions + [math::quasirandom](tcllib/files/modules/math/quasirandom\.md) Quasi\-random points for integration and Monte Carlo type methods + [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions + [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals + [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions + [math::statistics](tcllib/files/modules/math/statistics\.md) Basic statistical functions and procedures |
︙ | ︙ | |||
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 | + [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol + [ftp::geturl](tcllib/files/modules/ftp/ftp\_geturl\.md) Uri handler for ftp urls + [ftpd](tcllib/files/modules/ftpd/ftpd\.md) Tcl FTP server implementation + [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client + [irc](tcllib/files/modules/irc/irc\.md) Create IRC connection and interface\. + [ldap](tcllib/files/modules/ldap/ldap\.md) LDAP client + [ldapx](tcllib/files/modules/ldap/ldapx\.md) LDAP extended object interface | > > > > | 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | + [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol + [ftp::geturl](tcllib/files/modules/ftp/ftp\_geturl\.md) Uri handler for ftp urls + [ftpd](tcllib/files/modules/ftpd/ftpd\.md) Tcl FTP server implementation + [httpd](tcllib/files/modules/httpd/httpd\.md) A TclOO and coroutine based web server + [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client + [imap4](tcllib/files/modules/imap4/imap4\.md) imap client\-side tcl implementation of imap protocol + [irc](tcllib/files/modules/irc/irc\.md) Create IRC connection and interface\. + [ldap](tcllib/files/modules/ldap/ldap\.md) LDAP client + [ldapx](tcllib/files/modules/ldap/ldapx\.md) LDAP extended object interface |
︙ | ︙ | |||
491 492 493 494 495 496 497 | + [smtp](tcllib/files/modules/mime/smtp\.md) Client\-side tcl implementation of the smtp protocol + [smtpd](tcllib/files/modules/smtpd/smtpd\.md) Tcl SMTP server implementation + [tcllib\_ip](tcllib/files/modules/dns/tcllib\_ip\.md) IPv4 and IPv6 address manipulation | < < | 497 498 499 500 501 502 503 504 505 506 507 508 509 510 | + [smtp](tcllib/files/modules/mime/smtp\.md) Client\-side tcl implementation of the smtp protocol + [smtpd](tcllib/files/modules/smtpd/smtpd\.md) Tcl SMTP server implementation + [tcllib\_ip](tcllib/files/modules/dns/tcllib\_ip\.md) IPv4 and IPv6 address manipulation + [udpcluster](tcllib/files/modules/udpcluster/udpcluster\.md) UDP Peer\-to\-Peer cluster + [uri](tcllib/files/modules/uri/uri\.md) URI utilities + [uri\_urn](tcllib/files/modules/uri/urn\-scheme\.md) URI utilities, URN scheme + [websocket](tcllib/files/modules/websocket/websocket\.md) Tcl implementation of the websocket protocol |
︙ | ︙ | |||
614 615 616 617 618 619 620 621 622 623 624 625 626 627 | * [Procedures, arguments, parameters, options]() + [tepam](tcllib/files/modules/tepam/tepam\_introduction\.md) An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager + [tepam::procedure](tcllib/files/modules/tepam/tepam\_procedure\.md) TEPAM procedure, reference manual * [Programming tools]() + [cmdline](tcllib/files/modules/cmdline/cmdline\.md) Procedures to process command lines and options\. + [comm](tcllib/files/modules/comm/comm\.md) A remote communication facility for Tcl \(8\.3 and later\) + [comm\_wire](tcllib/files/modules/comm/comm\_wire\.md) The comm wire protocol | > > | 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | * [Procedures, arguments, parameters, options]() + [tepam](tcllib/files/modules/tepam/tepam\_introduction\.md) An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager + [tepam::procedure](tcllib/files/modules/tepam/tepam\_procedure\.md) TEPAM procedure, reference manual * [Programming tools]() + [clay](tcllib/files/modules/clay/clay\.md) A minimalist framework for large scale OO Projects + [cmdline](tcllib/files/modules/cmdline/cmdline\.md) Procedures to process command lines and options\. + [comm](tcllib/files/modules/comm/comm\.md) A remote communication facility for Tcl \(8\.3 and later\) + [comm\_wire](tcllib/files/modules/comm/comm\_wire\.md) The comm wire protocol |
︙ | ︙ | |||
826 827 828 829 830 831 832 833 834 835 836 837 | + [transfer::receiver](tcllib/files/modules/transfer/receiver\.md) Data source + [transfer::transmitter](tcllib/files/modules/transfer/transmitter\.md) Data source * [Unfiled]() + [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache + [generator](tcllib/files/modules/generator/generator\.md) Procedures for creating and using generators\. + [huddle](tcllib/files/modules/yaml/huddle\.md) Create and manipulate huddle object | > > < < > > | 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 | + [transfer::receiver](tcllib/files/modules/transfer/receiver\.md) Data source + [transfer::transmitter](tcllib/files/modules/transfer/transmitter\.md) Data source * [Unfiled]() + [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache + [fileutil::paths](tcllib/files/modules/fileutil/paths\.md) Manage search path pools + [generator](tcllib/files/modules/generator/generator\.md) Procedures for creating and using generators\. + [huddle](tcllib/files/modules/yaml/huddle\.md) Create and manipulate huddle object + [map::geocode::nominatim](tcllib/files/modules/map/map\_geocode\_nominatim\.md) Resolving geographical names with a Nominatim service + [map::slippy](tcllib/files/modules/map/map\_slippy\.md) Common code for slippy based map packages + [map::slippy::cache](tcllib/files/modules/map/map\_slippy\_cache\.md) Management of a tile cache in the local filesystem + [map::slippy::fetcher](tcllib/files/modules/map/map\_slippy\_fetcher\.md) Accessing a server providing tiles for slippy\-based maps + [mapproj](tcllib/files/modules/mapproj/mapproj\.md) Map projection routines + [math::calculus::symdiff](tcllib/files/modules/math/symdiff\.md) Symbolic differentiation for Tcl + [namespacex](tcllib/files/modules/namespacex/namespacex\.md) Namespace utility commands + [rest](tcllib/files/modules/rest/rest\.md) define REST web APIs and call them inline or asychronously + [stringprep](tcllib/files/modules/stringprep/stringprep\.md) Implementation of stringprep + [stringprep::data](tcllib/files/modules/stringprep/stringprep\_data\.md) stringprep data tables, generated, internal + [struct::map](tcllib/files/modules/struct/struct\_map\.md) Manage key/value maps + [tclrep/machineparameters](tcllib/files/modules/math/machineparameters\.md) Compute double precision machine parameters\. + [uevent::onidle](tcllib/files/modules/uev/uevent\_onidle\.md) Request merging and deferal to idle time + [unicode](tcllib/files/modules/stringprep/unicode\.md) Implementation of Unicode normalization |
︙ | ︙ |
Changes to embedded/md/toc1.md.
︙ | ︙ | |||
65 66 67 68 69 70 71 72 73 74 75 76 77 78 | + [blowfish](tcllib/files/modules/blowfish/blowfish\.md) Implementation of the Blowfish block cipher * [cache]() + [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache * [clock]() + [clock\_iso8601](tcllib/files/modules/clock/iso8601\.md) Parsing ISO 8601 dates/times + [clock\_rfc2822](tcllib/files/modules/clock/rfc2822\.md) Parsing ISO 8601 dates/times * [cmdline]() | > > > > | 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | + [blowfish](tcllib/files/modules/blowfish/blowfish\.md) Implementation of the Blowfish block cipher * [cache]() + [cache::async](tcllib/files/modules/cache/async\.md) Asynchronous in\-memory cache * [clay]() + [clay](tcllib/files/modules/clay/clay\.md) A minimalist framework for large scale OO Projects * [clock]() + [clock\_iso8601](tcllib/files/modules/clock/iso8601\.md) Parsing ISO 8601 dates/times + [clock\_rfc2822](tcllib/files/modules/clock/rfc2822\.md) Parsing ISO 8601 dates/times * [cmdline]() |
︙ | ︙ | |||
298 299 300 301 302 303 304 305 306 307 308 309 310 311 | * [fileutil]() + [fileutil](tcllib/files/modules/fileutil/fileutil\.md) Procedures implementing some file utilities + [fileutil::multi](tcllib/files/modules/fileutil/multi\.md) Multi\-file operation, scatter/gather, standard object + [fileutil::multi::op](tcllib/files/modules/fileutil/multiop\.md) Multi\-file operation, scatter/gather + [fileutil\_traverse](tcllib/files/modules/fileutil/traverse\.md) Iterative directory traversal * [ftp]() + [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol | > > | 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | * [fileutil]() + [fileutil](tcllib/files/modules/fileutil/fileutil\.md) Procedures implementing some file utilities + [fileutil::multi](tcllib/files/modules/fileutil/multi\.md) Multi\-file operation, scatter/gather, standard object + [fileutil::multi::op](tcllib/files/modules/fileutil/multiop\.md) Multi\-file operation, scatter/gather + [fileutil::paths](tcllib/files/modules/fileutil/paths\.md) Manage search path pools + [fileutil\_traverse](tcllib/files/modules/fileutil/traverse\.md) Iterative directory traversal * [ftp]() + [ftp](tcllib/files/modules/ftp/ftp\.md) Client\-side tcl implementation of the ftp protocol |
︙ | ︙ | |||
385 386 387 388 389 390 391 | * [http]() + [autoproxy](tcllib/files/modules/http/autoproxy\.md) Automatic HTTP proxy usage and authentication * [httpd]() | | | 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | * [http]() + [autoproxy](tcllib/files/modules/http/autoproxy\.md) Automatic HTTP proxy usage and authentication * [httpd]() + [httpd](tcllib/files/modules/httpd/httpd\.md) A TclOO and coroutine based web server * [ident]() + [ident](tcllib/files/modules/ident/ident\.md) Ident protocol client * [imap4]() |
︙ | ︙ | |||
510 511 512 513 514 515 516 517 518 519 520 521 522 523 | + [math::numtheory](tcllib/files/modules/math/numtheory\.md) Number Theory + [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines + [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis + [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions + [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions + [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals + [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions | > > | 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | + [math::numtheory](tcllib/files/modules/math/numtheory\.md) Number Theory + [math::optimize](tcllib/files/modules/math/optimize\.md) Optimisation routines + [math::PCA](tcllib/files/modules/math/pca\.md) Package for Principal Component Analysis + [math::polynomials](tcllib/files/modules/math/polynomials\.md) Polynomial functions + [math::quasirandom](tcllib/files/modules/math/quasirandom\.md) Quasi\-random points for integration and Monte Carlo type methods + [math::rationalfunctions](tcllib/files/modules/math/rational\_funcs\.md) Polynomial functions + [math::roman](tcllib/files/modules/math/roman\.md) Tools for creating and manipulating roman numerals + [math::special](tcllib/files/modules/math/special\.md) Special mathematical functions |
︙ | ︙ | |||
830 831 832 833 834 835 836 837 838 839 840 841 842 843 | + [struct::graph](tcllib/files/modules/struct/graph\.md) Create and manipulate directed graph objects + [struct::graph::op](tcllib/files/modules/struct/graphops\.md) Operation for \(un\)directed graph objects + [struct::graph\_v1](tcllib/files/modules/struct/graph1\.md) Create and manipulate directed graph objects + [struct::list](tcllib/files/modules/struct/struct\_list\.md) Procedures for manipulating lists + [struct::matrix](tcllib/files/modules/struct/matrix\.md) Create and manipulate matrix objects + [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) Create and manipulate matrix objects + [struct::pool](tcllib/files/modules/struct/pool\.md) Create and manipulate pool objects \(of discrete items\) | > > | 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 | + [struct::graph](tcllib/files/modules/struct/graph\.md) Create and manipulate directed graph objects + [struct::graph::op](tcllib/files/modules/struct/graphops\.md) Operation for \(un\)directed graph objects + [struct::graph\_v1](tcllib/files/modules/struct/graph1\.md) Create and manipulate directed graph objects + [struct::list](tcllib/files/modules/struct/struct\_list\.md) Procedures for manipulating lists + [struct::map](tcllib/files/modules/struct/struct\_map\.md) Manage key/value maps + [struct::matrix](tcllib/files/modules/struct/matrix\.md) Create and manipulate matrix objects + [struct::matrix\_v1](tcllib/files/modules/struct/matrix1\.md) Create and manipulate matrix objects + [struct::pool](tcllib/files/modules/struct/pool\.md) Create and manipulate pool objects \(of discrete items\) |
︙ | ︙ |
Added idoc/man/files/devdoc/tcl_community_communication.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'tcl_community_communication\&.man' by tcllib/doctools with format 'nroff' '\" .TH "tcl_community_communication" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME tcl_community_communication \- Tcl Community - Kind Communication .SH DESCRIPTION The Tcl Community encourages contributions from anyone who wishes to advance the development of: .IP \(bu The Tcl Language .IP \(bu Tcl derived languages .IP \(bu Tcl related libraries .IP \(bu Tcl extensions .IP \(bu External Projects that Integrate Tcl .PP .PP We welcome those contributions from anyone\&. We are blind to gender, race, religion, cultural background, cybernetic nature, and any other demographic characteristics, as well as personal political views\&. .PP A community lives and dies by communications\&. And occasionally our communications are peppered with patterns that are harsh, unfriendly, unwelcoming and/or otherwise unkind\&. As a volunteer community, we need all of the help we can get\&. Therefore, we ask all contributors to make a conscious effort, in Tcl Community discussions, to communicate in ways that are welcoming\&. Ways that are friendly\&. Ways that are, in a word: kind\&. .PP These guidelines suggest specific ways to accomplish that goal\&. .PP Please note: for the balance of this document any reference to "People", "Persons", "anybody" or "somebody" can refer to any sentient being, not merely corporeal members of the species Homo Sapien\&. .TP We are a Sanctuary not a Clubhouse The Tcl Community is a collective of amateurs and professionals who code, test, and use tools\&. Our community is open to all\&. There is no velvet rope\&. There is no bouncer at the door\&. There are no secret handshakes\&. Any sentient being who enters our midst is welcome\&. If someone is ever asked to leave, it is only because they are being disruptive to the functioning of the community\&. .TP We Merit Ideas, Not People A good idea can come from anyone, regardless of how little time they have been with us\&. A bad idea can come from anyone, regardless of how much time or how little time they have been with us\&. We judge a concept by how it stands up to scrutiny of logic, implementation, and regression testing\&. We don’t judge ideas based on who had the idea first, who agrees with the idea, or who disagrees with it\&. .TP Treat Everyone with Respect Everyone is deserving of respect and courtesy at all times\&. .TP Refer to people by the names they use\&. If grammar requires you to state a gender for a person, honor their preferences about their gender identity\&. If you are unsure as to the gender of an individual, ask\&. If someone had to guess about your gender and got it wrong, please correct them and do not take it personally\&. .TP Do not take a harsh tone towards other participants\&. Do not make personal attacks against anyone (participant or not\&.) .sp Criticize statements and actions, never people\&. .TP Don’t Take Things Personally When in doubt, assume the best in people\&. A criticism of your statements is not a personal attack on you\&. .TP Persons, not People Stereotypes are an unhelpful tool on many accounts\&. They are generally oversimplified\&. They are usually flat out wrong\&. And even if "right" they are of absolutely no utility in determining the capabilities, motivations, or fitness of an individual\&. .sp Don’t use them in Tcl Community communications\&. .TP Mistakes Happen The human condition is a series of trials and errors\&. Progress is when we get one more trial than error\&. Being wrong or making a mistake is the default state of humanity\&. Accept the errors of your fellow sentient beings, and be aware that you are also fallible\&. .TP Keep it Real Please respond to what people actually say\&. We are all amazing individuals, but none among us are mind readers\&. If you find yourself responding to what you imagine someone is thinking, odds are you are going to be wrong\&. .sp If you must criticize someone, stick to things they have actually done\&. Never criticize for something you speculate they have done\&. Or imagine they have done\&. Or something someone who shares some attribute with them has done in the past\&. .sp Keep discussions about any non-Tcl subjects to what can be stated factually and without emotion or judgement\&. .TP When Trouble Arises, Don’t Escalate If you feel you are being personally attacked or offended, take the high road\&. Punching back in a public forum will only makes things worse\&. Address the matter in a private correspondence\&. Be polite\&. Express your feelings, but note that you are expressing your feelings\&. When writing, look for a way to calm matters down\&. And when in doubt, sleep on your letter before pressing send\&. And when not in doubt, sleep on it for another day after that\&. .sp If you are a spectator to a fight in progress, politely request the two parties take the matter to a more private forum\&. .TP Always get the Last Word: I’m Sorry If an personal argument does arise, be the first to apologize\&. An apology does not concede a logical point\&. It merely acknowledges that at some point the discussion left either logic, community decency, or both\&. Return to the topic when cooler heads can prevail\&. .TP Nobody is Keeping Score There is no prize for being right\&. There is no cost for being wrong\&. A hard sell is not going to advance your idea along any more than a logical argument\&. You aren’t running for office\&. This isn’t debate club\&. If you find yourself continuing a discussion beyond where a topic can be logically discussed, stop\&. .TP No Evangelizing The Tcl Community is not the place to promote your chosen operating system, political outlook, religion, marketing scheme, or economic model\&. Period\&. .sp (And if you do bring it up, be prepared to have your chosen topic discussed logically\&. And odds are, not favorably\&.) .TP Respect the Community If the Community has come to a decision on a course of action, please stop arguing\&. .sp If someone complains about how you are expressing your ideas, listen\&. .sp If your words are hurting people, stop\&. There is no amount of being "right" that makes up for someone leaving our midst because they felt insulted, threatened, or ignored\&. .PP By following these guidelines, we will build our community, encourage more contribution to our projects, and our discussions will be friendlier and reach conclusions more easily\&. .PP Thank You\&. .SH SIGNATORIES .IP \(bu Sean "the Hypnotoad" Woods .IP \(bu Andreas Kupries .PP .SH AUTHORS .TP Primary Sean "the Hypnotoad" Woods .TP Light editing Andreas Kupries .PP |
Added idoc/man/files/devdoc/tcllib_devguide.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 | '\" '\" Generated from file 'tcllib_devguide\&.man' by tcllib/doctools with format 'nroff' '\" .TH "tcllib_devguide" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME tcllib_devguide \- Tcllib - The Developer's Guide .SH SYNOPSIS \fBModule\fR \fIname\fR \fIcode-action\fR \fIdoc-action\fR \fIexample-action\fR .sp \fBApplication\fR \fIname\fR .sp \fBExclude\fR \fIname\fR .sp .BE .SH DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\&. Note that Tcllib is not a package itself\&. It is a collection of (semi-independent) \fITcl\fR packages that provide utility functions useful to a large collection of Tcl programmers\&. .PP This document is a guide for developers working on Tcllib, i\&.e\&. maintainers fixing bugs, extending the collection's functionality, etc\&. .PP Please read .IP [1] \fITcllib - How To Get The Sources\fR and .IP [2] \fITcllib - The Installer's Guide\fR .PP first, if that was not done already\&. .PP Here we assume that the sources are already available in a directory of your choice, and that you not only know how to build and install them, but also have all the necessary requisites to actually do so\&. The guide to the sources in particular also explains which source code management system is used, where to find it, how to set it up, etc\&. .SH COMMITMENTS .SS CONTRIBUTOR As a contributor to Tcllib you are committing yourself to: .IP [1] keep the guidelines written down in \fITcl Community - Kind Communication\fR in your mind\&. The main point to take away from there is \fIto be kind to each other\fR\&. .IP [2] Your contributions getting distributed under a BSD/MIT license\&. For the details see \fITcllib - License\fR .PP Contributions are made by entering tickets into our tracker, providing patches, bundles or branches of code for inclusion, or posting to the Tcllib related mailing lists\&. .SS MAINTAINER When contributing one or more packages for full inclusion into Tcllib you are committing yourself to .IP [1] Keep the guidelines written down in \fITcl Community - Kind Communication\fR (as any contributor) in your mind\&. The main point to take away from there is \fIto be kind to each other\fR\&. .IP [2] Your packages getting distributed under a BSD/MIT license\&. For the details see \fITcllib - License\fR .IP [3] Maintenance of the new packages for a period of two years under the following rules, and responsibilities: .RS .IP [1] A maintainer may step down after the mandatory period as they see fit\&. .IP [2] A maintainer may step down before the end of the mandatory period, under the condition that a replacement maintainer is immediately available and has agreed to serve the remainder of the period, plus their own mandatory period (see below)\&. .IP [3] When stepping down without a replacement maintainer taking over the relevant packages have to be flagged as \fBunmaintained\fR\&. .IP [4] When a replacement mantainer is brought in for a package it is (kept) marked as \fBmaintained\fR (again)\&. .sp A replacement maintainer is bound by the same rules as the original maintainer, except that the mandatory period of maintenance is shortened to one year\&. .IP [5] For any \fBunmaintained\fR package a contributor interested in becoming its maintainer can become so by flagging them as \fBmaintained\fR with their name and contact information, committing themselves to the rules of a replacement maintainer (see previous point)\&. .IP [6] For any already \fBmaintained\fR package a contributor interested in becoming a co-maintainer can become so with the agreement of the existing maintainer(s), committing themselves to the rules of a replacement maintainer (see two points previous)\&. .RE .sp The responsibilities as a maintainer include: .RS .IP [1] Watching Tcllib's ticket tracker for bugs, bug fixes, and feature requests related to the new packages\&. .IP [2] Reviewing the aforementioned tickets, rejecting or applying them .IP [3] Coordination and discussion with ticket submitter during the development and/or application of bug fixes\&. .RE .IP [4] Follow the \fBBranching and Workflow\fR of this guide\&. .PP .SH "BRANCHING AND WORKFLOW" .SS "PACKAGE DEPENDENCIES" Regarding packages and dependencies between them Tcllib occupies a middle position between two extremes: .IP [1] On one side a strongly interdependent set of packages, usually by a single author, for a single project\&. Looking at my (Andreas Kupries) own work examples of such are \fIMarpa\fR [https://core\&.tcl\&.tk/akupries/marpa/index], \fICRIMP\fR [https://core\&.tcl\&.tk/akupries/crimp/index], \fIKinetcl\fR [https://core\&.tcl\&.tk/akupries/kinetcl/index], etc\&. .sp For every change the author of the project handles all the modifications cascading from any incompatibilities it introduced to the system\&. .IP [2] On the other side, the world of semi-independent projects by many different authors where authors know what packages their own creations depend on, yet usually do not know who else depends on them\&. .sp The best thing an author making an (incompatible) change to their project can do is to for one announce such changes in some way, and for two use versioning to distinguish the code before and after the change\&. .sp The world is then responsible for adapting, be it by updating their own projects to the new version, or by sticking to the old\&. .PP As mentioned already, Tcllib lives in the middle of that\&. .PP While we as maintainers cannot be aware of all users of Tcllib's packages, and thus have to rely on the mechanisms touched on in point 2 above for that, the dependencies between the packages contained in Tcllib are a different matter\&. .PP As we are collectively responsible for the usability of Tcllib in toto to the outside world, it behooves us to be individually mindful even of Tcllib packages we are not directly maintaining, when they depend on packages under our maintainership\&. This may be as simple as coordinating with the maintainers of the affected packages\&. It may also require us to choose how to adapt affected packages which do not have maintainers, i\&.e\&. modify them to use our changed package properly, or modify them to properly depend on the unchanged version of our package\&. .PP Note that the above is not only a chore but an opportunity as well\&. Additional insight can be had by forcing ourselves to look at our package and the planned change(s) from an outside perspective, to consider the ramifications of our actions on others in general, and on dependent packages in particular\&. .SS TRUNK The management and use of branches is an important part of working with a \fIDistributed Version Control System\fR (\fIDVCS\fR) like \fIfossil\fR [https://www\&.fossil-scm\&.org/]\&. .PP For Tcllib the main branch of the collection is \fItrunk\fR\&. In \fIgit\fR this branch would be called \fImaster\fR, and this is exactly the case in the \fIgithub mirror\fR [https://github\&.com/tcltk/tcllib/] of Tcllib\&. .PP To properly support debugging \fIeach commit\fR on this branch \fIhas to pass the entire testsuite\fR of the collection\&. Using bisection to determine when an issue appeared is an example of an action made easier by this constraint\&. .PP This is part of our collective responsibility for the usability of Tcllib in toto to the outside world\&. As \fIfossil\fR has no mechanism to enforce this condition this is handled on the honor system for developers and maintainers\&. .PP To make the task easier Tcllib comes with a tool ("\fIsak\&.tcl\fR") providing a number of commands in support\&. These commands are explained in the following sections of this guide\&. .PP While it is possible and allowed to commit directly to trunk remember the above constraint regarding the testsuite, and the coming notes about other possible issues with a commit\&. .SS BRANCHES Given the constraints placed on the \fItrunk\fR branch of the repository it is (strongly) recommended to perform any development going beyond trivial changes on a non-trunk branch\&. .PP Outside of the trunk developers are allowed to commit intermediate broken states of their work\&. Only at the end of a development cycle, when the relevant branch is considered ready for merging, will it be necessary to perform full the set of validations ensuring that the merge to come will create a good commit on trunk\&. .PP Note that while a review from a second developer is not a required condition for merging a branch it is recommended to seek out such an independent opinion as a means of cross-checking the work\&. .PP It also recommended to give any new branch a name which aids in determining additional details about it\&. Examples of good things to stick into a branch name would be .IP \(bu Developer (nick)name .IP \(bu Ticket hash/reference .IP \(bu One or two keywords applicable to the work .IP \(bu \&.\&.\&. .PP .PP Further, while most development branches are likely quite short-lived, no prohibitions exist against making longer-lived branches\&. Creators should however be mindful that the longer such a branch exists without merges the more divergent they will tend to be, with an associated increase in the effort which will have to be spent on either merging from and merging to trunk\&. .SS "WORKING WITH BRANCHES" In the hope of engendering good work practices now a few example operations which will come up with branches, and their associated fossil command (sequences)\&. .TP \fIAwareness\fR When developing we have to keep ourselves aware of the context of our work\&. On what branch are we ? What files have we changed ? What new files are not yet known to the repository ? What has happened remotely since we used our checkout ? The answers to these questions become especially important when using a long-lived checkout and coming back to it after some time away\&. .sp Commands to answer questions like the above are: .RS .TP \fBfossil pull\fR Get all changes done on the remote since the last pull or sync from it\&. This has to be done first, before any of the commands below\&. .sp Even if the commit in our checkout refers to the branch we want right now control operations committed to the remote may have changed that from underneath us\&. .TP \fBfossil info | grep tags\fR .TP \fBfossil branch list | grep '\\*'\fR Two different ways of determining the branch our checkout is on\&. .TP \fBfossil timeline\fR What have we (and others) done recently ? .sp \fIAttention\fR, this information is very likely outdated, the more the longer we did not use this checkout\&. Run \fBfossil pull\fR first to get latest information from the remote repository of the project\&. .TP \fBfossil timeline current\fR Place the commit our checkout is based on at the top of the timeline\&. .TP \fBfossil changes\fR Lists the files we have changed compared to the commit the checkout is based on\&. .TP \fBfossil extra\fR Lists the files we have in the checkout the repository does not know about\&. This may be leftover chaff from our work, or something we have forgotten to \fBfossil add\fR to the repository yet\&. .RE .TP \fIClean checkouts\fR Be aware of where you are (see first definition)\&. .sp For pretty much all the operation recipes below a clean checkout is at least desired, often required\&. To check that a checkout is clean invoke .CS fossil changes fossil extra .CE .IP How to clean up when uncommitted changes of all sorts are found is context-specific and outside of the scope of this guide\&. .TP \fIStarting a new branch\fR Be aware of where you are (see first definition)\&. .sp Ensure that you have clean checkout (see second definition)\&. It is \fIrequired\fR\&. .sp In most situations you want to be on branch \fItrunk\fR, and you want to be on the latest commit for it\&. To get there use .CS fossil pull fossil update trunk .CE .IP If some other branch is desired as the starting point for the coming work replace \fItrunk\fR in the commands above with the name of that branch\&. .sp With the base line established we now have two ways of creating the new branch, with differing (dis)advantages\&. The simpler way is to .CS fossil branch new NAME_OF_NEW_BRANCH .CE .IP and start developing\&. The advantage here is that you cannot forget to create the branch\&. The disadvantages are that we have a branch commit unchanged from where we branched from, and that we have to use high-handed techniques like hiding or shunning to get rid of the commit should we decide to abandon the work before the first actual commit on the branch\&. .sp The other way of creating the branch is to start developing, and then on the first commit use the option \fB--branch\fR to tell \fBfossil\fR that we are starting a branch now\&. I\&.e\&. run .CS fossil commit --branch NAME_OF_NEW_BRANCH \&.\&.\&. .CE .IP where \fI\&.\&.\&.\fR are any other options used to supply the commit message, files to commit, etc\&. .sp The (dis)advantages are now reversed\&. .sp We have no superflous commit, only what is actually developed\&. The work is hidden until we commit to make our first commit\&. .sp We may forget to use \fB--branch NAME_OF_NEW_BRANCH\fR and then have to correct that oversight via the fossil web interface (I am currently unaware of ways of doing such from the command line, although some magic incantantion of \fBfossil tag create\fR may work)\&. .sp It helps to keep awareness, like checking before any commit that we are on the desired branch\&. .TP \fIMerging a branch into trunk\fR Be aware of where you are (see first definition)\&. .sp Ensure that you have clean checkout (see second definition)\&. In the full-blown sequence (zig-zag) it is \fIrequired\fR, due to the merging from trunk\&. In the shorter sequence it is only desired\&. That said, keeping the checkout clean before any major operations is a good habit to have, in my opinion\&. .sp The full-blown sequencing with checks all the way is to .RS .IP [1] Validate the checkout, i\&.e\&. last commit on your branch\&. Run the full test suite and other validations, fix all the issues which have cropped up\&. .IP [2] Merge the latest state of the \fItrunk\fR (see next definition)\&. .IP [3] Validate the checkout again\&. The incoming trunk changes may have broken something now\&. Do any required fixes\&. .IP [4] Now merge to the trunk using .CS fossil update trunk fossil merge --integrate YOUR_BRANCH .CE .IP [5] At this point the checkout should be in the same state as at the end of point (3) above, because we resolved any issues with the trunk already\&. Thus a simple .CS fossil commit \&.\&.\&. .CE .IP should be sufficient now to commit the merge back and close the branch (due to the \fB--integrate\fR we used on the merge)\&. .sp The more paranoid may validate the checkout a third time before commiting\&. .RE .sp I call this a \fIzig-zag merge\fR because of how the arrows look in the timeline, from trunk to feature branch for the first merge, and then back for the final merge\&. .sp A less paranoid can do what I call a \fIsimple merge\fR, which moves step (2) after step (4) and skips step (3) entirely\&. The resulting shorter sequence is .RS .IP [1] Validate .IP [2] Merge to trunk .IP [3] Validate again .IP [4] Commit to trunk .RE .IP The last step after either zig-zag or plain merge is to .CS fossil sync .CE .IP This saves our work to the remote side, and further gives us any other work done while we were doing our merge\&. It especially allows us to check if we raced somebody else, resulting in a split trunk\&. .sp When that happens we should coordinate with the other developer on who fixes the split, to ensure that we do not race each other again\&. .TP \fIMerging from trunk\fR Be aware of where you are (see first definition)\&. .sp Ensure that you have clean checkout (see second definition)\&. It is \fIrequired\fR\&. .sp In most situations you want to import the latest commit of branch \fItrunk\fR (or other origin)\&. To get it use .CS fossil pull .CE .sp With that done we can now import this commit into our current branch with .CS fossil merge trunk .CE .sp Even if \fBfossil\fR does not report any conflicts it is a good idea to check that the operation has not broken the new and/or changed functionality we are working on\&. .sp With the establishment of a good merge we then save the state with .CS fossil commit \&.\&.\&. .CE .IP before continuing development\&. .PP .SS "VERSION NUMBERS" In Tcllib all changes to a package have to come with an increment of its version number\&. What part is incremented (patchlevel, minor, major version) depends on the kind of change made\&. With multiple changes in a commit the highest "wins"\&. .PP When working in a development branch the version change can be deferred until it is time to merge, and then has to cover all the changes in the branch\&. .PP Below a list of the kinds of changes and their associated version increments: .TP \fID - documentation\fR No increment .TP \fIT - testsuite\fR No increment .TP \fIB - bugfix\fR Patchlevel .TP \fII - implementation tweak\fR Patchlevel .TP \fIP - performance tweak\fR Patchlevel .TP \fIE - backward-compatible extension\fR Minor .TP \fIAPI - incompatible change\fR Major .PP .PP Note that a commit containing a version increment has to mention the new version number in its commit message, as well as the kind of change which caused it\&. .PP Note further that the version number of a package currently exists in three places\&. An increment has to update all of them: .IP [1] The package implementation\&. .IP [2] The package index ("\fIpkgIndex\&.tcl\fR") .IP [3] The package documentation\&. .PP .PP The "\fIsak\&.tcl\fR" command \fBvalidate version\fR helps finding discrepancies between the first two\&. All the other \fBvalidate\fR methods are also of interest to any developer\&. Invoke it with .CS sak\&.tcl help validate .CE to see their documentation\&. .SH "STRUCTURAL OVERVIEW" .SS "MAIN DIRECTORIES" The main directories in the Tcllib toplevel directory and of interest to a developer are: .TP "\fImodules\fR" Each child directory represents one or more packages\&. In the case of the latter the packages are usually related in some way\&. Examples are "\fIbase64\fR", "\fImath\fR", and "\fIstruct\fR", with loose (base64) to strong (math) relations between the packages in the directory\&. .TP "\fIapps\fR" This directory contains all the installable applications, with their documentation\&. Note that this directory is currently \fInot\fR split into sub-directories\&. .TP "\fIexamples\fR" Each child directory "\fIfoo\fR" contains one or more example application for the packages in "\fImodules/foo\fR"\&. These examples are generally not polished enough to be considered for installation\&. .PP .SS "MORE DIRECTORIES" .TP "\fIconfig\fR" This directory contains files supporting the Unix build system, i\&.e\&. "\fIconfigure\fR" and "\fIMakefile\&.in\fR"\&. .TP "\fIdevdoc\fR" This directories contains the doctools sources for the global documentation, like this document and its sibling guides\&. .TP "\fIembedded\fR" This directory contains the entire documentation formatted for \fIHTML\fR and styled to properly mix into the web site generated by fossil for the repository\&. .sp This is the documentation accessible from the Tcllib home directory, represented in the repository as "\fIembedded/index\&.md\fR"\&. .TP "\fIidoc\fR" This directory contains the entire documentation formatted for \fInroff\fR and \fIHTML\fR, the latter without any styling\&. This is the documentation which will be installed\&. .TP "\fIsupport\fR" This directory contains the sources of internal packages and utilities used in the implementation of the "\fIinstaller\&.tcl\fR" and "\fIsak\&.tcl\fR" scripts/tools\&. .PP .SS "TOP FILES" .TP "\fIaclocal\&.m4\fR" .TP "\fIconfigure\fR" .TP "\fIconfigure\&.in\fR" .TP "\fIMakefile\&.in\fR" These four files comprise the Unix build system layered on top of the "\fIinstaller\&.tcl\fR" script\&. .TP "\fIinstaller\&.tcl\fR" The Tcl-based installation script/tool\&. .TP "\fIproject\&.shed\fR" Configuration file for \fISean Wood\fR's \fBPracTcl\fR buildsystem\&. .TP "\fIsak\&.tcl\fR" This is the main tool for developers and release managers, the \fISwiss Army Knife\fR of management operations on the collection\&. .TP "\fIChangeLog\fR" The log of changes to the global support, when the sources were held in \fICVS\fR\&. Not relevant any longer with the switch to the \fIfossil\fR SCM\&. .TP "\fIlicense\&.terms\fR" The license in plain ASCII\&. See also \fITcllib - License\fR for the nicely formatted form\&. The text is identical\&. .TP "\fIREADME\&.md\fR" .TP "\fI\&.github/CONTRIBUTING\&.md\fR" .TP "\fI\&.github/ISSUE_TEMPLATE\&.md\fR" .TP "\fI\&.github/PULL_REQUEST_TEMPLATE\&.md\fR" These markdown-formatted documents are used and shown by the github mirror of these sources, pointing people back to the official location and issue trackers\&. .TP "\fIDESCRIPTION\&.txt\fR" .TP "\fISTATUS\fR" .TP "\fItcllib\&.spec\fR" .TP "\fItcllib\&.tap\fR" .TP "\fItcllib\&.yml\fR" ???? .PP .SS "FILE TYPES" The most common file types, by file extension, are: .TP "\fI\&.tcl\fR" Tcl code for a package, application, or example\&. .TP "\fI\&.man\fR" Doctools-formatted documentation, usually for a package\&. .TP "\fI\&.test\fR" Test suite for a package, or part of\&. Based on \fBtcltest\fR\&. .TP "\fI\&.bench\fR" Performance benchmarks for a package, or part of\&. Based on "\fImodules/bench\fR"\&. .TP "\fI\&.pcx\fR" Syntax rules for \fITclDevKit\fR's \fBtclchecker\fR\&. Using these rules allows the checker to validate the use of commands of a Tcllib package \fBfoo\fR without having to scan the "\fI\&.tcl\fR" files implementing it\&. .PP .SH "TESTSUITE TOOLING" Testsuites in Tcllib are based on Tcl's standard test package \fBtcltest\fR, plus utilities found in the directory "\fImodules/devtools\fR" .PP Tcllib developers invoke the suites through the \fBtest run\fR method of the "\fIsak\&.tcl\fR" tool, with other methods of \fBtest\fR providing management operations, for example setting a list of standard Tcl shells to use\&. .SS "INVOKE THE TESTSUITES OF A SPECIFIC MODULE" Invoke either .CS \&./sak\&.tcl test run foo .CE or .CS \&./sak\&.tcl test run modules/foo .CE to invoke the testsuites found in a specific module "\fIfoo\fR"\&. .SS "INVOKE THE TESTSUITES OF ALL MODULES" Invoke the tool without a module name, i\&.e\&. .CS \&./sak\&.tcl test run .CE to invoke the testsuites of all modules\&. .SS "DETAILED TEST LOGS" In all the previous examples the test runner will write a combination of progress display and testsuite log to the standard output, showing for each module only the tests that passed or failed and how many of each in a summary at the end\&. .PP To get a detailed log, it is necessary to invoke the test runner with additional options\&. .PP For one: .CS \&./sak\&.tcl test run --log LOG foo .CE While this shows the same short log on the terminal as before, it also writes a detailed log to the file "\fILOG\&.log\fR", and excerpts to other files ("\fILOG\&.summary\fR", "\fILOG\&.failures\fR", etc\&.)\&. .PP For two: .CS \&./sak\&.tcl test run -v foo .CE This writes the detailed log to the standard output, instead of the short log\&. .PP Regardless of form, the detailed log contains a list of all test cases executed, which failed, and how they failed (expected versus actual results)\&. .SS "SHELL SELECTION" By default the test runner will use all the Tcl shells specified via \fBtest add\fR to invoke the specified testsuites, if any\&. If no such are specified it will fall back to the Tcl shell used to run the tool itself\&. .PP Use option \fB--shell\fR to explicitly specify the Tcl shell to use, like .CS \&./sak\&.tcl test run --shell /path/to/tclsh \&.\&.\&. .CE .SS HELP Invoke the tool as .CS \&./sak\&.tcl help test .CE to see the detailed help for all methods of \fBtest\fR, and the associated options\&. .SH "DOCUMENTATION TOOLING" The standard format used for documentation of packages and other things in Tcllib is \fIdoctools\fR\&. Its supporting packages are a part of Tcllib, see the directories "\fImodules/doctools\fR" and "\fImodules/dtplite\fR"\&. The latter is an application package, with the actual application "\fIapps/dtplite\fR" a light wrapper around it\&. .PP Tcllib developers gain access to these through the \fBdoc\fR method of the "\fIsak\&.tcl\fR" tool, another (internal) wrapper around the "\fImodules/dtplite\fR" application package\&. .SS "GENERATE DOCUMENTATION FOR A SPECIFIC MODULE" Invoke either .CS \&./sak\&.tcl doc html foo .CE or .CS \&./sak\&.tcl doc html modules/foo .CE to generate HTML for the documentation found in the module "\fIfoo\fR"\&. Instead of \fBhtml\fR any other supported format can be used here, of course\&. .PP The generated formatted documentation will be placed into a directory "\fIdoc\fR" in the current working directory\&. .SS "GENERATE DOCUMENTATION FOR ALL MODULES" Invoke the tool without a module name, i\&.e\&. .CS \&./sak\&.tcl doc html .CE to generate HTML for the documentation found in all modules\&. Instead of \fBhtml\fR any other supported format can be used here, of course\&. .PP The generated formatted documentation will be placed into a directory "\fIdoc\fR" in the current working directory\&. .SS "AVAILABLE OUTPUT FORMATS, HELP" Invoke the tool as .CS \&./sak\&.tcl help doc .CE to see the entire set of supported output formats which can be generated\&. .SS "VALIDATION WITHOUT OUTPUT" Note the special format \fBvalidate\fR\&. .PP Using this value as the name of the format to generate forces the tool to simply check that the documentation is syntactically correct, without generating actual output\&. .PP Invoke it as either .CS \&./sak\&.tcl doc validate (modules/)foo .CE or .CS \&./sak\&.tcl doc validate .CE to either check the packages of a specific module or check all of them\&. .SH "NOTES ON WRITING A TESTSUITE" While previous sections talked about running the testsuites for a module and the packages therein, this has no meaning if the module in question has no testsuites at all\&. .PP This section gives a very basic overview on possible methodologies for writing tests and testsuites\&. .PP First there are "drudgery" tests\&. Written to check absolutely basic assumptions which should never fail\&. .PP For example for a command FOO taking two arguments, three tests calling it with zero, one, and three arguments\&. The basic checks that the command fails if it has not enough arguments, or too many\&. .PP After that come the tests checking things based on our knowledge of the command, about its properties and assumptions\&. Some examples based on the graph operations added during Google's Summer of Code 2009 are: .IP \(bu The BellmanFord command in struct::graph::ops takes a \fIstartnode\fR as argument, and this node should be a node of the graph\&. This equals one test case checking the behavior when the specified node is not a node of the graph\&. .sp This often gives rise to code in the implementation which explicitly checks the assumption and throws an understandable error, instead of letting the algorithm fail later in some weird non-deterministic way\&. .sp It is not always possible to do such checks\&. The graph argument for example is just a command in itself, and while we expect it to exhibit a certain interface, i\&.e\&. a set of sub-commands aka methods, we cannot check that it has them, except by actually trying to use them\&. That is done by the algorithm anyway, so an explicit check is just overhead we can get by without\&. .IP \(bu IIRC one of the distinguishing characteristic of either BellmanFord and/or Johnson is that they are able to handle negative weights\&. Whereas Dijkstra requires positive weights\&. .sp This induces (at least) three testcases \&.\&.\&. Graph with all positive weights, all negative, and a mix of positive and negative weights\&. Thinking further does the algorithm handle the weight \fB0\fR as well ? Another test case, or several, if we mix zero with positive and negative weights\&. .IP \(bu The two algorithms we are currently thinking about are about distances between nodes, and distance can be 'Inf'inity, i\&.e\&. nodes may not be connected\&. This means that good test cases are .RS .IP [1] Strongly connected graph .IP [2] Connected graph .IP [3] Disconnected graph\&. .RE .sp At the extremes of strongly connected and disconnected we have the fully connected graphs and graphs without edges, only nodes, i\&.e\&. completely disconnected\&. .IP \(bu IIRC both of the algorithms take weighted arcs, and fill in a default if arcs are left unweighted in the input graph\&. .sp This also induces three test cases: .RS .IP [1] Graph will all arcs with explicit weights\&. .IP [2] Graph without weights at all\&. .IP [3] Graph with mixture of weighted and unweighted graphs\&. .RE .PP .PP What was described above via examples is called \fIblack-box\fR testing\&. Test cases are designed and written based on the developer's knowledge of the properties of the algorithm and its inputs, without referencing a particular implementation\&. .PP Going further, a complement to \fIblack-box\fR testing is \fIwhite-box\fR\&. For this we know the implementation of the algorithm, we look at it and design our tests cases so that they force the code through all possible paths in the implementation\&. Wherever a decision is made we have a test case forcing a specific direction of the decision, for all possible combinations and directions\&. It is easy to get a combinatorial explosion in the number of needed test-cases\&. .PP In practice I often hope that the black-box tests I have made are enough to cover all the paths, obviating the need for white-box tests\&. .PP The above should be enough to make it clear that writing tests for an algorithm takes at least as much time as coding the algorithm, and often more time\&. Much more time\&. See for example also \fIhttp://sqlite\&.org/testing\&.html\fR, a writeup on how the Sqlite database engine is tested\&. Another article of interest might be \fIhttps://www\&.researchgate\&.net/publication/298896236\fR\&. While geared to a particular numerical algorithm it still shows that even a simple-looking algorithm can lead to an incredible number of test cases\&. .PP An interesting connection is to documentation\&. In one direction, the properties checked with black-box testing are exactly the properties which should be documented in the algorithm's man page\&. And conversely, the documentation of the properties of an algorithm makes a good reference to base the black-box tests on\&. .PP In practice test cases and documentation often get written together, cross-influencing each other\&. And the actual writing of test cases is a mix of black and white box, possibly influencing the implementation while writing the tests\&. Like writing a test for a condition like \fIstartnode not in input graph\fR serving as reminder to put a check for this condition into the code\&. .SH "INSTALLATION TOOLING" A last thing to consider when adding a new package to the collection is installation\&. .PP How to \fIuse\fR the "\fIinstaller\&.tcl\fR" script is documented in \fITcllib - The Installer's Guide\fR\&. .PP Here we document how to extend said installer so that it may install new package(s) and/or application(s)\&. .PP In most cases only a single file has to be modified, the "\fIsupport/installation/modules\&.tcl\fR" holding one command per module and application to install\&. .PP The relevant commands are: .TP \fBModule\fR \fIname\fR \fIcode-action\fR \fIdoc-action\fR \fIexample-action\fR Install the packages of module \fIname\fR, found in "\fImodules/\fIname\fR\fR"\&. .sp The \fIcode-action\fR is responsible for installing the packages and their index\&. The system currently provides .RS .TP \fB_tcl\fR Copy all "\fI\&.tcl\fR" files found in "\fImodules/\fIname\fR\fR" into the installation\&. .TP \fB_tcr\fR As \fB_tcl\fR, copy the "\fI\&.tcl\fR" files found in the subdirectories of "\fImodules/\fIname\fR\fR" as well\&. .TP \fB_tci\fR As \fB_tcl\fR, and copy the "\fItclIndex\&.tcl\fR" file as well\&. .TP \fB_msg\fR As \fB_tcl\fR, and copy the subdirectory "\fImsgs\fR" as well\&. .TP \fB_doc\fR As \fB_tcl\fR, and copy the subdirectory "\fImpformats\fR" as well\&. .TP \fB_tex\fR As \fB_tcl\fR, and copy "\fI\&.tex\fR" files as well\&. .RE .sp The \fIdoc-action\fR is responsible for installing the package documentation\&. The system currently provides .RS .TP \fB_null\fR No documentation available, do nothing\&. .TP \fB_man\fR Process the "\fI\&.man\fR" files found in "\fImodules/\fIname\fR\fR" and install the results (nroff and/or HTML) in the proper location, as given to the installer\&. .sp This is actually a fallback, normally the installer uses the pre-made formatted documentation found under "\fIidoc\fR"\&. .RE .sp The \fIexample-action\fR is responsible for installing the examples\&. The system currently provides .RS .TP \fB_null\fR No examples available, do nothing\&. .TP \fB_exa\fR Copy the the directory "\fIexamples/\fIname\fR\fR" recursively to the install location for examples\&. .RE .TP \fBApplication\fR \fIname\fR Install the application with \fIname\fR, found in "\fIapps\fR"\&. .TP \fBExclude\fR \fIname\fR This command signals to the installer which of the listed modules to \fInot\fR install\&. I\&.e\&. they name the deprecated modules of Tcllib\&. .PP .PP If, and only if the above actions are not suitable for the new module then a second file has to be modified, "\fIsupport/installation/actions\&.tcl\fR"\&. .PP This file contains the implementations of the available actions, and is the place where any custom action needed to handle the special circumstances of module has to be added\&. |
Added idoc/man/files/devdoc/tcllib_installer.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'tcllib_installer\&.man' by tcllib/doctools with format 'nroff' '\" .TH "tcllib_install_guide" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME tcllib_install_guide \- Tcllib - The Installer's Guide .SH DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\&. Note that Tcllib is not a package itself\&. It is a collection of (semi-independent) \fITcl\fR packages that provide utility functions useful to a large collection of Tcl programmers\&. .PP The audience of this document is anyone wishing to build and install the packages found in Tcllib, for either themselves, or others\&. .PP For developers intending to work on the packages themselves we additionally provide .IP [1] \fITcllib - The Developer's Guide\fR\&. .PP .PP Please read \fITcllib - How To Get The Sources\fR first, if that was not done already\&. Here we assume that the sources are already available in a directory of your choice\&. .PP .SH REQUISITES Before Tcllib can be build and used a number of requisites must be installed\&. These are: .IP [1] The scripting language Tcl\&. For details see \fBTcl\fR\&. .IP [2] Optionally, the \fBcritcl\fR package (C embedding) for \fBTcl\fR\&. For details see \fBCriTcl\fR\&. .PP 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\&. .SS 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\&. .PP Out of the many possibilities use whatever you are comfortable with, as long as it provides at the very least 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\&. .PP \fINote\fR 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 \fIpackage not found\fR errors, as their package index files will not register them in versions of the core unable to use them\&. .PP Myself, I used (and still use) \fIActiveState's\fR [http://www\&.activestate\&.com] ActiveTcl 8\&.5 distribution during development, as I am most familiar with it\&. .PP \fI(Disclosure: I, Andreas Kupries, worked for ActiveState until 2016, maintaining ActiveTcl and TclDevKit for them)\&.\fR\&. I am currently working for SUSE Software Canada ULC, although not in Tcl-related areas\&. .PP This distribution can be found at \fIhttp://www\&.activestate\&.com/activetcl\fR\&. Retrieve the archive of ActiveTcl 8\&.5 (or higher) for your platform and install it as directed by ActiveState\&. .PP For those wishing to build and install Tcl on their own, the relevant sources can be found at .TP Tcl \fIhttp://core\&.tcl-lang\&.org/tcl/\fR .PP together with the necessary instructions on how to build it\&. .PP If there are problems with building, installing, or using Tcl, please file a ticket against \fITcl\fR, or the vendor of your distribution, and \fInot\fR \fITcllib\fR\&. .SS CRITCL The \fBcritcl\fR tool is an \fIoptional\fR dependency\&. .PP It is only required when trying to build the C-based \fIaccelerators\fR for a number of packages, as explained in \fBCritcl & Accelerators\fR .PP Tcllib's build system looks for it in the , using the name \fBcritcl\fR\&. This is for Unix\&. On Windows on the other hand the search is more complex\&. First we look for a proper application \fBcritcl\&.exe\fR\&. When that is not found we look for a combination of interpreter (\fBtclkitsh\&.exe\fR, \fBtclsh\&.exe\fR) and starkit (\fBcritcl\&.kit\fR, \fBcritcl\fR) instead\&. \fINote\fR that the choice of starkit can be overriden via the environment variable \&. .PP Tcllib requires Critcl version 2 or higher\&. .PP The github repository providing releases of version 2 and higher, and the associated sources, can be found at \fIhttp://andreas-kupries\&.github\&.com/critcl\fR\&. .PP Any branch of the repository can be used (if not using the prebuild starkit or starpack), although the use of the stable branch \fImaster\fR is recommended\&. .PP At the above url is also an explanation on how to build and install Critcl, including a list of its dependencies\&. .PP Its instructions will not be repeated here\&. If there are problems with these directions please file a ticket against the \fICritcl\fR project, and not Tcllib\&. .SH "BUILD & INSTALLATION INSTRUCTIONS" As Tcllib is mainly a bundle of packages written in pure Tcl building it is the same as installing it\&. The exceptions to this have their own subsection, \fBCritcl & Accelerators\fR, later on\&. .PP Before that however comes the standard case, differentiated by the platforms with material differences in the instruction, i\&.e\&. \fIUnix\fR-like, versus \fIWindows\fR\&. .PP Regarding the latter it should also be noted that it is possible set up an \fIUnix\fR-like environment using projects like \fIMSYS\fR, \fICygwin\fR, and others\&. In that case the user has the choice of which instructions to follow\&. .PP Regardless of environment or platform, a suitable \fITcl\fR has to be installed, and its \fBtclsh\fR should be placed on the (\fIUnix\fR) or associated with "\fI\&.tcl\fR" files (\fIWindows\fR)\&. .SS "INSTALLING ON UNIX" For \fIUnix\fR-like environments Tcllib comes with the standard set of files to make .CS \&./configure make install .CE a suitable way of installing it\&. This is a standard non-interactive install automatically figuring out where to place everything, i\&.e\&. packages, applications, and the manpages\&. .PP To get a graphical installer invoke .CS \&./installer\&.tcl .CE instead\&. .SS "INSTALLING ON WINDOWS" In a Windows environment we have the \fBinstaller\&.tcl\fR script to perform installation\&. .PP If the desired \fBtclsh\fR is associated "\fI\&.tcl\fR" files then double-clicking / opening the \fBinstaller\&.tcl\fR is enough to invoke it in graphical mode\&. This assumes that \fITk\fR is installed and available as well\&. .PP Without \fITk\fR the only way to invoke the installer are to open a DOS window, i\&.e\&. \fBcmd\&.exe\fR, and then to invoke .CS \&./installer\&.tcl .CE inside it\&. .SS "CRITCL & ACCELERATORS" While the majority of Tcllib consists of packages written in pure Tcl a number of packages also have \fIaccelerators\fR associated with them\&. These are \fBcritcl\fR-based C packages whose use will boost the performance of the packages using them\&. These accelerators are optional, and they are not installed by default\&. .PP To build the accelerators the normally optional dependency on \fBcritcl\fR becomes required\&. .PP To build and install Tcllib with the accelerators in a Unix-like environment invoke: .CS \&./configure make critcl # This builds the shared library holding # the accelerators make install .CE .PP The underlying tool is "\fIsak\&.tcl\fR" in the toplevel directory of Tcllib and the command \fBmake critcl\fR is just a wrapper around .CS \&./sak\&.tcl critcl .CE .PP Therefore in a Windows environment instead invoke .CS \&./sak\&.tcl critcl \&./installer\&.tcl .CE from within a DOS window, i\&.e\&. \fBcmd\&.exe\fR\&. .SS TOOLING The core of Tcllib's build system is the script "\fIinstaller\&.tcl\fR" found in the toplevel directory of a checkout or release\&. .PP The .CS configure ; make install .CE setup available to developers on Unix-like systems is just a wrapper around it\&. To go beyond the standard embodied in the wrapper it is necessary to directly invoke this script\&. .PP On Windows system using it directly is the only way to invoke it\&. .PP For basic help invoke it as .CS \&./installer\&.tcl -help .CE This will print a short list of all the available options to the standard output channel\&. .PP The commands associated with the various \fIinstall\fR targets in the \fIMakefile\&.in\fR for Unix can be used as additional examples on how to use this tool as well\&. .PP The installer can operate in GUI and CLI modes\&. By default it chooses the mode automatically, based on if the Tcl package \fBTk\fR can be used or not\&. The option \fB-no-gui\fR can be used to force CLI mode\&. .PP Note that it is possible to specify options on the command line even if the installer ultimatively selects GUI mode\&. In that case the hardwired defaults and the options determine the data presented to the user for editing\&. .PP The installer will select a number of defaults for the locations of packages, examples, and documentation, and also the format of the documentation\&. The user can overide these defaults in the GUI, or by specifying additional options\&. The defaults depend on the platform detected (Unix/Windows) and on the \fBtclsh\fR executable used to run the installer\&. .PP \fIOptions\fR .TP \fB-help\fR Show the list of options explained here on the standard output channel and exit\&. .TP \fB+excluded\fR Include deprecated packages in the installation\&. .TP \fB-no-gui\fR Force command line operation of the installer .TP \fB-no-wait\fR In CLI mode the installer will by default ask the user to confirm that the chosen configuration (destination paths, things to install) is correct before performing any action\&. Using this option causes the installer to skip this query and immediately jump to installation\&. .TP \fB-app-path\fR \fIpath\fR .TP \fB-example-path\fR \fIpath\fR .TP \fB-html-path\fR \fIpath\fR .TP \fB-nroff-path\fR \fIpath\fR .TP \fB-pkg-path\fR \fIpath\fR Declare the destination paths for the applications, examples, html documentation, nroff manpages, and packages\&. The defaults are derived from the location of the \fBtclsh\fR used to run the installer\&. .TP \fB-dry-run\fR .TP \fB-simulate\fR Run the installer without modifying the destination directories\&. .TP \fB-apps\fR .TP \fB-no-apps\fR .TP \fB-examples\fR .TP \fB-no-examples\fR .TP \fB-pkgs\fR .TP \fB-no-pkgs\fR .TP \fB-html\fR .TP \fB-no-html\fR .TP \fB-nroff\fR .TP \fB-no-nroff\fR (De)activate the installation of applications, examples, packages, html documentation, and nroff manpages\&. .sp Applications, examples, and packages are installed by default\&. .sp On Windows the html documentation is installed by default\&. .sp On Unix the nroff manpages are installed by default\&. .PP |
Added idoc/man/files/devdoc/tcllib_license.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'tcllib_license\&.man' by tcllib/doctools with format 'nroff' '\" .TH "tcllib_license" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME tcllib_license \- Tcllib - License .SH DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\&. Note that Tcllib is not a package itself\&. It is a collection of (semi-independent) \fITcl\fR packages that provide utility functions useful to a large collection of Tcl programmers\&. .PP The collection is under the BSD license\&. .SH LICENSE .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. .PP 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\&. |
Added idoc/man/files/devdoc/tcllib_releasemgr.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'tcllib_releasemgr\&.man' by tcllib/doctools with format 'nroff' '\" .TH "tcllib_releasemgr" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME tcllib_releasemgr \- Tcllib - The Release Manager's Guide .SH DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\&. Note that Tcllib is not a package itself\&. It is a collection of (semi-independent) \fITcl\fR packages that provide utility functions useful to a large collection of Tcl programmers\&. .PP The audience of this document is the release manager for Tcllib, their deputies, and anybody else interested in the task of creating an official release of Tcllib for distribution\&. .PP Please read \fITcllib - How To Get The Sources\fR first, if that was not done already\&. Here we assume that the sources are already available in a directory of your choice\&. .PP .SH TOOLS The "\fIsak\&.tcl\fR" script in the toplevel directory of a Tcllib checkout is the one tool used by the release manager to perform its \fBTasks\fR\&. .PP The main commands to be used are .CS sak\&.tcl validate sak\&.tcl test run sak\&.tcl review sak\&.tcl readme sak\&.tcl localdoc sak\&.tcl release .CE More detail will be provided in the explanations of the various \fBTasks\fR\&. .SH TASKS .SS "START A RELEASE CANDIDATE" todo: open a candidate for release .SS "READY THE CANDIDATE" todo: test, validate and check that the candidate is worthy of release fix testsuites, possibly fix packages, documentation regenerate docs coordinate with package maintainers wrt fixes big thing: going over the packages, classify changes since last release to generate a nice readme\&. .SS "MAKE IT OFFICIAL" todo: finalize release, make candidate official .SS "DISTRIBUTE THE RELEASE" With the release made it has to be published and the world notified of its existence\&. .IP [1] Create a proper fossil event for the release, via \fIhttp://core\&.tcl-lang\&.org/tcllib/eventedit\fR\&. .sp An \fIexisting event\fR [http://core\&.tcl-lang\&.org/tcllib/event/dac0ddcd2e990234143196b4dc438fe01e7b9817] should be used as template\&. .IP [2] Update a number of web locations: .RS .IP [1] \fIHome page\fR [http://core\&.tcl-lang\&.org/tcllib/doc/trunk/embedded/index\&.md] .IP [2] \fIDownloads\fR [http://core\&.tcl-lang\&.org/tcllib/wiki?name=Downloads] .IP [3] \fIPast Releases\fR [http://core\&.tcl-lang\&.org/tcllib/wiki?name=Past+Releases] .IP [4] \fIhttp://www\&.tcl-lang\&.org/home/release\&.txt\fR .IP [5] \fIhttp://www\&.tcl-lang\&.org/software/tcllib/*\&.tml\fR .IP [6] \fIhttp://wiki\&.tcl-lang\&.org/page/Tcllib\fR .RE .IP The first location maps to the file "\fIembedded/index\&.md\fR" in the repository itself, as such it can edited as part of the release process\&. This is where reference to the new fossil event is added, as the new current release\&. .sp The next two locations are in the fossil tcllib wiki and require admin or wiki write permissions for \fIhttp://core\&.tcl-lang\&.org/tcllib\fR\&. .sp The last two locations require ssh access to \fIhttp://www\&.tcl-lang\&.org\fR and permission to edit files in the web area\&. .IP [3] ***TODO*** mailing lists and other places to send notes to\&. .PP |
Added idoc/man/files/devdoc/tcllib_sources.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'tcllib_sources\&.man' by tcllib/doctools with format 'nroff' '\" .TH "tcllib_sources" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME tcllib_sources \- Tcllib - How To Get The Sources .SH DESCRIPTION Welcome to Tcllib, the Tcl Standard Library\&. Note that Tcllib is not a package itself\&. It is a collection of (semi-independent) \fITcl\fR packages that provide utility functions useful to a large collection of Tcl programmers\&. .PP 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\&. .PP For builders and developers we additionally provide .IP [1] \fITcllib - The Installer's Guide\fR\&. .IP [2] \fITcllib - The Developer's Guide\fR\&. .PP respectively\&. .SH "SOURCE LOCATION" The official repository for Tcllib can be found at \fIhttp://core\&.tcl-lang\&.org/tcllib\fR .SH RETRIEVAL Assuming that you simply wish to look at the sources, or build a specific revision, the easiest way of retrieving it is to: .IP [1] Log into this site, as "anonymous", using the semi-random password in the captcha\&. .IP [2] Go to the "Timeline"\&. .IP [3] Choose the revision you wish to have\&. .IP [4] Follow its link to its detailed information page\&. .IP [5] On that page, choose either the "ZIP" or "Tarball" link to get a copy of this revision in the format of your choice\&. .PP .SH "SOURCE CODE MANAGEMENT" For the curious (or a developer-to-be), the sources are managed by the \fIFossil SCM\fR [http://www\&.fossil-scm\&.org]\&. Binaries for popular platforms can be found directly at its \fIdownload page\fR [http://www\&.fossil-scm\&.org/download\&.html]\&. .PP With that tool available the full history can be retrieved via: .CS fossil clone http://core\&.tcl-lang\&.org/tcllib tcllib\&.fossil .CE followed by .CS mkdir tcllib cd tcllib fossil open \&.\&./tcllib\&.fossil .CE to get a checkout of the head of the trunk\&. |
Changes to idoc/man/files/modules/dicttool/dicttool.n.
︙ | ︙ | |||
272 273 274 275 276 277 278 279 280 281 282 283 284 285 | .. .BS .SH NAME dicttool \- Dictionary Tools .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp \fBladd\fR \fIvarname\fR \fIargs\fR .sp \fBldelete\fR \fIvarname\fR \fIargs\fR .sp \fBdict getnull\fR \fIargs\fR .sp \fBdict print\fR \fIdict\fR | > > | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | .. .BS .SH NAME dicttool \- Dictionary Tools .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBdicttool ?1\&.0?\fR .sp \fBladd\fR \fIvarname\fR \fIargs\fR .sp \fBldelete\fR \fIvarname\fR \fIargs\fR .sp \fBdict getnull\fR \fIargs\fR .sp \fBdict print\fR \fIdict\fR |
︙ | ︙ | |||
297 298 299 300 301 302 303 | just in case any of these slip into the core\&. .TP \fBladd\fR \fIvarname\fR \fIargs\fR This command will add a new instance of each element in \fIargs\fR to \fIvarname\fR, but only if that element is not already present\&. .TP \fBldelete\fR \fIvarname\fR \fIargs\fR | | | 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | just in case any of these slip into the core\&. .TP \fBladd\fR \fIvarname\fR \fIargs\fR This command will add a new instance of each element in \fIargs\fR to \fIvarname\fR, but only if that element is not already present\&. .TP \fBldelete\fR \fIvarname\fR \fIargs\fR This command will delete all instances of each element in \fIargs\fR from \fIvarname\fR\&. .TP \fBdict getnull\fR \fIargs\fR Operates like \fBdict get\fR, however if the key \fIargs\fR does not exist, it returns an empty list instead of throwing an error\&. .TP \fBdict print\fR \fIdict\fR This command will produce a string representation of \fIdict\fR, with each nested branch on |
︙ | ︙ |
Changes to idoc/man/files/modules/doctools/docidx_lang_intro.n.
︙ | ︙ | |||
297 298 299 300 301 302 303 | \&.\&.\&. [key {markup language}] \&.\&.\&. .CE .CS | | | 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | \&.\&.\&. [key {markup language}] \&.\&.\&. .CE .CS \&.\&.\&. [manpage thefile \\ {file description}] \&.\&.\&. .CE .SS "BASIC STRUCTURE" The most simple document which can be written in docidx is .CS |
︙ | ︙ |
Changes to idoc/man/files/modules/doctools/doctoc_lang_intro.n.
︙ | ︙ | |||
297 298 299 300 301 302 303 | \&.\&.\&. [division_start {Appendix 1}] \&.\&.\&. .CE .CS | | | 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | \&.\&.\&. [division_start {Appendix 1}] \&.\&.\&. .CE .CS \&.\&.\&. [item thefile \\ label {file description}] \&.\&.\&. .CE .SS "BASIC STRUCTURE" The most simple document which can be written in doctoc is .CS |
︙ | ︙ |
Changes to idoc/man/files/modules/doctools/doctools.n.
1 2 3 4 | '\" '\" Generated from file 'doctools\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2003-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'doctools\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2003-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools" n 1\&.5\&.6 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME doctools \- doctools - Processing documents .SH SYNOPSIS package require \fBTcl 8\&.2\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME doctools \- doctools - Processing documents .SH SYNOPSIS package require \fBTcl 8\&.2\fR .sp package require \fBdoctools ?1\&.5\&.6?\fR .sp \fB::doctools::new\fR \fIobjectName\fR ?\fIoption value\fR\&.\&.\&.? .sp \fB::doctools::help\fR .sp \fB::doctools::search\fR \fIpath\fR .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/doctools/doctools_lang_intro.n.
︙ | ︙ | |||
296 297 298 299 300 301 302 | \&.\&.\&. [list_begin enumerated] \&.\&.\&. .CE .CS | | | 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | \&.\&.\&. [list_begin enumerated] \&.\&.\&. .CE .CS \&.\&.\&. [call [cmd foo] \\ [arg bar]] \&.\&.\&. .CE .CS \&.\&.\&. [term {complex concept}] \&.\&.\&. |
︙ | ︙ | |||
330 331 332 333 334 335 336 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] | | | 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] [include \&.\&./common-text/feedback\&.inc] [manpage_end] .CE This also shows us that all doctools documents are split into two parts, the \fIheader\fR and the \fIbody\fR\&. Everything coming before [\fBdescription\fR] belongs to the header, and everything coming after belongs to the body, with the whole document bracketed by the |
︙ | ︙ | |||
389 390 391 392 393 394 395 | .CS [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] | | | 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 | .CS [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] [include \&.\&./common-text/feedback\&.inc] [manpage_end] .CE has the same meaning as the example before\&. .PP On the other hand, if \fIwhitespace\fR is present it consists not only of any sequence of characters containing the space character, |
︙ | ︙ |
Changes to idoc/man/files/modules/doctools2idx/export_docidx.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export::docidx" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME doctools::idx::export::docidx \- docidx export plugin .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME doctools::idx::export::docidx \- docidx export plugin .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp package require \fBdoctools::idx::export::docidx ?0\&.2\&.1?\fR .sp \fBexport\fR \fIserial\fR \fIconfiguration\fR .sp .BE .SH DESCRIPTION This package implements the doctools keyword index export plugin for the generation of docidx markup\&. |
︙ | ︙ | |||
464 465 466 467 468 469 470 | left-most button in the secondary navigation bar\&. .SH KEYWORDS docidx, doctools, export, index, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 464 465 466 467 468 469 470 471 472 473 | left-most button in the secondary navigation bar\&. .SH KEYWORDS docidx, doctools, export, index, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_export.n.
1 2 | '\" '\" Generated from file 'idx_export\&.man' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'idx_export\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::idx::export \- Exporting keyword indices .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | .de MT .QW "" .. .BS .SH NAME doctools::idx::export \- Exporting keyword indices .SH SYNOPSIS package require \fBdoctools::idx::export ?0\&.2\&.1?\fR .sp package require \fBTcl 8\&.4\fR .sp package require \fBstruct::map \fR .sp package require \fBdoctools::idx::structure \fR .sp package require \fBsnit \fR .sp package require \fBpluginmgr \fR .sp |
︙ | ︙ | |||
670 671 672 673 674 675 676 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, conversion, docidx, documentation, export, formatting, generation, index, json, keyword index, manpage, markup, nroff, plugin, reference, tcler's wiki, text, url, wiki .SH CATEGORY Documentation tools .SH COPYRIGHT .nf | | | 670 671 672 673 674 675 676 677 678 679 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, conversion, docidx, documentation, export, formatting, generation, index, json, keyword index, manpage, markup, nroff, plugin, reference, tcler's wiki, text, url, wiki .SH CATEGORY Documentation tools .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_export_html.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export::html" n 0\&.2 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
549 550 551 552 553 554 555 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, doctools, export, index, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 549 550 551 552 553 554 555 556 557 558 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, doctools, export, index, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_export_json.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export::json" n 0\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
481 482 483 484 485 486 487 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, doctools, export, index, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 481 482 483 484 485 486 487 488 489 490 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, doctools, export, index, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_export_nroff.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export::nroff" n 0\&.3 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
432 433 434 435 436 437 438 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, index, nroff, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 432 433 434 435 436 437 438 439 440 441 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, index, nroff, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_export_text.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export::text" n 0\&.2 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
416 417 418 419 420 421 422 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, index, plain text, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 416 417 418 419 420 421 422 423 424 425 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, index, plain text, serialization .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_export_wiki.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::export::wiki" n 0\&.2 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
429 430 431 432 433 434 435 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, index, serialization, wiki .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 429 430 431 432 433 434 435 436 437 438 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, index, serialization, wiki .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_import.n.
1 2 | '\" '\" Generated from file 'idx_import\&.man' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'idx_import\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::import" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::idx::import \- Importing keyword indices .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | .de MT .QW "" .. .BS .SH NAME doctools::idx::import \- Importing keyword indices .SH SYNOPSIS package require \fBdoctools::idx::import ?0\&.2\&.1?\fR .sp package require \fBTcl 8\&.4\fR .sp package require \fBstruct::map \fR .sp package require \fBdoctools::idx::structure \fR .sp package require \fBsnit \fR .sp package require \fBpluginmgr \fR .sp |
︙ | ︙ | |||
749 750 751 752 753 754 755 | left-most button in the secondary navigation bar\&. .SH KEYWORDS conversion, docidx, documentation, import, index, json, keyword index, manpage, markup, parsing, plugin, reference, url .SH CATEGORY Documentation tools .SH COPYRIGHT .nf | | | 749 750 751 752 753 754 755 756 757 758 | left-most button in the secondary navigation bar\&. .SH KEYWORDS conversion, docidx, documentation, import, index, json, keyword index, manpage, markup, parsing, plugin, reference, url .SH CATEGORY Documentation tools .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_import_json.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::import::json" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::idx::import::json \- JSON import plugin .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .de MT .QW "" .. .BS .SH NAME doctools::idx::import::json \- JSON import plugin .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBdoctools::idx::import::json ?0\&.2\&.1?\fR .sp package require \fBdoctools::idx::structure \fR .sp package require \fBjson \fR .sp \fBimport\fR \fIstring\fR \fIconfiguration\fR .sp |
︙ | ︙ | |||
458 459 460 461 462 463 464 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, deserialization, doctools, import, index .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 458 459 460 461 462 463 464 465 466 467 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, deserialization, doctools, import, index .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2idx/idx_introduction.n.
︙ | ︙ | |||
369 370 371 372 373 374 375 | ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | | | | 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct::map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::idx::export::<*> | | | doctools::idx::import::<*> docidx | | | docidx, json json | | | | \\ html | | | doctools::idx::parse \\ nroff | | | | \\ wiki | | | +---------------+ json text | | | | | doctools::idx::structure | | +-------+---------------+ | | doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat |
︙ | ︙ |
Changes to idoc/man/files/modules/doctools2idx/import_docidx.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::idx::import::docidx" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::idx::import::docidx \- docidx import plugin .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .de MT .QW "" .. .BS .SH NAME doctools::idx::import::docidx \- docidx import plugin .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBdoctools::idx::import::docidx ?0\&.2\&.1?\fR .sp package require \fBdoctools::idx::parse \fR .sp package require \fBdoctools::idx::structure \fR .sp package require \fBdoctools::msgcat \fR .sp |
︙ | ︙ | |||
440 441 442 443 444 445 446 | left-most button in the secondary navigation bar\&. .SH KEYWORDS deserialization, docidx, doctools, import, index .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 440 441 442 443 444 445 446 447 448 449 | left-most button in the secondary navigation bar\&. .SH KEYWORDS deserialization, docidx, doctools, import, index .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/export_doctoc.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export::doctoc" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME doctools::toc::export::doctoc \- doctoc export plugin .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME doctools::toc::export::doctoc \- doctoc export plugin .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp package require \fBdoctools::toc::export::doctoc ?0\&.2\&.1?\fR .sp \fBexport\fR \fIserial\fR \fIconfiguration\fR .sp .BE .SH DESCRIPTION This package implements the doctools table of contents export plugin for the generation of doctoc markup\&. |
︙ | ︙ | |||
491 492 493 494 495 496 497 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctoc, doctools, export, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 491 492 493 494 495 496 497 498 499 500 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctoc, doctools, export, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/import_doctoc.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::import::doctoc" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::toc::import::doctoc \- doctoc import plugin .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .de MT .QW "" .. .BS .SH NAME doctools::toc::import::doctoc \- doctoc import plugin .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBdoctools::toc::import::doctoc ?0\&.2\&.1?\fR .sp package require \fBdoctools::toc::parse \fR .sp package require \fBdoctools::toc::structure \fR .sp package require \fBdoctools::msgcat \fR .sp |
︙ | ︙ | |||
468 469 470 471 472 473 474 | left-most button in the secondary navigation bar\&. .SH KEYWORDS deserialization, doctoc, doctools, import, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 468 469 470 471 472 473 474 475 476 477 | left-most button in the secondary navigation bar\&. .SH KEYWORDS deserialization, doctoc, doctools, import, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_export.n.
1 2 | '\" '\" Generated from file 'toc_export\&.man' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'toc_export\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::toc::export \- Exporting tables of contents .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | .de MT .QW "" .. .BS .SH NAME doctools::toc::export \- Exporting tables of contents .SH SYNOPSIS package require \fBdoctools::toc::export ?0\&.2\&.1?\fR .sp package require \fBTcl 8\&.4\fR .sp package require \fBstruct::map \fR .sp package require \fBdoctools::toc::structure \fR .sp package require \fBsnit \fR .sp package require \fBpluginmgr \fR .sp |
︙ | ︙ | |||
687 688 689 690 691 692 693 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, conversion, doctoc, documentation, export, formatting, generation, json, manpage, markup, nroff, plugin, reference, table, table of contents, tcler's wiki, text, url, wiki .SH CATEGORY Documentation tools .SH COPYRIGHT .nf | | | 687 688 689 690 691 692 693 694 695 696 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, conversion, doctoc, documentation, export, formatting, generation, json, manpage, markup, nroff, plugin, reference, table, table of contents, tcler's wiki, text, url, wiki .SH CATEGORY Documentation tools .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_export_html.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export::html" n 0\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
541 542 543 544 545 546 547 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, doctools, export, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 541 542 543 544 545 546 547 548 549 550 | left-most button in the secondary navigation bar\&. .SH KEYWORDS HTML, doctools, export, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_export_json.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export::json" n 0\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
529 530 531 532 533 534 535 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, doctools, export, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 529 530 531 532 533 534 535 536 537 538 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, doctools, export, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_export_nroff.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export::nroff" n 0\&.2 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
460 461 462 463 464 465 466 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, nroff, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 460 461 462 463 464 465 466 467 468 469 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, nroff, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_export_text.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export::text" n 0\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
443 444 445 446 447 448 449 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, plain text, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 443 444 445 446 447 448 449 450 451 452 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, plain text, serialization, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_export_wiki.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | 1 2 3 4 5 6 7 8 9 10 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::export::wiki" n 0\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. |
︙ | ︙ | |||
449 450 451 452 453 454 455 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, serialization, table of contents, toc, wiki .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 449 450 451 452 453 454 455 456 457 458 | left-most button in the secondary navigation bar\&. .SH KEYWORDS doctools, export, serialization, table of contents, toc, wiki .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_import.n.
1 2 | '\" '\" Generated from file 'toc_import\&.man' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'toc_import\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::import" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::toc::import \- Importing keyword indices .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | .de MT .QW "" .. .BS .SH NAME doctools::toc::import \- Importing keyword indices .SH SYNOPSIS package require \fBdoctools::toc::import ?0\&.2\&.1?\fR .sp package require \fBTcl 8\&.4\fR .sp package require \fBstruct::map \fR .sp package require \fBdoctools::toc::structure \fR .sp package require \fBsnit \fR .sp package require \fBpluginmgr \fR .sp |
︙ | ︙ | |||
768 769 770 771 772 773 774 | left-most button in the secondary navigation bar\&. .SH KEYWORDS conversion, doctoc, documentation, import, json, manpage, markup, parsing, plugin, reference, table, table of contents, url .SH CATEGORY Documentation tools .SH COPYRIGHT .nf | | | 768 769 770 771 772 773 774 775 776 777 | left-most button in the secondary navigation bar\&. .SH KEYWORDS conversion, doctoc, documentation, import, json, manpage, markup, parsing, plugin, reference, table, table of contents, url .SH CATEGORY Documentation tools .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_import_json.n.
1 2 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'plugin\&.inc' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "doctools::toc::import::json" n 0\&.2\&.1 tcllib "Documentation tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
270 271 272 273 274 275 276 | .de MT .QW "" .. .BS .SH NAME doctools::toc::import::json \- JSON import plugin .SH SYNOPSIS | | | | 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .de MT .QW "" .. .BS .SH NAME doctools::toc::import::json \- JSON import plugin .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBdoctools::toc::import::json ?0\&.2\&.1?\fR .sp package require \fBdoctools::toc::structure \fR .sp package require \fBjson \fR .sp \fBimport\fR \fIstring\fR \fIconfiguration\fR .sp |
︙ | ︙ | |||
506 507 508 509 510 511 512 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, deserialization, doctools, import, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf | | | 506 507 508 509 510 511 512 513 514 515 | left-most button in the secondary navigation bar\&. .SH KEYWORDS JSON, deserialization, doctools, import, table of contents, toc .SH CATEGORY Text formatter plugin .SH COPYRIGHT .nf Copyright (c) 2009-2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Changes to idoc/man/files/modules/doctools2toc/toc_introduction.n.
︙ | ︙ | |||
369 370 371 372 373 374 375 | ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | | | | 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct:map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::toc::export::<*> | | | doctools::toc::import::<*> doctoc | | | doctoc, json json | | | | \\ html | | | doctools::toc::parse \\ nroff | | | | \\ wiki | | | +---------------+ json text | | | | | doctools::toc::structure | | +-------+---------------+ | | doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat |
︙ | ︙ |
Changes to idoc/man/files/modules/fileutil/multiop.n.
︙ | ︙ | |||
632 633 634 635 636 637 638 | .PP .SH EXAMPLES The following examples assume that the variable \fBF\fR contains a reference to a multi-file operation object\&. .CS | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | .PP .SH EXAMPLES The following examples assume that the variable \fBF\fR contains a reference to a multi-file operation object\&. .CS $F do copy \\ the *\&.dll \\ from c:/TDK/PrivateOpenSSL/bin \\ to [installdir_of tls] .CE .CS $F do move \\ the * \\ from /sources \\ into /scratch \\ but not *\&.html # Alternatively use 'except for *\&.html'\&. .CE .CS $F do \\ move \\ the index \\ from /sources \\ into /scratch \\ as pkgIndex\&.tcl .CE .CS $F do \\ remove \\ the *\&.txt \\ in /scratch .CE Note that the fact that most commands just modify the object state allows us to use more off forms as specifications instead of just nearly-natural language sentences\&. For example the second example in this section can re-arranged into: .CS $F do \\ from /sources \\ into /scratch \\ but not *\&.html \\ move \\ the * .CE and the result is not only still a valid specification, but even stays relatively readable\&. .PP Further note that the information collected by the commands \fBbut\fR, \fBexcept\fR, and \fBas\fR is automatically reset after the associated \fBthe\fR was executed\&. However no other state is reset in that manner, allowing the user to avoid repetitions of unchanging information\&. For example the second and third examples of this section can be merged and rewritten into the equivalent: .CS $F do \\ move \\ the * \\ from /sources \\ into /scratch \\ but not *\&.html not index \\ the index \\ as pkgIndex\&.tcl .CE .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fIfileutil\fR of the |
︙ | ︙ |
Added idoc/man/files/modules/fileutil/paths.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'paths\&.man' by tcllib/doctools with format 'nroff' '\" .TH "fileutil::paths" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME fileutil::paths \- Manage search path pools .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp package require \fBfileutil::paths ?1?\fR .sp \fB::fileutil::paths\fR \fIpoolName\fR .sp \fBpoolName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? .sp \fIpoolName\fR \fBadd\fR \fIpath\fR .sp \fIpoolName\fR \fBclear\fR .sp \fIpoolName\fR \fBpaths\fR .sp \fIpoolName\fR \fBremove\fR \fIpath\fR .sp .BE .SH DESCRIPTION Provides a snit class whose instances manage a pool of (search) paths\&. .SH API The main command provides construction of search path pools: .TP \fB::fileutil::paths\fR \fIpoolName\fR Creates a new, empty pool of search paths with an associated global Tcl command whose name is \fIpoolName\fR\&. It may be used to invoke various operations on the pool\&. It has the following general form: .RS .TP \fBpoolName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? \fBmethod\fR and \fIarg\fRuments determine the exact behavior of the command\&. .RE .IP If \fIpoolName\fR is specified as \fB%AUTO%\fR a unique name will be generated by the package itself\&. The result of the command is the fully-qualified name of the instance command\&. .PP .PP The following commands are possible for pool objects: .TP \fIpoolName\fR \fBadd\fR \fIpath\fR Adds the \fIpath\fR to the pool\&. Nothing is done if the \fIpath\fR is already known to the pool\&. The result of the command is the empty string\&. .TP \fIpoolName\fR \fBclear\fR Clears the entire pool\&. In other words, removes all paths from it\&. The result of the command is the empty string\&. .TP \fIpoolName\fR \fBpaths\fR Returns the list of all paths known to the pool, in the order they were added\&. .TP \fIpoolName\fR \fBremove\fR \fIpath\fR Removes the \fIpath\fR from the pool, if it is known to the pool\&. Unknown paths are ignored without error\&. The result of the command is the empty string\&. .PP .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fIfileutil\fR of the \fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&. Please also report any ideas for enhancements you may have for either package and/or documentation\&. .PP When proposing code changes, please provide \fIunified diffs\fR, i\&.e the output of \fBdiff -u\fR\&. .PP Note further that \fIattachments\fR are strongly preferred over inlined patches\&. Attachments can be made by going to the \fBEdit\fR form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar\&. |
Changes to idoc/man/files/modules/grammar_fa/fa.n.
︙ | ︙ | |||
545 546 547 548 549 550 551 | .CE .sp a possible serialization is .sp .CS | | | | | | | 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | .CE .sp a possible serialization is .sp .CS grammar::fa \\ {yellow red green red/yellow} \\ {Drive {0 0 {yellow Brake}} \\ Brake {0 0 {red Stop}} \\ Stop {1 0 {red/yellow Attention}} \\ Attention {0 0 {green Drive}}} .CE .sp A possible one, because I did not care about creation order here .TP \fIfaName\fR \fBdeserialize\fR \fIserialization\fR |
︙ | ︙ |
Changes to idoc/man/files/modules/grammar_peg/peg.n.
︙ | ︙ | |||
554 555 556 557 558 559 560 | .CE .sp a possible serialization is .sp .CS | | | | | | | | | | | | | | | | 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 | .CE .sp a possible serialization is .sp .CS grammar::peg \\ {Expression {/ {x ( Expression )} {x Factor {* {x MulOp Factor}}}} \\ Factor {x Term {* {x AddOp Term}}} \\ Term Number \\ MulOp {/ * /} \\ AddOp {/ + -} \\ Number {x {? Sign} {+ Digit}} \\ Sign {/ + -} \\ Digit {/ 0 1 2 3 4 5 6 7 8 9} \\ } \\ {Expression value Factor value \\ Term value MulOp value \\ AddOp value Number value \\ Sign value Digit value \\ } Expression .CE .sp A possible one, because the order of the nonterminals in the dictionary is not relevant\&. |
︙ | ︙ |
Changes to idoc/man/files/modules/httpd/httpd.n.
1 2 3 4 | '\" '\" Generated from file 'httpd\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2018 Sean Woods <yoda@etoyoc\&.com> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'httpd\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2018 Sean Woods <yoda@etoyoc\&.com> '\" .TH "httpd" n 4\&.3\&.3 tcllib "Tcl Web Server" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
268 269 270 271 272 273 274 | .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME | | < < < < | | < < < < < < < < < < | | | | | | < < | | | | < < < < | | | < < | | < < | | | | > > > > > > | | | > > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > | | > > > > | > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > | | > | > > > > > > > > > > > > > > > > > > > > > | | < > > < < > | < | < < | > | < | < < < < < < < < < < < < | < | < | | | < | < < | | < < < < < | < | < | < < < < < < < < < < < < < < < | > > | 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 | .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME httpd \- A TclOO and coroutine based web server .SH SYNOPSIS package require \fBTcl 8\&.6\fR .sp package require \fBuuid \fR .sp package require \fBclay \fR .sp package require \fBcoroutine \fR .sp package require \fBfileutil \fR .sp package require \fBfileutil::magic::filetype \fR .sp package require \fBwebsocket \fR .sp package require \fBmime \fR .sp package require \fBcron \fR .sp package require \fBuri \fR .sp package require \fBMarkdown \fR .sp method \fBChannelCopy\fR \fIin\fR \fIout\fR ?\fIargs\fR? .sp method \fBhtml_header\fR ?\fItitle\fR \fB\fR? ?\fIargs\fR? .sp method \fBhtml_footer\fR ?\fIargs\fR? .sp method \fBhttp_code_string\fR \fIcode\fR .sp method \fBHttpHeaders\fR \fIsock\fR ?\fIdebug\fR \fB\fR? .sp method \fBHttpHeaders_Default\fR .sp method \fBHttpServerHeaders\fR .sp method \fBMimeParse\fR \fImimetext\fR .sp method \fBUrl_Decode\fR \fIdata\fR .sp method \fBUrl_PathCheck\fR \fIurlsuffix\fR .sp method \fBwait\fR \fImode\fR \fIsock\fR .sp variable \fBChannelRegister\fR .sp variable \fBreply\fR .sp variable \fBrequest\fR .sp delegate \fB<server>\fR .sp method \fBconstructor\fR \fIServerObj\fR ?\fIargs\fR? .sp method \fBdestructor\fR ?\fIdictargs\fR? .sp method \fBChannelRegister\fR ?\fIargs\fR? .sp method \fBclose\fR .sp method \fBLog_Dispatched\fR .sp method \fBdispatch\fR \fInewsock\fR \fIdatastate\fR .sp method \fBDispatch\fR .sp method \fBhtml_header\fR \fItitle\fR ?\fIargs\fR? .sp method \fBhtml_footer\fR ?\fIargs\fR? .sp method \fBerror\fR \fIcode\fR ?\fImsg\fR \fB\fR? ?\fIerrorInfo\fR \fB\fR? .sp method \fBcontent\fR .sp method \fBEncodeStatus\fR \fIstatus\fR .sp method \fBlog\fR \fItype\fR ?\fIinfo\fR \fB\fR? .sp method \fBCoroName\fR .sp method \fBDoOutput\fR .sp method \fBFormData\fR .sp method \fBPostData\fR \fIlength\fR .sp method \fBSession_Load\fR .sp method \fBputs\fR \fIline\fR .sp method \fBRequestFind\fR \fIfield\fR .sp method \fBrequest\fR \fIsubcommand\fR ?\fIargs\fR? .sp method \fBreply\fR \fIsubcommand\fR ?\fIargs\fR? .sp method \fBreset\fR .sp method \fBtimeOutCheck\fR .sp method \fBtimestamp\fR .sp variable \fBtemplate\fR .sp variable \fBurl_patterns\fR .sp method \fBconstructor\fR \fIargs\fR ?\fIport\fR \fBauto\fR? ?\fImyaddr\fR \fB127\&.0\&.0\&.1\fR? ?\fIstring\fR \fBauto\fR? ?\fIname\fR \fBauto\fR? ?\fIdoc_root\fR \fB\fR? ?\fIreverse_dns\fR \fB0\fR? ?\fIconfiguration_file\fR \fB\fR? ?\fIprotocol\fR \fBHTTP/1\&.1\fR? .sp method \fBdestructor\fR ?\fIdictargs\fR? .sp method \fBconnect\fR \fIsock\fR \fIip\fR \fIport\fR .sp method \fBServerHeaders\fR \fIip\fR \fIhttp_request\fR \fImimetxt\fR .sp method \fBConnect\fR \fIuuid\fR \fIsock\fR \fIip\fR .sp method \fBcounter\fR \fIwhich\fR .sp method \fBCheckTimeout\fR .sp method \fBdebug\fR ?\fIargs\fR? .sp method \fBdispatch\fR \fIdata\fR .sp method \fBDispatch_Default\fR \fIreply\fR .sp method \fBDispatch_Local\fR \fIdata\fR .sp method \fBHeaders_Local\fR \fIvarname\fR .sp method \fBHeaders_Process\fR \fIvarname\fR .sp method \fBHostName\fR \fIipaddr\fR .sp method \fBlog\fR ?\fIargs\fR? .sp method \fBplugin\fR \fIslot\fR ?\fIclass\fR \fB\fR? .sp method \fBport_listening\fR .sp method \fBPrefixNormalize\fR \fIprefix\fR .sp method \fBsource\fR \fIfilename\fR .sp method \fBstart\fR .sp method \fBstop\fR .sp method \fBSubObject {} db\fR .sp method \fBSubObject {} default\fR .sp method \fBtemplate\fR \fIpage\fR .sp method \fBTemplateSearch\fR \fIpage\fR .sp method \fBThread_start\fR .sp method \fBUuid_Generate\fR .sp method \fBValidate_Connection\fR \fIsock\fR \fIip\fR .sp method \fBreset\fR .sp method \fBcontent\fR .sp method \fBDispatch\fR .sp method \fBcontent\fR .sp method \fBFileName\fR .sp method \fBDirectoryListing\fR \fIlocal_file\fR .sp method \fBcontent\fR .sp method \fBDispatch\fR .sp variable \fBexename\fR .sp method \fBCgiExec\fR \fIexecname\fR \fIscript\fR \fIarglist\fR .sp method \fBCgi_Executable\fR \fIscript\fR .sp method \fBproxy_channel\fR .sp method \fBproxy_path\fR .sp method \fBProxyRequest\fR \fIchana\fR \fIchanb\fR .sp method \fBProxyReply\fR \fIchana\fR \fIchanb\fR ?\fIargs\fR? .sp method \fBDispatch\fR .sp method \fBFileName\fR .sp method \fBproxy_channel\fR .sp method \fBProxyRequest\fR \fIchana\fR \fIchanb\fR .sp method \fBProxyReply\fR \fIchana\fR \fIchanb\fR ?\fIargs\fR? .sp method \fBDirectoryListing\fR \fIlocal_file\fR .sp method \fBEncodeStatus\fR \fIstatus\fR .sp method \fBscgi_info\fR .sp method \fBproxy_channel\fR .sp method \fBProxyRequest\fR \fIchana\fR \fIchanb\fR .sp method \fBProxyReply\fR \fIchana\fR \fIchanb\fR ?\fIargs\fR? .sp method \fBdebug\fR ?\fIargs\fR? .sp method \fBConnect\fR \fIuuid\fR \fIsock\fR \fIip\fR .sp method \fBDispatch_Dict\fR \fIdata\fR .sp method \fBuri {} add\fR \fIvhosts\fR \fIpatterns\fR \fIinfo\fR .sp method \fBuri {} direct\fR \fIvhosts\fR \fIpatterns\fR \fIinfo\fR \fIbody\fR .sp method \fBoutput\fR .sp method \fBDoOutput\fR .sp method \fBclose\fR .sp method \fBlocal_memchan\fR \fIcommand\fR ?\fIargs\fR? .sp method \fBConnect_Local\fR \fIuuid\fR \fIsock\fR ?\fIargs\fR? .sp .BE .SH DESCRIPTION .PP This module implements a web server, suitable for embedding in an application\&. The server is object oriented, and contains all of the fundamentals needed for a full service website\&. .PP .SH "MINIMAL EXAMPLE" Starting a web service requires starting a class of type \fBhttpd::server\fR, and providing that server with one or more URIs to service, and \fBhttpd::reply\fR derived classes to generate them\&. .CS oo::class create ::reply\&.hello { method content {} { my puts "<HTML><HEAD><TITLE>IRM Dispatch Server</TITLE></HEAD><BODY>" my puts "<h1>Hello World!</h1>" my puts </BODY></HTML> } } ::httpd::server create HTTPD port 8015 myaddr 127\&.0\&.0\&.1 doc_root ~/htdocs HTTPD plugin dispatch httpd::server::dispatch HTTPD uri add * /hello [list mixin reply\&.hello] .CE The bare module does have facilities to hose a files from a file system\&. Files that end in a \&.tml will be substituted in the style of Tclhttpd: .CS <!-- hello\&.tml --> [my html_header {Hello World!}] Your Server is running\&. <p> The time is now [clock format [clock seconds]] [my html_footer] .CE A complete example of an httpd server is in the /examples directory of Tcllib\&. It also show how to dispatch URIs to other processes via SCGI and HTTP proxies\&. .CS cd ~/tcl/sandbox/tcllib tclsh examples/httpd\&.tcl .CE .SH CLASSES .SS "CLASS HTTPD::MIME" A metaclass for MIME handling behavior across a live socket .PP \fBMethods\fR .TP method \fBChannelCopy\fR \fIin\fR \fIout\fR ?\fIargs\fR? .TP method \fBhtml_header\fR ?\fItitle\fR \fB\fR? ?\fIargs\fR? Returns a block of HTML .TP method \fBhtml_footer\fR ?\fIargs\fR? .TP method \fBhttp_code_string\fR \fIcode\fR .TP method \fBHttpHeaders\fR \fIsock\fR ?\fIdebug\fR \fB\fR? .TP method \fBHttpHeaders_Default\fR .TP method \fBHttpServerHeaders\fR .TP method \fBMimeParse\fR \fImimetext\fR Converts a block of mime encoded text to a key/value list\&. If an exception is encountered, the method will generate its own call to the \fBerror\fR method, and immediately invoke the \fBoutput\fR method to produce an error code and close the connection\&. .TP method \fBUrl_Decode\fR \fIdata\fR De-httpizes a string\&. .TP method \fBUrl_PathCheck\fR \fIurlsuffix\fR .TP method \fBwait\fR \fImode\fR \fIsock\fR .PP .PP .SS "CLASS HTTPD::REPLY" \fIancestors\fR: \fBhttpd::mime\fR .PP A class which shephards a request through the process of generating a reply\&. The socket associated with the reply is available at all times as the \fIchan\fR variable\&. The process of generating a reply begins with an \fBhttpd::server\fR generating a \fBhttp::class\fR object, mixing in a set of behaviors and then invoking the reply object's \fBdispatch\fR method\&. |
︙ | ︙ | |||
519 520 521 522 523 524 525 | .IP [5] Invokes the \fBcontent\fR method for the object, generating an call to the \fBerror\fR method if an exception is raised\&. .IP [6] Invokes the \fBoutput\fR method for the object .PP .PP | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | < < < < < | < < < > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | < | > > > > > > > > > > > > > > > > > > > > > > > > < < < < < < < < < < < < < < > > > > > > > > > > > > > > > > > > | > > > > | > > > > > | > > > | < > > | < < > > > > > > > > > | > | < < > | < > > | < > > > > > | < > | < > > > > > > | > > > > > > > > > > > > > > > > > | > > > > > | > > > > | < < < > > > > > | < < < > > > > | > | < > | > > > > > > > > > > > > > | < > | | | | | | > > > > > > > | > > > > > > | | > > | > > > > > > > > | > > > > > > | > > | > > | 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 | .IP [5] Invokes the \fBcontent\fR method for the object, generating an call to the \fBerror\fR method if an exception is raised\&. .IP [6] Invokes the \fBoutput\fR method for the object .PP .PP Developers have the option of streaming output to a buffer via the \fBputs\fR method of the reply, or simply populating the \fIreply_body\fR variable of the object\&. The information returned by the \fBcontent\fR method is not interpreted in any way\&. If an exception is thrown (via the \fBerror\fR command in Tcl, for example) the caller will auto-generate a 500 {Internal Error} message\&. A typical implementation of \fBcontent\fR look like: .CS clay::define ::test::content\&.file { superclass ::httpd::content\&.file # Return a file # Note: this is using the content\&.file mixin which looks for the reply_file variable # and will auto-compute the Content-Type method content {} { my reset set doc_root [my request get DOCUMENT_ROOT] my variable reply_file set reply_file [file join $doc_root index\&.html] } } clay::define ::test::content\&.time { # return the current system time method content {} { my variable reply_body my reply set Content-Type text/plain set reply_body [clock seconds] } } clay::define ::test::content\&.echo { method content {} { my variable reply_body my reply set Content-Type [my request get CONTENT_TYPE] set reply_body [my PostData [my request get CONTENT_LENGTH]] } } clay::define ::test::content\&.form_handler { method content {} { set form [my FormData] my reply set Content-Type {text/html; charset=UTF-8} my puts [my html_header {My Dynamic Page}] my puts "<BODY>" my puts "You Sent<p>" my puts "<TABLE>" foreach {f v} $form { my puts "<TR><TH>$f</TH><TD><verbatim>$v</verbatim></TD>" } my puts "</TABLE><p>" my puts "Send some info:<p>" my puts "<FORM action=/[my request get REQUEST_PATH] method POST>" my puts "<TABLE>" foreach field {name rank serial_number} { set line "<TR><TH>$field</TH><TD><input name=\\"$field\\" " if {[dict exists $form $field]} { append line " value=\\"[dict get $form $field]\\""" } append line " /></TD></TR>" my puts $line } my puts "</TABLE>" my puts [my html footer] } } .CE .PP \fBVariable\fR .TP variable \fBChannelRegister\fR .TP variable \fBreply\fR A dictionary which will converted into the MIME headers of the reply .TP variable \fBrequest\fR A dictionary containing the SCGI transformed HTTP headers for the request .PP .PP \fBDelegate\fR .TP delegate \fB<server>\fR The server object which spawned this reply .PP .PP \fBMethods\fR .TP method \fBconstructor\fR \fIServerObj\fR ?\fIargs\fR? .TP method \fBdestructor\fR ?\fIdictargs\fR? clean up on exit .TP method \fBChannelRegister\fR ?\fIargs\fR? Registers a channel to be closed by the close method .TP method \fBclose\fR Close channels opened by this object .TP method \fBLog_Dispatched\fR Record a dispatch event .TP method \fBdispatch\fR \fInewsock\fR \fIdatastate\fR Accept the handoff from the server object of the socket \fInewsock\fR and feed it the state \fIdatastate\fR\&. Fields the \fIdatastate\fR are looking for in particular are: .sp * \fBmixin\fR - A key/value list of slots and classes to be mixed into the object prior to invoking \fBDispatch\fR\&. .sp * \fBhttp\fR - A key/value list of values to populate the object's \fIrequest\fR ensemble .sp All other fields are passed along to the \fBclay\fR structure of the object\&. .TP method \fBDispatch\fR .TP method \fBhtml_header\fR \fItitle\fR ?\fIargs\fR? .TP method \fBhtml_footer\fR ?\fIargs\fR? .TP method \fBerror\fR \fIcode\fR ?\fImsg\fR \fB\fR? ?\fIerrorInfo\fR \fB\fR? .TP method \fBcontent\fR REPLACE ME: This method is the "meat" of your application\&. It writes to the result buffer via the "puts" method and can tweak the headers via "clay put header_reply" .TP method \fBEncodeStatus\fR \fIstatus\fR Formulate a standard HTTP status header from he string provided\&. .TP method \fBlog\fR \fItype\fR ?\fIinfo\fR \fB\fR? .TP method \fBCoroName\fR .TP method \fBDoOutput\fR Generates the the HTTP reply, streams that reply back across \fIchan\fR, and destroys the object\&. .TP method \fBFormData\fR For GET requests, converts the QUERY_DATA header into a key/value list\&. For POST requests, reads the Post data and converts that information to a key/value list for application/x-www-form-urlencoded posts\&. For multipart posts, it composites all of the MIME headers of the post to a singular key/value list, and provides MIME_* information as computed by the \fBmime\fR package, including the MIME_TOKEN, which can be fed back into the mime package to read out the contents\&. .TP method \fBPostData\fR \fIlength\fR Stream \fIlength\fR bytes from the \fIchan\fR socket, but only of the request is a POST or PUSH\&. Returns an empty string otherwise\&. .TP method \fBSession_Load\fR Manage session data .TP method \fBputs\fR \fIline\fR Appends the value of \fIstring\fR to the end of \fIreply_body\fR, as well as a trailing newline character\&. .TP method \fBRequestFind\fR \fIfield\fR .TP method \fBrequest\fR \fIsubcommand\fR ?\fIargs\fR? .TP method \fBreply\fR \fIsubcommand\fR ?\fIargs\fR? .TP method \fBreset\fR Clear the contents of the \fIreply_body\fR variable, and reset all headers in the \fBreply\fR structure back to the defaults for this object\&. .TP method \fBtimeOutCheck\fR Called from the \fBhttp::server\fR object which spawned this reply\&. Checks to see if too much time has elapsed while waiting for data or generating a reply, and issues a timeout error to the request if it has, as well as destroy the object and close the \fIchan\fR socket\&. .TP method \fBtimestamp\fR Return the current system time in the format: .CS %a, %d %b %Y %T %Z .CE .PP .PP .SS "CLASS HTTPD::SERVER" \fIancestors\fR: \fBhttpd::mime\fR .PP .PP \fBVariable\fR .TP variable \fBtemplate\fR .TP variable \fBurl_patterns\fR .PP .PP \fBMethods\fR .TP method \fBconstructor\fR \fIargs\fR ?\fIport\fR \fBauto\fR? ?\fImyaddr\fR \fB127\&.0\&.0\&.1\fR? ?\fIstring\fR \fBauto\fR? ?\fIname\fR \fBauto\fR? ?\fIdoc_root\fR \fB\fR? ?\fIreverse_dns\fR \fB0\fR? ?\fIconfiguration_file\fR \fB\fR? ?\fIprotocol\fR \fBHTTP/1\&.1\fR? .TP method \fBdestructor\fR ?\fIdictargs\fR? .TP method \fBconnect\fR \fIsock\fR \fIip\fR \fIport\fR Reply to an open socket\&. This method builds a coroutine to manage the remainder of the connection\&. The coroutine's operations are driven by the \fBConnect\fR method\&. .TP method \fBServerHeaders\fR \fIip\fR \fIhttp_request\fR \fImimetxt\fR .TP method \fBConnect\fR \fIuuid\fR \fIsock\fR \fIip\fR This method reads HTTP headers, and then consults the \fBdispatch\fR method to determine if the request is valid, and/or what kind of reply to generate\&. Under normal cases, an object of class \fB::http::reply\fR is created, and that class's \fBdispatch\fR method\&. This action passes control of the socket to the reply object\&. The reply object manages the rest of the transaction, including closing the socket\&. .TP method \fBcounter\fR \fIwhich\fR Increment an internal counter\&. .TP method \fBCheckTimeout\fR Check open connections for a time out event\&. .TP method \fBdebug\fR ?\fIargs\fR? .TP method \fBdispatch\fR \fIdata\fR Given a key/value list of information, return a data structure describing how the server should reply\&. .TP method \fBDispatch_Default\fR \fIreply\fR Method dispatch method of last resort before returning a 404 NOT FOUND error\&. The default behavior is to look for a file in \fIDOCUMENT_ROOT\fR which matches the query\&. .TP method \fBDispatch_Local\fR \fIdata\fR Method dispatch method invoked prior to invoking methods implemented by plugins\&. If this method returns a non-empty dictionary, that structure will be passed to the reply\&. The default is an empty implementation\&. .TP method \fBHeaders_Local\fR \fIvarname\fR Introspect and possibly modify a data structure destined for a reply\&. This method is invoked before invoking Header methods implemented by plugins\&. The default implementation is empty\&. .TP method \fBHeaders_Process\fR \fIvarname\fR Introspect and possibly modify a data structure destined for a reply\&. This method is built dynamically by the \fBplugin\fR method\&. .TP method \fBHostName\fR \fIipaddr\fR Convert an ip address to a host name\&. If the server/ reverse_dns flag is false, this method simply returns the IP address back\&. Internally, this method uses the \fIdns\fR module from tcllib\&. .TP method \fBlog\fR ?\fIargs\fR? Log an event\&. The input for args is free form\&. This method is intended to be replaced by the user, and is a noop for a stock http::server object\&. .TP method \fBplugin\fR \fIslot\fR ?\fIclass\fR \fB\fR? Incorporate behaviors from a plugin\&. This method dynamically rebuilds the \fBDispatch\fR and \fBHeaders\fR method\&. For every plugin, the server looks for the following entries in \fIclay plugin/\fR: .sp \fIload\fR - A script to invoke in the server's namespace during the \fBplugin\fR method invokation\&. .sp \fIdispatch\fR - A script to stitch into the server's \fBDispatch\fR method\&. .sp \fIheaders\fR - A script to stitch into the server's \fBHeaders\fR method\&. .sp \fIthread\fR - A script to stitch into the server's \fBThread_start\fR method\&. .TP method \fBport_listening\fR Return the actual port that httpd is listening on\&. .TP method \fBPrefixNormalize\fR \fIprefix\fR For the stock version, trim trailing /'s and *'s from a prefix\&. This method can be replaced by the end user to perform any other transformations needed for the application\&. .TP method \fBsource\fR \fIfilename\fR .TP method \fBstart\fR Open the socket listener\&. .TP method \fBstop\fR Shut off the socket listener, and destroy any pending replies\&. .TP method \fBSubObject {} db\fR .TP method \fBSubObject {} default\fR .TP method \fBtemplate\fR \fIpage\fR Return a template for the string \fIpage\fR .TP method \fBTemplateSearch\fR \fIpage\fR Perform a search for the template that best matches \fIpage\fR\&. This can include local file searches, in-memory structures, or even database lookups\&. The stock implementation simply looks for files with a \&.tml or \&.html extension in the ?doc_root? directory\&. .TP method \fBThread_start\fR Built by the \fBplugin\fR method\&. Called by the \fBstart\fR method\&. Intended to allow plugins to spawn worker threads\&. .TP method \fBUuid_Generate\fR Generate a GUUID\&. Used to ensure every request has a unique ID\&. The default implementation is: .CS return [::clay::uuid generate] .CE .TP method \fBValidate_Connection\fR \fIsock\fR \fIip\fR Given a socket and an ip address, return true if this connection should be terminated, or false if it should be allowed to continue\&. The stock implementation always returns 0\&. This is intended for applications to be able to implement black lists and/or provide security based on IP address\&. .PP .PP .SS "CLASS HTTPD::SERVER::DISPATCH" \fIancestors\fR: \fBhttpd::server\fR .PP Provide a backward compadible alias .PP .SS "CLASS HTTPD::CONTENT\&.REDIRECT" .PP \fBMethods\fR .TP method \fBreset\fR .TP method \fBcontent\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.CACHE" .PP \fBMethods\fR .TP method \fBDispatch\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.TEMPLATE" .PP \fBMethods\fR .TP method \fBcontent\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.FILE" Class to deliver Static content When utilized, this class is fed a local filename by the dispatcher .PP \fBMethods\fR .TP method \fBFileName\fR .TP method \fBDirectoryListing\fR \fIlocal_file\fR .TP method \fBcontent\fR .TP method \fBDispatch\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.EXEC" .PP \fBVariable\fR .TP variable \fBexename\fR .PP .PP \fBMethods\fR .TP method \fBCgiExec\fR \fIexecname\fR \fIscript\fR \fIarglist\fR .TP method \fBCgi_Executable\fR \fIscript\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.PROXY" \fIancestors\fR: \fBhttpd::content\&.exec\fR .PP Return data from an proxy process .PP \fBMethods\fR .TP method \fBproxy_channel\fR .TP method \fBproxy_path\fR .TP method \fBProxyRequest\fR \fIchana\fR \fIchanb\fR .TP method \fBProxyReply\fR \fIchana\fR \fIchanb\fR ?\fIargs\fR? .TP method \fBDispatch\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.CGI" \fIancestors\fR: \fBhttpd::content\&.proxy\fR .PP .PP \fBMethods\fR .TP method \fBFileName\fR .TP method \fBproxy_channel\fR .TP method \fBProxyRequest\fR \fIchana\fR \fIchanb\fR .TP method \fBProxyReply\fR \fIchana\fR \fIchanb\fR ?\fIargs\fR? .TP method \fBDirectoryListing\fR \fIlocal_file\fR For most CGI applications a directory list is vorboten .PP .PP .SS "CLASS HTTPD::PROTOCOL\&.SCGI" Return data from an SCGI process .PP \fBMethods\fR .TP method \fBEncodeStatus\fR \fIstatus\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.SCGI" \fIancestors\fR: \fBhttpd::content\&.proxy\fR .PP .PP \fBMethods\fR .TP method \fBscgi_info\fR .TP method \fBproxy_channel\fR .TP method \fBProxyRequest\fR \fIchana\fR \fIchanb\fR .TP method \fBProxyReply\fR \fIchana\fR \fIchanb\fR ?\fIargs\fR? .PP .PP .SS "CLASS HTTPD::SERVER\&.SCGI" \fIancestors\fR: \fBhttpd::server\fR .PP Act as an SCGI Server .PP \fBMethods\fR .TP method \fBdebug\fR ?\fIargs\fR? .TP method \fBConnect\fR \fIuuid\fR \fIsock\fR \fIip\fR .PP .PP .SS "CLASS HTTPD::CONTENT\&.WEBSOCKET" Upgrade a connection to a websocket .PP .SS "CLASS HTTPD::PLUGIN" httpd plugin template .PP .SS "CLASS HTTPD::PLUGIN\&.DICT_DISPATCH" A rudimentary plugin that dispatches URLs from a dict data structure .PP \fBMethods\fR .TP method \fBDispatch_Dict\fR \fIdata\fR Implementation of the dispatcher .TP method \fBuri {} add\fR \fIvhosts\fR \fIpatterns\fR \fIinfo\fR .TP method \fBuri {} direct\fR \fIvhosts\fR \fIpatterns\fR \fIinfo\fR \fIbody\fR .PP .PP .SS "CLASS HTTPD::REPLY\&.MEMCHAN" \fIancestors\fR: \fBhttpd::reply\fR .PP .PP \fBMethods\fR .TP method \fBoutput\fR .TP method \fBDoOutput\fR .TP method \fBclose\fR .PP .PP .SS "CLASS HTTPD::PLUGIN\&.LOCAL_MEMCHAN" .PP \fBMethods\fR .TP method \fBlocal_memchan\fR \fIcommand\fR ?\fIargs\fR? .TP method \fBConnect_Local\fR \fIuuid\fR \fIsock\fR ?\fIargs\fR? A modified connection method that passes simple GET request to an object and pulls data directly from the reply_body data variable in the object Needed because memchan is bidirectional, and we can't seem to communicate that the server is one side of the link and the reply is another .PP .PP .SH AUTHORS Sean Woods .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fInetwork\fR of the \fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&. |
︙ | ︙ |
Changes to idoc/man/files/modules/imap4/imap4.n.
︙ | ︙ | |||
271 272 273 274 275 276 277 | .. .BS .SH NAME imap4 \- imap client-side tcl implementation of imap protocol .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp | | | 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | .. .BS .SH NAME imap4 \- imap client-side tcl implementation of imap protocol .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBimap4 ?0\&.5\&.3?\fR .sp \fB::imap4::open\fR \fIhostname\fR ?\fIport\fR? .sp \fB::imap4::starttls\fR \fIchan\fR .sp \fB::imap4::login\fR \fIchan\fR \fIuser\fR \fIpass\fR .sp |
︙ | ︙ | |||
809 810 811 812 813 814 815 | form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar\&. Only a small part of rfc3501 implemented\&. .SH "SEE ALSO" ftp, http, imap, mime, pop3, tls .SH KEYWORDS email, imap, internet, mail, net, rfc3501, ssl, tls | > > | 809 810 811 812 813 814 815 816 817 | form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar\&. Only a small part of rfc3501 implemented\&. .SH "SEE ALSO" ftp, http, imap, mime, pop3, tls .SH KEYWORDS email, imap, internet, mail, net, rfc3501, ssl, tls .SH CATEGORY Networking |
Changes to idoc/man/files/modules/math/numtheory.n.
︙ | ︙ | |||
308 309 310 311 312 313 314 315 316 317 318 319 320 321 | .sp \fBmath::numtheory::numberPrimesGauss\fR \fIN\fR .sp \fBmath::numtheory::numberPrimesLegendre\fR \fIN\fR .sp \fBmath::numtheory::numberPrimesLegendreModified\fR \fIN\fR .sp .BE .SH DESCRIPTION .PP This package is for collecting various number-theoretic operations, with a slight bias to prime numbers\&. .TP \fBmath::numtheory::isprime\fR \fIN\fR ?\fIoption\fR \fIvalue\fR \&.\&.\&.? | > > | 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 | .sp \fBmath::numtheory::numberPrimesGauss\fR \fIN\fR .sp \fBmath::numtheory::numberPrimesLegendre\fR \fIN\fR .sp \fBmath::numtheory::numberPrimesLegendreModified\fR \fIN\fR .sp \fBmath::numtheory::differenceNumberPrimesLegendreModified\fR \fIlower\fR \fIupper\fR .sp .BE .SH DESCRIPTION .PP This package is for collecting various number-theoretic operations, with a slight bias to prime numbers\&. .TP \fBmath::numtheory::isprime\fR \fIN\fR ?\fIoption\fR \fIvalue\fR \&.\&.\&.? |
︙ | ︙ | |||
467 468 469 470 471 472 473 | .RE .TP \fBmath::numtheory::numberPrimesGauss\fR \fIN\fR Estimate the number of primes according the formula by Gauss\&. .RS .TP integer \fIN\fR (in) | | | | > > > > > > > > > > > | 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 | .RE .TP \fBmath::numtheory::numberPrimesGauss\fR \fIN\fR Estimate the number of primes according the formula by Gauss\&. .RS .TP integer \fIN\fR (in) Number in question, should be larger than 0 .RE .TP \fBmath::numtheory::numberPrimesLegendre\fR \fIN\fR Estimate the number of primes according the formula by Legendre\&. .RS .TP integer \fIN\fR (in) Number in question, should be larger than 0 .RE .TP \fBmath::numtheory::numberPrimesLegendreModified\fR \fIN\fR Estimate the number of primes according the modified formula by Legendre\&. .RS .TP integer \fIN\fR (in) Number in question, should be larger than 0 .RE .TP \fBmath::numtheory::differenceNumberPrimesLegendreModified\fR \fIlower\fR \fIupper\fR Estimate the number of primes between tow limits according the modified formula by Legendre\&. .RS .TP integer \fIlower\fR (in) Lower limit for the primes, should be larger than 0 .TP integer \fIupper\fR (in) Upper limit for the primes, should be larger than 0 .RE .PP .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fImath :: numtheory\fR of the \fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&. |
︙ | ︙ |
Added idoc/man/files/modules/math/quasirandom.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'quasirandom\&.man' by tcllib/doctools with format 'nroff' '\" .TH "math::quasirandom" n 1 tcllib "Tcl Math Library" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME math::quasirandom \- Quasi-random points for integration and Monte Carlo type methods .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBTclOO \fR .sp package require \fBmath::quasirandom 1\fR .sp \fB::math::quasirandom::qrpoint create\fR \fINAME\fR \fIDIM\fR ?ARGS? .sp \fBgen next\fR .sp \fBgen set-start\fR \fIindex\fR .sp \fBgen set-evaluations\fR \fInumber\fR .sp \fBgen integral\fR \fIfunc\fR \fIminmax\fR \fIargs\fR .sp .BE .SH DESCRIPTION .PP In many applications pseudo-random numbers and pseudo-random points in a (limited) sample space play an important role\&. For instance in any type of Monte Carlo simulation\&. Pseudo-random numbers, however, may be too random and as a consequence a large number of data points is required to reduce the error or fluctuation in the results to the desired value\&. .PP Quasi-random numbers can be used as an alternative: instead of "completely" arbitrary points, points are generated that are diverse enough to cover the entire sample space in a more or less uniform way\&. As a consequence convergence to the limit can be much faster, when such quasi-random numbers are well-chosen\&. .PP The package defines a \fIclass\fR "qrpoint" that creates a command to generate quasi-random points in 1, 2 or more dimensions\&. The command can either generate separate points, so that they can be used in a user-defined algorithm or use these points to calculate integrals of functions defined over 1, 2 or more dimensions\&. It also holds several other common algorithms\&. (NOTE: these are not implemented yet) .PP One particular characteristic of the generators is that there are no tuning parameters involved, which makes the use particularly simple\&. .SH COMMANDS A quasi-random point generator is created using the \fIqrpoint\fR class: .TP \fB::math::quasirandom::qrpoint create\fR \fINAME\fR \fIDIM\fR ?ARGS? This command takes the following arguments: .RS .TP string \fINAME\fR The name of the command to be created (alternatively: the \fInew\fR subcommand will generate a unique name) .TP integer/string \fIDIM\fR The number of dimensions or one of: "circle", "disk", "sphere" or "ball" .TP strings \fIARGS\fR Zero or more key-value pairs\&. The supported options are: .RS .IP \(bu \fI-start index\fR: The index for the next point to be generated (default: 1) .IP \(bu \fI-evaluations number\fR: The number of evaluations to be used by default (default: 100) .RE .RE .PP The points that are returned lie in the hyperblock [0,1[^n (n the number of dimensions) or on the unit circle, within the unit disk, on the unit sphere or within the unit ball\&. .PP Each generator supports the following subcommands: .TP \fBgen next\fR Return the coordinates of the next quasi-random point .sp .TP \fBgen set-start\fR \fIindex\fR Reset the index for the next quasi-random point\&. This is useful to control which list of points is returned\&. Returns the new or the current value, if no value is given\&. .sp .TP \fBgen set-evaluations\fR \fInumber\fR Reset the default number of evaluations in compound algorithms\&. Note that the actual number is the smallest 4-fold larger or equal to the given number\&. (The 4-fold plays a role in the detailed integration routine\&.) .sp .TP \fBgen integral\fR \fIfunc\fR \fIminmax\fR \fIargs\fR Calculate the integral of the given function over the block (or the circle, sphere etc\&.) .RS .TP string \fIfunc\fR The name of the function to be integrated .TP list \fIminmax\fR List of pairs of minimum and maximum coordinates\&. This can be used to map the quasi-random coordinates to the desired hyper-block\&. .sp If the space is a circle, disk etc\&. then this argument should be a single value, the radius\&. The circle, disk, etc\&. is centred at the origin\&. If this is not what is required, then a coordinate transformation should be made within the function\&. .TP strings \fIargs\fR Zero or more key-value pairs\&. The following options are supported: .RS .IP \(bu \fI-evaluations number\fR: The number of evaluations to be used\&. If not specified use the default of the generator object\&. .RE .RE .PP .SH TODO Implement other algorithms and variants .PP Implement more unit tests\&. .PP Comparison to pseudo-random numbers for integration\&. .SH REFERENCES Various algorithms exist for generating quasi-random numbers\&. The generators created in this package are based on: \fIhttp://extremelearning\&.com\&.au/unreasonable-effectiveness-of-quasirandom-sequences/\fR .SH KEYWORDS mathematics, quasi-random .SH CATEGORY Mathematics |
Changes to idoc/man/files/modules/mime/mime.n.
1 2 3 4 | '\" '\" Generated from file 'mime\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 1999-2000 Marshall T\&. Rose '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'mime\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 1999-2000 Marshall T\&. Rose '\" .TH "mime" n 1\&.6\&.1 tcllib "Mime" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME mime \- Manipulation of MIME body parts .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME mime \- Manipulation of MIME body parts .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBmime ?1\&.6\&.1?\fR .sp \fB::mime::initialize\fR ?\fB-canonical\fR \fItype/subtype\fR ?\fB-param\fR {\fIkey value\fR}\&.\&.\&.? ?\fB-encoding\fR \fIvalue\fR? ?\fB-header\fR {\fIkey value\fR}\&.\&.\&.?? (\fB-file\fR \fIname\fR | \fB-string\fR \fIvalue\fR | \fB-parts\fR {\fItoken1\fR \&.\&.\&. \fItokenN\fR}) .sp \fB::mime::finalize\fR \fItoken\fR ?\fB-subordinates\fR \fBall\fR | \fBdynamic\fR | \fBnone\fR? .sp \fB::mime::getproperty\fR \fItoken\fR ?\fIproperty\fR | \fB-names\fR? .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/mime/smtp.n.
︙ | ︙ | |||
403 404 405 406 407 408 409 | .CS proc send_simple_message {recipient email_server subject body} { package require smtp package require mime | | | | | 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 | .CS proc send_simple_message {recipient email_server subject body} { package require smtp package require mime set token [mime::initialize -canonical text/plain \\ -string $body] mime::setheader $token Subject $subject smtp::sendmessage $token \\ -recipients $recipient -servers $email_server mime::finalize $token } send_simple_message someone@somewhere\&.com localhost \\ "This is the subject\&." "This is the message\&." .CE .SH "TLS SECURITY CONSIDERATIONS" .PP This package uses the \fBTLS\fR package to handle the security for \fBhttps\fR urls and other socket connections\&. |
︙ | ︙ |
Changes to idoc/man/files/modules/oauth/oauth.n.
1 2 3 4 | '\" '\" Generated from file 'oauth\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2014 Javi P\&. <hxm@eggdrop\&.es> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'oauth\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2014 Javi P\&. <hxm@eggdrop\&.es> '\" .TH "oauth" n 1\&.0\&.3 tcllib "oauth" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME oauth \- oauth API base signature .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME oauth \- oauth API base signature .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBoauth ?1\&.0\&.3?\fR .sp \fB::oauth::config\fR .sp \fB::oauth::config\fR ?\fIoptions\fR\&.\&.\&.? .sp \fB::oauth::header\fR \fIbaseURL\fR ?\fIpostQuery\fR? .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/pop3/pop3.n.
︙ | ︙ | |||
499 500 501 502 503 504 505 | .CS package require tls tls::init -cafile /path/to/ca/cert -keyfile \&.\&.\&. # Create secured pop3 channel | | | | 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 | .CS package require tls tls::init -cafile /path/to/ca/cert -keyfile \&.\&.\&. # Create secured pop3 channel pop3::open -socketcmd tls::socket \\ $thehost $theuser $thepassword \&.\&.\&. .CE The second method, option \fB-stls\fR, will connect to the standard POP3 port and then perform an STARTTLS handshake\&. This will only work for POP3 servers which have this capability\&. The package will confirm that the server supports STARTTLS and the handshake was performed correctly before proceeding with authentication\&. .CS package require tls tls::init -cafile /path/to/ca/cert -keyfile \&.\&.\&. # Create secured pop3 channel pop3::open -stls 1 \\ $thehost $theuser $thepassword \&.\&.\&. .CE .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain |
︙ | ︙ |
Changes to idoc/man/files/modules/pop3d/pop3d.n.
︙ | ︙ | |||
489 490 491 492 493 494 495 | the package to override how the server opens its listening socket\&. The envisioned main use is the specification of the \fBtls::socket\fR command, see package \fBtls\fR, to secure the communication\&. .CS package require tls | | | 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | the package to override how the server opens its listening socket\&. The envisioned main use is the specification of the \fBtls::socket\fR command, see package \fBtls\fR, to secure the communication\&. .CS package require tls tls::init \\ \&.\&.\&. pop3d::new S -socket tls::socket \&.\&.\&. .CE .SH REFERENCES |
︙ | ︙ |
Changes to idoc/man/files/modules/practcl/practcl.n.
1 2 3 4 | '\" '\" Generated from file 'practcl\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2016-2018 Sean Woods <yoda@etoyoc\&.com> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'practcl\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2016-2018 Sean Woods <yoda@etoyoc\&.com> '\" .TH "practcl" n 0\&.16\&.3 tcllib "The The Proper Rational API for C to Tool Command Language Module" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME practcl \- The Practcl Module .SH SYNOPSIS package require \fBTclOO 1\&.0\fR .sp | > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | < > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > | > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 | .. .BS .SH NAME practcl \- The Practcl Module .SH SYNOPSIS package require \fBTclOO 1\&.0\fR .sp proc \fBpractcl::cat\fR \fIfname\fR .sp proc \fBpractcl::docstrip\fR \fItext\fR .sp proc \fBputb\fR ?\fImap\fR? \fItext\fR .sp proc \fBProc\fR \fIname\fR \fIarglist\fR \fIbody\fR .sp proc \fBnoop\fR ?\fIargs\fR? .sp proc \fBpractcl::debug\fR ?\fIargs\fR? .sp proc \fBpractcl::doexec\fR ?\fIargs\fR? .sp proc \fBpractcl::doexec_in\fR \fIpath\fR ?\fIargs\fR? .sp proc \fBpractcl::dotclexec\fR ?\fIargs\fR? .sp proc \fBpractcl::domake\fR \fIpath\fR ?\fIargs\fR? .sp proc \fBpractcl::domake\&.tcl\fR \fIpath\fR ?\fIargs\fR? .sp proc \fBpractcl::fossil\fR \fIpath\fR ?\fIargs\fR? .sp proc \fBpractcl::fossil_status\fR \fIdir\fR .sp proc \fBpractcl::os\fR .sp proc \fBpractcl::mkzip\fR \fIexename\fR \fIbarekit\fR \fIvfspath\fR .sp proc \fBpractcl::sort_dict\fR \fIlist\fR .sp proc \fBpractcl::local_os\fR .sp proc \fBpractcl::config\&.tcl\fR \fIpath\fR .sp proc \fBpractcl::read_configuration\fR \fIpath\fR .sp proc \fBpractcl::tcllib_require\fR \fIpkg\fR ?\fIargs\fR? .sp proc \fBpractcl::platform::tcl_core_options\fR \fIos\fR .sp proc \fBpractcl::platform::tk_core_options\fR \fIos\fR .sp proc \fBpractcl::read_rc_file\fR \fIfilename\fR ?\fIlocaldat\fR \fB\fR? .sp proc \fBpractcl::read_sh_subst\fR \fIline\fR \fIinfo\fR .sp proc \fBpractcl::read_sh_file\fR \fIfilename\fR ?\fIlocaldat\fR \fB\fR? .sp proc \fBpractcl::read_Config\&.sh\fR \fIfilename\fR .sp proc \fBpractcl::read_Makefile\fR \fIfilename\fR .sp proc \fBpractcl::cputs\fR \fIvarname\fR ?\fIargs\fR? .sp proc \fBpractcl::tcl_to_c\fR \fIbody\fR .sp proc \fBpractcl::_tagblock\fR \fItext\fR ?\fIstyle\fR \fBtcl\fR? ?\fInote\fR \fB\fR? .sp proc \fBpractcl::de_shell\fR \fIdata\fR .sp proc \fBpractcl::grep\fR \fIpattern\fR ?\fIfiles\fR \fB\fR? .sp proc \fBpractcl::file_lexnormalize\fR \fIsp\fR .sp proc \fBpractcl::file_relative\fR \fIbase\fR \fIdst\fR .sp proc \fBpractcl::findByPattern\fR \fIbasedir\fR \fIpatterns\fR .sp proc \fBpractcl::log\fR \fIfname\fR \fIcomment\fR .sp proc \fBpractcl::_pkgindex_simpleIndex\fR \fIpath\fR .sp proc \fBpractcl::_pkgindex_directory\fR \fIpath\fR .sp proc \fBpractcl::_pkgindex_path_subdir\fR \fIpath\fR .sp proc \fBpractcl::pkgindex_path\fR ?\fIargs\fR? .sp proc \fBpractcl::installDir\fR \fId1\fR \fId2\fR .sp proc \fBpractcl::copyDir\fR \fId1\fR \fId2\fR ?\fItoplevel\fR \fB1\fR? .sp proc \fBpractcl::buildModule\fR \fImodpath\fR .sp proc \fBpractcl::installModule\fR \fImodpath\fR \fIDEST\fR .sp proc \fBpractcl::trigger\fR ?\fIargs\fR? .sp proc \fBpractcl::depends\fR ?\fIargs\fR? .sp proc \fBpractcl::target\fR \fIname\fR \fIinfo\fR ?\fIaction\fR \fB\fR? .sp method \fBconstructor\fR .sp method \fBargspec\fR \fIargspec\fR .sp method \fBcomment\fR \fIblock\fR .sp method \fBkeyword\&.Annotation\fR \fIresultvar\fR \fIcommentblock\fR \fItype\fR \fIname\fR \fIbody\fR .sp method \fBkeyword\&.Class\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR \fIbody\fR .sp method \fBkeyword\&.class\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR \fIbody\fR .sp method \fBkeyword\&.Class_Method\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR ?\fIargs\fR? .sp method \fBkeyword\&.method\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR ?\fIargs\fR? .sp method \fBkeyword\&.proc\fR \fIcommentblock\fR \fIname\fR \fIargspec\fR .sp method \fBreset\fR .sp method \fBMain\fR .sp method \fBsection\&.method\fR \fIkeyword\fR \fImethod\fR \fIminfo\fR .sp method \fBsection\&.annotation\fR \fItype\fR \fIname\fR \fIiinfo\fR .sp method \fBsection\&.class\fR \fIclass_name\fR \fIclass_info\fR .sp method \fBsection\&.command\fR \fIprocinfo\fR .sp method \fBmanpage\fR ?\fBheader \fIvalue\fR\fR? ?\fBfooter \fIvalue\fR\fR? ?\fBauthors \fIlist\fR\fR? .sp method \fBscan_text\fR \fItext\fR .sp method \fBscan_file\fR \fIfilename\fR .sp method \fB_MorphPatterns\fR .sp method \fBdefine\fR \fIsubmethod\fR ?\fIargs\fR? .sp method \fBgraft\fR ?\fIargs\fR? .sp method \fBinitialize\fR .sp method \fBlink\fR \fIcommand\fR ?\fIargs\fR? .sp method \fBmorph\fR \fIclassname\fR .sp method \fBscript\fR \fIscript\fR .sp method \fBselect\fR .sp method \fBsource\fR \fIfilename\fR .sp classmethod \fBselect\fR \fIobject\fR .sp method \fBconfig\&.sh\fR .sp method \fBBuildDir\fR \fIPWD\fR .sp method \fBMakeDir\fR \fIsrcdir\fR .sp method \fBread_configuration\fR .sp method \fBbuild-cflags\fR \fIPROJECT\fR \fIDEFS\fR \fInamevar\fR \fIversionvar\fR \fIdefsvar\fR .sp method \fBcritcl\fR ?\fIargs\fR? .sp method \fBAutoconf\fR .sp method \fBBuildDir\fR \fIPWD\fR .sp method \fBConfigureOpts\fR .sp method \fBMakeDir\fR \fIsrcdir\fR .sp method \fBmake {} autodetect\fR .sp method \fBmake {} clean\fR .sp method \fBmake {} compile\fR .sp method \fBmake {} install\fR \fIDEST\fR .sp method \fBbuild-compile-sources\fR \fIPROJECT\fR \fICOMPILE\fR \fICPPCOMPILE\fR \fIINCLUDES\fR .sp method \fBbuild-Makefile\fR \fIpath\fR \fIPROJECT\fR .sp method \fBbuild-library\fR \fIoutfile\fR \fIPROJECT\fR .sp method \fBbuild-tclsh\fR \fIoutfile\fR \fIPROJECT\fR ?\fIpath\fR \fBauto\fR? .sp method \fBBuildDir\fR \fIPWD\fR .sp method \fBmake {} autodetect\fR .sp method \fBmake {} clean\fR .sp method \fBmake {} compile\fR .sp method \fBmake {} install\fR \fIDEST\fR .sp method \fBMakeDir\fR \fIsrcdir\fR .sp method \fBNmakeOpts\fR .sp method \fBconstructor\fR \fImodule_object\fR \fIname\fR \fIinfo\fR ?\fIaction_body\fR \fB\fR? .sp method \fBdo\fR .sp method \fBcheck\fR .sp method \fBoutput\fR .sp method \fBreset\fR .sp method \fBtriggers\fR .sp method \fBconstructor\fR \fIparent\fR ?\fIargs\fR? .sp method \fBchild\fR \fImethod\fR .sp method \fBgo\fR .sp method \fBcstructure\fR \fIname\fR \fIdefinition\fR ?\fIargdat\fR \fB\fR? .sp method \fBinclude\fR \fIheader\fR .sp method \fBinclude_dir\fR ?\fIargs\fR? .sp method \fBinclude_directory\fR ?\fIargs\fR? .sp method \fBc_header\fR \fIbody\fR .sp method \fBc_code\fR \fIbody\fR .sp method \fBc_function\fR \fIheader\fR \fIbody\fR ?\fIinfo\fR \fB\fR? .sp method \fBc_tcloomethod\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? .sp method \fBcmethod\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? .sp method \fBc_tclproc_nspace\fR \fInspace\fR .sp method \fBc_tclcmd\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? .sp method \fBc_tclproc_raw\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? .sp method \fBtcltype\fR \fIname\fR \fIargdat\fR .sp method \fBproject-compile-products\fR .sp method \fBimplement\fR \fIpath\fR .sp method \fBinitialize\fR .sp method \fBlinktype\fR .sp method \fBgenerate-cfile-constant\fR .sp method \fBgenerate-cfile-header\fR .sp method \fBgenerate-cfile-tclapi\fR .sp method \fBgenerate-loader-module\fR .sp method \fBCollate_Source\fR \fICWD\fR .sp method \fBselect\fR .sp classmethod \fBselect\fR \fIobject\fR .sp method \fBcode\fR \fIsection\fR \fIbody\fR .sp method \fBCollate_Source\fR \fICWD\fR .sp method \fBproject-compile-products\fR .sp method \fBgenerate-debug\fR ?\fIspaces\fR \fB\fR? .sp method \fBgenerate-cfile-constant\fR .sp method \fBgenerate-cfile-public-structure\fR .sp method \fBgenerate-cfile-header\fR .sp method \fBgenerate-cfile-global\fR .sp method \fBgenerate-cfile-private-typedef\fR .sp method \fBgenerate-cfile-private-structure\fR .sp method \fBgenerate-cfile-functions\fR .sp method \fBgenerate-cfile-tclapi\fR .sp method \fBgenerate-hfile-public-define\fR .sp method \fBgenerate-hfile-public-macro\fR .sp method \fBgenerate-hfile-public-typedef\fR .sp method \fBgenerate-hfile-public-structure\fR .sp method \fBgenerate-hfile-public-headers\fR .sp method \fBgenerate-hfile-public-function\fR .sp method \fBgenerate-hfile-public-includes\fR .sp method \fBgenerate-hfile-public-verbatim\fR .sp method \fBgenerate-loader-external\fR .sp method \fBgenerate-loader-module\fR .sp method \fBgenerate-stub-function\fR .sp method \fBIncludeAdd\fR \fIheadervar\fR ?\fIargs\fR? .sp method \fBgenerate-tcl-loader\fR .sp method \fBgenerate-tcl-pre\fR .sp method \fBgenerate-tcl-post\fR .sp method \fBlinktype\fR .sp method \fBOfile\fR \fIfilename\fR .sp method \fBproject-static-packages\fR .sp method \fBtoolset-include-directory\fR .sp method \fBtarget\fR \fImethod\fR ?\fIargs\fR? .sp method \fBproject-compile-products\fR .sp method \fBgenerate-loader-module\fR .sp method \fBproject-compile-products\fR .sp method \fBlinker-products\fR \fIconfigdict\fR .sp method \fBinitialize\fR .sp variable \fBmake_object\fR .sp method \fB_MorphPatterns\fR .sp method \fBadd\fR ?\fIargs\fR? .sp method \fBinstall-headers\fR ?\fIargs\fR? .sp method \fBmake {} _preamble\fR .sp method \fBmake {} pkginfo\fR .sp method \fBmake {} objects\fR .sp method \fBmake {} object\fR \fIname\fR .sp method \fBmake {} reset\fR .sp method \fBmake {} trigger\fR ?\fIargs\fR? .sp method \fBmake {} depends\fR ?\fIargs\fR? .sp method \fBmake {} filename\fR \fIname\fR .sp method \fBmake {} target\fR \fIname\fR \fIInfo\fR \fIbody\fR .sp method \fBmake {} todo\fR .sp method \fBmake {} do\fR .sp method \fBchild\fR \fIwhich\fR .sp method \fBgenerate-c\fR .sp method \fBgenerate-h\fR .sp method \fBgenerate-loader\fR .sp method \fBinitialize\fR .sp method \fBimplement\fR \fIpath\fR .sp method \fBlinktype\fR .sp method \fB_MorphPatterns\fR .sp method \fBconstructor\fR ?\fIargs\fR? .sp method \fBadd_object\fR \fIobject\fR .sp method \fBadd_project\fR \fIpkg\fR \fIinfo\fR ?\fIoodefine\fR \fB\fR? .sp method \fBadd_tool\fR \fIpkg\fR \fIinfo\fR ?\fIoodefine\fR \fB\fR? .sp method \fBbuild-tclcore\fR .sp method \fBchild\fR \fIwhich\fR .sp method \fBlinktype\fR .sp method \fBproject\fR \fIpkg\fR ?\fIargs\fR? .sp method \fBtclcore\fR .sp method \fBtkcore\fR .sp method \fBtool\fR \fIpkg\fR ?\fIargs\fR? .sp method \fBclean\fR \fIPATH\fR .sp method \fBproject-compile-products\fR .sp method \fBgo\fR .sp method \fBgenerate-decls\fR \fIpkgname\fR \fIpath\fR .sp method \fBimplement\fR \fIpath\fR .sp method \fBgenerate-make\fR \fIpath\fR .sp method \fBlinktype\fR .sp method \fBpackage-ifneeded\fR ?\fIargs\fR? .sp method \fBshared_library\fR ?\fIfilename\fR \fB\fR? .sp method \fBstatic_library\fR ?\fIfilename\fR \fB\fR? .sp method \fBbuild-tclkit_main\fR \fIPROJECT\fR \fIPKG_OBJS\fR .sp method \fBCollate_Source\fR \fICWD\fR .sp method \fBwrap\fR \fIPWD\fR \fIexename\fR \fIvfspath\fR ?\fIargs\fR? .sp classmethod \fBSandbox\fR \fIobject\fR .sp classmethod \fBselect\fR \fIobject\fR .sp classmethod \fBclaim_option\fR .sp classmethod \fBclaim_object\fR \fIobject\fR .sp classmethod \fBclaim_path\fR \fIpath\fR .sp method \fBscm_info\fR .sp method \fBDistroMixIn\fR .sp method \fBSandbox\fR .sp method \fBSrcDir\fR .sp method \fBScmTag\fR .sp method \fBScmClone\fR .sp method \fBScmUnpack\fR .sp method \fBScmUpdate\fR .sp method \fBUnpack\fR .sp classmethod \fBclaim_object\fR \fIobject\fR .sp classmethod \fBclaim_option\fR .sp classmethod \fBclaim_path\fR \fIpath\fR .sp method \fBScmUnpack\fR .sp classmethod \fBclaim_object\fR \fIobj\fR .sp classmethod \fBclaim_option\fR .sp classmethod \fBclaim_path\fR \fIpath\fR .sp method \fBscm_info\fR .sp method \fBScmClone\fR .sp method \fBScmTag\fR .sp method \fBScmUnpack\fR .sp method \fBScmUpdate\fR .sp classmethod \fBclaim_object\fR \fIobj\fR .sp classmethod \fBclaim_option\fR .sp classmethod \fBclaim_path\fR \fIpath\fR .sp method \fBScmTag\fR .sp method \fBScmUnpack\fR .sp method \fBScmUpdate\fR .sp method \fB_MorphPatterns\fR .sp method \fBBuildDir\fR \fIPWD\fR .sp method \fBchild\fR \fIwhich\fR .sp method \fBcompile\fR .sp method \fBgo\fR .sp method \fBinstall\fR ?\fIargs\fR? .sp method \fBlinktype\fR .sp method \fBlinker-products\fR \fIconfigdict\fR .sp method \fBlinker-external\fR \fIconfigdict\fR .sp method \fBlinker-extra\fR \fIconfigdict\fR .sp method \fBenv-bootstrap\fR .sp method \fBenv-exec\fR .sp method \fBenv-install\fR .sp method \fBenv-load\fR .sp method \fBenv-present\fR .sp method \fBsources\fR .sp method \fBupdate\fR .sp method \fBunpack\fR .sp method \fBenv-bootstrap\fR .sp method \fBenv-present\fR .sp method \fBlinktype\fR .sp method \fBenv-bootstrap\fR .sp method \fBenv-install\fR .sp method \fBenv-present\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBkettle\fR \fIpath\fR ?\fIargs\fR? .sp method \fBinstall\fR \fIDEST\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBenv-bootstrap\fR .sp method \fBenv-install\fR .sp method \fBenv-present\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBinstall-module\fR \fIDEST\fR ?\fIargs\fR? .sp method \fBenv-bootstrap\fR .sp method \fBenv-install\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBinstall-module\fR \fIDEST\fR ?\fIargs\fR? .sp method \fBclean\fR .sp method \fBenv-install\fR .sp method \fBproject-compile-products\fR .sp method \fBComputeInstall\fR .sp method \fBgo\fR .sp method \fBlinker-products\fR \fIconfigdict\fR .sp method \fBproject-static-packages\fR .sp method \fBBuildDir\fR \fIPWD\fR .sp method \fBcompile\fR .sp method \fBConfigure\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBinstall\fR \fIDEST\fR .sp method \fBenv-bootstrap\fR .sp method \fBenv-present\fR .sp method \fBenv-install\fR .sp method \fBgo\fR .sp method \fBlinktype\fR .sp .BE .SH DESCRIPTION The Practcl module is a tool for integrating large modules for C API Tcl code that requires custom Tcl types and TclOO objects\&. .PP The concept with Practcl is that is a single file package that can assist any tcl based project with distribution, compilation, linking, VFS preparation, executable assembly, and installation\&. Practcl also allows one project to invoke the build system from another project, allowing complex projects such as a statically linked basekit to be assembled with relative ease\&. .PP Practcl ships as a single file, and aside from a Tcl 8\&.6 interpreter, has no external dependencies\&. .PP Making a practcl project .SH COMMANDS .TP proc \fBpractcl::cat\fR \fIfname\fR Concatenate a file .TP proc \fBpractcl::docstrip\fR \fItext\fR Strip the global comments from tcl code\&. Used to prevent the documentation markup comments from clogging up files intended for distribution in machine readable format\&. .TP proc \fBputb\fR ?\fImap\fR? \fItext\fR Append a line of text to a variable\&. Optionally apply a string mapping\&. .TP proc \fBProc\fR \fIname\fR \fIarglist\fR \fIbody\fR Generate a proc if no command already exists by that name .TP proc \fBnoop\fR ?\fIargs\fR? A command to do nothing\&. A handy way of negating an instruction without having to comment it completely out\&. It's also a handy attachment point for an object to be named later .TP proc \fBpractcl::debug\fR ?\fIargs\fR? .TP proc \fBpractcl::doexec\fR ?\fIargs\fR? Drop in a static copy of Tcl .TP proc \fBpractcl::doexec_in\fR \fIpath\fR ?\fIargs\fR? .TP proc \fBpractcl::dotclexec\fR ?\fIargs\fR? .TP proc \fBpractcl::domake\fR \fIpath\fR ?\fIargs\fR? .TP proc \fBpractcl::domake\&.tcl\fR \fIpath\fR ?\fIargs\fR? .TP proc \fBpractcl::fossil\fR \fIpath\fR ?\fIargs\fR? .TP proc \fBpractcl::fossil_status\fR \fIdir\fR .TP proc \fBpractcl::os\fR .TP proc \fBpractcl::mkzip\fR \fIexename\fR \fIbarekit\fR \fIvfspath\fR Build a zipfile\&. On tcl8\&.6 this invokes the native Zip implementation on older interpreters this invokes zip via exec .TP proc \fBpractcl::sort_dict\fR \fIlist\fR Dictionary sort a key/value list\&. Needed because pre tcl8\&.6 does not have \fIlsort -stride 2\fR .TP proc \fBpractcl::local_os\fR .TP proc \fBpractcl::config\&.tcl\fR \fIpath\fR Detect local platform .TP proc \fBpractcl::read_configuration\fR \fIpath\fR .TP proc \fBpractcl::tcllib_require\fR \fIpkg\fR ?\fIargs\fR? Try to load a package, and failing that retrieve tcllib .TP proc \fBpractcl::platform::tcl_core_options\fR \fIos\fR .TP proc \fBpractcl::platform::tk_core_options\fR \fIos\fR .TP proc \fBpractcl::read_rc_file\fR \fIfilename\fR ?\fIlocaldat\fR \fB\fR? Read a stylized key/value list stored in a file .TP proc \fBpractcl::read_sh_subst\fR \fIline\fR \fIinfo\fR Converts a XXX\&.sh file into a series of Tcl variables .TP proc \fBpractcl::read_sh_file\fR \fIfilename\fR ?\fIlocaldat\fR \fB\fR? .TP proc \fBpractcl::read_Config\&.sh\fR \fIfilename\fR A simpler form of read_sh_file tailored to pulling data from (tcl|tk)Config\&.sh .TP proc \fBpractcl::read_Makefile\fR \fIfilename\fR A simpler form of read_sh_file tailored to pulling data from a Makefile .TP proc \fBpractcl::cputs\fR \fIvarname\fR ?\fIargs\fR? Append arguments to a buffer The command works like puts in that each call will also insert a line feed\&. Unlike puts, blank links in the interstitial are suppressed .TP proc \fBpractcl::tcl_to_c\fR \fIbody\fR .TP proc \fBpractcl::_tagblock\fR \fItext\fR ?\fIstyle\fR \fBtcl\fR? ?\fInote\fR \fB\fR? .TP proc \fBpractcl::de_shell\fR \fIdata\fR .TP proc \fBpractcl::grep\fR \fIpattern\fR ?\fIfiles\fR \fB\fR? Search for the pattern \fIpattern\fR amongst $files .TP proc \fBpractcl::file_lexnormalize\fR \fIsp\fR .TP proc \fBpractcl::file_relative\fR \fIbase\fR \fIdst\fR Calculate a relative path between base and dst .sp Example: .CS ::practcl::file_relative ~/build/tcl/unix ~/build/tcl/library > \&.\&./library .CE .TP proc \fBpractcl::findByPattern\fR \fIbasedir\fR \fIpatterns\fR .TP proc \fBpractcl::log\fR \fIfname\fR \fIcomment\fR Record an event in the practcl log .TP proc \fBpractcl::_pkgindex_simpleIndex\fR \fIpath\fR .TP proc \fBpractcl::_pkgindex_directory\fR \fIpath\fR Return true if the pkgindex file contains any statement other than "package ifneeded" and/or if any package ifneeded loads a DLL .TP proc \fBpractcl::_pkgindex_path_subdir\fR \fIpath\fR Helper function for ::practcl::pkgindex_path .TP proc \fBpractcl::pkgindex_path\fR ?\fIargs\fR? Index all paths given as though they will end up in the same virtual file system .TP proc \fBpractcl::installDir\fR \fId1\fR \fId2\fR Delete the contents of \fId2\fR, and then recusively Ccopy the contents of \fId1\fR to \fId2\fR\&. .TP proc \fBpractcl::copyDir\fR \fId1\fR \fId2\fR ?\fItoplevel\fR \fB1\fR? Recursively copy the contents of \fId1\fR to \fId2\fR .TP proc \fBpractcl::buildModule\fR \fImodpath\fR .TP proc \fBpractcl::installModule\fR \fImodpath\fR \fIDEST\fR .TP proc \fBpractcl::trigger\fR ?\fIargs\fR? Trigger build targets, and recompute dependencies .sp Internals: .CS ::practcl::LOCAL make trigger {*}$args foreach {name obj} [::practcl::LOCAL make objects] { set ::make($name) [$obj do] } .CE .TP proc \fBpractcl::depends\fR ?\fIargs\fR? Calculate if a dependency for any of the arguments needs to be fulfilled or rebuilt\&. .sp Internals: .CS ::practcl::LOCAL make depends {*}$args .CE .TP proc \fBpractcl::target\fR \fIname\fR \fIinfo\fR ?\fIaction\fR \fB\fR? Declare a build product\&. This proc is just a shorthand for \fI::practcl::LOCAL make task $name $info $action\fR .sp Registering a build product with this command will create an entry in the global array, and populate a value in the global array\&. .sp Internals: .CS set obj [::practcl::LOCAL make task $name $info $action] set ::make($name) 0 set filename [$obj define get filename] if {$filename ne {}} { set ::target($name) $filename } .CE .PP .SH CLASSES .SS "CLASS PRACTCL::DOCTOOL" .CS { set authors { {John Doe} {jdoe@illustrious\&.edu} {Tom RichardHarry} {tomdickharry@illustrius\&.edu} } # Create the object ::practcl::doctool create AutoDoc set fout [open [file join $moddir module\&.tcl] w] foreach file [glob [file join $srcdir *\&.tcl]] { set content [::practcl::cat [file join $srcdir $file]] # Scan the file AutoDoc scan_text $content # Strip the comments from the distribution puts $fout [::practcl::docstrip $content] } # Write out the manual page set manout [open [file join $moddir module\&.man] w] dict set args header [string map $modmap [::practcl::cat [file join $srcdir manual\&.txt]]] dict set args footer [string map $modmap [::practcl::cat [file join $srcdir footer\&.txt]]] dict set args authors $authors puts $manout [AutoDoc manpage {*}$args] close $manout } .CE .PP Tool for build scripts to dynamically generate manual files from comments in source code files .PP \fBMethods\fR .TP method \fBconstructor\fR .TP method \fBargspec\fR \fIargspec\fR Process an argument list into an informational dict\&. This method also understands non-positional arguments expressed in the notation of Tip 471 \fIhttps://core\&.tcl-lang\&.org/tips/doc/trunk/tip/479\&.md\fR\&. .sp The output will be a dictionary of all of the fields and whether the fields are \fBpositional\fR, \fBmandatory\fR, and whether they have a \fBdefault\fR value\&. .sp .sp Example: .CS my argspec {a b {c 10}} > a {positional 1 mandatory 1} b {positional 1 mandatory 1} c {positional 1 mandatory 0 default 10} .CE .TP method \fBcomment\fR \fIblock\fR Convert a block of comments into an informational dictionary\&. If lines in the comment start with a single word ending in a colon, all subsequent lines are appended to a dictionary field of that name\&. If no fields are given, all of the text is appended to the \fBdescription\fR field\&. .sp Example: .CS my comment {Does something cool} > description {Does something cool} my comment { title : Something really cool author : Sean Woods author : John Doe description : This does something really cool! } > description {This does something really cool!} title {Something really cool} author {Sean Woods John Doe} .CE .TP method \fBkeyword\&.Annotation\fR \fIresultvar\fR \fIcommentblock\fR \fItype\fR \fIname\fR \fIbody\fR .TP method \fBkeyword\&.Class\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR \fIbody\fR Process an oo::objdefine call that modifies the class object itself .TP method \fBkeyword\&.class\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR \fIbody\fR Process an oo::define, clay::define, etc statement\&. .TP method \fBkeyword\&.Class_Method\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR ?\fIargs\fR? Process a statement for a clay style class method .TP method \fBkeyword\&.method\fR \fIresultvar\fR \fIcommentblock\fR \fIname\fR ?\fIargs\fR? Process a statement for a tcloo style object method .TP method \fBkeyword\&.proc\fR \fIcommentblock\fR \fIname\fR \fIargspec\fR Process a proc statement .TP method \fBreset\fR Reset the state of the object and its embedded coroutine .TP method \fBMain\fR Main body of the embedded coroutine for the object .TP method \fBsection\&.method\fR \fIkeyword\fR \fImethod\fR \fIminfo\fR Generate the manual page text for a method or proc .TP method \fBsection\&.annotation\fR \fItype\fR \fIname\fR \fIiinfo\fR .TP method \fBsection\&.class\fR \fIclass_name\fR \fIclass_info\fR Generate the manual page text for a class .TP method \fBsection\&.command\fR \fIprocinfo\fR Generate the manual page text for the commands section .TP method \fBmanpage\fR ?\fBheader \fIvalue\fR\fR? ?\fBfooter \fIvalue\fR\fR? ?\fBauthors \fIlist\fR\fR? Generate the manual page\&. Returns the completed text suitable for saving in \&.man file\&. The header argument is a block of doctools text to go in before the machine generated section\&. footer is a block of doctools text to go in after the machine generated section\&. authors is a list of individual authors and emails in the form of AUTHOR EMAIL ?AUTHOR EMAIL?\&.\&.\&. .TP method \fBscan_text\fR \fItext\fR Scan a block of text .TP method \fBscan_file\fR \fIfilename\fR Scan a file of text .PP .PP .SS "CLASS PRACTCL::METACLASS" The metaclass for all practcl objects .PP \fBMethods\fR .TP method \fB_MorphPatterns\fR .TP method \fBdefine\fR \fIsubmethod\fR ?\fIargs\fR? .TP method \fBgraft\fR ?\fIargs\fR? .TP method \fBinitialize\fR .TP method \fBlink\fR \fIcommand\fR ?\fIargs\fR? .TP method \fBmorph\fR \fIclassname\fR .TP method \fBscript\fR \fIscript\fR .TP method \fBselect\fR .TP method \fBsource\fR \fIfilename\fR .PP .PP .SS "CLASS PRACTCL::TOOLSET" Ancestor-less class intended to be a mixin which defines a family of build related behaviors that are modified when targetting either gcc or msvc .PP \fBClass Methods\fR .TP classmethod \fBselect\fR \fIobject\fR Perform the selection for the toolset mixin .PP .PP \fBMethods\fR .TP method \fBconfig\&.sh\fR find or fake a key/value list describing this project .TP method \fBBuildDir\fR \fIPWD\fR Compute the location where the product will be built .TP method \fBMakeDir\fR \fIsrcdir\fR Return where the Makefile is located relative to \fIsrcdir\fR\&. For this implementation the MakeDir is always srcdir\&. .TP method \fBread_configuration\fR Read information about the build process for this package\&. For this implementation, data is sought in the following locations in the following order: config\&.tcl (generated by practcl\&.) PKGConfig\&.sh\&. The Makefile .sp If the Makefile needs to be consulted, but does not exist, the Configure method is invoked .TP method \fBbuild-cflags\fR \fIPROJECT\fR \fIDEFS\fR \fInamevar\fR \fIversionvar\fR \fIdefsvar\fR method DEFS This method populates 4 variables: name - The name of the package version - The version of the package defs - C flags passed to the compiler includedir - A list of paths to feed to the compiler for finding headers .TP method \fBcritcl\fR ?\fIargs\fR? Invoke critcl in an external process .PP .PP .SS "CLASS PRACTCL::TOOLSET\&.GCC" \fIancestors\fR: \fBpractcl::toolset\fR .PP .PP \fBMethods\fR .TP method \fBAutoconf\fR .TP method \fBBuildDir\fR \fIPWD\fR .TP method \fBConfigureOpts\fR .TP method \fBMakeDir\fR \fIsrcdir\fR Detect what directory contains the Makefile template .TP method \fBmake {} autodetect\fR .TP method \fBmake {} clean\fR .TP method \fBmake {} compile\fR .TP method \fBmake {} install\fR \fIDEST\fR .TP method \fBbuild-compile-sources\fR \fIPROJECT\fR \fICOMPILE\fR \fICPPCOMPILE\fR \fIINCLUDES\fR .TP method \fBbuild-Makefile\fR \fIpath\fR \fIPROJECT\fR .TP method \fBbuild-library\fR \fIoutfile\fR \fIPROJECT\fR Produce a static or dynamic library .TP method \fBbuild-tclsh\fR \fIoutfile\fR \fIPROJECT\fR ?\fIpath\fR \fBauto\fR? Produce a static executable .PP .PP .SS "CLASS PRACTCL::TOOLSET\&.MSVC" \fIancestors\fR: \fBpractcl::toolset\fR .PP .PP \fBMethods\fR .TP method \fBBuildDir\fR \fIPWD\fR MSVC always builds in the source directory .TP method \fBmake {} autodetect\fR Do nothing .TP method \fBmake {} clean\fR .TP method \fBmake {} compile\fR .TP method \fBmake {} install\fR \fIDEST\fR .TP method \fBMakeDir\fR \fIsrcdir\fR Detect what directory contains the Makefile template .TP method \fBNmakeOpts\fR .PP .PP .SS "CLASS PRACTCL::MAKE_OBJ" \fIancestors\fR: \fBpractcl::metaclass\fR .PP A build deliverable object\&. Normally an object file, header, or tcl script which must be compiled or generated in some way .PP \fBMethods\fR .TP method \fBconstructor\fR \fImodule_object\fR \fIname\fR \fIinfo\fR ?\fIaction_body\fR \fB\fR? .TP method \fBdo\fR .TP method \fBcheck\fR .TP method \fBoutput\fR .TP method \fBreset\fR .TP method \fBtriggers\fR .PP .PP .SS "CLASS PRACTCL::OBJECT" \fIancestors\fR: \fBpractcl::metaclass\fR .PP A generic Practcl object .PP \fBMethods\fR .TP method \fBconstructor\fR \fIparent\fR ?\fIargs\fR? .TP method \fBchild\fR \fImethod\fR .TP method \fBgo\fR .PP .PP .SS "CLASS PRACTCL::DYNAMIC" Dynamic blocks do not generate their own \&.c files, instead the contribute to the amalgamation of the main library file .PP \fBMethods\fR .TP method \fBcstructure\fR \fIname\fR \fIdefinition\fR ?\fIargdat\fR \fB\fR? Parser functions .TP method \fBinclude\fR \fIheader\fR .TP method \fBinclude_dir\fR ?\fIargs\fR? .TP method \fBinclude_directory\fR ?\fIargs\fR? .TP method \fBc_header\fR \fIbody\fR .TP method \fBc_code\fR \fIbody\fR .TP method \fBc_function\fR \fIheader\fR \fIbody\fR ?\fIinfo\fR \fB\fR? .TP method \fBc_tcloomethod\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? .TP method \fBcmethod\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? Alias to classic name .TP method \fBc_tclproc_nspace\fR \fInspace\fR .TP method \fBc_tclcmd\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? .TP method \fBc_tclproc_raw\fR \fIname\fR \fIbody\fR ?\fIarginfo\fR \fB\fR? Alias to classic name .TP method \fBtcltype\fR \fIname\fR \fIargdat\fR .TP method \fBproject-compile-products\fR Module interactions .TP method \fBimplement\fR \fIpath\fR .TP method \fBinitialize\fR Practcl internals .TP method \fBlinktype\fR .TP method \fBgenerate-cfile-constant\fR .TP method \fBgenerate-cfile-header\fR .TP method \fBgenerate-cfile-tclapi\fR Generate code that provides implements Tcl API calls .TP method \fBgenerate-loader-module\fR Generate code that runs when the package/module is initialized into the interpreter .TP method \fBCollate_Source\fR \fICWD\fR .TP method \fBselect\fR Once an object marks itself as some flavor of dynamic, stop trying to morph it into something else .PP .PP .SS "CLASS PRACTCL::PRODUCT" A deliverable for the build system .PP \fBClass Methods\fR .TP classmethod \fBselect\fR \fIobject\fR .PP .PP \fBMethods\fR .TP method \fBcode\fR \fIsection\fR \fIbody\fR .TP method \fBCollate_Source\fR \fICWD\fR .TP method \fBproject-compile-products\fR .TP method \fBgenerate-debug\fR ?\fIspaces\fR \fB\fR? .TP method \fBgenerate-cfile-constant\fR .TP method \fBgenerate-cfile-public-structure\fR Populate const static data structures .TP method \fBgenerate-cfile-header\fR .TP method \fBgenerate-cfile-global\fR .TP method \fBgenerate-cfile-private-typedef\fR .TP method \fBgenerate-cfile-private-structure\fR .TP method \fBgenerate-cfile-functions\fR Generate code that provides subroutines called by Tcl API methods .TP method \fBgenerate-cfile-tclapi\fR Generate code that provides implements Tcl API calls .TP method \fBgenerate-hfile-public-define\fR .TP method \fBgenerate-hfile-public-macro\fR .TP method \fBgenerate-hfile-public-typedef\fR .TP method \fBgenerate-hfile-public-structure\fR .TP method \fBgenerate-hfile-public-headers\fR .TP method \fBgenerate-hfile-public-function\fR .TP method \fBgenerate-hfile-public-includes\fR .TP method \fBgenerate-hfile-public-verbatim\fR .TP method \fBgenerate-loader-external\fR .TP method \fBgenerate-loader-module\fR .TP method \fBgenerate-stub-function\fR .TP method \fBIncludeAdd\fR \fIheadervar\fR ?\fIargs\fR? .TP method \fBgenerate-tcl-loader\fR .TP method \fBgenerate-tcl-pre\fR This methods generates any Tcl script file which is required to pre-initialize the C library .TP method \fBgenerate-tcl-post\fR .TP method \fBlinktype\fR .TP method \fBOfile\fR \fIfilename\fR .TP method \fBproject-static-packages\fR Methods called by the master project .TP method \fBtoolset-include-directory\fR Methods called by the toolset .TP method \fBtarget\fR \fImethod\fR ?\fIargs\fR? .PP .PP .SS "CLASS PRACTCL::PRODUCT\&.CHEADER" \fIancestors\fR: \fBpractcl::product\fR .PP A product which generated from a C header file\&. Which is to say, nothing\&. .PP \fBMethods\fR .TP method \fBproject-compile-products\fR .TP method \fBgenerate-loader-module\fR .PP .PP .SS "CLASS PRACTCL::PRODUCT\&.CSOURCE" \fIancestors\fR: \fBpractcl::product\fR .PP A product which generated from a C source file\&. Normally an object (\&.o) file\&. .PP \fBMethods\fR .TP method \fBproject-compile-products\fR .PP .PP .SS "CLASS PRACTCL::PRODUCT\&.CLIBRARY" \fIancestors\fR: \fBpractcl::product\fR .PP A product which is generated from a compiled C library\&. Usually a \&.a or a \&.dylib file, but in complex cases may actually just be a conduit for one project to integrate the source code of another .PP \fBMethods\fR .TP method \fBlinker-products\fR \fIconfigdict\fR .PP .PP .SS "CLASS PRACTCL::PRODUCT\&.DYNAMIC" \fIancestors\fR: \fBpractcl::dynamic\fR \fBpractcl::product\fR .PP A product which is generated from C code that itself is generated by practcl or some other means\&. This C file may or may not produce its own \&.o file, depending on whether it is eligible to become part of an amalgamation .PP \fBMethods\fR .TP method \fBinitialize\fR .PP .PP .SS "CLASS PRACTCL::PRODUCT\&.CRITCL" \fIancestors\fR: \fBpractcl::dynamic\fR \fBpractcl::product\fR .PP A binary product produced by critcl\&. Note: The implementation is not written yet, this class does nothing\&. .PP .SS "CLASS PRACTCL::MODULE" \fIancestors\fR: \fBpractcl::object\fR \fBpractcl::product\&.dynamic\fR .PP In the end, all C code must be loaded into a module This will either be a dynamically loaded library implementing a tcl extension, or a compiled in segment of a custom shell/app .PP \fBVariable\fR .TP variable \fBmake_object\fR .PP .PP \fBMethods\fR .TP method \fB_MorphPatterns\fR .TP method \fBadd\fR ?\fIargs\fR? .TP method \fBinstall-headers\fR ?\fIargs\fR? .TP method \fBmake {} _preamble\fR .TP method \fBmake {} pkginfo\fR .TP method \fBmake {} objects\fR Return a dictionary of all handles and associated objects .TP method \fBmake {} object\fR \fIname\fR Return the object associated with handle \fIname\fR .TP method \fBmake {} reset\fR Reset all deputy objects .TP method \fBmake {} trigger\fR ?\fIargs\fR? Exercise the triggers method for all handles listed .TP method \fBmake {} depends\fR ?\fIargs\fR? Exercise the check method for all handles listed .TP method \fBmake {} filename\fR \fIname\fR Return the file name of the build product for the listed handle .TP method \fBmake {} target\fR \fIname\fR \fIInfo\fR \fIbody\fR .TP method \fBmake {} todo\fR Return a list of handles for object which return true for the do method .TP method \fBmake {} do\fR For each target exercise the action specified in the \fIaction\fR definition if the \fIdo\fR method returns true .TP method \fBchild\fR \fIwhich\fR .TP method \fBgenerate-c\fR This methods generates the contents of an amalgamated \&.c file which implements the loader for a batch of tools .TP method \fBgenerate-h\fR This methods generates the contents of an amalgamated \&.h file which describes the public API of this module .TP method \fBgenerate-loader\fR .TP method \fBinitialize\fR .TP method \fBimplement\fR \fIpath\fR .TP method \fBlinktype\fR .PP .PP .SS "CLASS PRACTCL::PROJECT" \fIancestors\fR: \fBpractcl::module\fR .PP A toplevel project that is a collection of other projects .PP \fBMethods\fR .TP method \fB_MorphPatterns\fR .TP method \fBconstructor\fR ?\fIargs\fR? .TP method \fBadd_object\fR \fIobject\fR .TP method \fBadd_project\fR \fIpkg\fR \fIinfo\fR ?\fIoodefine\fR \fB\fR? .TP method \fBadd_tool\fR \fIpkg\fR \fIinfo\fR ?\fIoodefine\fR \fB\fR? .TP method \fBbuild-tclcore\fR Compile the Tcl core\&. If the define \fItk\fR is true, compile the Tk core as well .TP method \fBchild\fR \fIwhich\fR .TP method \fBlinktype\fR .TP method \fBproject\fR \fIpkg\fR ?\fIargs\fR? Exercise the methods of a sub-object .TP method \fBtclcore\fR .TP method \fBtkcore\fR .TP method \fBtool\fR \fIpkg\fR ?\fIargs\fR? .PP .PP .SS "CLASS PRACTCL::LIBRARY" \fIancestors\fR: \fBpractcl::project\fR .PP A toplevel project that produces a library .PP \fBMethods\fR .TP method \fBclean\fR \fIPATH\fR .TP method \fBproject-compile-products\fR .TP method \fBgo\fR .TP method \fBgenerate-decls\fR \fIpkgname\fR \fIpath\fR .TP method \fBimplement\fR \fIpath\fR .TP method \fBgenerate-make\fR \fIpath\fR Backward compadible call .TP method \fBlinktype\fR .TP method \fBpackage-ifneeded\fR ?\fIargs\fR? Create a "package ifneeded" Args are a list of aliases for which this package will answer to .TP method \fBshared_library\fR ?\fIfilename\fR \fB\fR? .TP method \fBstatic_library\fR ?\fIfilename\fR \fB\fR? .PP .PP .SS "CLASS PRACTCL::TCLKIT" \fIancestors\fR: \fBpractcl::library\fR .PP A toplevel project that produces a self-contained executable .PP \fBMethods\fR .TP method \fBbuild-tclkit_main\fR \fIPROJECT\fR \fIPKG_OBJS\fR .TP method \fBCollate_Source\fR \fICWD\fR .TP method \fBwrap\fR \fIPWD\fR \fIexename\fR \fIvfspath\fR ?\fIargs\fR? Wrap an executable .PP .PP .SS "CLASS PRACTCL::DISTRIBUTION" Standalone class to manage code distribution This class is intended to be mixed into another class (Thus the lack of ancestors) .PP \fBClass Methods\fR .TP classmethod \fBSandbox\fR \fIobject\fR .TP classmethod \fBselect\fR \fIobject\fR .TP classmethod \fBclaim_option\fR .TP classmethod \fBclaim_object\fR \fIobject\fR .TP classmethod \fBclaim_path\fR \fIpath\fR .PP .PP \fBMethods\fR .TP method \fBscm_info\fR .TP method \fBDistroMixIn\fR .TP method \fBSandbox\fR .TP method \fBSrcDir\fR .TP method \fBScmTag\fR .TP method \fBScmClone\fR .TP method \fBScmUnpack\fR .TP method \fBScmUpdate\fR .TP method \fBUnpack\fR .PP .PP .SS "CLASS PRACTCL::DISTRIBUTION\&.SNAPSHOT" \fIancestors\fR: \fBpractcl::distribution\fR .PP A file distribution from zip, tarball, or other non-scm archive format .PP \fBClass Methods\fR .TP classmethod \fBclaim_object\fR \fIobject\fR .TP classmethod \fBclaim_option\fR .TP classmethod \fBclaim_path\fR \fIpath\fR .PP .PP \fBMethods\fR .TP method \fBScmUnpack\fR .PP .PP .SS "CLASS PRACTCL::DISTRIBUTION\&.FOSSIL" \fIancestors\fR: \fBpractcl::distribution\fR .PP A file distribution based on fossil .PP \fBClass Methods\fR .TP classmethod \fBclaim_object\fR \fIobj\fR Check for markers in the metadata .TP classmethod \fBclaim_option\fR .TP classmethod \fBclaim_path\fR \fIpath\fR Check for markers in the source root .PP .PP \fBMethods\fR .TP method \fBscm_info\fR .TP method \fBScmClone\fR Clone the source .TP method \fBScmTag\fR .TP method \fBScmUnpack\fR .TP method \fBScmUpdate\fR .PP .PP .SS "CLASS PRACTCL::DISTRIBUTION\&.GIT" \fIancestors\fR: \fBpractcl::distribution\fR .PP A file distribution based on git .PP \fBClass Methods\fR .TP classmethod \fBclaim_object\fR \fIobj\fR .TP classmethod \fBclaim_option\fR .TP classmethod \fBclaim_path\fR \fIpath\fR .PP .PP \fBMethods\fR .TP method \fBScmTag\fR .TP method \fBScmUnpack\fR .TP method \fBScmUpdate\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT" \fIancestors\fR: \fBpractcl::module\fR .PP A subordinate project .PP \fBMethods\fR .TP method \fB_MorphPatterns\fR .TP method \fBBuildDir\fR \fIPWD\fR .TP method \fBchild\fR \fIwhich\fR .TP method \fBcompile\fR .TP method \fBgo\fR .TP method \fBinstall\fR ?\fIargs\fR? Install project into the local build system .TP method \fBlinktype\fR .TP method \fBlinker-products\fR \fIconfigdict\fR .TP method \fBlinker-external\fR \fIconfigdict\fR .TP method \fBlinker-extra\fR \fIconfigdict\fR .TP method \fBenv-bootstrap\fR Methods for packages/tools that can be downloaded possibly built and used internally by this Practcl process Load the facility into the interpreter .TP method \fBenv-exec\fR Return a file path that exec can call .TP method \fBenv-install\fR Install the tool into the local environment .TP method \fBenv-load\fR Do whatever is necessary to get the tool into the local environment .TP method \fBenv-present\fR Check if tool is available for load/already loaded .TP method \fBsources\fR .TP method \fBupdate\fR .TP method \fBunpack\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.SOURCE" \fIancestors\fR: \fBpractcl::subproject\fR \fBpractcl::library\fR .PP A project which the kit compiles and integrates the source for itself .PP \fBMethods\fR .TP method \fBenv-bootstrap\fR .TP method \fBenv-present\fR .TP method \fBlinktype\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.TEAPOT" \fIancestors\fR: \fBpractcl::subproject\fR .PP a copy from the teapot .PP \fBMethods\fR .TP method \fBenv-bootstrap\fR .TP method \fBenv-install\fR .TP method \fBenv-present\fR .TP method \fBinstall\fR \fIDEST\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.KETTLE" \fIancestors\fR: \fBpractcl::subproject\fR .PP .PP \fBMethods\fR .TP method \fBkettle\fR \fIpath\fR ?\fIargs\fR? .TP method \fBinstall\fR \fIDEST\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.CRITCL" \fIancestors\fR: \fBpractcl::subproject\fR .PP .PP \fBMethods\fR .TP method \fBinstall\fR \fIDEST\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.SAK" \fIancestors\fR: \fBpractcl::subproject\fR .PP .PP \fBMethods\fR .TP method \fBenv-bootstrap\fR .TP method \fBenv-install\fR .TP method \fBenv-present\fR .TP method \fBinstall\fR \fIDEST\fR .TP method \fBinstall-module\fR \fIDEST\fR ?\fIargs\fR? .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.PRACTCL" \fIancestors\fR: \fBpractcl::subproject\fR .PP .PP \fBMethods\fR .TP method \fBenv-bootstrap\fR .TP method \fBenv-install\fR .TP method \fBinstall\fR \fIDEST\fR .TP method \fBinstall-module\fR \fIDEST\fR ?\fIargs\fR? .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.BINARY" \fIancestors\fR: \fBpractcl::subproject\fR .PP A subordinate binary package .PP \fBMethods\fR .TP method \fBclean\fR .TP method \fBenv-install\fR .TP method \fBproject-compile-products\fR .TP method \fBComputeInstall\fR .TP method \fBgo\fR .TP method \fBlinker-products\fR \fIconfigdict\fR .TP method \fBproject-static-packages\fR .TP method \fBBuildDir\fR \fIPWD\fR .TP method \fBcompile\fR .TP method \fBConfigure\fR .TP method \fBinstall\fR \fIDEST\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.TEA" \fIancestors\fR: \fBpractcl::subproject\&.binary\fR .PP A subordinate TEA based binary package .PP .SS "CLASS PRACTCL::SUBPROJECT\&.LIBRARY" \fIancestors\fR: \fBpractcl::subproject\&.binary\fR \fBpractcl::library\fR .PP A subordinate C library built by this project .PP \fBMethods\fR .TP method \fBinstall\fR \fIDEST\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.EXTERNAL" \fIancestors\fR: \fBpractcl::subproject\&.binary\fR .PP A subordinate external C library .PP \fBMethods\fR .TP method \fBinstall\fR \fIDEST\fR .PP .PP .SS "CLASS PRACTCL::SUBPROJECT\&.CORE" \fIancestors\fR: \fBpractcl::subproject\&.binary\fR .PP .PP \fBMethods\fR .TP method \fBenv-bootstrap\fR .TP method \fBenv-present\fR .TP method \fBenv-install\fR .TP method \fBgo\fR .TP method \fBlinktype\fR .PP .PP .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fIpractcl\fR of the \fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&. Please also report any ideas for enhancements you may have for either |
︙ | ︙ |
Changes to idoc/man/files/modules/pt/pt_peg_export.n.
1 2 3 4 | '\" '\" Generated from file 'pt_peg_export\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'pt_peg_export\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "pt::peg::export" n 1\&.0\&.1 tcllib "Parser Tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
274 275 276 277 278 279 280 | .SH NAME pt::peg::export \- PEG Export .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBsnit \fR .sp | | | | 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | .SH NAME pt::peg::export \- PEG Export .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBsnit \fR .sp package require \fBstruct::map \fR .sp package require \fBpt::peg \fR .sp package require \fBpluginmgr \fR .sp package require \fBpt::peg::export ?1\&.0\&.1?\fR .sp \fB::pt::peg::export\fR \fIobjectName\fR .sp \fBobjectName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? .sp \fIobjectName\fR \fBdestroy\fR .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/pt/pt_peg_import.n.
1 2 3 4 | '\" '\" Generated from file 'pt_peg_import\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'pt_peg_import\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "pt::peg::import" n 1\&.0\&.1 tcllib "Parser Tools" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME pt::peg::import \- PEG Import .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp | | | > > | | 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 | .. .BS .SH NAME pt::peg::import \- PEG Import .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBTcl 8\&.5\fR .sp package require \fBsnit \fR .sp package require \fBfileutil::paths \fR .sp package require \fBpt::peg \fR .sp package require \fBpluginmgr \fR .sp package require \fBpt::peg::import ?1\&.0\&.1?\fR .sp \fB::pt::peg::import\fR \fIobjectName\fR .sp \fBobjectName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? .sp \fIobjectName\fR \fBdestroy\fR .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/sha1/sha1.n.
1 2 3 4 | '\" '\" Generated from file 'sha1\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2005, Pat Thoyts <patthoyts@users\&.sourceforge\&.net> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'sha1\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2005, Pat Thoyts <patthoyts@users\&.sourceforge\&.net> '\" .TH "sha1" n 2\&.0\&.4 tcllib "SHA-x Message-Digest Algorithm" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME sha1 \- SHA1 Message-Digest Algorithm .SH SYNOPSIS package require \fBTcl 8\&.2\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME sha1 \- SHA1 Message-Digest Algorithm .SH SYNOPSIS package require \fBTcl 8\&.2\fR .sp package require \fBsha1 ?2\&.0\&.4?\fR .sp \fB::sha1::sha1\fR ?\fB-hex|-bin\fR? [ \fB-channel channel\fR | \fB-file filename\fR | ?\fB--\fR? \fIstring\fR ] .sp \fB::sha1::hmac\fR \fIkey\fR \fIstring\fR .sp \fB::sha1::hmac\fR ?\fB-hex|-bin\fR? \fB-key key\fR [ \fB-channel channel\fR | \fB-file filename\fR | ?\fB--\fR? \fIstring\fR ] .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/sha1/sha256.n.
1 2 3 4 | '\" '\" Generated from file 'sha256\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2008, Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'sha256\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2008, Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "sha256" n 1\&.0\&.4 tcllib "SHA-x Message-Digest Algorithm" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME sha256 \- SHA256 Message-Digest Algorithm .SH SYNOPSIS package require \fBTcl 8\&.2\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME sha256 \- SHA256 Message-Digest Algorithm .SH SYNOPSIS package require \fBTcl 8\&.2\fR .sp package require \fBsha256 ?1\&.0\&.4?\fR .sp \fB::sha2::sha256\fR ?\fB-hex|-bin\fR? [ \fB-channel channel\fR | \fB-file filename\fR | ?\fB--\fR? \fIstring\fR ] .sp \fB::sha2::sha224\fR ?\fB-hex|-bin\fR? [ \fB-channel channel\fR | \fB-file filename\fR | ?\fB--\fR? \fIstring\fR ] .sp \fB::sha2::hmac\fR \fIkey\fR \fIstring\fR .sp |
︙ | ︙ |
Changes to idoc/man/files/modules/struct/graph.n.
1 2 | '\" '\" Generated from file 'graph\&.man' by tcllib/doctools with format 'nroff' | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'graph\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2002-2009,2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "struct::graph" n 2\&.4\&.2 tcllib "Tcl Data Structures" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME struct::graph \- Create and manipulate directed graph objects .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME struct::graph \- Create and manipulate directed graph objects .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp package require \fBstruct::graph ?2\&.4\&.2?\fR .sp package require \fBstruct::list ?1\&.5?\fR .sp package require \fBstruct::set ?2\&.2\&.3?\fR .sp \fB::struct::graph\fR ?\fIgraphName\fR? ?\fB=\fR|\fB:=\fR|\fBas\fR|\fBdeserialize\fR \fIsource\fR? .sp |
︙ | ︙ | |||
723 724 725 726 727 728 729 | of returned arcs based on the nodes that are connected by the arc, on the keyed values associated with the arc, or both\&. A general filter command can be used as well\&. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself\&. .sp The restrictions imposed by either \fB-in\fR, \fB-out\fR, | | | 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 | of returned arcs based on the nodes that are connected by the arc, on the keyed values associated with the arc, or both\&. A general filter command can be used as well\&. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself\&. .sp The restrictions imposed by either \fB-in\fR, \fB-out\fR, \fB-adj\fR, \fB-inner\fR, or \fB-embedding\fR are applied first\&. Specifying more than one of them is illegal\&. .sp After that the restrictions set via \fB-key\fR (and \fB-value\fR) are applied\&. Specifying more than one \fB-key\fR (and \fB-value\fR) is illegal\&. Specifying \fB-value\fR alone, without \fB-key\fR is illegal as well\&. .sp |
︙ | ︙ | |||
762 763 764 765 766 767 768 769 770 771 772 773 774 775 | the set\&. This is the set of arcs in the subgraph spawned by the specified nodes\&. .TP \fB-embedding\fR Return a list of all arcs adjacent to exactly one of the nodes in the set\&. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph\&. .TP \fB-key\fR \fIkey\fR Limit the list of arcs that are returned to those arcs that have an associated key \fIkey\fR\&. .TP \fB-value\fR \fIvalue\fR This restriction can only be used in combination with | > > > > > > > > > > > | 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 | the set\&. This is the set of arcs in the subgraph spawned by the specified nodes\&. .TP \fB-embedding\fR Return a list of all arcs adjacent to exactly one of the nodes in the set\&. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph\&. .RE .IP \fIAttention\fR: After the above options any word with a leading dash which is not a valid option is treated as a node name instead of an invalid option to error out on\&. This condition holds until either a valid option terminates the list of nodes, or the end of the command is reached, whichever comes first\&. .sp The remaining filter options are: .sp .RS .TP \fB-key\fR \fIkey\fR Limit the list of arcs that are returned to those arcs that have an associated key \fIkey\fR\&. .TP \fB-value\fR \fIvalue\fR This restriction can only be used in combination with |
︙ | ︙ | |||
892 893 894 895 896 897 898 | \fIgraphName\fR \fBnodes\fR ?-key \fIkey\fR? ?-value \fIvalue\fR? ?-filter \fIcmdprefix\fR? ?-in|-out|-adj|-inner|-embedding \fInode\fR \fInode\fR\&.\&.\&.? Return a list of nodes in the graph\&. Restrictions can limit the list of returned nodes based on neighboring nodes, or based on the keyed values associated with the node\&. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself\&. .sp | | | > > > > | | 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 | \fIgraphName\fR \fBnodes\fR ?-key \fIkey\fR? ?-value \fIvalue\fR? ?-filter \fIcmdprefix\fR? ?-in|-out|-adj|-inner|-embedding \fInode\fR \fInode\fR\&.\&.\&.? Return a list of nodes in the graph\&. Restrictions can limit the list of returned nodes based on neighboring nodes, or based on the keyed values associated with the node\&. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself\&. .sp The possible restrictions are the same as for method \fBarcs\fR\&. Note that while the exact meanings change slightly, as they operate on nodes instead of arcs, the general behaviour is the same, especially when it comes to the handling of words with a leading dash in node lists\&. .sp The command recognizes: .RS .TP \fB-in\fR Return a list of all nodes with at least one outgoing arc ending in a node found in the specified set of nodes\&. Alternatively specified as the set of source nodes for the \fB-in\fR arcs of the node set\&. The \fIincoming neighbours\fR\&. |
︙ | ︙ | |||
1031 1032 1033 1034 1035 1036 1037 | relevance, nor has the order of the arcs per node\&. .CS # A possible serialization for the graph structure # # d -----> %2 | | | | | | 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 | relevance, nor has the order of the arcs per node\&. .CS # A possible serialization for the graph structure # # d -----> %2 # / ^ \\ # / / \\ # / b \\ # / / \\ # %1 <- a - %0 e # ^ \\\\ / # \\\\ c / # \\\\ \\\\ / # \\\\ v v # f ------ %3 # is |
︙ | ︙ | |||
1160 1161 1162 1163 1164 1165 1166 | left-most button in the secondary navigation bar\&. .SH KEYWORDS adjacent, arc, cgraph, degree, edge, graph, loop, neighbour, node, serialization, subgraph, vertex .SH CATEGORY Data structures .SH COPYRIGHT .nf | | | 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 | left-most button in the secondary navigation bar\&. .SH KEYWORDS adjacent, arc, cgraph, degree, edge, graph, loop, neighbour, node, serialization, subgraph, vertex .SH CATEGORY Data structures .SH COPYRIGHT .nf Copyright (c) 2002-2009,2019 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> .fi |
Added idoc/man/files/modules/struct/struct_map.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file 'struct_map\&.man' by tcllib/doctools with format 'nroff' '\" .TH "struct::map" n 1 tcllib "" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME struct::map \- Manage key/value maps .SH SYNOPSIS package require \fBstruct::map ?1?\fR .sp \fB::struct::map\fR \fImapName\fR .sp \fBmapName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? .sp \fImapName\fR \fBget\fR .sp \fImapName\fR \fBnames\fR .sp \fImapName\fR \fBset\fR \fIname\fR ?\fIvalue\fR? .sp \fImapName\fR \fBunset\fR ?\fIpattern\fR\&.\&.\&.? .sp .BE .SH DESCRIPTION Provides a snit class whose instances manage a key/value map\&. In other words, an object wrapper around Tcl arrays\&. .SH API The main command provides construction of maps: .TP \fB::struct::map\fR \fImapName\fR Creates a new, empty map with an associated global Tcl command whose name is \fImapName\fR\&. It may be used to invoke various operations on the map\&. It has the following general form: .RS .TP \fBmapName\fR \fBmethod\fR ?\fIarg arg \&.\&.\&.\fR? \fBmethod\fR and \fIarg\fRuments determine the exact behavior of the command\&. .RE .IP If \fImapName\fR is specified as \fB%AUTO%\fR a unique name will be generated by the package itself\&. The result of the command is the fully-qualified name of the instance command\&. .PP .PP The following commands are possible for map objects: .TP \fImapName\fR \fBget\fR Returns the entire map as a Tcl dictionary\&. .TP \fImapName\fR \fBnames\fR Returns the list of all keys known to the map, in arbitrary order\&. .TP \fImapName\fR \fBset\fR \fIname\fR ?\fIvalue\fR? Sets key \fIname\fR to the specified \fIvalue\fR, if the value specified\&. Returns the value for the key\&. Throws an error if the key is not known\&. .TP \fImapName\fR \fBunset\fR ?\fIpattern\fR\&.\&.\&.? Removes all keys matching at least one of the glob \fIpattern\fRs from the map\&. If no pattern is specified all keys are removed\&. In other words, the default pattern is \fB*\fR\&. The result of the command is the empty string\&. .PP .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such in the category \fIstruct :: list\fR of the \fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&. Please also report any ideas for enhancements you may have for either package and/or documentation\&. .PP When proposing code changes, please provide \fIunified diffs\fR, i\&.e the output of \fBdiff -u\fR\&. .PP Note further that \fIattachments\fR are strongly preferred over inlined patches\&. Attachments can be made by going to the \fBEdit\fR form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar\&. |
Changes to idoc/man/files/modules/treeql/treeql.n.
︙ | ︙ | |||
404 405 406 407 408 409 410 | # have such an attribute\&. # - And returns this information\&. # Below we can see the same query, but rewritten # to show the structure as it is seen by the query # interpreter\&. | | | | | 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | # have such an attribute\&. # - And returns this information\&. # Below we can see the same query, but rewritten # to show the structure as it is seen by the query # interpreter\&. q query \\ root \\ children \\ get data .CE .sp The operators of the TreeQL language available for this are explained in the section about \fBThe Tree Query Language\fR\&. This section also explains the term \fInode set\fR used above\&. |
︙ | ︙ |
Changes to idoc/man/files/modules/virtchannel_base/cat.n.
1 2 3 4 | '\" '\" Generated from file 'cat\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2011 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'cat\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2011 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net> '\" .TH "tcl::chan::cat" n 1\&.0\&.3 tcllib "Reflected/virtual channel support" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
276 277 278 279 280 281 282 | .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBTclOO \fR .sp package require \fBtcl::chan::core ?1?\fR .sp | | | 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | .SH SYNOPSIS package require \fBTcl 8\&.5\fR .sp package require \fBTclOO \fR .sp package require \fBtcl::chan::core ?1?\fR .sp package require \fBtcl::chan::cat ?1\&.0\&.3?\fR .sp \fB::tcl::chan::cat\fR \fIchan\fR\&.\&.\&. .sp .BE .SH DESCRIPTION .PP The \fBtcl::chan::cat\fR package provides a command creating |
︙ | ︙ |
Changes to idoc/man/files/modules/zip/mkzip.n.
1 2 3 4 | '\" '\" Generated from file 'mkzip\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 Pat Thoyts '\" | | | 1 2 3 4 5 6 7 8 9 10 11 12 | '\" '\" Generated from file 'mkzip\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2009 Pat Thoyts '\" .TH "zipfile::mkzip" n 1\&.2\&.1 tcllib "Zip archive creation" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, |
︙ | ︙ | |||
272 273 274 275 276 277 278 | .. .BS .SH NAME zipfile::mkzip \- Build a zip archive .SH SYNOPSIS package require \fBTcl 8\&.6\fR .sp | | | 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | .. .BS .SH NAME zipfile::mkzip \- Build a zip archive .SH SYNOPSIS package require \fBTcl 8\&.6\fR .sp package require \fBzipfile::mkzip ?1\&.2\&.1?\fR .sp \fB::zipfile::mkzip::mkzip\fR \fIzipfile\fR ?\fB-zipkit\fR? ?\fB-runtime\fR \fIprefix\fR? ?\fB-comment\fR \fIstring\fR? ?\fB-directory\fR \fIrootpath\fR? ?\fB-exclude\fR \fIexclude\fR? ?\fB--\fR? ?\fIpath\fR\&.\&.\&.? .sp .BE .SH DESCRIPTION .PP This package utilizes the zlib functions in Tcl 8\&.6 to build zip |
︙ | ︙ |
Changes to idoc/man/index.n.
︙ | ︙ | |||
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 | .RS .TP \fBfiles/modules/doctools2base/tcl_parse\&.n\fR doctools::tcl::parse .RE TclOO .RS .TP \fBfiles/modules/tool/meta\&.n\fR oo::util .TP \fBfiles/modules/ooutil/ooutil\&.n\fR oo::util .TP \fBfiles/modules/oometa/oometa\&.n\fR oometa .TP \fBfiles/modules/tool/tool\&.n\fR tool .TP | > > > > > > < < < | 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 | .RS .TP \fBfiles/modules/doctools2base/tcl_parse\&.n\fR doctools::tcl::parse .RE TclOO .RS .TP \fBfiles/modules/clay/clay\&.n\fR clay .TP \fBfiles/modules/httpd/httpd\&.n\fR httpd .TP \fBfiles/modules/tool/meta\&.n\fR oo::util .TP \fBfiles/modules/ooutil/ooutil\&.n\fR oo::util .TP \fBfiles/modules/oometa/oometa\&.n\fR oometa .TP \fBfiles/modules/tool/tool\&.n\fR tool .TP \fBfiles/modules/tool/tool_dict_ensemble\&.n\fR tool::dict_ensemble .RE TeX .RS .TP \fBfiles/modules/textutil/textutil\&.n\fR |
︙ | ︙ | |||
1700 1701 1702 1703 1704 1705 1706 | \fBfiles/modules/valtype/verhoeff\&.n\fR valtype::verhoeff .RE WWW .RS .TP \fBfiles/modules/httpd/httpd\&.n\fR | | | 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 | \fBfiles/modules/valtype/verhoeff\&.n\fR valtype::verhoeff .RE WWW .RS .TP \fBfiles/modules/httpd/httpd\&.n\fR httpd .RE XGoogleToken .RS .TP \fBfiles/modules/sasl/gtoken\&.n\fR SASL::XGoogleToken .RE |
︙ | ︙ | |||
5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 | ncgi .RE http .RS .TP \fBfiles/modules/http/autoproxy\&.n\fR autoproxy .TP \fBfiles/modules/map/map_geocode_nominatim\&.n\fR map::geocode::nominatim .TP \fBfiles/modules/map/map_slippy_fetcher\&.n\fR map::slippy::fetcher .TP | > > > < < < | | | 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 | ncgi .RE http .RS .TP \fBfiles/modules/http/autoproxy\&.n\fR autoproxy .TP \fBfiles/modules/httpd/httpd\&.n\fR httpd .TP \fBfiles/modules/map/map_geocode_nominatim\&.n\fR map::geocode::nominatim .TP \fBfiles/modules/map/map_slippy_fetcher\&.n\fR map::slippy::fetcher .TP \fBfiles/modules/uri/uri\&.n\fR uri .TP \fBfiles/modules/websocket/websocket\&.n\fR websocket .RE httpd .RS .TP \fBfiles/modules/httpd/httpd\&.n\fR httpd .RE https .RS .TP \fBfiles/modules/uri/uri\&.n\fR uri .RE httpserver .RS .TP \fBfiles/modules/httpd/httpd\&.n\fR httpd .RE huddle .RS .TP \fBfiles/modules/yaml/huddle\&.n\fR huddle .TP |
︙ | ︙ | |||
6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 | simulation::random .RE mathematics .RS .TP \fBfiles/modules/math/fourier\&.n\fR math::fourier .TP \fBfiles/modules/math/statistics\&.n\fR math::statistics .RE matrices .RS .TP | > > > | 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 | simulation::random .RE mathematics .RS .TP \fBfiles/modules/math/fourier\&.n\fR math::fourier .TP \fBfiles/modules/math/quasirandom\&.n\fR math::quasirandom .TP \fBfiles/modules/math/statistics\&.n\fR math::statistics .RE matrices .RS .TP |
︙ | ︙ | |||
7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 | .RE one time pad .RS .TP \fBfiles/modules/virtchannel_transform/vt_otp\&.n\fR tcl::transform::otp .RE optimization .RS .TP \fBfiles/modules/math/optimize\&.n\fR math::optimize .TP \fBfiles/modules/simulation/annealing\&.n\fR | > > > > > > | 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 | .RE one time pad .RS .TP \fBfiles/modules/virtchannel_transform/vt_otp\&.n\fR tcl::transform::otp .RE oo .RS .TP \fBfiles/modules/clay/clay\&.n\fR clay .RE optimization .RS .TP \fBfiles/modules/math/optimize\&.n\fR math::optimize .TP \fBfiles/modules/simulation/annealing\&.n\fR |
︙ | ︙ | |||
8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 | .TP \fBfiles/modules/pt/pt_parser_api\&.n\fR pt_parser_api .TP \fBfiles/modules/pt/pt_peg_op\&.n\fR pt_peg_op .RE queue .RS .TP \fBfiles/modules/csv/csv\&.n\fR csv .TP \fBfiles/modules/htmlparse/htmlparse\&.n\fR | > > > > > > | 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 | .TP \fBfiles/modules/pt/pt_parser_api\&.n\fR pt_parser_api .TP \fBfiles/modules/pt/pt_peg_op\&.n\fR pt_peg_op .RE quasi-random .RS .TP \fBfiles/modules/math/quasirandom\&.n\fR math::quasirandom .RE queue .RS .TP \fBfiles/modules/csv/csv\&.n\fR csv .TP \fBfiles/modules/htmlparse/htmlparse\&.n\fR |
︙ | ︙ | |||
9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 | logger .RE services .RS .TP \fBfiles/modules/ftpd/ftpd\&.n\fR ftpd .TP \fBfiles/modules/smtpd/smtpd\&.n\fR smtpd | > > > < < < | 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 | logger .RE services .RS .TP \fBfiles/modules/ftpd/ftpd\&.n\fR ftpd .TP \fBfiles/modules/httpd/httpd\&.n\fR httpd .TP \fBfiles/modules/smtpd/smtpd\&.n\fR smtpd .RE set .RS .TP \fBfiles/modules/struct/queue\&.n\fR struct::queue .TP |
︙ | ︙ |
Changes to idoc/man/toc.n.
︙ | ︙ | |||
329 330 331 332 333 334 335 336 337 338 339 340 341 342 | .TP \fBcache::async\fR \fIfiles/modules/cache/async\&.n\fR: Asynchronous in-memory cache .TP \fBcksum\fR \fIfiles/modules/crc/cksum\&.n\fR: Calculate a cksum(1) compatible checksum .TP \fBclock_iso8601\fR \fIfiles/modules/clock/iso8601\&.n\fR: Parsing ISO 8601 dates/times .TP \fBclock_rfc2822\fR \fIfiles/modules/clock/rfc2822\&.n\fR: Parsing ISO 8601 dates/times .TP \fBcmdline\fR | > > > | 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | .TP \fBcache::async\fR \fIfiles/modules/cache/async\&.n\fR: Asynchronous in-memory cache .TP \fBcksum\fR \fIfiles/modules/crc/cksum\&.n\fR: Calculate a cksum(1) compatible checksum .TP \fBclay\fR \fIfiles/modules/clay/clay\&.n\fR: A minimalist framework for large scale OO Projects .TP \fBclock_iso8601\fR \fIfiles/modules/clock/iso8601\&.n\fR: Parsing ISO 8601 dates/times .TP \fBclock_rfc2822\fR \fIfiles/modules/clock/rfc2822\&.n\fR: Parsing ISO 8601 dates/times .TP \fBcmdline\fR |
︙ | ︙ | |||
620 621 622 623 624 625 626 627 628 629 630 631 632 633 | .TP \fBfileutil::multi\fR \fIfiles/modules/fileutil/multi\&.n\fR: Multi-file operation, scatter/gather, standard object .TP \fBfileutil::multi::op\fR \fIfiles/modules/fileutil/multiop\&.n\fR: Multi-file operation, scatter/gather .TP \fBfileutil_traverse\fR \fIfiles/modules/fileutil/traverse\&.n\fR: Iterative directory traversal .TP \fBftp\fR \fIfiles/modules/ftp/ftp\&.n\fR: Client-side tcl implementation of the ftp protocol .TP \fBftp::geturl\fR | > > > | 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 | .TP \fBfileutil::multi\fR \fIfiles/modules/fileutil/multi\&.n\fR: Multi-file operation, scatter/gather, standard object .TP \fBfileutil::multi::op\fR \fIfiles/modules/fileutil/multiop\&.n\fR: Multi-file operation, scatter/gather .TP \fBfileutil::paths\fR \fIfiles/modules/fileutil/paths\&.n\fR: Manage search path pools .TP \fBfileutil_traverse\fR \fIfiles/modules/fileutil/traverse\&.n\fR: Iterative directory traversal .TP \fBftp\fR \fIfiles/modules/ftp/ftp\&.n\fR: Client-side tcl implementation of the ftp protocol .TP \fBftp::geturl\fR |
︙ | ︙ | |||
692 693 694 695 696 697 698 699 700 701 702 703 704 705 | .TP \fBhtml\fR \fIfiles/modules/html/html\&.n\fR: Procedures to generate HTML structures .TP \fBhtmlparse\fR \fIfiles/modules/htmlparse/htmlparse\&.n\fR: Procedures to parse HTML strings .TP \fBhuddle\fR \fIfiles/modules/yaml/huddle\&.n\fR: Create and manipulate huddle object .TP \fBident\fR \fIfiles/modules/ident/ident\&.n\fR: Ident protocol client .TP \fBimap4\fR | > > > | 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 | .TP \fBhtml\fR \fIfiles/modules/html/html\&.n\fR: Procedures to generate HTML structures .TP \fBhtmlparse\fR \fIfiles/modules/htmlparse/htmlparse\&.n\fR: Procedures to parse HTML strings .TP \fBhttpd\fR \fIfiles/modules/httpd/httpd\&.n\fR: A TclOO and coroutine based web server .TP \fBhuddle\fR \fIfiles/modules/yaml/huddle\&.n\fR: Create and manipulate huddle object .TP \fBident\fR \fIfiles/modules/ident/ident\&.n\fR: Ident protocol client .TP \fBimap4\fR |
︙ | ︙ | |||
824 825 826 827 828 829 830 831 832 833 834 835 836 837 | .TP \fBmath::PCA\fR \fIfiles/modules/math/pca\&.n\fR: Package for Principal Component Analysis .TP \fBmath::polynomials\fR \fIfiles/modules/math/polynomials\&.n\fR: Polynomial functions .TP \fBmath::rationalfunctions\fR \fIfiles/modules/math/rational_funcs\&.n\fR: Polynomial functions .TP \fBmath::roman\fR \fIfiles/modules/math/roman\&.n\fR: Tools for creating and manipulating roman numerals .TP \fBmath::special\fR | > > > | 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 | .TP \fBmath::PCA\fR \fIfiles/modules/math/pca\&.n\fR: Package for Principal Component Analysis .TP \fBmath::polynomials\fR \fIfiles/modules/math/polynomials\&.n\fR: Polynomial functions .TP \fBmath::quasirandom\fR \fIfiles/modules/math/quasirandom\&.n\fR: Quasi-random points for integration and Monte Carlo type methods .TP \fBmath::rationalfunctions\fR \fIfiles/modules/math/rational_funcs\&.n\fR: Polynomial functions .TP \fBmath::roman\fR \fIfiles/modules/math/roman\&.n\fR: Tools for creating and manipulating roman numerals .TP \fBmath::special\fR |
︙ | ︙ | |||
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 | .TP \fBstruct::graph_v1\fR \fIfiles/modules/struct/graph1\&.n\fR: Create and manipulate directed graph objects .TP \fBstruct::list\fR \fIfiles/modules/struct/struct_list\&.n\fR: Procedures for manipulating lists .TP \fBstruct::matrix\fR \fIfiles/modules/struct/matrix\&.n\fR: Create and manipulate matrix objects .TP \fBstruct::matrix_v1\fR \fIfiles/modules/struct/matrix1\&.n\fR: Create and manipulate matrix objects .TP \fBstruct::pool\fR | > > > | 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 | .TP \fBstruct::graph_v1\fR \fIfiles/modules/struct/graph1\&.n\fR: Create and manipulate directed graph objects .TP \fBstruct::list\fR \fIfiles/modules/struct/struct_list\&.n\fR: Procedures for manipulating lists .TP \fBstruct::map\fR \fIfiles/modules/struct/struct_map\&.n\fR: Manage key/value maps .TP \fBstruct::matrix\fR \fIfiles/modules/struct/matrix\&.n\fR: Create and manipulate matrix objects .TP \fBstruct::matrix_v1\fR \fIfiles/modules/struct/matrix1\&.n\fR: Create and manipulate matrix objects .TP \fBstruct::pool\fR |
︙ | ︙ | |||
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 | .TP \fBtcl::transform::spacer\fR \fIfiles/modules/virtchannel_transform/spacer\&.n\fR: Space insertation and removal .TP \fBtcl::transform::zlib\fR \fIfiles/modules/virtchannel_transform/tcllib_zlib\&.n\fR: zlib (de)compression .TP \fBtclDES\fR \fIfiles/modules/des/tcldes\&.n\fR: Implementation of the DES and triple-DES ciphers .TP \fBtclDESjr\fR \fIfiles/modules/des/tcldesjr\&.n\fR: Implementation of the DES and triple-DES ciphers .TP \fBtcldocstrip\fR \fIfiles/apps/tcldocstrip\&.n\fR: Tcl-based Docstrip Processor .TP \fBtcllib_ip\fR \fIfiles/modules/dns/tcllib_ip\&.n\fR: IPv4 and IPv6 address manipulation .TP \fBtclrep/machineparameters\fR \fIfiles/modules/math/machineparameters\&.n\fR: Compute double precision machine parameters\&. .TP \fBtepam\fR \fIfiles/modules/tepam/tepam_introduction\&.n\fR: An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager .TP \fBtepam::argument_dialogbox\fR | > > > > > > > > > > > > > > > > > > | 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 | .TP \fBtcl::transform::spacer\fR \fIfiles/modules/virtchannel_transform/spacer\&.n\fR: Space insertation and removal .TP \fBtcl::transform::zlib\fR \fIfiles/modules/virtchannel_transform/tcllib_zlib\&.n\fR: zlib (de)compression .TP \fBtcl_community_communication\fR \fIfiles/devdoc/tcl_community_communication\&.n\fR: Tcl Community - Kind Communication .TP \fBtclDES\fR \fIfiles/modules/des/tcldes\&.n\fR: Implementation of the DES and triple-DES ciphers .TP \fBtclDESjr\fR \fIfiles/modules/des/tcldesjr\&.n\fR: Implementation of the DES and triple-DES ciphers .TP \fBtcldocstrip\fR \fIfiles/apps/tcldocstrip\&.n\fR: Tcl-based Docstrip Processor .TP \fBtcllib_devguide\fR \fIfiles/devdoc/tcllib_devguide\&.n\fR: Tcllib - The Developer's Guide .TP \fBtcllib_install_guide\fR \fIfiles/devdoc/tcllib_installer\&.n\fR: Tcllib - The Installer's Guide .TP \fBtcllib_ip\fR \fIfiles/modules/dns/tcllib_ip\&.n\fR: IPv4 and IPv6 address manipulation .TP \fBtcllib_license\fR \fIfiles/devdoc/tcllib_license\&.n\fR: Tcllib - License .TP \fBtcllib_releasemgr\fR \fIfiles/devdoc/tcllib_releasemgr\&.n\fR: Tcllib - The Release Manager's Guide .TP \fBtcllib_sources\fR \fIfiles/devdoc/tcllib_sources\&.n\fR: Tcllib - How To Get The Sources .TP \fBtclrep/machineparameters\fR \fIfiles/modules/math/machineparameters\&.n\fR: Compute double precision machine parameters\&. .TP \fBtepam\fR \fIfiles/modules/tepam/tepam_introduction\&.n\fR: An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager .TP \fBtepam::argument_dialogbox\fR |
︙ | ︙ | |||
1430 1431 1432 1433 1434 1435 1436 | .TP \fBtiff\fR \fIfiles/modules/tiff/tiff\&.n\fR: TIFF reading, writing, and querying and manipulation of meta data .TP \fBtool\fR \fIfiles/modules/tool/tool\&.n\fR: TclOO Library (TOOL) Framework .TP | < < < | 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 | .TP \fBtiff\fR \fIfiles/modules/tiff/tiff\&.n\fR: TIFF reading, writing, and querying and manipulation of meta data .TP \fBtool\fR \fIfiles/modules/tool/tool\&.n\fR: TclOO Library (TOOL) Framework .TP \fBtool::dict_ensemble\fR \fIfiles/modules/tool/tool_dict_ensemble\&.n\fR: Dictionary Tools .TP \fBtransfer::connect\fR \fIfiles/modules/transfer/connect\&.n\fR: Connection setup .TP \fBtransfer::copy\fR |
︙ | ︙ |
Changes to idoc/www/index.html.
︙ | ︙ | |||
1721 1722 1723 1724 1725 1726 1727 | <td class="#doctools_idxleft" width="35%"><a name="html"> html </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/html/html.html"> html </a> · <a href="tcllib/files/modules/htmlparse/htmlparse.html"> htmlparse </a> · <a href="tcllib/files/modules/javascript/javascript.html"> javascript </a> · <a href="tcllib/files/modules/ncgi/ncgi.html"> ncgi </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="http"> http </a></td> <td class="#doctools_idxright" width="65%"> | | | | | 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 | <td class="#doctools_idxleft" width="35%"><a name="html"> html </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/html/html.html"> html </a> · <a href="tcllib/files/modules/htmlparse/htmlparse.html"> htmlparse </a> · <a href="tcllib/files/modules/javascript/javascript.html"> javascript </a> · <a href="tcllib/files/modules/ncgi/ncgi.html"> ncgi </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="http"> http </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/http/autoproxy.html"> autoproxy </a> · <a href="tcllib/files/modules/httpd/httpd.html"> httpd </a> · <a href="tcllib/files/modules/map/map_geocode_nominatim.html"> map::geocode::nominatim </a> · <a href="tcllib/files/modules/map/map_slippy_fetcher.html"> map::slippy::fetcher </a> · <a href="tcllib/files/modules/uri/uri.html"> uri </a> · <a href="tcllib/files/modules/websocket/websocket.html"> websocket </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="httpd"> httpd </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/httpd/httpd.html"> httpd </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="https"> https </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/uri/uri.html"> uri </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="httpserver"> httpserver </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/httpd/httpd.html"> httpd </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="huddle"> huddle </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/yaml/huddle.html"> huddle </a> · <a href="tcllib/files/modules/yaml/yaml.html"> yaml </a> </td></tr> <tr class="#doctools_idxeven" valign=top> |
︙ | ︙ | |||
2271 2272 2273 2274 2275 2276 2277 | <td class="#doctools_idxleft" width="35%"><a name="math"> math </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/math.html"> math </a> · <a href="tcllib/files/modules/math/bigfloat.html"> math::bigfloat </a> · <a href="tcllib/files/modules/math/bignum.html"> math::bignum </a> · <a href="tcllib/files/modules/math/calculus.html"> math::calculus </a> · <a href="tcllib/files/modules/math/qcomplex.html"> math::complexnumbers </a> · <a href="tcllib/files/modules/math/constants.html"> math::constants </a> · <a href="tcllib/files/modules/math/decimal.html"> math::decimal </a> · <a href="tcllib/files/modules/math/fuzzy.html"> math::fuzzy </a> · <a href="tcllib/files/modules/math/math_geometry.html"> math::geometry </a> · <a href="tcllib/files/modules/math/interpolate.html"> math::interpolate </a> · <a href="tcllib/files/modules/math/linalg.html"> math::linearalgebra </a> · <a href="tcllib/files/modules/math/optimize.html"> math::optimize </a> · <a href="tcllib/files/modules/math/pca.html"> math::PCA </a> · <a href="tcllib/files/modules/math/polynomials.html"> math::polynomials </a> · <a href="tcllib/files/modules/math/rational_funcs.html"> math::rationalfunctions </a> · <a href="tcllib/files/modules/math/special.html"> math::special </a> · <a href="tcllib/files/modules/math/trig.html"> math::trig </a> · <a href="tcllib/files/modules/simulation/annealing.html"> simulation::annealing </a> · <a href="tcllib/files/modules/simulation/montecarlo.html"> simulation::montecarlo </a> · <a href="tcllib/files/modules/simulation/simulation_random.html"> simulation::random </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="mathematics"> mathematics </a></td> <td class="#doctools_idxright" width="65%"> | | | 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 | <td class="#doctools_idxleft" width="35%"><a name="math"> math </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/math.html"> math </a> · <a href="tcllib/files/modules/math/bigfloat.html"> math::bigfloat </a> · <a href="tcllib/files/modules/math/bignum.html"> math::bignum </a> · <a href="tcllib/files/modules/math/calculus.html"> math::calculus </a> · <a href="tcllib/files/modules/math/qcomplex.html"> math::complexnumbers </a> · <a href="tcllib/files/modules/math/constants.html"> math::constants </a> · <a href="tcllib/files/modules/math/decimal.html"> math::decimal </a> · <a href="tcllib/files/modules/math/fuzzy.html"> math::fuzzy </a> · <a href="tcllib/files/modules/math/math_geometry.html"> math::geometry </a> · <a href="tcllib/files/modules/math/interpolate.html"> math::interpolate </a> · <a href="tcllib/files/modules/math/linalg.html"> math::linearalgebra </a> · <a href="tcllib/files/modules/math/optimize.html"> math::optimize </a> · <a href="tcllib/files/modules/math/pca.html"> math::PCA </a> · <a href="tcllib/files/modules/math/polynomials.html"> math::polynomials </a> · <a href="tcllib/files/modules/math/rational_funcs.html"> math::rationalfunctions </a> · <a href="tcllib/files/modules/math/special.html"> math::special </a> · <a href="tcllib/files/modules/math/trig.html"> math::trig </a> · <a href="tcllib/files/modules/simulation/annealing.html"> simulation::annealing </a> · <a href="tcllib/files/modules/simulation/montecarlo.html"> simulation::montecarlo </a> · <a href="tcllib/files/modules/simulation/simulation_random.html"> simulation::random </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="mathematics"> mathematics </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/fourier.html"> math::fourier </a> · <a href="tcllib/files/modules/math/quasirandom.html"> math::quasirandom </a> · <a href="tcllib/files/modules/math/statistics.html"> math::statistics </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="matrices"> matrices </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/linalg.html"> math::linearalgebra </a> </td></tr> <tr class="#doctools_idxeven" valign=top> |
︙ | ︙ | |||
2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 | </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="one_time_pad"> one time pad </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/virtchannel_transform/vt_otp.html"> tcl::transform::otp </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="optimization"> optimization </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/optimize.html"> math::optimize </a> · <a href="tcllib/files/modules/simulation/annealing.html"> simulation::annealing </a> </td></tr> | > > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > > | 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 | </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="one_time_pad"> one time pad </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/virtchannel_transform/vt_otp.html"> tcl::transform::otp </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="oo"> oo </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/clay/clay.html"> clay </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="optimization"> optimization </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/optimize.html"> math::optimize </a> · <a href="tcllib/files/modules/simulation/annealing.html"> simulation::annealing </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="ordered_list"> ordered list </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/prioqueue.html"> struct::prioqueue </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="otp"> otp </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/virtchannel_transform/vt_otp.html"> tcl::transform::otp </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="outer_join"> outer join </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/struct_list.html"> struct::list </a> </td></tr> <tr class="#doctools_idxheader"><th colspan="2"> <a name="cP">Keywords: P</a> </th></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="package"> package </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/csv/csv.html"> csv </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="package_indexing"> package indexing </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/docstrip/docstrip_util.html"> docstrip_util </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="page"> page </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/page/page_intro.html"> page_intro </a> · <a href="tcllib/files/modules/page/page_pluginmgr.html"> page_pluginmgr </a> · <a href="tcllib/files/modules/page/page_util_flow.html"> page_util_flow </a> · <a href="tcllib/files/modules/page/page_util_norm_lemon.html"> page_util_norm_lemon </a> · <a href="tcllib/files/modules/page/page_util_norm_peg.html"> page_util_norm_peg </a> · <a href="tcllib/files/modules/page/page_util_peg.html"> page_util_peg </a> · <a href="tcllib/files/modules/page/page_util_quote.html"> page_util_quote </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pager"> pager </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/term/ipager.html"> term::interact::pager </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="paragraph"> paragraph </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/textutil/textutil.html"> textutil </a> · <a href="tcllib/files/modules/textutil/adjust.html"> textutil::adjust </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="param"> PARAM </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pt/pt_peg_to_param.html"> pt::peg::to::param </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="parameter_entry_form"> parameter entry form </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/tepam/tepam_introduction.html"> tepam </a> · <a href="tcllib/files/modules/tepam/tepam_argument_dialogbox.html"> tepam::argument_dialogbox </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="parser"> parser </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/doctools2idx/idx_parse.html"> doctools::idx::parse </a> · <a href="tcllib/files/modules/doctools2base/tcl_parse.html"> doctools::tcl::parse </a> · <a href="tcllib/files/modules/doctools2toc/toc_parse.html"> doctools::toc::parse </a> · <a href="tcllib/files/modules/grammar_aycock/aycock.html"> grammar::aycock </a> · <a href="tcllib/files/apps/pt.html"> pt </a> · <a href="tcllib/files/modules/pt/pt_astree.html"> pt::ast </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_critcl.html"> pt::cparam::configuration::critcl </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_tea.html"> pt::cparam::configuration::tea </a> · <a href="tcllib/files/modules/pt/pt_json_language.html"> pt::json_language </a> · <a href="tcllib/files/modules/pt/pt_param.html"> pt::param </a> · <a href="tcllib/files/modules/pt/pt_pexpression.html"> pt::pe </a> · <a href="tcllib/files/modules/pt/pt_pexpr_op.html"> pt::pe::op </a> · <a href="tcllib/files/modules/pt/pt_pegrammar.html"> pt::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_container.html"> pt::peg::container </a> · <a href="tcllib/files/modules/pt/pt_peg_container_peg.html"> pt::peg::container::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_export.html"> pt::peg::export </a> · <a href="tcllib/files/modules/pt/pt_peg_export_container.html"> pt::peg::export::container </a> · <a href="tcllib/files/modules/pt/pt_peg_export_json.html"> pt::peg::export::json </a> · <a href="tcllib/files/modules/pt/pt_peg_export_peg.html"> pt::peg::export::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_from_container.html"> pt::peg::from::container </a> · <a href="tcllib/files/modules/pt/pt_peg_from_json.html"> pt::peg::from::json </a> · <a href="tcllib/files/modules/pt/pt_peg_from_peg.html"> pt::peg::from::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_import.html"> pt::peg::import </a> · <a href="tcllib/files/modules/pt/pt_peg_import_container.html"> pt::peg::import::container </a> · <a href="tcllib/files/modules/pt/pt_peg_import_json.html"> pt::peg::import::json </a> · <a href="tcllib/files/modules/pt/pt_peg_import_peg.html"> pt::peg::import::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_interp.html"> pt::peg::interp </a> · <a href="tcllib/files/modules/pt/pt_peg_to_container.html"> pt::peg::to::container </a> · <a href="tcllib/files/modules/pt/pt_peg_to_cparam.html"> pt::peg::to::cparam </a> · <a href="tcllib/files/modules/pt/pt_peg_to_json.html"> pt::peg::to::json </a> · <a href="tcllib/files/modules/pt/pt_peg_to_param.html"> pt::peg::to::param </a> · <a href="tcllib/files/modules/pt/pt_peg_to_peg.html"> pt::peg::to::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_to_tclparam.html"> pt::peg::to::tclparam </a> · <a href="tcllib/files/modules/pt/pt_peg_language.html"> pt::peg_language </a> · <a href="tcllib/files/modules/pt/pt_peg_introduction.html"> pt::pegrammar </a> · <a href="tcllib/files/modules/pt/pt_pgen.html"> pt::pgen </a> · <a href="tcllib/files/modules/pt/pt_rdengine.html"> pt::rde </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_nx.html"> pt::tclparam::configuration::nx </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_snit.html"> pt::tclparam::configuration::snit </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_tcloo.html"> pt::tclparam::configuration::tcloo </a> · <a href="tcllib/files/modules/pt/pt_util.html"> pt::util </a> · <a href="tcllib/files/modules/pt/pt_to_api.html"> pt_export_api </a> · <a href="tcllib/files/modules/pt/pt_from_api.html"> pt_import_api </a> · <a href="tcllib/files/modules/pt/pt_introduction.html"> pt_introduction </a> · <a href="tcllib/files/modules/pt/pt_parse_peg.html"> pt_parse_peg </a> · <a href="tcllib/files/modules/pt/pt_parser_api.html"> pt_parser_api </a> · <a href="tcllib/files/modules/pt/pt_peg_op.html"> pt_peg_op </a> · <a href="tcllib/files/modules/amazon-s3/xsxp.html"> xsxp </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="parser_generator"> parser generator </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/apps/page.html"> page </a> · <a href="tcllib/files/modules/page/page_intro.html"> page_intro </a> · <a href="tcllib/files/modules/page/page_pluginmgr.html"> page_pluginmgr </a> · <a href="tcllib/files/modules/page/page_util_flow.html"> page_util_flow </a> · <a href="tcllib/files/modules/page/page_util_norm_lemon.html"> page_util_norm_lemon </a> · <a href="tcllib/files/modules/page/page_util_norm_peg.html"> page_util_norm_peg </a> · <a href="tcllib/files/modules/page/page_util_peg.html"> page_util_peg </a> · <a href="tcllib/files/modules/page/page_util_quote.html"> page_util_quote </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="parsing"> parsing </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/bench/bench_read.html"> bench::in </a> · <a href="tcllib/files/modules/bibtex/bibtex.html"> bibtex </a> · <a href="tcllib/files/modules/doctools2idx/idx_introduction.html"> doctools2idx_introduction </a> · <a href="tcllib/files/modules/doctools2toc/toc_introduction.html"> doctools2toc_introduction </a> · <a href="tcllib/files/modules/doctools2idx/idx_container.html"> doctools::idx </a> · <a href="tcllib/files/modules/doctools2idx/idx_import.html"> doctools::idx::import </a> · <a href="tcllib/files/modules/doctools2toc/toc_container.html"> doctools::toc </a> · <a href="tcllib/files/modules/doctools2toc/toc_import.html"> doctools::toc::import </a> · <a href="tcllib/files/modules/grammar_aycock/aycock.html"> grammar::aycock </a> · <a href="tcllib/files/modules/grammar_fa/fa.html"> grammar::fa </a> · <a href="tcllib/files/modules/grammar_fa/dacceptor.html"> grammar::fa::dacceptor </a> · <a href="tcllib/files/modules/grammar_fa/dexec.html"> grammar::fa::dexec </a> · <a href="tcllib/files/modules/grammar_fa/faop.html"> grammar::fa::op </a> · <a href="tcllib/files/modules/grammar_me/me_cpu.html"> grammar::me::cpu </a> · <a href="tcllib/files/modules/grammar_me/me_cpucore.html"> grammar::me::cpu::core </a> · <a href="tcllib/files/modules/grammar_me/gasm.html"> grammar::me::cpu::gasm </a> · <a href="tcllib/files/modules/grammar_me/me_tcl.html"> grammar::me::tcl </a> · <a href="tcllib/files/modules/grammar_me/me_intro.html"> grammar::me_intro </a> · <a href="tcllib/files/modules/grammar_me/me_vm.html"> grammar::me_vm </a> · <a href="tcllib/files/modules/grammar_peg/peg.html"> grammar::peg </a> · <a href="tcllib/files/modules/grammar_peg/peg_interp.html"> grammar::peg::interp </a> · <a href="tcllib/files/modules/htmlparse/htmlparse.html"> htmlparse </a> · <a href="tcllib/files/modules/yaml/huddle.html"> huddle </a> · <a href="tcllib/files/modules/string/token_shell.html"> string::token::shell </a> · <a href="tcllib/files/modules/yaml/yaml.html"> yaml </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="parsing_expression"> parsing expression </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/grammar_peg/peg.html"> grammar::peg </a> · <a href="tcllib/files/modules/grammar_peg/peg_interp.html"> grammar::peg::interp </a> · <a href="tcllib/files/apps/pt.html"> pt </a> · <a href="tcllib/files/modules/pt/pt_astree.html"> pt::ast </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_critcl.html"> pt::cparam::configuration::critcl </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_tea.html"> pt::cparam::configuration::tea </a> · <a href="tcllib/files/modules/pt/pt_json_language.html"> pt::json_language </a> · <a href="tcllib/files/modules/pt/pt_param.html"> pt::param </a> · <a href="tcllib/files/modules/pt/pt_pexpression.html"> pt::pe </a> · <a href="tcllib/files/modules/pt/pt_pexpr_op.html"> pt::pe::op </a> · <a href="tcllib/files/modules/pt/pt_pegrammar.html"> pt::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_container.html"> pt::peg::container </a> · <a href="tcllib/files/modules/pt/pt_peg_container_peg.html"> pt::peg::container::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_export.html"> pt::peg::export </a> · <a href="tcllib/files/modules/pt/pt_peg_export_container.html"> pt::peg::export::container </a> · <a href="tcllib/files/modules/pt/pt_peg_export_json.html"> pt::peg::export::json </a> · <a href="tcllib/files/modules/pt/pt_peg_export_peg.html"> pt::peg::export::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_from_container.html"> pt::peg::from::container </a> · <a href="tcllib/files/modules/pt/pt_peg_from_json.html"> pt::peg::from::json </a> · <a href="tcllib/files/modules/pt/pt_peg_from_peg.html"> pt::peg::from::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_import.html"> pt::peg::import </a> · <a href="tcllib/files/modules/pt/pt_peg_import_container.html"> pt::peg::import::container </a> · <a href="tcllib/files/modules/pt/pt_peg_import_json.html"> pt::peg::import::json </a> · <a href="tcllib/files/modules/pt/pt_peg_import_peg.html"> pt::peg::import::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_interp.html"> pt::peg::interp </a> · <a href="tcllib/files/modules/pt/pt_peg_to_container.html"> pt::peg::to::container </a> · <a href="tcllib/files/modules/pt/pt_peg_to_cparam.html"> pt::peg::to::cparam </a> · <a href="tcllib/files/modules/pt/pt_peg_to_json.html"> pt::peg::to::json </a> · <a href="tcllib/files/modules/pt/pt_peg_to_param.html"> pt::peg::to::param </a> · <a href="tcllib/files/modules/pt/pt_peg_to_peg.html"> pt::peg::to::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_to_tclparam.html"> pt::peg::to::tclparam </a> · <a href="tcllib/files/modules/pt/pt_peg_language.html"> pt::peg_language </a> · <a href="tcllib/files/modules/pt/pt_peg_introduction.html"> pt::pegrammar </a> · <a href="tcllib/files/modules/pt/pt_pgen.html"> pt::pgen </a> · <a href="tcllib/files/modules/pt/pt_rdengine.html"> pt::rde </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_nx.html"> pt::tclparam::configuration::nx </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_snit.html"> pt::tclparam::configuration::snit </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_tcloo.html"> pt::tclparam::configuration::tcloo </a> · <a href="tcllib/files/modules/pt/pt_util.html"> pt::util </a> · <a href="tcllib/files/modules/pt/pt_to_api.html"> pt_export_api </a> · <a href="tcllib/files/modules/pt/pt_from_api.html"> pt_import_api </a> · <a href="tcllib/files/modules/pt/pt_introduction.html"> pt_introduction </a> · <a href="tcllib/files/modules/pt/pt_parse_peg.html"> pt_parse_peg </a> · <a href="tcllib/files/modules/pt/pt_parser_api.html"> pt_parser_api </a> · <a href="tcllib/files/modules/pt/pt_peg_op.html"> pt_peg_op </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="parsing_expression_grammar"> parsing expression grammar </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/grammar_me/me_intro.html"> grammar::me_intro </a> · <a href="tcllib/files/modules/grammar_peg/peg.html"> grammar::peg </a> · <a href="tcllib/files/modules/grammar_peg/peg_interp.html"> grammar::peg::interp </a> · <a href="tcllib/files/modules/page/page_util_peg.html"> page_util_peg </a> · <a href="tcllib/files/apps/pt.html"> pt </a> · <a href="tcllib/files/modules/pt/pt_astree.html"> pt::ast </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_critcl.html"> pt::cparam::configuration::critcl </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_tea.html"> pt::cparam::configuration::tea </a> · <a href="tcllib/files/modules/pt/pt_json_language.html"> pt::json_language </a> · <a href="tcllib/files/modules/pt/pt_param.html"> pt::param </a> · <a href="tcllib/files/modules/pt/pt_pexpression.html"> pt::pe </a> · <a href="tcllib/files/modules/pt/pt_pexpr_op.html"> pt::pe::op </a> · <a href="tcllib/files/modules/pt/pt_pegrammar.html"> pt::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_container.html"> pt::peg::container </a> · <a href="tcllib/files/modules/pt/pt_peg_container_peg.html"> pt::peg::container::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_export.html"> pt::peg::export </a> · <a href="tcllib/files/modules/pt/pt_peg_export_container.html"> pt::peg::export::container </a> · <a href="tcllib/files/modules/pt/pt_peg_export_json.html"> pt::peg::export::json </a> · <a href="tcllib/files/modules/pt/pt_peg_export_peg.html"> pt::peg::export::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_from_container.html"> pt::peg::from::container </a> · <a href="tcllib/files/modules/pt/pt_peg_from_json.html"> pt::peg::from::json </a> · <a href="tcllib/files/modules/pt/pt_peg_from_peg.html"> pt::peg::from::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_import.html"> pt::peg::import </a> · <a href="tcllib/files/modules/pt/pt_peg_import_container.html"> pt::peg::import::container </a> · <a href="tcllib/files/modules/pt/pt_peg_import_json.html"> pt::peg::import::json </a> · <a href="tcllib/files/modules/pt/pt_peg_import_peg.html"> pt::peg::import::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_interp.html"> pt::peg::interp </a> · <a href="tcllib/files/modules/pt/pt_peg_to_container.html"> pt::peg::to::container </a> · <a href="tcllib/files/modules/pt/pt_peg_to_cparam.html"> pt::peg::to::cparam </a> · <a href="tcllib/files/modules/pt/pt_peg_to_json.html"> pt::peg::to::json </a> · <a href="tcllib/files/modules/pt/pt_peg_to_param.html"> pt::peg::to::param </a> · <a href="tcllib/files/modules/pt/pt_peg_to_peg.html"> pt::peg::to::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_to_tclparam.html"> pt::peg::to::tclparam </a> · <a href="tcllib/files/modules/pt/pt_peg_language.html"> pt::peg_language </a> · <a href="tcllib/files/modules/pt/pt_peg_introduction.html"> pt::pegrammar </a> · <a href="tcllib/files/modules/pt/pt_pgen.html"> pt::pgen </a> · <a href="tcllib/files/modules/pt/pt_rdengine.html"> pt::rde </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_nx.html"> pt::tclparam::configuration::nx </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_snit.html"> pt::tclparam::configuration::snit </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_tcloo.html"> pt::tclparam::configuration::tcloo </a> · <a href="tcllib/files/modules/pt/pt_util.html"> pt::util </a> · <a href="tcllib/files/modules/pt/pt_to_api.html"> pt_export_api </a> · <a href="tcllib/files/modules/pt/pt_from_api.html"> pt_import_api </a> · <a href="tcllib/files/modules/pt/pt_introduction.html"> pt_introduction </a> · <a href="tcllib/files/modules/pt/pt_parse_peg.html"> pt_parse_peg </a> · <a href="tcllib/files/modules/pt/pt_parser_api.html"> pt_parser_api </a> · <a href="tcllib/files/modules/pt/pt_peg_op.html"> pt_peg_op </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="partial_application"> partial application </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/lambda/lambda.html"> lambda </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="partition"> partition </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/disjointset.html"> struct::disjointset </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="partitioned_set"> partitioned set </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/disjointset.html"> struct::disjointset </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="passive"> passive </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/transfer/connect.html"> transfer::connect </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="password"> password </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/otp/otp.html"> otp </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="patch"> patch </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/docstrip/docstrip_util.html"> docstrip_util </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="patching"> patching </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/rcs/rcs.html"> rcs </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pca"> PCA </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/pca.html"> math::PCA </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="peg"> PEG </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/grammar_me/me_intro.html"> grammar::me_intro </a> · <a href="tcllib/files/modules/page/page_util_norm_peg.html"> page_util_norm_peg </a> · <a href="tcllib/files/modules/page/page_util_peg.html"> page_util_peg </a> · <a href="tcllib/files/apps/pt.html"> pt </a> · <a href="tcllib/files/modules/pt/pt_astree.html"> pt::ast </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_critcl.html"> pt::cparam::configuration::critcl </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_tea.html"> pt::cparam::configuration::tea </a> · <a href="tcllib/files/modules/pt/pt_json_language.html"> pt::json_language </a> · <a href="tcllib/files/modules/pt/pt_param.html"> pt::param </a> · <a href="tcllib/files/modules/pt/pt_pexpression.html"> pt::pe </a> · <a href="tcllib/files/modules/pt/pt_pexpr_op.html"> pt::pe::op </a> · <a href="tcllib/files/modules/pt/pt_pegrammar.html"> pt::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_container.html"> pt::peg::container </a> · <a href="tcllib/files/modules/pt/pt_peg_container_peg.html"> pt::peg::container::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_export.html"> pt::peg::export </a> · <a href="tcllib/files/modules/pt/pt_peg_export_container.html"> pt::peg::export::container </a> · <a href="tcllib/files/modules/pt/pt_peg_export_json.html"> pt::peg::export::json </a> · <a href="tcllib/files/modules/pt/pt_peg_export_peg.html"> pt::peg::export::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_from_container.html"> pt::peg::from::container </a> · <a href="tcllib/files/modules/pt/pt_peg_from_json.html"> pt::peg::from::json </a> · <a href="tcllib/files/modules/pt/pt_peg_from_peg.html"> pt::peg::from::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_import.html"> pt::peg::import </a> · <a href="tcllib/files/modules/pt/pt_peg_import_container.html"> pt::peg::import::container </a> · <a href="tcllib/files/modules/pt/pt_peg_import_json.html"> pt::peg::import::json </a> · <a href="tcllib/files/modules/pt/pt_peg_import_peg.html"> pt::peg::import::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_interp.html"> pt::peg::interp </a> · <a href="tcllib/files/modules/pt/pt_peg_to_container.html"> pt::peg::to::container </a> · <a href="tcllib/files/modules/pt/pt_peg_to_cparam.html"> pt::peg::to::cparam </a> · <a href="tcllib/files/modules/pt/pt_peg_to_json.html"> pt::peg::to::json </a> · <a href="tcllib/files/modules/pt/pt_peg_to_param.html"> pt::peg::to::param </a> · <a href="tcllib/files/modules/pt/pt_peg_to_peg.html"> pt::peg::to::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_to_tclparam.html"> pt::peg::to::tclparam </a> · <a href="tcllib/files/modules/pt/pt_peg_language.html"> pt::peg_language </a> · <a href="tcllib/files/modules/pt/pt_peg_introduction.html"> pt::pegrammar </a> · <a href="tcllib/files/modules/pt/pt_pgen.html"> pt::pgen </a> · <a href="tcllib/files/modules/pt/pt_rdengine.html"> pt::rde </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_nx.html"> pt::tclparam::configuration::nx </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_snit.html"> pt::tclparam::configuration::snit </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_tcloo.html"> pt::tclparam::configuration::tcloo </a> · <a href="tcllib/files/modules/pt/pt_util.html"> pt::util </a> · <a href="tcllib/files/modules/pt/pt_to_api.html"> pt_export_api </a> · <a href="tcllib/files/modules/pt/pt_from_api.html"> pt_import_api </a> · <a href="tcllib/files/modules/pt/pt_introduction.html"> pt_introduction </a> · <a href="tcllib/files/modules/pt/pt_parse_peg.html"> pt_parse_peg </a> · <a href="tcllib/files/modules/pt/pt_parser_api.html"> pt_parser_api </a> · <a href="tcllib/files/modules/pt/pt_peg_op.html"> pt_peg_op </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="performance"> performance </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/bench/bench.html"> bench </a> · <a href="tcllib/files/modules/bench/bench_read.html"> bench::in </a> · <a href="tcllib/files/modules/bench/bench_wcsv.html"> bench::out::csv </a> · <a href="tcllib/files/modules/bench/bench_wtext.html"> bench::out::text </a> · <a href="tcllib/files/modules/bench/bench_intro.html"> bench_intro </a> · <a href="tcllib/files/modules/bench/bench_lang_intro.html"> bench_lang_intro </a> · <a href="tcllib/files/modules/bench/bench_lang_spec.html"> bench_lang_spec </a> · <a href="tcllib/files/modules/profiler/profiler.html"> profiler </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="permutation"> permutation </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/struct_list.html"> struct::list </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="persistence"> persistence </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/tie/tie_std.html"> tie </a> · <a href="tcllib/files/modules/tie/tie.html"> tie </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="phone"> phone </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/valtype/imei.html"> valtype::imei </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pi"> pi </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/constants.html"> math::constants </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="plain_text"> plain text </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/doctools2idx/idx_export_text.html"> doctools::idx::export::text </a> · <a href="tcllib/files/modules/doctools2toc/toc_export_text.html"> doctools::toc::export::text </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="plane_geometry"> plane geometry </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/math_geometry.html"> math::geometry </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="plugin"> plugin </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/doctools/docidx_plugin_apiref.html"> docidx_plugin_apiref </a> · <a href="tcllib/files/modules/doctools/doctoc_plugin_apiref.html"> doctoc_plugin_apiref </a> · <a href="tcllib/files/modules/doctools2idx/idx_introduction.html"> doctools2idx_introduction </a> · <a href="tcllib/files/modules/doctools2toc/toc_introduction.html"> doctools2toc_introduction </a> · <a href="tcllib/files/modules/doctools2base/html_cssdefaults.html"> doctools::html::cssdefaults </a> · <a href="tcllib/files/modules/doctools2idx/idx_container.html"> doctools::idx </a> · <a href="tcllib/files/modules/doctools2idx/idx_export.html"> doctools::idx::export </a> · <a href="tcllib/files/modules/doctools2idx/idx_import.html"> doctools::idx::import </a> · <a href="tcllib/files/modules/doctools2base/nroff_manmacros.html"> doctools::nroff::man_macros </a> · <a href="tcllib/files/modules/doctools2toc/toc_container.html"> doctools::toc </a> · <a href="tcllib/files/modules/doctools2toc/toc_export.html"> doctools::toc::export </a> · <a href="tcllib/files/modules/doctools2toc/toc_import.html"> doctools::toc::import </a> · <a href="tcllib/files/modules/pt/pt_peg_export_container.html"> pt::peg::export::container </a> · <a href="tcllib/files/modules/pt/pt_peg_export_json.html"> pt::peg::export::json </a> · <a href="tcllib/files/modules/pt/pt_peg_export_peg.html"> pt::peg::export::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_import_json.html"> pt::peg::import::json </a> · <a href="tcllib/files/modules/pt/pt_peg_import_peg.html"> pt::peg::import::peg </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="plugin_management"> plugin management </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pluginmgr/pluginmgr.html"> pluginmgr </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="plugin_search"> plugin search </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pluginmgr/pluginmgr.html"> pluginmgr </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="png"> png </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/png/png.html"> png </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="point"> point </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/math_geometry.html"> math::geometry </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="polynomial_functions"> polynomial functions </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/polynomials.html"> math::polynomials </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pool"> pool </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/pool.html"> struct::pool </a> · <a href="tcllib/files/modules/struct/queue.html"> struct::queue </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pop"> pop </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pop3/pop3.html"> pop3 </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pop3"> pop3 </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pop3/pop3.html"> pop3 </a> · <a href="tcllib/files/modules/pop3d/pop3d.html"> pop3d </a> · <a href="tcllib/files/modules/pop3d/pop3d_dbox.html"> pop3d::dbox </a> · <a href="tcllib/files/modules/pop3d/pop3d_udb.html"> pop3d::udb </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="post_order"> post-order </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/struct_tree.html"> struct::tree </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="practcl"> practcl </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/practcl/practcl.html"> practcl </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="pre_order"> pre-order </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/struct_tree.html"> struct::tree </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="prefix"> prefix </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/textutil/textutil_string.html"> textutil::string </a> · <a href="tcllib/files/modules/textutil/trim.html"> textutil::trim </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="prime"> prime </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/numtheory.html"> math::numtheory </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="prioqueue"> prioqueue </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/prioqueue.html"> struct::prioqueue </a> · <a href="tcllib/files/modules/struct/queue.html"> struct::queue </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="priority_queue"> priority queue </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/prioqueue.html"> struct::prioqueue </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="proc"> proc </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/lambda/lambda.html"> lambda </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="procedure"> procedure </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/interp/deleg_proc.html"> deleg_proc </a> · <a href="tcllib/files/modules/tepam/tepam_introduction.html"> tepam </a> · <a href="tcllib/files/modules/tepam/tepam_procedure.html"> tepam::procedure </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="procedure_documentation"> procedure documentation </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/tepam/tepam_doc_gen.html"> tepam::doc_gen </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="processman"> processman </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/processman/processman.html"> processman </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="producer"> producer </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/hook/hook.html"> hook </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="profile"> profile </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/profiler/profiler.html"> profiler </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="projection"> projection </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/mapproj/mapproj.html"> mapproj </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="prospero"> prospero </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/uri/uri.html"> uri </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="protocol"> protocol </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/asn/asn.html"> asn </a> · <a href="tcllib/files/modules/ldap/ldap.html"> ldap </a> · <a href="tcllib/files/modules/ldap/ldapx.html"> ldapx </a> · <a href="tcllib/files/modules/nns/nns_protocol.html"> nameserv::protocol </a> · <a href="tcllib/files/modules/pop3d/pop3d.html"> pop3d </a> · <a href="tcllib/files/modules/pop3d/pop3d_dbox.html"> pop3d::dbox </a> · <a href="tcllib/files/modules/pop3d/pop3d_udb.html"> pop3d::udb </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="proxy"> proxy </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/http/autoproxy.html"> autoproxy </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="public_key_cipher"> public key cipher </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pki/pki.html"> pki </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="publisher"> publisher </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/hook/hook.html"> hook </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="push_down_automaton"> push down automaton </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/grammar_me/me_intro.html"> grammar::me_intro </a> · <a href="tcllib/files/modules/grammar_peg/peg.html"> grammar::peg </a> · <a href="tcllib/files/modules/grammar_peg/peg_interp.html"> grammar::peg::interp </a> · <a href="tcllib/files/apps/pt.html"> pt </a> · <a href="tcllib/files/modules/pt/pt_astree.html"> pt::ast </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_critcl.html"> pt::cparam::configuration::critcl </a> · <a href="tcllib/files/modules/pt/pt_cparam_config_tea.html"> pt::cparam::configuration::tea </a> · <a href="tcllib/files/modules/pt/pt_json_language.html"> pt::json_language </a> · <a href="tcllib/files/modules/pt/pt_param.html"> pt::param </a> · <a href="tcllib/files/modules/pt/pt_pexpression.html"> pt::pe </a> · <a href="tcllib/files/modules/pt/pt_pexpr_op.html"> pt::pe::op </a> · <a href="tcllib/files/modules/pt/pt_pegrammar.html"> pt::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_container.html"> pt::peg::container </a> · <a href="tcllib/files/modules/pt/pt_peg_container_peg.html"> pt::peg::container::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_export.html"> pt::peg::export </a> · <a href="tcllib/files/modules/pt/pt_peg_export_container.html"> pt::peg::export::container </a> · <a href="tcllib/files/modules/pt/pt_peg_export_json.html"> pt::peg::export::json </a> · <a href="tcllib/files/modules/pt/pt_peg_export_peg.html"> pt::peg::export::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_from_container.html"> pt::peg::from::container </a> · <a href="tcllib/files/modules/pt/pt_peg_from_json.html"> pt::peg::from::json </a> · <a href="tcllib/files/modules/pt/pt_peg_from_peg.html"> pt::peg::from::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_import.html"> pt::peg::import </a> · <a href="tcllib/files/modules/pt/pt_peg_import_container.html"> pt::peg::import::container </a> · <a href="tcllib/files/modules/pt/pt_peg_import_json.html"> pt::peg::import::json </a> · <a href="tcllib/files/modules/pt/pt_peg_import_peg.html"> pt::peg::import::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_interp.html"> pt::peg::interp </a> · <a href="tcllib/files/modules/pt/pt_peg_to_container.html"> pt::peg::to::container </a> · <a href="tcllib/files/modules/pt/pt_peg_to_cparam.html"> pt::peg::to::cparam </a> · <a href="tcllib/files/modules/pt/pt_peg_to_json.html"> pt::peg::to::json </a> · <a href="tcllib/files/modules/pt/pt_peg_to_param.html"> pt::peg::to::param </a> · <a href="tcllib/files/modules/pt/pt_peg_to_peg.html"> pt::peg::to::peg </a> · <a href="tcllib/files/modules/pt/pt_peg_to_tclparam.html"> pt::peg::to::tclparam </a> · <a href="tcllib/files/modules/pt/pt_peg_language.html"> pt::peg_language </a> · <a href="tcllib/files/modules/pt/pt_peg_introduction.html"> pt::pegrammar </a> · <a href="tcllib/files/modules/pt/pt_pgen.html"> pt::pgen </a> · <a href="tcllib/files/modules/pt/pt_rdengine.html"> pt::rde </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_nx.html"> pt::tclparam::configuration::nx </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_snit.html"> pt::tclparam::configuration::snit </a> · <a href="tcllib/files/modules/pt/pt_tclparam_config_tcloo.html"> pt::tclparam::configuration::tcloo </a> · <a href="tcllib/files/modules/pt/pt_util.html"> pt::util </a> · <a href="tcllib/files/modules/pt/pt_to_api.html"> pt_export_api </a> · <a href="tcllib/files/modules/pt/pt_from_api.html"> pt_import_api </a> · <a href="tcllib/files/modules/pt/pt_introduction.html"> pt_introduction </a> · <a href="tcllib/files/modules/pt/pt_parse_peg.html"> pt_parse_peg </a> · <a href="tcllib/files/modules/pt/pt_parser_api.html"> pt_parser_api </a> · <a href="tcllib/files/modules/pt/pt_peg_op.html"> pt_peg_op </a> </td></tr> <tr class="#doctools_idxheader"><th colspan="2"> <a name="cQ">Keywords: Q</a> </th></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="quasi_random"> quasi-random </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/math/quasirandom.html"> math::quasirandom </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="queue"> queue </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/csv/csv.html"> csv </a> · <a href="tcllib/files/modules/htmlparse/htmlparse.html"> htmlparse </a> · <a href="tcllib/files/modules/struct/stack.html"> struct::stack </a> · <a href="tcllib/files/modules/transfer/tqueue.html"> transfer::copy::queue </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="quoting"> quoting </a></td> |
︙ | ︙ | |||
3439 3440 3441 3442 3443 3444 3445 | <td class="#doctools_idxleft" width="35%"><a name="service"> service </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/log/logger.html"> logger </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="services"> services </a></td> <td class="#doctools_idxright" width="65%"> | | | 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 | <td class="#doctools_idxleft" width="35%"><a name="service"> service </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/log/logger.html"> logger </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="services"> services </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/ftpd/ftpd.html"> ftpd </a> · <a href="tcllib/files/modules/httpd/httpd.html"> httpd </a> · <a href="tcllib/files/modules/smtpd/smtpd.html"> smtpd </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="set"> set </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/struct/queue.html"> struct::queue </a> · <a href="tcllib/files/modules/struct/struct_set.html"> struct::set </a> </td></tr> <tr class="#doctools_idxeven" valign=top> |
︙ | ︙ | |||
3792 3793 3794 3795 3796 3797 3798 | <td class="#doctools_idxleft" width="35%"><a name="tcllib"> tcllib </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/csv/csv.html"> csv </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="tcloo"> TclOO </a></td> <td class="#doctools_idxright" width="65%"> | | | 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 | <td class="#doctools_idxleft" width="35%"><a name="tcllib"> tcllib </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/csv/csv.html"> csv </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="tcloo"> TclOO </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/clay/clay.html"> clay </a> · <a href="tcllib/files/modules/httpd/httpd.html"> httpd </a> · <a href="tcllib/files/modules/tool/meta.html"> oo::util </a> · <a href="tcllib/files/modules/ooutil/ooutil.html"> oo::util </a> · <a href="tcllib/files/modules/oometa/oometa.html"> oometa </a> · <a href="tcllib/files/modules/tool/tool.html"> tool </a> · <a href="tcllib/files/modules/tool/tool_dict_ensemble.html"> tool::dict_ensemble </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="tclparam"> TCLPARAM </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/pt/pt_peg_to_tclparam.html"> pt::peg::to::tclparam </a> </td></tr> <tr class="#doctools_idxeven" valign=top> |
︙ | ︙ | |||
4261 4262 4263 4264 4265 4266 4267 | <td class="#doctools_idxleft" width="35%"><a name="word"> word </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/doctools2base/tcl_parse.html"> doctools::tcl::parse </a> · <a href="tcllib/files/modules/wip/wip.html"> wip </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="www"> WWW </a></td> <td class="#doctools_idxright" width="65%"> | | | 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 | <td class="#doctools_idxleft" width="35%"><a name="word"> word </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/doctools2base/tcl_parse.html"> doctools::tcl::parse </a> · <a href="tcllib/files/modules/wip/wip.html"> wip </a> </td></tr> <tr class="#doctools_idxeven" valign=top> <td class="#doctools_idxleft" width="35%"><a name="www"> WWW </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/httpd/httpd.html"> httpd </a> </td></tr> <tr class="#doctools_idxodd" valign=top> <td class="#doctools_idxleft" width="35%"><a name="www"> www </a></td> <td class="#doctools_idxright" width="65%"> <a href="tcllib/files/modules/uri/uri.html"> uri </a> </td></tr> <tr class="#doctools_idxheader"><th colspan="2"> |
︙ | ︙ |
Added idoc/www/tcllib/files/devdoc/tcl_community_communication.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>tcl_community_communication - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'tcl_community_communication.man' by tcllib/doctools with format 'html' --> <!-- tcl_community_communication.n --> <body><hr> [ <a href="../../../../../../../home">Tcllib Home</a> | <a href="../../../toc.html">Main Table Of Contents</a> | <a href="../../toc.html">Table Of Contents</a> | <a href="../../../index.html">Keyword Index</a> | <a href="../../../toc0.html">Categories</a> | <a href="../../../toc1.html">Modules</a> | <a href="../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcl_community_communication(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcl_community_communication - Tcl Community - Kind Communication</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Signatories</a></li> <li class="doctools_section"><a href="#section3">Authors</a></li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>The Tcl Community encourages contributions from anyone who wishes to advance the development of:</p> <ul class="doctools_itemized"> <li><p>The Tcl Language</p></li> <li><p>Tcl derived languages</p></li> <li><p>Tcl related libraries</p></li> <li><p>Tcl extensions</p></li> <li><p>External Projects that Integrate Tcl</p></li> </ul> <p>We welcome those contributions from anyone. We are blind to gender, race, religion, cultural background, cybernetic nature, and any other demographic characteristics, as well as personal political views.</p> <p>A community lives and dies by communications. And occasionally our communications are peppered with patterns that are harsh, unfriendly, unwelcoming and/or otherwise unkind. As a volunteer community, we need all of the help we can get. Therefore, we ask all contributors to make a conscious effort, in Tcl Community discussions, to communicate in ways that are welcoming. Ways that are friendly. Ways that are, in a word: kind.</p> <p>These guidelines suggest specific ways to accomplish that goal.</p> <p>Please note: for the balance of this document any reference to "People", "Persons", "anybody" or "somebody" can refer to any sentient being, not merely corporeal members of the species Homo Sapien.</p> <dl class="doctools_definitions"> <dt>We are a Sanctuary not a Clubhouse</dt> <dd><p>The Tcl Community is a collective of amateurs and professionals who code, test, and use tools. Our community is open to all. There is no velvet rope. There is no bouncer at the door. There are no secret handshakes. Any sentient being who enters our midst is welcome. If someone is ever asked to leave, it is only because they are being disruptive to the functioning of the community.</p></dd> <dt>We Merit Ideas, Not People</dt> <dd><p>A good idea can come from anyone, regardless of how little time they have been with us. A bad idea can come from anyone, regardless of how much time or how little time they have been with us. We judge a concept by how it stands up to scrutiny of logic, implementation, and regression testing. We don’t judge ideas based on who had the idea first, who agrees with the idea, or who disagrees with it.</p></dd> <dt>Treat Everyone with Respect</dt> <dd><p>Everyone is deserving of respect and courtesy at all times.</p></dd> <dt>Refer to people by the names they use.</dt> <dd><p>If grammar requires you to state a gender for a person, honor their preferences about their gender identity. If you are unsure as to the gender of an individual, ask. If someone had to guess about your gender and got it wrong, please correct them and do not take it personally.</p></dd> <dt>Do not take a harsh tone towards other participants.</dt> <dd><p>Do not make personal attacks against anyone (participant or not.)</p> <p>Criticize statements and actions, never people.</p></dd> <dt>Don’t Take Things Personally</dt> <dd><p>When in doubt, assume the best in people. A criticism of your statements is not a personal attack on you.</p></dd> <dt>Persons, not People</dt> <dd><p>Stereotypes are an unhelpful tool on many accounts. They are generally oversimplified. They are usually flat out wrong. And even if "right" they are of absolutely no utility in determining the capabilities, motivations, or fitness of an individual.</p> <p>Don’t use them in Tcl Community communications.</p></dd> <dt>Mistakes Happen</dt> <dd><p>The human condition is a series of trials and errors. Progress is when we get one more trial than error. Being wrong or making a mistake is the default state of humanity. Accept the errors of your fellow sentient beings, and be aware that you are also fallible.</p></dd> <dt>Keep it Real</dt> <dd><p>Please respond to what people actually say. We are all amazing individuals, but none among us are mind readers. If you find yourself responding to what you imagine someone is thinking, odds are you are going to be wrong.</p> <p>If you must criticize someone, stick to things they have actually done. Never criticize for something you speculate they have done. Or imagine they have done. Or something someone who shares some attribute with them has done in the past.</p> <p>Keep discussions about any non-Tcl subjects to what can be stated factually and without emotion or judgement.</p></dd> <dt>When Trouble Arises, Don’t Escalate</dt> <dd><p>If you feel you are being personally attacked or offended, take the high road. Punching back in a public forum will only makes things worse. Address the matter in a private correspondence. Be polite. Express your feelings, but note that you are expressing your feelings. When writing, look for a way to calm matters down. And when in doubt, sleep on your letter before pressing send. And when not in doubt, sleep on it for another day after that.</p> <p>If you are a spectator to a fight in progress, politely request the two parties take the matter to a more private forum.</p></dd> <dt>Always get the Last Word: I’m Sorry</dt> <dd><p>If an personal argument does arise, be the first to apologize. An apology does not concede a logical point. It merely acknowledges that at some point the discussion left either logic, community decency, or both. Return to the topic when cooler heads can prevail.</p></dd> <dt>Nobody is Keeping Score</dt> <dd><p>There is no prize for being right. There is no cost for being wrong. A hard sell is not going to advance your idea along any more than a logical argument. You aren’t running for office. This isn’t debate club. If you find yourself continuing a discussion beyond where a topic can be logically discussed, stop.</p></dd> <dt>No Evangelizing</dt> <dd><p>The Tcl Community is not the place to promote your chosen operating system, political outlook, religion, marketing scheme, or economic model. Period.</p> <p>(And if you do bring it up, be prepared to have your chosen topic discussed logically. And odds are, not favorably.)</p></dd> <dt>Respect the Community</dt> <dd><p>If the Community has come to a decision on a course of action, please stop arguing.</p> <p>If someone complains about how you are expressing your ideas, listen.</p> <p>If your words are hurting people, stop. There is no amount of being "right" that makes up for someone leaving our midst because they felt insulted, threatened, or ignored.</p></dd> </dl> <p>By following these guidelines, we will build our community, encourage more contribution to our projects, and our discussions will be friendlier and reach conclusions more easily.</p> <p>Thank You.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Signatories</a></h2> <ul class="doctools_itemized"> <li><p>Sean "the Hypnotoad" Woods</p></li> <li><p>Andreas Kupries</p></li> </ul> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Authors</a></h2> <dl class="doctools_definitions"> <dt>Primary</dt> <dd><p>Sean "the Hypnotoad" Woods</p></dd> <dt>Light editing</dt> <dd><p>Andreas Kupries</p></dd> </dl> </div> </div></body></html> |
Added idoc/www/tcllib/files/devdoc/tcllib_devguide.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>tcllib_devguide - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'tcllib_devguide.man' by tcllib/doctools with format 'html' --> <!-- tcllib_devguide.n --> <body><hr> [ <a href="../../../../../../../home">Tcllib Home</a> | <a href="../../../toc.html">Main Table Of Contents</a> | <a href="../../toc.html">Table Of Contents</a> | <a href="../../../index.html">Keyword Index</a> | <a href="../../../toc0.html">Categories</a> | <a href="../../../toc1.html">Modules</a> | <a href="../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcllib_devguide(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcllib_devguide - Tcllib - The Developer's Guide</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Commitments</a> <ul> <li class="doctools_subsection"><a href="#subsection1">Contributor</a></li> <li class="doctools_subsection"><a href="#subsection2">Maintainer</a></li> </ul> </li> <li class="doctools_section"><a href="#section3">Branching and Workflow</a> <ul> <li class="doctools_subsection"><a href="#subsection3">Package Dependencies</a></li> <li class="doctools_subsection"><a href="#subsection4">Trunk</a></li> <li class="doctools_subsection"><a href="#subsection5">Branches</a></li> <li class="doctools_subsection"><a href="#subsection6">Working with Branches</a></li> <li class="doctools_subsection"><a href="#subsection7">Version numbers</a></li> </ul> </li> <li class="doctools_section"><a href="#section4">Structural Overview</a> <ul> <li class="doctools_subsection"><a href="#subsection8">Main Directories</a></li> <li class="doctools_subsection"><a href="#subsection9">More Directories</a></li> <li class="doctools_subsection"><a href="#subsection10">Top Files</a></li> <li class="doctools_subsection"><a href="#subsection11">File Types</a></li> </ul> </li> <li class="doctools_section"><a href="#section5">Testsuite Tooling</a> <ul> <li class="doctools_subsection"><a href="#subsection12">Invoke the testsuites of a specific module</a></li> <li class="doctools_subsection"><a href="#subsection13">Invoke the testsuites of all modules</a></li> <li class="doctools_subsection"><a href="#subsection14">Detailed Test Logs</a></li> <li class="doctools_subsection"><a href="#subsection15">Shell Selection</a></li> <li class="doctools_subsection"><a href="#subsection16">Help</a></li> </ul> </li> <li class="doctools_section"><a href="#section6">Documentation Tooling</a> <ul> <li class="doctools_subsection"><a href="#subsection17">Generate documentation for a specific module</a></li> <li class="doctools_subsection"><a href="#subsection18">Generate documentation for all modules</a></li> <li class="doctools_subsection"><a href="#subsection19">Available output formats, help</a></li> <li class="doctools_subsection"><a href="#subsection20">Validation without output</a></li> </ul> </li> <li class="doctools_section"><a href="#section7">Notes On Writing A Testsuite</a></li> <li class="doctools_section"><a href="#section8">Installation Tooling</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd"><a href="../../../index.html#module">Module</a></b> <i class="arg">name</i> <i class="arg">code-action</i> <i class="arg">doc-action</i> <i class="arg">example-action</i></a></li> <li><a href="#2"><b class="cmd"><a href="../../../index.html#application">Application</a></b> <i class="arg">name</i></a></li> <li><a href="#3"><b class="cmd">Exclude</b> <i class="arg">name</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a package itself. It is a collection of (semi-independent) <i class="term"><a href="../../../index.html#tcl">Tcl</a></i> packages that provide utility functions useful to a large collection of Tcl programmers.</p> <p>This document is a guide for developers working on Tcllib, i.e. maintainers fixing bugs, extending the collection's functionality, etc.</p> <p>Please read</p> <ol class="doctools_enumerated"> <li><p><i class="term"><a href="tcllib_sources.html">Tcllib - How To Get The Sources</a></i> and</p></li> <li><p><i class="term"><a href="tcllib_installer.html">Tcllib - The Installer's Guide</a></i></p></li> </ol> <p>first, if that was not done already.</p> <p>Here we assume that the sources are already available in a directory of your choice, and that you not only know how to build and install them, but also have all the necessary requisites to actually do so. The guide to the sources in particular also explains which source code management system is used, where to find it, how to set it up, etc.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Commitments</a></h2> <div id="subsection1" class="doctools_subsection"><h3><a name="subsection1">Contributor</a></h3> <p>As a contributor to Tcllib you are committing yourself to:</p> <ol class="doctools_enumerated"> <li><p>keep the guidelines written down in <i class="term"><a href="tcl_community_communication.html">Tcl Community - Kind Communication</a></i> in your mind. The main point to take away from there is <em>to be kind to each other</em>.</p></li> <li><p>Your contributions getting distributed under a BSD/MIT license. For the details see <i class="term"><a href="tcllib_license.html">Tcllib - License</a></i></p></li> </ol> <p>Contributions are made by entering tickets into our tracker, providing patches, bundles or branches of code for inclusion, or posting to the Tcllib related mailing lists.</p> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Maintainer</a></h3> <p>When contributing one or more packages for full inclusion into Tcllib you are committing yourself to</p> <ol class="doctools_enumerated"> <li><p>Keep the guidelines written down in <i class="term"><a href="tcl_community_communication.html">Tcl Community - Kind Communication</a></i> (as any contributor) in your mind. The main point to take away from there is <em>to be kind to each other</em>.</p></li> <li><p>Your packages getting distributed under a BSD/MIT license. For the details see <i class="term"><a href="tcllib_license.html">Tcllib - License</a></i></p></li> <li><p>Maintenance of the new packages for a period of two years under the following rules, and responsibilities:</p> <ol class="doctools_enumerated"> <li><p>A maintainer may step down after the mandatory period as they see fit.</p></li> <li><p>A maintainer may step down before the end of the mandatory period, under the condition that a replacement maintainer is immediately available and has agreed to serve the remainder of the period, plus their own mandatory period (see below).</p></li> <li><p>When stepping down without a replacement maintainer taking over the relevant packages have to be flagged as <b class="const">unmaintained</b>.</p></li> <li><p>When a replacement mantainer is brought in for a package it is (kept) marked as <b class="const">maintained</b> (again).</p> <p>A replacement maintainer is bound by the same rules as the original maintainer, except that the mandatory period of maintenance is shortened to one year.</p></li> <li><p>For any <b class="const">unmaintained</b> package a contributor interested in becoming its maintainer can become so by flagging them as <b class="const">maintained</b> with their name and contact information, committing themselves to the rules of a replacement maintainer (see previous point).</p></li> <li><p>For any already <b class="const">maintained</b> package a contributor interested in becoming a co-maintainer can become so with the agreement of the existing maintainer(s), committing themselves to the rules of a replacement maintainer (see two points previous).</p></li> </ol> <p>The responsibilities as a maintainer include:</p> <ol class="doctools_enumerated"> <li><p>Watching Tcllib's ticket tracker for bugs, bug fixes, and feature requests related to the new packages.</p></li> <li><p>Reviewing the aforementioned tickets, rejecting or applying them</p></li> <li><p>Coordination and discussion with ticket submitter during the development and/or application of bug fixes.</p></li> </ol> </li> <li><p>Follow the <span class="sectref"><a href="#section3">Branching and Workflow</a></span> of this guide.</p></li> </ol> </div> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Branching and Workflow</a></h2> <div id="subsection3" class="doctools_subsection"><h3><a name="subsection3">Package Dependencies</a></h3> <p>Regarding packages and dependencies between them Tcllib occupies a middle position between two extremes:</p> <ol class="doctools_enumerated"> <li><p>On one side a strongly interdependent set of packages, usually by a single author, for a single project. Looking at my (Andreas Kupries) own work examples of such are <a href="https://core.tcl.tk/akupries/marpa/index">Marpa</a>, <a href="https://core.tcl.tk/akupries/crimp/index">CRIMP</a>, <a href="https://core.tcl.tk/akupries/kinetcl/index">Kinetcl</a>, etc.</p> <p>For every change the author of the project handles all the modifications cascading from any incompatibilities it introduced to the system.</p></li> <li><p>On the other side, the world of semi-independent projects by many different authors where authors know what packages their own creations depend on, yet usually do not know who else depends on them.</p> <p>The best thing an author making an (incompatible) change to their project can do is to for one announce such changes in some way, and for two use versioning to distinguish the code before and after the change.</p> <p>The world is then responsible for adapting, be it by updating their own projects to the new version, or by sticking to the old.</p></li> </ol> <p>As mentioned already, Tcllib lives in the middle of that.</p> <p>While we as maintainers cannot be aware of all users of Tcllib's packages, and thus have to rely on the mechanisms touched on in point 2 above for that, the dependencies between the packages contained in Tcllib are a different matter.</p> <p>As we are collectively responsible for the usability of Tcllib in toto to the outside world, it behooves us to be individually mindful even of Tcllib packages we are not directly maintaining, when they depend on packages under our maintainership. This may be as simple as coordinating with the maintainers of the affected packages. It may also require us to choose how to adapt affected packages which do not have maintainers, i.e. modify them to use our changed package properly, or modify them to properly depend on the unchanged version of our package.</p> <p>Note that the above is not only a chore but an opportunity as well. Additional insight can be had by forcing ourselves to look at our package and the planned change(s) from an outside perspective, to consider the ramifications of our actions on others in general, and on dependent packages in particular.</p> </div> <div id="subsection4" class="doctools_subsection"><h3><a name="subsection4">Trunk</a></h3> <p>The management and use of branches is an important part of working with a <i class="term">Distributed Version Control System</i> (<i class="term">DVCS</i>) like <a href="https://www.fossil-scm.org/">fossil</a>.</p> <p>For Tcllib the main branch of the collection is <i class="term">trunk</i>. In <i class="term">git</i> this branch would be called <i class="term">master</i>, and this is exactly the case in the <a href="https://github.com/tcltk/tcllib/">github mirror</a> of Tcllib.</p> <p>To properly support debugging <em>each commit</em> on this branch <em>has to pass the entire testsuite</em> of the collection. Using bisection to determine when an issue appeared is an example of an action made easier by this constraint.</p> <p>This is part of our collective responsibility for the usability of Tcllib in toto to the outside world. As <i class="term">fossil</i> has no mechanism to enforce this condition this is handled on the honor system for developers and maintainers.</p> <p>To make the task easier Tcllib comes with a tool ("<b class="file">sak.tcl</b>") providing a number of commands in support. These commands are explained in the following sections of this guide.</p> <p>While it is possible and allowed to commit directly to trunk remember the above constraint regarding the testsuite, and the coming notes about other possible issues with a commit.</p> </div> <div id="subsection5" class="doctools_subsection"><h3><a name="subsection5">Branches</a></h3> <p>Given the constraints placed on the <i class="term">trunk</i> branch of the repository it is (strongly) recommended to perform any development going beyond trivial changes on a non-trunk branch.</p> <p>Outside of the trunk developers are allowed to commit intermediate broken states of their work. Only at the end of a development cycle, when the relevant branch is considered ready for merging, will it be necessary to perform full the set of validations ensuring that the merge to come will create a good commit on trunk.</p> <p>Note that while a review from a second developer is not a required condition for merging a branch it is recommended to seek out such an independent opinion as a means of cross-checking the work.</p> <p>It also recommended to give any new branch a name which aids in determining additional details about it. Examples of good things to stick into a branch name would be</p> <ul class="doctools_itemized"> <li><p>Developer (nick)name</p></li> <li><p>Ticket hash/reference</p></li> <li><p>One or two keywords applicable to the work</p></li> <li><p>...</p></li> </ul> <p>Further, while most development branches are likely quite short-lived, no prohibitions exist against making longer-lived branches. Creators should however be mindful that the longer such a branch exists without merges the more divergent they will tend to be, with an associated increase in the effort which will have to be spent on either merging from and merging to trunk.</p> </div> <div id="subsection6" class="doctools_subsection"><h3><a name="subsection6">Working with Branches</a></h3> <p>In the hope of engendering good work practices now a few example operations which will come up with branches, and their associated fossil command (sequences).</p> <dl class="doctools_definitions"> <dt><em>Awareness</em></dt> <dd><p>When developing we have to keep ourselves aware of the context of our work. On what branch are we ? What files have we changed ? What new files are not yet known to the repository ? What has happened remotely since we used our checkout ? The answers to these questions become especially important when using a long-lived checkout and coming back to it after some time away.</p> <p>Commands to answer questions like the above are:</p> <dl class="doctools_definitions"> <dt><b class="cmd">fossil pull</b></dt> <dd><p>Get all changes done on the remote since the last pull or sync from it. This has to be done first, before any of the commands below.</p> <p>Even if the commit in our checkout refers to the branch we want right now control operations committed to the remote may have changed that from underneath us.</p></dd> <dt><b class="cmd">fossil info | grep tags</b></dt> <dd></dd> <dt><b class="cmd">fossil branch list | grep '\*'</b></dt> <dd><p>Two different ways of determining the branch our checkout is on.</p></dd> <dt><b class="cmd">fossil timeline</b></dt> <dd><p>What have we (and others) done recently ?</p> <p><em>Attention</em>, this information is very likely outdated, the more the longer we did not use this checkout. Run <b class="cmd">fossil pull</b> first to get latest information from the remote repository of the project.</p></dd> <dt><b class="cmd">fossil timeline current</b></dt> <dd><p>Place the commit our checkout is based on at the top of the timeline.</p></dd> <dt><b class="cmd">fossil changes</b></dt> <dd><p>Lists the files we have changed compared to the commit the checkout is based on.</p></dd> <dt><b class="cmd">fossil extra</b></dt> <dd><p>Lists the files we have in the checkout the repository does not know about. This may be leftover chaff from our work, or something we have forgotten to <b class="cmd">fossil add</b> to the repository yet.</p></dd> </dl></dd> <dt><em>Clean checkouts</em></dt> <dd><p>Be aware of where you are (see first definition).</p> <p>For pretty much all the operation recipes below a clean checkout is at least desired, often required. To check that a checkout is clean invoke</p> <pre class="doctools_example"> fossil changes fossil extra </pre> <p>How to clean up when uncommitted changes of all sorts are found is context-specific and outside of the scope of this guide.</p></dd> <dt><em>Starting a new branch</em></dt> <dd><p>Be aware of where you are (see first definition).</p> <p>Ensure that you have clean checkout (see second definition). It is <em>required</em>.</p> <p>In most situations you want to be on branch <i class="term">trunk</i>, and you want to be on the latest commit for it. To get there use</p> <pre class="doctools_example"> fossil pull fossil update trunk </pre> <p>If some other branch is desired as the starting point for the coming work replace <i class="term">trunk</i> in the commands above with the name of that branch.</p> <p>With the base line established we now have two ways of creating the new branch, with differing (dis)advantages. The simpler way is to</p> <pre class="doctools_example"> fossil branch new NAME_OF_NEW_BRANCH </pre> <p>and start developing. The advantage here is that you cannot forget to create the branch. The disadvantages are that we have a branch commit unchanged from where we branched from, and that we have to use high-handed techniques like hiding or shunning to get rid of the commit should we decide to abandon the work before the first actual commit on the branch.</p> <p>The other way of creating the branch is to start developing, and then on the first commit use the option <b class="option">--branch</b> to tell <b class="syscmd">fossil</b> that we are starting a branch now. I.e. run</p> <pre class="doctools_example"> fossil commit --branch NAME_OF_NEW_BRANCH ... </pre> <p>where <i class="term">...</i> are any other options used to supply the commit message, files to commit, etc.</p> <p>The (dis)advantages are now reversed.</p> <p>We have no superflous commit, only what is actually developed. The work is hidden until we commit to make our first commit.</p> <p>We may forget to use <b class="option">--branch NAME_OF_NEW_BRANCH</b> and then have to correct that oversight via the fossil web interface (I am currently unaware of ways of doing such from the command line, although some magic incantantion of <b class="cmd">fossil tag create</b> may work).</p> <p>It helps to keep awareness, like checking before any commit that we are on the desired branch.</p></dd> <dt><em>Merging a branch into trunk</em></dt> <dd><p>Be aware of where you are (see first definition).</p> <p>Ensure that you have clean checkout (see second definition). In the full-blown sequence (zig-zag) it is <em>required</em>, due to the merging from trunk. In the shorter sequence it is only desired. That said, keeping the checkout clean before any major operations is a good habit to have, in my opinion.</p> <p>The full-blown sequencing with checks all the way is to</p> <ol class="doctools_enumerated"> <li><p>Validate the checkout, i.e. last commit on your branch. Run the full test suite and other validations, fix all the issues which have cropped up.</p></li> <li><p>Merge the latest state of the <i class="term">trunk</i> (see next definition).</p></li> <li><p>Validate the checkout again. The incoming trunk changes may have broken something now. Do any required fixes.</p></li> <li><p>Now merge to the trunk using</p> <pre class="doctools_example"> fossil update trunk fossil merge --integrate YOUR_BRANCH </pre> </li> <li><p>At this point the checkout should be in the same state as at the end of point (3) above, because we resolved any issues with the trunk already. Thus a simple</p> <pre class="doctools_example"> fossil commit ... </pre> <p>should be sufficient now to commit the merge back and close the branch (due to the <b class="option">--integrate</b> we used on the merge).</p> <p>The more paranoid may validate the checkout a third time before commiting.</p></li> </ol> <p>I call this a <i class="term">zig-zag merge</i> because of how the arrows look in the timeline, from trunk to feature branch for the first merge, and then back for the final merge.</p> <p>A less paranoid can do what I call a <i class="term">simple merge</i>, which moves step (2) after step (4) and skips step (3) entirely. The resulting shorter sequence is</p> <ol class="doctools_enumerated"> <li><p>Validate</p></li> <li><p>Merge to trunk</p></li> <li><p>Validate again</p></li> <li><p>Commit to trunk</p></li> </ol> <p>The last step after either zig-zag or plain merge is to</p> <pre class="doctools_example"> fossil sync </pre> <p>This saves our work to the remote side, and further gives us any other work done while we were doing our merge. It especially allows us to check if we raced somebody else, resulting in a split trunk.</p> <p>When that happens we should coordinate with the other developer on who fixes the split, to ensure that we do not race each other again.</p></dd> <dt><em>Merging from trunk</em></dt> <dd><p>Be aware of where you are (see first definition).</p> <p>Ensure that you have clean checkout (see second definition). It is <em>required</em>.</p> <p>In most situations you want to import the latest commit of branch <i class="term">trunk</i> (or other origin). To get it use</p> <pre class="doctools_example"> fossil pull </pre> <p>With that done we can now import this commit into our current branch with</p> <pre class="doctools_example"> fossil merge trunk </pre> <p>Even if <b class="syscmd">fossil</b> does not report any conflicts it is a good idea to check that the operation has not broken the new and/or changed functionality we are working on.</p> <p>With the establishment of a good merge we then save the state with</p> <pre class="doctools_example"> fossil commit ... </pre> <p>before continuing development.</p></dd> </dl> </div> <div id="subsection7" class="doctools_subsection"><h3><a name="subsection7">Version numbers</a></h3> <p>In Tcllib all changes to a package have to come with an increment of its version number. What part is incremented (patchlevel, minor, major version) depends on the kind of change made. With multiple changes in a commit the highest "wins".</p> <p>When working in a development branch the version change can be deferred until it is time to merge, and then has to cover all the changes in the branch.</p> <p>Below a list of the kinds of changes and their associated version increments:</p> <dl class="doctools_definitions"> <dt><i class="term">D - documentation</i></dt> <dd><p>No increment</p></dd> <dt><i class="term">T - testsuite</i></dt> <dd><p>No increment</p></dd> <dt><i class="term">B - bugfix</i></dt> <dd><p>Patchlevel</p></dd> <dt><i class="term">I - implementation tweak</i></dt> <dd><p>Patchlevel</p></dd> <dt><i class="term">P - performance tweak</i></dt> <dd><p>Patchlevel</p></dd> <dt><i class="term">E - backward-compatible extension</i></dt> <dd><p>Minor</p></dd> <dt><i class="term">API - incompatible change</i></dt> <dd><p>Major</p></dd> </dl> <p>Note that a commit containing a version increment has to mention the new version number in its commit message, as well as the kind of change which caused it.</p> <p>Note further that the version number of a package currently exists in three places. An increment has to update all of them:</p> <ol class="doctools_enumerated"> <li><p>The package implementation.</p></li> <li><p>The package index ("<b class="file">pkgIndex.tcl</b>")</p></li> <li><p>The package documentation.</p></li> </ol> <p>The "<b class="file">sak.tcl</b>" command <b class="cmd">validate version</b> helps finding discrepancies between the first two. All the other <b class="cmd">validate</b> methods are also of interest to any developer. Invoke it with</p> <pre class="doctools_example"> sak.tcl help validate </pre> <p>to see their documentation.</p> </div> </div> <div id="section4" class="doctools_section"><h2><a name="section4">Structural Overview</a></h2> <div id="subsection8" class="doctools_subsection"><h3><a name="subsection8">Main Directories</a></h3> <p>The main directories in the Tcllib toplevel directory and of interest to a developer are:</p> <dl class="doctools_definitions"> <dt>"<b class="file">modules</b>"</dt> <dd><p>Each child directory represents one or more packages. In the case of the latter the packages are usually related in some way. Examples are "<b class="file">base64</b>", "<b class="file">math</b>", and "<b class="file">struct</b>", with loose (base64) to strong (math) relations between the packages in the directory.</p></dd> <dt>"<b class="file">apps</b>"</dt> <dd><p>This directory contains all the installable applications, with their documentation. Note that this directory is currently <em>not</em> split into sub-directories.</p></dd> <dt>"<b class="file">examples</b>"</dt> <dd><p>Each child directory "<b class="file">foo</b>" contains one or more example application for the packages in "<b class="file">modules/foo</b>". These examples are generally not polished enough to be considered for installation.</p></dd> </dl> </div> <div id="subsection9" class="doctools_subsection"><h3><a name="subsection9">More Directories</a></h3> <dl class="doctools_definitions"> <dt>"<b class="file">config</b>"</dt> <dd><p>This directory contains files supporting the Unix build system, i.e. "<b class="file">configure</b>" and "<b class="file">Makefile.in</b>".</p></dd> <dt>"<b class="file">devdoc</b>"</dt> <dd><p>This directories contains the doctools sources for the global documentation, like this document and its sibling guides.</p></dd> <dt>"<b class="file">embedded</b>"</dt> <dd><p>This directory contains the entire documentation formatted for <i class="term"><a href="../../../index.html#html">HTML</a></i> and styled to properly mix into the web site generated by fossil for the repository.</p> <p>This is the documentation accessible from the Tcllib home directory, represented in the repository as "<b class="file">embedded/index.md</b>".</p></dd> <dt>"<b class="file">idoc</b>"</dt> <dd><p>This directory contains the entire documentation formatted for <i class="term"><a href="../../../index.html#nroff">nroff</a></i> and <i class="term"><a href="../../../index.html#html">HTML</a></i>, the latter without any styling. This is the documentation which will be installed.</p></dd> <dt>"<b class="file">support</b>"</dt> <dd><p>This directory contains the sources of internal packages and utilities used in the implementation of the "<b class="file">installer.tcl</b>" and "<b class="file">sak.tcl</b>" scripts/tools.</p></dd> </dl> </div> <div id="subsection10" class="doctools_subsection"><h3><a name="subsection10">Top Files</a></h3> <dl class="doctools_definitions"> <dt>"<b class="file">aclocal.m4</b>"</dt> <dd></dd> <dt>"<b class="file">configure</b>"</dt> <dd></dd> <dt>"<b class="file">configure.in</b>"</dt> <dd></dd> <dt>"<b class="file">Makefile.in</b>"</dt> <dd><p>These four files comprise the Unix build system layered on top of the "<b class="file">installer.tcl</b>" script.</p></dd> <dt>"<b class="file">installer.tcl</b>"</dt> <dd><p>The Tcl-based installation script/tool.</p></dd> <dt>"<b class="file">project.shed</b>"</dt> <dd><p>Configuration file for <i class="term">Sean Wood</i>'s <b class="syscmd"><a href="../modules/practcl/practcl.html">PracTcl</a></b> buildsystem.</p></dd> <dt>"<b class="file">sak.tcl</b>"</dt> <dd><p>This is the main tool for developers and release managers, the <i class="term">Swiss Army Knife</i> of management operations on the collection.</p></dd> <dt>"<b class="file">ChangeLog</b>"</dt> <dd><p>The log of changes to the global support, when the sources were held in <i class="term"><a href="../../../index.html#cvs">CVS</a></i>. Not relevant any longer with the switch to the <i class="term">fossil</i> SCM.</p></dd> <dt>"<b class="file">license.terms</b>"</dt> <dd><p>The license in plain ASCII. See also <i class="term"><a href="tcllib_license.html">Tcllib - License</a></i> for the nicely formatted form. The text is identical.</p></dd> <dt>"<b class="file">README.md</b>"</dt> <dd></dd> <dt>"<b class="file">.github/CONTRIBUTING.md</b>"</dt> <dd></dd> <dt>"<b class="file">.github/ISSUE_TEMPLATE.md</b>"</dt> <dd></dd> <dt>"<b class="file">.github/PULL_REQUEST_TEMPLATE.md</b>"</dt> <dd><p>These markdown-formatted documents are used and shown by the github mirror of these sources, pointing people back to the official location and issue trackers.</p></dd> <dt>"<b class="file">DESCRIPTION.txt</b>"</dt> <dd></dd> <dt>"<b class="file">STATUS</b>"</dt> <dd></dd> <dt>"<b class="file">tcllib.spec</b>"</dt> <dd></dd> <dt>"<b class="file">tcllib.tap</b>"</dt> <dd></dd> <dt>"<b class="file">tcllib.yml</b>"</dt> <dd><p>????</p></dd> </dl> </div> <div id="subsection11" class="doctools_subsection"><h3><a name="subsection11">File Types</a></h3> <p>The most common file types, by file extension, are:</p> <dl class="doctools_definitions"> <dt>"<b class="file">.tcl</b>"</dt> <dd><p>Tcl code for a package, application, or example.</p></dd> <dt>"<b class="file">.man</b>"</dt> <dd><p>Doctools-formatted documentation, usually for a package.</p></dd> <dt>"<b class="file">.test</b>"</dt> <dd><p>Test suite for a package, or part of. Based on <b class="package">tcltest</b>.</p></dd> <dt>"<b class="file">.bench</b>"</dt> <dd><p>Performance benchmarks for a package, or part of. Based on "<b class="file">modules/bench</b>".</p></dd> <dt>"<b class="file">.pcx</b>"</dt> <dd><p>Syntax rules for <i class="term">TclDevKit</i>'s <b class="syscmd">tclchecker</b>. Using these rules allows the checker to validate the use of commands of a Tcllib package <b class="package">foo</b> without having to scan the "<b class="file">.tcl</b>" files implementing it.</p></dd> </dl> </div> </div> <div id="section5" class="doctools_section"><h2><a name="section5">Testsuite Tooling</a></h2> <p>Testsuites in Tcllib are based on Tcl's standard test package <b class="package">tcltest</b>, plus utilities found in the directory "<b class="file">modules/devtools</b>"</p> <p>Tcllib developers invoke the suites through the <b class="cmd">test run</b> method of the "<b class="file">sak.tcl</b>" tool, with other methods of <b class="cmd"><a href="../../../index.html#test">test</a></b> providing management operations, for example setting a list of standard Tcl shells to use.</p> <div id="subsection12" class="doctools_subsection"><h3><a name="subsection12">Invoke the testsuites of a specific module</a></h3> <p>Invoke either</p> <pre class="doctools_example"> ./sak.tcl test run foo </pre> <p>or</p> <pre class="doctools_example"> ./sak.tcl test run modules/foo </pre> <p>to invoke the testsuites found in a specific module "<b class="file">foo</b>".</p> </div> <div id="subsection13" class="doctools_subsection"><h3><a name="subsection13">Invoke the testsuites of all modules</a></h3> <p>Invoke the tool without a module name, i.e.</p> <pre class="doctools_example"> ./sak.tcl test run </pre> <p>to invoke the testsuites of all modules.</p> </div> <div id="subsection14" class="doctools_subsection"><h3><a name="subsection14">Detailed Test Logs</a></h3> <p>In all the previous examples the test runner will write a combination of progress display and testsuite log to the standard output, showing for each module only the tests that passed or failed and how many of each in a summary at the end.</p> <p>To get a detailed log, it is necessary to invoke the test runner with additional options.</p> <p>For one:</p> <pre class="doctools_example"> ./sak.tcl test run --log LOG foo </pre> <p>While this shows the same short log on the terminal as before, it also writes a detailed log to the file "<b class="file">LOG.log</b>", and excerpts to other files ("<b class="file">LOG.summary</b>", "<b class="file">LOG.failures</b>", etc.).</p> <p>For two:</p> <pre class="doctools_example"> ./sak.tcl test run -v foo </pre> <p>This writes the detailed log to the standard output, instead of the short log.</p> <p>Regardless of form, the detailed log contains a list of all test cases executed, which failed, and how they failed (expected versus actual results).</p> </div> <div id="subsection15" class="doctools_subsection"><h3><a name="subsection15">Shell Selection</a></h3> <p>By default the test runner will use all the Tcl shells specified via <b class="cmd">test add</b> to invoke the specified testsuites, if any. If no such are specified it will fall back to the Tcl shell used to run the tool itself.</p> <p>Use option <b class="option">--shell</b> to explicitly specify the Tcl shell to use, like</p> <pre class="doctools_example"> ./sak.tcl test run --shell /path/to/tclsh ... </pre> </div> <div id="subsection16" class="doctools_subsection"><h3><a name="subsection16">Help</a></h3> <p>Invoke the tool as</p> <pre class="doctools_example"> ./sak.tcl help test </pre> <p>to see the detailed help for all methods of <b class="cmd"><a href="../../../index.html#test">test</a></b>, and the associated options.</p> </div> </div> <div id="section6" class="doctools_section"><h2><a name="section6">Documentation Tooling</a></h2> <p>The standard format used for documentation of packages and other things in Tcllib is <i class="term"><a href="../../../index.html#doctools">doctools</a></i>. Its supporting packages are a part of Tcllib, see the directories "<b class="file">modules/doctools</b>" and "<b class="file">modules/dtplite</b>". The latter is an application package, with the actual application "<b class="file">apps/dtplite</b>" a light wrapper around it.</p> <p>Tcllib developers gain access to these through the <b class="cmd">doc</b> method of the "<b class="file">sak.tcl</b>" tool, another (internal) wrapper around the "<b class="file">modules/dtplite</b>" application package.</p> <div id="subsection17" class="doctools_subsection"><h3><a name="subsection17">Generate documentation for a specific module</a></h3> <p>Invoke either</p> <pre class="doctools_example"> ./sak.tcl doc html foo </pre> <p>or</p> <pre class="doctools_example"> ./sak.tcl doc html modules/foo </pre> <p>to generate HTML for the documentation found in the module "<b class="file">foo</b>". Instead of <b class="const">html</b> any other supported format can be used here, of course.</p> <p>The generated formatted documentation will be placed into a directory "<b class="file">doc</b>" in the current working directory.</p> </div> <div id="subsection18" class="doctools_subsection"><h3><a name="subsection18">Generate documentation for all modules</a></h3> <p>Invoke the tool without a module name, i.e.</p> <pre class="doctools_example"> ./sak.tcl doc html </pre> <p>to generate HTML for the documentation found in all modules. Instead of <b class="const">html</b> any other supported format can be used here, of course.</p> <p>The generated formatted documentation will be placed into a directory "<b class="file">doc</b>" in the current working directory.</p> </div> <div id="subsection19" class="doctools_subsection"><h3><a name="subsection19">Available output formats, help</a></h3> <p>Invoke the tool as</p> <pre class="doctools_example"> ./sak.tcl help doc </pre> <p>to see the entire set of supported output formats which can be generated.</p> </div> <div id="subsection20" class="doctools_subsection"><h3><a name="subsection20">Validation without output</a></h3> <p>Note the special format <b class="const">validate</b>.</p> <p>Using this value as the name of the format to generate forces the tool to simply check that the documentation is syntactically correct, without generating actual output.</p> <p>Invoke it as either</p> <pre class="doctools_example"> ./sak.tcl doc validate (modules/)foo </pre> <p>or</p> <pre class="doctools_example"> ./sak.tcl doc validate </pre> <p>to either check the packages of a specific module or check all of them.</p> </div> </div> <div id="section7" class="doctools_section"><h2><a name="section7">Notes On Writing A Testsuite</a></h2> <p>While previous sections talked about running the testsuites for a module and the packages therein, this has no meaning if the module in question has no testsuites at all.</p> <p>This section gives a very basic overview on possible methodologies for writing tests and testsuites.</p> <p>First there are "drudgery" tests. Written to check absolutely basic assumptions which should never fail.</p> <p>For example for a command FOO taking two arguments, three tests calling it with zero, one, and three arguments. The basic checks that the command fails if it has not enough arguments, or too many.</p> <p>After that come the tests checking things based on our knowledge of the command, about its properties and assumptions. Some examples based on the graph operations added during Google's Summer of Code 2009 are:</p> <ul class="doctools_itemized"> <li><p>The BellmanFord command in struct::graph::ops takes a <i class="arg">startnode</i> as argument, and this node should be a node of the graph. This equals one test case checking the behavior when the specified node is not a node of the graph.</p> <p>This often gives rise to code in the implementation which explicitly checks the assumption and throws an understandable error, instead of letting the algorithm fail later in some weird non-deterministic way.</p> <p>It is not always possible to do such checks. The graph argument for example is just a command in itself, and while we expect it to exhibit a certain interface, i.e. a set of sub-commands aka methods, we cannot check that it has them, except by actually trying to use them. That is done by the algorithm anyway, so an explicit check is just overhead we can get by without.</p></li> <li><p>IIRC one of the distinguishing characteristic of either BellmanFord and/or Johnson is that they are able to handle negative weights. Whereas Dijkstra requires positive weights.</p> <p>This induces (at least) three testcases ... Graph with all positive weights, all negative, and a mix of positive and negative weights. Thinking further does the algorithm handle the weight <b class="const">0</b> as well ? Another test case, or several, if we mix zero with positive and negative weights.</p></li> <li><p>The two algorithms we are currently thinking about are about distances between nodes, and distance can be 'Inf'inity, i.e. nodes may not be connected. This means that good test cases are</p> <ol class="doctools_enumerated"> <li><p>Strongly connected graph</p></li> <li><p>Connected graph</p></li> <li><p>Disconnected graph.</p></li> </ol> <p>At the extremes of strongly connected and disconnected we have the fully connected graphs and graphs without edges, only nodes, i.e. completely disconnected.</p></li> <li><p>IIRC both of the algorithms take weighted arcs, and fill in a default if arcs are left unweighted in the input graph.</p> <p>This also induces three test cases:</p> <ol class="doctools_enumerated"> <li><p>Graph will all arcs with explicit weights.</p></li> <li><p>Graph without weights at all.</p></li> <li><p>Graph with mixture of weighted and unweighted graphs.</p></li> </ol> </li> </ul> <p>What was described above via examples is called <i class="term">black-box</i> testing. Test cases are designed and written based on the developer's knowledge of the properties of the algorithm and its inputs, without referencing a particular implementation.</p> <p>Going further, a complement to <i class="term">black-box</i> testing is <i class="term">white-box</i>. For this we know the implementation of the algorithm, we look at it and design our tests cases so that they force the code through all possible paths in the implementation. Wherever a decision is made we have a test case forcing a specific direction of the decision, for all possible combinations and directions. It is easy to get a combinatorial explosion in the number of needed test-cases.</p> <p>In practice I often hope that the black-box tests I have made are enough to cover all the paths, obviating the need for white-box tests.</p> <p>The above should be enough to make it clear that writing tests for an algorithm takes at least as much time as coding the algorithm, and often more time. Much more time. See for example also <a href="http://sqlite.org/testing.html">http://sqlite.org/testing.html</a>, a writeup on how the Sqlite database engine is tested. Another article of interest might be <a href="https://www.researchgate.net/publication/298896236">https://www.researchgate.net/publication/298896236</a>. While geared to a particular numerical algorithm it still shows that even a simple-looking algorithm can lead to an incredible number of test cases.</p> <p>An interesting connection is to documentation. In one direction, the properties checked with black-box testing are exactly the properties which should be documented in the algorithm's man page. And conversely, the documentation of the properties of an algorithm makes a good reference to base the black-box tests on.</p> <p>In practice test cases and documentation often get written together, cross-influencing each other. And the actual writing of test cases is a mix of black and white box, possibly influencing the implementation while writing the tests. Like writing a test for a condition like <i class="term">startnode not in input graph</i> serving as reminder to put a check for this condition into the code.</p> </div> <div id="section8" class="doctools_section"><h2><a name="section8">Installation Tooling</a></h2> <p>A last thing to consider when adding a new package to the collection is installation.</p> <p>How to <em>use</em> the "<b class="file">installer.tcl</b>" script is documented in <i class="term"><a href="tcllib_installer.html">Tcllib - The Installer's Guide</a></i>.</p> <p>Here we document how to extend said installer so that it may install new package(s) and/or application(s).</p> <p>In most cases only a single file has to be modified, the "<b class="file">support/installation/modules.tcl</b>" holding one command per module and application to install.</p> <p>The relevant commands are:</p> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd"><a href="../../../index.html#module">Module</a></b> <i class="arg">name</i> <i class="arg">code-action</i> <i class="arg">doc-action</i> <i class="arg">example-action</i></a></dt> <dd><p>Install the packages of module <i class="arg">name</i>, found in "<b class="file">modules/<i class="arg">name</i></b>".</p> <p>The <i class="arg">code-action</i> is responsible for installing the packages and their index. The system currently provides</p> <dl class="doctools_definitions"> <dt><b class="cmd">_tcl</b></dt> <dd><p>Copy all "<b class="file">.tcl</b>" files found in "<b class="file">modules/<i class="arg">name</i></b>" into the installation.</p></dd> <dt><b class="cmd">_tcr</b></dt> <dd><p>As <b class="cmd">_tcl</b>, copy the "<b class="file">.tcl</b>" files found in the subdirectories of "<b class="file">modules/<i class="arg">name</i></b>" as well.</p></dd> <dt><b class="cmd">_tci</b></dt> <dd><p>As <b class="cmd">_tcl</b>, and copy the "<b class="file">tclIndex.tcl</b>" file as well.</p></dd> <dt><b class="cmd">_msg</b></dt> <dd><p>As <b class="cmd">_tcl</b>, and copy the subdirectory "<b class="file">msgs</b>" as well.</p></dd> <dt><b class="cmd">_doc</b></dt> <dd><p>As <b class="cmd">_tcl</b>, and copy the subdirectory "<b class="file">mpformats</b>" as well.</p></dd> <dt><b class="cmd">_tex</b></dt> <dd><p>As <b class="cmd">_tcl</b>, and copy "<b class="file">.tex</b>" files as well.</p></dd> </dl> <p>The <i class="arg">doc-action</i> is responsible for installing the package documentation. The system currently provides</p> <dl class="doctools_definitions"> <dt><b class="cmd">_null</b></dt> <dd><p>No documentation available, do nothing.</p></dd> <dt><b class="cmd">_man</b></dt> <dd><p>Process the "<b class="file">.man</b>" files found in "<b class="file">modules/<i class="arg">name</i></b>" and install the results (nroff and/or HTML) in the proper location, as given to the installer.</p> <p>This is actually a fallback, normally the installer uses the pre-made formatted documentation found under "<b class="file">idoc</b>".</p></dd> </dl> <p>The <i class="arg">example-action</i> is responsible for installing the examples. The system currently provides</p> <dl class="doctools_definitions"> <dt><b class="cmd">_null</b></dt> <dd><p>No examples available, do nothing.</p></dd> <dt><b class="cmd">_exa</b></dt> <dd><p>Copy the the directory "<b class="file">examples/<i class="arg">name</i></b>" recursively to the install location for examples.</p></dd> </dl></dd> <dt><a name="2"><b class="cmd"><a href="../../../index.html#application">Application</a></b> <i class="arg">name</i></a></dt> <dd><p>Install the application with <i class="arg">name</i>, found in "<b class="file">apps</b>".</p></dd> <dt><a name="3"><b class="cmd">Exclude</b> <i class="arg">name</i></a></dt> <dd><p>This command signals to the installer which of the listed modules to <em>not</em> install. I.e. they name the deprecated modules of Tcllib.</p></dd> </dl> <p>If, and only if the above actions are not suitable for the new module then a second file has to be modified, "<b class="file">support/installation/actions.tcl</b>".</p> <p>This file contains the implementations of the available actions, and is the place where any custom action needed to handle the special circumstances of module has to be added.</p> </div> </div></body></html> |
Added idoc/www/tcllib/files/devdoc/tcllib_installer.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>tcllib_install_guide - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'tcllib_installer.man' by tcllib/doctools with format 'html' --> <!-- tcllib_install_guide.n --> <body><hr> [ <a href="../../../../../../../home">Tcllib Home</a> | <a href="../../../toc.html">Main Table Of Contents</a> | <a href="../../toc.html">Table Of Contents</a> | <a href="../../../index.html">Keyword Index</a> | <a href="../../../toc0.html">Categories</a> | <a href="../../../toc1.html">Modules</a> | <a href="../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcllib_install_guide(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcllib_install_guide - Tcllib - The Installer's Guide</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Requisites</a> <ul> <li class="doctools_subsection"><a href="#subsection1">Tcl</a></li> <li class="doctools_subsection"><a href="#subsection2">Critcl</a></li> </ul> </li> <li class="doctools_section"><a href="#section3">Build & Installation Instructions</a> <ul> <li class="doctools_subsection"><a href="#subsection3">Installing on Unix</a></li> <li class="doctools_subsection"><a href="#subsection4">Installing on Windows</a></li> <li class="doctools_subsection"><a href="#subsection5">Critcl & Accelerators</a></li> <li class="doctools_subsection"><a href="#subsection6">Tooling</a></ul> </li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a package itself. It is a collection of (semi-independent) <i class="term"><a href="../../../index.html#tcl">Tcl</a></i> packages that provide utility functions useful to a large collection of Tcl programmers.</p> <p>The audience of this document is anyone wishing to build and install the packages found in Tcllib, for either themselves, or others.</p> <p>For developers intending to work on the packages themselves we additionally provide</p> <ol class="doctools_enumerated"> <li><p><i class="term"><a href="tcllib_devguide.html">Tcllib - The Developer's Guide</a></i>.</p></li> </ol> <p>Please read <i class="term"><a href="tcllib_sources.html">Tcllib - How To Get The Sources</a></i> first, if that was not done already. Here we assume that the sources are already available in a directory of your choice.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Requisites</a></h2> <p>Before Tcllib can be build and used a number of requisites must be installed. These are:</p> <ol class="doctools_enumerated"> <li><p>The scripting language Tcl. For details see <span class="sectref"><a href="#subsection1">Tcl</a></span>.</p></li> <li><p>Optionally, the <b class="package">critcl</b> package (C embedding) for <b class="syscmd"><a href="../../../index.html#tcl">Tcl</a></b>. For details see <b class="sectref">CriTcl</b>.</p></li> </ol> <p>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.</p> <div id="subsection1" class="doctools_subsection"><h3><a name="subsection1">Tcl</a></h3> <p>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.</p> <p>Out of the many possibilities use whatever you are comfortable with, as long as it provides at the very least 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.</p> <p><em>Note</em> 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 <em>package not found</em> errors, as their package index files will not register them in versions of the core unable to use them.</p> <p>Myself, I used (and still use) <a href="http://www.activestate.com">ActiveState's</a> ActiveTcl 8.5 distribution during development, as I am most familiar with it.</p> <p><em>(Disclosure: I, Andreas Kupries, worked for ActiveState until 2016, maintaining ActiveTcl and TclDevKit for them).</em>. I am currently working for SUSE Software Canada ULC, although not in Tcl-related areas.</p> <p>This distribution can be found at <a href="http://www.activestate.com/activetcl">http://www.activestate.com/activetcl</a>. Retrieve the archive of ActiveTcl 8.5 (or higher) for your platform and install it as directed by ActiveState.</p> <p>For those wishing to build and install Tcl on their own, the relevant sources can be found at</p> <dl class="doctools_definitions"> <dt>Tcl</dt> <dd><p><a href="http://core.tcl-lang.org/tcl/">http://core.tcl-lang.org/tcl/</a></p></dd> </dl> <p>together with the necessary instructions on how to build it.</p> <p>If there are problems with building, installing, or using Tcl, please file a ticket against <i class="term"><a href="../../../index.html#tcl">Tcl</a></i>, or the vendor of your distribution, and <em>not</em> <i class="term"><a href="../../../index.html#tcllib">Tcllib</a></i>.</p> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Critcl</a></h3> <p>The <b class="syscmd">critcl</b> tool is an <em>optional</em> dependency.</p> <p>It is only required when trying to build the C-based <i class="term">accelerators</i> for a number of packages, as explained in <span class="sectref"><a href="#subsection5">Critcl & Accelerators</a></span></p> <p>Tcllib's build system looks for it in the , using the name <b class="syscmd">critcl</b>. This is for Unix. On Windows on the other hand the search is more complex. First we look for a proper application <b class="syscmd">critcl.exe</b>. When that is not found we look for a combination of interpreter (<b class="syscmd">tclkitsh.exe</b>, <b class="syscmd">tclsh.exe</b>) and starkit (<b class="syscmd">critcl.kit</b>, <b class="syscmd">critcl</b>) instead. <em>Note</em> that the choice of starkit can be overriden via the environment variable .</p> <p>Tcllib requires Critcl version 2 or higher.</p> <p>The github repository providing releases of version 2 and higher, and the associated sources, can be found at <a href="http://andreas-kupries.github.com/critcl">http://andreas-kupries.github.com/critcl</a>.</p> <p>Any branch of the repository can be used (if not using the prebuild starkit or starpack), although the use of the stable branch <em>master</em> is recommended.</p> <p>At the above url is also an explanation on how to build and install Critcl, including a list of its dependencies.</p> <p>Its instructions will not be repeated here. If there are problems with these directions please file a ticket against the <i class="term">Critcl</i> project, and not Tcllib.</p> </div> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Build & Installation Instructions</a></h2> <p>As Tcllib is mainly a bundle of packages written in pure Tcl building it is the same as installing it. The exceptions to this have their own subsection, <span class="sectref"><a href="#subsection5">Critcl & Accelerators</a></span>, later on.</p> <p>Before that however comes the standard case, differentiated by the platforms with material differences in the instruction, i.e. <i class="term">Unix</i>-like, versus <i class="term">Windows</i>.</p> <p>Regarding the latter it should also be noted that it is possible set up an <i class="term">Unix</i>-like environment using projects like <i class="term">MSYS</i>, <i class="term">Cygwin</i>, and others. In that case the user has the choice of which instructions to follow.</p> <p>Regardless of environment or platform, a suitable <i class="term"><a href="../../../index.html#tcl">Tcl</a></i> has to be installed, and its <b class="syscmd">tclsh</b> should be placed on the (<i class="term">Unix</i>) or associated with "<b class="file">.tcl</b>" files (<i class="term">Windows</i>).</p> <div id="subsection3" class="doctools_subsection"><h3><a name="subsection3">Installing on Unix</a></h3> <p>For <i class="term">Unix</i>-like environments Tcllib comes with the standard set of files to make</p> <pre class="doctools_example"> ./configure make install </pre> <p>a suitable way of installing it. This is a standard non-interactive install automatically figuring out where to place everything, i.e. packages, applications, and the manpages.</p> <p>To get a graphical installer invoke</p> <pre class="doctools_example"> ./installer.tcl </pre> <p>instead.</p> </div> <div id="subsection4" class="doctools_subsection"><h3><a name="subsection4">Installing on Windows</a></h3> <p>In a Windows environment we have the <b class="cmd">installer.tcl</b> script to perform installation.</p> <p>If the desired <b class="syscmd">tclsh</b> is associated "<b class="file">.tcl</b>" files then double-clicking / opening the <b class="cmd">installer.tcl</b> is enough to invoke it in graphical mode. This assumes that <i class="term"><a href="../../../index.html#tk">Tk</a></i> is installed and available as well.</p> <p>Without <i class="term"><a href="../../../index.html#tk">Tk</a></i> the only way to invoke the installer are to open a DOS window, i.e. <b class="syscmd">cmd.exe</b>, and then to invoke</p> <pre class="doctools_example"> ./installer.tcl </pre> <p>inside it.</p> </div> <div id="subsection5" class="doctools_subsection"><h3><a name="subsection5">Critcl & Accelerators</a></h3> <p>While the majority of Tcllib consists of packages written in pure Tcl a number of packages also have <i class="term">accelerators</i> associated with them. These are <b class="syscmd">critcl</b>-based C packages whose use will boost the performance of the packages using them. These accelerators are optional, and they are not installed by default.</p> <p>To build the accelerators the normally optional dependency on <b class="syscmd">critcl</b> becomes required.</p> <p>To build and install Tcllib with the accelerators in a Unix-like environment invoke:</p> <pre class="doctools_example"> ./configure make critcl # This builds the shared library holding # the accelerators make install </pre> <p>The underlying tool is "<b class="file">sak.tcl</b>" in the toplevel directory of Tcllib and the command <b class="cmd">make critcl</b> is just a wrapper around</p> <pre class="doctools_example"> ./sak.tcl critcl </pre> <p>Therefore in a Windows environment instead invoke</p> <pre class="doctools_example"> ./sak.tcl critcl ./installer.tcl </pre> <p>from within a DOS window, i.e. <b class="syscmd">cmd.exe</b>.</p> </div> <div id="subsection6" class="doctools_subsection"><h3><a name="subsection6">Tooling</a></h3> <p>The core of Tcllib's build system is the script "<b class="file">installer.tcl</b>" found in the toplevel directory of a checkout or release.</p> <p>The</p> <pre class="doctools_example"> configure ; make install </pre> <p>setup available to developers on Unix-like systems is just a wrapper around it. To go beyond the standard embodied in the wrapper it is necessary to directly invoke this script.</p> <p>On Windows system using it directly is the only way to invoke it.</p> <p>For basic help invoke it as</p> <pre class="doctools_example"> ./installer.tcl -help </pre> <p>This will print a short list of all the available options to the standard output channel.</p> <p>The commands associated with the various <i class="term">install</i> targets in the <i class="term">Makefile.in</i> for Unix can be used as additional examples on how to use this tool as well.</p> <p>The installer can operate in GUI and CLI modes. By default it chooses the mode automatically, based on if the Tcl package <b class="package"><a href="../../../index.html#tk">Tk</a></b> can be used or not. The option <b class="option">-no-gui</b> can be used to force CLI mode.</p> <p>Note that it is possible to specify options on the command line even if the installer ultimatively selects GUI mode. In that case the hardwired defaults and the options determine the data presented to the user for editing.</p> <p>The installer will select a number of defaults for the locations of packages, examples, and documentation, and also the format of the documentation. The user can overide these defaults in the GUI, or by specifying additional options. The defaults depend on the platform detected (Unix/Windows) and on the <b class="syscmd">tclsh</b> executable used to run the installer.</p> <p><em>Options</em></p> <dl class="doctools_options"> <dt><b class="option">-help</b></dt> <dd><p>Show the list of options explained here on the standard output channel and exit.</p></dd> <dt><b class="option">+excluded</b></dt> <dd><p>Include deprecated packages in the installation.</p></dd> <dt><b class="option">-no-gui</b></dt> <dd><p>Force command line operation of the installer</p></dd> <dt><b class="option">-no-wait</b></dt> <dd><p>In CLI mode the installer will by default ask the user to confirm that the chosen configuration (destination paths, things to install) is correct before performing any action. Using this option causes the installer to skip this query and immediately jump to installation.</p></dd> <dt><b class="option">-app-path</b> <i class="arg">path</i></dt> <dd></dd> <dt><b class="option">-example-path</b> <i class="arg">path</i></dt> <dd></dd> <dt><b class="option">-html-path</b> <i class="arg">path</i></dt> <dd></dd> <dt><b class="option">-nroff-path</b> <i class="arg">path</i></dt> <dd></dd> <dt><b class="option">-pkg-path</b> <i class="arg">path</i></dt> <dd><p>Declare the destination paths for the applications, examples, html documentation, nroff manpages, and packages. The defaults are derived from the location of the <b class="syscmd">tclsh</b> used to run the installer.</p></dd> <dt><b class="option">-dry-run</b></dt> <dd></dd> <dt><b class="option">-simulate</b></dt> <dd><p>Run the installer without modifying the destination directories.</p></dd> <dt><b class="option">-apps</b></dt> <dd></dd> <dt><b class="option">-no-apps</b></dt> <dd></dd> <dt><b class="option">-examples</b></dt> <dd></dd> <dt><b class="option">-no-examples</b></dt> <dd></dd> <dt><b class="option">-pkgs</b></dt> <dd></dd> <dt><b class="option">-no-pkgs</b></dt> <dd></dd> <dt><b class="option">-html</b></dt> <dd></dd> <dt><b class="option">-no-html</b></dt> <dd></dd> <dt><b class="option">-nroff</b></dt> <dd></dd> <dt><b class="option">-no-nroff</b></dt> <dd><p>(De)activate the installation of applications, examples, packages, html documentation, and nroff manpages.</p> <p>Applications, examples, and packages are installed by default.</p> <p>On Windows the html documentation is installed by default.</p> <p>On Unix the nroff manpages are installed by default.</p></dd> </dl> </div> </div> </div></body></html> |
Added idoc/www/tcllib/files/devdoc/tcllib_license.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>tcllib_license - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'tcllib_license.man' by tcllib/doctools with format 'html' --> <!-- tcllib_license.n --> <body><hr> [ <a href="../../../../../../../home">Tcllib Home</a> | <a href="../../../toc.html">Main Table Of Contents</a> | <a href="../../toc.html">Table Of Contents</a> | <a href="../../../index.html">Keyword Index</a> | <a href="../../../toc0.html">Categories</a> | <a href="../../../toc1.html">Modules</a> | <a href="../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcllib_license(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcllib_license - Tcllib - License</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">License</a></li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a package itself. It is a collection of (semi-independent) <i class="term"><a href="../../../index.html#tcl">Tcl</a></i> packages that provide utility functions useful to a large collection of Tcl programmers.</p> <p>The collection is under the BSD license.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">License</a></h2> <p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> </div> </div></body></html> |
Added idoc/www/tcllib/files/devdoc/tcllib_releasemgr.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>tcllib_releasemgr - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'tcllib_releasemgr.man' by tcllib/doctools with format 'html' --> <!-- tcllib_releasemgr.n --> <body><hr> [ <a href="../../../../../../../home">Tcllib Home</a> | <a href="../../../toc.html">Main Table Of Contents</a> | <a href="../../toc.html">Table Of Contents</a> | <a href="../../../index.html">Keyword Index</a> | <a href="../../../toc0.html">Categories</a> | <a href="../../../toc1.html">Modules</a> | <a href="../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcllib_releasemgr(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcllib_releasemgr - Tcllib - The Release Manager's Guide</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Tools</a></li> <li class="doctools_section"><a href="#section3">Tasks</a> <ul> <li class="doctools_subsection"><a href="#subsection1">Start a release candidate</a></li> <li class="doctools_subsection"><a href="#subsection2">Ready the candidate</a></li> <li class="doctools_subsection"><a href="#subsection3">Make it official</a></li> <li class="doctools_subsection"><a href="#subsection4">Distribute the release</a></ul> </li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a package itself. It is a collection of (semi-independent) <i class="term"><a href="../../../index.html#tcl">Tcl</a></i> packages that provide utility functions useful to a large collection of Tcl programmers.</p> <p>The audience of this document is the release manager for Tcllib, their deputies, and anybody else interested in the task of creating an official release of Tcllib for distribution.</p> <p>Please read <i class="term"><a href="tcllib_sources.html">Tcllib - How To Get The Sources</a></i> first, if that was not done already. Here we assume that the sources are already available in a directory of your choice.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Tools</a></h2> <p>The "<b class="file">sak.tcl</b>" script in the toplevel directory of a Tcllib checkout is the one tool used by the release manager to perform its <span class="sectref"><a href="#section3">Tasks</a></span>.</p> <p>The main commands to be used are</p> <pre class="doctools_example"> sak.tcl validate sak.tcl test run sak.tcl review sak.tcl readme sak.tcl localdoc sak.tcl release </pre> <p>More detail will be provided in the explanations of the various <span class="sectref"><a href="#section3">Tasks</a></span>.</p> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Tasks</a></h2> <div id="subsection1" class="doctools_subsection"><h3><a name="subsection1">Start a release candidate</a></h3> <p>todo: open a candidate for release</p> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Ready the candidate</a></h3> <p>todo: test, validate and check that the candidate is worthy of release fix testsuites, possibly fix packages, documentation regenerate docs coordinate with package maintainers wrt fixes big thing: going over the packages, classify changes since last release to generate a nice readme.</p> </div> <div id="subsection3" class="doctools_subsection"><h3><a name="subsection3">Make it official</a></h3> <p>todo: finalize release, make candidate official</p> </div> <div id="subsection4" class="doctools_subsection"><h3><a name="subsection4">Distribute the release</a></h3> <p>With the release made it has to be published and the world notified of its existence.</p> <ol class="doctools_enumerated"> <li><p>Create a proper fossil event for the release, via <a href="http://core.tcl-lang.org/tcllib/eventedit">http://core.tcl-lang.org/tcllib/eventedit</a>.</p> <p>An <a href="http://core.tcl-lang.org/tcllib/event/dac0ddcd2e990234143196b4dc438fe01e7b9817">existing event</a> should be used as template.</p></li> <li><p>Update a number of web locations:</p> <ol class="doctools_enumerated"> <li><p><a href="http://core.tcl-lang.org/tcllib/doc/trunk/embedded/index.md">Home page</a></p></li> <li><p><a href="http://core.tcl-lang.org/tcllib/wiki?name=Downloads">Downloads</a></p></li> <li><p><a href="http://core.tcl-lang.org/tcllib/wiki?name=Past+Releases">Past Releases</a></p></li> <li><p><a href="http://www.tcl-lang.org/home/release.txt">http://www.tcl-lang.org/home/release.txt</a></p></li> <li><p><a href="http://www.tcl-lang.org/software/tcllib/*.tml">http://www.tcl-lang.org/software/tcllib/*.tml</a></p></li> <li><p><a href="http://wiki.tcl-lang.org/page/Tcllib">http://wiki.tcl-lang.org/page/Tcllib</a></p></li> </ol> <p>The first location maps to the file "<b class="file">embedded/index.md</b>" in the repository itself, as such it can edited as part of the release process. This is where reference to the new fossil event is added, as the new current release.</p> <p>The next two locations are in the fossil tcllib wiki and require admin or wiki write permissions for <a href="http://core.tcl-lang.org/tcllib">http://core.tcl-lang.org/tcllib</a>.</p> <p>The last two locations require ssh access to <a href="http://www.tcl-lang.org">http://www.tcl-lang.org</a> and permission to edit files in the web area.</p></li> <li><p>***TODO*** mailing lists and other places to send notes to.</p></li> </ol> </div> </div> </div></body></html> |
Added idoc/www/tcllib/files/devdoc/tcllib_sources.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>tcllib_sources - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'tcllib_sources.man' by tcllib/doctools with format 'html' --> <!-- tcllib_sources.n --> <body><hr> [ <a href="../../../../../../../home">Tcllib Home</a> | <a href="../../../toc.html">Main Table Of Contents</a> | <a href="../../toc.html">Table Of Contents</a> | <a href="../../../index.html">Keyword Index</a> | <a href="../../../toc0.html">Categories</a> | <a href="../../../toc1.html">Modules</a> | <a href="../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcllib_sources(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcllib_sources - Tcllib - How To Get The Sources</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Source Location</a></li> <li class="doctools_section"><a href="#section3">Retrieval</a></li> <li class="doctools_section"><a href="#section4">Source Code Management</a></li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Welcome to Tcllib, the Tcl Standard Library. Note that Tcllib is not a package itself. It is a collection of (semi-independent) <i class="term"><a href="../../../index.html#tcl">Tcl</a></i> packages that provide utility functions useful to a large collection of Tcl programmers.</p> <p>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.</p> <p>For builders and developers we additionally provide</p> <ol class="doctools_enumerated"> <li><p><i class="term"><a href="tcllib_installer.html">Tcllib - The Installer's Guide</a></i>.</p></li> <li><p><i class="term"><a href="tcllib_devguide.html">Tcllib - The Developer's Guide</a></i>.</p></li> </ol> <p>respectively.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Source Location</a></h2> <p>The official repository for Tcllib can be found at <a href="http://core.tcl-lang.org/tcllib">http://core.tcl-lang.org/tcllib</a></p> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Retrieval</a></h2> <p>Assuming that you simply wish to look at the sources, or build a specific revision, the easiest way of retrieving it is to:</p> <ol class="doctools_enumerated"> <li><p>Log into this site, as "anonymous", using the semi-random password in the captcha.</p></li> <li><p>Go to the "Timeline".</p></li> <li><p>Choose the revision you wish to have.</p></li> <li><p>Follow its link to its detailed information page.</p></li> <li><p>On that page, choose either the "ZIP" or "Tarball" link to get a copy of this revision in the format of your choice.</p></li> </ol> </div> <div id="section4" class="doctools_section"><h2><a name="section4">Source Code Management</a></h2> <p>For the curious (or a developer-to-be), the sources are managed by the <a href="http://www.fossil-scm.org">Fossil SCM</a>. Binaries for popular platforms can be found directly at its <a href="http://www.fossil-scm.org/download.html">download page</a>.</p> <p>With that tool available the full history can be retrieved via:</p> <pre class="doctools_example"> fossil clone http://core.tcl-lang.org/tcllib tcllib.fossil </pre> <p>followed by</p> <pre class="doctools_example"> mkdir tcllib cd tcllib fossil open ../tcllib.fossil </pre> <p>to get a checkout of the head of the trunk.</p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/dicttool/dicttool.html.
︙ | ︙ | |||
122 123 124 125 126 127 128 129 130 131 132 133 134 135 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">ladd</b> <i class="arg">varname</i> <i class="arg">args</i></a></li> <li><a href="#2"><b class="cmd">ldelete</b> <i class="arg">varname</i> <i class="arg">args</i></a></li> <li><a href="#3"><b class="cmd">dict getnull</b> <i class="arg">args</i></a></li> <li><a href="#4"><b class="cmd">dict print</b> <i class="arg">dict</i></a></li> <li><a href="#5"><b class="cmd">dict is_dict</b> <i class="arg">value</i></a></li> | > | 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">dicttool <span class="opt">?1.0?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">ladd</b> <i class="arg">varname</i> <i class="arg">args</i></a></li> <li><a href="#2"><b class="cmd">ldelete</b> <i class="arg">varname</i> <i class="arg">args</i></a></li> <li><a href="#3"><b class="cmd">dict getnull</b> <i class="arg">args</i></a></li> <li><a href="#4"><b class="cmd">dict print</b> <i class="arg">dict</i></a></li> <li><a href="#5"><b class="cmd">dict is_dict</b> <i class="arg">value</i></a></li> |
︙ | ︙ | |||
143 144 145 146 147 148 149 | Each command checks to see if a command already exists of the same name before adding itself, just in case any of these slip into the core.</p> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd">ladd</b> <i class="arg">varname</i> <i class="arg">args</i></a></dt> <dd><p>This command will add a new instance of each element in <i class="arg">args</i> to <i class="arg">varname</i>, but only if that element is not already present.</p></dd> <dt><a name="2"><b class="cmd">ldelete</b> <i class="arg">varname</i> <i class="arg">args</i></a></dt> | | | 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | Each command checks to see if a command already exists of the same name before adding itself, just in case any of these slip into the core.</p> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd">ladd</b> <i class="arg">varname</i> <i class="arg">args</i></a></dt> <dd><p>This command will add a new instance of each element in <i class="arg">args</i> to <i class="arg">varname</i>, but only if that element is not already present.</p></dd> <dt><a name="2"><b class="cmd">ldelete</b> <i class="arg">varname</i> <i class="arg">args</i></a></dt> <dd><p>This command will delete all instances of each element in <i class="arg">args</i> from <i class="arg">varname</i>.</p></dd> <dt><a name="3"><b class="cmd">dict getnull</b> <i class="arg">args</i></a></dt> <dd><p>Operates like <b class="cmd">dict get</b>, however if the key <i class="arg">args</i> does not exist, it returns an empty list instead of throwing an error.</p></dd> <dt><a name="4"><b class="cmd">dict print</b> <i class="arg">dict</i></a></dt> <dd><p>This command will produce a string representation of <i class="arg">dict</i>, with each nested branch on a newline, and indented with two spaces for every level.</p></dd> <dt><a name="5"><b class="cmd">dict is_dict</b> <i class="arg">value</i></a></dt> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/doctools/docidx_lang_intro.html.
︙ | ︙ | |||
146 147 148 149 150 151 152 | <b class="const">[</b> and <b class="const">]</b>. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc. I.e.</p> <pre class="doctools_example"> ... [key {markup language}] ... </pre> <pre class="doctools_example"> | | | 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | <b class="const">[</b> and <b class="const">]</b>. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc. I.e.</p> <pre class="doctools_example"> ... [key {markup language}] ... </pre> <pre class="doctools_example"> ... [manpage thefile \ {file description}] ... </pre> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Basic structure</a></h3> <p>The most simple document which can be written in docidx is</p> <pre class="doctools_example"> [index_begin GROUPTITLE TITLE] |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/doctools/doctoc_lang_intro.html.
︙ | ︙ | |||
148 149 150 151 152 153 154 | <b class="const">[</b> and <b class="const">]</b>. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc. I.e.</p> <pre class="doctools_example"> ... [division_start {Appendix 1}] ... </pre> <pre class="doctools_example"> | | | 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | <b class="const">[</b> and <b class="const">]</b>. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc. I.e.</p> <pre class="doctools_example"> ... [division_start {Appendix 1}] ... </pre> <pre class="doctools_example"> ... [item thefile \ label {file description}] ... </pre> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Basic structure</a></h3> <p>The most simple document which can be written in doctoc is</p> <pre class="doctools_example"> [toc_begin GROUPTITLE TITLE] |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/doctools/doctools.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools(n) 1.5.6 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools - doctools - Processing documents</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
133 134 135 136 137 138 139 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.2</b></li> | | | 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.2</b></li> <li>package require <b class="pkgname">doctools <span class="opt">?1.5.6?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::doctools::new</b> <i class="arg">objectName</i> <span class="opt">?<i class="arg">option value</i>...?</span></a></li> <li><a href="#2"><b class="cmd">::doctools::help</b></a></li> <li><a href="#3"><b class="cmd">::doctools::search</b> <i class="arg">path</i></a></li> <li><a href="#4"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> <li><a href="#5"><i class="arg">objectName</i> <b class="method">configure</b></a></li> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/doctools/doctools_lang_intro.html.
︙ | ︙ | |||
150 151 152 153 154 155 156 | <b class="const">[</b> and <b class="const">]</b>. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc. I.e.</p> <pre class="doctools_example"> ... [list_begin enumerated] ... </pre> <pre class="doctools_example"> | | | 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | <b class="const">[</b> and <b class="const">]</b>. Inside of these delimiters the usual rules for a Tcl command apply with regard to word quotation, nested commands, continuation lines, etc. I.e.</p> <pre class="doctools_example"> ... [list_begin enumerated] ... </pre> <pre class="doctools_example"> ... [call [cmd foo] \ [arg bar]] ... </pre> <pre class="doctools_example"> ... [term {complex concept}] ... </pre> <pre class="doctools_example"> ... [opt "[arg key] [arg value]"] ... |
︙ | ︙ | |||
176 177 178 179 180 181 182 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] | | | 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] </pre> <p>This also shows us that all doctools documents are split into two parts, the <i class="term">header</i> and the <i class="term">body</i>. Everything coming before [<b class="cmd">description</b>] belongs to the header, and everything coming after belongs to the body, with the whole document bracketed by the two <b class="cmd">manpage_*</b> commands. Before and after these opening and |
︙ | ︙ | |||
227 228 229 230 231 232 233 | </pre> <p>Remember that the whitespace is optional. The document</p> <pre class="doctools_example"> [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] | | | 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | </pre> <p>Remember that the whitespace is optional. The document</p> <pre class="doctools_example"> [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] </pre> <p>has the same meaning as the example before.</p> <p>On the other hand, if <i class="term">whitespace</i> is present it consists not only of any sequence of characters containing the space character, horizontal and vertical tabs, carriage return, and newline, but it may contain comment markup as well, in the form of the <b class="cmd"><a href="../../../../index.html#comment">comment</a></b> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/doctools2idx/export_docidx.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export::docidx.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::idx::export::docidx(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::idx::export::docidx - docidx export plugin</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
126 127 128 129 130 131 132 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.4</b></li> | | | 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">doctools::idx::export::docidx <span class="opt">?0.2.1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd"><a href="../../../../index.html#export">export</a></b> <i class="arg">serial</i> <i class="arg">configuration</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> |
︙ | ︙ | |||
300 301 302 303 304 305 306 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 300 301 302 303 304 305 306 307 308 309 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_export.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'idx_export.man' by tcllib/doctools with format 'html' --> | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'idx_export.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::idx::export(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::idx::export - Exporting keyword indices</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
131 132 133 134 135 136 137 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> | | | | 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">doctools::idx::export <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">struct::map</b></li> <li>package require <b class="pkgname">doctools::idx::structure</b></li> <li>package require <b class="pkgname">snit</b></li> <li>package require <b class="pkgname">pluginmgr</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::doctools::idx::export</b> <i class="arg">objectName</i></a></li> <li><a href="#2"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> |
︙ | ︙ | |||
458 459 460 461 462 463 464 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#formatting">formatting</a>, <a href="../../../../index.html#generation">generation</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#keyword_index">keyword index</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#tcler_s_wiki">tcler's wiki</a>, <a href="../../../../index.html#text">text</a>, <a href="../../../../index.html#url">url</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 458 459 460 461 462 463 464 465 466 467 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#formatting">formatting</a>, <a href="../../../../index.html#generation">generation</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#keyword_index">keyword index</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#tcler_s_wiki">tcler's wiki</a>, <a href="../../../../index.html#text">text</a>, <a href="../../../../index.html#url">url</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_export_html.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export::html.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
362 363 364 365 366 367 368 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 362 363 364 365 366 367 368 369 370 371 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_export_json.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export::json.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
315 316 317 318 319 320 321 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 315 316 317 318 319 320 321 322 323 324 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_export_nroff.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export::nroff.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
269 270 271 272 273 274 275 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 269 270 271 272 273 274 275 276 277 278 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_export_text.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export::text.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
256 257 258 259 260 261 262 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#plain_text">plain text</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 256 257 258 259 260 261 262 263 264 265 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#plain_text">plain text</a>, <a href="../../../../index.html#serialization">serialization</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_export_wiki.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::export::wiki.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
269 270 271 272 273 274 275 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 269 270 271 272 273 274 275 276 277 278 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_import.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'idx_import.man' by tcllib/doctools with format 'html' --> | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'idx_import.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::import.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::idx::import(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::idx::import - Importing keyword indices</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
131 132 133 134 135 136 137 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> | | | | 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">doctools::idx::import <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">struct::map</b></li> <li>package require <b class="pkgname">doctools::idx::structure</b></li> <li>package require <b class="pkgname">snit</b></li> <li>package require <b class="pkgname">pluginmgr</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::doctools::idx::import</b> <i class="arg">objectName</i></a></li> <li><a href="#2"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> |
︙ | ︙ | |||
517 518 519 520 521 522 523 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#keyword_index">keyword index</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#parsing">parsing</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#url">url</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 517 518 519 520 521 522 523 524 525 526 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#index">index</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#keyword_index">keyword index</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#parsing">parsing</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#url">url</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_import_json.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::import::json.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::idx::import::json(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::idx::import::json - JSON import plugin</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">JSON notation of keyword indices</a></li> <li class="doctools_section"><a href="#section4">Keyword index serialization format</a></li> <li class="doctools_section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">doctools::idx::import::json <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">doctools::idx::structure</b></li> <li>package require <b class="pkgname">json</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd"><a href="../../../../index.html#import">import</a></b> <i class="arg">string</i> <i class="arg">configuration</i></a></li> </ul> </div> |
︙ | ︙ | |||
292 293 294 295 296 297 298 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#index">index</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 292 293 294 295 296 297 298 299 300 301 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#index">index</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2idx/idx_introduction.html.
︙ | ︙ | |||
206 207 208 209 210 211 212 | <pre class="doctools_example"> ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | | | | 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | <pre class="doctools_example"> ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct::map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::idx::export::<*> | | | doctools::idx::import::<*> docidx | | | docidx, json json | | | | \ html | | | doctools::idx::parse \ nroff | | | | \ wiki | | | +---------------+ json text | | | | | doctools::idx::structure | | +-------+---------------+ | | doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/doctools2idx/import_docidx.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::idx::import::docidx.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::idx::import::docidx(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::idx::import::docidx - docidx import plugin</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">[docidx] notation of keyword indices</a></li> <li class="doctools_section"><a href="#section4">Keyword index serialization format</a></li> <li class="doctools_section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">doctools::idx::import::docidx <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">doctools::idx::parse</b></li> <li>package require <b class="pkgname">doctools::idx::structure</b></li> <li>package require <b class="pkgname">doctools::msgcat</b></li> <li>package require <b class="pkgname">doctools::tcl::parse</b></li> <li>package require <b class="pkgname">fileutil</b></li> <li>package require <b class="pkgname">logger</b></li> <li>package require <b class="pkgname">snit</b></li> |
︙ | ︙ | |||
269 270 271 272 273 274 275 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#index">index</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 269 270 271 272 273 274 275 276 277 278 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#docidx">docidx</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#index">index</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/export_doctoc.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export::doctoc.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::toc::export::doctoc(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::toc::export::doctoc - doctoc export plugin</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
126 127 128 129 130 131 132 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.4</b></li> | | | 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">doctools::toc::export::doctoc <span class="opt">?0.2.1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd"><a href="../../../../index.html#export">export</a></b> <i class="arg">serial</i> <i class="arg">configuration</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> |
︙ | ︙ | |||
323 324 325 326 327 328 329 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 323 324 325 326 327 328 329 330 331 332 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/import_doctoc.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::import::doctoc.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::toc::import::doctoc(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::toc::import::doctoc - doctoc import plugin</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">[doctoc] notation of tables of contents</a></li> <li class="doctools_section"><a href="#section4">ToC serialization format</a></li> <li class="doctools_section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">doctools::toc::import::doctoc <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">doctools::toc::parse</b></li> <li>package require <b class="pkgname">doctools::toc::structure</b></li> <li>package require <b class="pkgname">doctools::msgcat</b></li> <li>package require <b class="pkgname">doctools::tcl::parse</b></li> <li>package require <b class="pkgname">fileutil</b></li> <li>package require <b class="pkgname">logger</b></li> <li>package require <b class="pkgname">snit</b></li> |
︙ | ︙ | |||
293 294 295 296 297 298 299 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 293 294 295 296 297 298 299 300 301 302 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_export.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'toc_export.man' by tcllib/doctools with format 'html' --> | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'toc_export.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::toc::export(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::toc::export - Exporting tables of contents</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
131 132 133 134 135 136 137 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> | | | | 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">doctools::toc::export <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">struct::map</b></li> <li>package require <b class="pkgname">doctools::toc::structure</b></li> <li>package require <b class="pkgname">snit</b></li> <li>package require <b class="pkgname">pluginmgr</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::doctools::toc::export</b> <i class="arg">objectName</i></a></li> <li><a href="#2"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> |
︙ | ︙ | |||
474 475 476 477 478 479 480 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#formatting">formatting</a>, <a href="../../../../index.html#generation">generation</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#table">table</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#tcler_s_wiki">tcler's wiki</a>, <a href="../../../../index.html#text">text</a>, <a href="../../../../index.html#url">url</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 474 475 476 477 478 479 480 481 482 483 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#formatting">formatting</a>, <a href="../../../../index.html#generation">generation</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#table">table</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#tcler_s_wiki">tcler's wiki</a>, <a href="../../../../index.html#text">text</a>, <a href="../../../../index.html#url">url</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_export_html.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export::html.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
356 357 358 359 360 361 362 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 356 357 358 359 360 361 362 363 364 365 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#html">HTML</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_export_json.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export::json.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
359 360 361 362 363 364 365 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 359 360 361 362 363 364 365 366 367 368 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_export_nroff.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export::nroff.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
293 294 295 296 297 298 299 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 293 294 295 296 297 298 299 300 301 302 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#nroff">nroff</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_export_text.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export::text.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
279 280 281 282 283 284 285 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#plain_text">plain text</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 279 280 281 282 283 284 285 286 287 288 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#plain_text">plain text</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_export_wiki.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::export::wiki.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> |
︙ | ︙ | |||
286 287 288 289 290 291 292 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 286 287 288 289 290 291 292 293 294 295 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#export">export</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a>, <a href="../../../../index.html#wiki">wiki</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_import.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'toc_import.man' by tcllib/doctools with format 'html' --> | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'toc_import.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::import.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::toc::import(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::toc::import - Importing keyword indices</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
131 132 133 134 135 136 137 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> | | | | 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">doctools::toc::import <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">struct::map</b></li> <li>package require <b class="pkgname">doctools::toc::structure</b></li> <li>package require <b class="pkgname">snit</b></li> <li>package require <b class="pkgname">pluginmgr</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::doctools::toc::import</b> <i class="arg">objectName</i></a></li> <li><a href="#2"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> |
︙ | ︙ | |||
535 536 537 538 539 540 541 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#parsing">parsing</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#table">table</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#url">url</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 535 536 537 538 539 540 541 542 543 544 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#conversion">conversion</a>, <a href="../../../../index.html#doctoc">doctoc</a>, <a href="../../../../index.html#documentation">documentation</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#json">json</a>, <a href="../../../../index.html#manpage">manpage</a>, <a href="../../../../index.html#markup">markup</a>, <a href="../../../../index.html#parsing">parsing</a>, <a href="../../../../index.html#plugin">plugin</a>, <a href="../../../../index.html#reference">reference</a>, <a href="../../../../index.html#table">table</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#url">url</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Documentation tools</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_import_json.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> | | | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'plugin.inc' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2009-2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- doctools::toc::import::json.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">doctools::toc::import::json(n) 0.2.1 tcllib "Documentation tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>doctools::toc::import::json - JSON import plugin</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">JSON notation of tables of contents</a></li> <li class="doctools_section"><a href="#section4">ToC serialization format</a></li> <li class="doctools_section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">doctools::toc::import::json <span class="opt">?0.2.1?</span></b></li> <li>package require <b class="pkgname">doctools::toc::structure</b></li> <li>package require <b class="pkgname">json</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd"><a href="../../../../index.html#import">import</a></b> <i class="arg">string</i> <i class="arg">configuration</i></a></li> </ul> </div> |
︙ | ︙ | |||
336 337 338 339 340 341 342 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 336 337 338 339 340 341 342 343 344 345 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#json">JSON</a>, <a href="../../../../index.html#deserialization">deserialization</a>, <a href="../../../../index.html#doctools">doctools</a>, <a href="../../../../index.html#import">import</a>, <a href="../../../../index.html#table_of_contents">table of contents</a>, <a href="../../../../index.html#toc">toc</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Text formatter plugin</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2009-2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/doctools2toc/toc_introduction.html.
︙ | ︙ | |||
206 207 208 209 210 211 212 | <pre class="doctools_example"> ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | | | | 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | <pre class="doctools_example"> ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct:map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::toc::export::<*> | | | doctools::toc::import::<*> doctoc | | | doctoc, json json | | | | \ html | | | doctools::toc::parse \ nroff | | | | \ wiki | | | +---------------+ json text | | | | | doctools::toc::structure | | +-------+---------------+ | | doctools::html doctools::html::cssdefaults doctools::tcl::parse doctools::msgcat |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/fileutil/multiop.html.
︙ | ︙ | |||
381 382 383 384 385 386 387 | <dd><p>Returns the current path type limiter.</p></dd> </dl> </div> <div id="section5" class="doctools_section"><h2><a name="section5">EXAMPLES</a></h2> <p>The following examples assume that the variable <b class="variable">F</b> contains a reference to a multi-file operation object.</p> <pre class="doctools_example"> | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | <dd><p>Returns the current path type limiter.</p></dd> </dl> </div> <div id="section5" class="doctools_section"><h2><a name="section5">EXAMPLES</a></h2> <p>The following examples assume that the variable <b class="variable">F</b> contains a reference to a multi-file operation object.</p> <pre class="doctools_example"> $F do copy \ the *.dll \ from c:/TDK/PrivateOpenSSL/bin \ to [installdir_of tls] </pre> <pre class="doctools_example"> $F do move \ the * \ from /sources \ into /scratch \ but not *.html # Alternatively use 'except for *.html'. </pre> <pre class="doctools_example"> $F do \ move \ the index \ from /sources \ into /scratch \ as pkgIndex.tcl </pre> <pre class="doctools_example"> $F do \ remove \ the *.txt \ in /scratch </pre> <p>Note that the fact that most commands just modify the object state allows us to use more off forms as specifications instead of just nearly-natural language sentences. For example the second example in this section can re-arranged into:</p> <pre class="doctools_example"> $F do \ from /sources \ into /scratch \ but not *.html \ move \ the * </pre> <p>and the result is not only still a valid specification, but even stays relatively readable.</p> <p>Further note that the information collected by the commands <b class="cmd">but</b>, <b class="cmd">except</b>, and <b class="cmd">as</b> is automatically reset after the associated <b class="cmd">the</b> was executed. However no other state is reset in that manner, allowing the user to avoid repetitions of unchanging information. For example the second and third examples of this section can be merged and rewritten into the equivalent:</p> <pre class="doctools_example"> $F do \ move \ the * \ from /sources \ into /scratch \ but not *.html not index \ the index \ as pkgIndex.tcl </pre> </div> <div id="section6" class="doctools_section"><h2><a name="section6">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category <em>fileutil</em> of the |
︙ | ︙ |
Added idoc/www/tcllib/files/modules/fileutil/paths.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>fileutil::paths - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'paths.man' by tcllib/doctools with format 'html' --> <!-- fileutil::paths.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">fileutil::paths(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>fileutil::paths - Manage search path pools</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">Bugs, Ideas, Feedback</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">fileutil::paths <span class="opt">?1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::fileutil::paths</b> <i class="arg">poolName</i></a></li> <li><a href="#2"><b class="cmd">poolName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> <li><a href="#3"><i class="arg">poolName</i> <b class="method">add</b> <i class="arg">path</i></a></li> <li><a href="#4"><i class="arg">poolName</i> <b class="method">clear</b></a></li> <li><a href="#5"><i class="arg">poolName</i> <b class="method">paths</b></a></li> <li><a href="#6"><i class="arg">poolName</i> <b class="method">remove</b> <i class="arg">path</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Provides a snit class whose instances manage a pool of (search) paths.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">API</a></h2> <p>The main command provides construction of search path pools:</p> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd">::fileutil::paths</b> <i class="arg">poolName</i></a></dt> <dd><p>Creates a new, empty pool of search paths with an associated global Tcl command whose name is <i class="arg">poolName</i>. It may be used to invoke various operations on the pool. It has the following general form:</p> <dl class="doctools_definitions"> <dt><a name="2"><b class="cmd">poolName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></dt> <dd><p><b class="method">method</b> and <i class="arg">arg</i>uments determine the exact behavior of the command.</p></dd> </dl> <p>If <i class="arg">poolName</i> is specified as <b class="const">%AUTO%</b> a unique name will be generated by the package itself. The result of the command is the fully-qualified name of the instance command.</p></dd> </dl> <p>The following commands are possible for pool objects:</p> <dl class="doctools_definitions"> <dt><a name="3"><i class="arg">poolName</i> <b class="method">add</b> <i class="arg">path</i></a></dt> <dd><p>Adds the <i class="arg">path</i> to the pool. Nothing is done if the <i class="arg">path</i> is already known to the pool. The result of the command is the empty string.</p></dd> <dt><a name="4"><i class="arg">poolName</i> <b class="method">clear</b></a></dt> <dd><p>Clears the entire pool. In other words, removes all paths from it. The result of the command is the empty string.</p></dd> <dt><a name="5"><i class="arg">poolName</i> <b class="method">paths</b></a></dt> <dd><p>Returns the list of all paths known to the pool, in the order they were added.</p></dd> <dt><a name="6"><i class="arg">poolName</i> <b class="method">remove</b> <i class="arg">path</i></a></dt> <dd><p>Removes the <i class="arg">path</i> from the pool, if it is known to the pool. Unknown paths are ignored without error. The result of the command is the empty string.</p></dd> </dl> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category <em>fileutil</em> of the <a href="http://core.tcl.tk/tcllib/reportlist">Tcllib Trackers</a>. Please also report any ideas for enhancements you may have for either package and/or documentation.</p> <p>When proposing code changes, please provide <em>unified diffs</em>, i.e the output of <b class="const">diff -u</b>.</p> <p>Note further that <em>attachments</em> are strongly preferred over inlined patches. Attachments can be made by going to the <b class="const">Edit</b> form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.</p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/grammar_fa/fa.html.
︙ | ︙ | |||
309 310 311 312 313 314 315 | in a very simple way :)</p> <pre class="doctools_example"> Drive -- yellow --> Brake -- red --> (Stop) -- red/yellow --> Attention -- green --> Drive (...) is the start state. </pre> <p>a possible serialization is</p> <pre class="doctools_example"> | | | | | | | 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | in a very simple way :)</p> <pre class="doctools_example"> Drive -- yellow --> Brake -- red --> (Stop) -- red/yellow --> Attention -- green --> Drive (...) is the start state. </pre> <p>a possible serialization is</p> <pre class="doctools_example"> grammar::fa \ {yellow red green red/yellow} \ {Drive {0 0 {yellow Brake}} \ Brake {0 0 {red Stop}} \ Stop {1 0 {red/yellow Attention}} \ Attention {0 0 {green Drive}}} </pre> <p>A possible one, because I did not care about creation order here</p></dd> <dt><a name="8"><i class="arg">faName</i> <b class="method">deserialize</b> <i class="arg">serialization</i></a></dt> <dd><p>This is the complement to <b class="method">serialize</b>. It replaces the automaton definition in <i class="arg">faName</i> with the automaton described by the <i class="arg">serialization</i> value. The old contents of <i class="arg">faName</i> are |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/grammar_peg/peg.html.
︙ | ︙ | |||
346 347 348 349 350 351 352 | MulOp <- '*' / '/' Factor <- Term (AddOp Term)* AddOp <- '+'/'-' Term <- Number </pre> <p>a possible serialization is</p> <pre class="doctools_example"> | | | | | | | | | | | | | | | | 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 | MulOp <- '*' / '/' Factor <- Term (AddOp Term)* AddOp <- '+'/'-' Term <- Number </pre> <p>a possible serialization is</p> <pre class="doctools_example"> grammar::peg \ {Expression {/ {x ( Expression )} {x Factor {* {x MulOp Factor}}}} \ Factor {x Term {* {x AddOp Term}}} \ Term Number \ MulOp {/ * /} \ AddOp {/ + -} \ Number {x {? Sign} {+ Digit}} \ Sign {/ + -} \ Digit {/ 0 1 2 3 4 5 6 7 8 9} \ } \ {Expression value Factor value \ Term value MulOp value \ AddOp value Number value \ Sign value Digit value \ } Expression </pre> <p>A possible one, because the order of the nonterminals in the dictionary is not relevant.</p></dd> <dt><a name="7"><i class="arg">pegName</i> <b class="method">deserialize</b> <i class="arg">serialization</i></a></dt> <dd><p>This is the complement to <b class="method">serialize</b>. It replaces the grammar |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/httpd/httpd.html.
1 | <!DOCTYPE html><html><head> | | | 1 2 3 4 5 6 7 8 9 | <!DOCTYPE html><html><head> <title>httpd - Tcl Web Server</title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; |
︙ | ︙ | |||
91 92 93 94 95 96 97 | } --></style> </head> <!-- Generated from file 'httpd.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2018 Sean Woods &lt;[email protected]&gt; --> | | | | | > | | | | | | | | | | > > | > | | | | > > > | | < | | < < < | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > > > > > | > > | | > > > > > | > | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > | > > > > > > > > > > > > > > | > > | < | | | < < < | | | < | < < < < < < < < < < < | | | | < < | > | | < > > | | | | < < | | < < < < < < < < < < < < < < < | | > | | | | | | | > | | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > | > > > | | | | | < < < < < < | | > > | | > > > > > > | | | | > > > | | < | < < < < > > | > | < | < > > > > > > | > > | < > > > > | < > > | > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > | > | | > > > > | > | > | | > | < | > > > | > | | > | > > > > > > | < > > > > > > > > | | > > > > > | | > > > > > > > > > > > > > > > > > > | < < > > > > > > | | > > > > | | | > | > > > > > > > > > | < < < > | | > > > > > > > > > > > | > > | > > > > > > | > > > > | > > > > > > > > > > > > > > | < | | < > > > > > > > > | | > > > > > > > | | > > > > > | > > | > > > | > > | > > | | | 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 | } --></style> </head> <!-- Generated from file 'httpd.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2018 Sean Woods &lt;[email protected]&gt; --> <!-- httpd.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">httpd(n) 4.3.3 tcllib "Tcl Web Server"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>httpd - A TclOO and coroutine based web server</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Minimal Example</a></li> <li class="doctools_section"><a href="#section3">Classes</a> <ul> <li class="doctools_subsection"><a href="#subsection1">Class httpd::mime</a></li> <li class="doctools_subsection"><a href="#subsection2">Class httpd::reply</a></li> <li class="doctools_subsection"><a href="#subsection3">Class httpd::server</a></li> <li class="doctools_subsection"><a href="#subsection4">Class httpd::server::dispatch</a></li> <li class="doctools_subsection"><a href="#subsection5">Class httpd::content.redirect</a></li> <li class="doctools_subsection"><a href="#subsection6">Class httpd::content.cache</a></li> <li class="doctools_subsection"><a href="#subsection7">Class httpd::content.template</a></li> <li class="doctools_subsection"><a href="#subsection8">Class httpd::content.file</a></li> <li class="doctools_subsection"><a href="#subsection9">Class httpd::content.exec</a></li> <li class="doctools_subsection"><a href="#subsection10">Class httpd::content.proxy</a></li> <li class="doctools_subsection"><a href="#subsection11">Class httpd::content.cgi</a></li> <li class="doctools_subsection"><a href="#subsection12">Class httpd::protocol.scgi</a></li> <li class="doctools_subsection"><a href="#subsection13">Class httpd::content.scgi</a></li> <li class="doctools_subsection"><a href="#subsection14">Class httpd::server.scgi</a></li> <li class="doctools_subsection"><a href="#subsection15">Class httpd::content.websocket</a></li> <li class="doctools_subsection"><a href="#subsection16">Class httpd::plugin</a></li> <li class="doctools_subsection"><a href="#subsection17">Class httpd::plugin.dict_dispatch</a></li> <li class="doctools_subsection"><a href="#subsection18">Class httpd::reply.memchan</a></li> <li class="doctools_subsection"><a href="#subsection19">Class httpd::plugin.local_memchan</a></li> </ul> </li> <li class="doctools_section"><a href="#section4">AUTHORS</a></li> <li class="doctools_section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.6</b></li> <li>package require <b class="pkgname">uuid</b></li> <li>package require <b class="pkgname">clay</b></li> <li>package require <b class="pkgname">coroutine</b></li> <li>package require <b class="pkgname">fileutil</b></li> <li>package require <b class="pkgname">fileutil::magic::filetype</b></li> <li>package require <b class="pkgname">websocket</b></li> <li>package require <b class="pkgname">mime</b></li> <li>package require <b class="pkgname">cron</b></li> <li>package require <b class="pkgname">uri</b></li> <li>package require <b class="pkgname">Markdown</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1">method <b class="cmd">ChannelCopy</b> <i class="arg">in</i> <i class="arg">out</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#2">method <b class="cmd">html_header</b> <span class="opt">?<i class="arg">title</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#3">method <b class="cmd">html_footer</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#4">method <b class="cmd">http_code_string</b> <i class="arg">code</i></a></li> <li><a href="#5">method <b class="cmd">HttpHeaders</b> <i class="arg">sock</i> <span class="opt">?<i class="arg">debug</i> <b class="const"></b>?</span></a></li> <li><a href="#6">method <b class="cmd">HttpHeaders_Default</b></a></li> <li><a href="#7">method <b class="cmd">HttpServerHeaders</b></a></li> <li><a href="#8">method <b class="cmd">MimeParse</b> <i class="arg">mimetext</i></a></li> <li><a href="#9">method <b class="cmd">Url_Decode</b> <i class="arg">data</i></a></li> <li><a href="#10">method <b class="cmd">Url_PathCheck</b> <i class="arg">urlsuffix</i></a></li> <li><a href="#11">method <b class="cmd">wait</b> <i class="arg">mode</i> <i class="arg">sock</i></a></li> <li><a href="#12">variable <b class="cmd">ChannelRegister</b></a></li> <li><a href="#13">variable <b class="cmd">reply</b></a></li> <li><a href="#14">variable <b class="cmd">request</b></a></li> <li><a href="#15">delegate <b class="cmd"><server></b></a></li> <li><a href="#16">method <b class="cmd">constructor</b> <i class="arg">ServerObj</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#17">method <b class="cmd">destructor</b> <span class="opt">?<i class="arg">dictargs</i>?</span></a></li> <li><a href="#18">method <b class="cmd">ChannelRegister</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#19">method <b class="cmd">close</b></a></li> <li><a href="#20">method <b class="cmd">Log_Dispatched</b></a></li> <li><a href="#21">method <b class="cmd">dispatch</b> <i class="arg">newsock</i> <i class="arg">datastate</i></a></li> <li><a href="#22">method <b class="cmd">Dispatch</b></a></li> <li><a href="#23">method <b class="cmd">html_header</b> <i class="arg">title</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#24">method <b class="cmd">html_footer</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#25">method <b class="cmd"><a href="../../../../index.html#error">error</a></b> <i class="arg">code</i> <span class="opt">?<i class="arg">msg</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">errorInfo</i> <b class="const"></b>?</span></a></li> <li><a href="#26">method <b class="cmd">content</b></a></li> <li><a href="#27">method <b class="cmd">EncodeStatus</b> <i class="arg">status</i></a></li> <li><a href="#28">method <b class="cmd"><a href="../log/log.html">log</a></b> <i class="arg">type</i> <span class="opt">?<i class="arg">info</i> <b class="const"></b>?</span></a></li> <li><a href="#29">method <b class="cmd">CoroName</b></a></li> <li><a href="#30">method <b class="cmd">DoOutput</b></a></li> <li><a href="#31">method <b class="cmd">FormData</b></a></li> <li><a href="#32">method <b class="cmd">PostData</b> <i class="arg">length</i></a></li> <li><a href="#33">method <b class="cmd">Session_Load</b></a></li> <li><a href="#34">method <b class="cmd">puts</b> <i class="arg">line</i></a></li> <li><a href="#35">method <b class="cmd">RequestFind</b> <i class="arg">field</i></a></li> <li><a href="#36">method <b class="cmd">request</b> <i class="arg">subcommand</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#37">method <b class="cmd">reply</b> <i class="arg">subcommand</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#38">method <b class="cmd">reset</b></a></li> <li><a href="#39">method <b class="cmd">timeOutCheck</b></a></li> <li><a href="#40">method <b class="cmd"><a href="../../../../index.html#timestamp">timestamp</a></b></a></li> <li><a href="#41">variable <b class="cmd">template</b></a></li> <li><a href="#42">variable <b class="cmd">url_patterns</b></a></li> <li><a href="#43">method <b class="cmd">constructor</b> <i class="arg">args</i> <span class="opt">?<i class="arg">port</i> <b class="const">auto</b>?</span> <span class="opt">?<i class="arg">myaddr</i> <b class="const">127.0.0.1</b>?</span> <span class="opt">?<i class="arg">string</i> <b class="const">auto</b>?</span> <span class="opt">?<i class="arg">name</i> <b class="const">auto</b>?</span> <span class="opt">?<i class="arg">doc_root</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">reverse_dns</i> <b class="const">0</b>?</span> <span class="opt">?<i class="arg">configuration_file</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">protocol</i> <b class="const">HTTP/1.1</b>?</span></a></li> <li><a href="#44">method <b class="cmd">destructor</b> <span class="opt">?<i class="arg">dictargs</i>?</span></a></li> <li><a href="#45">method <b class="cmd">connect</b> <i class="arg">sock</i> <i class="arg">ip</i> <i class="arg">port</i></a></li> <li><a href="#46">method <b class="cmd">ServerHeaders</b> <i class="arg">ip</i> <i class="arg">http_request</i> <i class="arg">mimetxt</i></a></li> <li><a href="#47">method <b class="cmd">Connect</b> <i class="arg">uuid</i> <i class="arg">sock</i> <i class="arg">ip</i></a></li> <li><a href="#48">method <b class="cmd"><a href="../counter/counter.html">counter</a></b> <i class="arg">which</i></a></li> <li><a href="#49">method <b class="cmd">CheckTimeout</b></a></li> <li><a href="#50">method <b class="cmd"><a href="../debug/debug.html">debug</a></b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#51">method <b class="cmd">dispatch</b> <i class="arg">data</i></a></li> <li><a href="#52">method <b class="cmd">Dispatch_Default</b> <i class="arg">reply</i></a></li> <li><a href="#53">method <b class="cmd">Dispatch_Local</b> <i class="arg">data</i></a></li> <li><a href="#54">method <b class="cmd">Headers_Local</b> <i class="arg">varname</i></a></li> <li><a href="#55">method <b class="cmd">Headers_Process</b> <i class="arg">varname</i></a></li> <li><a href="#56">method <b class="cmd">HostName</b> <i class="arg">ipaddr</i></a></li> <li><a href="#57">method <b class="cmd"><a href="../log/log.html">log</a></b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#58">method <b class="cmd"><a href="../../../../index.html#plugin">plugin</a></b> <i class="arg">slot</i> <span class="opt">?<i class="arg">class</i> <b class="const"></b>?</span></a></li> <li><a href="#59">method <b class="cmd">port_listening</b></a></li> <li><a href="#60">method <b class="cmd">PrefixNormalize</b> <i class="arg">prefix</i></a></li> <li><a href="#61">method <b class="cmd"><a href="../../../../index.html#source">source</a></b> <i class="arg">filename</i></a></li> <li><a href="#62">method <b class="cmd">start</b></a></li> <li><a href="#63">method <b class="cmd">stop</b></a></li> <li><a href="#64">method <b class="cmd">SubObject {} db</b></a></li> <li><a href="#65">method <b class="cmd">SubObject {} default</b></a></li> <li><a href="#66">method <b class="cmd">template</b> <i class="arg">page</i></a></li> <li><a href="#67">method <b class="cmd">TemplateSearch</b> <i class="arg">page</i></a></li> <li><a href="#68">method <b class="cmd">Thread_start</b></a></li> <li><a href="#69">method <b class="cmd">Uuid_Generate</b></a></li> <li><a href="#70">method <b class="cmd">Validate_Connection</b> <i class="arg">sock</i> <i class="arg">ip</i></a></li> <li><a href="#71">method <b class="cmd">reset</b></a></li> <li><a href="#72">method <b class="cmd">content</b></a></li> <li><a href="#73">method <b class="cmd">Dispatch</b></a></li> <li><a href="#74">method <b class="cmd">content</b></a></li> <li><a href="#75">method <b class="cmd">FileName</b></a></li> <li><a href="#76">method <b class="cmd">DirectoryListing</b> <i class="arg">local_file</i></a></li> <li><a href="#77">method <b class="cmd">content</b></a></li> <li><a href="#78">method <b class="cmd">Dispatch</b></a></li> <li><a href="#79">variable <b class="cmd">exename</b></a></li> <li><a href="#80">method <b class="cmd">CgiExec</b> <i class="arg">execname</i> <i class="arg">script</i> <i class="arg">arglist</i></a></li> <li><a href="#81">method <b class="cmd">Cgi_Executable</b> <i class="arg">script</i></a></li> <li><a href="#82">method <b class="cmd">proxy_channel</b></a></li> <li><a href="#83">method <b class="cmd">proxy_path</b></a></li> <li><a href="#84">method <b class="cmd">ProxyRequest</b> <i class="arg">chana</i> <i class="arg">chanb</i></a></li> <li><a href="#85">method <b class="cmd">ProxyReply</b> <i class="arg">chana</i> <i class="arg">chanb</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#86">method <b class="cmd">Dispatch</b></a></li> <li><a href="#87">method <b class="cmd">FileName</b></a></li> <li><a href="#88">method <b class="cmd">proxy_channel</b></a></li> <li><a href="#89">method <b class="cmd">ProxyRequest</b> <i class="arg">chana</i> <i class="arg">chanb</i></a></li> <li><a href="#90">method <b class="cmd">ProxyReply</b> <i class="arg">chana</i> <i class="arg">chanb</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#91">method <b class="cmd">DirectoryListing</b> <i class="arg">local_file</i></a></li> <li><a href="#92">method <b class="cmd">EncodeStatus</b> <i class="arg">status</i></a></li> <li><a href="#93">method <b class="cmd">scgi_info</b></a></li> <li><a href="#94">method <b class="cmd">proxy_channel</b></a></li> <li><a href="#95">method <b class="cmd">ProxyRequest</b> <i class="arg">chana</i> <i class="arg">chanb</i></a></li> <li><a href="#96">method <b class="cmd">ProxyReply</b> <i class="arg">chana</i> <i class="arg">chanb</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#97">method <b class="cmd"><a href="../debug/debug.html">debug</a></b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#98">method <b class="cmd">Connect</b> <i class="arg">uuid</i> <i class="arg">sock</i> <i class="arg">ip</i></a></li> <li><a href="#99">method <b class="cmd">Dispatch_Dict</b> <i class="arg">data</i></a></li> <li><a href="#100">method <b class="cmd">uri {} add</b> <i class="arg">vhosts</i> <i class="arg">patterns</i> <i class="arg">info</i></a></li> <li><a href="#101">method <b class="cmd">uri {} direct</b> <i class="arg">vhosts</i> <i class="arg">patterns</i> <i class="arg">info</i> <i class="arg">body</i></a></li> <li><a href="#102">method <b class="cmd">output</b></a></li> <li><a href="#103">method <b class="cmd">DoOutput</b></a></li> <li><a href="#104">method <b class="cmd">close</b></a></li> <li><a href="#105">method <b class="cmd">local_memchan</b> <i class="arg">command</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#106">method <b class="cmd">Connect_Local</b> <i class="arg">uuid</i> <i class="arg">sock</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>This module implements a web server, suitable for embedding in an application. The server is object oriented, and contains all of the fundamentals needed for a full service website.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Minimal Example</a></h2> <p>Starting a web service requires starting a class of type <b class="cmd">httpd::server</b>, and providing that server with one or more URIs to service, and <b class="cmd">httpd::reply</b> derived classes to generate them.</p> <pre class="doctools_example"> oo::class create ::reply.hello { method content {} { my puts "<HTML><HEAD><TITLE>IRM Dispatch Server</TITLE></HEAD><BODY>" my puts "<h1>Hello World!</h1>" my puts </BODY></HTML> } } ::httpd::server create HTTPD port 8015 myaddr 127.0.0.1 doc_root ~/htdocs HTTPD plugin dispatch httpd::server::dispatch HTTPD uri add * /hello [list mixin reply.hello] </pre> <p>The bare module does have facilities to hose a files from a file system. Files that end in a .tml will be substituted in the style of Tclhttpd:</p> <pre class="doctools_example"> <!-- hello.tml --> [my html_header {Hello World!}] Your Server is running. <p> The time is now [clock format [clock seconds]] [my html_footer] </pre> <p>A complete example of an httpd server is in the /examples directory of Tcllib. It also show how to dispatch URIs to other processes via SCGI and HTTP proxies.</p> <pre class="doctools_example"> cd ~/tcl/sandbox/tcllib tclsh examples/httpd.tcl </pre> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Classes</a></h2> <div id="subsection1" class="doctools_subsection"><h3><a name="subsection1">Class httpd::mime</a></h3> <p>A metaclass for MIME handling behavior across a live socket</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="1">method <b class="cmd">ChannelCopy</b> <i class="arg">in</i> <i class="arg">out</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="2">method <b class="cmd">html_header</b> <span class="opt">?<i class="arg">title</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Returns a block of HTML</p></dd> <dt><a name="3">method <b class="cmd">html_footer</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="4">method <b class="cmd">http_code_string</b> <i class="arg">code</i></a></dt> <dd></dd> <dt><a name="5">method <b class="cmd">HttpHeaders</b> <i class="arg">sock</i> <span class="opt">?<i class="arg">debug</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="6">method <b class="cmd">HttpHeaders_Default</b></a></dt> <dd></dd> <dt><a name="7">method <b class="cmd">HttpServerHeaders</b></a></dt> <dd></dd> <dt><a name="8">method <b class="cmd">MimeParse</b> <i class="arg">mimetext</i></a></dt> <dd><p>Converts a block of mime encoded text to a key/value list. If an exception is encountered, the method will generate its own call to the <b class="cmd"><a href="../../../../index.html#error">error</a></b> method, and immediately invoke the <b class="cmd">output</b> method to produce an error code and close the connection.</p></dd> <dt><a name="9">method <b class="cmd">Url_Decode</b> <i class="arg">data</i></a></dt> <dd><p>De-httpizes a string.</p></dd> <dt><a name="10">method <b class="cmd">Url_PathCheck</b> <i class="arg">urlsuffix</i></a></dt> <dd></dd> <dt><a name="11">method <b class="cmd">wait</b> <i class="arg">mode</i> <i class="arg">sock</i></a></dt> <dd></dd> </dl> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Class httpd::reply</a></h3> <p><em>ancestors</em>: <b class="class">httpd::mime</b></p> <p>A class which shephards a request through the process of generating a reply. The socket associated with the reply is available at all times as the <i class="arg">chan</i> variable. The process of generating a reply begins with an <b class="cmd">httpd::server</b> generating a <b class="cmd">http::class</b> object, mixing in a set of behaviors and then invoking the reply object's <b class="cmd">dispatch</b> method. In normal operations the <b class="cmd">dispatch</b> method:</p> <ol class="doctools_enumerated"> <li><p>Invokes the <b class="cmd">reset</b> method for the object to populate default headers.</p></li> <li><p>Invokes the <b class="cmd">HttpHeaders</b> method to stream the MIME headers out of the socket</p></li> <li><p>Invokes the <b class="cmd">request parse</b> method to convert the stream of MIME headers into a dict that can be read via the <b class="cmd">request</b> method.</p></li> <li><p>Stores the raw stream of MIME headers in the <i class="arg">rawrequest</i> variable of the object.</p></li> <li><p>Invokes the <b class="cmd">content</b> method for the object, generating an call to the <b class="cmd"><a href="../../../../index.html#error">error</a></b> method if an exception is raised.</p></li> <li><p>Invokes the <b class="cmd">output</b> method for the object</p></li> </ol> <p>Developers have the option of streaming output to a buffer via the <b class="cmd">puts</b> method of the reply, or simply populating the <i class="arg">reply_body</i> variable of the object. The information returned by the <b class="cmd">content</b> method is not interpreted in any way. If an exception is thrown (via the <b class="cmd"><a href="../../../../index.html#error">error</a></b> command in Tcl, for example) the caller will auto-generate a 500 {Internal Error} message. A typical implementation of <b class="cmd">content</b> look like:</p> <pre class="doctools_example"> clay::define ::test::content.file { superclass ::httpd::content.file # Return a file # Note: this is using the content.file mixin which looks for the reply_file variable # and will auto-compute the Content-Type method content {} { my reset set doc_root [my request get DOCUMENT_ROOT] my variable reply_file set reply_file [file join $doc_root index.html] } } clay::define ::test::content.time { # return the current system time method content {} { my variable reply_body my reply set Content-Type text/plain set reply_body [clock seconds] } } clay::define ::test::content.echo { method content {} { my variable reply_body my reply set Content-Type [my request get CONTENT_TYPE] set reply_body [my PostData [my request get CONTENT_LENGTH]] } } clay::define ::test::content.form_handler { method content {} { set form [my FormData] my reply set Content-Type {text/html; charset=UTF-8} my puts [my html_header {My Dynamic Page}] my puts "<BODY>" my puts "You Sent<p>" my puts "<TABLE>" foreach {f v} $form { my puts "<TR><TH>$f</TH><TD><verbatim>$v</verbatim></TD>" } my puts "</TABLE><p>" my puts "Send some info:<p>" my puts "<FORM action=/[my request get REQUEST_PATH] method POST>" my puts "<TABLE>" foreach field {name rank serial_number} { set line "<TR><TH>$field</TH><TD><input name=\"$field\" " if {[dict exists $form $field]} { append line " value=\"[dict get $form $field]\""" } append line " /></TD></TR>" my puts $line } my puts "</TABLE>" my puts [my html footer] } } </pre> <p><b class="class">Variable</b></p> <dl class="doctools_definitions"> <dt><a name="12">variable <b class="cmd">ChannelRegister</b></a></dt> <dd></dd> <dt><a name="13">variable <b class="cmd">reply</b></a></dt> <dd><p>A dictionary which will converted into the MIME headers of the reply</p></dd> <dt><a name="14">variable <b class="cmd">request</b></a></dt> <dd><p>A dictionary containing the SCGI transformed HTTP headers for the request</p></dd> </dl> <p><b class="class">Delegate</b></p> <dl class="doctools_definitions"> <dt><a name="15">delegate <b class="cmd"><server></b></a></dt> <dd><p>The server object which spawned this reply</p></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="16">method <b class="cmd">constructor</b> <i class="arg">ServerObj</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="17">method <b class="cmd">destructor</b> <span class="opt">?<i class="arg">dictargs</i>?</span></a></dt> <dd><p>clean up on exit</p></dd> <dt><a name="18">method <b class="cmd">ChannelRegister</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Registers a channel to be closed by the close method</p></dd> <dt><a name="19">method <b class="cmd">close</b></a></dt> <dd><p>Close channels opened by this object</p></dd> <dt><a name="20">method <b class="cmd">Log_Dispatched</b></a></dt> <dd><p>Record a dispatch event</p></dd> <dt><a name="21">method <b class="cmd">dispatch</b> <i class="arg">newsock</i> <i class="arg">datastate</i></a></dt> <dd><p>Accept the handoff from the server object of the socket <em>newsock</em> and feed it the state <em>datastate</em>. Fields the <em>datastate</em> are looking for in particular are:</p> <p>* <b class="const">mixin</b> - A key/value list of slots and classes to be mixed into the object prior to invoking <b class="cmd">Dispatch</b>.</p> <p>* <b class="const">http</b> - A key/value list of values to populate the object's <em>request</em> ensemble</p> <p>All other fields are passed along to the <b class="method">clay</b> structure of the object.</p></dd> <dt><a name="22">method <b class="cmd">Dispatch</b></a></dt> <dd></dd> <dt><a name="23">method <b class="cmd">html_header</b> <i class="arg">title</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="24">method <b class="cmd">html_footer</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="25">method <b class="cmd"><a href="../../../../index.html#error">error</a></b> <i class="arg">code</i> <span class="opt">?<i class="arg">msg</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">errorInfo</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="26">method <b class="cmd">content</b></a></dt> <dd><p>REPLACE ME: This method is the "meat" of your application. It writes to the result buffer via the "puts" method and can tweak the headers via "clay put header_reply"</p></dd> <dt><a name="27">method <b class="cmd">EncodeStatus</b> <i class="arg">status</i></a></dt> <dd><p>Formulate a standard HTTP status header from he string provided.</p></dd> <dt><a name="28">method <b class="cmd"><a href="../log/log.html">log</a></b> <i class="arg">type</i> <span class="opt">?<i class="arg">info</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="29">method <b class="cmd">CoroName</b></a></dt> <dd></dd> <dt><a name="30">method <b class="cmd">DoOutput</b></a></dt> <dd><p>Generates the the HTTP reply, streams that reply back across <i class="arg">chan</i>, and destroys the object.</p></dd> <dt><a name="31">method <b class="cmd">FormData</b></a></dt> <dd><p>For GET requests, converts the QUERY_DATA header into a key/value list. For POST requests, reads the Post data and converts that information to a key/value list for application/x-www-form-urlencoded posts. For multipart posts, it composites all of the MIME headers of the post to a singular key/value list, and provides MIME_* information as computed by the <b class="cmd"><a href="../mime/mime.html">mime</a></b> package, including the MIME_TOKEN, which can be fed back into the mime package to read out the contents.</p></dd> <dt><a name="32">method <b class="cmd">PostData</b> <i class="arg">length</i></a></dt> <dd><p>Stream <i class="arg">length</i> bytes from the <i class="arg">chan</i> socket, but only of the request is a POST or PUSH. Returns an empty string otherwise.</p></dd> <dt><a name="33">method <b class="cmd">Session_Load</b></a></dt> <dd><p>Manage session data</p></dd> <dt><a name="34">method <b class="cmd">puts</b> <i class="arg">line</i></a></dt> <dd><p>Appends the value of <i class="arg">string</i> to the end of <i class="arg">reply_body</i>, as well as a trailing newline character.</p></dd> <dt><a name="35">method <b class="cmd">RequestFind</b> <i class="arg">field</i></a></dt> <dd></dd> <dt><a name="36">method <b class="cmd">request</b> <i class="arg">subcommand</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="37">method <b class="cmd">reply</b> <i class="arg">subcommand</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="38">method <b class="cmd">reset</b></a></dt> <dd><p>Clear the contents of the <i class="arg">reply_body</i> variable, and reset all headers in the <b class="cmd">reply</b> structure back to the defaults for this object.</p></dd> <dt><a name="39">method <b class="cmd">timeOutCheck</b></a></dt> <dd><p>Called from the <b class="cmd">http::server</b> object which spawned this reply. Checks to see if too much time has elapsed while waiting for data or generating a reply, and issues a timeout error to the request if it has, as well as destroy the object and close the <i class="arg">chan</i> socket.</p></dd> <dt><a name="40">method <b class="cmd"><a href="../../../../index.html#timestamp">timestamp</a></b></a></dt> <dd><p>Return the current system time in the format:</p> <pre class="doctools_example">%a, %d %b %Y %T %Z</pre> </dd> </dl> </div> <div id="subsection3" class="doctools_subsection"><h3><a name="subsection3">Class httpd::server</a></h3> <p><em>ancestors</em>: <b class="class">httpd::mime</b></p> <p><b class="class">Variable</b></p> <dl class="doctools_definitions"> <dt><a name="41">variable <b class="cmd">template</b></a></dt> <dd></dd> <dt><a name="42">variable <b class="cmd">url_patterns</b></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="43">method <b class="cmd">constructor</b> <i class="arg">args</i> <span class="opt">?<i class="arg">port</i> <b class="const">auto</b>?</span> <span class="opt">?<i class="arg">myaddr</i> <b class="const">127.0.0.1</b>?</span> <span class="opt">?<i class="arg">string</i> <b class="const">auto</b>?</span> <span class="opt">?<i class="arg">name</i> <b class="const">auto</b>?</span> <span class="opt">?<i class="arg">doc_root</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">reverse_dns</i> <b class="const">0</b>?</span> <span class="opt">?<i class="arg">configuration_file</i> <b class="const"></b>?</span> <span class="opt">?<i class="arg">protocol</i> <b class="const">HTTP/1.1</b>?</span></a></dt> <dd></dd> <dt><a name="44">method <b class="cmd">destructor</b> <span class="opt">?<i class="arg">dictargs</i>?</span></a></dt> <dd></dd> <dt><a name="45">method <b class="cmd">connect</b> <i class="arg">sock</i> <i class="arg">ip</i> <i class="arg">port</i></a></dt> <dd><p>Reply to an open socket. This method builds a coroutine to manage the remainder of the connection. The coroutine's operations are driven by the <b class="cmd">Connect</b> method.</p></dd> <dt><a name="46">method <b class="cmd">ServerHeaders</b> <i class="arg">ip</i> <i class="arg">http_request</i> <i class="arg">mimetxt</i></a></dt> <dd></dd> <dt><a name="47">method <b class="cmd">Connect</b> <i class="arg">uuid</i> <i class="arg">sock</i> <i class="arg">ip</i></a></dt> <dd><p>This method reads HTTP headers, and then consults the <b class="cmd">dispatch</b> method to determine if the request is valid, and/or what kind of reply to generate. Under normal cases, an object of class <b class="cmd">::http::reply</b> is created, and that class's <b class="cmd">dispatch</b> method. This action passes control of the socket to the reply object. The reply object manages the rest of the transaction, including closing the socket.</p></dd> <dt><a name="48">method <b class="cmd"><a href="../counter/counter.html">counter</a></b> <i class="arg">which</i></a></dt> <dd><p>Increment an internal counter.</p></dd> <dt><a name="49">method <b class="cmd">CheckTimeout</b></a></dt> <dd><p>Check open connections for a time out event.</p></dd> <dt><a name="50">method <b class="cmd"><a href="../debug/debug.html">debug</a></b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="51">method <b class="cmd">dispatch</b> <i class="arg">data</i></a></dt> <dd><p>Given a key/value list of information, return a data structure describing how the server should reply.</p></dd> <dt><a name="52">method <b class="cmd">Dispatch_Default</b> <i class="arg">reply</i></a></dt> <dd><p>Method dispatch method of last resort before returning a 404 NOT FOUND error. The default behavior is to look for a file in <em>DOCUMENT_ROOT</em> which matches the query.</p></dd> <dt><a name="53">method <b class="cmd">Dispatch_Local</b> <i class="arg">data</i></a></dt> <dd><p>Method dispatch method invoked prior to invoking methods implemented by plugins. If this method returns a non-empty dictionary, that structure will be passed to the reply. The default is an empty implementation.</p></dd> <dt><a name="54">method <b class="cmd">Headers_Local</b> <i class="arg">varname</i></a></dt> <dd><p>Introspect and possibly modify a data structure destined for a reply. This method is invoked before invoking Header methods implemented by plugins. The default implementation is empty.</p></dd> <dt><a name="55">method <b class="cmd">Headers_Process</b> <i class="arg">varname</i></a></dt> <dd><p>Introspect and possibly modify a data structure destined for a reply. This method is built dynamically by the <b class="cmd"><a href="../../../../index.html#plugin">plugin</a></b> method.</p></dd> <dt><a name="56">method <b class="cmd">HostName</b> <i class="arg">ipaddr</i></a></dt> <dd><p>Convert an ip address to a host name. If the server/ reverse_dns flag is false, this method simply returns the IP address back. Internally, this method uses the <em>dns</em> module from tcllib.</p></dd> <dt><a name="57">method <b class="cmd"><a href="../log/log.html">log</a></b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Log an event. The input for args is free form. This method is intended to be replaced by the user, and is a noop for a stock http::server object.</p></dd> <dt><a name="58">method <b class="cmd"><a href="../../../../index.html#plugin">plugin</a></b> <i class="arg">slot</i> <span class="opt">?<i class="arg">class</i> <b class="const"></b>?</span></a></dt> <dd><p>Incorporate behaviors from a plugin. This method dynamically rebuilds the <b class="cmd">Dispatch</b> and <b class="cmd">Headers</b> method. For every plugin, the server looks for the following entries in <em>clay plugin/</em>:</p> <p><em>load</em> - A script to invoke in the server's namespace during the <b class="cmd"><a href="../../../../index.html#plugin">plugin</a></b> method invokation.</p> <p><em>dispatch</em> - A script to stitch into the server's <b class="cmd">Dispatch</b> method.</p> <p><em>headers</em> - A script to stitch into the server's <b class="cmd">Headers</b> method.</p> <p><em>thread</em> - A script to stitch into the server's <b class="cmd">Thread_start</b> method.</p></dd> <dt><a name="59">method <b class="cmd">port_listening</b></a></dt> <dd><p>Return the actual port that httpd is listening on.</p></dd> <dt><a name="60">method <b class="cmd">PrefixNormalize</b> <i class="arg">prefix</i></a></dt> <dd><p>For the stock version, trim trailing /'s and *'s from a prefix. This method can be replaced by the end user to perform any other transformations needed for the application.</p></dd> <dt><a name="61">method <b class="cmd"><a href="../../../../index.html#source">source</a></b> <i class="arg">filename</i></a></dt> <dd></dd> <dt><a name="62">method <b class="cmd">start</b></a></dt> <dd><p>Open the socket listener.</p></dd> <dt><a name="63">method <b class="cmd">stop</b></a></dt> <dd><p>Shut off the socket listener, and destroy any pending replies.</p></dd> <dt><a name="64">method <b class="cmd">SubObject {} db</b></a></dt> <dd></dd> <dt><a name="65">method <b class="cmd">SubObject {} default</b></a></dt> <dd></dd> <dt><a name="66">method <b class="cmd">template</b> <i class="arg">page</i></a></dt> <dd><p>Return a template for the string <i class="arg">page</i></p></dd> <dt><a name="67">method <b class="cmd">TemplateSearch</b> <i class="arg">page</i></a></dt> <dd><p>Perform a search for the template that best matches <i class="arg">page</i>. This can include local file searches, in-memory structures, or even database lookups. The stock implementation simply looks for files with a .tml or .html extension in the <span class="opt">?doc_root?</span> directory.</p></dd> <dt><a name="68">method <b class="cmd">Thread_start</b></a></dt> <dd><p>Built by the <b class="cmd"><a href="../../../../index.html#plugin">plugin</a></b> method. Called by the <b class="cmd">start</b> method. Intended to allow plugins to spawn worker threads.</p></dd> <dt><a name="69">method <b class="cmd">Uuid_Generate</b></a></dt> <dd><p>Generate a GUUID. Used to ensure every request has a unique ID. The default implementation is:</p> <pre class="doctools_example"> return [::clay::uuid generate] </pre> </dd> <dt><a name="70">method <b class="cmd">Validate_Connection</b> <i class="arg">sock</i> <i class="arg">ip</i></a></dt> <dd><p>Given a socket and an ip address, return true if this connection should be terminated, or false if it should be allowed to continue. The stock implementation always returns 0. This is intended for applications to be able to implement black lists and/or provide security based on IP address.</p></dd> </dl> </div> <div id="subsection4" class="doctools_subsection"><h3><a name="subsection4">Class httpd::server::dispatch</a></h3> <p><em>ancestors</em>: <b class="class">httpd::server</b></p> <p>Provide a backward compadible alias</p> </div> <div id="subsection5" class="doctools_subsection"><h3><a name="subsection5">Class httpd::content.redirect</a></h3> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="71">method <b class="cmd">reset</b></a></dt> <dd></dd> <dt><a name="72">method <b class="cmd">content</b></a></dt> <dd></dd> </dl> </div> <div id="subsection6" class="doctools_subsection"><h3><a name="subsection6">Class httpd::content.cache</a></h3> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="73">method <b class="cmd">Dispatch</b></a></dt> <dd></dd> </dl> </div> <div id="subsection7" class="doctools_subsection"><h3><a name="subsection7">Class httpd::content.template</a></h3> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="74">method <b class="cmd">content</b></a></dt> <dd></dd> </dl> </div> <div id="subsection8" class="doctools_subsection"><h3><a name="subsection8">Class httpd::content.file</a></h3> <p>Class to deliver Static content When utilized, this class is fed a local filename by the dispatcher</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="75">method <b class="cmd">FileName</b></a></dt> <dd></dd> <dt><a name="76">method <b class="cmd">DirectoryListing</b> <i class="arg">local_file</i></a></dt> <dd></dd> <dt><a name="77">method <b class="cmd">content</b></a></dt> <dd></dd> <dt><a name="78">method <b class="cmd">Dispatch</b></a></dt> <dd></dd> </dl> </div> <div id="subsection9" class="doctools_subsection"><h3><a name="subsection9">Class httpd::content.exec</a></h3> <p><b class="class">Variable</b></p> <dl class="doctools_definitions"> <dt><a name="79">variable <b class="cmd">exename</b></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="80">method <b class="cmd">CgiExec</b> <i class="arg">execname</i> <i class="arg">script</i> <i class="arg">arglist</i></a></dt> <dd></dd> <dt><a name="81">method <b class="cmd">Cgi_Executable</b> <i class="arg">script</i></a></dt> <dd></dd> </dl> </div> <div id="subsection10" class="doctools_subsection"><h3><a name="subsection10">Class httpd::content.proxy</a></h3> <p><em>ancestors</em>: <b class="class">httpd::content.exec</b></p> <p>Return data from an proxy process</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="82">method <b class="cmd">proxy_channel</b></a></dt> <dd></dd> <dt><a name="83">method <b class="cmd">proxy_path</b></a></dt> <dd></dd> <dt><a name="84">method <b class="cmd">ProxyRequest</b> <i class="arg">chana</i> <i class="arg">chanb</i></a></dt> <dd></dd> <dt><a name="85">method <b class="cmd">ProxyReply</b> <i class="arg">chana</i> <i class="arg">chanb</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="86">method <b class="cmd">Dispatch</b></a></dt> <dd></dd> </dl> </div> <div id="subsection11" class="doctools_subsection"><h3><a name="subsection11">Class httpd::content.cgi</a></h3> <p><em>ancestors</em>: <b class="class">httpd::content.proxy</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="87">method <b class="cmd">FileName</b></a></dt> <dd></dd> <dt><a name="88">method <b class="cmd">proxy_channel</b></a></dt> <dd></dd> <dt><a name="89">method <b class="cmd">ProxyRequest</b> <i class="arg">chana</i> <i class="arg">chanb</i></a></dt> <dd></dd> <dt><a name="90">method <b class="cmd">ProxyReply</b> <i class="arg">chana</i> <i class="arg">chanb</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="91">method <b class="cmd">DirectoryListing</b> <i class="arg">local_file</i></a></dt> <dd><p>For most CGI applications a directory list is vorboten</p></dd> </dl> </div> <div id="subsection12" class="doctools_subsection"><h3><a name="subsection12">Class httpd::protocol.scgi</a></h3> <p>Return data from an SCGI process</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="92">method <b class="cmd">EncodeStatus</b> <i class="arg">status</i></a></dt> <dd></dd> </dl> </div> <div id="subsection13" class="doctools_subsection"><h3><a name="subsection13">Class httpd::content.scgi</a></h3> <p><em>ancestors</em>: <b class="class">httpd::content.proxy</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="93">method <b class="cmd">scgi_info</b></a></dt> <dd></dd> <dt><a name="94">method <b class="cmd">proxy_channel</b></a></dt> <dd></dd> <dt><a name="95">method <b class="cmd">ProxyRequest</b> <i class="arg">chana</i> <i class="arg">chanb</i></a></dt> <dd></dd> <dt><a name="96">method <b class="cmd">ProxyReply</b> <i class="arg">chana</i> <i class="arg">chanb</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> </dl> </div> <div id="subsection14" class="doctools_subsection"><h3><a name="subsection14">Class httpd::server.scgi</a></h3> <p><em>ancestors</em>: <b class="class">httpd::server</b></p> <p>Act as an SCGI Server</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="97">method <b class="cmd"><a href="../debug/debug.html">debug</a></b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="98">method <b class="cmd">Connect</b> <i class="arg">uuid</i> <i class="arg">sock</i> <i class="arg">ip</i></a></dt> <dd></dd> </dl> </div> <div id="subsection15" class="doctools_subsection"><h3><a name="subsection15">Class httpd::content.websocket</a></h3> <p>Upgrade a connection to a websocket</p> </div> <div id="subsection16" class="doctools_subsection"><h3><a name="subsection16">Class httpd::plugin</a></h3> <p>httpd plugin template</p> </div> <div id="subsection17" class="doctools_subsection"><h3><a name="subsection17">Class httpd::plugin.dict_dispatch</a></h3> <p>A rudimentary plugin that dispatches URLs from a dict data structure</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="99">method <b class="cmd">Dispatch_Dict</b> <i class="arg">data</i></a></dt> <dd><p>Implementation of the dispatcher</p></dd> <dt><a name="100">method <b class="cmd">uri {} add</b> <i class="arg">vhosts</i> <i class="arg">patterns</i> <i class="arg">info</i></a></dt> <dd></dd> <dt><a name="101">method <b class="cmd">uri {} direct</b> <i class="arg">vhosts</i> <i class="arg">patterns</i> <i class="arg">info</i> <i class="arg">body</i></a></dt> <dd></dd> </dl> </div> <div id="subsection18" class="doctools_subsection"><h3><a name="subsection18">Class httpd::reply.memchan</a></h3> <p><em>ancestors</em>: <b class="class">httpd::reply</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="102">method <b class="cmd">output</b></a></dt> <dd></dd> <dt><a name="103">method <b class="cmd">DoOutput</b></a></dt> <dd></dd> <dt><a name="104">method <b class="cmd">close</b></a></dt> <dd></dd> </dl> </div> <div id="subsection19" class="doctools_subsection"><h3><a name="subsection19">Class httpd::plugin.local_memchan</a></h3> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="105">method <b class="cmd">local_memchan</b> <i class="arg">command</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="106">method <b class="cmd">Connect_Local</b> <i class="arg">uuid</i> <i class="arg">sock</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>A modified connection method that passes simple GET request to an object and pulls data directly from the reply_body data variable in the object Needed because memchan is bidirectional, and we can't seem to communicate that the server is one side of the link and the reply is another</p></dd> </dl> </div> </div> <div id="section4" class="doctools_section"><h2><a name="section4">AUTHORS</a></h2> <p>Sean Woods</p> </div> <div id="section5" class="doctools_section"><h2><a name="section5">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category <em>network</em> of the <a href="http://core.tcl.tk/tcllib/reportlist">Tcllib Trackers</a>. Please also report any ideas for enhancements you may have for either package and/or documentation.</p> <p>When proposing code changes, please provide <em>unified diffs</em>, |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/imap4/imap4.html.
︙ | ︙ | |||
117 118 119 120 121 122 123 124 125 126 127 128 129 | <li class="doctools_section"><a href="#section2">PROCEDURES</a></li> <li class="doctools_section"><a href="#section3">EXAMPLES</a></li> <li class="doctools_section"><a href="#section4">TLS Security Considerations</a></li> <li class="doctools_section"><a href="#section5">REFERENCES</a></li> <li class="doctools_section"><a href="#section6">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#see-also">See Also</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> | > | | 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | <li class="doctools_section"><a href="#section2">PROCEDURES</a></li> <li class="doctools_section"><a href="#section3">EXAMPLES</a></li> <li class="doctools_section"><a href="#section4">TLS Security Considerations</a></li> <li class="doctools_section"><a href="#section5">REFERENCES</a></li> <li class="doctools_section"><a href="#section6">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#see-also">See Also</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">imap4 <span class="opt">?0.5.3?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::imap4::open</b> <i class="arg">hostname</i> <span class="opt">?<i class="arg">port</i>?</span></a></li> <li><a href="#2"><b class="cmd">::imap4::starttls</b> <i class="arg">chan</i></a></li> <li><a href="#3"><b class="cmd">::imap4::login</b> <i class="arg">chan</i> <i class="arg">user</i> <i class="arg">pass</i></a></li> <li><a href="#4"><b class="cmd">::imap4::folders</b> <i class="arg">chan</i> <span class="opt">?<i class="arg">-inline</i>?</span> <span class="opt">?<i class="arg">mboxref</i>?</span> <span class="opt">?<i class="arg">mboxname</i>?</span></a></li> <li><a href="#5"><b class="cmd">::imap4::select</b> <i class="arg">chan</i> <span class="opt">?<i class="arg">mailbox</i>?</span></a></li> |
︙ | ︙ | |||
486 487 488 489 490 491 492 493 494 | Only a small part of rfc3501 implemented.</p> </div> <div id="see-also" class="doctools_section"><h2><a name="see-also">See Also</a></h2> <p><a href="../ftp/ftp.html">ftp</a>, <a href="../../../../index.html#http">http</a>, <a href="../../../../index.html#imap">imap</a>, <a href="../mime/mime.html">mime</a>, <a href="../pop3/pop3.html">pop3</a>, <a href="../../../../index.html#tls">tls</a></p> </div> <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#email">email</a>, <a href="../../../../index.html#imap">imap</a>, <a href="../../../../index.html#internet">internet</a>, <a href="../../../../index.html#mail">mail</a>, <a href="../../../../index.html#net">net</a>, <a href="../../../../index.html#rfc3501">rfc3501</a>, <a href="../../../../index.html#ssl">ssl</a>, <a href="../../../../index.html#tls">tls</a></p> </div> </div></body></html> | > > > | 487 488 489 490 491 492 493 494 495 496 497 498 | Only a small part of rfc3501 implemented.</p> </div> <div id="see-also" class="doctools_section"><h2><a name="see-also">See Also</a></h2> <p><a href="../ftp/ftp.html">ftp</a>, <a href="../../../../index.html#http">http</a>, <a href="../../../../index.html#imap">imap</a>, <a href="../mime/mime.html">mime</a>, <a href="../pop3/pop3.html">pop3</a>, <a href="../../../../index.html#tls">tls</a></p> </div> <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#email">email</a>, <a href="../../../../index.html#imap">imap</a>, <a href="../../../../index.html#internet">internet</a>, <a href="../../../../index.html#mail">mail</a>, <a href="../../../../index.html#net">net</a>, <a href="../../../../index.html#rfc3501">rfc3501</a>, <a href="../../../../index.html#ssl">ssl</a>, <a href="../../../../index.html#tls">tls</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Networking</p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/math/numtheory.html.
︙ | ︙ | |||
142 143 144 145 146 147 148 149 150 151 152 153 154 155 | <li><a href="#11"><b class="cmd">math::numtheory::legendre</b> <i class="arg">a</i> <i class="arg">p</i></a></li> <li><a href="#12"><b class="cmd">math::numtheory::jacobi</b> <i class="arg">a</i> <i class="arg">b</i></a></li> <li><a href="#13"><b class="cmd">math::numtheory::gcd</b> <i class="arg">m</i> <i class="arg">n</i></a></li> <li><a href="#14"><b class="cmd">math::numtheory::lcm</b> <i class="arg">m</i> <i class="arg">n</i></a></li> <li><a href="#15"><b class="cmd">math::numtheory::numberPrimesGauss</b> <i class="arg">N</i></a></li> <li><a href="#16"><b class="cmd">math::numtheory::numberPrimesLegendre</b> <i class="arg">N</i></a></li> <li><a href="#17"><b class="cmd">math::numtheory::numberPrimesLegendreModified</b> <i class="arg">N</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>This package is for collecting various number-theoretic operations, with a slight bias to prime numbers.</p> <dl class="doctools_definitions"> | > | 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | <li><a href="#11"><b class="cmd">math::numtheory::legendre</b> <i class="arg">a</i> <i class="arg">p</i></a></li> <li><a href="#12"><b class="cmd">math::numtheory::jacobi</b> <i class="arg">a</i> <i class="arg">b</i></a></li> <li><a href="#13"><b class="cmd">math::numtheory::gcd</b> <i class="arg">m</i> <i class="arg">n</i></a></li> <li><a href="#14"><b class="cmd">math::numtheory::lcm</b> <i class="arg">m</i> <i class="arg">n</i></a></li> <li><a href="#15"><b class="cmd">math::numtheory::numberPrimesGauss</b> <i class="arg">N</i></a></li> <li><a href="#16"><b class="cmd">math::numtheory::numberPrimesLegendre</b> <i class="arg">N</i></a></li> <li><a href="#17"><b class="cmd">math::numtheory::numberPrimesLegendreModified</b> <i class="arg">N</i></a></li> <li><a href="#18"><b class="cmd">math::numtheory::differenceNumberPrimesLegendreModified</b> <i class="arg">lower</i> <i class="arg">upper</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>This package is for collecting various number-theoretic operations, with a slight bias to prime numbers.</p> <dl class="doctools_definitions"> |
︙ | ︙ | |||
267 268 269 270 271 272 273 | <dt>integer <i class="arg">n</i> (in)</dt> <dd><p>Second number</p></dd> </dl></dd> <dt><a name="15"><b class="cmd">math::numtheory::numberPrimesGauss</b> <i class="arg">N</i></a></dt> <dd><p>Estimate the number of primes according the formula by Gauss.</p> <dl class="doctools_arguments"> <dt>integer <i class="arg">N</i> (in)</dt> | | | | > > > > > > > > | 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 | <dt>integer <i class="arg">n</i> (in)</dt> <dd><p>Second number</p></dd> </dl></dd> <dt><a name="15"><b class="cmd">math::numtheory::numberPrimesGauss</b> <i class="arg">N</i></a></dt> <dd><p>Estimate the number of primes according the formula by Gauss.</p> <dl class="doctools_arguments"> <dt>integer <i class="arg">N</i> (in)</dt> <dd><p>Number in question, should be larger than 0</p></dd> </dl></dd> <dt><a name="16"><b class="cmd">math::numtheory::numberPrimesLegendre</b> <i class="arg">N</i></a></dt> <dd><p>Estimate the number of primes according the formula by Legendre.</p> <dl class="doctools_arguments"> <dt>integer <i class="arg">N</i> (in)</dt> <dd><p>Number in question, should be larger than 0</p></dd> </dl></dd> <dt><a name="17"><b class="cmd">math::numtheory::numberPrimesLegendreModified</b> <i class="arg">N</i></a></dt> <dd><p>Estimate the number of primes according the modified formula by Legendre.</p> <dl class="doctools_arguments"> <dt>integer <i class="arg">N</i> (in)</dt> <dd><p>Number in question, should be larger than 0</p></dd> </dl></dd> <dt><a name="18"><b class="cmd">math::numtheory::differenceNumberPrimesLegendreModified</b> <i class="arg">lower</i> <i class="arg">upper</i></a></dt> <dd><p>Estimate the number of primes between tow limits according the modified formula by Legendre.</p> <dl class="doctools_arguments"> <dt>integer <i class="arg">lower</i> (in)</dt> <dd><p>Lower limit for the primes, should be larger than 0</p></dd> <dt>integer <i class="arg">upper</i> (in)</dt> <dd><p>Upper limit for the primes, should be larger than 0</p></dd> </dl></dd> </dl> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category <em>math :: numtheory</em> of the |
︙ | ︙ |
Added idoc/www/tcllib/files/modules/math/quasirandom.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>math::quasirandom - Tcl Math Library</title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'quasirandom.man' by tcllib/doctools with format 'html' --> <!-- math::quasirandom.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">math::quasirandom(n) 1 tcllib "Tcl Math Library"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>math::quasirandom - Quasi-random points for integration and Monte Carlo type methods</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">COMMANDS</a></li> <li class="doctools_section"><a href="#section3">TODO</a></li> <li class="doctools_section"><a href="#section4">References</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">TclOO</b></li> <li>package require <b class="pkgname">math::quasirandom 1</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::math::quasirandom::qrpoint create</b> <i class="arg">NAME</i> <i class="arg">DIM</i> <span class="opt">?ARGS?</span></a></li> <li><a href="#2"><b class="cmd">gen next</b></a></li> <li><a href="#3"><b class="cmd">gen set-start</b> <i class="arg">index</i></a></li> <li><a href="#4"><b class="cmd">gen set-evaluations</b> <i class="arg">number</i></a></li> <li><a href="#5"><b class="cmd">gen integral</b> <i class="arg">func</i> <i class="arg">minmax</i> <i class="arg">args</i></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>In many applications pseudo-random numbers and pseudo-random points in a (limited) sample space play an important role. For instance in any type of Monte Carlo simulation. Pseudo-random numbers, however, may be too random and as a consequence a large number of data points is required to reduce the error or fluctuation in the results to the desired value.</p> <p>Quasi-random numbers can be used as an alternative: instead of "completely" arbitrary points, points are generated that are diverse enough to cover the entire sample space in a more or less uniform way. As a consequence convergence to the limit can be much faster, when such quasi-random numbers are well-chosen.</p> <p>The package defines a <i class="term"><a href="../../../../index.html#class">class</a></i> "qrpoint" that creates a command to generate quasi-random points in 1, 2 or more dimensions. The command can either generate separate points, so that they can be used in a user-defined algorithm or use these points to calculate integrals of functions defined over 1, 2 or more dimensions. It also holds several other common algorithms. (NOTE: these are not implemented yet)</p> <p>One particular characteristic of the generators is that there are no tuning parameters involved, which makes the use particularly simple.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">COMMANDS</a></h2> <p>A quasi-random point generator is created using the <i class="term">qrpoint</i> class:</p> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd">::math::quasirandom::qrpoint create</b> <i class="arg">NAME</i> <i class="arg">DIM</i> <span class="opt">?ARGS?</span></a></dt> <dd><p>This command takes the following arguments:</p> <dl class="doctools_arguments"> <dt>string <i class="arg">NAME</i></dt> <dd><p>The name of the command to be created (alternatively: the <i class="term">new</i> subcommand will generate a unique name)</p></dd> <dt>integer/string <i class="arg">DIM</i></dt> <dd><p>The number of dimensions or one of: "circle", "disk", "sphere" or "ball"</p></dd> <dt>strings <i class="arg">ARGS</i></dt> <dd><p>Zero or more key-value pairs. The supported options are:</p> <ul class="doctools_itemized"> <li><p><i class="term">-start index</i>: The index for the next point to be generated (default: 1)</p></li> <li><p><i class="term">-evaluations number</i>: The number of evaluations to be used by default (default: 100)</p></li> </ul></dd> </dl></dd> </dl> <p>The points that are returned lie in the hyperblock [0,1[^n (n the number of dimensions) or on the unit circle, within the unit disk, on the unit sphere or within the unit ball.</p> <p>Each generator supports the following subcommands:</p> <dl class="doctools_definitions"> <dt><a name="2"><b class="cmd">gen next</b></a></dt> <dd><p>Return the coordinates of the next quasi-random point</p></dd> <dt><a name="3"><b class="cmd">gen set-start</b> <i class="arg">index</i></a></dt> <dd><p>Reset the index for the next quasi-random point. This is useful to control which list of points is returned. Returns the new or the current value, if no value is given.</p></dd> <dt><a name="4"><b class="cmd">gen set-evaluations</b> <i class="arg">number</i></a></dt> <dd><p>Reset the default number of evaluations in compound algorithms. Note that the actual number is the smallest 4-fold larger or equal to the given number. (The 4-fold plays a role in the detailed integration routine.)</p></dd> <dt><a name="5"><b class="cmd">gen integral</b> <i class="arg">func</i> <i class="arg">minmax</i> <i class="arg">args</i></a></dt> <dd><p>Calculate the integral of the given function over the block (or the circle, sphere etc.)</p> <dl class="doctools_arguments"> <dt>string <i class="arg">func</i></dt> <dd><p>The name of the function to be integrated</p></dd> <dt>list <i class="arg">minmax</i></dt> <dd><p>List of pairs of minimum and maximum coordinates. This can be used to map the quasi-random coordinates to the desired hyper-block.</p> <p>If the space is a circle, disk etc. then this argument should be a single value, the radius. The circle, disk, etc. is centred at the origin. If this is not what is required, then a coordinate transformation should be made within the function.</p></dd> <dt>strings <i class="arg">args</i></dt> <dd><p>Zero or more key-value pairs. The following options are supported:</p> <ul class="doctools_itemized"> <li><p><i class="term">-evaluations number</i>: The number of evaluations to be used. If not specified use the default of the generator object.</p></li> </ul></dd> </dl></dd> </dl> </div> <div id="section3" class="doctools_section"><h2><a name="section3">TODO</a></h2> <p>Implement other algorithms and variants</p> <p>Implement more unit tests.</p> <p>Comparison to pseudo-random numbers for integration.</p> </div> <div id="section4" class="doctools_section"><h2><a name="section4">References</a></h2> <p>Various algorithms exist for generating quasi-random numbers. The generators created in this package are based on: <a href="http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/">http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/</a></p> </div> <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#mathematics">mathematics</a>, <a href="../../../../index.html#quasi_random">quasi-random</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Mathematics</p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/mime/mime.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | | 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 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">mime(n) 1.6.1 tcllib "Mime"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>mime - Manipulation of MIME body parts</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">KNOWN BUGS</a></li> <li class="doctools_section"><a href="#section3">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#see-also">See Also</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">mime <span class="opt">?1.6.1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::mime::initialize</b> <span class="opt">?<b class="option">-canonical</b> <i class="arg">type/subtype</i> <span class="opt">?<b class="option">-param</b> {<i class="arg">key value</i>}...?</span> <span class="opt">?<b class="option">-encoding</b> <i class="arg">value</i>?</span> <span class="opt">?<b class="option">-header</b> {<i class="arg">key value</i>}...?</span>?</span> (<b class="option">-file</b> <i class="arg">name</i> | <b class="option">-string</b> <i class="arg">value</i> | <b class="option">-parts</b> {<i class="arg">token1</i> ... <i class="arg">tokenN</i>})</a></li> <li><a href="#2"><b class="cmd">::mime::finalize</b> <i class="arg">token</i> <span class="opt">?<b class="option">-subordinates</b> <b class="const">all</b> | <b class="const">dynamic</b> | <b class="const">none</b>?</span></a></li> <li><a href="#3"><b class="cmd">::mime::getproperty</b> <i class="arg">token</i> <span class="opt">?<i class="arg">property</i> | <b class="option">-names</b>?</span></a></li> <li><a href="#4"><b class="cmd">::mime::getheader</b> <i class="arg">token</i> <span class="opt">?<i class="arg">key</i> | <b class="option">-names</b>?</span></a></li> <li><a href="#5"><b class="cmd">::mime::setheader</b> <i class="arg">token</i> <i class="arg">key value</i> <span class="opt">?<b class="option">-mode</b> <b class="const">write</b> | <b class="const">append</b> | <b class="const">delete</b>?</span></a></li> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/mime/smtp.html.
︙ | ︙ | |||
239 240 241 242 243 244 245 | and <b class="package"><a href="../ripemd/ripemd160.html">ripemd160</a></b>.</p> </div> <div id="section3" class="doctools_section"><h2><a name="section3">EXAMPLE</a></h2> <pre class="doctools_example"> proc send_simple_message {recipient email_server subject body} { package require smtp package require mime | | | | | 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | and <b class="package"><a href="../ripemd/ripemd160.html">ripemd160</a></b>.</p> </div> <div id="section3" class="doctools_section"><h2><a name="section3">EXAMPLE</a></h2> <pre class="doctools_example"> proc send_simple_message {recipient email_server subject body} { package require smtp package require mime set token [mime::initialize -canonical text/plain \ -string $body] mime::setheader $token Subject $subject smtp::sendmessage $token \ -recipients $recipient -servers $email_server mime::finalize $token } send_simple_message [email protected] localhost \ "This is the subject." "This is the message." </pre> </div> <div id="section4" class="doctools_section"><h2><a name="section4">TLS Security Considerations</a></h2> <p>This package uses the <b class="package"><a href="../../../../index.html#tls">TLS</a></b> package to handle the security for <b class="const">https</b> urls and other socket connections.</p> <p>Policy decisions like the set of protocols to support and what |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/oauth/oauth.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | | 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 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">oauth(n) 1.0.3 tcllib "oauth"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>oauth - oauth API base signature</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">TLS Security Considerations</a></li> <li class="doctools_section"><a href="#section3">Commands</a></li> <li class="doctools_section"><a href="#section4">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">oauth <span class="opt">?1.0.3?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::oauth::config</b></a></li> <li><a href="#2"><b class="cmd">::oauth::config</b> <span class="opt">?<i class="arg">options</i>...?</span></a></li> <li><a href="#3"><b class="cmd">::oauth::header</b> <i class="arg">baseURL</i> <span class="opt">?<i class="arg">postQuery</i>?</span></a></li> <li><a href="#4"><b class="cmd">::oauth::query</b> <i class="arg">baseURL</i> <span class="opt">?<i class="arg">postQuery</i>?</span></a></li> </ul> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/pop3/pop3.html.
︙ | ︙ | |||
310 311 312 313 314 315 316 | of the <b class="cmd">tls::socket</b> command when opening the connection. This is suitable for POP3 servers which expect SSL connections only. These will generally be listening on port 995.</p> <pre class="doctools_example"> package require tls tls::init -cafile /path/to/ca/cert -keyfile ... # Create secured pop3 channel | | | | 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 | of the <b class="cmd">tls::socket</b> command when opening the connection. This is suitable for POP3 servers which expect SSL connections only. These will generally be listening on port 995.</p> <pre class="doctools_example"> package require tls tls::init -cafile /path/to/ca/cert -keyfile ... # Create secured pop3 channel pop3::open -socketcmd tls::socket \ $thehost $theuser $thepassword ... </pre> <p>The second method, option <b class="option">-stls</b>, will connect to the standard POP3 port and then perform an STARTTLS handshake. This will only work for POP3 servers which have this capability. The package will confirm that the server supports STARTTLS and the handshake was performed correctly before proceeding with authentication.</p> <pre class="doctools_example"> package require tls tls::init -cafile /path/to/ca/cert -keyfile ... # Create secured pop3 channel pop3::open -stls 1 \ $thehost $theuser $thepassword ... </pre> </div> <div id="section5" class="doctools_section"><h2><a name="section5">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/pop3d/pop3d.html.
︙ | ︙ | |||
305 306 307 308 309 310 311 | <div id="section5" class="doctools_section"><h2><a name="section5">Secure mail transfer</a></h2> <p>The option <b class="option">-socket</b> (see <span class="sectref"><a href="#section2">Options</a></span>) enables users of the package to override how the server opens its listening socket. The envisioned main use is the specification of the <b class="cmd">tls::socket</b> command, see package <b class="package"><a href="../../../../index.html#tls">tls</a></b>, to secure the communication.</p> <pre class="doctools_example"> package require tls | | | 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | <div id="section5" class="doctools_section"><h2><a name="section5">Secure mail transfer</a></h2> <p>The option <b class="option">-socket</b> (see <span class="sectref"><a href="#section2">Options</a></span>) enables users of the package to override how the server opens its listening socket. The envisioned main use is the specification of the <b class="cmd">tls::socket</b> command, see package <b class="package"><a href="../../../../index.html#tls">tls</a></b>, to secure the communication.</p> <pre class="doctools_example"> package require tls tls::init \ ... pop3d::new S -socket tls::socket ... </pre> </div> <div id="section6" class="doctools_section"><h2><a name="section6">References</a></h2> <ol class="doctools_enumerated"> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/practcl/practcl.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < > > > > > | > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > > > | > > > > > > > > > > > > > | > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | | | > > > > > > > > > > | > > > > > | > > > > > > > > | > > > > > > | > > > > > > > > > > > > > > > > > | > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">practcl(n) 0.16.3 tcllib "The The Proper Rational API for C to Tool Command Language Module"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>practcl - The Practcl Module</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Commands</a></li> <li class="doctools_section"><a href="#section3">Classes</a> <ul> <li class="doctools_subsection"><a href="#subsection1">Class practcl::doctool</a></li> <li class="doctools_subsection"><a href="#subsection2">Class practcl::metaclass</a></li> <li class="doctools_subsection"><a href="#subsection3">Class practcl::toolset</a></li> <li class="doctools_subsection"><a href="#subsection4">Class practcl::toolset.gcc</a></li> <li class="doctools_subsection"><a href="#subsection5">Class practcl::toolset.msvc</a></li> <li class="doctools_subsection"><a href="#subsection6">Class practcl::make_obj</a></li> <li class="doctools_subsection"><a href="#subsection7">Class practcl::object</a></li> <li class="doctools_subsection"><a href="#subsection8">Class practcl::dynamic</a></li> <li class="doctools_subsection"><a href="#subsection9">Class practcl::product</a></li> <li class="doctools_subsection"><a href="#subsection10">Class practcl::product.cheader</a></li> <li class="doctools_subsection"><a href="#subsection11">Class practcl::product.csource</a></li> <li class="doctools_subsection"><a href="#subsection12">Class practcl::product.clibrary</a></li> <li class="doctools_subsection"><a href="#subsection13">Class practcl::product.dynamic</a></li> <li class="doctools_subsection"><a href="#subsection14">Class practcl::product.critcl</a></li> <li class="doctools_subsection"><a href="#subsection15">Class practcl::module</a></li> <li class="doctools_subsection"><a href="#subsection16">Class practcl::project</a></li> <li class="doctools_subsection"><a href="#subsection17">Class practcl::library</a></li> <li class="doctools_subsection"><a href="#subsection18">Class practcl::tclkit</a></li> <li class="doctools_subsection"><a href="#subsection19">Class practcl::distribution</a></li> <li class="doctools_subsection"><a href="#subsection20">Class practcl::distribution.snapshot</a></li> <li class="doctools_subsection"><a href="#subsection21">Class practcl::distribution.fossil</a></li> <li class="doctools_subsection"><a href="#subsection22">Class practcl::distribution.git</a></li> <li class="doctools_subsection"><a href="#subsection23">Class practcl::subproject</a></li> <li class="doctools_subsection"><a href="#subsection24">Class practcl::subproject.source</a></li> <li class="doctools_subsection"><a href="#subsection25">Class practcl::subproject.teapot</a></li> <li class="doctools_subsection"><a href="#subsection26">Class practcl::subproject.kettle</a></li> <li class="doctools_subsection"><a href="#subsection27">Class practcl::subproject.critcl</a></li> <li class="doctools_subsection"><a href="#subsection28">Class practcl::subproject.sak</a></li> <li class="doctools_subsection"><a href="#subsection29">Class practcl::subproject.practcl</a></li> <li class="doctools_subsection"><a href="#subsection30">Class practcl::subproject.binary</a></li> <li class="doctools_subsection"><a href="#subsection31">Class practcl::subproject.tea</a></li> <li class="doctools_subsection"><a href="#subsection32">Class practcl::subproject.library</a></li> <li class="doctools_subsection"><a href="#subsection33">Class practcl::subproject.external</a></li> <li class="doctools_subsection"><a href="#subsection34">Class practcl::subproject.core</a></li> </ul> </li> <li class="doctools_section"><a href="#section4">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">TclOO 1.0</b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1">proc <b class="cmd">practcl::cat</b> <i class="arg">fname</i></a></li> <li><a href="#2">proc <b class="cmd">practcl::docstrip</b> <i class="arg">text</i></a></li> <li><a href="#3">proc <b class="cmd">putb</b> <span class="opt">?<i class="arg">map</i>?</span> <i class="arg">text</i></a></li> <li><a href="#4">proc <b class="cmd"><a href="../../../../index.html#proc">Proc</a></b> <i class="arg">name</i> <i class="arg">arglist</i> <i class="arg">body</i></a></li> <li><a href="#5">proc <b class="cmd">noop</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#6">proc <b class="cmd">practcl::debug</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#7">proc <b class="cmd">practcl::doexec</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#8">proc <b class="cmd">practcl::doexec_in</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#9">proc <b class="cmd">practcl::dotclexec</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#10">proc <b class="cmd">practcl::domake</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#11">proc <b class="cmd">practcl::domake.tcl</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#12">proc <b class="cmd">practcl::fossil</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#13">proc <b class="cmd">practcl::fossil_status</b> <i class="arg">dir</i></a></li> <li><a href="#14">proc <b class="cmd">practcl::os</b></a></li> <li><a href="#15">proc <b class="cmd">practcl::mkzip</b> <i class="arg">exename</i> <i class="arg">barekit</i> <i class="arg">vfspath</i></a></li> <li><a href="#16">proc <b class="cmd">practcl::sort_dict</b> <i class="arg">list</i></a></li> <li><a href="#17">proc <b class="cmd">practcl::local_os</b></a></li> <li><a href="#18">proc <b class="cmd">practcl::config.tcl</b> <i class="arg">path</i></a></li> <li><a href="#19">proc <b class="cmd">practcl::read_configuration</b> <i class="arg">path</i></a></li> <li><a href="#20">proc <b class="cmd">practcl::tcllib_require</b> <i class="arg">pkg</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#21">proc <b class="cmd">practcl::platform::tcl_core_options</b> <i class="arg">os</i></a></li> <li><a href="#22">proc <b class="cmd">practcl::platform::tk_core_options</b> <i class="arg">os</i></a></li> <li><a href="#23">proc <b class="cmd">practcl::read_rc_file</b> <i class="arg">filename</i> <span class="opt">?<i class="arg">localdat</i> <b class="const"></b>?</span></a></li> <li><a href="#24">proc <b class="cmd">practcl::read_sh_subst</b> <i class="arg">line</i> <i class="arg">info</i></a></li> <li><a href="#25">proc <b class="cmd">practcl::read_sh_file</b> <i class="arg">filename</i> <span class="opt">?<i class="arg">localdat</i> <b class="const"></b>?</span></a></li> <li><a href="#26">proc <b class="cmd">practcl::read_Config.sh</b> <i class="arg">filename</i></a></li> <li><a href="#27">proc <b class="cmd">practcl::read_Makefile</b> <i class="arg">filename</i></a></li> <li><a href="#28">proc <b class="cmd">practcl::cputs</b> <i class="arg">varname</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#29">proc <b class="cmd">practcl::tcl_to_c</b> <i class="arg">body</i></a></li> <li><a href="#30">proc <b class="cmd">practcl::_tagblock</b> <i class="arg">text</i> <span class="opt">?<i class="arg">style</i> <b class="const">tcl</b>?</span> <span class="opt">?<i class="arg">note</i> <b class="const"></b>?</span></a></li> <li><a href="#31">proc <b class="cmd">practcl::de_shell</b> <i class="arg">data</i></a></li> <li><a href="#32">proc <b class="cmd">practcl::grep</b> <i class="arg">pattern</i> <span class="opt">?<i class="arg">files</i> <b class="const"></b>?</span></a></li> <li><a href="#33">proc <b class="cmd">practcl::file_lexnormalize</b> <i class="arg">sp</i></a></li> <li><a href="#34">proc <b class="cmd">practcl::file_relative</b> <i class="arg">base</i> <i class="arg">dst</i></a></li> <li><a href="#35">proc <b class="cmd">practcl::findByPattern</b> <i class="arg">basedir</i> <i class="arg">patterns</i></a></li> <li><a href="#36">proc <b class="cmd">practcl::log</b> <i class="arg">fname</i> <i class="arg">comment</i></a></li> <li><a href="#37">proc <b class="cmd">practcl::_pkgindex_simpleIndex</b> <i class="arg">path</i></a></li> <li><a href="#38">proc <b class="cmd">practcl::_pkgindex_directory</b> <i class="arg">path</i></a></li> <li><a href="#39">proc <b class="cmd">practcl::_pkgindex_path_subdir</b> <i class="arg">path</i></a></li> <li><a href="#40">proc <b class="cmd">practcl::pkgindex_path</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#41">proc <b class="cmd">practcl::installDir</b> <i class="arg">d1</i> <i class="arg">d2</i></a></li> <li><a href="#42">proc <b class="cmd">practcl::copyDir</b> <i class="arg">d1</i> <i class="arg">d2</i> <span class="opt">?<i class="arg">toplevel</i> <b class="const">1</b>?</span></a></li> <li><a href="#43">proc <b class="cmd">practcl::buildModule</b> <i class="arg">modpath</i></a></li> <li><a href="#44">proc <b class="cmd">practcl::installModule</b> <i class="arg">modpath</i> <i class="arg">DEST</i></a></li> <li><a href="#45">proc <b class="cmd">practcl::trigger</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#46">proc <b class="cmd">practcl::depends</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#47">proc <b class="cmd">practcl::target</b> <i class="arg">name</i> <i class="arg">info</i> <span class="opt">?<i class="arg">action</i> <b class="const"></b>?</span></a></li> <li><a href="#48">method <b class="cmd">constructor</b></a></li> <li><a href="#49">method <b class="cmd">argspec</b> <i class="arg">argspec</i></a></li> <li><a href="#50">method <b class="cmd"><a href="../../../../index.html#comment">comment</a></b> <i class="arg">block</i></a></li> <li><a href="#51">method <b class="cmd">keyword.Annotation</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">type</i> <i class="arg">name</i> <i class="arg">body</i></a></li> <li><a href="#52">method <b class="cmd">keyword.Class</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <i class="arg">body</i></a></li> <li><a href="#53">method <b class="cmd">keyword.class</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <i class="arg">body</i></a></li> <li><a href="#54">method <b class="cmd">keyword.Class_Method</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#55">method <b class="cmd">keyword.method</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#56">method <b class="cmd">keyword.proc</b> <i class="arg">commentblock</i> <i class="arg">name</i> <i class="arg">argspec</i></a></li> <li><a href="#57">method <b class="cmd">reset</b></a></li> <li><a href="#58">method <b class="cmd">Main</b></a></li> <li><a href="#59">method <b class="cmd">section.method</b> <i class="arg">keyword</i> <i class="arg">method</i> <i class="arg">minfo</i></a></li> <li><a href="#60">method <b class="cmd">section.annotation</b> <i class="arg">type</i> <i class="arg">name</i> <i class="arg">iinfo</i></a></li> <li><a href="#61">method <b class="cmd">section.class</b> <i class="arg">class_name</i> <i class="arg">class_info</i></a></li> <li><a href="#62">method <b class="cmd">section.command</b> <i class="arg">procinfo</i></a></li> <li><a href="#63">method <b class="cmd"><a href="../../../../index.html#manpage">manpage</a></b> <span class="opt">?<b class="option">header <em>value</em></b>?</span> <span class="opt">?<b class="option">footer <em>value</em></b>?</span> <span class="opt">?<b class="option">authors <em>list</em></b>?</span></a></li> <li><a href="#64">method <b class="cmd">scan_text</b> <i class="arg">text</i></a></li> <li><a href="#65">method <b class="cmd">scan_file</b> <i class="arg">filename</i></a></li> <li><a href="#66">method <b class="cmd">_MorphPatterns</b></a></li> <li><a href="#67">method <b class="cmd"><a href="../../../../index.html#define">define</a></b> <i class="arg">submethod</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#68">method <b class="cmd">graft</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#69">method <b class="cmd">initialize</b></a></li> <li><a href="#70">method <b class="cmd">link</b> <i class="arg">command</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#71">method <b class="cmd">morph</b> <i class="arg">classname</i></a></li> <li><a href="#72">method <b class="cmd">script</b> <i class="arg">script</i></a></li> <li><a href="#73">method <b class="cmd">select</b></a></li> <li><a href="#74">method <b class="cmd"><a href="../../../../index.html#source">source</a></b> <i class="arg">filename</i></a></li> <li><a href="#75">classmethod <b class="cmd">select</b> <i class="arg">object</i></a></li> <li><a href="#76">method <b class="cmd">config.sh</b></a></li> <li><a href="#77">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></li> <li><a href="#78">method <b class="cmd">MakeDir</b> <i class="arg">srcdir</i></a></li> <li><a href="#79">method <b class="cmd">read_configuration</b></a></li> <li><a href="#80">method <b class="cmd">build-cflags</b> <i class="arg">PROJECT</i> <i class="arg">DEFS</i> <i class="arg">namevar</i> <i class="arg">versionvar</i> <i class="arg">defsvar</i></a></li> <li><a href="#81">method <b class="cmd">critcl</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#82">method <b class="cmd">Autoconf</b></a></li> <li><a href="#83">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></li> <li><a href="#84">method <b class="cmd">ConfigureOpts</b></a></li> <li><a href="#85">method <b class="cmd">MakeDir</b> <i class="arg">srcdir</i></a></li> <li><a href="#86">method <b class="cmd">make {} autodetect</b></a></li> <li><a href="#87">method <b class="cmd">make {} clean</b></a></li> <li><a href="#88">method <b class="cmd">make {} compile</b></a></li> <li><a href="#89">method <b class="cmd">make {} install</b> <i class="arg">DEST</i></a></li> <li><a href="#90">method <b class="cmd">build-compile-sources</b> <i class="arg">PROJECT</i> <i class="arg">COMPILE</i> <i class="arg">CPPCOMPILE</i> <i class="arg">INCLUDES</i></a></li> <li><a href="#91">method <b class="cmd">build-Makefile</b> <i class="arg">path</i> <i class="arg">PROJECT</i></a></li> <li><a href="#92">method <b class="cmd">build-library</b> <i class="arg">outfile</i> <i class="arg">PROJECT</i></a></li> <li><a href="#93">method <b class="cmd">build-tclsh</b> <i class="arg">outfile</i> <i class="arg">PROJECT</i> <span class="opt">?<i class="arg">path</i> <b class="const">auto</b>?</span></a></li> <li><a href="#94">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></li> <li><a href="#95">method <b class="cmd">make {} autodetect</b></a></li> <li><a href="#96">method <b class="cmd">make {} clean</b></a></li> <li><a href="#97">method <b class="cmd">make {} compile</b></a></li> <li><a href="#98">method <b class="cmd">make {} install</b> <i class="arg">DEST</i></a></li> <li><a href="#99">method <b class="cmd">MakeDir</b> <i class="arg">srcdir</i></a></li> <li><a href="#100">method <b class="cmd">NmakeOpts</b></a></li> <li><a href="#101">method <b class="cmd">constructor</b> <i class="arg">module_object</i> <i class="arg">name</i> <i class="arg">info</i> <span class="opt">?<i class="arg">action_body</i> <b class="const"></b>?</span></a></li> <li><a href="#102">method <b class="cmd"><a href="../../../../index.html#do">do</a></b></a></li> <li><a href="#103">method <b class="cmd">check</b></a></li> <li><a href="#104">method <b class="cmd">output</b></a></li> <li><a href="#105">method <b class="cmd">reset</b></a></li> <li><a href="#106">method <b class="cmd">triggers</b></a></li> <li><a href="#107">method <b class="cmd">constructor</b> <i class="arg">parent</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#108">method <b class="cmd">child</b> <i class="arg">method</i></a></li> <li><a href="#109">method <b class="cmd">go</b></a></li> <li><a href="#110">method <b class="cmd">cstructure</b> <i class="arg">name</i> <i class="arg">definition</i> <span class="opt">?<i class="arg">argdat</i> <b class="const"></b>?</span></a></li> <li><a href="#111">method <b class="cmd">include</b> <i class="arg">header</i></a></li> <li><a href="#112">method <b class="cmd">include_dir</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#113">method <b class="cmd">include_directory</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#114">method <b class="cmd">c_header</b> <i class="arg">body</i></a></li> <li><a href="#115">method <b class="cmd">c_code</b> <i class="arg">body</i></a></li> <li><a href="#116">method <b class="cmd">c_function</b> <i class="arg">header</i> <i class="arg">body</i> <span class="opt">?<i class="arg">info</i> <b class="const"></b>?</span></a></li> <li><a href="#117">method <b class="cmd">c_tcloomethod</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></li> <li><a href="#118">method <b class="cmd">cmethod</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></li> <li><a href="#119">method <b class="cmd">c_tclproc_nspace</b> <i class="arg">nspace</i></a></li> <li><a href="#120">method <b class="cmd">c_tclcmd</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></li> <li><a href="#121">method <b class="cmd">c_tclproc_raw</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></li> <li><a href="#122">method <b class="cmd">tcltype</b> <i class="arg">name</i> <i class="arg">argdat</i></a></li> <li><a href="#123">method <b class="cmd">project-compile-products</b></a></li> <li><a href="#124">method <b class="cmd">implement</b> <i class="arg">path</i></a></li> <li><a href="#125">method <b class="cmd">initialize</b></a></li> <li><a href="#126">method <b class="cmd">linktype</b></a></li> <li><a href="#127">method <b class="cmd">generate-cfile-constant</b></a></li> <li><a href="#128">method <b class="cmd">generate-cfile-header</b></a></li> <li><a href="#129">method <b class="cmd">generate-cfile-tclapi</b></a></li> <li><a href="#130">method <b class="cmd">generate-loader-module</b></a></li> <li><a href="#131">method <b class="cmd">Collate_Source</b> <i class="arg">CWD</i></a></li> <li><a href="#132">method <b class="cmd">select</b></a></li> <li><a href="#133">classmethod <b class="cmd">select</b> <i class="arg">object</i></a></li> <li><a href="#134">method <b class="cmd">code</b> <i class="arg">section</i> <i class="arg">body</i></a></li> <li><a href="#135">method <b class="cmd">Collate_Source</b> <i class="arg">CWD</i></a></li> <li><a href="#136">method <b class="cmd">project-compile-products</b></a></li> <li><a href="#137">method <b class="cmd">generate-debug</b> <span class="opt">?<i class="arg">spaces</i> <b class="const"></b>?</span></a></li> <li><a href="#138">method <b class="cmd">generate-cfile-constant</b></a></li> <li><a href="#139">method <b class="cmd">generate-cfile-public-structure</b></a></li> <li><a href="#140">method <b class="cmd">generate-cfile-header</b></a></li> <li><a href="#141">method <b class="cmd">generate-cfile-global</b></a></li> <li><a href="#142">method <b class="cmd">generate-cfile-private-typedef</b></a></li> <li><a href="#143">method <b class="cmd">generate-cfile-private-structure</b></a></li> <li><a href="#144">method <b class="cmd">generate-cfile-functions</b></a></li> <li><a href="#145">method <b class="cmd">generate-cfile-tclapi</b></a></li> <li><a href="#146">method <b class="cmd">generate-hfile-public-define</b></a></li> <li><a href="#147">method <b class="cmd">generate-hfile-public-macro</b></a></li> <li><a href="#148">method <b class="cmd">generate-hfile-public-typedef</b></a></li> <li><a href="#149">method <b class="cmd">generate-hfile-public-structure</b></a></li> <li><a href="#150">method <b class="cmd">generate-hfile-public-headers</b></a></li> <li><a href="#151">method <b class="cmd">generate-hfile-public-function</b></a></li> <li><a href="#152">method <b class="cmd">generate-hfile-public-includes</b></a></li> <li><a href="#153">method <b class="cmd">generate-hfile-public-verbatim</b></a></li> <li><a href="#154">method <b class="cmd">generate-loader-external</b></a></li> <li><a href="#155">method <b class="cmd">generate-loader-module</b></a></li> <li><a href="#156">method <b class="cmd">generate-stub-function</b></a></li> <li><a href="#157">method <b class="cmd">IncludeAdd</b> <i class="arg">headervar</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#158">method <b class="cmd">generate-tcl-loader</b></a></li> <li><a href="#159">method <b class="cmd">generate-tcl-pre</b></a></li> <li><a href="#160">method <b class="cmd">generate-tcl-post</b></a></li> <li><a href="#161">method <b class="cmd">linktype</b></a></li> <li><a href="#162">method <b class="cmd">Ofile</b> <i class="arg">filename</i></a></li> <li><a href="#163">method <b class="cmd">project-static-packages</b></a></li> <li><a href="#164">method <b class="cmd">toolset-include-directory</b></a></li> <li><a href="#165">method <b class="cmd">target</b> <i class="arg">method</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#166">method <b class="cmd">project-compile-products</b></a></li> <li><a href="#167">method <b class="cmd">generate-loader-module</b></a></li> <li><a href="#168">method <b class="cmd">project-compile-products</b></a></li> <li><a href="#169">method <b class="cmd">linker-products</b> <i class="arg">configdict</i></a></li> <li><a href="#170">method <b class="cmd">initialize</b></a></li> <li><a href="#171">variable <b class="cmd">make_object</b></a></li> <li><a href="#172">method <b class="cmd">_MorphPatterns</b></a></li> <li><a href="#173">method <b class="cmd">add</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#174">method <b class="cmd">install-headers</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#175">method <b class="cmd">make {} _preamble</b></a></li> <li><a href="#176">method <b class="cmd">make {} pkginfo</b></a></li> <li><a href="#177">method <b class="cmd">make {} objects</b></a></li> <li><a href="#178">method <b class="cmd">make {} object</b> <i class="arg">name</i></a></li> <li><a href="#179">method <b class="cmd">make {} reset</b></a></li> <li><a href="#180">method <b class="cmd">make {} trigger</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#181">method <b class="cmd">make {} depends</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#182">method <b class="cmd">make {} filename</b> <i class="arg">name</i></a></li> <li><a href="#183">method <b class="cmd">make {} target</b> <i class="arg">name</i> <i class="arg">Info</i> <i class="arg">body</i></a></li> <li><a href="#184">method <b class="cmd">make {} todo</b></a></li> <li><a href="#185">method <b class="cmd">make {} do</b></a></li> <li><a href="#186">method <b class="cmd">child</b> <i class="arg">which</i></a></li> <li><a href="#187">method <b class="cmd">generate-c</b></a></li> <li><a href="#188">method <b class="cmd">generate-h</b></a></li> <li><a href="#189">method <b class="cmd">generate-loader</b></a></li> <li><a href="#190">method <b class="cmd">initialize</b></a></li> <li><a href="#191">method <b class="cmd">implement</b> <i class="arg">path</i></a></li> <li><a href="#192">method <b class="cmd">linktype</b></a></li> <li><a href="#193">method <b class="cmd">_MorphPatterns</b></a></li> <li><a href="#194">method <b class="cmd">constructor</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#195">method <b class="cmd">add_object</b> <i class="arg">object</i></a></li> <li><a href="#196">method <b class="cmd">add_project</b> <i class="arg">pkg</i> <i class="arg">info</i> <span class="opt">?<i class="arg">oodefine</i> <b class="const"></b>?</span></a></li> <li><a href="#197">method <b class="cmd">add_tool</b> <i class="arg">pkg</i> <i class="arg">info</i> <span class="opt">?<i class="arg">oodefine</i> <b class="const"></b>?</span></a></li> <li><a href="#198">method <b class="cmd">build-tclcore</b></a></li> <li><a href="#199">method <b class="cmd">child</b> <i class="arg">which</i></a></li> <li><a href="#200">method <b class="cmd">linktype</b></a></li> <li><a href="#201">method <b class="cmd">project</b> <i class="arg">pkg</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#202">method <b class="cmd">tclcore</b></a></li> <li><a href="#203">method <b class="cmd">tkcore</b></a></li> <li><a href="#204">method <b class="cmd"><a href="../tool/tool.html">tool</a></b> <i class="arg">pkg</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#205">method <b class="cmd">clean</b> <i class="arg">PATH</i></a></li> <li><a href="#206">method <b class="cmd">project-compile-products</b></a></li> <li><a href="#207">method <b class="cmd">go</b></a></li> <li><a href="#208">method <b class="cmd">generate-decls</b> <i class="arg">pkgname</i> <i class="arg">path</i></a></li> <li><a href="#209">method <b class="cmd">implement</b> <i class="arg">path</i></a></li> <li><a href="#210">method <b class="cmd">generate-make</b> <i class="arg">path</i></a></li> <li><a href="#211">method <b class="cmd">linktype</b></a></li> <li><a href="#212">method <b class="cmd">package-ifneeded</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#213">method <b class="cmd">shared_library</b> <span class="opt">?<i class="arg">filename</i> <b class="const"></b>?</span></a></li> <li><a href="#214">method <b class="cmd">static_library</b> <span class="opt">?<i class="arg">filename</i> <b class="const"></b>?</span></a></li> <li><a href="#215">method <b class="cmd">build-tclkit_main</b> <i class="arg">PROJECT</i> <i class="arg">PKG_OBJS</i></a></li> <li><a href="#216">method <b class="cmd">Collate_Source</b> <i class="arg">CWD</i></a></li> <li><a href="#217">method <b class="cmd">wrap</b> <i class="arg">PWD</i> <i class="arg">exename</i> <i class="arg">vfspath</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#218">classmethod <b class="cmd">Sandbox</b> <i class="arg">object</i></a></li> <li><a href="#219">classmethod <b class="cmd">select</b> <i class="arg">object</i></a></li> <li><a href="#220">classmethod <b class="cmd">claim_option</b></a></li> <li><a href="#221">classmethod <b class="cmd">claim_object</b> <i class="arg">object</i></a></li> <li><a href="#222">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></li> <li><a href="#223">method <b class="cmd">scm_info</b></a></li> <li><a href="#224">method <b class="cmd">DistroMixIn</b></a></li> <li><a href="#225">method <b class="cmd">Sandbox</b></a></li> <li><a href="#226">method <b class="cmd">SrcDir</b></a></li> <li><a href="#227">method <b class="cmd">ScmTag</b></a></li> <li><a href="#228">method <b class="cmd">ScmClone</b></a></li> <li><a href="#229">method <b class="cmd">ScmUnpack</b></a></li> <li><a href="#230">method <b class="cmd">ScmUpdate</b></a></li> <li><a href="#231">method <b class="cmd">Unpack</b></a></li> <li><a href="#232">classmethod <b class="cmd">claim_object</b> <i class="arg">object</i></a></li> <li><a href="#233">classmethod <b class="cmd">claim_option</b></a></li> <li><a href="#234">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></li> <li><a href="#235">method <b class="cmd">ScmUnpack</b></a></li> <li><a href="#236">classmethod <b class="cmd">claim_object</b> <i class="arg">obj</i></a></li> <li><a href="#237">classmethod <b class="cmd">claim_option</b></a></li> <li><a href="#238">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></li> <li><a href="#239">method <b class="cmd">scm_info</b></a></li> <li><a href="#240">method <b class="cmd">ScmClone</b></a></li> <li><a href="#241">method <b class="cmd">ScmTag</b></a></li> <li><a href="#242">method <b class="cmd">ScmUnpack</b></a></li> <li><a href="#243">method <b class="cmd">ScmUpdate</b></a></li> <li><a href="#244">classmethod <b class="cmd">claim_object</b> <i class="arg">obj</i></a></li> <li><a href="#245">classmethod <b class="cmd">claim_option</b></a></li> <li><a href="#246">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></li> <li><a href="#247">method <b class="cmd">ScmTag</b></a></li> <li><a href="#248">method <b class="cmd">ScmUnpack</b></a></li> <li><a href="#249">method <b class="cmd">ScmUpdate</b></a></li> <li><a href="#250">method <b class="cmd">_MorphPatterns</b></a></li> <li><a href="#251">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></li> <li><a href="#252">method <b class="cmd">child</b> <i class="arg">which</i></a></li> <li><a href="#253">method <b class="cmd">compile</b></a></li> <li><a href="#254">method <b class="cmd">go</b></a></li> <li><a href="#255">method <b class="cmd">install</b> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#256">method <b class="cmd">linktype</b></a></li> <li><a href="#257">method <b class="cmd">linker-products</b> <i class="arg">configdict</i></a></li> <li><a href="#258">method <b class="cmd">linker-external</b> <i class="arg">configdict</i></a></li> <li><a href="#259">method <b class="cmd">linker-extra</b> <i class="arg">configdict</i></a></li> <li><a href="#260">method <b class="cmd">env-bootstrap</b></a></li> <li><a href="#261">method <b class="cmd">env-exec</b></a></li> <li><a href="#262">method <b class="cmd">env-install</b></a></li> <li><a href="#263">method <b class="cmd">env-load</b></a></li> <li><a href="#264">method <b class="cmd">env-present</b></a></li> <li><a href="#265">method <b class="cmd">sources</b></a></li> <li><a href="#266">method <b class="cmd"><a href="../../../../index.html#update">update</a></b></a></li> <li><a href="#267">method <b class="cmd">unpack</b></a></li> <li><a href="#268">method <b class="cmd">env-bootstrap</b></a></li> <li><a href="#269">method <b class="cmd">env-present</b></a></li> <li><a href="#270">method <b class="cmd">linktype</b></a></li> <li><a href="#271">method <b class="cmd">env-bootstrap</b></a></li> <li><a href="#272">method <b class="cmd">env-install</b></a></li> <li><a href="#273">method <b class="cmd">env-present</b></a></li> <li><a href="#274">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#275">method <b class="cmd">kettle</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#276">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#277">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#278">method <b class="cmd">env-bootstrap</b></a></li> <li><a href="#279">method <b class="cmd">env-install</b></a></li> <li><a href="#280">method <b class="cmd">env-present</b></a></li> <li><a href="#281">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#282">method <b class="cmd">install-module</b> <i class="arg">DEST</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#283">method <b class="cmd">env-bootstrap</b></a></li> <li><a href="#284">method <b class="cmd">env-install</b></a></li> <li><a href="#285">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#286">method <b class="cmd">install-module</b> <i class="arg">DEST</i> <span class="opt">?<i class="arg">args</i>?</span></a></li> <li><a href="#287">method <b class="cmd">clean</b></a></li> <li><a href="#288">method <b class="cmd">env-install</b></a></li> <li><a href="#289">method <b class="cmd">project-compile-products</b></a></li> <li><a href="#290">method <b class="cmd">ComputeInstall</b></a></li> <li><a href="#291">method <b class="cmd">go</b></a></li> <li><a href="#292">method <b class="cmd">linker-products</b> <i class="arg">configdict</i></a></li> <li><a href="#293">method <b class="cmd">project-static-packages</b></a></li> <li><a href="#294">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></li> <li><a href="#295">method <b class="cmd">compile</b></a></li> <li><a href="#296">method <b class="cmd">Configure</b></a></li> <li><a href="#297">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#298">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#299">method <b class="cmd">install</b> <i class="arg">DEST</i></a></li> <li><a href="#300">method <b class="cmd">env-bootstrap</b></a></li> <li><a href="#301">method <b class="cmd">env-present</b></a></li> <li><a href="#302">method <b class="cmd">env-install</b></a></li> <li><a href="#303">method <b class="cmd">go</b></a></li> <li><a href="#304">method <b class="cmd">linktype</b></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>The Practcl module is a tool for integrating large modules for C API Tcl code that requires custom Tcl types and TclOO objects.</p> <p>The concept with Practcl is that is a single file package that can assist any tcl based project with distribution, compilation, linking, VFS preparation, executable assembly, and installation. Practcl also allows one project to invoke the build system from another project, allowing complex projects such as a statically linked basekit to be assembled with relative ease.</p> <p>Practcl ships as a single file, and aside from a Tcl 8.6 interpreter, has no external dependencies.</p> <p>Making a practcl project</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">Commands</a></h2> <dl class="doctools_definitions"> <dt><a name="1">proc <b class="cmd">practcl::cat</b> <i class="arg">fname</i></a></dt> <dd><p>Concatenate a file</p></dd> <dt><a name="2">proc <b class="cmd">practcl::docstrip</b> <i class="arg">text</i></a></dt> <dd><p>Strip the global comments from tcl code. Used to prevent the documentation markup comments from clogging up files intended for distribution in machine readable format.</p></dd> <dt><a name="3">proc <b class="cmd">putb</b> <span class="opt">?<i class="arg">map</i>?</span> <i class="arg">text</i></a></dt> <dd><p>Append a line of text to a variable. Optionally apply a string mapping.</p></dd> <dt><a name="4">proc <b class="cmd"><a href="../../../../index.html#proc">Proc</a></b> <i class="arg">name</i> <i class="arg">arglist</i> <i class="arg">body</i></a></dt> <dd><p>Generate a proc if no command already exists by that name</p></dd> <dt><a name="5">proc <b class="cmd">noop</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>A command to do nothing. A handy way of negating an instruction without having to comment it completely out. It's also a handy attachment point for an object to be named later</p></dd> <dt><a name="6">proc <b class="cmd">practcl::debug</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="7">proc <b class="cmd">practcl::doexec</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Drop in a static copy of Tcl</p></dd> <dt><a name="8">proc <b class="cmd">practcl::doexec_in</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="9">proc <b class="cmd">practcl::dotclexec</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="10">proc <b class="cmd">practcl::domake</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="11">proc <b class="cmd">practcl::domake.tcl</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="12">proc <b class="cmd">practcl::fossil</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="13">proc <b class="cmd">practcl::fossil_status</b> <i class="arg">dir</i></a></dt> <dd></dd> <dt><a name="14">proc <b class="cmd">practcl::os</b></a></dt> <dd></dd> <dt><a name="15">proc <b class="cmd">practcl::mkzip</b> <i class="arg">exename</i> <i class="arg">barekit</i> <i class="arg">vfspath</i></a></dt> <dd><p>Build a zipfile. On tcl8.6 this invokes the native Zip implementation on older interpreters this invokes zip via exec</p></dd> <dt><a name="16">proc <b class="cmd">practcl::sort_dict</b> <i class="arg">list</i></a></dt> <dd><p>Dictionary sort a key/value list. Needed because pre tcl8.6 does not have <em>lsort -stride 2</em></p></dd> <dt><a name="17">proc <b class="cmd">practcl::local_os</b></a></dt> <dd></dd> <dt><a name="18">proc <b class="cmd">practcl::config.tcl</b> <i class="arg">path</i></a></dt> <dd><p>Detect local platform</p></dd> <dt><a name="19">proc <b class="cmd">practcl::read_configuration</b> <i class="arg">path</i></a></dt> <dd></dd> <dt><a name="20">proc <b class="cmd">practcl::tcllib_require</b> <i class="arg">pkg</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Try to load a package, and failing that retrieve tcllib</p></dd> <dt><a name="21">proc <b class="cmd">practcl::platform::tcl_core_options</b> <i class="arg">os</i></a></dt> <dd></dd> <dt><a name="22">proc <b class="cmd">practcl::platform::tk_core_options</b> <i class="arg">os</i></a></dt> <dd></dd> <dt><a name="23">proc <b class="cmd">practcl::read_rc_file</b> <i class="arg">filename</i> <span class="opt">?<i class="arg">localdat</i> <b class="const"></b>?</span></a></dt> <dd><p>Read a stylized key/value list stored in a file</p></dd> <dt><a name="24">proc <b class="cmd">practcl::read_sh_subst</b> <i class="arg">line</i> <i class="arg">info</i></a></dt> <dd><p>Converts a XXX.sh file into a series of Tcl variables</p></dd> <dt><a name="25">proc <b class="cmd">practcl::read_sh_file</b> <i class="arg">filename</i> <span class="opt">?<i class="arg">localdat</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="26">proc <b class="cmd">practcl::read_Config.sh</b> <i class="arg">filename</i></a></dt> <dd><p>A simpler form of read_sh_file tailored to pulling data from (tcl|tk)Config.sh</p></dd> <dt><a name="27">proc <b class="cmd">practcl::read_Makefile</b> <i class="arg">filename</i></a></dt> <dd><p>A simpler form of read_sh_file tailored to pulling data from a Makefile</p></dd> <dt><a name="28">proc <b class="cmd">practcl::cputs</b> <i class="arg">varname</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Append arguments to a buffer The command works like puts in that each call will also insert a line feed. Unlike puts, blank links in the interstitial are suppressed</p></dd> <dt><a name="29">proc <b class="cmd">practcl::tcl_to_c</b> <i class="arg">body</i></a></dt> <dd></dd> <dt><a name="30">proc <b class="cmd">practcl::_tagblock</b> <i class="arg">text</i> <span class="opt">?<i class="arg">style</i> <b class="const">tcl</b>?</span> <span class="opt">?<i class="arg">note</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="31">proc <b class="cmd">practcl::de_shell</b> <i class="arg">data</i></a></dt> <dd></dd> <dt><a name="32">proc <b class="cmd">practcl::grep</b> <i class="arg">pattern</i> <span class="opt">?<i class="arg">files</i> <b class="const"></b>?</span></a></dt> <dd><p>Search for the pattern <em>pattern</em> amongst $files</p></dd> <dt><a name="33">proc <b class="cmd">practcl::file_lexnormalize</b> <i class="arg">sp</i></a></dt> <dd></dd> <dt><a name="34">proc <b class="cmd">practcl::file_relative</b> <i class="arg">base</i> <i class="arg">dst</i></a></dt> <dd><p>Calculate a relative path between base and dst</p> <p>Example:</p> <pre class="doctools_example"> ::practcl::file_relative ~/build/tcl/unix ~/build/tcl/library > ../library </pre> </dd> <dt><a name="35">proc <b class="cmd">practcl::findByPattern</b> <i class="arg">basedir</i> <i class="arg">patterns</i></a></dt> <dd></dd> <dt><a name="36">proc <b class="cmd">practcl::log</b> <i class="arg">fname</i> <i class="arg">comment</i></a></dt> <dd><p>Record an event in the practcl log</p></dd> <dt><a name="37">proc <b class="cmd">practcl::_pkgindex_simpleIndex</b> <i class="arg">path</i></a></dt> <dd></dd> <dt><a name="38">proc <b class="cmd">practcl::_pkgindex_directory</b> <i class="arg">path</i></a></dt> <dd><p>Return true if the pkgindex file contains any statement other than "package ifneeded" and/or if any package ifneeded loads a DLL</p></dd> <dt><a name="39">proc <b class="cmd">practcl::_pkgindex_path_subdir</b> <i class="arg">path</i></a></dt> <dd><p>Helper function for ::practcl::pkgindex_path</p></dd> <dt><a name="40">proc <b class="cmd">practcl::pkgindex_path</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Index all paths given as though they will end up in the same virtual file system</p></dd> <dt><a name="41">proc <b class="cmd">practcl::installDir</b> <i class="arg">d1</i> <i class="arg">d2</i></a></dt> <dd><p>Delete the contents of <em>d2</em>, and then recusively Ccopy the contents of <em>d1</em> to <em>d2</em>.</p></dd> <dt><a name="42">proc <b class="cmd">practcl::copyDir</b> <i class="arg">d1</i> <i class="arg">d2</i> <span class="opt">?<i class="arg">toplevel</i> <b class="const">1</b>?</span></a></dt> <dd><p>Recursively copy the contents of <em>d1</em> to <em>d2</em></p></dd> <dt><a name="43">proc <b class="cmd">practcl::buildModule</b> <i class="arg">modpath</i></a></dt> <dd></dd> <dt><a name="44">proc <b class="cmd">practcl::installModule</b> <i class="arg">modpath</i> <i class="arg">DEST</i></a></dt> <dd></dd> <dt><a name="45">proc <b class="cmd">practcl::trigger</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Trigger build targets, and recompute dependencies</p> <p>Internals:</p> <pre class="doctools_example"> ::practcl::LOCAL make trigger {*}$args foreach {name obj} [::practcl::LOCAL make objects] { set ::make($name) [$obj do] } </pre> </dd> <dt><a name="46">proc <b class="cmd">practcl::depends</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Calculate if a dependency for any of the arguments needs to be fulfilled or rebuilt.</p> <p>Internals:</p> <pre class="doctools_example"> ::practcl::LOCAL make depends {*}$args </pre> </dd> <dt><a name="47">proc <b class="cmd">practcl::target</b> <i class="arg">name</i> <i class="arg">info</i> <span class="opt">?<i class="arg">action</i> <b class="const"></b>?</span></a></dt> <dd><p>Declare a build product. This proc is just a shorthand for <em>::practcl::LOCAL make task $name $info $action</em></p> <p>Registering a build product with this command will create an entry in the global array, and populate a value in the global array.</p> <p>Internals:</p> <pre class="doctools_example"> set obj [::practcl::LOCAL make task $name $info $action] set ::make($name) 0 set filename [$obj define get filename] if {$filename ne {}} { set ::target($name) $filename } </pre> </dd> </dl> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Classes</a></h2> <div id="subsection1" class="doctools_subsection"><h3><a name="subsection1">Class practcl::doctool</a></h3> <pre class="doctools_example">{ set authors { {John Doe} {[email protected]} {Tom RichardHarry} {[email protected]} } # Create the object ::practcl::doctool create AutoDoc set fout [open [file join $moddir module.tcl] w] foreach file [glob [file join $srcdir *.tcl]] { set content [::practcl::cat [file join $srcdir $file]] # Scan the file AutoDoc scan_text $content # Strip the comments from the distribution puts $fout [::practcl::docstrip $content] } # Write out the manual page set manout [open [file join $moddir module.man] w] dict set args header [string map $modmap [::practcl::cat [file join $srcdir manual.txt]]] dict set args footer [string map $modmap [::practcl::cat [file join $srcdir footer.txt]]] dict set args authors $authors puts $manout [AutoDoc manpage {*}$args] close $manout }</pre> <p>Tool for build scripts to dynamically generate manual files from comments in source code files</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="48">method <b class="cmd">constructor</b></a></dt> <dd></dd> <dt><a name="49">method <b class="cmd">argspec</b> <i class="arg">argspec</i></a></dt> <dd><p>Process an argument list into an informational dict. This method also understands non-positional arguments expressed in the notation of Tip 471 <a href="https://core.tcl-lang.org/tips/doc/trunk/tip/479.md">https://core.tcl-lang.org/tips/doc/trunk/tip/479.md</a>.</p> <p>The output will be a dictionary of all of the fields and whether the fields are <b class="const">positional</b>, <b class="const">mandatory</b>, and whether they have a <b class="const">default</b> value.</p> <p>Example:</p> <pre class="doctools_example"> my argspec {a b {c 10}} > a {positional 1 mandatory 1} b {positional 1 mandatory 1} c {positional 1 mandatory 0 default 10} </pre> </dd> <dt><a name="50">method <b class="cmd"><a href="../../../../index.html#comment">comment</a></b> <i class="arg">block</i></a></dt> <dd><p>Convert a block of comments into an informational dictionary. If lines in the comment start with a single word ending in a colon, all subsequent lines are appended to a dictionary field of that name. If no fields are given, all of the text is appended to the <b class="const">description</b> field.</p> <p>Example:</p> <pre class="doctools_example"> my comment {Does something cool} > description {Does something cool} my comment { title : Something really cool author : Sean Woods author : John Doe description : This does something really cool! } > description {This does something really cool!} title {Something really cool} author {Sean Woods John Doe} </pre> </dd> <dt><a name="51">method <b class="cmd">keyword.Annotation</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">type</i> <i class="arg">name</i> <i class="arg">body</i></a></dt> <dd></dd> <dt><a name="52">method <b class="cmd">keyword.Class</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <i class="arg">body</i></a></dt> <dd><p>Process an oo::objdefine call that modifies the class object itself</p></dd> <dt><a name="53">method <b class="cmd">keyword.class</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <i class="arg">body</i></a></dt> <dd><p>Process an oo::define, clay::define, etc statement.</p></dd> <dt><a name="54">method <b class="cmd">keyword.Class_Method</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Process a statement for a clay style class method</p></dd> <dt><a name="55">method <b class="cmd">keyword.method</b> <i class="arg">resultvar</i> <i class="arg">commentblock</i> <i class="arg">name</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Process a statement for a tcloo style object method</p></dd> <dt><a name="56">method <b class="cmd">keyword.proc</b> <i class="arg">commentblock</i> <i class="arg">name</i> <i class="arg">argspec</i></a></dt> <dd><p>Process a proc statement</p></dd> <dt><a name="57">method <b class="cmd">reset</b></a></dt> <dd><p>Reset the state of the object and its embedded coroutine</p></dd> <dt><a name="58">method <b class="cmd">Main</b></a></dt> <dd><p>Main body of the embedded coroutine for the object</p></dd> <dt><a name="59">method <b class="cmd">section.method</b> <i class="arg">keyword</i> <i class="arg">method</i> <i class="arg">minfo</i></a></dt> <dd><p>Generate the manual page text for a method or proc</p></dd> <dt><a name="60">method <b class="cmd">section.annotation</b> <i class="arg">type</i> <i class="arg">name</i> <i class="arg">iinfo</i></a></dt> <dd></dd> <dt><a name="61">method <b class="cmd">section.class</b> <i class="arg">class_name</i> <i class="arg">class_info</i></a></dt> <dd><p>Generate the manual page text for a class</p></dd> <dt><a name="62">method <b class="cmd">section.command</b> <i class="arg">procinfo</i></a></dt> <dd><p>Generate the manual page text for the commands section</p></dd> <dt><a name="63">method <b class="cmd"><a href="../../../../index.html#manpage">manpage</a></b> <span class="opt">?<b class="option">header <em>value</em></b>?</span> <span class="opt">?<b class="option">footer <em>value</em></b>?</span> <span class="opt">?<b class="option">authors <em>list</em></b>?</span></a></dt> <dd><p>Generate the manual page. Returns the completed text suitable for saving in .man file. The header argument is a block of doctools text to go in before the machine generated section. footer is a block of doctools text to go in after the machine generated section. authors is a list of individual authors and emails in the form of AUTHOR EMAIL ?AUTHOR EMAIL?...</p></dd> <dt><a name="64">method <b class="cmd">scan_text</b> <i class="arg">text</i></a></dt> <dd><p>Scan a block of text</p></dd> <dt><a name="65">method <b class="cmd">scan_file</b> <i class="arg">filename</i></a></dt> <dd><p>Scan a file of text</p></dd> </dl> </div> <div id="subsection2" class="doctools_subsection"><h3><a name="subsection2">Class practcl::metaclass</a></h3> <p>The metaclass for all practcl objects</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="66">method <b class="cmd">_MorphPatterns</b></a></dt> <dd></dd> <dt><a name="67">method <b class="cmd"><a href="../../../../index.html#define">define</a></b> <i class="arg">submethod</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="68">method <b class="cmd">graft</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="69">method <b class="cmd">initialize</b></a></dt> <dd></dd> <dt><a name="70">method <b class="cmd">link</b> <i class="arg">command</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="71">method <b class="cmd">morph</b> <i class="arg">classname</i></a></dt> <dd></dd> <dt><a name="72">method <b class="cmd">script</b> <i class="arg">script</i></a></dt> <dd></dd> <dt><a name="73">method <b class="cmd">select</b></a></dt> <dd></dd> <dt><a name="74">method <b class="cmd"><a href="../../../../index.html#source">source</a></b> <i class="arg">filename</i></a></dt> <dd></dd> </dl> </div> <div id="subsection3" class="doctools_subsection"><h3><a name="subsection3">Class practcl::toolset</a></h3> <p>Ancestor-less class intended to be a mixin which defines a family of build related behaviors that are modified when targetting either gcc or msvc</p> <p><b class="class">Class Methods</b></p> <dl class="doctools_definitions"> <dt><a name="75">classmethod <b class="cmd">select</b> <i class="arg">object</i></a></dt> <dd><p>Perform the selection for the toolset mixin</p></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="76">method <b class="cmd">config.sh</b></a></dt> <dd><p>find or fake a key/value list describing this project</p></dd> <dt><a name="77">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></dt> <dd><p>Compute the location where the product will be built</p></dd> <dt><a name="78">method <b class="cmd">MakeDir</b> <i class="arg">srcdir</i></a></dt> <dd><p>Return where the Makefile is located relative to <em>srcdir</em>. For this implementation the MakeDir is always srcdir.</p></dd> <dt><a name="79">method <b class="cmd">read_configuration</b></a></dt> <dd><p>Read information about the build process for this package. For this implementation, data is sought in the following locations in the following order: config.tcl (generated by practcl.) PKGConfig.sh. The Makefile</p> <p>If the Makefile needs to be consulted, but does not exist, the Configure method is invoked</p></dd> <dt><a name="80">method <b class="cmd">build-cflags</b> <i class="arg">PROJECT</i> <i class="arg">DEFS</i> <i class="arg">namevar</i> <i class="arg">versionvar</i> <i class="arg">defsvar</i></a></dt> <dd><p>method DEFS This method populates 4 variables: name - The name of the package version - The version of the package defs - C flags passed to the compiler includedir - A list of paths to feed to the compiler for finding headers</p></dd> <dt><a name="81">method <b class="cmd">critcl</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Invoke critcl in an external process</p></dd> </dl> </div> <div id="subsection4" class="doctools_subsection"><h3><a name="subsection4">Class practcl::toolset.gcc</a></h3> <p><em>ancestors</em>: <b class="class">practcl::toolset</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="82">method <b class="cmd">Autoconf</b></a></dt> <dd></dd> <dt><a name="83">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></dt> <dd></dd> <dt><a name="84">method <b class="cmd">ConfigureOpts</b></a></dt> <dd></dd> <dt><a name="85">method <b class="cmd">MakeDir</b> <i class="arg">srcdir</i></a></dt> <dd><p>Detect what directory contains the Makefile template</p></dd> <dt><a name="86">method <b class="cmd">make {} autodetect</b></a></dt> <dd></dd> <dt><a name="87">method <b class="cmd">make {} clean</b></a></dt> <dd></dd> <dt><a name="88">method <b class="cmd">make {} compile</b></a></dt> <dd></dd> <dt><a name="89">method <b class="cmd">make {} install</b> <i class="arg">DEST</i></a></dt> <dd></dd> <dt><a name="90">method <b class="cmd">build-compile-sources</b> <i class="arg">PROJECT</i> <i class="arg">COMPILE</i> <i class="arg">CPPCOMPILE</i> <i class="arg">INCLUDES</i></a></dt> <dd></dd> <dt><a name="91">method <b class="cmd">build-Makefile</b> <i class="arg">path</i> <i class="arg">PROJECT</i></a></dt> <dd></dd> <dt><a name="92">method <b class="cmd">build-library</b> <i class="arg">outfile</i> <i class="arg">PROJECT</i></a></dt> <dd><p>Produce a static or dynamic library</p></dd> <dt><a name="93">method <b class="cmd">build-tclsh</b> <i class="arg">outfile</i> <i class="arg">PROJECT</i> <span class="opt">?<i class="arg">path</i> <b class="const">auto</b>?</span></a></dt> <dd><p>Produce a static executable</p></dd> </dl> </div> <div id="subsection5" class="doctools_subsection"><h3><a name="subsection5">Class practcl::toolset.msvc</a></h3> <p><em>ancestors</em>: <b class="class">practcl::toolset</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="94">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></dt> <dd><p>MSVC always builds in the source directory</p></dd> <dt><a name="95">method <b class="cmd">make {} autodetect</b></a></dt> <dd><p>Do nothing</p></dd> <dt><a name="96">method <b class="cmd">make {} clean</b></a></dt> <dd></dd> <dt><a name="97">method <b class="cmd">make {} compile</b></a></dt> <dd></dd> <dt><a name="98">method <b class="cmd">make {} install</b> <i class="arg">DEST</i></a></dt> <dd></dd> <dt><a name="99">method <b class="cmd">MakeDir</b> <i class="arg">srcdir</i></a></dt> <dd><p>Detect what directory contains the Makefile template</p></dd> <dt><a name="100">method <b class="cmd">NmakeOpts</b></a></dt> <dd></dd> </dl> </div> <div id="subsection6" class="doctools_subsection"><h3><a name="subsection6">Class practcl::make_obj</a></h3> <p><em>ancestors</em>: <b class="class">practcl::metaclass</b></p> <p>A build deliverable object. Normally an object file, header, or tcl script which must be compiled or generated in some way</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="101">method <b class="cmd">constructor</b> <i class="arg">module_object</i> <i class="arg">name</i> <i class="arg">info</i> <span class="opt">?<i class="arg">action_body</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="102">method <b class="cmd"><a href="../../../../index.html#do">do</a></b></a></dt> <dd></dd> <dt><a name="103">method <b class="cmd">check</b></a></dt> <dd></dd> <dt><a name="104">method <b class="cmd">output</b></a></dt> <dd></dd> <dt><a name="105">method <b class="cmd">reset</b></a></dt> <dd></dd> <dt><a name="106">method <b class="cmd">triggers</b></a></dt> <dd></dd> </dl> </div> <div id="subsection7" class="doctools_subsection"><h3><a name="subsection7">Class practcl::object</a></h3> <p><em>ancestors</em>: <b class="class">practcl::metaclass</b></p> <p>A generic Practcl object</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="107">method <b class="cmd">constructor</b> <i class="arg">parent</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="108">method <b class="cmd">child</b> <i class="arg">method</i></a></dt> <dd></dd> <dt><a name="109">method <b class="cmd">go</b></a></dt> <dd></dd> </dl> </div> <div id="subsection8" class="doctools_subsection"><h3><a name="subsection8">Class practcl::dynamic</a></h3> <p>Dynamic blocks do not generate their own .c files, instead the contribute to the amalgamation of the main library file</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="110">method <b class="cmd">cstructure</b> <i class="arg">name</i> <i class="arg">definition</i> <span class="opt">?<i class="arg">argdat</i> <b class="const"></b>?</span></a></dt> <dd><p>Parser functions</p></dd> <dt><a name="111">method <b class="cmd">include</b> <i class="arg">header</i></a></dt> <dd></dd> <dt><a name="112">method <b class="cmd">include_dir</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="113">method <b class="cmd">include_directory</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="114">method <b class="cmd">c_header</b> <i class="arg">body</i></a></dt> <dd></dd> <dt><a name="115">method <b class="cmd">c_code</b> <i class="arg">body</i></a></dt> <dd></dd> <dt><a name="116">method <b class="cmd">c_function</b> <i class="arg">header</i> <i class="arg">body</i> <span class="opt">?<i class="arg">info</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="117">method <b class="cmd">c_tcloomethod</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="118">method <b class="cmd">cmethod</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></dt> <dd><p>Alias to classic name</p></dd> <dt><a name="119">method <b class="cmd">c_tclproc_nspace</b> <i class="arg">nspace</i></a></dt> <dd></dd> <dt><a name="120">method <b class="cmd">c_tclcmd</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="121">method <b class="cmd">c_tclproc_raw</b> <i class="arg">name</i> <i class="arg">body</i> <span class="opt">?<i class="arg">arginfo</i> <b class="const"></b>?</span></a></dt> <dd><p>Alias to classic name</p></dd> <dt><a name="122">method <b class="cmd">tcltype</b> <i class="arg">name</i> <i class="arg">argdat</i></a></dt> <dd></dd> <dt><a name="123">method <b class="cmd">project-compile-products</b></a></dt> <dd><p>Module interactions</p></dd> <dt><a name="124">method <b class="cmd">implement</b> <i class="arg">path</i></a></dt> <dd></dd> <dt><a name="125">method <b class="cmd">initialize</b></a></dt> <dd><p>Practcl internals</p></dd> <dt><a name="126">method <b class="cmd">linktype</b></a></dt> <dd></dd> <dt><a name="127">method <b class="cmd">generate-cfile-constant</b></a></dt> <dd></dd> <dt><a name="128">method <b class="cmd">generate-cfile-header</b></a></dt> <dd></dd> <dt><a name="129">method <b class="cmd">generate-cfile-tclapi</b></a></dt> <dd><p>Generate code that provides implements Tcl API calls</p></dd> <dt><a name="130">method <b class="cmd">generate-loader-module</b></a></dt> <dd><p>Generate code that runs when the package/module is initialized into the interpreter</p></dd> <dt><a name="131">method <b class="cmd">Collate_Source</b> <i class="arg">CWD</i></a></dt> <dd></dd> <dt><a name="132">method <b class="cmd">select</b></a></dt> <dd><p>Once an object marks itself as some flavor of dynamic, stop trying to morph it into something else</p></dd> </dl> </div> <div id="subsection9" class="doctools_subsection"><h3><a name="subsection9">Class practcl::product</a></h3> <p>A deliverable for the build system</p> <p><b class="class">Class Methods</b></p> <dl class="doctools_definitions"> <dt><a name="133">classmethod <b class="cmd">select</b> <i class="arg">object</i></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="134">method <b class="cmd">code</b> <i class="arg">section</i> <i class="arg">body</i></a></dt> <dd></dd> <dt><a name="135">method <b class="cmd">Collate_Source</b> <i class="arg">CWD</i></a></dt> <dd></dd> <dt><a name="136">method <b class="cmd">project-compile-products</b></a></dt> <dd></dd> <dt><a name="137">method <b class="cmd">generate-debug</b> <span class="opt">?<i class="arg">spaces</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="138">method <b class="cmd">generate-cfile-constant</b></a></dt> <dd></dd> <dt><a name="139">method <b class="cmd">generate-cfile-public-structure</b></a></dt> <dd><p>Populate const static data structures</p></dd> <dt><a name="140">method <b class="cmd">generate-cfile-header</b></a></dt> <dd></dd> <dt><a name="141">method <b class="cmd">generate-cfile-global</b></a></dt> <dd></dd> <dt><a name="142">method <b class="cmd">generate-cfile-private-typedef</b></a></dt> <dd></dd> <dt><a name="143">method <b class="cmd">generate-cfile-private-structure</b></a></dt> <dd></dd> <dt><a name="144">method <b class="cmd">generate-cfile-functions</b></a></dt> <dd><p>Generate code that provides subroutines called by Tcl API methods</p></dd> <dt><a name="145">method <b class="cmd">generate-cfile-tclapi</b></a></dt> <dd><p>Generate code that provides implements Tcl API calls</p></dd> <dt><a name="146">method <b class="cmd">generate-hfile-public-define</b></a></dt> <dd></dd> <dt><a name="147">method <b class="cmd">generate-hfile-public-macro</b></a></dt> <dd></dd> <dt><a name="148">method <b class="cmd">generate-hfile-public-typedef</b></a></dt> <dd></dd> <dt><a name="149">method <b class="cmd">generate-hfile-public-structure</b></a></dt> <dd></dd> <dt><a name="150">method <b class="cmd">generate-hfile-public-headers</b></a></dt> <dd></dd> <dt><a name="151">method <b class="cmd">generate-hfile-public-function</b></a></dt> <dd></dd> <dt><a name="152">method <b class="cmd">generate-hfile-public-includes</b></a></dt> <dd></dd> <dt><a name="153">method <b class="cmd">generate-hfile-public-verbatim</b></a></dt> <dd></dd> <dt><a name="154">method <b class="cmd">generate-loader-external</b></a></dt> <dd></dd> <dt><a name="155">method <b class="cmd">generate-loader-module</b></a></dt> <dd></dd> <dt><a name="156">method <b class="cmd">generate-stub-function</b></a></dt> <dd></dd> <dt><a name="157">method <b class="cmd">IncludeAdd</b> <i class="arg">headervar</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="158">method <b class="cmd">generate-tcl-loader</b></a></dt> <dd></dd> <dt><a name="159">method <b class="cmd">generate-tcl-pre</b></a></dt> <dd><p>This methods generates any Tcl script file which is required to pre-initialize the C library</p></dd> <dt><a name="160">method <b class="cmd">generate-tcl-post</b></a></dt> <dd></dd> <dt><a name="161">method <b class="cmd">linktype</b></a></dt> <dd></dd> <dt><a name="162">method <b class="cmd">Ofile</b> <i class="arg">filename</i></a></dt> <dd></dd> <dt><a name="163">method <b class="cmd">project-static-packages</b></a></dt> <dd><p>Methods called by the master project</p></dd> <dt><a name="164">method <b class="cmd">toolset-include-directory</b></a></dt> <dd><p>Methods called by the toolset</p></dd> <dt><a name="165">method <b class="cmd">target</b> <i class="arg">method</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> </dl> </div> <div id="subsection10" class="doctools_subsection"><h3><a name="subsection10">Class practcl::product.cheader</a></h3> <p><em>ancestors</em>: <b class="class">practcl::product</b></p> <p>A product which generated from a C header file. Which is to say, nothing.</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="166">method <b class="cmd">project-compile-products</b></a></dt> <dd></dd> <dt><a name="167">method <b class="cmd">generate-loader-module</b></a></dt> <dd></dd> </dl> </div> <div id="subsection11" class="doctools_subsection"><h3><a name="subsection11">Class practcl::product.csource</a></h3> <p><em>ancestors</em>: <b class="class">practcl::product</b></p> <p>A product which generated from a C source file. Normally an object (.o) file.</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="168">method <b class="cmd">project-compile-products</b></a></dt> <dd></dd> </dl> </div> <div id="subsection12" class="doctools_subsection"><h3><a name="subsection12">Class practcl::product.clibrary</a></h3> <p><em>ancestors</em>: <b class="class">practcl::product</b></p> <p>A product which is generated from a compiled C library. Usually a .a or a .dylib file, but in complex cases may actually just be a conduit for one project to integrate the source code of another</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="169">method <b class="cmd">linker-products</b> <i class="arg">configdict</i></a></dt> <dd></dd> </dl> </div> <div id="subsection13" class="doctools_subsection"><h3><a name="subsection13">Class practcl::product.dynamic</a></h3> <p><em>ancestors</em>: <b class="class">practcl::dynamic</b> <b class="class">practcl::product</b></p> <p>A product which is generated from C code that itself is generated by practcl or some other means. This C file may or may not produce its own .o file, depending on whether it is eligible to become part of an amalgamation</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="170">method <b class="cmd">initialize</b></a></dt> <dd></dd> </dl> </div> <div id="subsection14" class="doctools_subsection"><h3><a name="subsection14">Class practcl::product.critcl</a></h3> <p><em>ancestors</em>: <b class="class">practcl::dynamic</b> <b class="class">practcl::product</b></p> <p>A binary product produced by critcl. Note: The implementation is not written yet, this class does nothing.</p> </div> <div id="subsection15" class="doctools_subsection"><h3><a name="subsection15">Class practcl::module</a></h3> <p><em>ancestors</em>: <b class="class">practcl::object</b> <b class="class">practcl::product.dynamic</b></p> <p>In the end, all C code must be loaded into a module This will either be a dynamically loaded library implementing a tcl extension, or a compiled in segment of a custom shell/app</p> <p><b class="class">Variable</b></p> <dl class="doctools_definitions"> <dt><a name="171">variable <b class="cmd">make_object</b></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="172">method <b class="cmd">_MorphPatterns</b></a></dt> <dd></dd> <dt><a name="173">method <b class="cmd">add</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="174">method <b class="cmd">install-headers</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="175">method <b class="cmd">make {} _preamble</b></a></dt> <dd></dd> <dt><a name="176">method <b class="cmd">make {} pkginfo</b></a></dt> <dd></dd> <dt><a name="177">method <b class="cmd">make {} objects</b></a></dt> <dd><p>Return a dictionary of all handles and associated objects</p></dd> <dt><a name="178">method <b class="cmd">make {} object</b> <i class="arg">name</i></a></dt> <dd><p>Return the object associated with handle <em>name</em></p></dd> <dt><a name="179">method <b class="cmd">make {} reset</b></a></dt> <dd><p>Reset all deputy objects</p></dd> <dt><a name="180">method <b class="cmd">make {} trigger</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Exercise the triggers method for all handles listed</p></dd> <dt><a name="181">method <b class="cmd">make {} depends</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Exercise the check method for all handles listed</p></dd> <dt><a name="182">method <b class="cmd">make {} filename</b> <i class="arg">name</i></a></dt> <dd><p>Return the file name of the build product for the listed handle</p></dd> <dt><a name="183">method <b class="cmd">make {} target</b> <i class="arg">name</i> <i class="arg">Info</i> <i class="arg">body</i></a></dt> <dd></dd> <dt><a name="184">method <b class="cmd">make {} todo</b></a></dt> <dd><p>Return a list of handles for object which return true for the do method</p></dd> <dt><a name="185">method <b class="cmd">make {} do</b></a></dt> <dd><p>For each target exercise the action specified in the <em>action</em> definition if the <em>do</em> method returns true</p></dd> <dt><a name="186">method <b class="cmd">child</b> <i class="arg">which</i></a></dt> <dd></dd> <dt><a name="187">method <b class="cmd">generate-c</b></a></dt> <dd><p>This methods generates the contents of an amalgamated .c file which implements the loader for a batch of tools</p></dd> <dt><a name="188">method <b class="cmd">generate-h</b></a></dt> <dd><p>This methods generates the contents of an amalgamated .h file which describes the public API of this module</p></dd> <dt><a name="189">method <b class="cmd">generate-loader</b></a></dt> <dd></dd> <dt><a name="190">method <b class="cmd">initialize</b></a></dt> <dd></dd> <dt><a name="191">method <b class="cmd">implement</b> <i class="arg">path</i></a></dt> <dd></dd> <dt><a name="192">method <b class="cmd">linktype</b></a></dt> <dd></dd> </dl> </div> <div id="subsection16" class="doctools_subsection"><h3><a name="subsection16">Class practcl::project</a></h3> <p><em>ancestors</em>: <b class="class">practcl::module</b></p> <p>A toplevel project that is a collection of other projects</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="193">method <b class="cmd">_MorphPatterns</b></a></dt> <dd></dd> <dt><a name="194">method <b class="cmd">constructor</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="195">method <b class="cmd">add_object</b> <i class="arg">object</i></a></dt> <dd></dd> <dt><a name="196">method <b class="cmd">add_project</b> <i class="arg">pkg</i> <i class="arg">info</i> <span class="opt">?<i class="arg">oodefine</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="197">method <b class="cmd">add_tool</b> <i class="arg">pkg</i> <i class="arg">info</i> <span class="opt">?<i class="arg">oodefine</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="198">method <b class="cmd">build-tclcore</b></a></dt> <dd><p>Compile the Tcl core. If the define <em>tk</em> is true, compile the Tk core as well</p></dd> <dt><a name="199">method <b class="cmd">child</b> <i class="arg">which</i></a></dt> <dd></dd> <dt><a name="200">method <b class="cmd">linktype</b></a></dt> <dd></dd> <dt><a name="201">method <b class="cmd">project</b> <i class="arg">pkg</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Exercise the methods of a sub-object</p></dd> <dt><a name="202">method <b class="cmd">tclcore</b></a></dt> <dd></dd> <dt><a name="203">method <b class="cmd">tkcore</b></a></dt> <dd></dd> <dt><a name="204">method <b class="cmd"><a href="../tool/tool.html">tool</a></b> <i class="arg">pkg</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> </dl> </div> <div id="subsection17" class="doctools_subsection"><h3><a name="subsection17">Class practcl::library</a></h3> <p><em>ancestors</em>: <b class="class">practcl::project</b></p> <p>A toplevel project that produces a library</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="205">method <b class="cmd">clean</b> <i class="arg">PATH</i></a></dt> <dd></dd> <dt><a name="206">method <b class="cmd">project-compile-products</b></a></dt> <dd></dd> <dt><a name="207">method <b class="cmd">go</b></a></dt> <dd></dd> <dt><a name="208">method <b class="cmd">generate-decls</b> <i class="arg">pkgname</i> <i class="arg">path</i></a></dt> <dd></dd> <dt><a name="209">method <b class="cmd">implement</b> <i class="arg">path</i></a></dt> <dd></dd> <dt><a name="210">method <b class="cmd">generate-make</b> <i class="arg">path</i></a></dt> <dd><p>Backward compadible call</p></dd> <dt><a name="211">method <b class="cmd">linktype</b></a></dt> <dd></dd> <dt><a name="212">method <b class="cmd">package-ifneeded</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Create a "package ifneeded" Args are a list of aliases for which this package will answer to</p></dd> <dt><a name="213">method <b class="cmd">shared_library</b> <span class="opt">?<i class="arg">filename</i> <b class="const"></b>?</span></a></dt> <dd></dd> <dt><a name="214">method <b class="cmd">static_library</b> <span class="opt">?<i class="arg">filename</i> <b class="const"></b>?</span></a></dt> <dd></dd> </dl> </div> <div id="subsection18" class="doctools_subsection"><h3><a name="subsection18">Class practcl::tclkit</a></h3> <p><em>ancestors</em>: <b class="class">practcl::library</b></p> <p>A toplevel project that produces a self-contained executable</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="215">method <b class="cmd">build-tclkit_main</b> <i class="arg">PROJECT</i> <i class="arg">PKG_OBJS</i></a></dt> <dd></dd> <dt><a name="216">method <b class="cmd">Collate_Source</b> <i class="arg">CWD</i></a></dt> <dd></dd> <dt><a name="217">method <b class="cmd">wrap</b> <i class="arg">PWD</i> <i class="arg">exename</i> <i class="arg">vfspath</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Wrap an executable</p></dd> </dl> </div> <div id="subsection19" class="doctools_subsection"><h3><a name="subsection19">Class practcl::distribution</a></h3> <p>Standalone class to manage code distribution This class is intended to be mixed into another class (Thus the lack of ancestors)</p> <p><b class="class">Class Methods</b></p> <dl class="doctools_definitions"> <dt><a name="218">classmethod <b class="cmd">Sandbox</b> <i class="arg">object</i></a></dt> <dd></dd> <dt><a name="219">classmethod <b class="cmd">select</b> <i class="arg">object</i></a></dt> <dd></dd> <dt><a name="220">classmethod <b class="cmd">claim_option</b></a></dt> <dd></dd> <dt><a name="221">classmethod <b class="cmd">claim_object</b> <i class="arg">object</i></a></dt> <dd></dd> <dt><a name="222">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="223">method <b class="cmd">scm_info</b></a></dt> <dd></dd> <dt><a name="224">method <b class="cmd">DistroMixIn</b></a></dt> <dd></dd> <dt><a name="225">method <b class="cmd">Sandbox</b></a></dt> <dd></dd> <dt><a name="226">method <b class="cmd">SrcDir</b></a></dt> <dd></dd> <dt><a name="227">method <b class="cmd">ScmTag</b></a></dt> <dd></dd> <dt><a name="228">method <b class="cmd">ScmClone</b></a></dt> <dd></dd> <dt><a name="229">method <b class="cmd">ScmUnpack</b></a></dt> <dd></dd> <dt><a name="230">method <b class="cmd">ScmUpdate</b></a></dt> <dd></dd> <dt><a name="231">method <b class="cmd">Unpack</b></a></dt> <dd></dd> </dl> </div> <div id="subsection20" class="doctools_subsection"><h3><a name="subsection20">Class practcl::distribution.snapshot</a></h3> <p><em>ancestors</em>: <b class="class">practcl::distribution</b></p> <p>A file distribution from zip, tarball, or other non-scm archive format</p> <p><b class="class">Class Methods</b></p> <dl class="doctools_definitions"> <dt><a name="232">classmethod <b class="cmd">claim_object</b> <i class="arg">object</i></a></dt> <dd></dd> <dt><a name="233">classmethod <b class="cmd">claim_option</b></a></dt> <dd></dd> <dt><a name="234">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="235">method <b class="cmd">ScmUnpack</b></a></dt> <dd></dd> </dl> </div> <div id="subsection21" class="doctools_subsection"><h3><a name="subsection21">Class practcl::distribution.fossil</a></h3> <p><em>ancestors</em>: <b class="class">practcl::distribution</b></p> <p>A file distribution based on fossil</p> <p><b class="class">Class Methods</b></p> <dl class="doctools_definitions"> <dt><a name="236">classmethod <b class="cmd">claim_object</b> <i class="arg">obj</i></a></dt> <dd><p>Check for markers in the metadata</p></dd> <dt><a name="237">classmethod <b class="cmd">claim_option</b></a></dt> <dd></dd> <dt><a name="238">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></dt> <dd><p>Check for markers in the source root</p></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="239">method <b class="cmd">scm_info</b></a></dt> <dd></dd> <dt><a name="240">method <b class="cmd">ScmClone</b></a></dt> <dd><p>Clone the source</p></dd> <dt><a name="241">method <b class="cmd">ScmTag</b></a></dt> <dd></dd> <dt><a name="242">method <b class="cmd">ScmUnpack</b></a></dt> <dd></dd> <dt><a name="243">method <b class="cmd">ScmUpdate</b></a></dt> <dd></dd> </dl> </div> <div id="subsection22" class="doctools_subsection"><h3><a name="subsection22">Class practcl::distribution.git</a></h3> <p><em>ancestors</em>: <b class="class">practcl::distribution</b></p> <p>A file distribution based on git</p> <p><b class="class">Class Methods</b></p> <dl class="doctools_definitions"> <dt><a name="244">classmethod <b class="cmd">claim_object</b> <i class="arg">obj</i></a></dt> <dd></dd> <dt><a name="245">classmethod <b class="cmd">claim_option</b></a></dt> <dd></dd> <dt><a name="246">classmethod <b class="cmd">claim_path</b> <i class="arg">path</i></a></dt> <dd></dd> </dl> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="247">method <b class="cmd">ScmTag</b></a></dt> <dd></dd> <dt><a name="248">method <b class="cmd">ScmUnpack</b></a></dt> <dd></dd> <dt><a name="249">method <b class="cmd">ScmUpdate</b></a></dt> <dd></dd> </dl> </div> <div id="subsection23" class="doctools_subsection"><h3><a name="subsection23">Class practcl::subproject</a></h3> <p><em>ancestors</em>: <b class="class">practcl::module</b></p> <p>A subordinate project</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="250">method <b class="cmd">_MorphPatterns</b></a></dt> <dd></dd> <dt><a name="251">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></dt> <dd></dd> <dt><a name="252">method <b class="cmd">child</b> <i class="arg">which</i></a></dt> <dd></dd> <dt><a name="253">method <b class="cmd">compile</b></a></dt> <dd></dd> <dt><a name="254">method <b class="cmd">go</b></a></dt> <dd></dd> <dt><a name="255">method <b class="cmd">install</b> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd><p>Install project into the local build system</p></dd> <dt><a name="256">method <b class="cmd">linktype</b></a></dt> <dd></dd> <dt><a name="257">method <b class="cmd">linker-products</b> <i class="arg">configdict</i></a></dt> <dd></dd> <dt><a name="258">method <b class="cmd">linker-external</b> <i class="arg">configdict</i></a></dt> <dd></dd> <dt><a name="259">method <b class="cmd">linker-extra</b> <i class="arg">configdict</i></a></dt> <dd></dd> <dt><a name="260">method <b class="cmd">env-bootstrap</b></a></dt> <dd><p>Methods for packages/tools that can be downloaded possibly built and used internally by this Practcl process Load the facility into the interpreter</p></dd> <dt><a name="261">method <b class="cmd">env-exec</b></a></dt> <dd><p>Return a file path that exec can call</p></dd> <dt><a name="262">method <b class="cmd">env-install</b></a></dt> <dd><p>Install the tool into the local environment</p></dd> <dt><a name="263">method <b class="cmd">env-load</b></a></dt> <dd><p>Do whatever is necessary to get the tool into the local environment</p></dd> <dt><a name="264">method <b class="cmd">env-present</b></a></dt> <dd><p>Check if tool is available for load/already loaded</p></dd> <dt><a name="265">method <b class="cmd">sources</b></a></dt> <dd></dd> <dt><a name="266">method <b class="cmd"><a href="../../../../index.html#update">update</a></b></a></dt> <dd></dd> <dt><a name="267">method <b class="cmd">unpack</b></a></dt> <dd></dd> </dl> </div> <div id="subsection24" class="doctools_subsection"><h3><a name="subsection24">Class practcl::subproject.source</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b> <b class="class">practcl::library</b></p> <p>A project which the kit compiles and integrates the source for itself</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="268">method <b class="cmd">env-bootstrap</b></a></dt> <dd></dd> <dt><a name="269">method <b class="cmd">env-present</b></a></dt> <dd></dd> <dt><a name="270">method <b class="cmd">linktype</b></a></dt> <dd></dd> </dl> </div> <div id="subsection25" class="doctools_subsection"><h3><a name="subsection25">Class practcl::subproject.teapot</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b></p> <p>a copy from the teapot</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="271">method <b class="cmd">env-bootstrap</b></a></dt> <dd></dd> <dt><a name="272">method <b class="cmd">env-install</b></a></dt> <dd></dd> <dt><a name="273">method <b class="cmd">env-present</b></a></dt> <dd></dd> <dt><a name="274">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> </dl> </div> <div id="subsection26" class="doctools_subsection"><h3><a name="subsection26">Class practcl::subproject.kettle</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="275">method <b class="cmd">kettle</b> <i class="arg">path</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> <dt><a name="276">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> </dl> </div> <div id="subsection27" class="doctools_subsection"><h3><a name="subsection27">Class practcl::subproject.critcl</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="277">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> </dl> </div> <div id="subsection28" class="doctools_subsection"><h3><a name="subsection28">Class practcl::subproject.sak</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="278">method <b class="cmd">env-bootstrap</b></a></dt> <dd></dd> <dt><a name="279">method <b class="cmd">env-install</b></a></dt> <dd></dd> <dt><a name="280">method <b class="cmd">env-present</b></a></dt> <dd></dd> <dt><a name="281">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> <dt><a name="282">method <b class="cmd">install-module</b> <i class="arg">DEST</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> </dl> </div> <div id="subsection29" class="doctools_subsection"><h3><a name="subsection29">Class practcl::subproject.practcl</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="283">method <b class="cmd">env-bootstrap</b></a></dt> <dd></dd> <dt><a name="284">method <b class="cmd">env-install</b></a></dt> <dd></dd> <dt><a name="285">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> <dt><a name="286">method <b class="cmd">install-module</b> <i class="arg">DEST</i> <span class="opt">?<i class="arg">args</i>?</span></a></dt> <dd></dd> </dl> </div> <div id="subsection30" class="doctools_subsection"><h3><a name="subsection30">Class practcl::subproject.binary</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject</b></p> <p>A subordinate binary package</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="287">method <b class="cmd">clean</b></a></dt> <dd></dd> <dt><a name="288">method <b class="cmd">env-install</b></a></dt> <dd></dd> <dt><a name="289">method <b class="cmd">project-compile-products</b></a></dt> <dd></dd> <dt><a name="290">method <b class="cmd">ComputeInstall</b></a></dt> <dd></dd> <dt><a name="291">method <b class="cmd">go</b></a></dt> <dd></dd> <dt><a name="292">method <b class="cmd">linker-products</b> <i class="arg">configdict</i></a></dt> <dd></dd> <dt><a name="293">method <b class="cmd">project-static-packages</b></a></dt> <dd></dd> <dt><a name="294">method <b class="cmd">BuildDir</b> <i class="arg">PWD</i></a></dt> <dd></dd> <dt><a name="295">method <b class="cmd">compile</b></a></dt> <dd></dd> <dt><a name="296">method <b class="cmd">Configure</b></a></dt> <dd></dd> <dt><a name="297">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> </dl> </div> <div id="subsection31" class="doctools_subsection"><h3><a name="subsection31">Class practcl::subproject.tea</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject.binary</b></p> <p>A subordinate TEA based binary package</p> </div> <div id="subsection32" class="doctools_subsection"><h3><a name="subsection32">Class practcl::subproject.library</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject.binary</b> <b class="class">practcl::library</b></p> <p>A subordinate C library built by this project</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="298">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> </dl> </div> <div id="subsection33" class="doctools_subsection"><h3><a name="subsection33">Class practcl::subproject.external</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject.binary</b></p> <p>A subordinate external C library</p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="299">method <b class="cmd">install</b> <i class="arg">DEST</i></a></dt> <dd></dd> </dl> </div> <div id="subsection34" class="doctools_subsection"><h3><a name="subsection34">Class practcl::subproject.core</a></h3> <p><em>ancestors</em>: <b class="class">practcl::subproject.binary</b></p> <p><b class="class">Methods</b></p> <dl class="doctools_definitions"> <dt><a name="300">method <b class="cmd">env-bootstrap</b></a></dt> <dd></dd> <dt><a name="301">method <b class="cmd">env-present</b></a></dt> <dd></dd> <dt><a name="302">method <b class="cmd">env-install</b></a></dt> <dd></dd> <dt><a name="303">method <b class="cmd">go</b></a></dt> <dd></dd> <dt><a name="304">method <b class="cmd">linktype</b></a></dt> <dd></dd> </dl> </div> </div> <div id="section4" class="doctools_section"><h2><a name="section4">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category <em>practcl</em> of the <a href="http://core.tcl.tk/tcllib/reportlist">Tcllib Trackers</a>. Please also report any ideas for enhancements you may have for either package and/or documentation.</p> <p>When proposing code changes, please provide <em>unified diffs</em>, |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/pt/pt_peg_export.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">pt::peg::export(n) 1.0.1 tcllib "Parser Tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>pt::peg::export - PEG Export</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
140 141 142 143 144 145 146 | </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">snit</b></li> | | | | 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">snit</b></li> <li>package require <b class="pkgname">struct::map</b></li> <li>package require <b class="pkgname">pt::peg</b></li> <li>package require <b class="pkgname">pluginmgr</b></li> <li>package require <b class="pkgname">pt::peg::export <span class="opt">?1.0.1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::pt::peg::export</b> <i class="arg">objectName</i></a></li> <li><a href="#2"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> <li><a href="#3"><i class="arg">objectName</i> <b class="method">destroy</b></a></li> <li><a href="#4"><i class="arg">objectName</i> <b class="method">export serial</b> <i class="arg">serial</i> <span class="opt">?<i class="arg">format</i>?</span></a></li> <li><a href="#5"><i class="arg">objectName</i> <b class="method">export object</b> <i class="arg">object</i> <span class="opt">?<i class="arg">format</i>?</span></a></li> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/pt/pt_peg_import.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">pt::peg::import(n) 1.0.1 tcllib "Parser Tools"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>pt::peg::import - PEG Import</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
139 140 141 142 143 144 145 146 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">snit</b></li> | > | | | 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">snit</b></li> <li>package require <b class="pkgname">fileutil::paths</b></li> <li>package require <b class="pkgname">pt::peg</b></li> <li>package require <b class="pkgname">pluginmgr</b></li> <li>package require <b class="pkgname">pt::peg::import <span class="opt">?1.0.1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::pt::peg::import</b> <i class="arg">objectName</i></a></li> <li><a href="#2"><b class="cmd">objectName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> <li><a href="#3"><i class="arg">objectName</i> <b class="method">destroy</b></a></li> <li><a href="#4"><i class="arg">objectName</i> <b class="method">import text</b> <i class="arg">text</i> <span class="opt">?<i class="arg">format</i>?</span></a></li> <li><a href="#5"><i class="arg">objectName</i> <b class="method">import file</b> <i class="arg">path</i> <span class="opt">?<i class="arg">format</i>?</span></a></li> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/pt/pt_peg_to_tclparam.html.
︙ | ︙ | |||
280 281 282 283 284 285 286 | containing a canned configuration which will generate immediately useful full parsers. These are</p> <dl class="doctools_definitions"> <dt><b class="package"><a href="pt_tclparam_config_snit.html">pt::tclparam::configuration::snit</a></b></dt> <dd><p>Generated parsers are classes based on the <b class="package"><a href="../snit/snit.html">snit</a></b> package, i.e. snit::type's.</p></dd> <dt><b class="package"><a href="pt_tclparam_config_tcloo.html">pt::tclparam::configuration::tcloo</a></b></dt> | | | 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | containing a canned configuration which will generate immediately useful full parsers. These are</p> <dl class="doctools_definitions"> <dt><b class="package"><a href="pt_tclparam_config_snit.html">pt::tclparam::configuration::snit</a></b></dt> <dd><p>Generated parsers are classes based on the <b class="package"><a href="../snit/snit.html">snit</a></b> package, i.e. snit::type's.</p></dd> <dt><b class="package"><a href="pt_tclparam_config_tcloo.html">pt::tclparam::configuration::tcloo</a></b></dt> <dd><p>Generated parsers are classes based on the <b class="package"><a href="../../../../index.html#oo">OO</a></b> package.</p></dd> </dl> </div> <div id="section4" class="doctools_section"><h2><a name="section4">Tcl/PARAM code representation of parsing expression grammars</a></h2> <p>The Tcl/PARAM representation of parsing expression grammars is Tcl code whose execution will parse input per the grammar. The code is based on the virtual machine documented in the <i class="term"><a href="pt_param.html">PackRat Machine Specification</a></i>, using its instructions |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/pt/pt_tclparam_config_tcloo.html.
︙ | ︙ | |||
140 141 142 143 144 145 146 | In that case please read the overview provided by the <i class="term"><a href="pt_introduction.html">Introduction to Parser Tools</a></i>. This document is the entrypoint to the whole system the current package is a part of.</p> <p>This package is an adjunct to <b class="package"><a href="pt_peg_to_tclparam.html">pt::peg::to::tclparam</a></b>, to make the use of this highly configurable package easier by providing a canned configuration. When applied this configuration causes the package <b class="package"><a href="pt_peg_to_tclparam.html">pt::peg::to::tclparam</a></b> to generate | | | | 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | In that case please read the overview provided by the <i class="term"><a href="pt_introduction.html">Introduction to Parser Tools</a></i>. This document is the entrypoint to the whole system the current package is a part of.</p> <p>This package is an adjunct to <b class="package"><a href="pt_peg_to_tclparam.html">pt::peg::to::tclparam</a></b>, to make the use of this highly configurable package easier by providing a canned configuration. When applied this configuration causes the package <b class="package"><a href="pt_peg_to_tclparam.html">pt::peg::to::tclparam</a></b> to generate <b class="package"><a href="../../../../index.html#oo">OO</a></b>-based parser packages.</p> <p>It is a supporting package in the Core Layer of Parser Tools.</p> <p><img alt="arch_core_support" src="../../../../image/arch_core_support.png"></p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">API</a></h2> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd">::pt::tclparam::configuration::tcloo</b> <b class="method">def</b> <i class="arg">name</i> <i class="arg">pkg</i> <i class="arg">version</i> <i class="arg">cmdprefix</i></a></dt> <dd><p>The command applies the configuration provided by this package to the <i class="arg">cmdprefix</i>, causing the creation of <b class="package"><a href="../../../../index.html#oo">OO</a></b>-based parsers whose class is <i class="arg">name</i>, in package <i class="arg">pkg</i> with <i class="arg">version</i>.</p> <p>The use of a command prefix as API allows application of the configuration to not only <b class="package"><a href="pt_peg_to_tclparam.html">pt::peg::to::tclparam</a></b> (<b class="cmd">pt::peg::to::tclparam configure</b>), but also export manager instances and PEG containers (<b class="cmd">$export configuration set</b> and <b class="cmd">[$container exporter] configuration set</b> respectively).</p> <p>Or anything other command prefix accepting two arguments, option and |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/sha1/sha1.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">sha1(n) 2.0.4 tcllib "SHA-x Message-Digest Algorithm"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>sha1 - SHA1 Message-Digest Algorithm</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
127 128 129 130 131 132 133 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.2</b></li> | | | 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.2</b></li> <li>package require <b class="pkgname">sha1 <span class="opt">?2.0.4?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::sha1::sha1</b> <span class="opt">?<b class="option">-hex|-bin</b>?</span> [ <b class="option">-channel channel</b> | <b class="option">-file filename</b> | <span class="opt">?<b class="option">--</b>?</span> <i class="arg">string</i> ]</a></li> <li><a href="#2"><b class="cmd">::sha1::hmac</b> <i class="arg">key</i> <i class="arg">string</i></a></li> <li><a href="#3"><b class="cmd">::sha1::hmac</b> <span class="opt">?<b class="option">-hex|-bin</b>?</span> <b class="option">-key key</b> [ <b class="option">-channel channel</b> | <b class="option">-file filename</b> | <span class="opt">?<b class="option">--</b>?</span> <i class="arg">string</i> ]</a></li> <li><a href="#4"><b class="cmd">::sha1::SHA1Init</b></a></li> <li><a href="#5"><b class="cmd">::sha1::SHA1Update</b> <i class="arg">token</i> <i class="arg">data</i></a></li> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/sha1/sha256.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">sha256(n) 1.0.4 tcllib "SHA-x Message-Digest Algorithm"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>sha256 - SHA256 Message-Digest Algorithm</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
127 128 129 130 131 132 133 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.2</b></li> | | | 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.2</b></li> <li>package require <b class="pkgname">sha256 <span class="opt">?1.0.4?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::sha2::sha256</b> <span class="opt">?<b class="option">-hex|-bin</b>?</span> [ <b class="option">-channel channel</b> | <b class="option">-file filename</b> | <span class="opt">?<b class="option">--</b>?</span> <i class="arg">string</i> ]</a></li> <li><a href="#2"><b class="cmd">::sha2::sha224</b> <span class="opt">?<b class="option">-hex|-bin</b>?</span> [ <b class="option">-channel channel</b> | <b class="option">-file filename</b> | <span class="opt">?<b class="option">--</b>?</span> <i class="arg">string</i> ]</a></li> <li><a href="#3"><b class="cmd">::sha2::hmac</b> <i class="arg">key</i> <i class="arg">string</i></a></li> <li><a href="#4"><b class="cmd">::sha2::hmac</b> <span class="opt">?<b class="option">-hex|-bin</b>?</span> <b class="option">-key key</b> [ <b class="option">-channel channel</b> | <b class="option">-file filename</b> | <span class="opt">?<b class="option">--</b>?</span> <i class="arg">string</i> ]</a></li> <li><a href="#5"><b class="cmd">::sha2::SHA256Init</b></a></li> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/struct/graph.html.
︙ | ︙ | |||
89 90 91 92 93 94 95 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'graph.man' by tcllib/doctools with format 'html' --> | | | | | 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 | margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'graph.man' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2002-2009,2019 Andreas Kupries &lt;[email protected]&gt; --> <!-- struct::graph.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">struct::graph(n) 2.4.2 tcllib "Tcl Data Structures"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>struct::graph - Create and manipulate directed graph objects</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">Changes for 2.0</a></li> <li class="doctools_section"><a href="#section3">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.4</b></li> <li>package require <b class="pkgname">struct::graph <span class="opt">?2.4.2?</span></b></li> <li>package require <b class="pkgname">struct::list <span class="opt">?1.5?</span></b></li> <li>package require <b class="pkgname">struct::set <span class="opt">?2.2.3?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::struct::graph</b> <span class="opt">?<i class="arg">graphName</i>?</span> <span class="opt">?<b class="const">=</b>|<b class="const">:=</b>|<b class="const">as</b>|<b class="const">deserialize</b> <i class="arg">source</i>?</span></a></li> <li><a href="#2"><b class="cmd">graphName</b> <i class="arg">option</i> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> <li><a href="#3"><i class="arg">graphName</i> <b class="method">=</b> <i class="arg">sourcegraph</i></a></li> |
︙ | ︙ | |||
427 428 429 430 431 432 433 | list containing all arcs is returned. Restrictions can limit the list of returned arcs based on the nodes that are connected by the arc, on the keyed values associated with the arc, or both. A general filter command can be used as well. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself.</p> <p>The restrictions imposed by either <b class="option">-in</b>, <b class="option">-out</b>, | | | 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | list containing all arcs is returned. Restrictions can limit the list of returned arcs based on the nodes that are connected by the arc, on the keyed values associated with the arc, or both. A general filter command can be used as well. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself.</p> <p>The restrictions imposed by either <b class="option">-in</b>, <b class="option">-out</b>, <b class="option">-adj</b>, <b class="option">-inner</b>, or <b class="option">-embedding</b> are applied first. Specifying more than one of them is illegal.</p> <p>After that the restrictions set via <b class="option">-key</b> (and <b class="option">-value</b>) are applied. Specifying more than one <b class="option">-key</b> (and <b class="option">-value</b>) is illegal. Specifying <b class="option">-value</b> alone, without <b class="option">-key</b> is illegal as well.</p> <p>Any restriction set through <b class="option">-filter</b> is applied last. Specifying more than one <b class="option">-filter</b> is illegal.</p> |
︙ | ︙ | |||
458 459 460 461 462 463 464 465 466 467 468 469 470 471 | <dd><p>Return a list of all arcs which are adjacent to two of the nodes in the set. This is the set of arcs in the subgraph spawned by the specified nodes.</p></dd> <dt><b class="option">-embedding</b></dt> <dd><p>Return a list of all arcs adjacent to exactly one of the nodes in the set. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph.</p></dd> <dt><b class="option">-key</b> <i class="arg">key</i></dt> <dd><p>Limit the list of arcs that are returned to those arcs that have an associated key <i class="arg">key</i>.</p></dd> <dt><b class="option">-value</b> <i class="arg">value</i></dt> <dd><p>This restriction can only be used in combination with <b class="option">-key</b>. It limits the list of arcs that are returned to those arcs whose associated key <i class="arg">key</i> has the value <i class="arg">value</i>.</p></dd> | > > > > > > > > | 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | <dd><p>Return a list of all arcs which are adjacent to two of the nodes in the set. This is the set of arcs in the subgraph spawned by the specified nodes.</p></dd> <dt><b class="option">-embedding</b></dt> <dd><p>Return a list of all arcs adjacent to exactly one of the nodes in the set. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph.</p></dd> </dl> <p><em>Attention</em>: After the above options any word with a leading dash which is not a valid option is treated as a node name instead of an invalid option to error out on. This condition holds until either a valid option terminates the list of nodes, or the end of the command is reached, whichever comes first.</p> <p>The remaining filter options are:</p> <dl class="doctools_definitions"> <dt><b class="option">-key</b> <i class="arg">key</i></dt> <dd><p>Limit the list of arcs that are returned to those arcs that have an associated key <i class="arg">key</i>.</p></dd> <dt><b class="option">-value</b> <i class="arg">value</i></dt> <dd><p>This restriction can only be used in combination with <b class="option">-key</b>. It limits the list of arcs that are returned to those arcs whose associated key <i class="arg">key</i> has the value <i class="arg">value</i>.</p></dd> |
︙ | ︙ | |||
561 562 563 564 565 566 567 | nothing if the <i class="arg">key</i> does not exist.</p></dd> <dt><a name="58"><i class="arg">graphName</i> <b class="method">nodes</b> <span class="opt">?-key <i class="arg">key</i>?</span> <span class="opt">?-value <i class="arg">value</i>?</span> <span class="opt">?-filter <i class="arg">cmdprefix</i>?</span> <span class="opt">?-in|-out|-adj|-inner|-embedding <i class="arg">node</i> <i class="arg">node</i>...?</span></a></dt> <dd><p>Return a list of nodes in the graph. Restrictions can limit the list of returned nodes based on neighboring nodes, or based on the keyed values associated with the node. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself.</p> | | | > > > | | 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | nothing if the <i class="arg">key</i> does not exist.</p></dd> <dt><a name="58"><i class="arg">graphName</i> <b class="method">nodes</b> <span class="opt">?-key <i class="arg">key</i>?</span> <span class="opt">?-value <i class="arg">value</i>?</span> <span class="opt">?-filter <i class="arg">cmdprefix</i>?</span> <span class="opt">?-in|-out|-adj|-inner|-embedding <i class="arg">node</i> <i class="arg">node</i>...?</span></a></dt> <dd><p>Return a list of nodes in the graph. Restrictions can limit the list of returned nodes based on neighboring nodes, or based on the keyed values associated with the node. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself.</p> <p>The possible restrictions are the same as for method <b class="method">arcs</b>. Note that while the exact meanings change slightly, as they operate on nodes instead of arcs, the general behaviour is the same, especially when it comes to the handling of words with a leading dash in node lists.</p> <p>The command recognizes:</p> <dl class="doctools_definitions"> <dt><b class="option">-in</b></dt> <dd><p>Return a list of all nodes with at least one outgoing arc ending in a node found in the specified set of nodes. Alternatively specified as the set of source nodes for the <b class="option">-in</b> arcs of the node set. The <i class="term">incoming neighbours</i>.</p></dd> <dt><b class="option">-out</b></dt> |
︙ | ︙ | |||
671 672 673 674 675 676 677 | attributes, and the values are the values for each name.</p> <p><em>Note:</em> The order of the nodes in the serialization has no relevance, nor has the order of the arcs per node.</p> <pre class="doctools_example"> # A possible serialization for the graph structure # # d -----> %2 | | | | | | 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 | attributes, and the values are the values for each name.</p> <p><em>Note:</em> The order of the nodes in the serialization has no relevance, nor has the order of the arcs per node.</p> <pre class="doctools_example"> # A possible serialization for the graph structure # # d -----> %2 # / ^ \ # / / \ # / b \ # / / \ # %1 <- a - %0 e # ^ \\ / # \\ c / # \\ \\ / # \\ v v # f ------ %3 # is |
︙ | ︙ | |||
784 785 786 787 788 789 790 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#adjacent">adjacent</a>, <a href="../../../../index.html#arc">arc</a>, <a href="../../../../index.html#cgraph">cgraph</a>, <a href="../../../../index.html#degree">degree</a>, <a href="../../../../index.html#edge">edge</a>, <a href="../../../../index.html#graph">graph</a>, <a href="../../../../index.html#loop">loop</a>, <a href="../../../../index.html#neighbour">neighbour</a>, <a href="../../../../index.html#node">node</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#subgraph">subgraph</a>, <a href="../../../../index.html#vertex">vertex</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Data structures</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> | | | 795 796 797 798 799 800 801 802 803 804 | <div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2> <p><a href="../../../../index.html#adjacent">adjacent</a>, <a href="../../../../index.html#arc">arc</a>, <a href="../../../../index.html#cgraph">cgraph</a>, <a href="../../../../index.html#degree">degree</a>, <a href="../../../../index.html#edge">edge</a>, <a href="../../../../index.html#graph">graph</a>, <a href="../../../../index.html#loop">loop</a>, <a href="../../../../index.html#neighbour">neighbour</a>, <a href="../../../../index.html#node">node</a>, <a href="../../../../index.html#serialization">serialization</a>, <a href="../../../../index.html#subgraph">subgraph</a>, <a href="../../../../index.html#vertex">vertex</a></p> </div> <div id="category" class="doctools_section"><h2><a name="category">Category</a></h2> <p>Data structures</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2002-2009,2019 Andreas Kupries <[email protected]></p> </div> </div></body></html> |
Added idoc/www/tcllib/files/modules/struct/struct_map.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>struct::map - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file 'struct_map.man' by tcllib/doctools with format 'html' --> <!-- struct::map.n --> <body><hr> [ <a href="../../../../../../../../home">Tcllib Home</a> | <a href="../../../../toc.html">Main Table Of Contents</a> | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">struct::map(n) 1 tcllib ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>struct::map - Manage key/value maps</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">Bugs, Ideas, Feedback</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">struct::map <span class="opt">?1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::struct::map</b> <i class="arg">mapName</i></a></li> <li><a href="#2"><b class="cmd">mapName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></li> <li><a href="#3"><i class="arg">mapName</i> <b class="method">get</b></a></li> <li><a href="#4"><i class="arg">mapName</i> <b class="method">names</b></a></li> <li><a href="#5"><i class="arg">mapName</i> <b class="method">set</b> <i class="arg">name</i> <span class="opt">?<i class="arg">value</i>?</span></a></li> <li><a href="#6"><i class="arg">mapName</i> <b class="method">unset</b> <span class="opt">?<i class="arg">pattern</i>...?</span></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>Provides a snit class whose instances manage a key/value map. In other words, an object wrapper around Tcl arrays.</p> </div> <div id="section2" class="doctools_section"><h2><a name="section2">API</a></h2> <p>The main command provides construction of maps:</p> <dl class="doctools_definitions"> <dt><a name="1"><b class="cmd">::struct::map</b> <i class="arg">mapName</i></a></dt> <dd><p>Creates a new, empty map with an associated global Tcl command whose name is <i class="arg">mapName</i>. It may be used to invoke various operations on the map. It has the following general form:</p> <dl class="doctools_definitions"> <dt><a name="2"><b class="cmd">mapName</b> <b class="method">method</b> <span class="opt">?<i class="arg">arg arg ...</i>?</span></a></dt> <dd><p><b class="method">method</b> and <i class="arg">arg</i>uments determine the exact behavior of the command.</p></dd> </dl> <p>If <i class="arg">mapName</i> is specified as <b class="const">%AUTO%</b> a unique name will be generated by the package itself. The result of the command is the fully-qualified name of the instance command.</p></dd> </dl> <p>The following commands are possible for map objects:</p> <dl class="doctools_definitions"> <dt><a name="3"><i class="arg">mapName</i> <b class="method">get</b></a></dt> <dd><p>Returns the entire map as a Tcl dictionary.</p></dd> <dt><a name="4"><i class="arg">mapName</i> <b class="method">names</b></a></dt> <dd><p>Returns the list of all keys known to the map, in arbitrary order.</p></dd> <dt><a name="5"><i class="arg">mapName</i> <b class="method">set</b> <i class="arg">name</i> <span class="opt">?<i class="arg">value</i>?</span></a></dt> <dd><p>Sets key <i class="arg">name</i> to the specified <i class="arg">value</i>, if the value specified. Returns the value for the key. Throws an error if the key is not known.</p></dd> <dt><a name="6"><i class="arg">mapName</i> <b class="method">unset</b> <span class="opt">?<i class="arg">pattern</i>...?</span></a></dt> <dd><p>Removes all keys matching at least one of the glob <i class="arg">pattern</i>s from the map. If no pattern is specified all keys are removed. In other words, the default pattern is <b class="const">*</b>. The result of the command is the empty string.</p></dd> </dl> </div> <div id="section3" class="doctools_section"><h2><a name="section3">Bugs, Ideas, Feedback</a></h2> <p>This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category <em>struct :: list</em> of the <a href="http://core.tcl.tk/tcllib/reportlist">Tcllib Trackers</a>. Please also report any ideas for enhancements you may have for either package and/or documentation.</p> <p>When proposing code changes, please provide <em>unified diffs</em>, i.e the output of <b class="const">diff -u</b>.</p> <p>Note further that <em>attachments</em> are strongly preferred over inlined patches. Attachments can be made by going to the <b class="const">Edit</b> form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.</p> </div> </div></body></html> |
Changes to idoc/www/tcllib/files/modules/treeql/treeql.html.
︙ | ︙ | |||
250 251 252 253 254 255 256 | # values for the attribute 'data', # for all nodes in the set which # have such an attribute. # - And returns this information. # Below we can see the same query, but rewritten # to show the structure as it is seen by the query # interpreter. | | | | | 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | # values for the attribute 'data', # for all nodes in the set which # have such an attribute. # - And returns this information. # Below we can see the same query, but rewritten # to show the structure as it is seen by the query # interpreter. q query \ root \ children \ get data </pre> <p>The operators of the TreeQL language available for this are explained in the section about <span class="sectref"><a href="#section3">The Tree Query Language</a></span>. This section also explains the term <i class="term">node set</i> used above.</p></dd> <dt><a name="3"><i class="arg">qo</i> <b class="method">result</b></a></dt> <dd><p>This method returns a list containing the current node set.</p></dd> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/virtchannel_base/cat.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">tcl::chan::cat(n) 1.0.3 tcllib "Reflected/virtual channel support"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>tcl::chan::cat - Concatenation channel</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> |
︙ | ︙ | |||
125 126 127 128 129 130 131 | </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">TclOO</b></li> <li>package require <b class="pkgname">tcl::chan::core <span class="opt">?1?</span></b></li> | | | 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.5</b></li> <li>package require <b class="pkgname">TclOO</b></li> <li>package require <b class="pkgname">tcl::chan::core <span class="opt">?1?</span></b></li> <li>package require <b class="pkgname">tcl::chan::cat <span class="opt">?1.0.3?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::tcl::chan::cat</b> <i class="arg">chan</i>...</a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> |
︙ | ︙ |
Changes to idoc/www/tcllib/files/modules/zip/mkzip.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> | | | | 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 | | <a href="../../../toc.html">Table Of Contents</a> | <a href="../../../../index.html">Keyword Index</a> | <a href="../../../../toc0.html">Categories</a> | <a href="../../../../toc1.html">Modules</a> | <a href="../../../../toc2.html">Applications</a> ] <hr> <div class="doctools"> <h1 class="doctools_title">zipfile::mkzip(n) 1.2.1 tcllib "Zip archive creation"</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>zipfile::mkzip - Build a zip archive</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#synopsis">Synopsis</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#section2">API</a></li> <li class="doctools_section"><a href="#section3">Bugs, Ideas, Feedback</a></li> <li class="doctools_section"><a href="#keywords">Keywords</a></li> <li class="doctools_section"><a href="#category">Category</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2> <div class="doctools_synopsis"> <ul class="doctools_requirements"> <li>package require <b class="pkgname">Tcl 8.6</b></li> <li>package require <b class="pkgname">zipfile::mkzip <span class="opt">?1.2.1?</span></b></li> </ul> <ul class="doctools_syntax"> <li><a href="#1"><b class="cmd">::zipfile::mkzip::mkzip</b> <i class="arg">zipfile</i> <span class="opt">?<b class="option">-zipkit</b>?</span> <span class="opt">?<b class="option">-runtime</b> <i class="arg">prefix</i>?</span> <span class="opt">?<b class="option">-comment</b> <i class="arg">string</i>?</span> <span class="opt">?<b class="option">-directory</b> <i class="arg">rootpath</i>?</span> <span class="opt">?<b class="option">-exclude</b> <i class="arg">exclude</i>?</span> <span class="opt">?<b class="option">--</b>?</span> <span class="opt">?<i class="arg">path</i>...?</span></a></li> </ul> </div> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> |
︙ | ︙ |
Changes to idoc/www/tcllib/toc.html.
︙ | ︙ | |||
93 94 95 96 97 98 99 100 101 102 | <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='cksum'><a href="files/modules/crc/cksum.html">cksum</a></td> <td class="#doctools_tocright">Calculate a cksum(1) compatible checksum</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clock_iso8601'><a href="files/modules/clock/iso8601.html">clock_iso8601</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> | > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > | 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 | <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='cksum'><a href="files/modules/crc/cksum.html">cksum</a></td> <td class="#doctools_tocright">Calculate a cksum(1) compatible checksum</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clay'><a href="files/modules/clay/clay.html">clay</a></td> <td class="#doctools_tocright">A minimalist framework for large scale OO Projects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='clock_iso8601'><a href="files/modules/clock/iso8601.html">clock_iso8601</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clock_rfc2822'><a href="files/modules/clock/rfc2822.html">clock_rfc2822</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='cmdline'><a href="files/modules/cmdline/cmdline.html">cmdline</a></td> <td class="#doctools_tocright">Procedures to process command lines and options.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='comm'><a href="files/modules/comm/comm.html">comm</a></td> <td class="#doctools_tocright">A remote communication facility for Tcl (8.3 and later)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='comm_wire'><a href="files/modules/comm/comm_wire.html">comm_wire</a></td> <td class="#doctools_tocright">The comm wire protocol</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='control'><a href="files/modules/control/control.html">control</a></td> <td class="#doctools_tocright">Procedures for control flow structures.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='coroutine'><a href="files/modules/coroutine/tcllib_coroutine.html">coroutine</a></td> <td class="#doctools_tocright">Coroutine based event and IO handling</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='coroutine_auto'><a href="files/modules/coroutine/coro_auto.html">coroutine::auto</a></td> <td class="#doctools_tocright">Automatic event and IO coroutine awareness</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='counter'><a href="files/modules/counter/counter.html">counter</a></td> <td class="#doctools_tocright">Procedures for counters and histograms</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='crc16'><a href="files/modules/crc/crc16.html">crc16</a></td> <td class="#doctools_tocright">Perform a 16bit Cyclic Redundancy Check</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='crc32'><a href="files/modules/crc/crc32.html">crc32</a></td> <td class="#doctools_tocright">Perform a 32bit Cyclic Redundancy Check</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cron'><a href="files/modules/cron/cron.html">cron</a></td> <td class="#doctools_tocright">Tool for automating the period callback of commands</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='csv'><a href="files/modules/csv/csv.html">csv</a></td> <td class="#doctools_tocright">Procedures to handle CSV data.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='debug'><a href="files/modules/debug/debug.html">debug</a></td> <td class="#doctools_tocright">debug narrative - core</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='debug_caller'><a href="files/modules/debug/debug_caller.html">debug::caller</a></td> <td class="#doctools_tocright">debug narrative - caller</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='debug_heartbeat'><a href="files/modules/debug/debug_heartbeat.html">debug::heartbeat</a></td> <td class="#doctools_tocright">debug narrative - heartbeat</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='debug_timestamp'><a href="files/modules/debug/debug_timestamp.html">debug::timestamp</a></td> <td class="#doctools_tocright">debug narrative - timestamping</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='defer'><a href="files/modules/defer/defer.html">defer</a></td> <td class="#doctools_tocright">Defered execution</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='deleg_method'><a href="files/modules/interp/deleg_method.html">deleg_method</a></td> <td class="#doctools_tocright">Creation of comm delegates (snit methods)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='deleg_proc'><a href="files/modules/interp/deleg_proc.html">deleg_proc</a></td> <td class="#doctools_tocright">Creation of comm delegates (procedures)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='des'><a href="files/modules/des/des.html">des</a></td> <td class="#doctools_tocright">Implementation of the DES and triple-DES ciphers</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='dicttool'><a href="files/modules/dicttool/dicttool.html">dicttool</a></td> <td class="#doctools_tocright">Dictionary Tools</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='dns'><a href="files/modules/dns/tcllib_dns.html">dns</a></td> <td class="#doctools_tocright">Tcl Domain Name Service Client</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='docidx_intro'><a href="files/modules/doctools/docidx_intro.html">docidx_intro</a></td> <td class="#doctools_tocright">docidx introduction</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='docidx_lang_cmdref'><a href="files/modules/doctools/docidx_lang_cmdref.html">docidx_lang_cmdref</a></td> <td class="#doctools_tocright">docidx language command reference</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='docidx_lang_faq'><a href="files/modules/doctools/docidx_lang_faq.html">docidx_lang_faq</a></td> <td class="#doctools_tocright">docidx language faq</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='docidx_lang_intro'><a href="files/modules/doctools/docidx_lang_intro.html">docidx_lang_intro</a></td> <td class="#doctools_tocright">docidx language introduction</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='docidx_lang_syntax'><a href="files/modules/doctools/docidx_lang_syntax.html">docidx_lang_syntax</a></td> <td class="#doctools_tocright">docidx language syntax</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='docidx_plugin_apiref'><a href="files/modules/doctools/docidx_plugin_apiref.html">docidx_plugin_apiref</a></td> <td class="#doctools_tocright">docidx plugin API reference</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='docstrip'><a href="files/modules/docstrip/docstrip.html">docstrip</a></td> <td class="#doctools_tocright">Docstrip style source code extraction</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='docstrip_util'><a href="files/modules/docstrip/docstrip_util.html">docstrip_util</a></td> <td class="#doctools_tocright">Docstrip-related utilities</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctoc_intro'><a href="files/modules/doctools/doctoc_intro.html">doctoc_intro</a></td> <td class="#doctools_tocright">doctoc introduction</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctoc_lang_cmdref'><a href="files/modules/doctools/doctoc_lang_cmdref.html">doctoc_lang_cmdref</a></td> <td class="#doctools_tocright">doctoc language command reference</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctoc_lang_faq'><a href="files/modules/doctools/doctoc_lang_faq.html">doctoc_lang_faq</a></td> <td class="#doctools_tocright">doctoc language faq</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctoc_lang_intro'><a href="files/modules/doctools/doctoc_lang_intro.html">doctoc_lang_intro</a></td> <td class="#doctools_tocright">doctoc language introduction</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctoc_lang_syntax'><a href="files/modules/doctools/doctoc_lang_syntax.html">doctoc_lang_syntax</a></td> <td class="#doctools_tocright">doctoc language syntax</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctoc_plugin_apiref'><a href="files/modules/doctools/doctoc_plugin_apiref.html">doctoc_plugin_apiref</a></td> <td class="#doctools_tocright">doctoc plugin API reference</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools'><a href="files/modules/doctools/doctools.html">doctools</a></td> <td class="#doctools_tocright">doctools - Processing documents</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools2idx_introduction'><a href="files/modules/doctools2idx/idx_introduction.html">doctools2idx_introduction</a></td> <td class="#doctools_tocright">DocTools - Keyword indices</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools2toc_introduction'><a href="files/modules/doctools2toc/toc_introduction.html">doctools2toc_introduction</a></td> <td class="#doctools_tocright">DocTools - Tables of Contents</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_changelog'><a href="files/modules/doctools/changelog.html">doctools::changelog</a></td> <td class="#doctools_tocright">Processing text in Emacs ChangeLog format</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_cvs'><a href="files/modules/doctools/cvs.html">doctools::cvs</a></td> <td class="#doctools_tocright">Processing text in 'cvs log' format</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_html_cssdefaults'><a href="files/modules/doctools2base/html_cssdefaults.html">doctools::html::cssdefaults</a></td> <td class="#doctools_tocright">Default CSS style for HTML export plugins</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx'><a href="files/modules/doctools/docidx.html">doctools::idx</a></td> <td class="#doctools_tocright">docidx - Processing indices</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx'><a href="files/modules/doctools2idx/idx_container.html">doctools::idx</a></td> <td class="#doctools_tocright">Holding keyword indices</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx_export'><a href="files/modules/doctools2idx/idx_export.html">doctools::idx::export</a></td> <td class="#doctools_tocright">Exporting keyword indices</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx_export_docidx'><a href="files/modules/doctools2idx/export_docidx.html">doctools::idx::export::docidx</a></td> <td class="#doctools_tocright">docidx export plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx_export_html'><a href="files/modules/doctools2idx/idx_export_html.html">doctools::idx::export::html</a></td> <td class="#doctools_tocright">HTML export plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx_export_json'><a href="files/modules/doctools2idx/idx_export_json.html">doctools::idx::export::json</a></td> <td class="#doctools_tocright">JSON export plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx_export_nroff'><a href="files/modules/doctools2idx/idx_export_nroff.html">doctools::idx::export::nroff</a></td> <td class="#doctools_tocright">nroff export plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx_export_text'><a href="files/modules/doctools2idx/idx_export_text.html">doctools::idx::export::text</a></td> <td class="#doctools_tocright">plain text export plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx_export_wiki'><a href="files/modules/doctools2idx/idx_export_wiki.html">doctools::idx::export::wiki</a></td> <td class="#doctools_tocright">wiki export plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx_import'><a href="files/modules/doctools2idx/idx_import.html">doctools::idx::import</a></td> <td class="#doctools_tocright">Importing keyword indices</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx_import_docidx'><a href="files/modules/doctools2idx/import_docidx.html">doctools::idx::import::docidx</a></td> <td class="#doctools_tocright">docidx import plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx_import_json'><a href="files/modules/doctools2idx/idx_import_json.html">doctools::idx::import::json</a></td> <td class="#doctools_tocright">JSON import plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_idx_parse'><a href="files/modules/doctools2idx/idx_parse.html">doctools::idx::parse</a></td> <td class="#doctools_tocright">Parsing text in docidx format</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_idx_structure'><a href="files/modules/doctools2idx/idx_structure.html">doctools::idx::structure</a></td> <td class="#doctools_tocright">Docidx serialization utilities</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_msgcat'><a href="files/modules/doctools2base/tcllib_msgcat.html">doctools::msgcat</a></td> <td class="#doctools_tocright">Message catalog management for the various document parsers</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_idx_c'><a href="files/modules/doctools2idx/idx_msgcat_c.html">doctools::msgcat::idx::c</a></td> <td class="#doctools_tocright">Message catalog for the docidx parser (C)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_idx_de'><a href="files/modules/doctools2idx/idx_msgcat_de.html">doctools::msgcat::idx::de</a></td> <td class="#doctools_tocright">Message catalog for the docidx parser (DE)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_idx_en'><a href="files/modules/doctools2idx/idx_msgcat_en.html">doctools::msgcat::idx::en</a></td> <td class="#doctools_tocright">Message catalog for the docidx parser (EN)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_idx_fr'><a href="files/modules/doctools2idx/idx_msgcat_fr.html">doctools::msgcat::idx::fr</a></td> <td class="#doctools_tocright">Message catalog for the docidx parser (FR)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_toc_c'><a href="files/modules/doctools2toc/toc_msgcat_c.html">doctools::msgcat::toc::c</a></td> <td class="#doctools_tocright">Message catalog for the doctoc parser (C)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_toc_de'><a href="files/modules/doctools2toc/toc_msgcat_de.html">doctools::msgcat::toc::de</a></td> <td class="#doctools_tocright">Message catalog for the doctoc parser (DE)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_toc_en'><a href="files/modules/doctools2toc/toc_msgcat_en.html">doctools::msgcat::toc::en</a></td> <td class="#doctools_tocright">Message catalog for the doctoc parser (EN)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_msgcat_toc_fr'><a href="files/modules/doctools2toc/toc_msgcat_fr.html">doctools::msgcat::toc::fr</a></td> <td class="#doctools_tocright">Message catalog for the doctoc parser (FR)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_nroff_man_macros'><a href="files/modules/doctools2base/nroff_manmacros.html">doctools::nroff::man_macros</a></td> <td class="#doctools_tocright">Default CSS style for NROFF export plugins</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_tcl_parse'><a href="files/modules/doctools2base/tcl_parse.html">doctools::tcl::parse</a></td> <td class="#doctools_tocright">Processing text in 'subst -novariables' format</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc'><a href="files/modules/doctools2toc/toc_container.html">doctools::toc</a></td> <td class="#doctools_tocright">Holding tables of contents</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc'><a href="files/modules/doctools/doctoc.html">doctools::toc</a></td> <td class="#doctools_tocright">doctoc - Processing tables of contents</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc_export'><a href="files/modules/doctools2toc/toc_export.html">doctools::toc::export</a></td> <td class="#doctools_tocright">Exporting tables of contents</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc_export_doctoc'><a href="files/modules/doctools2toc/export_doctoc.html">doctools::toc::export::doctoc</a></td> <td class="#doctools_tocright">doctoc export plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc_export_html'><a href="files/modules/doctools2toc/toc_export_html.html">doctools::toc::export::html</a></td> <td class="#doctools_tocright">HTML export plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc_export_json'><a href="files/modules/doctools2toc/toc_export_json.html">doctools::toc::export::json</a></td> <td class="#doctools_tocright">JSON export plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc_export_nroff'><a href="files/modules/doctools2toc/toc_export_nroff.html">doctools::toc::export::nroff</a></td> <td class="#doctools_tocright">nroff export plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc_export_text'><a href="files/modules/doctools2toc/toc_export_text.html">doctools::toc::export::text</a></td> <td class="#doctools_tocright">plain text export plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc_export_wiki'><a href="files/modules/doctools2toc/toc_export_wiki.html">doctools::toc::export::wiki</a></td> <td class="#doctools_tocright">wiki export plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc_import'><a href="files/modules/doctools2toc/toc_import.html">doctools::toc::import</a></td> <td class="#doctools_tocright">Importing keyword indices</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc_import_doctoc'><a href="files/modules/doctools2toc/import_doctoc.html">doctools::toc::import::doctoc</a></td> <td class="#doctools_tocright">doctoc import plugin</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc_import_json'><a href="files/modules/doctools2toc/toc_import_json.html">doctools::toc::import::json</a></td> <td class="#doctools_tocright">JSON import plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_toc_parse'><a href="files/modules/doctools2toc/toc_parse.html">doctools::toc::parse</a></td> <td class="#doctools_tocright">Parsing text in doctoc format</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_toc_structure'><a href="files/modules/doctools2toc/toc_structure.html">doctools::toc::structure</a></td> <td class="#doctools_tocright">Doctoc serialization utilities</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_intro'><a href="files/modules/doctools/doctools_intro.html">doctools_intro</a></td> <td class="#doctools_tocright">doctools introduction</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_lang_cmdref'><a href="files/modules/doctools/doctools_lang_cmdref.html">doctools_lang_cmdref</a></td> <td class="#doctools_tocright">doctools language command reference</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_lang_faq'><a href="files/modules/doctools/doctools_lang_faq.html">doctools_lang_faq</a></td> <td class="#doctools_tocright">doctools language faq</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_lang_intro'><a href="files/modules/doctools/doctools_lang_intro.html">doctools_lang_intro</a></td> <td class="#doctools_tocright">doctools language introduction</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='doctools_lang_syntax'><a href="files/modules/doctools/doctools_lang_syntax.html">doctools_lang_syntax</a></td> <td class="#doctools_tocright">doctools language syntax</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='doctools_plugin_apiref'><a href="files/modules/doctools/doctools_plugin_apiref.html">doctools_plugin_apiref</a></td> <td class="#doctools_tocright">doctools plugin API reference</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='dtplite'><a href="files/apps/dtplite.html">dtplite</a></td> <td class="#doctools_tocright">Lightweight DocTools Markup Processor</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='dtplite'><a href="files/modules/dtplite/pkg_dtplite.html">dtplite</a></td> <td class="#doctools_tocright">Lightweight DocTools Markup Processor</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil'><a href="files/modules/fileutil/fileutil.html">fileutil</a></td> <td class="#doctools_tocright">Procedures implementing some file utilities</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_magic_cfront'><a href="files/modules/fumagic/cfront.html">fileutil::magic::cfront</a></td> <td class="#doctools_tocright">Generator core for compiler of magic(5) files</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_magic_cgen'><a href="files/modules/fumagic/cgen.html">fileutil::magic::cgen</a></td> <td class="#doctools_tocright">Generator core for compiler of magic(5) files</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_magic_filetype'><a href="files/modules/fumagic/filetypes.html">fileutil::magic::filetype</a></td> <td class="#doctools_tocright">Procedures implementing file-type recognition</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_magic_rt'><a href="files/modules/fumagic/rtcore.html">fileutil::magic::rt</a></td> <td class="#doctools_tocright">Runtime core for file type recognition engines written in pure Tcl</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi'><a href="files/modules/fileutil/multi.html">fileutil::multi</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_paths'><a href="files/modules/fileutil/paths.html">fileutil::paths</a></td> <td class="#doctools_tocright">Manage search path pools</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ftp'><a href="files/modules/ftp/ftp.html">ftp</a></td> <td class="#doctools_tocright">Client-side tcl implementation of the ftp protocol</td> |
︙ | ︙ | |||
577 578 579 580 581 582 583 584 585 586 | <td class="#doctools_tocright">Procedures to generate HTML structures</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='htmlparse'><a href="files/modules/htmlparse/htmlparse.html">htmlparse</a></td> <td class="#doctools_tocright">Procedures to parse HTML strings</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='huddle'><a href="files/modules/yaml/huddle.html">huddle</a></td> <td class="#doctools_tocright">Create and manipulate huddle object</td> </tr> | > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > | 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 | <td class="#doctools_tocright">Procedures to generate HTML structures</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='htmlparse'><a href="files/modules/htmlparse/htmlparse.html">htmlparse</a></td> <td class="#doctools_tocright">Procedures to parse HTML strings</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='httpd'><a href="files/modules/httpd/httpd.html">httpd</a></td> <td class="#doctools_tocright">A TclOO and coroutine based web server</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='huddle'><a href="files/modules/yaml/huddle.html">huddle</a></td> <td class="#doctools_tocright">Create and manipulate huddle object</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ident'><a href="files/modules/ident/ident.html">ident</a></td> <td class="#doctools_tocright">Ident protocol client</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='imap4'><a href="files/modules/imap4/imap4.html">imap4</a></td> <td class="#doctools_tocright">imap client-side tcl implementation of imap protocol</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='inifile'><a href="files/modules/inifile/ini.html">inifile</a></td> <td class="#doctools_tocright">Parsing of Windows INI files</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='interp'><a href="files/modules/interp/tcllib_interp.html">interp</a></td> <td class="#doctools_tocright">Interp creation and aliasing</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='irc'><a href="files/modules/irc/irc.html">irc</a></td> <td class="#doctools_tocright">Create IRC connection and interface.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='javascript'><a href="files/modules/javascript/javascript.html">javascript</a></td> <td class="#doctools_tocright">Procedures to generate HTML and Java Script structures.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='jpeg'><a href="files/modules/jpeg/jpeg.html">jpeg</a></td> <td class="#doctools_tocright">JPEG querying and manipulation of meta data</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='json'><a href="files/modules/json/json.html">json</a></td> <td class="#doctools_tocright">JSON parser</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='json_write'><a href="files/modules/json/json_write.html">json::write</a></td> <td class="#doctools_tocright">JSON generation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='lambda'><a href="files/modules/lambda/lambda.html">lambda</a></td> <td class="#doctools_tocright">Utility commands for anonymous procedures</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='lazyset'><a href="files/modules/lazyset/lazyset.html">lazyset</a></td> <td class="#doctools_tocright">Lazy evaluation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ldap'><a href="files/modules/ldap/ldap.html">ldap</a></td> <td class="#doctools_tocright">LDAP client</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ldapx'><a href="files/modules/ldap/ldapx.html">ldapx</a></td> <td class="#doctools_tocright">LDAP extended object interface</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='log'><a href="files/modules/log/log.html">log</a></td> <td class="#doctools_tocright">Procedures to log messages of libraries and applications.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='logger'><a href="files/modules/log/logger.html">logger</a></td> <td class="#doctools_tocright">System to control logging of events.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='logger_appender'><a href="files/modules/log/loggerAppender.html">logger::appender</a></td> <td class="#doctools_tocright">Collection of predefined appenders for logger</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='logger_utils'><a href="files/modules/log/loggerUtils.html">logger::utils</a></td> <td class="#doctools_tocright">Utilities for logger</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='map_geocode_nominatim'><a href="files/modules/map/map_geocode_nominatim.html">map::geocode::nominatim</a></td> <td class="#doctools_tocright">Resolving geographical names with a Nominatim service</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='map_slippy'><a href="files/modules/map/map_slippy.html">map::slippy</a></td> <td class="#doctools_tocright">Common code for slippy based map packages</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='map_slippy_cache'><a href="files/modules/map/map_slippy_cache.html">map::slippy::cache</a></td> <td class="#doctools_tocright">Management of a tile cache in the local filesystem</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='map_slippy_fetcher'><a href="files/modules/map/map_slippy_fetcher.html">map::slippy::fetcher</a></td> <td class="#doctools_tocright">Accessing a server providing tiles for slippy-based maps</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='mapproj'><a href="files/modules/mapproj/mapproj.html">mapproj</a></td> <td class="#doctools_tocright">Map projection routines</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='markdown'><a href="files/modules/markdown/markdown.html">markdown</a></td> <td class="#doctools_tocright">Converts Markdown text to HTML</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math'><a href="files/modules/math/math.html">math</a></td> <td class="#doctools_tocright">Tcl Math Library</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_bigfloat'><a href="files/modules/math/bigfloat.html">math::bigfloat</a></td> <td class="#doctools_tocright">Arbitrary precision floating-point numbers</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_bignum'><a href="files/modules/math/bignum.html">math::bignum</a></td> <td class="#doctools_tocright">Arbitrary precision integer numbers</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_calculus'><a href="files/modules/math/calculus.html">math::calculus</a></td> <td class="#doctools_tocright">Integration and ordinary differential equations</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_calculus_romberg'><a href="files/modules/math/romberg.html">math::calculus::romberg</a></td> <td class="#doctools_tocright">Romberg integration</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_calculus_symdiff'><a href="files/modules/math/symdiff.html">math::calculus::symdiff</a></td> <td class="#doctools_tocright">Symbolic differentiation for Tcl</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_combinatorics'><a href="files/modules/math/combinatorics.html">math::combinatorics</a></td> <td class="#doctools_tocright">Combinatorial functions in the Tcl Math Library</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_complexnumbers'><a href="files/modules/math/qcomplex.html">math::complexnumbers</a></td> <td class="#doctools_tocright">Straightforward complex number package</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_constants'><a href="files/modules/math/constants.html">math::constants</a></td> <td class="#doctools_tocright">Mathematical and numerical constants</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_decimal'><a href="files/modules/math/decimal.html">math::decimal</a></td> <td class="#doctools_tocright">General decimal arithmetic</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_exact'><a href="files/modules/math/exact.html">math::exact</a></td> <td class="#doctools_tocright">Exact Real Arithmetic</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_fourier'><a href="files/modules/math/fourier.html">math::fourier</a></td> <td class="#doctools_tocright">Discrete and fast fourier transforms</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_fuzzy'><a href="files/modules/math/fuzzy.html">math::fuzzy</a></td> <td class="#doctools_tocright">Fuzzy comparison of floating-point numbers</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_geometry'><a href="files/modules/math/math_geometry.html">math::geometry</a></td> <td class="#doctools_tocright">Geometrical computations</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_interpolate'><a href="files/modules/math/interpolate.html">math::interpolate</a></td> <td class="#doctools_tocright">Interpolation routines</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_linearalgebra'><a href="files/modules/math/linalg.html">math::linearalgebra</a></td> <td class="#doctools_tocright">Linear Algebra</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_numtheory'><a href="files/modules/math/numtheory.html">math::numtheory</a></td> <td class="#doctools_tocright">Number Theory</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_optimize'><a href="files/modules/math/optimize.html">math::optimize</a></td> <td class="#doctools_tocright">Optimisation routines</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_pca'><a href="files/modules/math/pca.html">math::PCA</a></td> <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_quasirandom'><a href="files/modules/math/quasirandom.html">math::quasirandom</a></td> <td class="#doctools_tocright">Quasi-random points for integration and Monte Carlo type methods</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_roman'><a href="files/modules/math/roman.html">math::roman</a></td> <td class="#doctools_tocright">Tools for creating and manipulating roman numerals</td> |
︙ | ︙ | |||
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 | <td class="#doctools_tocright">Create and manipulate directed graph objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_list'><a href="files/modules/struct/struct_list.html">struct::list</a></td> <td class="#doctools_tocright">Procedures for manipulating lists</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_matrix'><a href="files/modules/struct/matrix.html">struct::matrix</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> | > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > > > > > > > > > > > > > > > > > > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | < < < < | 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 | <td class="#doctools_tocright">Create and manipulate directed graph objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_list'><a href="files/modules/struct/struct_list.html">struct::list</a></td> <td class="#doctools_tocright">Procedures for manipulating lists</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_map'><a href="files/modules/struct/struct_map.html">struct::map</a></td> <td class="#doctools_tocright">Manage key/value maps</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_matrix'><a href="files/modules/struct/matrix.html">struct::matrix</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_matrix_v1'><a href="files/modules/struct/matrix1.html">struct::matrix_v1</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_pool'><a href="files/modules/struct/pool.html">struct::pool</a></td> <td class="#doctools_tocright">Create and manipulate pool objects (of discrete items)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_prioqueue'><a href="files/modules/struct/prioqueue.html">struct::prioqueue</a></td> <td class="#doctools_tocright">Create and manipulate prioqueue objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_queue'><a href="files/modules/struct/queue.html">struct::queue</a></td> <td class="#doctools_tocright">Create and manipulate queue objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_record'><a href="files/modules/struct/record.html">struct::record</a></td> <td class="#doctools_tocright">Define and create records (similar to 'C' structures)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_set'><a href="files/modules/struct/struct_set.html">struct::set</a></td> <td class="#doctools_tocright">Procedures for manipulating sets</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_skiplist'><a href="files/modules/struct/skiplist.html">struct::skiplist</a></td> <td class="#doctools_tocright">Create and manipulate skiplists</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_stack'><a href="files/modules/struct/stack.html">struct::stack</a></td> <td class="#doctools_tocright">Create and manipulate stack objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_tree'><a href="files/modules/struct/struct_tree.html">struct::tree</a></td> <td class="#doctools_tocright">Create and manipulate tree objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_tree_v1'><a href="files/modules/struct/struct_tree1.html">struct::tree_v1</a></td> <td class="#doctools_tocright">Create and manipulate tree objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='sum'><a href="files/modules/crc/sum.html">sum</a></td> <td class="#doctools_tocright">Calculate a sum(1) compatible checksum</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='switched'><a href="files/modules/stooop/switched.html">switched</a></td> <td class="#doctools_tocright">switch/option management.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tar'><a href="files/modules/tar/tar.html">tar</a></td> <td class="#doctools_tocright">Tar file creation, extraction & manipulation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_cat'><a href="files/modules/virtchannel_base/cat.html">tcl::chan::cat</a></td> <td class="#doctools_tocright">Concatenation channel</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_core'><a href="files/modules/virtchannel_core/core.html">tcl::chan::core</a></td> <td class="#doctools_tocright">Basic reflected/virtual channel support</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_events'><a href="files/modules/virtchannel_core/events.html">tcl::chan::events</a></td> <td class="#doctools_tocright">Event support for reflected/virtual channels</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_facade'><a href="files/modules/virtchannel_base/facade.html">tcl::chan::facade</a></td> <td class="#doctools_tocright">Facade channel</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_fifo'><a href="files/modules/virtchannel_base/tcllib_fifo.html">tcl::chan::fifo</a></td> <td class="#doctools_tocright">In-memory fifo channel</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_fifo2'><a href="files/modules/virtchannel_base/tcllib_fifo2.html">tcl::chan::fifo2</a></td> <td class="#doctools_tocright">In-memory interconnected fifo channels</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_halfpipe'><a href="files/modules/virtchannel_base/halfpipe.html">tcl::chan::halfpipe</a></td> <td class="#doctools_tocright">In-memory channel, half of a fifo2</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_memchan'><a href="files/modules/virtchannel_base/tcllib_memchan.html">tcl::chan::memchan</a></td> <td class="#doctools_tocright">In-memory channel</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_null'><a href="files/modules/virtchannel_base/tcllib_null.html">tcl::chan::null</a></td> <td class="#doctools_tocright">Null channel</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_nullzero'><a href="files/modules/virtchannel_base/nullzero.html">tcl::chan::nullzero</a></td> <td class="#doctools_tocright">Null/Zero channel combination</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_random'><a href="files/modules/virtchannel_base/tcllib_random.html">tcl::chan::random</a></td> <td class="#doctools_tocright">Random channel</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_std'><a href="files/modules/virtchannel_base/std.html">tcl::chan::std</a></td> <td class="#doctools_tocright">Standard I/O, unification of stdin and stdout</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_string'><a href="files/modules/virtchannel_base/tcllib_string.html">tcl::chan::string</a></td> <td class="#doctools_tocright">Read-only in-memory channel</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_textwindow'><a href="files/modules/virtchannel_base/textwindow.html">tcl::chan::textwindow</a></td> <td class="#doctools_tocright">Textwindow channel</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_chan_variable'><a href="files/modules/virtchannel_base/tcllib_variable.html">tcl::chan::variable</a></td> <td class="#doctools_tocright">In-memory channel using variable for storage</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_chan_zero'><a href="files/modules/virtchannel_base/tcllib_zero.html">tcl::chan::zero</a></td> <td class="#doctools_tocright">Zero channel</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_randomseed'><a href="files/modules/virtchannel_base/randseed.html">tcl::randomseed</a></td> <td class="#doctools_tocright">Utilities for random channels</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_adler32'><a href="files/modules/virtchannel_transform/adler32.html">tcl::transform::adler32</a></td> <td class="#doctools_tocright">Adler32 transformation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_transform_base64'><a href="files/modules/virtchannel_transform/vt_base64.html">tcl::transform::base64</a></td> <td class="#doctools_tocright">Base64 encoding transformation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_core'><a href="files/modules/virtchannel_core/transformcore.html">tcl::transform::core</a></td> <td class="#doctools_tocright">Basic reflected/virtual channel transform support</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_transform_counter'><a href="files/modules/virtchannel_transform/vt_counter.html">tcl::transform::counter</a></td> <td class="#doctools_tocright">Counter transformation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_crc32'><a href="files/modules/virtchannel_transform/vt_crc32.html">tcl::transform::crc32</a></td> <td class="#doctools_tocright">Crc32 transformation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_transform_hex'><a href="files/modules/virtchannel_transform/hex.html">tcl::transform::hex</a></td> <td class="#doctools_tocright">Hexadecimal encoding transformation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_identity'><a href="files/modules/virtchannel_transform/identity.html">tcl::transform::identity</a></td> <td class="#doctools_tocright">Identity transformation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_transform_limitsize'><a href="files/modules/virtchannel_transform/limitsize.html">tcl::transform::limitsize</a></td> <td class="#doctools_tocright">limiting input</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_observe'><a href="files/modules/virtchannel_transform/observe.html">tcl::transform::observe</a></td> <td class="#doctools_tocright">Observer transformation, stream copy</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_transform_otp'><a href="files/modules/virtchannel_transform/vt_otp.html">tcl::transform::otp</a></td> <td class="#doctools_tocright">Encryption via one-time pad</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_rot'><a href="files/modules/virtchannel_transform/rot.html">tcl::transform::rot</a></td> <td class="#doctools_tocright">rot-encryption</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_transform_spacer'><a href="files/modules/virtchannel_transform/spacer.html">tcl::transform::spacer</a></td> <td class="#doctools_tocright">Space insertation and removal</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcl_transform_zlib'><a href="files/modules/virtchannel_transform/tcllib_zlib.html">tcl::transform::zlib</a></td> <td class="#doctools_tocright">zlib (de)compression</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcl_community_communication'><a href="files/devdoc/tcl_community_communication.html">tcl_community_communication</a></td> <td class="#doctools_tocright">Tcl Community - Kind Communication</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcldes'><a href="files/modules/des/tcldes.html">tclDES</a></td> <td class="#doctools_tocright">Implementation of the DES and triple-DES ciphers</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcldesjr'><a href="files/modules/des/tcldesjr.html">tclDESjr</a></td> <td class="#doctools_tocright">Implementation of the DES and triple-DES ciphers</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcldocstrip'><a href="files/apps/tcldocstrip.html">tcldocstrip</a></td> <td class="#doctools_tocright">Tcl-based Docstrip Processor</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_devguide'><a href="files/devdoc/tcllib_devguide.html">tcllib_devguide</a></td> <td class="#doctools_tocright">Tcllib - The Developer's Guide</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcllib_install_guide'><a href="files/devdoc/tcllib_installer.html">tcllib_install_guide</a></td> <td class="#doctools_tocright">Tcllib - The Installer's Guide</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_ip'><a href="files/modules/dns/tcllib_ip.html">tcllib_ip</a></td> <td class="#doctools_tocright">IPv4 and IPv6 address manipulation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcllib_license'><a href="files/devdoc/tcllib_license.html">tcllib_license</a></td> <td class="#doctools_tocright">Tcllib - License</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_releasemgr'><a href="files/devdoc/tcllib_releasemgr.html">tcllib_releasemgr</a></td> <td class="#doctools_tocright">Tcllib - The Release Manager's Guide</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tcllib_sources'><a href="files/devdoc/tcllib_sources.html">tcllib_sources</a></td> <td class="#doctools_tocright">Tcllib - How To Get The Sources</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tepam'><a href="files/modules/tepam/tepam_introduction.html">tepam</a></td> <td class="#doctools_tocright">An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tepam_argument_dialogbox'><a href="files/modules/tepam/tepam_argument_dialogbox.html">tepam::argument_dialogbox</a></td> <td class="#doctools_tocright">TEPAM argument_dialogbox, reference manual</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tepam_doc_gen'><a href="files/modules/tepam/tepam_doc_gen.html">tepam::doc_gen</a></td> <td class="#doctools_tocright">TEPAM DOC Generation, reference manual</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tepam_procedure'><a href="files/modules/tepam/tepam_procedure.html">tepam::procedure</a></td> <td class="#doctools_tocright">TEPAM procedure, reference manual</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='term'><a href="files/modules/term/term.html">term</a></td> <td class="#doctools_tocright">General terminal control</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='term_ansi_code'><a href="files/modules/term/ansi_code.html">term::ansi::code</a></td> <td class="#doctools_tocright">Helper for control sequences</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='term_ansi_code_attr'><a href="files/modules/term/ansi_cattr.html">term::ansi::code::attr</a></td> <td class="#doctools_tocright">ANSI attribute sequences</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='term_ansi_code_ctrl'><a href="files/modules/term/ansi_cctrl.html">term::ansi::code::ctrl</a></td> <td class="#doctools_tocright">ANSI control sequences</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='term_ansi_code_macros'><a href="files/modules/term/ansi_cmacros.html">term::ansi::code::macros</a></td> <td class="#doctools_tocright">Macro sequences</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='term_ansi_ctrl_unix'><a href="files/modules/term/ansi_ctrlu.html">term::ansi::ctrl::unix</a></td> <td class="#doctools_tocright">Control operations and queries</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='term_ansi_send'><a href="files/modules/term/ansi_send.html">term::ansi::send</a></td> <td class="#doctools_tocright">Output of ANSI control sequences to terminals</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='term_interact_menu'><a href="files/modules/term/imenu.html">term::interact::menu</a></td> <td class="#doctools_tocright">Terminal widget, menu</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='term_interact_pager'><a href="files/modules/term/ipager.html">term::interact::pager</a></td> <td class="#doctools_tocright">Terminal widget, paging</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='term_receive'><a href="files/modules/term/receive.html">term::receive</a></td> <td class="#doctools_tocright">General input from terminals</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='term_receive_bind'><a href="files/modules/term/term_bind.html">term::receive::bind</a></td> <td class="#doctools_tocright">Keyboard dispatch from terminals</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='term_send'><a href="files/modules/term/term_send.html">term::send</a></td> <td class="#doctools_tocright">General output to terminals</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='textutil'><a href="files/modules/textutil/textutil.html">textutil</a></td> <td class="#doctools_tocright">Procedures to manipulate texts and strings.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='textutil_adjust'><a href="files/modules/textutil/adjust.html">textutil::adjust</a></td> <td class="#doctools_tocright">Procedures to adjust, indent, and undent paragraphs</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='textutil_expander'><a href="files/modules/textutil/expander.html">textutil::expander</a></td> <td class="#doctools_tocright">Procedures to process templates and expand text.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='textutil_repeat'><a href="files/modules/textutil/repeat.html">textutil::repeat</a></td> <td class="#doctools_tocright">Procedures to repeat strings.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='textutil_split'><a href="files/modules/textutil/textutil_split.html">textutil::split</a></td> <td class="#doctools_tocright">Procedures to split texts</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='textutil_string'><a href="files/modules/textutil/textutil_string.html">textutil::string</a></td> <td class="#doctools_tocright">Procedures to manipulate texts and strings.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='textutil_tabify'><a href="files/modules/textutil/tabify.html">textutil::tabify</a></td> <td class="#doctools_tocright">Procedures to (un)tabify strings</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='textutil_trim'><a href="files/modules/textutil/trim.html">textutil::trim</a></td> <td class="#doctools_tocright">Procedures to trim strings</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='throw'><a href="files/modules/try/tcllib_throw.html">throw</a></td> <td class="#doctools_tocright">throw - Throw an error exception with a message</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tie'><a href="files/modules/tie/tie_std.html">tie</a></td> <td class="#doctools_tocright">Array persistence, standard data sources</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tie'><a href="files/modules/tie/tie.html">tie</a></td> <td class="#doctools_tocright">Array persistence</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tiff'><a href="files/modules/tiff/tiff.html">tiff</a></td> <td class="#doctools_tocright">TIFF reading, writing, and querying and manipulation of meta data</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tool'><a href="files/modules/tool/tool.html">tool</a></td> <td class="#doctools_tocright">TclOO Library (TOOL) Framework</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tool_dict_ensemble'><a href="files/modules/tool/tool_dict_ensemble.html">tool::dict_ensemble</a></td> <td class="#doctools_tocright">Dictionary Tools</td> |
︙ | ︙ |
Changes to idoc/www/toc.html.
︙ | ︙ | |||
795 796 797 798 799 800 801 802 803 804 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> | > > > > | | | | | | | | 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 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_quasirandom'><a href="tcllib/files/modules/math/quasirandom.html">math::quasirandom</a></td> <td class="#doctools_tocright">Quasi-random points for integration and Monte Carlo type methods</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_roman'><a href="tcllib/files/modules/math/roman.html">math::roman</a></td> <td class="#doctools_tocright">Tools for creating and manipulating roman numerals</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_special'><a href="tcllib/files/modules/math/special.html">math::special</a></td> <td class="#doctools_tocright">Special mathematical functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_statistics'><a href="tcllib/files/modules/math/statistics.html">math::statistics</a></td> <td class="#doctools_tocright">Basic statistical functions and procedures</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_trig'><a href="tcllib/files/modules/math/trig.html">math::trig</a></td> <td class="#doctools_tocright">Trigonometric anf hyperbolic functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='simulation_annealing'><a href="tcllib/files/modules/simulation/annealing.html">simulation::annealing</a></td> <td class="#doctools_tocright">Simulated annealing</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='simulation_montecarlo'><a href="tcllib/files/modules/simulation/montecarlo.html">simulation::montecarlo</a></td> <td class="#doctools_tocright">Monte Carlo simulations</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='simulation_random'><a href="tcllib/files/modules/simulation/simulation_random.html">simulation::random</a></td> <td class="#doctools_tocright">Pseudo-random number generators</td> </tr> </table></dl> <dl><dt><a name='networking'>Networking</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 | <td class="#doctools_tocright">Uri handler for ftp urls</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ftpd'><a href="tcllib/files/modules/ftpd/ftpd.html">ftpd</a></td> <td class="#doctools_tocright">Tcl FTP server implementation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ident'><a href="tcllib/files/modules/ident/ident.html">ident</a></td> <td class="#doctools_tocright">Ident protocol client</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='irc'><a href="tcllib/files/modules/irc/irc.html">irc</a></td> <td class="#doctools_tocright">Create IRC connection and interface.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ldap'><a href="tcllib/files/modules/ldap/ldap.html">ldap</a></td> <td class="#doctools_tocright">LDAP client</td> | > > > > > > > > | 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 | <td class="#doctools_tocright">Uri handler for ftp urls</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ftpd'><a href="tcllib/files/modules/ftpd/ftpd.html">ftpd</a></td> <td class="#doctools_tocright">Tcl FTP server implementation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='httpd'><a href="tcllib/files/modules/httpd/httpd.html">httpd</a></td> <td class="#doctools_tocright">A TclOO and coroutine based web server</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ident'><a href="tcllib/files/modules/ident/ident.html">ident</a></td> <td class="#doctools_tocright">Ident protocol client</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='imap4'><a href="tcllib/files/modules/imap4/imap4.html">imap4</a></td> <td class="#doctools_tocright">imap client-side tcl implementation of imap protocol</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='irc'><a href="tcllib/files/modules/irc/irc.html">irc</a></td> <td class="#doctools_tocright">Create IRC connection and interface.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ldap'><a href="tcllib/files/modules/ldap/ldap.html">ldap</a></td> <td class="#doctools_tocright">LDAP client</td> |
︙ | ︙ | |||
978 979 980 981 982 983 984 | <td class="#doctools_tocright">Tcl SMTP server implementation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_ip'><a href="tcllib/files/modules/dns/tcllib_ip.html">tcllib_ip</a></td> <td class="#doctools_tocright">IPv4 and IPv6 address manipulation</td> </tr> <tr class="#doctools_tocodd" > | < < < < | | | | 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 | <td class="#doctools_tocright">Tcl SMTP server implementation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_ip'><a href="tcllib/files/modules/dns/tcllib_ip.html">tcllib_ip</a></td> <td class="#doctools_tocright">IPv4 and IPv6 address manipulation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='udpcluster'><a href="tcllib/files/modules/udpcluster/udpcluster.html">udpcluster</a></td> <td class="#doctools_tocright">UDP Peer-to-Peer cluster</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='uri'><a href="tcllib/files/modules/uri/uri.html">uri</a></td> <td class="#doctools_tocright">URI utilities</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='uri_urn'><a href="tcllib/files/modules/uri/urn-scheme.html">uri_urn</a></td> <td class="#doctools_tocright">URI utilities, URN scheme</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='websocket'><a href="tcllib/files/modules/websocket/websocket.html">websocket</a></td> <td class="#doctools_tocright">Tcl implementation of the websocket protocol</td> </tr> </table></dl> <dl><dt><a name='page_parser_generator'>Page Parser Generator</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 | <td class="#doctools_tocleft" ><a name='tepam_procedure'><a href="tcllib/files/modules/tepam/tepam_procedure.html">tepam::procedure</a></td> <td class="#doctools_tocright">TEPAM procedure, reference manual</td> </tr> </table></dl> <dl><dt><a name='programming_tools'>Programming tools</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cmdline'><a href="tcllib/files/modules/cmdline/cmdline.html">cmdline</a></td> <td class="#doctools_tocright">Procedures to process command lines and options.</td> </tr> | > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 | <td class="#doctools_tocleft" ><a name='tepam_procedure'><a href="tcllib/files/modules/tepam/tepam_procedure.html">tepam::procedure</a></td> <td class="#doctools_tocright">TEPAM procedure, reference manual</td> </tr> </table></dl> <dl><dt><a name='programming_tools'>Programming tools</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clay'><a href="tcllib/files/modules/clay/clay.html">clay</a></td> <td class="#doctools_tocright">A minimalist framework for large scale OO Projects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='cmdline'><a href="tcllib/files/modules/cmdline/cmdline.html">cmdline</a></td> <td class="#doctools_tocright">Procedures to process command lines and options.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='comm'><a href="tcllib/files/modules/comm/comm.html">comm</a></td> <td class="#doctools_tocright">A remote communication facility for Tcl (8.3 and later)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='comm_wire'><a href="tcllib/files/modules/comm/comm_wire.html">comm_wire</a></td> <td class="#doctools_tocright">The comm wire protocol</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='control'><a href="tcllib/files/modules/control/control.html">control</a></td> <td class="#doctools_tocright">Procedures for control flow structures.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='deleg_method'><a href="tcllib/files/modules/interp/deleg_method.html">deleg_method</a></td> <td class="#doctools_tocright">Creation of comm delegates (snit methods)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='deleg_proc'><a href="tcllib/files/modules/interp/deleg_proc.html">deleg_proc</a></td> <td class="#doctools_tocright">Creation of comm delegates (procedures)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil'><a href="tcllib/files/modules/fileutil/fileutil.html">fileutil</a></td> <td class="#doctools_tocright">Procedures implementing some file utilities</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_magic_cfront'><a href="tcllib/files/modules/fumagic/cfront.html">fileutil::magic::cfront</a></td> <td class="#doctools_tocright">Generator core for compiler of magic(5) files</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_magic_cgen'><a href="tcllib/files/modules/fumagic/cgen.html">fileutil::magic::cgen</a></td> <td class="#doctools_tocright">Generator core for compiler of magic(5) files</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_magic_filetype'><a href="tcllib/files/modules/fumagic/filetypes.html">fileutil::magic::filetype</a></td> <td class="#doctools_tocright">Procedures implementing file-type recognition</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_magic_rt'><a href="tcllib/files/modules/fumagic/rtcore.html">fileutil::magic::rt</a></td> <td class="#doctools_tocright">Runtime core for file type recognition engines written in pure Tcl</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi'><a href="tcllib/files/modules/fileutil/multi.html">fileutil::multi</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="tcllib/files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="tcllib/files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='hook'><a href="tcllib/files/modules/hook/hook.html">hook</a></td> <td class="#doctools_tocright">Hooks</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='interp'><a href="tcllib/files/modules/interp/tcllib_interp.html">interp</a></td> <td class="#doctools_tocright">Interp creation and aliasing</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='log'><a href="tcllib/files/modules/log/log.html">log</a></td> <td class="#doctools_tocright">Procedures to log messages of libraries and applications.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='logger'><a href="tcllib/files/modules/log/logger.html">logger</a></td> <td class="#doctools_tocright">System to control logging of events.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='logger_appender'><a href="tcllib/files/modules/log/loggerAppender.html">logger::appender</a></td> <td class="#doctools_tocright">Collection of predefined appenders for logger</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='logger_utils'><a href="tcllib/files/modules/log/loggerUtils.html">logger::utils</a></td> <td class="#doctools_tocright">Utilities for logger</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='multiplexer'><a href="tcllib/files/modules/multiplexer/multiplexer.html">multiplexer</a></td> <td class="#doctools_tocright">One-to-many communication with sockets.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='pluginmgr'><a href="tcllib/files/modules/pluginmgr/pluginmgr.html">pluginmgr</a></td> <td class="#doctools_tocright">Manage a plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='profiler'><a href="tcllib/files/modules/profiler/profiler.html">profiler</a></td> <td class="#doctools_tocright">Tcl source code profiler</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='snit'><a href="tcllib/files/modules/snit/snit.html">snit</a></td> <td class="#doctools_tocright">Snit's Not Incr Tcl</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='snitfaq'><a href="tcllib/files/modules/snit/snitfaq.html">snitfaq</a></td> <td class="#doctools_tocright">Snit Frequently Asked Questions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='stooop'><a href="tcllib/files/modules/stooop/stooop.html">stooop</a></td> <td class="#doctools_tocright">Object oriented extension.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='switched'><a href="tcllib/files/modules/stooop/switched.html">switched</a></td> <td class="#doctools_tocright">switch/option management.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tie'><a href="tcllib/files/modules/tie/tie.html">tie</a></td> <td class="#doctools_tocright">Array persistence</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tie'><a href="tcllib/files/modules/tie/tie_std.html">tie</a></td> <td class="#doctools_tocright">Array persistence, standard data sources</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='uevent'><a href="tcllib/files/modules/uev/uevent.html">uevent</a></td> <td class="#doctools_tocright">User events</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='wip'><a href="tcllib/files/modules/wip/wip.html">wip</a></td> <td class="#doctools_tocright">Word Interpreter</td> </tr> </table></dl> <dl><dt><a name='system'>System</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 | <dl><dt><a name='unfiled'>Unfiled</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='generator'><a href="tcllib/files/modules/generator/generator.html">generator</a></td> <td class="#doctools_tocright">Procedures for creating and using generators.</td> </tr> | > > > > | < < < < | 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 | <dl><dt><a name='unfiled'>Unfiled</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_paths'><a href="tcllib/files/modules/fileutil/paths.html">fileutil::paths</a></td> <td class="#doctools_tocright">Manage search path pools</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='generator'><a href="tcllib/files/modules/generator/generator.html">generator</a></td> <td class="#doctools_tocright">Procedures for creating and using generators.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='huddle'><a href="tcllib/files/modules/yaml/huddle.html">huddle</a></td> <td class="#doctools_tocright">Create and manipulate huddle object</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='map_geocode_nominatim'><a href="tcllib/files/modules/map/map_geocode_nominatim.html">map::geocode::nominatim</a></td> <td class="#doctools_tocright">Resolving geographical names with a Nominatim service</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='map_slippy'><a href="tcllib/files/modules/map/map_slippy.html">map::slippy</a></td> <td class="#doctools_tocright">Common code for slippy based map packages</td> |
︙ | ︙ | |||
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 | <td class="#doctools_tocright">Implementation of stringprep</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='stringprep_data'><a href="tcllib/files/modules/stringprep/stringprep_data.html">stringprep::data</a></td> <td class="#doctools_tocright">stringprep data tables, generated, internal</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="tcllib/files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> | > > > > | | | | | | 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 | <td class="#doctools_tocright">Implementation of stringprep</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='stringprep_data'><a href="tcllib/files/modules/stringprep/stringprep_data.html">stringprep::data</a></td> <td class="#doctools_tocright">stringprep data tables, generated, internal</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_map'><a href="tcllib/files/modules/struct/struct_map.html">struct::map</a></td> <td class="#doctools_tocright">Manage key/value maps</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="tcllib/files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='uevent_onidle'><a href="tcllib/files/modules/uev/uevent_onidle.html">uevent::onidle</a></td> <td class="#doctools_tocright">Request merging and deferal to idle time</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='unicode'><a href="tcllib/files/modules/stringprep/unicode.html">unicode</a></td> <td class="#doctools_tocright">Implementation of Unicode normalization</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='unicode_data'><a href="tcllib/files/modules/stringprep/unicode_data.html">unicode::data</a></td> <td class="#doctools_tocright">unicode data tables, generated, internal</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='units'><a href="tcllib/files/modules/units/units.html">units</a></td> <td class="#doctools_tocright">unit conversion</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='yaml'><a href="tcllib/files/modules/yaml/yaml.html">yaml</a></td> <td class="#doctools_tocright">YAML Format Encoder/Decoder</td> </tr> </table></dl> <dl><dt><a name='utilities'>Utilities</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 | </table></dl> <dl><dt><a name='cache'>cache</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> </table></dl> <dl><dt><a name='clock'>clock</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clock_iso8601'><a href="tcllib/files/modules/clock/iso8601.html">clock_iso8601</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> | > > > > > > > | 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 | </table></dl> <dl><dt><a name='cache'>cache</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> </table></dl> <dl><dt><a name='clay'>clay</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clay'><a href="tcllib/files/modules/clay/clay.html">clay</a></td> <td class="#doctools_tocright">A minimalist framework for large scale OO Projects</td> </tr> </table></dl> <dl><dt><a name='clock'>clock</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clock_iso8601'><a href="tcllib/files/modules/clock/iso8601.html">clock_iso8601</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> |
︙ | ︙ | |||
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 | <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="tcllib/files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="tcllib/files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> </table></dl> <dl><dt><a name='ftp'>ftp</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > | > > > > | 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 | <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="tcllib/files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_paths'><a href="tcllib/files/modules/fileutil/paths.html">fileutil::paths</a></td> <td class="#doctools_tocright">Manage search path pools</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="tcllib/files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> </table></dl> <dl><dt><a name='ftp'>ftp</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
2569 2570 2571 2572 2573 2574 2575 | <td class="#doctools_tocleft" ><a name='autoproxy'><a href="tcllib/files/modules/http/autoproxy.html">autoproxy</a></td> <td class="#doctools_tocright">Automatic HTTP proxy usage and authentication</td> </tr> </table></dl> <dl><dt><a name='httpd'>httpd</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > | | | 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 | <td class="#doctools_tocleft" ><a name='autoproxy'><a href="tcllib/files/modules/http/autoproxy.html">autoproxy</a></td> <td class="#doctools_tocright">Automatic HTTP proxy usage and authentication</td> </tr> </table></dl> <dl><dt><a name='httpd'>httpd</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='httpd'><a href="tcllib/files/modules/httpd/httpd.html">httpd</a></td> <td class="#doctools_tocright">A TclOO and coroutine based web server</td> </tr> </table></dl> <dl><dt><a name='ident'>ident</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ident'><a href="tcllib/files/modules/ident/ident.html">ident</a></td> |
︙ | ︙ | |||
2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> | > > > > | | | | | | 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_quasirandom'><a href="tcllib/files/modules/math/quasirandom.html">math::quasirandom</a></td> <td class="#doctools_tocright">Quasi-random points for integration and Monte Carlo type methods</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_roman'><a href="tcllib/files/modules/math/roman.html">math::roman</a></td> <td class="#doctools_tocright">Tools for creating and manipulating roman numerals</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_special'><a href="tcllib/files/modules/math/special.html">math::special</a></td> <td class="#doctools_tocright">Special mathematical functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_statistics'><a href="tcllib/files/modules/math/statistics.html">math::statistics</a></td> <td class="#doctools_tocright">Basic statistical functions and procedures</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_trig'><a href="tcllib/files/modules/math/trig.html">math::trig</a></td> <td class="#doctools_tocright">Trigonometric anf hyperbolic functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="tcllib/files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> </table></dl> <dl><dt><a name='md4'>md4</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 | <td class="#doctools_tocright">Create and manipulate directed graph objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_list'><a href="tcllib/files/modules/struct/struct_list.html">struct::list</a></td> <td class="#doctools_tocright">Procedures for manipulating lists</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_matrix'><a href="tcllib/files/modules/struct/matrix.html">struct::matrix</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> | > > > > | | | | | | | | | | | 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 | <td class="#doctools_tocright">Create and manipulate directed graph objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_list'><a href="tcllib/files/modules/struct/struct_list.html">struct::list</a></td> <td class="#doctools_tocright">Procedures for manipulating lists</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_map'><a href="tcllib/files/modules/struct/struct_map.html">struct::map</a></td> <td class="#doctools_tocright">Manage key/value maps</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_matrix'><a href="tcllib/files/modules/struct/matrix.html">struct::matrix</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_matrix_v1'><a href="tcllib/files/modules/struct/matrix1.html">struct::matrix_v1</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_pool'><a href="tcllib/files/modules/struct/pool.html">struct::pool</a></td> <td class="#doctools_tocright">Create and manipulate pool objects (of discrete items)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_prioqueue'><a href="tcllib/files/modules/struct/prioqueue.html">struct::prioqueue</a></td> <td class="#doctools_tocright">Create and manipulate prioqueue objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_queue'><a href="tcllib/files/modules/struct/queue.html">struct::queue</a></td> <td class="#doctools_tocright">Create and manipulate queue objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_record'><a href="tcllib/files/modules/struct/record.html">struct::record</a></td> <td class="#doctools_tocright">Define and create records (similar to 'C' structures)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_set'><a href="tcllib/files/modules/struct/struct_set.html">struct::set</a></td> <td class="#doctools_tocright">Procedures for manipulating sets</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_skiplist'><a href="tcllib/files/modules/struct/skiplist.html">struct::skiplist</a></td> <td class="#doctools_tocright">Create and manipulate skiplists</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_stack'><a href="tcllib/files/modules/struct/stack.html">struct::stack</a></td> <td class="#doctools_tocright">Create and manipulate stack objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_tree'><a href="tcllib/files/modules/struct/struct_tree.html">struct::tree</a></td> <td class="#doctools_tocright">Create and manipulate tree objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_tree_v1'><a href="tcllib/files/modules/struct/struct_tree1.html">struct::tree_v1</a></td> <td class="#doctools_tocright">Create and manipulate tree objects</td> </tr> </table></dl> <dl><dt><a name='tar'>tar</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ |
Changes to idoc/www/toc0.html.
︙ | ︙ | |||
795 796 797 798 799 800 801 802 803 804 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> | > > > > | | | | | | | | 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 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_quasirandom'><a href="tcllib/files/modules/math/quasirandom.html">math::quasirandom</a></td> <td class="#doctools_tocright">Quasi-random points for integration and Monte Carlo type methods</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_roman'><a href="tcllib/files/modules/math/roman.html">math::roman</a></td> <td class="#doctools_tocright">Tools for creating and manipulating roman numerals</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_special'><a href="tcllib/files/modules/math/special.html">math::special</a></td> <td class="#doctools_tocright">Special mathematical functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_statistics'><a href="tcllib/files/modules/math/statistics.html">math::statistics</a></td> <td class="#doctools_tocright">Basic statistical functions and procedures</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_trig'><a href="tcllib/files/modules/math/trig.html">math::trig</a></td> <td class="#doctools_tocright">Trigonometric anf hyperbolic functions</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='simulation_annealing'><a href="tcllib/files/modules/simulation/annealing.html">simulation::annealing</a></td> <td class="#doctools_tocright">Simulated annealing</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='simulation_montecarlo'><a href="tcllib/files/modules/simulation/montecarlo.html">simulation::montecarlo</a></td> <td class="#doctools_tocright">Monte Carlo simulations</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='simulation_random'><a href="tcllib/files/modules/simulation/simulation_random.html">simulation::random</a></td> <td class="#doctools_tocright">Pseudo-random number generators</td> </tr> </table></dl> <dl><dt><a name='networking'>Networking</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 | <td class="#doctools_tocright">Uri handler for ftp urls</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ftpd'><a href="tcllib/files/modules/ftpd/ftpd.html">ftpd</a></td> <td class="#doctools_tocright">Tcl FTP server implementation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ident'><a href="tcllib/files/modules/ident/ident.html">ident</a></td> <td class="#doctools_tocright">Ident protocol client</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='irc'><a href="tcllib/files/modules/irc/irc.html">irc</a></td> <td class="#doctools_tocright">Create IRC connection and interface.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ldap'><a href="tcllib/files/modules/ldap/ldap.html">ldap</a></td> <td class="#doctools_tocright">LDAP client</td> | > > > > > > > > | 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 | <td class="#doctools_tocright">Uri handler for ftp urls</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ftpd'><a href="tcllib/files/modules/ftpd/ftpd.html">ftpd</a></td> <td class="#doctools_tocright">Tcl FTP server implementation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='httpd'><a href="tcllib/files/modules/httpd/httpd.html">httpd</a></td> <td class="#doctools_tocright">A TclOO and coroutine based web server</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ident'><a href="tcllib/files/modules/ident/ident.html">ident</a></td> <td class="#doctools_tocright">Ident protocol client</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='imap4'><a href="tcllib/files/modules/imap4/imap4.html">imap4</a></td> <td class="#doctools_tocright">imap client-side tcl implementation of imap protocol</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='irc'><a href="tcllib/files/modules/irc/irc.html">irc</a></td> <td class="#doctools_tocright">Create IRC connection and interface.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='ldap'><a href="tcllib/files/modules/ldap/ldap.html">ldap</a></td> <td class="#doctools_tocright">LDAP client</td> |
︙ | ︙ | |||
978 979 980 981 982 983 984 | <td class="#doctools_tocright">Tcl SMTP server implementation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_ip'><a href="tcllib/files/modules/dns/tcllib_ip.html">tcllib_ip</a></td> <td class="#doctools_tocright">IPv4 and IPv6 address manipulation</td> </tr> <tr class="#doctools_tocodd" > | < < < < | | | | 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 | <td class="#doctools_tocright">Tcl SMTP server implementation</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tcllib_ip'><a href="tcllib/files/modules/dns/tcllib_ip.html">tcllib_ip</a></td> <td class="#doctools_tocright">IPv4 and IPv6 address manipulation</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='udpcluster'><a href="tcllib/files/modules/udpcluster/udpcluster.html">udpcluster</a></td> <td class="#doctools_tocright">UDP Peer-to-Peer cluster</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='uri'><a href="tcllib/files/modules/uri/uri.html">uri</a></td> <td class="#doctools_tocright">URI utilities</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='uri_urn'><a href="tcllib/files/modules/uri/urn-scheme.html">uri_urn</a></td> <td class="#doctools_tocright">URI utilities, URN scheme</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='websocket'><a href="tcllib/files/modules/websocket/websocket.html">websocket</a></td> <td class="#doctools_tocright">Tcl implementation of the websocket protocol</td> </tr> </table></dl> <dl><dt><a name='page_parser_generator'>Page Parser Generator</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 | <td class="#doctools_tocleft" ><a name='tepam_procedure'><a href="tcllib/files/modules/tepam/tepam_procedure.html">tepam::procedure</a></td> <td class="#doctools_tocright">TEPAM procedure, reference manual</td> </tr> </table></dl> <dl><dt><a name='programming_tools'>Programming tools</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cmdline'><a href="tcllib/files/modules/cmdline/cmdline.html">cmdline</a></td> <td class="#doctools_tocright">Procedures to process command lines and options.</td> </tr> | > > > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 | <td class="#doctools_tocleft" ><a name='tepam_procedure'><a href="tcllib/files/modules/tepam/tepam_procedure.html">tepam::procedure</a></td> <td class="#doctools_tocright">TEPAM procedure, reference manual</td> </tr> </table></dl> <dl><dt><a name='programming_tools'>Programming tools</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clay'><a href="tcllib/files/modules/clay/clay.html">clay</a></td> <td class="#doctools_tocright">A minimalist framework for large scale OO Projects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='cmdline'><a href="tcllib/files/modules/cmdline/cmdline.html">cmdline</a></td> <td class="#doctools_tocright">Procedures to process command lines and options.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='comm'><a href="tcllib/files/modules/comm/comm.html">comm</a></td> <td class="#doctools_tocright">A remote communication facility for Tcl (8.3 and later)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='comm_wire'><a href="tcllib/files/modules/comm/comm_wire.html">comm_wire</a></td> <td class="#doctools_tocright">The comm wire protocol</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='control'><a href="tcllib/files/modules/control/control.html">control</a></td> <td class="#doctools_tocright">Procedures for control flow structures.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='deleg_method'><a href="tcllib/files/modules/interp/deleg_method.html">deleg_method</a></td> <td class="#doctools_tocright">Creation of comm delegates (snit methods)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='deleg_proc'><a href="tcllib/files/modules/interp/deleg_proc.html">deleg_proc</a></td> <td class="#doctools_tocright">Creation of comm delegates (procedures)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil'><a href="tcllib/files/modules/fileutil/fileutil.html">fileutil</a></td> <td class="#doctools_tocright">Procedures implementing some file utilities</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_magic_cfront'><a href="tcllib/files/modules/fumagic/cfront.html">fileutil::magic::cfront</a></td> <td class="#doctools_tocright">Generator core for compiler of magic(5) files</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_magic_cgen'><a href="tcllib/files/modules/fumagic/cgen.html">fileutil::magic::cgen</a></td> <td class="#doctools_tocright">Generator core for compiler of magic(5) files</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_magic_filetype'><a href="tcllib/files/modules/fumagic/filetypes.html">fileutil::magic::filetype</a></td> <td class="#doctools_tocright">Procedures implementing file-type recognition</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_magic_rt'><a href="tcllib/files/modules/fumagic/rtcore.html">fileutil::magic::rt</a></td> <td class="#doctools_tocright">Runtime core for file type recognition engines written in pure Tcl</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi'><a href="tcllib/files/modules/fileutil/multi.html">fileutil::multi</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="tcllib/files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="tcllib/files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='hook'><a href="tcllib/files/modules/hook/hook.html">hook</a></td> <td class="#doctools_tocright">Hooks</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='interp'><a href="tcllib/files/modules/interp/tcllib_interp.html">interp</a></td> <td class="#doctools_tocright">Interp creation and aliasing</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='log'><a href="tcllib/files/modules/log/log.html">log</a></td> <td class="#doctools_tocright">Procedures to log messages of libraries and applications.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='logger'><a href="tcllib/files/modules/log/logger.html">logger</a></td> <td class="#doctools_tocright">System to control logging of events.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='logger_appender'><a href="tcllib/files/modules/log/loggerAppender.html">logger::appender</a></td> <td class="#doctools_tocright">Collection of predefined appenders for logger</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='logger_utils'><a href="tcllib/files/modules/log/loggerUtils.html">logger::utils</a></td> <td class="#doctools_tocright">Utilities for logger</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='multiplexer'><a href="tcllib/files/modules/multiplexer/multiplexer.html">multiplexer</a></td> <td class="#doctools_tocright">One-to-many communication with sockets.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='pluginmgr'><a href="tcllib/files/modules/pluginmgr/pluginmgr.html">pluginmgr</a></td> <td class="#doctools_tocright">Manage a plugin</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='profiler'><a href="tcllib/files/modules/profiler/profiler.html">profiler</a></td> <td class="#doctools_tocright">Tcl source code profiler</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='snit'><a href="tcllib/files/modules/snit/snit.html">snit</a></td> <td class="#doctools_tocright">Snit's Not Incr Tcl</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='snitfaq'><a href="tcllib/files/modules/snit/snitfaq.html">snitfaq</a></td> <td class="#doctools_tocright">Snit Frequently Asked Questions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='stooop'><a href="tcllib/files/modules/stooop/stooop.html">stooop</a></td> <td class="#doctools_tocright">Object oriented extension.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='switched'><a href="tcllib/files/modules/stooop/switched.html">switched</a></td> <td class="#doctools_tocright">switch/option management.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tie'><a href="tcllib/files/modules/tie/tie.html">tie</a></td> <td class="#doctools_tocright">Array persistence</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tie'><a href="tcllib/files/modules/tie/tie_std.html">tie</a></td> <td class="#doctools_tocright">Array persistence, standard data sources</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='uevent'><a href="tcllib/files/modules/uev/uevent.html">uevent</a></td> <td class="#doctools_tocright">User events</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='wip'><a href="tcllib/files/modules/wip/wip.html">wip</a></td> <td class="#doctools_tocright">Word Interpreter</td> </tr> </table></dl> <dl><dt><a name='system'>System</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 | <dl><dt><a name='unfiled'>Unfiled</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='generator'><a href="tcllib/files/modules/generator/generator.html">generator</a></td> <td class="#doctools_tocright">Procedures for creating and using generators.</td> </tr> | > > > > | < < < < | 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 | <dl><dt><a name='unfiled'>Unfiled</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_paths'><a href="tcllib/files/modules/fileutil/paths.html">fileutil::paths</a></td> <td class="#doctools_tocright">Manage search path pools</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='generator'><a href="tcllib/files/modules/generator/generator.html">generator</a></td> <td class="#doctools_tocright">Procedures for creating and using generators.</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='huddle'><a href="tcllib/files/modules/yaml/huddle.html">huddle</a></td> <td class="#doctools_tocright">Create and manipulate huddle object</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='map_geocode_nominatim'><a href="tcllib/files/modules/map/map_geocode_nominatim.html">map::geocode::nominatim</a></td> <td class="#doctools_tocright">Resolving geographical names with a Nominatim service</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='map_slippy'><a href="tcllib/files/modules/map/map_slippy.html">map::slippy</a></td> <td class="#doctools_tocright">Common code for slippy based map packages</td> |
︙ | ︙ | |||
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 | <td class="#doctools_tocright">Implementation of stringprep</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='stringprep_data'><a href="tcllib/files/modules/stringprep/stringprep_data.html">stringprep::data</a></td> <td class="#doctools_tocright">stringprep data tables, generated, internal</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="tcllib/files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> | > > > > | | | | | | 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 | <td class="#doctools_tocright">Implementation of stringprep</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='stringprep_data'><a href="tcllib/files/modules/stringprep/stringprep_data.html">stringprep::data</a></td> <td class="#doctools_tocright">stringprep data tables, generated, internal</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_map'><a href="tcllib/files/modules/struct/struct_map.html">struct::map</a></td> <td class="#doctools_tocright">Manage key/value maps</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="tcllib/files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='uevent_onidle'><a href="tcllib/files/modules/uev/uevent_onidle.html">uevent::onidle</a></td> <td class="#doctools_tocright">Request merging and deferal to idle time</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='unicode'><a href="tcllib/files/modules/stringprep/unicode.html">unicode</a></td> <td class="#doctools_tocright">Implementation of Unicode normalization</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='unicode_data'><a href="tcllib/files/modules/stringprep/unicode_data.html">unicode::data</a></td> <td class="#doctools_tocright">unicode data tables, generated, internal</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='units'><a href="tcllib/files/modules/units/units.html">units</a></td> <td class="#doctools_tocright">unit conversion</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='yaml'><a href="tcllib/files/modules/yaml/yaml.html">yaml</a></td> <td class="#doctools_tocright">YAML Format Encoder/Decoder</td> </tr> </table></dl> <dl><dt><a name='utilities'>Utilities</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ |
Changes to idoc/www/toc1.html.
︙ | ︙ | |||
129 130 131 132 133 134 135 136 137 138 139 140 141 142 | </table></dl> <dl><dt><a name='cache'>cache</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> </table></dl> <dl><dt><a name='clock'>clock</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clock_iso8601'><a href="tcllib/files/modules/clock/iso8601.html">clock_iso8601</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> | > > > > > > > | 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | </table></dl> <dl><dt><a name='cache'>cache</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='cache_async'><a href="tcllib/files/modules/cache/async.html">cache::async</a></td> <td class="#doctools_tocright">Asynchronous in-memory cache</td> </tr> </table></dl> <dl><dt><a name='clay'>clay</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clay'><a href="tcllib/files/modules/clay/clay.html">clay</a></td> <td class="#doctools_tocright">A minimalist framework for large scale OO Projects</td> </tr> </table></dl> <dl><dt><a name='clock'>clock</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='clock_iso8601'><a href="tcllib/files/modules/clock/iso8601.html">clock_iso8601</a></td> <td class="#doctools_tocright">Parsing ISO 8601 dates/times</td> </tr> |
︙ | ︙ | |||
577 578 579 580 581 582 583 584 585 586 587 588 589 590 | <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="tcllib/files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="tcllib/files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> </table></dl> <dl><dt><a name='ftp'>ftp</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > | > > > > | 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 | <td class="#doctools_tocright">Multi-file operation, scatter/gather, standard object</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_multi_op'><a href="tcllib/files/modules/fileutil/multiop.html">fileutil::multi::op</a></td> <td class="#doctools_tocright">Multi-file operation, scatter/gather</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='fileutil_paths'><a href="tcllib/files/modules/fileutil/paths.html">fileutil::paths</a></td> <td class="#doctools_tocright">Manage search path pools</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='fileutil_traverse'><a href="tcllib/files/modules/fileutil/traverse.html">fileutil_traverse</a></td> <td class="#doctools_tocright">Iterative directory traversal</td> </tr> </table></dl> <dl><dt><a name='ftp'>ftp</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
735 736 737 738 739 740 741 | <td class="#doctools_tocleft" ><a name='autoproxy'><a href="tcllib/files/modules/http/autoproxy.html">autoproxy</a></td> <td class="#doctools_tocright">Automatic HTTP proxy usage and authentication</td> </tr> </table></dl> <dl><dt><a name='httpd'>httpd</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > | | | 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 | <td class="#doctools_tocleft" ><a name='autoproxy'><a href="tcllib/files/modules/http/autoproxy.html">autoproxy</a></td> <td class="#doctools_tocright">Automatic HTTP proxy usage and authentication</td> </tr> </table></dl> <dl><dt><a name='httpd'>httpd</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='httpd'><a href="tcllib/files/modules/httpd/httpd.html">httpd</a></td> <td class="#doctools_tocright">A TclOO and coroutine based web server</td> </tr> </table></dl> <dl><dt><a name='ident'>ident</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='ident'><a href="tcllib/files/modules/ident/ident.html">ident</a></td> |
︙ | ︙ | |||
971 972 973 974 975 976 977 978 979 980 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> | > > > > | | | | | | 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 | <td class="#doctools_tocright">Package for Principal Component Analysis</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_polynomials'><a href="tcllib/files/modules/math/polynomials.html">math::polynomials</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_quasirandom'><a href="tcllib/files/modules/math/quasirandom.html">math::quasirandom</a></td> <td class="#doctools_tocright">Quasi-random points for integration and Monte Carlo type methods</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_rationalfunctions'><a href="tcllib/files/modules/math/rational_funcs.html">math::rationalfunctions</a></td> <td class="#doctools_tocright">Polynomial functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_roman'><a href="tcllib/files/modules/math/roman.html">math::roman</a></td> <td class="#doctools_tocright">Tools for creating and manipulating roman numerals</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_special'><a href="tcllib/files/modules/math/special.html">math::special</a></td> <td class="#doctools_tocright">Special mathematical functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='math_statistics'><a href="tcllib/files/modules/math/statistics.html">math::statistics</a></td> <td class="#doctools_tocright">Basic statistical functions and procedures</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='math_trig'><a href="tcllib/files/modules/math/trig.html">math::trig</a></td> <td class="#doctools_tocright">Trigonometric anf hyperbolic functions</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='tclrep_machineparameters'><a href="tcllib/files/modules/math/machineparameters.html">tclrep/machineparameters</a></td> <td class="#doctools_tocright">Compute double precision machine parameters.</td> </tr> </table></dl> <dl><dt><a name='md4'>md4</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ | |||
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 | <td class="#doctools_tocright">Create and manipulate directed graph objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_list'><a href="tcllib/files/modules/struct/struct_list.html">struct::list</a></td> <td class="#doctools_tocright">Procedures for manipulating lists</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_matrix'><a href="tcllib/files/modules/struct/matrix.html">struct::matrix</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> | > > > > | | | | | | | | | | | 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 | <td class="#doctools_tocright">Create and manipulate directed graph objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_list'><a href="tcllib/files/modules/struct/struct_list.html">struct::list</a></td> <td class="#doctools_tocright">Procedures for manipulating lists</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_map'><a href="tcllib/files/modules/struct/struct_map.html">struct::map</a></td> <td class="#doctools_tocright">Manage key/value maps</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_matrix'><a href="tcllib/files/modules/struct/matrix.html">struct::matrix</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_matrix_v1'><a href="tcllib/files/modules/struct/matrix1.html">struct::matrix_v1</a></td> <td class="#doctools_tocright">Create and manipulate matrix objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_pool'><a href="tcllib/files/modules/struct/pool.html">struct::pool</a></td> <td class="#doctools_tocright">Create and manipulate pool objects (of discrete items)</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_prioqueue'><a href="tcllib/files/modules/struct/prioqueue.html">struct::prioqueue</a></td> <td class="#doctools_tocright">Create and manipulate prioqueue objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_queue'><a href="tcllib/files/modules/struct/queue.html">struct::queue</a></td> <td class="#doctools_tocright">Create and manipulate queue objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_record'><a href="tcllib/files/modules/struct/record.html">struct::record</a></td> <td class="#doctools_tocright">Define and create records (similar to 'C' structures)</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_set'><a href="tcllib/files/modules/struct/struct_set.html">struct::set</a></td> <td class="#doctools_tocright">Procedures for manipulating sets</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_skiplist'><a href="tcllib/files/modules/struct/skiplist.html">struct::skiplist</a></td> <td class="#doctools_tocright">Create and manipulate skiplists</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_stack'><a href="tcllib/files/modules/struct/stack.html">struct::stack</a></td> <td class="#doctools_tocright">Create and manipulate stack objects</td> </tr> <tr class="#doctools_tocodd" > <td class="#doctools_tocleft" ><a name='struct_tree'><a href="tcllib/files/modules/struct/struct_tree.html">struct::tree</a></td> <td class="#doctools_tocright">Create and manipulate tree objects</td> </tr> <tr class="#doctools_toceven" > <td class="#doctools_tocleft" ><a name='struct_tree_v1'><a href="tcllib/files/modules/struct/struct_tree1.html">struct::tree_v1</a></td> <td class="#doctools_tocright">Create and manipulate tree objects</td> </tr> </table></dl> <dl><dt><a name='tar'>tar</dt><dd> <table class="#doctools_toc"> <tr class="#doctools_toceven" > |
︙ | ︙ |
Changes to installer.tcl.
︙ | ︙ | |||
278 279 280 281 282 283 284 | # Starpack. No defaults for location. } else { # Starkit, or unwrapped. Derive defaults location from the # location of the executable running the installer, or the # location of its library. # For a starkit [info library] is inside the running | | | 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | # Starpack. No defaults for location. } else { # Starkit, or unwrapped. Derive defaults location from the # location of the executable running the installer, or the # location of its library. # For a starkit [info library] is inside the running # tclkit. Detect this and derive the location from the # location of the executable itself for that case. if {[string match [info nameofexecutable]* [info library]]} { # Starkit set libdir [file join [file dirname [file dirname [info nameofexecutable]]] lib] } else { # Unwrapped. |
︙ | ︙ |
Changes to license.terms.
1 | This software is copyrighted by Ajuba Solutions and other parties. | | | | | | | | | | | | | | | | | | | | 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 | 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. |
Added modules/0compatibility/d_config.tcl.
> > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | # (c) 2019 Andreas Kupries # Redirection wrapper for deprecated package # Deprecated: # - doctools::config # Replacement: # - struct::map package require Tcl 8.4 package require struct::map namespace eval ::doctools {} proc ::doctools::config {args} { uplevel 1 [linsert $args 0 ::struct::map] } package provide doctools::config 0.1 return |
Added modules/0compatibility/d_config.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # config.test: Testsuite for DEPRECATED package doctools::config # # Copyright (c) 2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2.0 support { use snit/snit.tcl snit use struct/map.tcl struct::map } testing { useLocal d_config.tcl doctools::config } # --------------------------------------------------------------------- # [] constructor # [] destructor # [] get # [] names # [] set # [] unset #---------------------------------------------------------------------- ## Constructor, destructor test doctools-config-1.0 {constructor, wrong args, too many} -body { doctools::config M X } -returnCodes error -result {Error in constructor: wrong # args: should be "::struct::map::I::Snit_constructor type selfns win self"} test doctools-config-1.1 {instance, bogus method} -setup { doctools::config M } -cleanup { M destroy } -body { M bogus } -returnCodes error -result {"::M bogus" is not defined} #---------------------------------------------------------------------- ## get test doctools-config-2.0 {get, wrong args, too many} -setup { doctools::config M } -cleanup { M destroy } -body { M get X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test doctools-config-2.1 {get, base state, none} -setup { doctools::config M } -cleanup { M destroy } -body { M get } -result {} #---------------------------------------------------------------------- ## names test doctools-config-3.0 {names, wrong args, too many} -setup { doctools::config M } -cleanup { M destroy } -body { M names X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test doctools-config-3.1 {names, base state, none} -setup { doctools::config M } -cleanup { M destroy } -body { M names } -result {} #---------------------------------------------------------------------- ## set test doctools-config-4.0 {set, wrong args, not enough} -setup { doctools::config M } -cleanup { M destroy } -body { M set } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test doctools-config-4.1 {set, wrong args, too many} -setup { doctools::config M } -cleanup { M destroy } -body { M set K V X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test doctools-config-4.2 {set, state change, result} -setup { doctools::config M } -cleanup { M destroy } -body { list [M names] [M get] [M set K V] [M names] [M get] } -result {{} {} V K {K V}} #---------------------------------------------------------------------- ## unset test doctools-config-5.2 {unset, known key, state change, result} -setup { doctools::config M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset K] [M names] [M get] } -result {K {K V} {} {} {}} test doctools-config-5.3 {unset, missing key, no state change, result} -setup { doctools::config M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset K'] [M names] [M get] } -result {K {K V} {} K {K V}} test doctools-config-5.4 {unset, no pattern, clear, result} -setup { doctools::config M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset] [M names] [M get] } -result {K {K V} {} {} {}} #---------------------------------------------------------------------- testsuiteCleanup return |
Added modules/0compatibility/d_paths.tcl.
> > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | # (c) 2019 Andreas Kupries # Redirection wrapper for deprecated package # Deprecated: # - doctools::paths # Replacement: # - fileutil::paths package require Tcl 8.4 package require fileutil::paths namespace eval ::doctools {} proc ::doctools::paths {args} { uplevel 1 [linsert $args 0 ::fileutil::paths] } package provide doctools::paths 0.1 return |
Added modules/0compatibility/d_paths.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # paths.test: Testsuite for DEPRECATED package doctools::paths # # Copyright (c) 2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2.0 support { use snit/snit.tcl snit use fileutil/paths.tcl fileutil::paths } testing { useLocal d_paths.tcl doctools::paths } # --------------------------------------------------------------------- # [] constructor # [] destructor # [] paths # [] add # [] remove # [] clear #---------------------------------------------------------------------- ## Constructor, destructor test doctools-paths-1.0 {constructor, wrong args, too many} -body { doctools::paths P X } -returnCodes error -result {Error in constructor: wrong # args: should be "::fileutil::paths::Snit_constructor type selfns win self"} test doctools-paths-1.1 {instance, bogus method} -setup { doctools::paths P } -cleanup { P destroy } -body { P bogus } -returnCodes error -result {"::P bogus" is not defined} #---------------------------------------------------------------------- ## paths test doctools-paths-2.0 {paths, wrong args, too many} -setup { doctools::paths P } -cleanup { P destroy } -body { P paths X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodpaths type selfns win self"} test doctools-paths-2.1 {paths, base state, none} -setup { doctools::paths P } -cleanup { P destroy } -body { P paths } -result {} #---------------------------------------------------------------------- ## add test doctools-paths-3.0 {add, wrong args, not enough} -setup { doctools::paths P } -cleanup { P destroy } -body { P add } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test doctools-paths-3.1 {add, wrong args, too many} -setup { doctools::paths P } -cleanup { P destroy } -body { P add F X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test doctools-paths-3.2 {add, state change, result} -setup { doctools::paths P } -cleanup { P destroy } -body { list [P add F] [P paths] } -result {{} F} #---------------------------------------------------------------------- ## remove test doctools-paths-4.0 {remove, wrong args, not enough} -setup { doctools::paths P } -cleanup { P destroy } -body { P remove } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test doctools-paths-4.1 {remove, wrong args, too many} -setup { doctools::paths P } -cleanup { P destroy } -body { P remove F X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test doctools-paths-4.2 {remove, known path, state change, result} -setup { doctools::paths P P add F } -cleanup { P destroy } -body { list [P remove F] [P paths] } -result {{} {}} test doctools-paths-4.3 {remove, missing path, no state change, result} -setup { doctools::paths P P add Z } -cleanup { P destroy } -body { list [P remove F] [P paths] } -result {{} Z} #---------------------------------------------------------------------- ## clear test doctools-paths-5.0 {clear, wrong args, too many} -setup { doctools::paths P } -cleanup { P destroy } -body { P clear X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodclear type selfns win self"} test doctools-paths-5.1 {clear, return to base state} -setup { doctools::paths P P add F } -cleanup { P destroy } -body { list [P clear] [P paths] } -result {{} {}} #---------------------------------------------------------------------- testsuiteCleanup return |
Added modules/0compatibility/p_config.tcl.
> > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | # (c) 2019 Andreas Kupries # Redirection wrapper for deprecated package # Deprecated: # - configuration # Replacement: # - struct::map package require Tcl 8.4 package require struct::map proc ::configuration {args} { uplevel 1 [linsert $args 0 ::struct::map] } package provide configuration 1 return |
Added modules/0compatibility/p_config.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # config.test: Testsuite for DEPRECATED package configuration # # Copyright (c) 2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2.0 support { use snit/snit.tcl snit use struct/map.tcl struct::map } testing { useLocal p_config.tcl configuration } # --------------------------------------------------------------------- # [] constructor # [] destructor # [] get # [] names # [] set # [] unset #---------------------------------------------------------------------- ## Constructor, destructor test configuration-1.0 {constructor, wrong args, too many} -body { configuration M X } -returnCodes error -result {Error in constructor: wrong # args: should be "::struct::map::I::Snit_constructor type selfns win self"} test configuration-1.1 {instance, bogus method} -setup { configuration M } -cleanup { M destroy } -body { M bogus } -returnCodes error -result {"::M bogus" is not defined} #---------------------------------------------------------------------- ## get test configuration-2.0 {get, wrong args, too many} -setup { configuration M } -cleanup { M destroy } -body { M get X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test configuration-2.1 {get, base state, none} -setup { configuration M } -cleanup { M destroy } -body { M get } -result {} #---------------------------------------------------------------------- ## names test configuration-3.0 {names, wrong args, too many} -setup { configuration M } -cleanup { M destroy } -body { M names X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test configuration-3.1 {names, base state, none} -setup { configuration M } -cleanup { M destroy } -body { M names } -result {} #---------------------------------------------------------------------- ## set test configuration-4.0 {set, wrong args, not enough} -setup { configuration M } -cleanup { M destroy } -body { M set } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test configuration-4.1 {set, wrong args, too many} -setup { configuration M } -cleanup { M destroy } -body { M set K V X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test configuration-4.2 {set, state change, result} -setup { configuration M } -cleanup { M destroy } -body { list [M names] [M get] [M set K V] [M names] [M get] } -result {{} {} V K {K V}} #---------------------------------------------------------------------- ## unset test configuration-5.2 {unset, known key, state change, result} -setup { configuration M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset K] [M names] [M get] } -result {K {K V} {} {} {}} test configuration-5.3 {unset, missing key, no state change, result} -setup { configuration M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset K'] [M names] [M get] } -result {K {K V} {} K {K V}} test configuration-5.4 {unset, no pattern, clear, result} -setup { configuration M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset] [M names] [M get] } -result {K {K V} {} {} {}} #---------------------------------------------------------------------- testsuiteCleanup return |
Added modules/0compatibility/p_paths.tcl.
> > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | # (c) 2019 Andreas Kupries # Redirection wrapper for deprecated package # Deprecated: # - paths # Replacement: # - fileutil::paths package require Tcl 8.4 package require fileutil::paths proc ::paths {args} { uplevel 1 [linsert $args 0 ::fileutil::paths] } package provide paths 1 return |
Added modules/0compatibility/p_paths.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # paths.test: Testsuite for DEPRECATED package paths (pt) # # Copyright (c) 2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2.0 support { use snit/snit.tcl snit use fileutil/paths.tcl fileutil::paths } testing { useLocal p_paths.tcl paths } # --------------------------------------------------------------------- # [] constructor # [] destructor # [] paths # [] add # [] remove # [] clear #---------------------------------------------------------------------- ## Constructor, destructor test paths-1.0 {constructor, wrong args, too many} -body { paths P X } -returnCodes error -result {Error in constructor: wrong # args: should be "::fileutil::paths::Snit_constructor type selfns win self"} test paths-1.1 {instance, bogus method} -setup { paths P } -cleanup { P destroy } -body { P bogus } -returnCodes error -result {"::P bogus" is not defined} #---------------------------------------------------------------------- ## paths test paths-2.0 {paths, wrong args, too many} -setup { paths P } -cleanup { P destroy } -body { P paths X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodpaths type selfns win self"} test paths-2.1 {paths, base state, none} -setup { paths P } -cleanup { P destroy } -body { P paths } -result {} #---------------------------------------------------------------------- ## add test paths-3.0 {add, wrong args, not enough} -setup { paths P } -cleanup { P destroy } -body { P add } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test paths-3.1 {add, wrong args, too many} -setup { paths P } -cleanup { P destroy } -body { P add F X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test paths-3.2 {add, state change, result} -setup { paths P } -cleanup { P destroy } -body { list [P add F] [P paths] } -result {{} F} #---------------------------------------------------------------------- ## remove test paths-4.0 {remove, wrong args, not enough} -setup { paths P } -cleanup { P destroy } -body { P remove } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test paths-4.1 {remove, wrong args, too many} -setup { paths P } -cleanup { P destroy } -body { P remove F X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test paths-4.2 {remove, known path, state change, result} -setup { paths P P add F } -cleanup { P destroy } -body { list [P remove F] [P paths] } -result {{} {}} test paths-4.3 {remove, missing path, no state change, result} -setup { paths P P add Z } -cleanup { P destroy } -body { list [P remove F] [P paths] } -result {{} Z} #---------------------------------------------------------------------- ## clear test paths-5.0 {clear, wrong args, too many} -setup { paths P } -cleanup { P destroy } -body { P clear X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodclear type selfns win self"} test paths-5.1 {clear, return to base state} -setup { paths P P add F } -cleanup { P destroy } -body { list [P clear] [P paths] } -result {{} {}} #---------------------------------------------------------------------- testsuiteCleanup return |
Added modules/0compatibility/pkgIndex.tcl.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # Compatibility wrapper for deprecated packages. ## # Stages # [D1] Next Release - Noted deprecated, with redirection wrappers # [D2] Release After - Wrappers become Boockers, throwing error noting redirection # [D3] Release Beyond - All removed. ## # Currently in deprecation # - D1 doctools::path (doctools2base) # - D1 doctools::config (doctools2base) # - D1 configuration (pt) # - D1 paths (pt) # # :Attention: # - Original `doctools::paths` Tcl 8.4 required # Replacement `fileutilutil::paths` Tcl 8.5 required! if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded configuration 1 [list source [file join $dir p_config.tcl]] package ifneeded doctools::config 0.1 [list source [file join $dir d_config.tcl]] package ifneeded doctools::paths 0.1 [list source [file join $dir d_paths.tcl]] package ifneeded paths 1 [list source [file join $dir p_paths.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} {return} if {![package vsatisfies [package provide Tcl] 8.6]} {return} |
Changes to modules/aes/aes.man.
︙ | ︙ | |||
160 161 162 163 164 165 166 | [list_end] [section AUTHORS] Thorsten Schloermann, Pat Thoyts [vset CATEGORY aes] | | | 160 161 162 163 164 165 166 167 168 | [list_end] [section AUTHORS] Thorsten Schloermann, Pat Thoyts [vset CATEGORY aes] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/amazon-s3/S3.man.
︙ | ︙ | |||
1442 1443 1444 1445 1446 1447 1448 | each moving on to the next unstarted task as it finishes each. This is still being designed, and it is intended primarily to be run on Amazon's Elastic Compute Cloud. [include ../common-text/tls-security-notes.inc] [vset CATEGORY amazon-s3] | | | 1442 1443 1444 1445 1446 1447 1448 1449 1450 | each moving on to the next unstarted task as it finishes each. This is still being designed, and it is intended primarily to be run on Amazon's Elastic Compute Cloud. [include ../common-text/tls-security-notes.inc] [vset CATEGORY amazon-s3] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/amazon-s3/xsxp.man.
︙ | ︙ | |||
129 130 131 132 133 134 135 | [call [cmd xsxp::prettyprint] [arg pxml] [opt [arg chan]]] This outputs to [arg chan] (default stdout) a pretty-printed version of [arg pxml]. [list_end] [vset CATEGORY amazon-s3] | | | 129 130 131 132 133 134 135 136 137 | [call [cmd xsxp::prettyprint] [arg pxml] [opt [arg chan]]] This outputs to [arg chan] (default stdout) a pretty-printed version of [arg pxml]. [list_end] [vset CATEGORY amazon-s3] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/asn/asn.man.
︙ | ︙ | |||
456 457 458 459 460 461 462 | [section EXAMPLES] Examples for the usage of this package can be found in the implementation of package [package ldap]. [vset CATEGORY asn] | | | 456 457 458 459 460 461 462 463 464 | [section EXAMPLES] Examples for the usage of this package can be found in the implementation of package [package ldap]. [vset CATEGORY asn] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base32/base32.man.
︙ | ︙ | |||
67 68 69 70 71 72 73 | 5 F 14 O 23 X 6 G 15 P 24 Y 7 H 16 Q 25 Z 8 I 17 R 26 2 }] [vset CATEGORY base32] | | | 67 68 69 70 71 72 73 74 75 | 5 F 14 O 23 X 6 G 15 P 24 Y 7 H 16 Q 25 Z 8 I 17 R 26 2 }] [vset CATEGORY base32] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base32/base32core.man.
︙ | ︙ | |||
58 59 60 61 62 63 64 | [enum] The length of the input is not a multiple of eight, [enum] The padding appears not at the end of input, but in the middle, [enum] The padding has not of length six, four, three, or one characters, [list_end] [list_end] [vset CATEGORY base32] | | | 58 59 60 61 62 63 64 65 66 | [enum] The length of the input is not a multiple of eight, [enum] The padding appears not at the end of input, but in the middle, [enum] The padding has not of length six, four, three, or one characters, [list_end] [list_end] [vset CATEGORY base32] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base32/base32hex.man.
︙ | ︙ | |||
70 71 72 73 74 75 76 | 5 5 14 E 23 N 6 6 15 F 24 O 7 7 16 G 25 P 8 8 17 H 26 Q }] [vset CATEGORY base32] | | | 70 71 72 73 74 75 76 77 78 | 5 5 14 E 23 N 6 6 15 F 24 O 7 7 16 G 25 P 8 8 17 H 26 Q }] [vset CATEGORY base32] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base64/ascii85.man.
︙ | ︙ | |||
67 68 69 70 71 72 73 | [list_begin enum] [enum] [uri http://en.wikipedia.org/wiki/Ascii85] [enum] Postscript Language Reference Manual, 3rd Edition, page 131. [uri http://www.adobe.com/devnet/postscript/pdfs/PLRM.pdf] [list_end] [vset CATEGORY base64] | | | 67 68 69 70 71 72 73 74 75 | [list_begin enum] [enum] [uri http://en.wikipedia.org/wiki/Ascii85] [enum] Postscript Language Reference Manual, 3rd Edition, page 131. [uri http://www.adobe.com/devnet/postscript/pdfs/PLRM.pdf] [list_end] [vset CATEGORY base64] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base64/base64.man.
︙ | ︙ | |||
62 63 64 65 66 67 68 | % set chemical [encoding convertto utf-8 "C\u2088H\u2081\u2080N\u2084O\u2082"] % set encoded [base64::encode $chemical] Q+KCiEjigoHigoBO4oKET+KCgg== % set caffeine [encoding convertfrom utf-8 [base64::decode $encoded]] }] [vset CATEGORY base64] | | | 62 63 64 65 66 67 68 69 70 | % set chemical [encoding convertto utf-8 "C\u2088H\u2081\u2080N\u2084O\u2082"] % set encoded [base64::encode $chemical] Q+KCiEjigoHigoBO4oKET+KCgg== % set caffeine [encoding convertfrom utf-8 [base64::decode $encoded]] }] [vset CATEGORY base64] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base64/uuencode.man.
︙ | ︙ | |||
89 90 91 92 93 94 95 | [para] [example { % uuencode::uudecode $d {hello.txt 644 {Hello World}} }] [vset CATEGORY base64] | | | 89 90 91 92 93 94 95 96 97 | [para] [example { % uuencode::uudecode $d {hello.txt 644 {Hello World}} }] [vset CATEGORY base64] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/base64/yencode.man.
︙ | ︙ | |||
88 89 90 91 92 93 94 | [section References] [list_begin enum] [enum] [uri http://www.yenc.org/yenc-draft.1.3.txt] [list_end] [vset CATEGORY base64] | | | 88 89 90 91 92 93 94 95 96 | [section References] [list_begin enum] [enum] [uri http://www.yenc.org/yenc-draft.1.3.txt] [list_end] [vset CATEGORY base64] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bee/bee.man.
︙ | ︙ | |||
335 336 337 338 339 340 341 | By wrapping an integer number into [const i]...[const e] the format makes sure that they are different from strings, which all begin with a digit. [section EXAMPLES] [vset CATEGORY bee] | | | 335 336 337 338 339 340 341 342 343 | By wrapping an integer number into [const i]...[const e] the format makes sure that they are different from strings, which all begin with a digit. [section EXAMPLES] [vset CATEGORY bee] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench.man.
︙ | ︙ | |||
288 289 290 291 292 293 294 | The benchmark could be executed, however the result from its body did not match the declared expectations. [list_end] [list_end] [vset CATEGORY bench] | | | 288 289 290 291 292 293 294 295 296 | The benchmark could be executed, however the result from its body did not match the declared expectations. [list_end] [list_end] [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench_intro.man.
︙ | ︙ | |||
83 84 85 86 87 88 89 | [section {HISTORICAL NOTES}] This module and package have been derived from Jeff Hobbs' [syscmd tclbench] application for the benchmarking of the Tcl core and its ancestor [file runbench.tcl]. [vset CATEGORY bench] | | | 83 84 85 86 87 88 89 90 91 | [section {HISTORICAL NOTES}] This module and package have been derived from Jeff Hobbs' [syscmd tclbench] application for the benchmarking of the Tcl core and its ancestor [file runbench.tcl]. [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench_lang_intro.man.
︙ | ︙ | |||
145 146 147 148 149 150 151 | to understand the formal [term {bench language specfication}]. It will also serve as the detailed specification and cheat sheet for all available commands and their syntax. [para] [vset CATEGORY bench] | | | 145 146 147 148 149 150 151 152 153 | to understand the formal [term {bench language specfication}]. It will also serve as the detailed specification and cheat sheet for all available commands and their syntax. [para] [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench_lang_spec.man.
︙ | ︙ | |||
124 125 126 127 128 129 130 | responsibility is to create whatever resources are needed by the body to run without failing. [list_end] [list_end] [vset CATEGORY bench] | | | 124 125 126 127 128 129 130 131 132 | responsibility is to create whatever resources are needed by the body to run without failing. [list_end] [list_end] [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench_read.man.
︙ | ︙ | |||
57 58 59 60 61 62 63 | [para] and automatically detects which format is used by the input file. [list_end] [vset CATEGORY bench] | | | 57 58 59 60 61 62 63 64 65 | [para] and automatically detects which format is used by the input file. [list_end] [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench_wcsv.man.
︙ | ︙ | |||
46 47 48 49 50 51 52 | For other formatting styles see the packages [package bench] and [package bench::out::text] which provide commands to format benchmark results in raw form, or for human consumption, respectively. [list_end] [vset CATEGORY bench] | | | 46 47 48 49 50 51 52 53 54 | For other formatting styles see the packages [package bench] and [package bench::out::text] which provide commands to format benchmark results in raw form, or for human consumption, respectively. [list_end] [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bench/bench_wtext.man.
︙ | ︙ | |||
47 48 49 50 51 52 53 | For other formatting styles see the packages [package bench] and [package bench::out::csv] which provide commands to format benchmark results in raw form, or as importable CSV data, respectively. [list_end] [vset CATEGORY bench] | | | 47 48 49 50 51 52 53 54 55 | For other formatting styles see the packages [package bench] and [package bench::out::csv] which provide commands to format benchmark results in raw form, or as importable CSV data, respectively. [list_end] [vset CATEGORY bench] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/bibtex/bibtex.man.
︙ | ︙ | |||
172 173 174 175 176 177 178 | replacement strings. This command has the correct signature for use as a [option -stringcommand] callback in an invokation of the command [cmd ::bibtex::parse]. [list_end] [vset CATEGORY bibtex] | | | 172 173 174 175 176 177 178 179 180 | replacement strings. This command has the correct signature for use as a [option -stringcommand] callback in an invokation of the command [cmd ::bibtex::parse]. [list_end] [vset CATEGORY bibtex] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/blowfish/blowfish.man.
︙ | ︙ | |||
156 157 158 159 160 161 162 | [list_end] [section AUTHORS] Frank Pilhofer, Pat Thoyts [vset CATEGORY blowfish] | | | 156 157 158 159 160 161 162 163 164 | [list_end] [section AUTHORS] Frank Pilhofer, Pat Thoyts [vset CATEGORY blowfish] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/cache/async.man.
︙ | ︙ | |||
136 137 138 139 140 141 142 | This method resets the state of either the specified [arg key] or of all keys known to the cache, making it unkown. This forces future [method get]-requests to reload the information from the provider. [list_end] [vset CATEGORY cache] | | | 136 137 138 139 140 141 142 143 144 | This method resets the state of either the specified [arg key] or of all keys known to the cache, making it unkown. This forces future [method get]-requests to reload the information from the provider. [list_end] [vset CATEGORY cache] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/clay/build/event.tcl.
|
| > > | < < < < | < < | < < < < < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | if {[info commands ::cron::object_destroy] eq {}} { # Provide a noop if we aren't running with the cron scheduler namespace eval ::cron {} proc ::cron::object_destroy args {} } ::namespace eval ::clay::event {} ### # Process the queue of objects to be destroyed ### proc ::clay::cleanup {} { if {![info exists ::clay::idle_destroy]} return foreach obj $::clay::idle_destroy { if {[info commands $obj] ne {}} { catch {$obj destroy} } } set ::clay::idle_destroy {} } proc ::clay::object_create {objname {class {}}} { #if {$::clay::trace>0} { # puts [list $objname CREATE] #} } proc ::clay::object_rename {object newname} { if {$::clay::trace>0} { puts [list $object RENAME -> $newname] } } ### # Mark an objects for destruction on the next cleanup ### proc ::clay::object_destroy args { if {![info exists ::clay::idle_destroy]} { set ::clay::idle_destroy {} } foreach objname $args { if {$::clay::trace>0} { puts [list $objname DESTROY] } ::cron::object_destroy $objname if {$objname in $::clay::idle_destroy} continue lappend ::clay::idle_destroy $objname } } ### # description: Cancel a scheduled event ### proc ::clay::event::cancel {self {task *}} { variable timer_event variable timer_script |
︙ | ︙ |
Changes to modules/clay/build/footer.txt.
1 | [vset CATEGORY oo] | | | 1 2 | [vset CATEGORY oo] [include ../common-text/feedback.inc] |
Changes to modules/clay/build/metaclass.tcl.
︙ | ︙ | |||
105 106 107 108 109 110 111 | proc ::clay::define::destructor rawbody { set body { # Run the destructor once and only once set self [self] my variable DestroyEvent if {$DestroyEvent} return set DestroyEvent 1 | < | 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | proc ::clay::define::destructor rawbody { set body { # Run the destructor once and only once set self [self] my variable DestroyEvent if {$DestroyEvent} return set DestroyEvent 1 } append body $rawbody ::oo::define [current_class] destructor $body } proc ::clay::define::Dict {name {values {}}} { set class [current_class] |
︙ | ︙ | |||
191 192 193 194 195 196 197 | # (if missing) when the object changes class via the [emph morph] method. ### proc ::clay::define::Variable {name {default {}}} { set class [current_class] set name [string trimright $name :/] $class clay set variable/ $name $default } | < < < < < < < < < < < < < < < < < < < < | 190 191 192 193 194 195 196 | # (if missing) when the object changes class via the [emph morph] method. ### proc ::clay::define::Variable {name {default {}}} { set class [current_class] set name [string trimright $name :/] $class clay set variable/ $name $default } |
Changes to modules/clay/build/object.tcl.
︙ | ︙ | |||
457 458 459 460 461 462 463 464 465 466 467 468 469 470 | } foreach class $clayorder { if {[$class clay exists {*}$args]} { return $class } } return {} } replace { set clay [lindex $args 0] } source { source [lindex $args 0] } | > > > > > > > > > > > > > > > > > > | 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 | } foreach class $clayorder { if {[$class clay exists {*}$args]} { return $class } } return {} } refcount { my variable refcount if {![info exists refcount]} { return 0 } return $refcount } refcount_incr { my variable refcount incr refcount } refcount_decr { my variable refcount incr refcount -1 if {$refcount <= 0} { ::clay::object_destroy [self] } } replace { set clay [lindex $args 0] } source { source [lindex $args 0] } |
︙ | ︙ |
Changes to modules/clay/clay.man.
︙ | ︙ | |||
443 444 445 446 447 448 449 | [example {property variable NAME {default DEFAULT}}] [para] Variables registered in the variable property are also initialized (if missing) when the object changes class via the [emph morph] method. | < < < < < < < < < < < < < < < < > > > > > > > > > > > > > | 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 | [example {property variable NAME {default DEFAULT}}] [para] Variables registered in the variable property are also initialized (if missing) when the object changes class via the [emph morph] method. [call proc [cmd clay::ensemble_methodbody] [arg ensemble] [arg einfo]] [call proc [cmd clay::define::Ensemble] [arg rawmethod] [opt "[arg args]"]] [call proc [cmd clay::cleanup]] Process the queue of objects to be destroyed [call proc [cmd clay::object_create] [arg objname] [opt "[arg class] [const ""]"]] [call proc [cmd clay::object_rename] [arg object] [arg newname]] [call proc [cmd clay::object_destroy] [opt "[arg args]"]] Mark an objects for destruction on the next cleanup [call proc [cmd clay::event::cancel] [arg self] [opt "[arg task] [const "*"]"]] Cancel a scheduled event |
︙ | ︙ | |||
697 698 699 700 701 702 703 | [list_end] [para] [section AUTHORS] Sean Woods [uri mailto:<[email protected]>][para] [vset CATEGORY oo] | | | 694 695 696 697 698 699 700 701 702 703 704 | [list_end] [para] [section AUTHORS] Sean Woods [uri mailto:<[email protected]>][para] [vset CATEGORY oo] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/clay/clay.tcl.
︙ | ︙ | |||
1025 1026 1027 1028 1029 1030 1031 | proc ::clay::define::destructor rawbody { set body { # Run the destructor once and only once set self [self] my variable DestroyEvent if {$DestroyEvent} return set DestroyEvent 1 | < | 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 | proc ::clay::define::destructor rawbody { set body { # Run the destructor once and only once set self [self] my variable DestroyEvent if {$DestroyEvent} return set DestroyEvent 1 } append body $rawbody ::oo::define [current_class] destructor $body } proc ::clay::define::Dict {name {values {}}} { set class [current_class] set name [string trim $name :/] |
︙ | ︙ | |||
1088 1089 1090 1091 1092 1093 1094 | } } proc ::clay::define::Variable {name {default {}}} { set class [current_class] set name [string trimright $name :/] $class clay set variable/ $name $default } | < < < < < < < < < < < < < < < < | 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 | } } proc ::clay::define::Variable {name {default {}}} { set class [current_class] set name [string trimright $name :/] $class clay set variable/ $name $default } ### # END: metaclass.tcl ### ### # START: ensemble.tcl ### |
︙ | ︙ | |||
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 | } foreach class $clayorder { if {[$class clay exists {*}$args]} { return $class } } return {} } replace { set clay [lindex $args 0] } source { source [lindex $args 0] } | > > > > > > > > > > > > > > > > > > | 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 | } foreach class $clayorder { if {[$class clay exists {*}$args]} { return $class } } return {} } refcount { my variable refcount if {![info exists refcount]} { return 0 } return $refcount } refcount_incr { my variable refcount incr refcount } refcount_decr { my variable refcount incr refcount -1 if {$refcount <= 0} { ::clay::object_destroy [self] } } replace { set clay [lindex $args 0] } source { source [lindex $args 0] } |
︙ | ︙ | |||
1905 1906 1907 1908 1909 1910 1911 | ### # END: object.tcl ### ### # START: event.tcl ### | > > | < | < < | < < < < > > > > > > > > > > > > > > > > > > > > > > > > | 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 | ### # END: object.tcl ### ### # START: event.tcl ### if {[info commands ::cron::object_destroy] eq {}} { # Provide a noop if we aren't running with the cron scheduler namespace eval ::cron {} proc ::cron::object_destroy args {} } ::namespace eval ::clay::event { } proc ::clay::cleanup {} { if {![info exists ::clay::idle_destroy]} return foreach obj $::clay::idle_destroy { if {[info commands $obj] ne {}} { catch {$obj destroy} } } set ::clay::idle_destroy {} } proc ::clay::object_create {objname {class {}}} { #if {$::clay::trace>0} { # puts [list $objname CREATE] #} } proc ::clay::object_rename {object newname} { if {$::clay::trace>0} { puts [list $object RENAME -> $newname] } } proc ::clay::object_destroy args { if {![info exists ::clay::idle_destroy]} { set ::clay::idle_destroy {} } foreach objname $args { if {$::clay::trace>0} { puts [list $objname DESTROY] } ::cron::object_destroy $objname if {$objname in $::clay::idle_destroy} continue lappend ::clay::idle_destroy $objname } } proc ::clay::event::cancel {self {task *}} { variable timer_event variable timer_script foreach {id event} [array get timer_event $self:$task] { ::after cancel $event |
︙ | ︙ |
Changes to modules/clock/iso8601.man.
︙ | ︙ | |||
39 40 41 42 43 44 45 | [option -locale], and [option -timezone] of the builtin command [cmd {clock scan}]. [list_end] [vset CATEGORY clock::iso8601] | | | 39 40 41 42 43 44 45 46 47 | [option -locale], and [option -timezone] of the builtin command [cmd {clock scan}]. [list_end] [vset CATEGORY clock::iso8601] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/clock/rfc2822.man.
︙ | ︙ | |||
19 20 21 22 23 24 25 | This command parses an RFC2822 date string and returns the given date in seconds since epoch. An error is thrown if the command is unable to parse the date. [list_end] [vset CATEGORY clock::rfc2822] | | | 19 20 21 22 23 24 25 26 27 | This command parses an RFC2822 date string and returns the given date in seconds since epoch. An error is thrown if the command is unable to parse the date. [list_end] [vset CATEGORY clock::rfc2822] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/cmdline/cmdline.man.
︙ | ︙ | |||
196 197 198 199 200 201 202 | This example, taken (and slightly modified) from the package [package fileutil], shows how to use cmdline. First, a list of options is created, then the 'args' list is passed to cmdline for processing. Subsequently, different options are checked to see if they have been passed to the script, and what their value is. [vset CATEGORY cmdline] | | | 196 197 198 199 200 201 202 203 204 | This example, taken (and slightly modified) from the package [package fileutil], shows how to use cmdline. First, a list of options is created, then the 'args' list is passed to cmdline for processing. Subsequently, different options are checked to see if they have been passed to the script, and what their value is. [vset CATEGORY cmdline] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/comm/comm.man.
︙ | ︙ | |||
1224 1225 1226 1227 1228 1229 1230 | [para] Andreas Kupries <[email protected]> uses [package comm] and has built a simple nameserver as part of his Pool library. See [uri http://www.purl.org/net/akupries/soft/pool/index.htm]. [vset CATEGORY comm] | | | 1224 1225 1226 1227 1228 1229 1230 1231 1232 | [para] Andreas Kupries <[email protected]> uses [package comm] and has built a simple nameserver as part of his Pool library. See [uri http://www.purl.org/net/akupries/soft/pool/index.htm]. [vset CATEGORY comm] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/comm/comm_wire.man.
︙ | ︙ | |||
276 277 278 279 280 281 282 | negotiated. IOW if v2 is used the client will not see a version reply during the negotiation handshake. }] [vset CATEGORY comm] | | | 276 277 278 279 280 281 282 283 284 | negotiated. IOW if v2 is used the client will not see a version reply during the negotiation handshake. }] [vset CATEGORY comm] [include ../common-text/feedback.inc] [manpage_end] |
Name change from modules/doctools2base/include/feedback.inc to modules/common-text/feedback.inc.
︙ | ︙ |
Changes to modules/control/control.man.
︙ | ︙ | |||
157 158 159 160 161 162 163 | % catch a 1 % catch b 0 }] [vset CATEGORY control] | | | 157 158 159 160 161 162 163 164 165 | % catch a 1 % catch b 0 }] [vset CATEGORY control] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/coroutine/coro_auto.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | [def [cmd global]] [def [cmd read]] [def [cmd update]] [def [cmd vwait]] [list_end] [vset CATEGORY coroutine] | | | 38 39 40 41 42 43 44 45 46 | [def [cmd global]] [def [cmd read]] [def [cmd update]] [def [cmd vwait]] [list_end] [vset CATEGORY coroutine] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/coroutine/coroutine.tcl.
︙ | ︙ | |||
94 95 96 97 98 99 100 | } tailcall {*}$cmd } # - -- --- ----- -------- ------------- proc ::coroutine::util::after {delay} { | | | 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | } tailcall {*}$cmd } # - -- --- ----- -------- ------------- proc ::coroutine::util::after {delay} { ::after $delay [list [info coroutine]] yield return } # - -- --- ----- -------- ------------- proc ::coroutine::util::exit {{status 0}} { |
︙ | ︙ | |||
125 126 127 128 129 130 131 | # Step 2. To prevent the next section of the coroutine code from # running entirely within the variable trace (*) we now use an # idle handler to defer it until the trace is definitely # done. This trick by Peter Spjuth. # # (*) At this point we are in VWaitTrace running the coroutine. | | | | | 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 | # Step 2. To prevent the next section of the coroutine code from # running entirely within the variable trace (*) we now use an # idle handler to defer it until the trace is definitely # done. This trick by Peter Spjuth. # # (*) At this point we are in VWaitTrace running the coroutine. ::after idle [list [info coroutine]] yield return } proc ::coroutine::util::VWaitTrace {coroutine args} { $coroutine return } # - -- --- ----- -------- ------------- proc ::coroutine::util::update {{what {}}} { if {$what eq "idletasks"} { ::after idle [list [info coroutine]] } elseif {$what ne {}} { # Force proper error message for bad call. tailcall ::tcl::update $what } else { ::after 0 [list [info coroutine]] } yield return } # - -- --- ----- -------- ------------- |
︙ | ︙ | |||
376 377 378 379 380 381 382 | # Step 2. To prevent the next section of the coroutine code from # running entirely within the variable trace (*) we now use an # idle handler to defer it until the trace is definitely # done. This trick by Peter Spjuth. # # (*) At this point we are in AWaitSignal running the coroutine. | | | 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | # Step 2. To prevent the next section of the coroutine code from # running entirely within the variable trace (*) we now use an # idle handler to defer it until the trace is definitely # done. This trick by Peter Spjuth. # # (*) At this point we are in AWaitSignal running the coroutine. ::after idle [list [info coroutine]] yield return $choice } proc ::coroutine::util::AWaitSignal {coroutine var index op} { if {$op ne "write"} { return } |
︙ | ︙ |
Changes to modules/coroutine/tcllib_coroutine.man.
︙ | ︙ | |||
109 110 111 112 113 114 115 | This command causes the coroutine calling it to wait for a write to the named namespace variable [arg varname]. [list_end] [vset CATEGORY coroutine] | | | 109 110 111 112 113 114 115 116 117 | This command causes the coroutine calling it to wait for a write to the named namespace variable [arg varname]. [list_end] [vset CATEGORY coroutine] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/counter/counter.man.
︙ | ︙ | |||
242 243 244 245 246 247 248 | Resets the counter with the name [arg tag] to an initial state. The [arg args] determine the new characteristics of the counter. They have the same meaning as described for [cmd ::counter::init]. [list_end] [vset CATEGORY counter] | | | 242 243 244 245 246 247 248 249 250 | Resets the counter with the name [arg tag] to an initial state. The [arg args] determine the new characteristics of the counter. They have the same meaning as described for [cmd ::counter::init]. [list_end] [vset CATEGORY counter] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/crc/cksum.man.
︙ | ︙ | |||
123 124 125 126 127 128 129 | 2609532967 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] | | | 123 124 125 126 127 128 129 130 131 | 2609532967 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/crc/crc16.man.
︙ | ︙ | |||
141 142 143 144 145 146 147 | 51675 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] | | | 141 142 143 144 145 146 147 148 149 | 51675 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/crc/crc32.man.
︙ | ︙ | |||
144 145 146 147 148 149 150 | 3964322768 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] | | | 144 145 146 147 148 149 150 151 152 | 3964322768 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/crc/sum.man.
︙ | ︙ | |||
100 101 102 103 104 105 106 | 13392 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] | | | 100 101 102 103 104 105 106 107 108 | 13392 }] [section AUTHORS] Pat Thoyts [vset CATEGORY crc] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/cron/cron.man.
︙ | ︙ | |||
178 179 180 181 182 183 184 | [para] [arg newtime] is expressed in absolute milliseconds since the beginning of the epoch. [list_end] [para] [vset CATEGORY odie] | | | 178 179 180 181 182 183 184 185 186 | [para] [arg newtime] is expressed in absolute milliseconds since the beginning of the epoch. [list_end] [para] [vset CATEGORY odie] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/csv/csv.man.
︙ | ︙ | |||
239 240 241 242 243 244 245 | d) (the empty string) }] instead. As can be seen only item (d) is different, now the empty string instead of a ". [vset CATEGORY csv] | | | 239 240 241 242 243 244 245 246 247 | d) (the empty string) }] instead. As can be seen only item (d) is different, now the empty string instead of a ". [vset CATEGORY csv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/debug/debug.man.
︙ | ︙ | |||
239 240 241 242 243 244 245 | [para] The result of the method is the specified text. [comment {= = == === ===== ======== ============= =====================}] [list_end] [vset CATEGORY debug] | | | 239 240 241 242 243 244 245 246 247 | [para] The result of the method is the specified text. [comment {= = == === ===== ======== ============= =====================}] [list_end] [vset CATEGORY debug] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/debug/debug_caller.man.
︙ | ︙ | |||
36 37 38 39 40 41 42 | The main anticipiated use case for this is the exclusion of arguments expected to contain large Tcl values, i.e. long lists, large dictionaries, etc. to prevent them from overwhelming the narrative. [list_end] [vset CATEGORY debug] | | | 36 37 38 39 40 41 42 43 44 | The main anticipiated use case for this is the exclusion of arguments expected to contain large Tcl values, i.e. long lists, large dictionaries, etc. to prevent them from overwhelming the narrative. [list_end] [vset CATEGORY debug] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/debug/debug_heartbeat.man.
︙ | ︙ | |||
35 36 37 38 39 40 41 | counter and the time in milliseconds since the last beat, thus providing insight into timing variationsn and deviations from the nominal [arg delta]. [list_end] [vset CATEGORY debug] | | | 35 36 37 38 39 40 41 42 43 | counter and the time in milliseconds since the last beat, thus providing insight into timing variationsn and deviations from the nominal [arg delta]. [list_end] [vset CATEGORY debug] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/debug/debug_timestamp.man.
︙ | ︙ | |||
26 27 28 29 30 31 32 | last call, making it useful in a tag-specific prefix to automatically provide caller information for all uses of the tag. Or in a message, when only specific places need such detail. [list_end] [vset CATEGORY debug] | | | 26 27 28 29 30 31 32 33 34 | last call, making it useful in a tag-specific prefix to automatically provide caller information for all uses of the tag. Or in a message, when only specific places need such detail. [list_end] [vset CATEGORY debug] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/defer/defer.man.
︙ | ︙ | |||
94 95 96 97 98 99 100 | [enum] [list_end] [section AUTHORS] Roy Keene [vset CATEGORY defer] | | | 94 95 96 97 98 99 100 101 102 | [enum] [list_end] [section AUTHORS] Roy Keene [vset CATEGORY defer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/des/des.man.
︙ | ︙ | |||
198 199 200 201 202 203 204 | [section "AUTHORS"] Jochen C Loewer, Mac Cody, Pat Thoyts [vset CATEGORY des] | | | 198 199 200 201 202 203 204 205 206 | [section "AUTHORS"] Jochen C Loewer, Mac Cody, Pat Thoyts [vset CATEGORY des] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/des/tcldes.man.
︙ | ︙ | |||
18 19 20 21 22 23 24 | [para] The [package tclDES] package is a helper package for [package des]. [para] Please see the documentation of [package des] for details. [vset CATEGORY des] | | | 18 19 20 21 22 23 24 25 26 | [para] The [package tclDES] package is a helper package for [package des]. [para] Please see the documentation of [package des] for details. [vset CATEGORY des] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/des/tcldesjr.man.
︙ | ︙ | |||
18 19 20 21 22 23 24 | [para] The [package tclDESjr] package is a helper package for [package des]. [para] Please see the documentation of [package des] for details. [vset CATEGORY des] | | | 18 19 20 21 22 23 24 25 26 | [para] The [package tclDESjr] package is a helper package for [package des]. [para] Please see the documentation of [package des] for details. [vset CATEGORY des] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/dicttool/dicttool.man.
1 | [comment {-*- tcl -*- doctools manpage}] | > | > | | 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 | [vset VERSION 1.0] [comment {-*- tcl -*- doctools manpage}] [manpage_begin dicttool n [vset VERSION]] [keywords dict] [copyright {2017 Sean Woods <[email protected]>}] [moddesc {Extensions to the standard "dict" command}] [category Utilities] [titledesc {Dictionary Tools}] [require Tcl 8.5] [require dicttool [opt [vset VERSION]]] [description] [para] The [package dicttool] package enhances the standard [emph dict] command with several new commands. In addition, the package also defines several "creature comfort" list commands as well. Each command checks to see if a command already exists of the same name before adding itself, just in case any of these slip into the core. [list_begin definitions] [call [cmd ladd] [arg varname] [arg args]] This command will add a new instance of each element in [arg args] to [arg varname], but only if that element is not already present. [call [cmd ldelete] [arg varname] [arg args]] This command will delete all instances of each element in [arg args] from [arg varname]. [call [cmd {dict getnull}] [arg args]] Operates like [cmd {dict get}], however if the key [arg args] does not exist, it returns an empty list instead of throwing an error. [call [cmd {dict print}] [arg dict]] |
︙ | ︙ | |||
68 69 70 71 72 73 74 | } } }] [list_end] [vset CATEGORY dict] | | | 70 71 72 73 74 75 76 77 78 | } } }] [list_end] [vset CATEGORY dict] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/dicttool/dicttool.md.
︙ | ︙ | |||
9 10 11 12 13 14 15 | #### ladd *varname* *args* This command will add a new instance of each element in *args* to *varname*, but only if that element is not already present. #### ldelete] *varname* *args* | | | 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | #### ladd *varname* *args* This command will add a new instance of each element in *args* to *varname*, but only if that element is not already present. #### ldelete] *varname* *args* This command will delete all instances of each element in *args* from *varname*. #### dict getnull *args* Operates like **dict get**, however if the key *args* does not exist, it returns an empty list instead of throwing an error. #### dict print *dict* |
︙ | ︙ |
Changes to modules/dns/tcllib_dns.man.
︙ | ︙ | |||
283 284 285 286 287 288 289 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY dns] | | | 283 284 285 286 287 288 289 290 291 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY dns] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/dns/tcllib_ip.man.
︙ | ︙ | |||
443 444 445 446 447 448 449 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY dns] | | | 443 444 445 446 447 448 449 450 451 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY dns] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/changelog.man.
︙ | ︙ | |||
79 80 81 82 83 84 85 | command merges all of them into a single structure, and collapses multiple entries for the same date and author into a single entry. The new structure is returned as the result of the command. [list_end] [vset CATEGORY doctools] | | | 79 80 81 82 83 84 85 86 87 | command merges all of them into a single structure, and collapses multiple entries for the same date and author into a single entry. The new structure is returned as the result of the command. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/checker.tcl.
︙ | ︙ | |||
612 613 614 615 616 617 618 | } set pid $sect($fid) } } } # If we have no text take the section title as text, if we | | | 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 | } set pid $sect($fid) } } } # If we have no text take the section title as text, if we # can. Last fallback for text is the id. if {$title == {}} { if {$pid != {}} { set title $sectt($fid) } else { set title $id } } |
︙ | ︙ |
Changes to modules/doctools/cvs.man.
︙ | ︙ | |||
93 94 95 96 97 98 99 | logs. It takes this information and converts it into a text in the format of a ChangeLog as accepted and generated by [syscmd emacs]. The constructed text is returned as the result of the command. [list_end] [vset CATEGORY doctools] | | | 93 94 95 96 97 98 99 100 101 | logs. It takes this information and converts it into a text in the format of a ChangeLog as accepted and generated by [syscmd emacs]. The constructed text is returned as the result of the command. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx.man.
︙ | ︙ | |||
402 403 404 405 406 407 408 | This engine generates Wiki markup as understood by Jean Claude Wippler's [syscmd wikit] application. [list_end] [vset CATEGORY doctools] | | | 402 403 404 405 406 407 408 409 410 | This engine generates Wiki markup as understood by Jean Claude Wippler's [syscmd wikit] application. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx_intro.man.
︙ | ︙ | |||
98 99 100 101 102 103 104 | respectively. They are described in their own sets of documents, starting at the [term {doctoc introduction}] and the [term {doctools introduction}], respectively. [vset CATEGORY doctools] | | | 98 99 100 101 102 103 104 105 106 | respectively. They are described in their own sets of documents, starting at the [term {doctoc introduction}] and the [term {doctools introduction}], respectively. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx_lang_cmdref.man.
︙ | ︙ | |||
108 109 110 111 112 113 114 | Templating. In this form the command is replaced by the value of the named document variable [list_end] [vset CATEGORY doctools] | | | 108 109 110 111 112 113 114 115 116 | Templating. In this form the command is replaced by the value of the named document variable [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx_lang_faq.man.
︙ | ︙ | |||
20 21 22 23 24 25 26 | [section OVERVIEW] [include include/placeholder.inc] [include include/examples.inc] [vset CATEGORY doctools] | | | 20 21 22 23 24 25 26 27 28 | [section OVERVIEW] [include include/placeholder.inc] [include include/examples.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx_lang_intro.man.
︙ | ︙ | |||
206 207 208 209 210 211 212 | On the other hand, docidx is perfectly suited for the automatic generation from doctools documents, and this is the route Tcllib's easy and simple [syscmd dtplite] goes, creating an index for a set of documents behind the scenes, without the writer having to do so on their own. [vset CATEGORY doctools] | | | 206 207 208 209 210 211 212 213 214 | On the other hand, docidx is perfectly suited for the automatic generation from doctools documents, and this is the route Tcllib's easy and simple [syscmd dtplite] goes, creating an index for a set of documents behind the scenes, without the writer having to do so on their own. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx_lang_syntax.man.
︙ | ︙ | |||
112 113 114 115 116 117 118 | [enum][cmd rb], or [enum][cmd vset] (1-argument form). [list_end] [list_end] [vset CATEGORY doctools] | | | 112 113 114 115 116 117 118 119 120 | [enum][cmd rb], or [enum][cmd vset] (1-argument form). [list_end] [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/docidx_plugin_apiref.man.
︙ | ︙ | |||
413 414 415 416 417 418 419 | [para] The formatted text is expected as the result of the command, and added to the output. If no special processing is required it has to simply return its argument without change. [list_end] [vset CATEGORY doctools] | | | 413 414 415 416 417 418 419 420 421 | [para] The formatted text is expected as the result of the command, and added to the output. If no special processing is required it has to simply return its argument without change. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc.man.
︙ | ︙ | |||
402 403 404 405 406 407 408 | This engine generates Wiki markup as understood by Jean Claude Wippler's [syscmd wikit] application. [list_end] [vset CATEGORY doctools] | | | 402 403 404 405 406 407 408 409 410 | This engine generates Wiki markup as understood by Jean Claude Wippler's [syscmd wikit] application. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc_intro.man.
︙ | ︙ | |||
97 98 99 100 101 102 103 | of [term {keyword indices}], and general documentation, respectively. They are described in their own sets of documents, starting at the [term {docidx introduction}] and the [term {doctools introduction}], respectively. [vset CATEGORY doctools] | | | 97 98 99 100 101 102 103 104 105 | of [term {keyword indices}], and general documentation, respectively. They are described in their own sets of documents, starting at the [term {docidx introduction}] and the [term {doctools introduction}], respectively. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc_lang_cmdref.man.
︙ | ︙ | |||
119 120 121 122 123 124 125 | Templating. In this form the command is replaced by the value of the named document variable [list_end] [vset CATEGORY doctools] | | | 119 120 121 122 123 124 125 126 127 | Templating. In this form the command is replaced by the value of the named document variable [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc_lang_faq.man.
︙ | ︙ | |||
20 21 22 23 24 25 26 | [section OVERVIEW] [include include/placeholder.inc] [include include/examples.inc] [vset CATEGORY doctools] | | | 20 21 22 23 24 25 26 27 28 | [section OVERVIEW] [include include/placeholder.inc] [include include/examples.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc_lang_intro.man.
︙ | ︙ | |||
289 290 291 292 293 294 295 | On the other hand, doctoc is perfectly suited for the automatic generation from doctools documents, and this is the route Tcllib's easy and simple [syscmd dtplite] goes, creating a table of contents for a set of documents behind the scenes, without the writer having to do so on their own. [vset CATEGORY doctools] | | | 289 290 291 292 293 294 295 296 297 | On the other hand, doctoc is perfectly suited for the automatic generation from doctools documents, and this is the route Tcllib's easy and simple [syscmd dtplite] goes, creating a table of contents for a set of documents behind the scenes, without the writer having to do so on their own. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc_lang_syntax.man.
︙ | ︙ | |||
97 98 99 100 101 102 103 | division = DIVISION_START contents DIVISION_END }] [vset CATEGORY doctools] | | | 97 98 99 100 101 102 103 104 105 | division = DIVISION_START contents DIVISION_END }] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctoc_plugin_apiref.man.
︙ | ︙ | |||
413 414 415 416 417 418 419 | [para] The formatted text is expected as the result of the command, and added to the output. If no special processing is required it has to simply return its argument without change. [list_end] [vset CATEGORY doctools] | | | 413 414 415 416 417 418 419 420 421 | [para] The formatted text is expected as the result of the command, and added to the output. If no special processing is required it has to simply return its argument without change. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools.man.
1 | [comment {-*- tcl -*- doctools manpage}] | | | 1 2 3 4 5 6 7 8 9 | [comment {-*- tcl -*- doctools manpage}] [vset PACKAGE_VERSION 1.5.6] [manpage_begin doctools n [vset PACKAGE_VERSION]] [see_also doctools_intro] [see_also doctools_lang_cmdref] [see_also doctools_lang_intro] [see_also doctools_lang_syntax] [see_also doctools_plugin_apiref] [keywords conversion] |
︙ | ︙ | |||
567 568 569 570 571 572 573 | This engine generates Wiki markup as understood by Jean Claude Wippler's [syscmd wikit] application. [list_end] [vset CATEGORY doctools] | | | 567 568 569 570 571 572 573 574 575 | This engine generates Wiki markup as understood by Jean Claude Wippler's [syscmd wikit] application. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools.tcl.
︙ | ︙ | |||
1354 1355 1356 1357 1358 1359 1360 | # => FOO/mpformats #catch {search [file join $here lib doctools mpformats]} #catch {search [file join [file dirname $here] lib doctools mpformats]} catch {search [file join $here mpformats]} } | | | 1354 1355 1356 1357 1358 1359 1360 1361 | # => FOO/mpformats #catch {search [file join $here lib doctools mpformats]} #catch {search [file join [file dirname $here] lib doctools mpformats]} catch {search [file join $here mpformats]} } package provide doctools 1.5.6 |
Changes to modules/doctools/doctools_intro.man.
︙ | ︙ | |||
95 96 97 98 99 100 101 | respectively. They are described in their own sets of documents, starting at the [term {docidx introduction}] and the [term {doctoc introduction}], respectively. [vset CATEGORY doctools] | | | 95 96 97 98 99 100 101 102 103 | respectively. They are described in their own sets of documents, starting at the [term {docidx introduction}] and the [term {doctoc introduction}], respectively. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools_lang_cmdref.man.
︙ | ︙ | |||
462 463 464 465 466 467 468 | Text markup. The argument is marked up as the name of a [term widget]. The text may have other markup already applied to it. Main use is the highlighting of widget names in free-form text. [list_end] [vset CATEGORY doctools] | | | 462 463 464 465 466 467 468 469 470 | Text markup. The argument is marked up as the name of a [term widget]. The text may have other markup already applied to it. Main use is the highlighting of widget names in free-form text. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools_lang_faq.man.
︙ | ︙ | |||
20 21 22 23 24 25 26 | [section OVERVIEW] [include include/placeholder.inc] [include include/examples.inc] [vset CATEGORY doctools] | | | 20 21 22 23 24 25 26 27 28 | [section OVERVIEW] [include include/placeholder.inc] [include include/examples.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools_lang_intro.man.
︙ | ︙ | |||
69 70 71 72 73 74 75 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] | | | 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | [keywords {doctools language}] [keywords {doctools markup}] [keywords {doctools syntax}] [keywords markup] [keywords {semantic markup}] [description] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] }] This also shows us that all doctools documents are split into two parts, the [term header] and the [term body]. Everything coming before [lb][cmd description][rb] belongs to the header, and everything coming after belongs to the body, with the whole document bracketed by the |
︙ | ︙ | |||
132 133 134 135 136 137 138 | Remember that the whitespace is optional. The document [example { [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] | | | 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | Remember that the whitespace is optional. The document [example { [manpage_begin NAME SECTION VERSION] [copyright {YEAR AUTHOR}][titledesc TITLE][moddesc MODULE_TITLE] [require PACKAGE VERSION][require PACKAGE][description] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] }] has the same meaning as the example before. [para] |
︙ | ︙ | |||
609 610 611 612 613 614 615 | To be able to validate a document while writing it, it is also recommended to familiarize oneself with one of the applications for the processing and conversion of doctools documents, i.e. either Tcllib's easy and simple [syscmd dtplite], or Tclapps' ultra-configurable [syscmd dtp]. [vset CATEGORY doctools] | | | 609 610 611 612 613 614 615 616 617 | To be able to validate a document while writing it, it is also recommended to familiarize oneself with one of the applications for the processing and conversion of doctools documents, i.e. either Tcllib's easy and simple [syscmd dtplite], or Tclapps' ultra-configurable [syscmd dtp]. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools_lang_syntax.man.
︙ | ︙ | |||
134 135 136 137 138 139 140 | enum_list = [ <WHITE> ] { ENUM paras } item_list = [ <WHITE> ] { ITEM paras } optd_list = [ <WHITE> ] { OPT_DEF paras } tkoptd_list = [ <WHITE> ] { TKOPTION_DEF paras } }] [vset CATEGORY doctools] | | | 134 135 136 137 138 139 140 141 142 | enum_list = [ <WHITE> ] { ENUM paras } item_list = [ <WHITE> ] { ITEM paras } optd_list = [ <WHITE> ] { OPT_DEF paras } tkoptd_list = [ <WHITE> ] { TKOPTION_DEF paras } }] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/doctools_plugin_apiref.man.
︙ | ︙ | |||
470 471 472 473 474 475 476 | [para] The formatted text is expected as the result of the command, and added to the output. If no special processing is required it has to simply return its argument without change. [list_end] [vset CATEGORY doctools] | | | 470 471 472 473 474 475 476 477 478 | [para] The formatted text is expected as the result of the command, and added to the output. If no special processing is required it has to simply return its argument without change. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/mpexpand.man.
︙ | ︙ | |||
99 100 101 102 103 104 105 | [section NOTES] [para] Possible future formats are plain text, pdf and postscript. [vset CATEGORY doctools] | | | 99 100 101 102 103 104 105 106 107 | [section NOTES] [para] Possible future formats are plain text, pdf and postscript. [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools/mpformats/_markdown.tcl.
︙ | ︙ | |||
30 31 32 33 34 35 36 | proc Sub4Title {lb title} { upvar 1 $lb lines lappend lines "[Hash][Hash][Hash][Hash] $title" return } | | | | 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | proc Sub4Title {lb title} { upvar 1 $lb lines lappend lines "[Hash][Hash][Hash][Hash] $title" return } proc _Strong {text} { return [Undr][Undr]${text}[Undr][Undr] } proc _Em {text} { return [Star]${text}[Star] } ## # # ## ### ##### ######## ## set __comments 0 |
︙ | ︙ |
Changes to modules/doctools/mpformats/_text.tcl.
︙ | ︙ | |||
117 118 119 120 121 122 123 | upvar 1 $lb lines #lappend lines "" lappend lines $title lappend lines [RepeatM - $title] return } | > > > | | > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | upvar 1 $lb lines #lappend lines "" lappend lines $title lappend lines [RepeatM - $title] return } proc Strong {text} { SplitLine $text _Strong } proc Em {text} { SplitLine $text _Em } proc _Strong {text} { return *${text}* } proc _Em {text} { return _${text}_ } proc SplitLine {text cmd} { #puts_stderr AAA/SLI=[string map [list \1 \\1 \t \\t { } \\s] <<[join [split $text \n] >>\n<<]>>] if {![string match *\n* $text]} { foreach {lead content} [LeadSplit $text] break return ${lead}[uplevel 1 [list $cmd $content]] } set r {} foreach line [split $text \n] { foreach {lead content} [LeadSplit $line] break if {$content == {}} { lappend r {} continue } lappend r ${lead}[uplevel 1 [list $cmd $content]] } set text [string trimright [join $r \n]]\n #puts_stderr AAA/SLE=[string map [list \1 \\1 \t \\t { } \\s] <<[join [split $text \n] >>\n<<]>>] return $text } proc LeadSplit {line} { regexp {^([ \t]*)(.*)([ \t]*)$} $line -> lead content _ list $lead $content } # # ## ### ##### ######## ## Bulleting # # itembullet = index of the bullet to use in the next itemized list # enumbullet = index of the bullet to use in the next enumerated list |
︙ | ︙ |
Changes to modules/doctools/mpformats/_text_para.tcl.
︙ | ︙ | |||
20 21 22 23 24 25 26 | return } proc Text? {} { global __currentp ; return $__currentp } proc TextClear {} { global __currentp ; set __currentp "" } proc TextTrimLeadingSpace {} { global __currentp | | > > > > > > > < < > > | 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 | return } proc Text? {} { global __currentp ; return $__currentp } proc TextClear {} { global __currentp ; set __currentp "" } proc TextTrimLeadingSpace {} { global __currentp regsub {^([ \t\v\f]*\x01?\n)*} $__currentp {} __currentp return } proc TextTrimTrailingSpace {} { global __currentp regsub {([ \t\v\f]*\x01?\n)*$} $__currentp {} __currentp append __currentp \n return } proc TextPlain {text} { if {[IsOff]} {return} # Note: Whenever we get plain text it is possible that a macro for # visual markup actually generated output before the expander got # to the current text. This output was captured by the expander in # its current context. Given the current organization of the # engine we have to retrieve this formatted text from the expander # or it will be lost. This is the purpose of the 'ctopandclear', # which retrieves the data and also clears the capture buffer. The # latter to prevent us from retrieving it again later, after the # next macro added more data. set text [ex_ctopandclear]$text #puts_stderr "<<text_plain_text>>=<<[string map [list \t \\t { } \\s \n \\n \r \\r \v \\v \f \\f \1 \\1] $text]>>" # ... TODO ... Handling of example => verbatim if {[string length [string trim $text]] == 0} return Text $text return |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.html.
1 2 3 4 | # -*- tcl -*- # # fmt.html # | | > > > | 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 | # -*- tcl -*- # # fmt.html # # Copyright (c) 2001-2019 Andreas Kupries <[email protected]> # # Definitions to convert a tcl based manpage definition into # a manpage based upon HTML markup. # ################################################################ ################################################################ dt_source _common.tcl ; # Shared code dt_source _html.tcl ; # HTML basic formatting dt_source _xref.tcl ; # xref management global _in_example set _in_example 0 proc c_copyrightsymbol {} {return "[markup "&"]copy;"} proc bgcolor {} {return ""} proc border {} {return 0} proc Year {} {clock format [clock seconds] -format %Y} c_holdBuffers require synopsis |
︙ | ︙ | |||
45 46 47 48 49 50 51 52 53 54 55 56 57 58 | set liststack [lreplace $liststack end end] foreach {t l} $t break litc_set $l return $t } proc fmt_plain_text {text} { return $text } ################################################################ # Formatting commands. c_pass 1 fmt_manpage_begin {title section version} {c_cinit ; c_clrSections ; return} | > > > > | 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | set liststack [lreplace $liststack end end] foreach {t l} $t break litc_set $l return $t } proc fmt_plain_text {text} { global _in_example if {$_in_example} { set text [string map [list \\\\\n \\\n] $text] } return $text } ################################################################ # Formatting commands. c_pass 1 fmt_manpage_begin {title section version} {c_cinit ; c_clrSections ; return} |
︙ | ︙ | |||
348 349 350 351 352 353 354 | append text "Database Class:\t[bold $dbclass optdbclass][tag br]\n" fmt_lst_item $text } ################################################################ proc fmt_example_begin {} { | > | > | 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | append text "Database Class:\t[bold $dbclass optdbclass][tag br]\n" fmt_lst_item $text } ################################################################ proc fmt_example_begin {} { global _in_example ; set _in_example 1 return [para_close]\n[tag* pre class doctools_example] } proc fmt_example_end {} { global _in_example ; set _in_example 0 return [tag/ pre]\n[para_open] } proc fmt_example {code} { return "[fmt_example_begin][fmt_plain_text $code][fmt_example_end]" } ################################################################ |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.latex.
︙ | ︙ | |||
15 16 17 18 19 20 21 22 23 24 | global _in_example set _in_example 0 global _has_images set _has_images 0 # Called to handle plain text from the input proc fmt_plain_text {text} { global _in_example | > > > | > > > | 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | global _in_example set _in_example 0 global _has_images set _has_images 0 global _has_examples set _has_examples 0 # Called to handle plain text from the input proc fmt_plain_text {text} { global _in_example if {$_in_example} { lappend map \\\\\n \1\\textbackslash\n lappend map \\\n \1\\textbackslash\n set text [string map $map $text] return $text } return [texEscape $text] } proc Year {} {clock format [clock seconds] -format %Y} |
︙ | ︙ | |||
48 49 50 51 52 53 54 | } ################################################################ ## Backend for LaTeX markup c_pass 1 fmt_manpage_begin {title section version} NOP c_pass 2 fmt_manpage_begin {title section version} { | | > > > | 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 | } ################################################################ ## Backend for LaTeX markup c_pass 1 fmt_manpage_begin {title section version} NOP c_pass 2 fmt_manpage_begin {title section version} { global _has_images _has_examples set module [dt_module] set shortdesc [c_get_module] set description [c_get_title] set copyright [c_get_copyright] set hdr "" append hdr [Comment [c_provenance]] \n if {$copyright != {}} { append hdr [Comment $copyright] \n } append hdr [Comment "$title.$section"] \n append hdr \n append hdr "\1\\documentclass\{article\}" \n if {$_has_images} { append hdr "\1\\usepackage{epsfig}" \n append hdr "\1\\usepackage{epstopdf}" \n } if {$_has_examples} { append hdr "\1\\usepackage{alltt}" \n } append hdr "\1\\begin\{document\}" \n append hdr "\1\\author\{[dt_user]\}" \n set titletext "" append titletext "$module / $title -- " append titletext "$shortdesc : $description" |
︙ | ︙ | |||
298 299 300 301 302 303 304 | append text "Database Class: [Bold $dbclass]\\\\\n" return "\n%\n\1\\item\[\] $text\n%\n" } ################################################################ proc fmt_example_begin {} { | | > | | | > > | 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 | append text "Database Class: [Bold $dbclass]\\\\\n" return "\n%\n\1\\item\[\] $text\n%\n" } ################################################################ proc fmt_example_begin {} { global _has_examples _in_example set _has_examples 1 set _in_example 1 return "\1\\begin{alltt}\n" } proc fmt_example_end {} { global _in_example set _in_example 0 return "\1\\end{alltt}\n" } # No mapping of special characters proc fmt_example {code} { return [fmt_example_begin][fmt_plain_text $code][fmt_example_end] } proc fmt_arg {text} {Underline $text} proc fmt_cmd {text} {Bold $text} proc fmt_emph {text} {Italic $text} proc fmt_opt {text} {return ?$text?} proc fmt_comment {text} { |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.markdown.
︙ | ︙ | |||
33 34 35 36 37 38 39 40 41 42 43 | proc In? {} { if {![CAttrHas mdindent]} { CAttrSet mdindent "" } CAttrGet mdindent } proc In! {ws} { CAttrSet mdindent $ws } | > > > > > > > > > > > > | | | > > > > > > > > | 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 | proc In? {} { if {![CAttrHas mdindent]} { CAttrSet mdindent "" } CAttrGet mdindent } proc In! {ws} { CAttrSet mdindent $ws } proc Example {complex} { if {![CAttrHas exenv$complex]} { ContextPush set exenv [NewExample $complex] ContextPop CAttrSet exenv$complex $exenv ContextCommit } return [CAttrGet exenv$complex] } proc NewExample {complex} { return [ContextNew Example$complex { VerbatimOn Example! if {$complex} { # Block quote Prefix+ "> " } else { # Code block Prefix+ " " } }] ; # {} } proc NewUnorderedList {} { # Itemized list - unordered list - bullet # 1. Base context provides indentation. # 2. First paragraph in a list item. |
︙ | ︙ | |||
274 275 276 277 278 279 280 | set shortdesc [c_get_module] set description [c_get_title] set copyright [c_get_copyright] set pagetitle "$title - $shortdesc" MDComment "$title - $shortdesc" MDComment [c_provenance] | | > > > > > > > > | 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 | set shortdesc [c_get_module] set description [c_get_title] set copyright [c_get_copyright] set pagetitle "$title - $shortdesc" MDComment "$title - $shortdesc" MDComment [c_provenance] if {$copyright != {}} { # Note, multiple copyright clauses => multiple lines, comments # are single-line => split for generation, strip MD markup for # linebreaks, will be re-added when committing the complete # comment block. foreach line [split $copyright \n] { MDComment [string trimright $line " \t\1"] } } MDComment "[string trimleft $title :]($section) $version $module \"$shortdesc\"" MDCDone Text [GetT header @TITLE@ $pagetitle] CloseParagraph Section NAME |
︙ | ︙ | |||
342 343 344 345 346 347 348 | set kw [c_xref_keywords] set ca [c_xref_category] set ct [c_get_copyright] CloseParagraph if {[llength $sa]} { Special {SEE ALSO} seealso [join [XrefList [lsort $sa] sa] ", "] } if {[llength $kw]} { Special KEYWORDS keywords [join [XrefList [lsort $kw] kw] ", "] } | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > | > > < | < | | 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 | set kw [c_xref_keywords] set ca [c_xref_category] set ct [c_get_copyright] CloseParagraph if {[llength $sa]} { Special {SEE ALSO} seealso [join [XrefList [lsort $sa] sa] ", "] } if {[llength $kw]} { Special KEYWORDS keywords [join [XrefList [lsort $kw] kw] ", "] } if {$ca ne ""} { Special CATEGORY category $ca } if {$ct != {}} { Special COPYRIGHT copyright $ct [Verbatim] } return } proc Breaks {lines} { set r {} foreach line $lines { lappend r $line[LB] } return $r } proc LeadSpaces {lines} { set r {} foreach line $lines { lappend r [LeadSpace $line] } return $r } proc LeadSpace {line} { # Split into leading and trailing whitespace, plus content regexp {^([ \t]*)(.*)([ \t]*)$} $line -> lead content _ # Drop trailing spaces, make leading non-breaking, keep content (and inner spaces). return [RepeatM " " $lead]$content } c_pass 2 fmt_example_end {} { #puts_stderr "AAA/fmt_example_end" # Flush markup from preceding commands into the text buffer. TextPlain "" TextTrimLeadingSpace # Check for protected markdown markup in the input. If present # this is a complex example with highlighted parts. set complex [string match *\1* [Text?]] #puts_stderr "AAA/fmt_example_end/$complex" # In examples (verbatim markup) markdown's special characters are # no such by default, thus must not be quoted. Mark them as # protected from quoting. Further look for and convert # continuation lines protected from Tcl substitution into a # regular continuation line. set t [Text?] set t [string map [list \\\\\n \\\n] $t] if {$complex} { # Process for block quote # - make leading spaces non-breaking # - force linebreaks set t [join [Breaks [LeadSpaces [split $t \n]]] {}] } else { # Process for code block (verbatim) set t [Mark $t] } TextClear Text $t TextTrimTrailingSpace set penv [GetCurrent] if {$penv != {}} { # In a list we save the current list context, activate the # proper paragraph context and create its example # variant. After closing the paragraph using the example we # restore and reactivate the list context. ContextPush ContextSet $penv CloseParagraph [Example $complex] ContextPop } else { # In a regular paragraph we simple close the example CloseParagraph [Example $complex] } #puts_stderr "AAA/fmt_example_end/Done" return } proc c_get_copyright {} { |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.nroff.
︙ | ︙ | |||
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | ################################################################ # Load shared code, load nroff support. dt_source _common.tcl dt_source _nroff.tcl ################################################################ # Define the API commands. c_pass 1 fmt_manpage_begin {title section version} c_begin c_pass 2 fmt_manpage_begin {title section version} { c_begin set module [dt_module] set shortdesc [c_get_module] | > > > > > > > > > > > > | 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 | ################################################################ # Load shared code, load nroff support. dt_source _common.tcl dt_source _nroff.tcl global _in_example set _in_example 0 ################################################################ # Define the API commands. # Called to handle plain text from the input proc fmt_plain_text {text} { global _in_example if {$_in_example} { set text [string map [list \\\\\n \\\n] $text] } return $text } c_pass 1 fmt_manpage_begin {title section version} c_begin c_pass 2 fmt_manpage_begin {title section version} { c_begin set module [dt_module] set shortdesc [c_get_module] |
︙ | ︙ | |||
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | append text "[nr_item]\n" return $text } ################################################################ proc fmt_example_begin {} { return [nr_cs]\n } proc fmt_example_end {} { if {[dt_lnesting]} { return [nr_ce][nr_item] } nr_ce } | > > | > > | 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 | append text "[nr_item]\n" return $text } ################################################################ proc fmt_example_begin {} { global _in_example ; set _in_example 1 return [nr_cs]\n } proc fmt_example_end {} { global _in_example ; set _in_example 0 if {[dt_lnesting]} { return [nr_ce][nr_item] } nr_ce } proc fmt_example {code} { global _in_example ; set _in_example 1 set lines [list "" [nr_cs]] foreach line [split $code "\n"] { lappend lines [fmt_plain_text $line] } lappend lines [nr_ce] "" set _in_example 0 return [join $lines "\n"] } proc fmt_nl {} {nr_vspace} proc fmt_arg {text} {underline $text} proc fmt_cmd {text} {bold $text} proc fmt_emph {text} {underline $text} |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.text.
︙ | ︙ | |||
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | #puts_stderr "AAA/fmt_example_begin/Done" return } c_pass 1 fmt_example_end {} NOP c_pass 2 fmt_example_end {} { #puts_stderr "AAA/fmt_example_end" TextTrimLeadingSpace set penv [GetCurrent] if {$penv != {}} { # In a list we save the current list context, activate the # proper paragraph context and create its example # variant. After closing the paragraph using the example we # restore and reactivate the list context. | > > > > > > > > > > > > > | 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 | #puts_stderr "AAA/fmt_example_begin/Done" return } c_pass 1 fmt_example_end {} NOP c_pass 2 fmt_example_end {} { #puts_stderr "AAA/fmt_example_end" #puts_stderr AAA/EIN=[string map [list \1 \\1 \t \\t { } \\s] <<[join [split [Text?] \n] >>\n<<]>>] # Flush markup from preceding commands into the text buffer. TextPlain "" TextTrimLeadingSpace # Look for and convert continuation lines protected from Tcl # substitution into a regular continuation line. set t [string map [list \\\\\n \\\n] [Text?]] TextClear Text $t #puts_stderr AAA/EFT=[string map [list \1\\1 \t \\t { } \\s] <<[join [split [Text?] \n] >>\n<<]>>] set penv [GetCurrent] if {$penv != {}} { # In a list we save the current list context, activate the # proper paragraph context and create its example # variant. After closing the paragraph using the example we # restore and reactivate the list context. |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.tmml.
︙ | ︙ | |||
36 37 38 39 40 41 42 | proc fmt_cmd {text} { wrap $text cmd } proc fmt_emph {text} { wrap $text emph } proc fmt_opt {text} { wrap $text o } c_pass 1 fmt_example_begin {} NOP c_pass 1 fmt_example_end {} NOP c_pass 1 fmt_example {code} NOP | | > > > | > > > > > | > > > > > > > > > > > > | 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 | proc fmt_cmd {text} { wrap $text cmd } proc fmt_emph {text} { wrap $text emph } proc fmt_opt {text} { wrap $text o } c_pass 1 fmt_example_begin {} NOP c_pass 1 fmt_example_end {} NOP c_pass 1 fmt_example {code} NOP c_pass 2 fmt_example_begin {} { global inexample ; set inexample 1 sequence [xmlContext $::block] [start example] } c_pass 2 fmt_example_end {} { global inexample ; set inexample 0 end example } c_pass 2 fmt_example {code} { set code [string map [list \\\\\n \\\n] $code] sequence [xmlContext $::block] [wrap $code example] } global inexample set inexample 0 proc fmt_plain_text {text} { global inexample if {$inexample} { set text [string map [list \\\\\n \\\n] $text] } return $text } proc fmt_comment {text} {xmlComment $text} proc fmt_sectref {text {id {}}} { global SectionNames if {$id == {}} { set id [c_sectionId $text] } |
︙ | ︙ |
Changes to modules/doctools/mpformats/fmt.wiki.
︙ | ︙ | |||
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | return $text } ################################################################ global textmode set textmode "" proc fmt_example_begin {} { global mode_save textmode lappend mode_save $textmode set textmode example return "\n======\n" } proc fmt_example_end {} { global mode_save textmode set textmode [lindex $mode_save end] set mode_save [lrange $mode_save 0 end-1] return "\n======\n" } proc fmt_example {code} { | > > > > > > > > > | | 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 | return $text } ################################################################ global textmode set textmode "" # NOTE: The example_begin/end combo allows for the example # text to contain markup. The currently used verbatim # environment will cause show the wiki markup of the example, # instead of formatting per that markup. # # TODO: Strip internal markup from the example text, wiki cannot # handle such at all. proc fmt_example_begin {} { global mode_save textmode lappend mode_save $textmode set textmode example return "\n======\n" } proc fmt_example_end {} { global mode_save textmode set textmode [lindex $mode_save end] set mode_save [lrange $mode_save 0 end-1] return "\n======\n" } proc fmt_example {code} { set code [string map [list \\\\\n \\\n] $code] return "\n======\n$code\n======\n" } proc emph {text} {return ''$text''} proc strong {text} {return '''$text'''} proc fmt_arg {text} {return ''$text''} proc fmt_cmd {text} {return '''$text'''} |
︙ | ︙ | |||
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | # For the wiki we have to force certain text into a single line. # We also have to make sure that the text is on the same line as # the initiator (i.e. list bullet). global textmode if {"$textmode" == "example"} { return "$text" } regsub -all "\[ \t\n\]+" $text { } text return $text } ################################################################ | > | 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 | # For the wiki we have to force certain text into a single line. # We also have to make sure that the text is on the same line as # the initiator (i.e. list bullet). global textmode if {"$textmode" == "example"} { set text [string map [list \\\\\n \\\n] $text] return "$text" } regsub -all "\[ \t\n\]+" $text { } text return $text } ################################################################ |
Changes to modules/doctools/pkgIndex.tcl.
1 | if {![package vsatisfies [package provide Tcl] 8.2]} {return} | | | 1 2 3 4 5 6 | if {![package vsatisfies [package provide Tcl] 8.2]} {return} package ifneeded doctools 1.5.6 [list source [file join $dir doctools.tcl]] package ifneeded doctools::toc 1.2 [list source [file join $dir doctoc.tcl]] package ifneeded doctools::idx 1.1 [list source [file join $dir docidx.tcl]] package ifneeded doctools::cvs 1 [list source [file join $dir cvs.tcl]] package ifneeded doctools::changelog 1.1 [list source [file join $dir changelog.tcl]] |
Added modules/doctools/tests/fmt/desc/26.
Added modules/doctools/tests/fmt/desc/27.
Added modules/doctools/tests/fmt/desc/28.
Added modules/doctools/tests/fmt/html/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>TEST - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file '.FILE.' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; .COPYRIGHT. --> <!-- TEST.z --> <body><div class="doctools"> <h1 class="doctools_title">TEST(z) 3.14.15.926 .MODULE. ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>TEST -</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <pre class="doctools_example"> Example Block More Lines \ Ever More Never </pre> <p>............... Weiter .............</p> <pre class="doctools_example"> Second \ Continuing Lines \ Done </pre> <p>............... Vorwaerts ..........</p> <pre class="doctools_example"> <b class="cmd">command</b> x \ -- <b class="cmd">command</b> -- </pre> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © .COPYRIGHT.</p> </div> </div></body></html> |
Added modules/doctools/tests/fmt/html/27.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>TEST - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file '.FILE.' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; .COPYRIGHT. --> <!-- TEST.T --> <body><div class="doctools"> <h1 class="doctools_title">TEST(T) 0 .MODULE. ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>TEST -</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> <p>= = == === ===== ======== =============</p> <pre class="doctools_example">[<b class="cmd">bar</b> \ foo]</pre> <p>= = == === ===== ======== =============</p> <pre class="doctools_example"> <em> many lines highlighted </em> </pre> <p>= = == === ===== ======== =============</p> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © .COPYRIGHT.</p> </div> </div></body></html> |
Added modules/doctools/tests/fmt/html/28.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!DOCTYPE html><html><head> <title>TEST - </title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; color: black; } DIV.doctools { margin-left: 10%; margin-right: 10%; } DIV.doctools H1,DIV.doctools H2 { margin-left: -5%; } H1, H2, H3, H4 { margin-top: 1em; font-family: sans-serif; font-size: large; color: #005A9C; background: transparent; text-align: left; } H1.doctools_title { text-align: center; } UL,OL { margin-right: 0em; margin-top: 3pt; margin-bottom: 3pt; } UL LI { list-style: disc; } OL LI { list-style: decimal; } DT { padding-top: 1ex; } UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL { font: normal 12pt/14pt sans-serif; list-style: none; } LI.doctools_section, LI.doctools_subsection { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } PRE { display: block; font-family: monospace; white-space: pre; margin: 0%; padding-top: 0.5ex; padding-bottom: 0.5ex; padding-left: 1ex; padding-right: 1ex; width: 100%; } PRE.doctools_example { color: black; background: #f5dcb3; border: 1px solid black; } UL.doctools_requirements LI, UL.doctools_syntax LI { list-style: none; margin-left: 0em; text-indent: 0em; padding: 0em; } DIV.doctools_synopsis { color: black; background: #80ffff; border: 1px solid black; font-family: serif; margin-top: 1em; margin-bottom: 1em; } UL.doctools_syntax { margin-top: 1em; border-top: 1px solid black; } UL.doctools_requirements { margin-bottom: 1em; border-bottom: 1px solid black; } --></style> </head> <!-- Generated from file '.FILE.' by tcllib/doctools with format 'html' --> <!-- Copyright &copy; 2019 Me -- Copyright &copy; 2019 Myself -- Copyright &copy; 2019 And I --> <!-- TEST.z --> <body><div class="doctools"> <h1 class="doctools_title">TEST(z) 1.1.23.58132.1 .MODULE. ""</h1> <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2> <p>TEST -</p> </div> <div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="doctools_toc"> <li class="doctools_section"><a href="#toc">Table Of Contents</a></li> <li class="doctools_section"><a href="#section1">Description</a></li> <li class="doctools_section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2> </div> <div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2> <p>Copyright © 2019 Me<br> Copyright © 2019 Myself<br> Copyright © 2019 And I</p> </div> </div></body></html> |
Changes to modules/doctools/tests/fmt/latex/04.
1 2 3 4 5 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \begin{document} | > | | | | | | | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} BEGINNE HIER \begin{alltt} Example Block More Lines \end{alltt} \begin{alltt} Inlined Example \textbackslash Next Line \end{alltt} FERTIG \section{Copyright}\label{copyright} \begin{flushleft} Copyright (c) .COPYRIGHT.\linebreak \end{flushleft} \end{document} |
Changes to modules/doctools/tests/fmt/latex/08.
1 2 3 4 5 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) **Copyright** % ALL.a \documentclass{article} \begin{document} | > | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) **Copyright** % ALL.a \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / ALL -- ..THE\_MODULE.. : ..THE\_TITLE..} \maketitle \section{Synopsis}\label{synopsis} \begin{flushleft} package require {\bf AAA} package require {\bf BBB VVV} package require {\bf CCC ?VVV?} |
︙ | ︙ | |||
79 80 81 82 83 84 85 | \item[] \underline{NAME} TYPE % DESCRIPTION ::{\bf Option}:: % \item[] \underline{NAME} TYPE (MODE) % DESCRIPTION ::?Optional?:: | | | | 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 | \item[] \underline{NAME} TYPE % DESCRIPTION ::{\bf Option}:: % \item[] \underline{NAME} TYPE (MODE) % DESCRIPTION ::?Optional?:: \begin{alltt} THE ARGUMENT IS USED IN THIS AND/OR THAT MANNER \end{alltt} \end{itemize} % \item[] CMDNAME ... % DESCRIPTION ::{\bf Package}:: % \item[] CMDNAME ... |
︙ | ︙ |
Changes to modules/doctools/tests/fmt/latex/09.
1 2 3 4 5 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \begin{document} | > | | | > | | | > | | | | | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} lorem \begin{alltt} 1 lorem ipsum dolores \end{alltt} ipsum \begin{alltt} 2 lorem ipsum dolores \end{alltt} dolores \begin{alltt} 3 lorem ipsum dolores \end{alltt} lorem \begin{alltt} 4 lorem ipsum dolores \end{alltt} ipsum \begin{alltt} 5 lorem ipsum dolores \end{alltt} dolores \section{Copyright}\label{copyright} \begin{flushleft} Copyright (c) .COPYRIGHT.\linebreak \end{flushleft} \end{document} |
Changes to modules/doctools/tests/fmt/latex/13.
1 2 3 4 5 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % test-itemized-examples.1 \documentclass{article} \begin{document} | > | > | > | > | | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % test-itemized-examples.1 \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / test-itemized-examples -- : } \maketitle \section{Description}\label{section1} lorem ipsum dolores \begin{itemize} % \item % \begin{alltt} A lorem ipsum dolores \end{alltt} % \item % lorem ipsum dolores \begin{alltt} B lorem ipsum dolores \end{alltt} lorem ipsum dolores % \item % lorem ipsum dolores \begin{alltt} C lorem ipsum dolores \end{alltt} % \item % lorem ipsum dolores \end{itemize} \section{Copyright}\label{copyright} \begin{flushleft} |
︙ | ︙ |
Changes to modules/doctools/tests/fmt/latex/14.
1 2 3 4 5 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % test-enumerated-examples.1 \documentclass{article} \begin{document} | > | > | > | > | | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % test-enumerated-examples.1 \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / test-enumerated-examples -- : } \maketitle \section{Description}\label{section1} lorem ipsum dolores \begin{enumerate} % \item % \begin{alltt} A1 lorem ipsum dolores \end{alltt} % \item % lorem ipsum dolores \begin{alltt} B2 lorem ipsum dolores \end{alltt} lorem ipsum dolores % \item % lorem ipsum dolores \begin{alltt} C3 lorem ipsum dolores \end{alltt} % \item % lorem ipsum dolores \end{enumerate} \section{Copyright}\label{copyright} \begin{flushleft} |
︙ | ︙ |
Changes to modules/doctools/tests/fmt/latex/15.
1 2 3 4 5 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % test-definition-examples.1 \documentclass{article} \begin{document} | > | > | > | > | | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % test-definition-examples.1 \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / test-definition-examples -- : } \maketitle \section{Description}\label{section1} lorem ipsum dolores \begin{itemize} % \item[] lorem % \begin{alltt} A1 lorem ipsum dolores \end{alltt} % \item[] lorem % ipsum dolores \begin{alltt} B2 lorem ipsum dolores \end{alltt} lorem ipsum dolores % \item[] lorem % ipsum dolores \begin{alltt} C3 lorem ipsum dolores \end{alltt} % \item[] lorem % ipsum dolores \end{itemize} \section{Copyright}\label{copyright} \begin{flushleft} |
︙ | ︙ |
Changes to modules/doctools/tests/fmt/latex/25.
1 2 3 4 5 6 7 8 9 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} | > | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} \begin{alltt} Special markdown __non-special__ \end{alltt} \section{Copyright}\label{copyright} \begin{flushleft} Copyright (c) .COPYRIGHT.\linebreak \end{flushleft} \end{document} |
Added modules/doctools/tests/fmt/latex/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.z \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} \begin{alltt} Example Block More Lines \textbackslash Ever More Never \end{alltt} ............... Weiter ............. \begin{alltt} Second \textbackslash Continuing Lines \textbackslash Done \end{alltt} ............... Vorwaerts .......... \begin{alltt} {\bf command} x \textbackslash -- {\bf command} -- \end{alltt} \section{Copyright}\label{copyright} \begin{flushleft} Copyright (c) .COPYRIGHT.\linebreak \end{flushleft} \end{document} |
Added modules/doctools/tests/fmt/latex/27.
> > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) .COPYRIGHT. % TEST.T \documentclass{article} \usepackage{alltt} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} = = == === ===== ======== ============= \begin{alltt} [{\bf bar} \textbackslash foo]\end{alltt} = = == === ===== ======== ============= \begin{alltt} {\it many lines highlighted } \end{alltt} = = == === ===== ======== ============= \section{Copyright}\label{copyright} \begin{flushleft} Copyright (c) .COPYRIGHT.\linebreak \end{flushleft} \end{document} |
Added modules/doctools/tests/fmt/latex/28.
> > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | % Generated from file '.FILE.' by tcllib/doctools with format 'latex' % Copyright (c) 2019 Me % Copyright (c) 2019 Myself % Copyright (c) 2019 And I % TEST.z \documentclass{article} \begin{document} \author{aku} \title{.MODULE. / TEST -- : } \maketitle \section{Description}\label{section1} \section{Copyright}\label{copyright} \begin{flushleft} Copyright (c) 2019 Me\linebreak Copyright (c) 2019 Myself\linebreak Copyright (c) 2019 And I\linebreak \end{flushleft} \end{document} |
Added modules/doctools/tests/fmt/list/26.
> | 1 | manpage {seealso {} keywords {} file .FILE. section z category {} module .MODULE. version 3.14.15.926 title TEST shortdesc {} desc {} fid .FILE} |
Added modules/doctools/tests/fmt/list/27.
> | 1 | manpage {seealso {} keywords {} file .FILE. section T category {} module .MODULE. version 0 title TEST shortdesc {} desc {} fid .FILE} |
Added modules/doctools/tests/fmt/list/28.
> | 1 | manpage {seealso {} keywords {} file .FILE. section z category {} module .MODULE. version 1.1.23.58132.1 title TEST shortdesc {} desc {} fid .FILE} |
Changes to modules/doctools/tests/fmt/man/25.
|
| | | 1 2 3 4 5 6 7 | [comment { -- Example 2 }] [manpage_begin TEST z 3.14.15.926] [description] [example { Special markdown __non-special__ }] [manpage_end] |
Added modules/doctools/tests/fmt/man/26.
> > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | [comment { -- Example 3 }] [manpage_begin TEST z 3.14.15.926] [description] [example { Example Block \ More Lines \\ Ever More Never }] [para] ............... Weiter ............. [para] [example_begin] Second \ Continuing Lines \\ Done [example_end] ............... Vorwaerts .......... [example_begin] [cmd command] x \\ -- [cmd command] -- [example_end] [manpage_end] |
Added modules/doctools/tests/fmt/man/27.
> > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [comment { -- Example 4 }] [manpage_begin TEST T 0] [description] = = == === ===== ======== ============= [example_begin][lb][cmd bar] \ foo[rb][example_end] = = == === ===== ======== ============= [example_begin] [emph { many lines highlighted }] [example_end] = = == === ===== ======== ============= [manpage_end] |
Added modules/doctools/tests/fmt/man/28.
> > > > > > > | 1 2 3 4 5 6 7 | [comment { -- Multi copyright }] [manpage_begin TEST z 1.1.23.58132.1] [copyright {2019 Me}] [copyright {2019 Myself}] [copyright {2019 And I}] [description] [manpage_end] |
Added modules/doctools/tests/fmt/markdown/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (TEST \- ) [//000000002]: # (Generated from file '\.FILE\.' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © \.COPYRIGHT\.) [//000000004]: # (TEST\(z\) 3\.14\.15\.926 \.MODULE\. "") # NAME TEST \- # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION Example Block More Lines \ Ever More Never \.\.\.\.\.\.\.\.\.\.\.\.\.\.\. Weiter \.\.\.\.\.\.\.\.\.\.\.\.\. Second \ Continuing Lines \ Done \.\.\.\.\.\.\.\.\.\.\.\.\.\.\. Vorwaerts \.\.\.\.\.\.\.\.\.\. > __command__ x \\ > \-\- __command__ \-\- # <a name='copyright'></a>COPYRIGHT Copyright © \.COPYRIGHT\. |
Added modules/doctools/tests/fmt/markdown/27.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (TEST \- ) [//000000002]: # (Generated from file '\.FILE\.' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © \.COPYRIGHT\.) [//000000004]: # (TEST\(T\) 0 \.MODULE\. "") # NAME TEST \- # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION = = == === ===== ======== ============= > \[__bar__ \\ > foo\] = = == === ===== ======== ============= > *many lines* > *highlighted* = = == === ===== ======== ============= # <a name='copyright'></a>COPYRIGHT Copyright © \.COPYRIGHT\. |
Added modules/doctools/tests/fmt/markdown/28.
> > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [//000000001]: # (TEST \- ) [//000000002]: # (Generated from file '\.FILE\.' by tcllib/doctools with format 'markdown') [//000000003]: # (Copyright © 2019 Me) [//000000004]: # (Copyright © 2019 Myself) [//000000005]: # (Copyright © 2019 And I) [//000000006]: # (TEST\(z\) 1\.1\.23\.58132\.1 \.MODULE\. "") # NAME TEST \- # <a name='toc'></a>Table Of Contents - [Table Of Contents](#toc) - [Description](#section1) - [Copyright](#copyright) # <a name='description'></a>DESCRIPTION # <a name='copyright'></a>COPYRIGHT Copyright © 2019 Me Copyright © 2019 Myself Copyright © 2019 And I |
Changes to modules/doctools/tests/fmt/nroff/25.
1 2 3 4 5 | '\" '\" Generated from file '\&.FILE\&.' by tcllib/doctools with format 'nroff' '\" Copyright (c) \&.COPYRIGHT\&. '\" .TH "TEST" z 3\&.14\&.15\&.926 \&.MODULE\&. "" | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 | '\" '\" Generated from file '\&.FILE\&.' by tcllib/doctools with format 'nroff' '\" Copyright (c) \&.COPYRIGHT\&. '\" .TH "TEST" z 3\&.14\&.15\&.926 \&.MODULE\&. "" .so man.macros .BS .SH NAME TEST \- .SH DESCRIPTION .CS |
︙ | ︙ |
Added modules/doctools/tests/fmt/nroff/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file '\&.FILE\&.' by tcllib/doctools with format 'nroff' '\" Copyright (c) \&.COPYRIGHT\&. '\" .TH "TEST" z 3\&.14\&.15\&.926 \&.MODULE\&. "" .so man.macros .BS .SH NAME TEST \- .SH DESCRIPTION .CS Example Block More Lines \\ Ever More Never .CE .PP \&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. Weiter \&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. .PP .CS Second \\ Continuing Lines \\ Done .CE \&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. Vorwaerts \&.\&.\&.\&.\&.\&.\&.\&.\&.\&. .CS \fBcommand\fR x \\ -- \fBcommand\fR -- .CE .SH COPYRIGHT .nf Copyright (c) \&.COPYRIGHT\&. .fi |
Added modules/doctools/tests/fmt/nroff/27.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '\" '\" Generated from file '\&.FILE\&.' by tcllib/doctools with format 'nroff' '\" Copyright (c) \&.COPYRIGHT\&. '\" .TH "TEST" T 0 \&.MODULE\&. "" .so man.macros .BS .SH NAME TEST \- .SH DESCRIPTION = = == === ===== ======== ============= .CS [\fBbar\fR \\ foo] .CE = = == === ===== ======== ============= .CS \fI many lines highlighted \fR .CE = = == === ===== ======== ============= .SH COPYRIGHT .nf Copyright (c) \&.COPYRIGHT\&. .fi |
Added modules/doctools/tests/fmt/nroff/28.
> > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | '\" '\" Generated from file '\&.FILE\&.' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2019 Me '\" Copyright (c) 2019 Myself '\" Copyright (c) 2019 And I '\" .TH "TEST" z 1\&.1\&.23\&.58132\&.1 \&.MODULE\&. "" .so man.macros .BS .SH NAME TEST \- .SH DESCRIPTION .SH COPYRIGHT .nf Copyright (c) 2019 Me Copyright (c) 2019 Myself Copyright (c) 2019 And I .fi |
Added modules/doctools/tests/fmt/null/26.
Added modules/doctools/tests/fmt/null/27.
Added modules/doctools/tests/fmt/null/28.
Added modules/doctools/tests/fmt/syntax/26.
Added modules/doctools/tests/fmt/syntax/28.
Added modules/doctools/tests/fmt/text/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | TEST - Generated from file '.FILE.' by tcllib/doctools with format 'text' TEST(z) 3.14.15.926 .MODULE. "" NAME ==== TEST - DESCRIPTION =========== | Example Block More Lines \ | Ever More | Never ............... Weiter ............. | Second \ | Continuing Lines \ | Done ............... Vorwaerts .......... | command x \ | -- command -- COPYRIGHT ========= Copyright (c) .COPYRIGHT. |
Added modules/doctools/tests/fmt/text/27.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | TEST - Generated from file '.FILE.' by tcllib/doctools with format 'text' TEST(T) 0 .MODULE. "" NAME ==== TEST - DESCRIPTION =========== = = == === ===== ======== ============= | [bar \ | foo] = = == === ===== ======== ============= | _many lines_ | _highlighted_ = = == === ===== ======== ============= COPYRIGHT ========= Copyright (c) .COPYRIGHT. |
Added modules/doctools/tests/fmt/text/28.
> > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | TEST - Generated from file '.FILE.' by tcllib/doctools with format 'text' TEST(z) 1.1.23.58132.1 .MODULE. "" NAME ==== TEST - DESCRIPTION =========== COPYRIGHT ========= Copyright (c) 2019 Me Copyright (c) 2019 Myself Copyright (c) 2019 And I |
Added modules/doctools/tests/fmt/tmml/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!-- Generated from file '.FILE.' by tcllib/doctools with format 'tmml' --> <manpage id='.FILE' cat='cmd' title='TEST' version='3.14.15.926' package='.MODULE.'> <head> <info key='copyright' value='Copyright (c) .COPYRIGHT.'/> </head> <namesection> <name>TEST</name> <desc></desc> </namesection> <section id='section1'> <title>DESCRIPTION</title> <example> Example Block More Lines \ Ever More Never </example> <p> ............... Weiter ............. </p> <p> </p> <example> Second \ Continuing Lines \ Done </example> ............... Vorwaerts .......... <example> <cmd>command</cmd> x \ -- <cmd>command</cmd> -- </example> </section> </manpage> |
Added modules/doctools/tests/fmt/tmml/27.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <!-- Generated from file '.FILE.' by tcllib/doctools with format 'tmml' --> <manpage id='.FILE' cat='cmd' title='TEST' version='0' package='.MODULE.'> <head> <info key='copyright' value='Copyright (c) .COPYRIGHT.'/> </head> <namesection> <name>TEST</name> <desc></desc> </namesection> <section id='section1'> <title>DESCRIPTION</title> = = == === ===== ======== ============= <example>[<cmd>bar</cmd> \ foo] </example> = = == === ===== ======== ============= <example> <emph> many lines highlighted </emph> </example> = = == === ===== ======== ============= </section> </manpage> |
Added modules/doctools/tests/fmt/tmml/28.
> > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <!-- Generated from file '.FILE.' by tcllib/doctools with format 'tmml' --> <manpage id='.FILE' cat='cmd' title='TEST' version='1.1.23.58132.1' package='.MODULE.'> <head> <info key='copyright' value='Copyright (c) 2019 Me'/> <info key='copyright' value='Copyright (c) 2019 Myself'/> <info key='copyright' value='Copyright (c) 2019 And I'/> </head> <namesection> <name>TEST</name> <desc></desc> </namesection> <section id='section1'> <title>DESCRIPTION</title> </section> </manpage> |
Added modules/doctools/tests/fmt/wiki/26.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '''TEST 3.14.15.926''' '''.MODULE.''' **DESCRIPTION** ====== Example Block More Lines \ Ever More Never ====== ............... Weiter ............. ====== Second \ Continuing Lines \ Done ====== ............... Vorwaerts .......... ====== '''command''' x \ -- '''command''' -- ====== **COPYRIGHT** Copyright (c) .COPYRIGHT. |
Added modules/doctools/tests/fmt/wiki/27.
> > > > > > > > > > > > > > > > > > > > > > > > > | 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 | '''TEST 0''' '''.MODULE.''' **DESCRIPTION** = = == === ===== ======== ============= ====== ['''bar''' \ foo] ====== = = == === ===== ======== ============= ====== '' many lines highlighted '' ====== = = == === ===== ======== ============= **COPYRIGHT** Copyright (c) .COPYRIGHT. |
Added modules/doctools/tests/fmt/wiki/28.
> > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | '''TEST 1.1.23.58132.1''' '''.MODULE.''' **DESCRIPTION** **COPYRIGHT** Copyright (c) 2019 Me Copyright (c) 2019 Myself Copyright (c) 2019 And I |
Changes to modules/doctools2base/html_cssdefaults.man.
︙ | ︙ | |||
32 33 34 35 36 37 38 | This command returns the text of the default CSS style to use for HTML markup generated by the various HTML export plugins. [list_end] [vset CATEGORY doctools] | | | 32 33 34 35 36 37 38 39 40 | This command returns the text of the default CSS style to use for HTML markup generated by the various HTML export plugins. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2base/nroff_manmacros.man.
︙ | ︙ | |||
32 33 34 35 36 37 38 | This command returns the text of the default CSS style to use for NROFF generated by the various NROFF export plugins. [list_end] [vset CATEGORY doctools] | | | 32 33 34 35 36 37 38 39 40 | This command returns the text of the default CSS style to use for NROFF generated by the various NROFF export plugins. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Deleted modules/doctools2base/paths.tcl.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Changes to modules/doctools2base/pkgIndex.tcl.
1 2 3 4 5 6 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} # Packages for the doctools {idx,toc,doc} v2 implementation # (still v1.1 doc{idx,toc} languages). # Supporting packages | < < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} # Packages for the doctools {idx,toc,doc} v2 implementation # (still v1.1 doc{idx,toc} languages). # Supporting packages # - Handling text generation, the nroff man.macros definitions, # HTML/XML generation, and the default CSS style # - Handling of message catalogs as packages. # - Recursive descent parser for Tcl strings (as expected by 'subst -novariables'). package ifneeded doctools::text 0.1 [list source [file join $dir text.tcl]] package ifneeded doctools::nroff::man_macros 0.1 [list source [file join $dir nroff_manmacros.tcl]] package ifneeded doctools::html 0.1 [list source [file join $dir html.tcl]] package ifneeded doctools::html::cssdefaults 0.1 [list source [file join $dir html_cssdefaults.tcl]] package ifneeded doctools::msgcat 0.1 [list source [file join $dir msgcat.tcl]] package ifneeded doctools::tcl::parse 0.1 [list source [file join $dir tcl_parse.tcl]] |
Changes to modules/doctools2base/tcl_parse.man.
︙ | ︙ | |||
176 177 178 179 180 181 182 | [enum] All leaves of the tree are either Text or Command nodes. Word nodes cannot be leaves. [list_end] [vset CATEGORY doctools] | | | 176 177 178 179 180 181 182 183 184 | [enum] All leaves of the tree are either Text or Command nodes. Word nodes cannot be leaves. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2base/tcllib_msgcat.man.
︙ | ︙ | |||
59 60 61 62 63 64 65 | "doctools::msgcat::[arg prefix]::[var langcode]", with [arg prefix] the argument to the command, and the [var langcode] supplied by the result of [cmd msgcat::mcpreferences]. [list_end] [vset CATEGORY doctools] | | | 59 60 61 62 63 64 65 66 67 | "doctools::msgcat::[arg prefix]::[var langcode]", with [arg prefix] the argument to the command, and the [var langcode] supplied by the result of [cmd msgcat::mcpreferences]. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/container.test.
1 2 3 | # -*- tcl -*- # idx.test: Tests for the doctools::idx package. Index management. # | | < < > > < < | 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 | # -*- tcl -*- # idx.test: Tests for the doctools::idx package. Index management. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2 support { use struct/list.tcl struct::list use snit/snit.tcl snit use fileutil/fileutil.tcl fileutil use fileutil/paths.tcl fileutil::paths use log/logger.tcl logger use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map useLocal export.tcl doctools::idx::export useLocal import.tcl doctools::idx::import use doctools2base/nroff_manmacros.tcl doctools::nroff::man_macros source [tcllibPath doctools2base/tests/common] } testing { |
︙ | ︙ |
Changes to modules/doctools2idx/export.tcl.
1 2 3 4 | # export.tcl -- # # Exporting indices into other formats. # | | < < | | | 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 | # export.tcl -- # # Exporting indices into other formats. # # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object manages a set of plugins for the conversion of keyword # indices into some textual representation. I.e. this object manages # the conversion to specialized serializations of keyword indices. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require struct::map package require doctools::idx::structure package require pluginmgr package require snit # ### ### ### ######### ######### ######### ## API snit::type ::doctools::idx::export { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction. constructor {} { install myconfig using ::struct::map ${selfns}::config return } destructor { $myconfig destroy # Clear the cache of loaded export plugins. foreach k [array names myplugin] { |
︙ | ︙ | |||
117 118 119 120 121 122 123 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 115 116 117 118 119 120 121 122 123 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide doctools::idx::export 0.2.1 return |
Changes to modules/doctools2idx/export.test.
1 2 3 | # -*- tcl -*- # idx.test: tests for the doctools::idx package. # | | < < > < | 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 | # -*- tcl -*- # idx.test: tests for the doctools::idx package. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2 support { use fileutil/fileutil.tcl fileutil ;# tests/common use struct/list.tcl struct::list use snit/snit.tcl snit use log/logger.tcl logger use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map useLocal structure.tcl doctools::idx::structure use doctools2base/nroff_manmacros.tcl doctools::nroff::man_macros source [tcllibPath doctools2base/tests/common] } testing { useLocalKeep export.tcl doctools::idx::export |
︙ | ︙ | |||
73 74 75 76 77 78 79 | test doctools-idx-export-5.0 {config names, wrong#args} -setup { doctools::idx::export E } -body { E config names X } -cleanup { E destroy | | | | | | 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 | test doctools-idx-export-5.0 {config names, wrong#args} -setup { doctools::idx::export E } -body { E config names X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test doctools-idx-export-6.0 {config get, wrong#args} -setup { doctools::idx::export E } -body { E config get X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test doctools-idx-export-7.0 {config set, wrong#args} -setup { doctools::idx::export E } -body { E config set } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test doctools-idx-export-7.1 {config set, wrong#args} -setup { doctools::idx::export E } -body { E config set N V X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} # ------------------------------------------------------------------------- test doctools-idx-export-12.0 {config set, define single var} -setup { doctools::idx::export E } -body { E config set N V |
︙ | ︙ |
Changes to modules/doctools2idx/export_docidx.man.
1 2 3 4 5 | [comment {-*- tcl -*- --- doctools ---}] [vset PACKAGE docidx] [vset NAME docidx] [vset REQUIRE null] [vset CONFIG docidx] | | | 1 2 3 4 5 6 7 | [comment {-*- tcl -*- --- doctools ---}] [vset PACKAGE docidx] [vset NAME docidx] [vset REQUIRE null] [vset CONFIG docidx] [vset VERSION 0.2.1] [include include/export/plugin.inc] |
Changes to modules/doctools2idx/idx_container.man.
︙ | ︙ | |||
288 289 290 291 292 293 294 | In that case an error will be thrown if the container has no export manager attached to it. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 288 289 290 291 292 293 294 295 296 | In that case an error will be thrown if the container has no export manager attached to it. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/idx_export.man.
|
| | | 1 2 3 4 5 6 7 8 | [vset VERSION 0.2.1] [comment {-*- tcl -*- doctools manpage}] [manpage_begin doctools::idx::export n [vset VERSION]] [keywords conversion] [keywords docidx] [keywords documentation] [keywords export] [keywords formatting] |
︙ | ︙ | |||
16 17 18 19 20 21 22 | [keywords nroff] [keywords plugin] [keywords reference] [keywords {tcler's wiki}] [keywords text] [keywords url] [keywords wiki] | | | | 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | [keywords nroff] [keywords plugin] [keywords reference] [keywords {tcler's wiki}] [keywords text] [keywords url] [keywords wiki] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc {Exporting keyword indices}] [category {Documentation tools}] [require doctools::idx::export [opt [vset VERSION]]] [require Tcl 8.4] [require struct::map] [require doctools::idx::structure] [require snit] [require pluginmgr] [description] This package provides a class to manage the plugins for the export of keyword indices to other formats, i.e. their conversion to, for |
︙ | ︙ | |||
301 302 303 304 305 306 307 | the command [cmd export]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 301 302 303 304 305 306 307 308 309 | the command [cmd export]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/idx_import.man.
|
| | | | | 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 | [vset VERSION 0.2.1] [comment {-*- tcl -*- doctools manpage}] [manpage_begin doctools::idx::import n [vset VERSION]] [keywords conversion] [keywords docidx] [keywords documentation] [keywords import] [keywords index] [keywords json] [keywords {keyword index}] [keywords manpage] [keywords markup] [keywords parsing] [keywords plugin] [keywords reference] [keywords url] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc {Importing keyword indices}] [category {Documentation tools}] [require doctools::idx::import [opt [vset VERSION]]] [require Tcl 8.4] [require struct::map] [require doctools::idx::structure] [require snit] [require pluginmgr] [description] This package provides a class to manage the plugins for the import of keyword indices from other formats, i.e. their conversion from, for |
︙ | ︙ | |||
387 388 389 390 391 392 393 | the command [cmd import]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 387 388 389 390 391 392 393 394 395 | the command [cmd import]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/idx_introduction.man.
︙ | ︙ | |||
138 139 140 141 142 143 144 | the [manpage {DocTools - Tables Of Contents}] and the [manpage {DocTools - General}], respectively. [section {Package Overview}] [include include/dependencies.inc] [vset CATEGORY doctools] | | | 138 139 140 141 142 143 144 145 146 | the [manpage {DocTools - Tables Of Contents}] and the [manpage {DocTools - General}], respectively. [section {Package Overview}] [include include/dependencies.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/idx_parse.man.
︙ | ︙ | |||
167 168 169 170 171 172 173 | [list_end] [list_end] [include include/format/docidx.inc] [include include/serialization.inc] [vset CATEGORY doctools] | | | 167 168 169 170 171 172 173 174 175 | [list_end] [list_end] [include include/format/docidx.inc] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/idx_structure.man.
︙ | ︙ | |||
121 122 123 124 125 126 127 | [sectref {Keyword index serialization format}]. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 121 122 123 124 125 126 127 128 129 | [sectref {Keyword index serialization format}]. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/import.tcl.
1 2 3 4 | # import.tcl -- # # Importing indices into other formats. # | | < < | | | | | 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 | # import.tcl -- # # Importing indices into other formats. # # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object manages a set of plugins for the conversion of keyword # indices into some textual representation. I.e. this object manages # the conversion to specialized serializations of keyword indices. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require struct::map package require doctools::idx::structure package require fileutil::paths package require pluginmgr package require snit # ### ### ### ######### ######### ######### ## API snit::type ::doctools::idx::import { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction. constructor {} { install myconfig using ::struct::map ${selfns}::config install myinclude using ::fileutil::paths ${selfns}::include return } destructor { $myconfig destroy $myinclude destroy # Clear the cache of loaded import plugins. |
︙ | ︙ | |||
183 184 185 186 187 188 189 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 181 182 183 184 185 186 187 188 189 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide doctools::idx::import 0.2.1 return |
Changes to modules/doctools2idx/import.test.
1 2 3 4 | # -*- tcl -*- # -- idx_import.test: # -- Tests for package "doctools::idx::import": Management of import plugins. # | | < < > | < < | 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 | # -*- tcl -*- # -- idx_import.test: # -- Tests for package "doctools::idx::import": Management of import plugins. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2 support { use struct/list.tcl struct::list use snit/snit.tcl snit use fileutil/fileutil.tcl fileutil use fileutil/paths.tcl fileutil::paths use log/logger.tcl logger use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map source [tcllibPath doctools2base/tests/common] } testing { useLocalKeep import.tcl doctools::idx::import } |
︙ | ︙ | |||
120 121 122 123 124 125 126 | test doctools-idx-import-5.0 {config names, wrong#args} -setup { doctools::idx::import I } -body { I config names X } -cleanup { I destroy | | | | | > > > | | | | | | | 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 | test doctools-idx-import-5.0 {config names, wrong#args} -setup { doctools::idx::import I } -body { I config names X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test doctools-idx-import-6.0 {config get, wrong#args} -setup { doctools::idx::import I } -body { I config get X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test doctools-idx-import-7.0 {config set, wrong#args} -setup { doctools::idx::import I } -body { I config set } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test doctools-idx-import-7.1 {config set, wrong#args} -setup { doctools::idx::import I } -body { I config set N V X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} # config unset - accepts any number of arguments. # ------------------------------------------------------------------------- ## `include paths` component, provided via fileutil::paths, search path for includes test doctools-idx-import-8.0 {include paths, wrong#args} -setup { doctools::idx::import I } -body { I include paths X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodpaths type selfns win self"} test doctools-idx-import-9.0 {include clear, wrong#args} -setup { doctools::idx::import I } -body { I include clear X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodclear type selfns win self"} test doctools-idx-import-10.0 {include add, wrong#args} -setup { doctools::idx::import I } -body { I include add } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test doctools-idx-import-10.1 {include add, wrong#args} -setup { doctools::idx::import I } -body { I include add P X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test doctools-idx-import-11.0 {include remove, wrong#args} -setup { doctools::idx::import I } -body { I include remove } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test doctools-idx-import-11.1 {include remove, wrong#args} -setup { doctools::idx::import I } -body { I include remove P X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} # ------------------------------------------------------------------------- test doctools-idx-import-12.0 {config set, define single var} -setup { doctools::idx::import I } -body { I config set N V |
︙ | ︙ |
Changes to modules/doctools2idx/include/dependencies.inc.
1 2 3 4 5 6 7 8 9 10 | [comment { ASCII diagram of the dependencies between the doctools v2 idx packages ====================================================================== }][example { ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | [comment { ASCII diagram of the dependencies between the doctools v2 idx packages ====================================================================== }][example { ~~~~~~~~~~~ doctools::idx ~~~~~~~~~~~ ~~ | ~~ doctools::idx::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::idx::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct::map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::idx::export::<*> | | | doctools::idx::import::<*> docidx | | | docidx, json json | | | | \\ html | | | doctools::idx::parse \\ nroff | | | | \\ wiki | | | +---------------+ json |
︙ | ︙ |
Changes to modules/doctools2idx/include/export/plugin.inc.
1 2 | [comment {-*- tcl -*- --- !doctools ---}] [manpage_begin doctools::idx::export::[vset PACKAGE] n [vset VERSION]] | | | 1 2 3 4 5 6 7 8 9 10 | [comment {-*- tcl -*- --- !doctools ---}] [manpage_begin doctools::idx::export::[vset PACKAGE] n [vset VERSION]] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc "[vset NAME] export plugin"] [category {Text formatter plugin}] [require Tcl 8.4] [require doctools::idx::export::[vset PACKAGE] [opt [vset VERSION]]] [include format/[vset REQUIRE].inc] [keywords doctools index serialization export [vset NAME]] |
︙ | ︙ | |||
47 48 49 50 51 52 53 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] | | | 47 48 49 50 51 52 53 54 55 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] [include ../../../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/include/import/plugin.inc.
1 | [comment {-*- tcl -*- --- !doctools ---}] | > | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | [comment {-*- tcl -*- --- !doctools ---}] [vset VERSION 0.2.1] [manpage_begin doctools::idx::import::[vset PACKAGE] n [vset VERSION]] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc "[vset NAME] import plugin"] [category {Text formatter plugin}] [require Tcl 8.5] [require doctools::idx::import::[vset PACKAGE] [opt [vset VERSION]]] [include format/[vset REQUIRE].inc] [keywords doctools index deserialization import [vset NAME]] [description] This package implements the doctools keyword index import plugin for the parsing of [vset NAME] markup. |
︙ | ︙ | |||
47 48 49 50 51 52 53 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] | | | 48 49 50 51 52 53 54 55 56 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] [include ../../../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/include/msgcat.inc.
︙ | ︙ | |||
38 39 40 41 42 43 44 | [section API] This package has no exported API. [vset CATEGORY doctools] | | | 38 39 40 41 42 43 44 45 46 | [section API] This package has no exported API. [vset CATEGORY doctools] [include ../../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2idx/pkgIndex.tcl.
1 2 3 4 5 6 7 8 9 10 11 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} # Packages for the doctools idx v2 implementation # (still v1.1 docidx language). # - Index container, mutable index objects # - Export and import management # - Export and import plugins # - Parser for docidx markup, and handling serializations # - Message catalogs for the parser | | < | < > > > > | 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 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} # Packages for the doctools idx v2 implementation # (still v1.1 docidx language). # - Index container, mutable index objects # - Export and import management # - Export and import plugins # - Parser for docidx markup, and handling serializations # - Message catalogs for the parser package ifneeded doctools::idx 2 [list source [file join $dir container.tcl]] package ifneeded doctools::idx::export 0.2.1 [list source [file join $dir export.tcl]] package ifneeded doctools::idx::export::docidx 0.1 [list source [file join $dir export_docidx.tcl]] package ifneeded doctools::idx::export::html 0.2 [list source [file join $dir export_html.tcl]] package ifneeded doctools::idx::export::json 0.1 [list source [file join $dir export_json.tcl]] package ifneeded doctools::idx::export::nroff 0.3 [list source [file join $dir export_nroff.tcl]] package ifneeded doctools::idx::export::text 0.2 [list source [file join $dir export_text.tcl]] package ifneeded doctools::idx::export::wiki 0.2 [list source [file join $dir export_wiki.tcl]] package ifneeded doctools::idx::import::docidx 0.1 [list source [file join $dir import_docidx.tcl]] package ifneeded doctools::idx::import::json 0.1 [list source [file join $dir import_json.tcl]] package ifneeded doctools::idx::parse 0.1 [list source [file join $dir parse.tcl]] package ifneeded doctools::idx::structure 0.1 [list source [file join $dir structure.tcl]] package ifneeded doctools::msgcat::idx::c 0.1 [list source [file join $dir msgcat_c.tcl]] package ifneeded doctools::msgcat::idx::de 0.1 [list source [file join $dir msgcat_de.tcl]] package ifneeded doctools::msgcat::idx::en 0.1 [list source [file join $dir msgcat_en.tcl]] package ifneeded doctools::msgcat::idx::fr 0.1 [list source [file join $dir msgcat_fr.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} {return} package ifneeded doctools::idx::import 0.2.1 [list source [file join $dir import.tcl]] |
Changes to modules/doctools2toc/container.test.
1 2 3 | # -*- tcl -*- # toc.test: Tests for the doctools::toc package. ToC management. # | | < < > > < < | 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 | # -*- tcl -*- # toc.test: Tests for the doctools::toc package. ToC management. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2 support { useAccel [useTcllibC] struct/tree.tcl struct::tree TestAccelInit struct::tree use struct/list.tcl struct::list use snit/snit.tcl snit use fileutil/fileutil.tcl fileutil use fileutil/paths.tcl fileutil::paths use log/logger.tcl logger use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map useLocal export.tcl doctools::toc::export useLocal import.tcl doctools::toc::import use doctools2base/nroff_manmacros.tcl doctools::nroff::man_macros source [tcllibPath doctools2base/tests/common] } testing { |
︙ | ︙ |
Changes to modules/doctools2toc/export.tcl.
1 2 3 4 | # export.tcl -- # # Exporting indices into other formats. # | | < < | | | 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 | # export.tcl -- # # Exporting indices into other formats. # # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object manages a set of plugins for the conversion of keyword # indices into some textual representation. I.e. this object manages # the conversion to specialized serializations of keyword indices. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require struct::map package require doctools::toc::structure package require pluginmgr package require snit # ### ### ### ######### ######### ######### ## API snit::type ::doctools::toc::export { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction. constructor {} { install myconfig using ::struct::map ${selfns}::config return } destructor { $myconfig destroy # Clear the cache of loaded export plugins. foreach k [array names myplugin] { |
︙ | ︙ | |||
117 118 119 120 121 122 123 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 115 116 117 118 119 120 121 122 123 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide doctools::toc::export 0.2.1 return |
Changes to modules/doctools2toc/export.test.
1 2 3 | # -*- tcl -*- # toc.test: tests for the doctools::toc package. # | | < < > < | 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 | # -*- tcl -*- # toc.test: tests for the doctools::toc package. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2 support { use fileutil/fileutil.tcl fileutil ;# tests/common use struct/list.tcl struct::list use snit/snit.tcl snit use log/logger.tcl logger use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map useLocal structure.tcl doctools::toc::structure use doctools2base/nroff_manmacros.tcl doctools::nroff::man_macros source [tcllibPath doctools2base/tests/common] } testing { useLocalKeep export.tcl doctools::toc::export |
︙ | ︙ | |||
73 74 75 76 77 78 79 | test doctools-toc-export-5.0 {config names, wrong#args} -setup { doctools::toc::export E } -body { E config names X } -cleanup { E destroy | | | | | | 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 | test doctools-toc-export-5.0 {config names, wrong#args} -setup { doctools::toc::export E } -body { E config names X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test doctools-toc-export-6.0 {config get, wrong#args} -setup { doctools::toc::export E } -body { E config get X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test doctools-toc-export-7.0 {config set, wrong#args} -setup { doctools::toc::export E } -body { E config set } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test doctools-toc-export-7.1 {config set, wrong#args} -setup { doctools::toc::export E } -body { E config set N V X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} # ------------------------------------------------------------------------- test doctools-toc-export-12.0 {config set, define single var} -setup { doctools::toc::export E } -body { E config set N V |
︙ | ︙ |
Changes to modules/doctools2toc/export_doctoc.man.
1 2 3 4 5 | [comment {-*- tcl -*- --- doctools ---}] [vset PACKAGE doctoc] [vset NAME doctoc] [vset REQUIRE null] [vset CONFIG doctoc] | | | 1 2 3 4 5 6 7 | [comment {-*- tcl -*- --- doctools ---}] [vset PACKAGE doctoc] [vset NAME doctoc] [vset REQUIRE null] [vset CONFIG doctoc] [vset VERSION 0.2.1] [include include/export/plugin.inc] |
Changes to modules/doctools2toc/import.tcl.
1 2 3 4 | # import.tcl -- # # Importing indices into other formats. # | | < < | | | | | 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 | # import.tcl -- # # Importing indices into other formats. # # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object manages a set of plugins for the conversion of keyword # indices into some textual representation. I.e. this object manages # the conversion to specialized serializations of keyword indices. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require struct::map package require doctools::toc::structure package require fileutil::paths package require pluginmgr package require snit # ### ### ### ######### ######### ######### ## API snit::type ::doctools::toc::import { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction. constructor {} { install myconfig using ::struct::map ${selfns}::config install myinclude using ::fileutil::paths ${selfns}::include return } destructor { $myconfig destroy $myinclude destroy # Clear the cache of loaded import plugins. |
︙ | ︙ | |||
183 184 185 186 187 188 189 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 181 182 183 184 185 186 187 188 189 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide doctools::toc::import 0.2.1 return |
Changes to modules/doctools2toc/import.test.
1 2 3 4 | # -*- tcl -*- # -- toc_import.test: # -- Tests for package "doctools::toc::import": Management of import plugins. # | | < < > | < < | 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 | # -*- tcl -*- # -- toc_import.test: # -- Tests for package "doctools::toc::import": Management of import plugins. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2 support { use struct/list.tcl struct::list use snit/snit.tcl snit use fileutil/fileutil.tcl fileutil use fileutil/paths.tcl fileutil::paths use log/logger.tcl logger use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map source [tcllibPath doctools2base/tests/common] } testing { useLocalKeep import.tcl doctools::toc::import } |
︙ | ︙ | |||
120 121 122 123 124 125 126 | test doctools-toc-import-5.0 {config names, wrong#args} -setup { doctools::toc::import I } -body { I config names X } -cleanup { I destroy | | | | | > > > | | | | | | | 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 | test doctools-toc-import-5.0 {config names, wrong#args} -setup { doctools::toc::import I } -body { I config names X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test doctools-toc-import-6.0 {config get, wrong#args} -setup { doctools::toc::import I } -body { I config get X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test doctools-toc-import-7.0 {config set, wrong#args} -setup { doctools::toc::import I } -body { I config set } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test doctools-toc-import-7.1 {config set, wrong#args} -setup { doctools::toc::import I } -body { I config set N V X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} # config unset - accepts any number of arguments. # ------------------------------------------------------------------------- ## `include paths` component, provided via fileutil::paths, search path for includes test doctools-toc-import-8.0 {include paths, wrong#args} -setup { doctools::toc::import I } -body { I include paths X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodpaths type selfns win self"} test doctools-toc-import-9.0 {include clear, wrong#args} -setup { doctools::toc::import I } -body { I include clear X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodclear type selfns win self"} test doctools-toc-import-10.0 {include add, wrong#args} -setup { doctools::toc::import I } -body { I include add } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test doctools-toc-import-10.1 {include add, wrong#args} -setup { doctools::toc::import I } -body { I include add P X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test doctools-toc-import-11.0 {include remove, wrong#args} -setup { doctools::toc::import I } -body { I include remove } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test doctools-toc-import-11.1 {include remove, wrong#args} -setup { doctools::toc::import I } -body { I include remove P X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} # ------------------------------------------------------------------------- test doctools-toc-import-12.0 {config set, define single var} -setup { doctools::toc::import I } -body { I config set N V |
︙ | ︙ |
Changes to modules/doctools2toc/include/dependencies.inc.
1 2 3 4 5 6 7 8 9 10 | [comment { ASCII diagram of the dependencies between the doctools v2 toc packages ====================================================================== }][example { ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | [comment { ASCII diagram of the dependencies between the doctools v2 toc packages ====================================================================== }][example { ~~~~~~~~~~~ doctools::toc ~~~~~~~~~~~ ~~ | ~~ doctools::toc::export ~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~ doctools::toc::import | | | +---------------+-------------------------+ | +------------------+---------------+-----------------------+---------------+ | | | | | | | | | struct:map = | | | = doctools::include struct::map fileutil::paths | | | | | doctools::toc::export::<*> | | | doctools::toc::import::<*> doctoc | | | doctoc, json json | | | | \\ html | | | doctools::toc::parse \\ nroff | | | | \\ wiki | | | +---------------+ json |
︙ | ︙ |
Changes to modules/doctools2toc/include/export/plugin.inc.
1 2 | [comment {-*- tcl -*- --- !doctools ---}] [manpage_begin doctools::toc::export::[vset PACKAGE] n [vset VERSION]] | | | 1 2 3 4 5 6 7 8 9 10 | [comment {-*- tcl -*- --- !doctools ---}] [manpage_begin doctools::toc::export::[vset PACKAGE] n [vset VERSION]] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc "[vset NAME] export plugin"] [category {Text formatter plugin}] [require Tcl 8.4] [require doctools::toc::export::[vset PACKAGE] [opt [vset VERSION]]] [include format/[vset REQUIRE].inc] [keywords doctools toc {table of contents} serialization export [vset NAME]] |
︙ | ︙ | |||
47 48 49 50 51 52 53 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] | | | 47 48 49 50 51 52 53 54 55 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] [include ../../../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/include/import/plugin.inc.
1 | [comment {-*- tcl -*- --- !doctools ---}] | > | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | [comment {-*- tcl -*- --- !doctools ---}] [vset VERSION 0.2.1] [manpage_begin doctools::toc::import::[vset PACKAGE] n [vset VERSION]] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc "[vset NAME] import plugin"] [category {Text formatter plugin}] [require Tcl 8.5] [require doctools::toc::import::[vset PACKAGE] [opt [vset VERSION]]] [include format/[vset REQUIRE].inc] [keywords doctools toc {table of contents} deserialization import [vset NAME]] [description] This package implements the doctools table of contents import plugin for the parsing of [vset NAME] markup. |
︙ | ︙ | |||
47 48 49 50 51 52 53 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] | | | 48 49 50 51 52 53 54 55 56 | [list_end] [include config/[vset CONFIG].inc] [include ../serialization.inc] [vset CATEGORY doctools] [include ../../../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/include/msgcat.inc.
︙ | ︙ | |||
38 39 40 41 42 43 44 | [section API] This package has no exported API. [vset CATEGORY doctools] | | | 38 39 40 41 42 43 44 45 46 | [section API] This package has no exported API. [vset CATEGORY doctools] [include ../../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/pkgIndex.tcl.
1 2 3 4 5 6 7 8 9 10 11 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} # Packages for the doctools toc v2 implementation # (still v1.1 doctoc language). # - Index container, mutable toc objects # - Export and import management # - Export and import plugins # - Parser for doctoc markup, and handling serializations # - Message catalogs for the parser | | < | < > > > > | 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 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} # Packages for the doctools toc v2 implementation # (still v1.1 doctoc language). # - Index container, mutable toc objects # - Export and import management # - Export and import plugins # - Parser for doctoc markup, and handling serializations # - Message catalogs for the parser package ifneeded doctools::toc 2 [list source [file join $dir container.tcl]] package ifneeded doctools::toc::export 0.2.1 [list source [file join $dir export.tcl]] package ifneeded doctools::toc::export::doctoc 0.1 [list source [file join $dir export_doctoc.tcl]] package ifneeded doctools::toc::export::html 0.1 [list source [file join $dir export_html.tcl]] package ifneeded doctools::toc::export::json 0.1 [list source [file join $dir export_json.tcl]] package ifneeded doctools::toc::export::nroff 0.2 [list source [file join $dir export_nroff.tcl]] package ifneeded doctools::toc::export::text 0.1 [list source [file join $dir export_text.tcl]] package ifneeded doctools::toc::export::wiki 0.1 [list source [file join $dir export_wiki.tcl]] package ifneeded doctools::toc::import::doctoc 0.1 [list source [file join $dir import_doctoc.tcl]] package ifneeded doctools::toc::import::json 0.1 [list source [file join $dir import_json.tcl]] package ifneeded doctools::toc::parse 0.1 [list source [file join $dir parse.tcl]] package ifneeded doctools::toc::structure 0.1 [list source [file join $dir structure.tcl]] package ifneeded doctools::msgcat::toc::c 0.1 [list source [file join $dir msgcat_c.tcl]] package ifneeded doctools::msgcat::toc::de 0.1 [list source [file join $dir msgcat_de.tcl]] package ifneeded doctools::msgcat::toc::en 0.1 [list source [file join $dir msgcat_en.tcl]] package ifneeded doctools::msgcat::toc::fr 0.1 [list source [file join $dir msgcat_fr.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} {return} package ifneeded doctools::toc::import 0.2.1 [list source [file join $dir import.tcl]] |
Changes to modules/doctools2toc/toc_container.man.
︙ | ︙ | |||
362 363 364 365 366 367 368 | In that case an error will be thrown if the container has no export manager attached to it. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 362 363 364 365 366 367 368 369 370 | In that case an error will be thrown if the container has no export manager attached to it. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/toc_export.man.
|
| | | 1 2 3 4 5 6 7 8 | [vset VERSION 0.2.1] [comment {-*- tcl -*- doctools manpage}] [manpage_begin doctools::toc::export n [vset VERSION]] [keywords conversion] [keywords doctoc] [keywords documentation] [keywords export] [keywords formatting] |
︙ | ︙ | |||
16 17 18 19 20 21 22 | [keywords reference] [keywords table] [keywords {table of contents}] [keywords {tcler's wiki}] [keywords text] [keywords url] [keywords wiki] | | | | 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | [keywords reference] [keywords table] [keywords {table of contents}] [keywords {tcler's wiki}] [keywords text] [keywords url] [keywords wiki] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc {Exporting tables of contents}] [category {Documentation tools}] [require doctools::toc::export [opt [vset VERSION]]] [require Tcl 8.4] [require struct::map] [require doctools::toc::structure] [require snit] [require pluginmgr] [description] This package provides a class to manage the plugins for the export of tables of contents to other formats, i.e. their conversion to, for |
︙ | ︙ | |||
299 300 301 302 303 304 305 | the command [cmd export]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 299 300 301 302 303 304 305 306 307 | the command [cmd export]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/toc_import.man.
|
| | | | | 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 | [vset VERSION 0.2.1] [comment {-*- tcl -*- doctools manpage}] [manpage_begin doctools::toc::import n [vset VERSION]] [keywords conversion] [keywords doctoc] [keywords documentation] [keywords import] [keywords json] [keywords manpage] [keywords markup] [keywords parsing] [keywords plugin] [keywords reference] [keywords table] [keywords {table of contents}] [keywords url] [copyright {2009-2019 Andreas Kupries <[email protected]>}] [moddesc {Documentation tools}] [titledesc {Importing keyword indices}] [category {Documentation tools}] [require doctools::toc::import [opt [vset VERSION]]] [require Tcl 8.4] [require struct::map] [require doctools::toc::structure] [require snit] [require pluginmgr] [description] This package provides a class to manage the plugins for the import of tables of contents from other formats, i.e. their conversion from, for |
︙ | ︙ | |||
387 388 389 390 391 392 393 | the command [cmd import]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 387 388 389 390 391 392 393 394 395 | the command [cmd import]. This call has to leave the plugin in a state where another usage cycle can be run without problems. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/toc_introduction.man.
︙ | ︙ | |||
135 136 137 138 139 140 141 | the [manpage {DocTools - Keyword Indices}] and the [manpage {DocTools - General}], respectively. [section {Package Overview}] [include include/dependencies.inc] [vset CATEGORY doctools] | | | 135 136 137 138 139 140 141 142 143 | the [manpage {DocTools - Keyword Indices}] and the [manpage {DocTools - General}], respectively. [section {Package Overview}] [include include/dependencies.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/toc_parse.man.
︙ | ︙ | |||
167 168 169 170 171 172 173 | [list_end] [list_end] [include include/format/doctoc.inc] [include include/serialization.inc] [vset CATEGORY doctools] | | | 167 168 169 170 171 172 173 174 175 | [list_end] [list_end] [include include/format/doctoc.inc] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/doctools2toc/toc_structure.man.
︙ | ︙ | |||
143 144 145 146 147 148 149 | section [sectref {ToC serialization format}]. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] | | | 143 144 145 146 147 148 149 150 151 | section [sectref {ToC serialization format}]. [list_end] [include include/serialization.inc] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/dtplite/pkg_dtplite.man.
︙ | ︙ | |||
441 442 443 444 445 446 447 | They are left in place, i.e. not deleted, to serve as demonstrations of doctoc and docidx markup. [list_end] [vset CATEGORY doctools] | | | 441 442 443 444 445 446 447 448 449 | They are left in place, i.e. not deleted, to serve as demonstrations of doctoc and docidx markup. [list_end] [vset CATEGORY doctools] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/exif/exif.man.
︙ | ︙ | |||
72 73 74 75 76 77 78 | [section ACKNOWLEDGEMENTS] This code is a direct translation of version 1.3 of exif.pl by Chris Breeze. See the source for full headers, references, etc. [vset CATEGORY exif] | | | 72 73 74 75 76 77 78 79 80 | [section ACKNOWLEDGEMENTS] This code is a direct translation of version 1.3 of exif.pl by Chris Breeze. See the source for full headers, references, etc. [vset CATEGORY exif] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fileutil/fileutil.man.
︙ | ︙ | |||
514 515 516 517 518 519 520 | option to prevent the traverser from following symbolic links, like so: [include include/cross-index-trav.inc] [list_end] [vset CATEGORY fileutil] | | | 514 515 516 517 518 519 520 521 522 | option to prevent the traverser from following symbolic links, like so: [include include/cross-index-trav.inc] [list_end] [vset CATEGORY fileutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fileutil/multi.man.
︙ | ︙ | |||
48 49 50 51 52 53 54 | The result of the command is the result generated by the last file command it executed. [list_end] [vset CATEGORY fileutil] | | | 48 49 50 51 52 53 54 55 56 | The result of the command is the result generated by the last file command it executed. [list_end] [vset CATEGORY fileutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fileutil/multiop.man.
︙ | ︙ | |||
394 395 396 397 398 399 400 | into /scratch \\ but not *.html not index \\ the index \\ as pkgIndex.tcl }] [vset CATEGORY fileutil] | | | 394 395 396 397 398 399 400 401 402 | into /scratch \\ but not *.html not index \\ the index \\ as pkgIndex.tcl }] [vset CATEGORY fileutil] [include ../common-text/feedback.inc] [manpage_end] |
Added modules/fileutil/paths.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [comment {-*- text -*- doctools manpage}] [vset VERSION 1] [manpage_begin fileutil::paths n [vset VERSION]] [titledesc {Manage search path pools}] [require Tcl 8.4] [require fileutil::paths [opt [vset VERSION]]] [description] Provides a snit class whose instances manage a pool of (search) paths. [section API] The main command provides construction of search path pools: [list_begin definitions] [call [cmd ::fileutil::paths] [arg poolName]] Creates a new, empty pool of search paths with an associated global Tcl command whose name is [arg poolName]. It may be used to invoke various operations on the pool. It has the following general form: [list_begin definitions] [call [cmd poolName] [method method] [opt [arg "arg arg ..."]]] [method method] and [arg arg]uments determine the exact behavior of the command. [list_end][comment --instance-command--] If [arg poolName] is specified as [const %AUTO%] a unique name will be generated by the package itself. The result of the command is the fully-qualified name of the instance command. [list_end][comment --class-command--] [para] The following commands are possible for pool objects: [list_begin definitions] [call [arg poolName] [method add] [arg path]] Adds the [arg path] to the pool. Nothing is done if the [arg path] is already known to the pool. The result of the command is the empty string. [call [arg poolName] [method clear]] Clears the entire pool. In other words, removes all paths from it. The result of the command is the empty string. [call [arg poolName] [method paths]] Returns the list of all paths known to the pool, in the order they were added. [call [arg poolName] [method remove] [arg path]] Removes the [arg path] from the pool, if it is known to the pool. Unknown paths are ignored without error. The result of the command is the empty string. [list_end] [include ../common-text/feedback.inc] [manpage_end] |
Name change from modules/pt/paths.tcl to modules/fileutil/paths.tcl.
1 2 | # paths.tcl -- # | | | | < < | | | > | | | 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 | # paths.tcl -- # # Manage lists of search paths. # # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object instance manages a list of paths. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require snit # ### ### ### ######### ######### ######### ## API snit::type ::fileutil::paths { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction # Default constructor. # Default destructor. # ### ### ### ######### ######### ######### ## Methods :: Querying and manipulating the list of paths. method paths {} { return $mypaths } method add {path} { set pos [lsearch $mypaths $path] if {$pos >= 0 } return lappend mypaths $path return } method remove {path} { set pos [lsearch $mypaths $path] if {$pos < 0} return set mypaths [lreplace $mypaths $pos $pos] return } method clear {} { set mypaths {} return } |
︙ | ︙ | |||
67 68 69 70 71 72 73 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 66 67 68 69 70 71 72 73 74 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide fileutil::paths 1 return |
Added modules/fileutil/paths.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # paths.test: Testsuite for package fileutil::paths # # Copyright (c) 2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2.0 support { use snit/snit.tcl snit } testing { useLocal paths.tcl fileutil::paths } # --------------------------------------------------------------------- # [] constructor # [] destructor # [] paths # [] add # [] remove # [] clear #---------------------------------------------------------------------- ## Constructor, destructor test fileutil-paths-1.0 {constructor, wrong args, too many} -body { fileutil::paths P X } -returnCodes error -result {Error in constructor: wrong # args: should be "::fileutil::paths::Snit_constructor type selfns win self"} test fileutil-paths-1.1 {instance, bogus method} -setup { fileutil::paths P } -cleanup { P destroy } -body { P bogus } -returnCodes error -result {"::P bogus" is not defined} #---------------------------------------------------------------------- ## paths test fileutil-paths-2.0 {paths, wrong args, too many} -setup { fileutil::paths P } -cleanup { P destroy } -body { P paths X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodpaths type selfns win self"} test fileutil-paths-2.1 {paths, base state, none} -setup { fileutil::paths P } -cleanup { P destroy } -body { P paths } -result {} #---------------------------------------------------------------------- ## add test fileutil-paths-3.0 {add, wrong args, not enough} -setup { fileutil::paths P } -cleanup { P destroy } -body { P add } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test fileutil-paths-3.1 {add, wrong args, too many} -setup { fileutil::paths P } -cleanup { P destroy } -body { P add F X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test fileutil-paths-3.2 {add, state change, result} -setup { fileutil::paths P } -cleanup { P destroy } -body { list [P add F] [P paths] } -result {{} F} #---------------------------------------------------------------------- ## remove test fileutil-paths-4.0 {remove, wrong args, not enough} -setup { fileutil::paths P } -cleanup { P destroy } -body { P remove } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test fileutil-paths-4.1 {remove, wrong args, too many} -setup { fileutil::paths P } -cleanup { P destroy } -body { P remove F X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test fileutil-paths-4.2 {remove, known path, state change, result} -setup { fileutil::paths P P add F } -cleanup { P destroy } -body { list [P remove F] [P paths] } -result {{} {}} test fileutil-paths-4.3 {remove, missing path, no state change, result} -setup { fileutil::paths P P add Z } -cleanup { P destroy } -body { list [P remove F] [P paths] } -result {{} Z} #---------------------------------------------------------------------- ## clear test fileutil-paths-5.0 {clear, wrong args, too many} -setup { fileutil::paths P } -cleanup { P destroy } -body { P clear X } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodclear type selfns win self"} test fileutil-paths-5.1 {clear, return to base state} -setup { fileutil::paths P P add F } -cleanup { P destroy } -body { list [P clear] [P paths] } -result {{} {}} #---------------------------------------------------------------------- testsuiteCleanup return |
Changes to modules/fileutil/pkgIndex.tcl.
1 2 3 4 5 6 7 8 9 10 | if {![package vsatisfies [package provide Tcl] 8.2]} {return} package ifneeded fileutil 1.16 [list source [file join $dir fileutil.tcl]] if {![package vsatisfies [package provide Tcl] 8.3]} {return} package ifneeded fileutil::traverse 0.6 [list source [file join $dir traverse.tcl]] if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded fileutil::multi 0.1 [list source [file join $dir multi.tcl]] package ifneeded fileutil::multi::op 0.5.3 [list source [file join $dir multiop.tcl]] package ifneeded fileutil::decode 0.2.1 [list source [file join $dir decode.tcl]] | > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | if {![package vsatisfies [package provide Tcl] 8.2]} {return} package ifneeded fileutil 1.16 [list source [file join $dir fileutil.tcl]] if {![package vsatisfies [package provide Tcl] 8.3]} {return} package ifneeded fileutil::traverse 0.6 [list source [file join $dir traverse.tcl]] if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded fileutil::multi 0.1 [list source [file join $dir multi.tcl]] package ifneeded fileutil::multi::op 0.5.3 [list source [file join $dir multiop.tcl]] package ifneeded fileutil::decode 0.2.1 [list source [file join $dir decode.tcl]] package ifneeded fileutil::paths 1 [list source [file join $dir paths.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} return if {![package vsatisfies [package provide Tcl] 8.6]} return |
Changes to modules/fileutil/traverse.man.
︙ | ︙ | |||
157 158 159 160 161 162 163 | traverser from following symbolic links, like so: [include include/cross-index-trav.inc] [list_end] [vset CATEGORY fileutil] | | | 157 158 159 160 161 162 163 164 165 | traverser from following symbolic links, like so: [include include/cross-index-trav.inc] [list_end] [vset CATEGORY fileutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ftp/ftp.man.
︙ | ︙ | |||
432 433 434 435 436 437 438 | [para] An update command placed in the procedure [cmd ::ftp::DisplayMsg] may run into persistent errors or infinite loops. The solution to this problem is to use [cmd {update idletasks}] instead of [cmd update]. [vset CATEGORY ftp] | | | 432 433 434 435 436 437 438 439 440 | [para] An update command placed in the procedure [cmd ::ftp::DisplayMsg] may run into persistent errors or infinite loops. The solution to this problem is to use [cmd {update idletasks}] instead of [cmd update]. [vset CATEGORY ftp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ftp/ftp_geturl.man.
︙ | ︙ | |||
49 50 51 52 53 54 55 | The attributes of the link, including the path it refers to. [list_end] [list_end] [vset CATEGORY ftp] | | | 49 50 51 52 53 54 55 56 57 | The attributes of the link, including the path it refers to. [list_end] [list_end] [vset CATEGORY ftp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ftpd/ftpd.man.
︙ | ︙ | |||
271 272 273 274 275 276 277 | Accessible to all callbacks and all filesystem commands (which are a special form of callback) and contains the handle of the socket channel which was active when the callback was invoked. [list_end] [vset CATEGORY ftpd] | | | 271 272 273 274 275 276 277 278 279 | Accessible to all callbacks and all filesystem commands (which are a special form of callback) and contains the handle of the socket channel which was active when the callback was invoked. [list_end] [vset CATEGORY ftpd] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fumagic/cfront.man.
︙ | ︙ | |||
63 64 65 66 67 68 69 | The name of each new procedure is derived from the name of the file/directory used in its creation, with file/directory [file FOO] causing the creation of procedure [const ::fileutil::magic::/FOO::run]. [list_end] [vset CATEGORY {fileutil :: magic}] | | | 63 64 65 66 67 68 69 70 71 | The name of each new procedure is derived from the name of the file/directory used in its creation, with file/directory [file FOO] causing the creation of procedure [const ::fileutil::magic::/FOO::run]. [list_end] [vset CATEGORY {fileutil :: magic}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fumagic/cgen.man.
︙ | ︙ | |||
55 56 57 58 59 60 61 | The generated script makes extensive use of the commands provided by the recognizer runtime package [package fileutil::magic::rt] to perform its duties. [list_end] [vset CATEGORY {fileutil :: magic}] | | | 55 56 57 58 59 60 61 62 63 | The generated script makes extensive use of the commands provided by the recognizer runtime package [package fileutil::magic::rt] to perform its duties. [list_end] [vset CATEGORY {fileutil :: magic}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fumagic/filetypes.man.
︙ | ︙ | |||
54 55 56 57 58 59 60 | This site contains the current sources for the file command, including the magic definitions used by it. The latter were used by us to generate this recognizer. [list_end] [vset CATEGORY {fileutil :: magic}] | | | 54 55 56 57 58 59 60 61 62 | This site contains the current sources for the file command, including the magic definitions used by it. The latter were used by us to generate this recognizer. [list_end] [vset CATEGORY {fileutil :: magic}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/fumagic/rtcore.man.
︙ | ︙ | |||
243 244 245 246 247 248 249 | [def [const ledate]] see above, stored in small/little endian [def [const ldate]] 32-bit integer timestamp, stored in native endianess [def [const beldate]] see above, stored in big endian [def [const leldate]] see above, stored in small/little endian [list_end] [vset CATEGORY {fileutil :: magic}] | | | 243 244 245 246 247 248 249 250 251 | [def [const ledate]] see above, stored in small/little endian [def [const ldate]] 32-bit integer timestamp, stored in native endianess [def [const beldate]] see above, stored in big endian [def [const leldate]] see above, stored in small/little endian [list_end] [vset CATEGORY {fileutil :: magic}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/gpx/gpx.man.
︙ | ︙ | |||
150 151 152 153 154 155 156 | [list_end] [section AUTHOR] Keith Vetter [vset CATEGORY gpx] | | | 150 151 152 153 154 155 156 157 158 | [list_end] [section AUTHOR] Keith Vetter [vset CATEGORY gpx] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_fa/dacceptor.man.
︙ | ︙ | |||
94 95 96 97 98 99 100 | [list_end] [para] [section EXAMPLES] [vset CATEGORY grammar_fa] | | | 94 95 96 97 98 99 100 101 102 | [list_end] [para] [section EXAMPLES] [vset CATEGORY grammar_fa] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_fa/dexec.man.
︙ | ︙ | |||
175 176 177 178 179 180 181 | [list_end] [para] [section EXAMPLES] [vset CATEGORY grammar_fa] | | | 175 176 177 178 179 180 181 182 183 | [list_end] [para] [section EXAMPLES] [vset CATEGORY grammar_fa] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_fa/fa.man.
︙ | ︙ | |||
644 645 646 647 648 649 650 | [para] Transducers are not handled by this package. They will get their own package in the future. [vset CATEGORY grammar_fa] | | | 644 645 646 647 648 649 650 651 652 | [para] Transducers are not handled by this package. They will get their own package in the future. [vset CATEGORY grammar_fa] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_fa/faop.man.
︙ | ︙ | |||
472 473 474 475 476 477 478 | [list_end] [para] [section EXAMPLES] [vset CATEGORY grammar_fa] | | | 472 473 474 475 476 477 478 479 480 | [list_end] [para] [section EXAMPLES] [vset CATEGORY grammar_fa] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/gasm.man.
︙ | ︙ | |||
431 432 433 434 435 436 437 | [para] The command returns the empty string as its result. [list_end] [vset CATEGORY grammar_me] | | | 431 432 433 434 435 436 437 438 439 | [para] The command returns the empty string as its result. [list_end] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_ast.man.
︙ | ︙ | |||
126 127 128 129 130 131 132 | This new attribute is defined for all nodes, and contains the locations from attribute [term range] translated into line number and column index. Lines are counted from 1, columns are counted from 0. [list_end] [vset CATEGORY grammar_me] | | | 126 127 128 129 130 131 132 133 134 | This new attribute is defined for all nodes, and contains the locations from attribute [term range] translated into line number and column index. Lines are counted from 1, columns are counted from 0. [list_end] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_cpu.man.
︙ | ︙ | |||
281 282 283 284 285 286 287 | [call [arg meName] [method destroy]] This method deletes the object and releases all resurces it claimed. [list_end] [vset CATEGORY grammar_me] | | | 281 282 283 284 285 286 287 288 289 | [call [arg meName] [method destroy]] This method deletes the object and releases all resurces it claimed. [list_end] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_cpucore.man.
︙ | ︙ | |||
366 367 368 369 370 371 372 | [para] [term nc], the nonterminal cache is keyed by nonterminal name and location, each value a four-element list containing current location, match status, semantic value, and error status, in this order. [vset CATEGORY grammar_me] | | | 366 367 368 369 370 371 372 373 374 | [para] [term nc], the nonterminal cache is keyed by nonterminal name and location, each value a four-element list containing current location, match status, semantic value, and error status, in this order. [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_intro.man.
︙ | ︙ | |||
86 87 88 89 90 91 92 | Core functionality for state manipulation and stepping used in the bytecode based implementation of ME virtual machines. [list_end] [para] [vset CATEGORY grammar_me] | | | 86 87 88 89 90 91 92 93 94 | Core functionality for state manipulation and stepping used in the bytecode based implementation of ME virtual machines. [list_end] [para] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_tcl.man.
︙ | ︙ | |||
335 336 337 338 339 340 341 | The command takes the marker as argument as it comes from the Tcl stack, not the machine state. It replaces [term ias_mpop]. [list_end] [para] [vset CATEGORY grammar_me] | | | 335 336 337 338 339 340 341 342 343 | The command takes the marker as argument as it comes from the Tcl stack, not the machine state. It replaces [term ias_mpop]. [list_end] [para] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_util.man.
︙ | ︙ | |||
75 76 77 78 79 80 81 | If a [arg root] node is specified the AST is generated from that node downward. Otherwise the root of the tree object is used as the starting point. [list_end] [vset CATEGORY grammar_me] | | | 75 76 77 78 79 80 81 82 83 | If a [arg root] node is specified the AST is generated from that node downward. Otherwise the root of the tree object is used as the starting point. [list_end] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_me/me_vm.man.
︙ | ︙ | |||
655 656 657 658 659 660 661 | This instruction pops an entry from the AST Marker stack [term MS] and discards it. [list_end] [vset CATEGORY grammar_me] | | | 655 656 657 658 659 660 661 662 663 | This instruction pops an entry from the AST Marker stack [term MS] and discards it. [list_end] [vset CATEGORY grammar_me] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_peg/peg.man.
︙ | ︙ | |||
713 714 715 716 717 718 719 | [enum] [uri {http://scifac.ru.ac.za/compilers/} \ {Compilers and Compiler Generators}], an online book using CoCo/R, a generator for recursive descent parsers. [list_end] [vset CATEGORY grammar_peg] | | | 713 714 715 716 717 718 719 720 721 | [enum] [uri {http://scifac.ru.ac.za/compilers/} \ {Compilers and Compiler Generators}], an online book using CoCo/R, a generator for recursive descent parsers. [list_end] [vset CATEGORY grammar_peg] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/grammar_peg/peg_interp.man.
︙ | ︙ | |||
114 115 116 117 118 119 120 | described in section [sectref-external {AST VALUES}] of document [term grammar::me_ast]. [list_end] [para] [vset CATEGORY grammar_peg] | | | 114 115 116 117 118 119 120 121 122 | described in section [sectref-external {AST VALUES}] of document [term grammar::me_ast]. [list_end] [para] [vset CATEGORY grammar_peg] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/hook/hook.man.
︙ | ︙ | |||
367 368 369 370 371 372 373 | All bindings involving [widget .view] are deleted. [section Credits] Hook has been designed and implemented by William H. Duquette. [vset CATEGORY hook] | | | 367 368 369 370 371 372 373 374 375 | All bindings involving [widget .view] are deleted. [section Credits] Hook has been designed and implemented by William H. Duquette. [vset CATEGORY hook] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/html/html.man.
︙ | ︙ | |||
468 469 470 471 472 473 474 | [enum] XHTML11 [enum] XHTMLB [list_end] [list_end] [vset CATEGORY html] | | | 468 469 470 471 472 473 474 475 476 | [enum] XHTML11 [enum] XHTMLB [list_end] [list_end] [vset CATEGORY html] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/htmlparse/htmlparse.man.
︙ | ︙ | |||
258 259 260 261 262 263 264 | [cmd ::htmlparse::2tree]. It removes all nodes representing forms and form elements. Its only argument is the name of the tree to cut down. [list_end] [vset CATEGORY htmlparse] | | | 258 259 260 261 262 263 264 265 266 | [cmd ::htmlparse::2tree]. It removes all nodes representing forms and form elements. Its only argument is the name of the tree to cut down. [list_end] [vset CATEGORY htmlparse] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/http/autoproxy.man.
︙ | ︙ | |||
208 209 210 211 212 213 214 | At this time only Basic authentication (1) (2) is supported. It is planned to add support for Digest (2) and NTLM in the future. [section AUTHORS] Pat Thoyts [vset CATEGORY {http :: autoproxy}] | | | 208 209 210 211 212 213 214 215 216 | At this time only Basic authentication (1) (2) is supported. It is planned to add support for Digest (2) and NTLM in the future. [section AUTHORS] Pat Thoyts [vset CATEGORY {http :: autoproxy}] [include ../common-text/feedback.inc] [manpage_end] |
Added modules/httpd/assets/test_cgi.tcl.
> > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | #!/usr/bin/tclsh puts stdout "Status: 200 OK" if {$::env(CONTENT_LENGTH) > 0} { puts stdout "Content-Type: $::env(CONTENT_TYPE)" set dat [read stdin $::env(CONTENT_LENGTH)] } else { puts stdout "Content-Type: text/plain" set dat "Hi!" } puts stdout "Content-Length: [string length $dat]" puts stdout {} puts stdout $dat exit 0 |
Changes to modules/httpd/build/cgi.tcl.
︙ | ︙ | |||
90 91 92 93 94 95 96 97 98 99 100 101 102 103 | ### # Send any POST/PUT/etc content ### my ChannelCopy $chana $chanb -size $length } else { chan flush $chanb } chan event $chanb readable [info coroutine] yield } method ProxyReply {chana chanb args} { my log ProxyReply [list args $args] | > | 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | ### # Send any POST/PUT/etc content ### my ChannelCopy $chana $chanb -size $length } else { chan flush $chanb } my clay refcount_incr chan event $chanb readable [info coroutine] yield } method ProxyReply {chana chanb args} { my log ProxyReply [list args $args] |
︙ | ︙ | |||
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | chan puts $chanb $replybuffer ### # Output the body. With no -size flag, channel will copy until EOF ### chan configure $chana -translation binary -blocking 0 -buffering full -buffersize 4096 chan configure $chanb -translation binary -blocking 0 -buffering full -buffersize 4096 my ChannelCopy $chana $chanb -chunk 4096 } ### # For most CGI applications a directory list is vorboten ### method DirectoryListing {local_file} { my error 403 {Not Allowed} tailcall my DoOutput } } | > | 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | chan puts $chanb $replybuffer ### # Output the body. With no -size flag, channel will copy until EOF ### chan configure $chana -translation binary -blocking 0 -buffering full -buffersize 4096 chan configure $chanb -translation binary -blocking 0 -buffering full -buffersize 4096 my ChannelCopy $chana $chanb -chunk 4096 my clay refcount_decr } ### # For most CGI applications a directory list is vorboten ### method DirectoryListing {local_file} { my error 403 {Not Allowed} tailcall my DoOutput } } |
Changes to modules/httpd/build/core.tcl.
︙ | ︙ | |||
30 31 32 33 34 35 36 | ### # A metaclass for MIME handling behavior across a live socket ### clay::define ::httpd::mime { method ChannelCopy {in out args} { | > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > | 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 | ### # A metaclass for MIME handling behavior across a live socket ### clay::define ::httpd::mime { method ChannelCopy {in out args} { try { my clay refcount_incr set chunk 4096 set size -1 foreach {f v} $args { set [string trim $f -] $v } dict set info coroutine [info coroutine] if {$size>0 && $chunk>$size} { set chunk $size } set bytes 0 set sofar 0 set method [self method] while 1 { set command {} set error {} if {$size>=0} { incr sofar $bytes set remaining [expr {$size-$sofar}] if {$remaining <= 0} { break } elseif {$chunk > $remaining} { set chunk $remaining } } lassign [yieldto chan copy $in $out -size $chunk \ -command [list [info coroutine] $method]] \ command bytes error if {$command ne $method} { error "Subroutine $method interrupted" } if {[string length $error]} { error $error } if {[chan eof $in]} { break } } } finally { my clay refcount_decr } } ### # Returns a block of HTML method html_header {{title {}} args} { set result {} |
︙ | ︙ | |||
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | } } return $pathlist } method wait {mode sock} { if {[info coroutine] eq {}} { chan event $sock $mode [list set ::httpd::lock_$sock $mode] vwait ::httpd::lock_$sock } else { chan event $sock $mode [info coroutine] yield } chan event $sock $mode {} } } | > > | 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | } } return $pathlist } method wait {mode sock} { my clay refcount_incr if {[info coroutine] eq {}} { chan event $sock $mode [list set ::httpd::lock_$sock $mode] vwait ::httpd::lock_$sock } else { chan event $sock $mode [info coroutine] yield } chan event $sock $mode {} my clay refcount_decr } } |
Changes to modules/httpd/build/dispatch.tcl.
︙ | ︙ | |||
25 26 27 28 29 30 31 | } } ::clay::define ::httpd::content.cache { method Dispatch {} { my variable chan | < | | | < < < < < | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | } } ::clay::define ::httpd::content.cache { method Dispatch {} { my variable chan my wait writable $chan chan configure $chan -translation {binary binary} chan puts -nonewline $chan [my clay get cache/ data] } } ::clay::define ::httpd::content.template { method content {} { if {[my request get HTTP_STATUS] ne {}} { |
︙ | ︙ |
Changes to modules/httpd/build/file.tcl.
︙ | ︙ | |||
127 128 129 130 131 132 133 | tailcall my DoOutput } if {$chan eq {}} return my wait writable $chan if {![info exists reply_file]} { tailcall my DoOutput } | < | | | | | | | | | | > | | | | | | < < < | 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 | tailcall my DoOutput } if {$chan eq {}} return my wait writable $chan if {![info exists reply_file]} { tailcall my DoOutput } chan configure $chan -translation {binary binary} my log HttpAccess {} ### # Return a stream of data from a file ### set size [file size $reply_file] my reply set Content-Length $size append result [my reply output] \n chan puts -nonewline $chan $result set reply_chan [open $reply_file r] my ChannelRegister $reply_chan my log SendReply [list length $size] ### # Output the file contents. With no -size flag, channel will copy until EOF ### chan configure $reply_chan -translation {binary binary} -buffersize 4096 -buffering full -blocking 0 my ChannelCopy $reply_chan $chan -chunk 4096 } } |
Changes to modules/httpd/build/footer.txt.
1 2 3 4 | [section AUTHORS] Sean Woods [vset CATEGORY network] | | | 1 2 3 4 5 | [section AUTHORS] Sean Woods [vset CATEGORY network] [include ../common-text/feedback.inc] |
Changes to modules/httpd/build/plugin.tcl.
︙ | ︙ | |||
199 200 201 202 203 204 205 | } $pageobj clay mixinmap {*}$mixinmap if {[dict exists $reply delegate]} { $pageobj clay delegate {*}[dict get $reply delegate] } $pageobj dispatch $sock $reply set output [$pageobj output] | | | 199 200 201 202 203 204 205 206 207 208 209 210 | } $pageobj clay mixinmap {*}$mixinmap if {[dict exists $reply delegate]} { $pageobj clay delegate {*}[dict get $reply delegate] } $pageobj dispatch $sock $reply set output [$pageobj output] $pageobj clay refcount_decr return $output } } |
Changes to modules/httpd/build/proxy.tcl.
︙ | ︙ | |||
155 156 157 158 159 160 161 | if {$sock eq {}} { my error 404 {Not Found} tailcall my DoOutput } my log HttpAccess {} chan event $sock writable [info coroutine] yield | | | | < < < | 155 156 157 158 159 160 161 162 163 164 165 166 | if {$sock eq {}} { my error 404 {Not Found} tailcall my DoOutput } my log HttpAccess {} chan event $sock writable [info coroutine] yield my ChannelRegister $sock my ProxyRequest $chan $sock my ProxyReply $sock $chan } } |
Changes to modules/httpd/build/reply.man.
︙ | ︙ | |||
129 130 131 132 133 134 135 136 137 138 139 140 141 142 | Terminate the transaction, and close the socket. [call method [cmd HttpHeaders] [arg sock] [arg ?debug?]] Stream MIME headers from the socket [arg sock], stopping at an empty line. Returns the stream as a block of text. [call method [cmd dispatch] [arg newsock] [arg datastate]] Take over control of the socket [arg newsock], and store that as the [arg chan] variable for the object. This method runs through all of the steps of reading HTTP headers, generating content, and closing the connection. (See class writetup). | > > > > > | 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | Terminate the transaction, and close the socket. [call method [cmd HttpHeaders] [arg sock] [arg ?debug?]] Stream MIME headers from the socket [arg sock], stopping at an empty line. Returns the stream as a block of text. [call method [cmd ChannelRegister] [arg chan]] Registers a channel that will need to be flushed and closed when the object's destructor invokes the close method. [call method [cmd dispatch] [arg newsock] [arg datastate]] Take over control of the socket [arg newsock], and store that as the [arg chan] variable for the object. This method runs through all of the steps of reading HTTP headers, generating content, and closing the connection. (See class writetup). |
︙ | ︙ | |||
264 265 266 267 268 269 270 | a timeout error to the request if it has, as well as destroy the object and close the [arg chan] socket. [call method [cmd timestamp]] Return the current system time in the format: [example {%a, %d %b %Y %T %Z}] | < < < < < < < < < < < < < < < < < < < < < < | 269 270 271 272 273 274 275 276 277 278 279 280 | a timeout error to the request if it has, as well as destroy the object and close the [arg chan] socket. [call method [cmd timestamp]] Return the current system time in the format: [example {%a, %d %b %Y %T %Z}] [call method [cmd Url_Decode] [arg string]] De-httpizes a string. [list_end] |
Changes to modules/httpd/build/reply.tcl.
︙ | ︙ | |||
95 96 97 98 99 100 101 102 103 104 105 106 107 108 | # } # } # # }] ### ::clay::define ::httpd::reply { superclass ::httpd::mime Delegate <server> { description {The server object which spawned this reply} } ### # A dictionary which will converted into the MIME headers of the reply | > | 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | # } # } # # }] ### ::clay::define ::httpd::reply { superclass ::httpd::mime Variable ChannelRegister {} Delegate <server> { description {The server object which spawned this reply} } ### # A dictionary which will converted into the MIME headers of the reply |
︙ | ︙ | |||
121 122 123 124 125 126 127 | REMOTE_ADDR {} REMOTE_HOST {} USER_AGENT {} SESSION {} } constructor {ServerObj args} { | | > > > > > > > > > > > > > | | > > > | | | | < > | 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 | REMOTE_ADDR {} REMOTE_HOST {} USER_AGENT {} SESSION {} } constructor {ServerObj args} { my variable dispatched_time uuid set uuid [namespace tail [self]] set dispatched_time [clock milliseconds] my clay delegate <server> $ServerObj foreach {field value} [::clay::args_to_options {*}$args] { my clay set config $field: $value } } ### # clean up on exit ### destructor { my close } # Registers a channel to be closed by the close method method ChannelRegister args { my variable ChannelRegister if {![info exists ChannelRegister]} { set ChannelRegister {} } foreach c $args { if {$c ni $ChannelRegister} { lappend ChannelRegister $c } } } ### # Close channels opened by this object ### method close {} { my variable ChannelRegister if {![info exists ChannelRegister]} { return } foreach c $ChannelRegister { catch {chan event $c readable {}} catch {chan event $c writable {}} catch {chan flush $c} catch {chan close $c} } set ChannelRegister {} } ### # Record a dispatch event ### method Log_Dispatched {} { my log Dispatched [dict create \ |
︙ | ︙ | |||
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | # ensemble # [para] # All other fields are passed along to the [method clay] structure of the object. ### method dispatch {newsock datastate} { my variable chan request try { set chan $newsock chan event $chan readable {} chan configure $chan -translation {auto crlf} -buffering line if {[dict exists $datastate mixin]} { set mixinmap [dict get $datastate mixin] } else { set mixinmap {} } | > > | 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | # ensemble # [para] # All other fields are passed along to the [method clay] structure of the object. ### method dispatch {newsock datastate} { my variable chan request try { my clay refcount_incr set chan $newsock my ChannelRegister $chan chan event $chan readable {} chan configure $chan -translation {auto crlf} -buffering line if {[dict exists $datastate mixin]} { set mixinmap [dict get $datastate mixin] } else { set mixinmap {} } |
︙ | ︙ | |||
219 220 221 222 223 224 225 226 227 228 229 230 231 232 | } my Session_Load my Log_Dispatched my Dispatch } on error {err errdat} { my error 500 $err [dict get $errdat -errorinfo] my DoOutput } } method Dispatch {} { # Invoke the URL implementation. my content my DoOutput | > > > | 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | } my Session_Load my Log_Dispatched my Dispatch } on error {err errdat} { my error 500 $err [dict get $errdat -errorinfo] my DoOutput } finally { my close my clay refcount_decr } } method Dispatch {} { # Invoke the URL implementation. my content my DoOutput |
︙ | ︙ | |||
334 335 336 337 338 339 340 | append result $reply_body } else { append result [my reply output] } chan puts -nonewline $chan $result my log HttpAccess {} } | < | 356 357 358 359 360 361 362 363 364 365 366 367 368 369 | append result $reply_body } else { append result [my reply output] } chan puts -nonewline $chan $result my log HttpAccess {} } } ### # For GET requests, converts the QUERY_DATA header into a key/value list. # # For POST requests, reads the Post data and converts that information to # a key/value list for application/x-www-form-urlencoded posts. For multipart |
︙ | ︙ | |||
419 420 421 422 423 424 425 | } return $postdata } # Manage session data method Session_Load {} {} | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | } return $postdata } # Manage session data method Session_Load {} {} # Appends the value of [arg string] to the end of [arg reply_body], as well as a trailing newline # character. method puts line { my variable reply_body append reply_body $line \n } |
︙ | ︙ |
Changes to modules/httpd/build/scgi.tcl.
︙ | ︙ | |||
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | my counter url_hit try { # Read the SCGI request on byte at a time until we reach a ":" dict set query http HTTP_HOST {} dict set query http CONTENT_LENGTH 0 dict set query http REQUEST_URI / dict set query http REMOTE_ADDR $ip set size {} while 1 { set char [::coroutine::util::read $sock 1] if {[chan eof $sock]} { catch {close $sock} return } if {$char eq ":"} break append size $char } # With length in hand, read the netstring encoded headers set inbuffer [::coroutine::util::read $sock [expr {$size+1}]] | > | | 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 | my counter url_hit try { # Read the SCGI request on byte at a time until we reach a ":" dict set query http HTTP_HOST {} dict set query http CONTENT_LENGTH 0 dict set query http REQUEST_URI / dict set query http REMOTE_ADDR $ip dict set query http DOCUMENT_ROOT [my clay get server/ doc_root] set size {} while 1 { set char [::coroutine::util::read $sock 1] if {[chan eof $sock]} { catch {close $sock} return } if {$char eq ":"} break append size $char } # With length in hand, read the netstring encoded headers set inbuffer [::coroutine::util::read $sock [expr {$size+1}]] chan configure $sock -translation {auto crlf} -blocking 0 -buffersize 4096 -buffering full foreach {f v} [lrange [split [string range $inbuffer 0 end-1] \0] 0 end-1] { dict set query http $f $v } if {![dict exists $query http REQUEST_PATH]} { set uri [dict get $query http REQUEST_URI] set uriinfo [::uri::split $uri] dict set query http REQUEST_PATH [dict get $uriinfo path] |
︙ | ︙ | |||
161 162 163 164 165 166 167 | try { set pageobj [::httpd::reply create ::httpd::object::$uuid [self]] dict set reply mixin protocol ::httpd::protocol.scgi $pageobj dispatch $sock $reply } on error {err errdat} { my debug [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] my log BadRequest $uuid [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] | | | 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | try { set pageobj [::httpd::reply create ::httpd::object::$uuid [self]] dict set reply mixin protocol ::httpd::protocol.scgi $pageobj dispatch $sock $reply } on error {err errdat} { my debug [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] my log BadRequest $uuid [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] $pageobj clay refcount_decr catch {chan event readable $sock {}} catch {chan event writeable $sock {}} catch {chan close $sock} return } } } |
Changes to modules/httpd/build/server.tcl.
︙ | ︙ | |||
110 111 112 113 114 115 116 117 118 119 120 121 122 123 | # normal cases, an object of class [cmd ::http::reply] is created, and that class's # [cmd dispatch] method. # This action passes control of the socket to # the reply object. The reply object manages the rest of the transaction, including # closing the socket. ### method Connect {uuid sock ip} { yield [info coroutine] chan event $sock readable {} chan configure $sock \ -blocking 0 \ -translation {auto crlf} \ -buffering line my counter url_hit | > | 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | # normal cases, an object of class [cmd ::http::reply] is created, and that class's # [cmd dispatch] method. # This action passes control of the socket to # the reply object. The reply object manages the rest of the transaction, including # closing the socket. ### method Connect {uuid sock ip} { ::clay::cleanup yield [info coroutine] chan event $sock readable {} chan configure $sock \ -blocking 0 \ -translation {auto crlf} \ -buffering line my counter url_hit |
︙ | ︙ | |||
158 159 160 161 162 163 164 | # Check open connections for a time out event. ### method CheckTimeout {} { foreach obj [info commands ::httpd::object::*] { try { $obj timeOutCheck } on error {} { | | > | 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | # Check open connections for a time out event. ### method CheckTimeout {} { foreach obj [info commands ::httpd::object::*] { try { $obj timeOutCheck } on error {} { $obj clay refcount_decr } } ::clay::cleanup } method debug args {} ### # Given a key/value list of information, return a data structure describing how # the server should reply. |
︙ | ︙ |
Changes to modules/httpd/httpd.man.
︙ | ︙ | |||
226 227 228 229 230 231 232 | } }] [para] | | | < < < < > > > > > > > > > > > | 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 | } }] [para] [class {Variable}] [list_begin definitions] [call variable [cmd ChannelRegister]] [call variable [cmd reply]] A dictionary which will converted into the MIME headers of the reply [call variable [cmd request]] A dictionary containing the SCGI transformed HTTP headers for the request [list_end] [para] [class {Delegate}] [list_begin definitions] [call delegate [cmd <server>]]The server object which spawned this reply [list_end] [para] [class {Methods}] [list_begin definitions] [call method [cmd "constructor"] [arg ServerObj] [opt "[arg args]"]] [call method [cmd "destructor"] [opt "[arg dictargs]"]] clean up on exit [call method [cmd "ChannelRegister"] [opt "[arg args]"]] Registers a channel to be closed by the close method [call method [cmd "close"]] Close channels opened by this object |
︙ | ︙ | |||
356 357 358 359 360 361 362 | POST or PUSH. Returns an empty string otherwise. [call method [cmd "Session_Load"]] Manage session data | < < < < < < < < < < < < < < < < < < < < < < < | 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | POST or PUSH. Returns an empty string otherwise. [call method [cmd "Session_Load"]] Manage session data [call method [cmd "puts"] [arg line]] Appends the value of [arg string] to the end of [arg reply_body], as well as a trailing newline character. |
︙ | ︙ | |||
932 933 934 935 936 937 938 | [list_end] [para] [section AUTHORS] Sean Woods [vset CATEGORY network] | | | 916 917 918 919 920 921 922 923 924 925 926 | [list_end] [para] [section AUTHORS] Sean Woods [vset CATEGORY network] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/httpd/httpd.tcl.
︙ | ︙ | |||
26 27 28 29 30 31 32 | } namespace eval ::httpd { } namespace eval ::scgi { } clay::define ::httpd::mime { method ChannelCopy {in out args} { | > > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > | 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 | } namespace eval ::httpd { } namespace eval ::scgi { } clay::define ::httpd::mime { method ChannelCopy {in out args} { try { my clay refcount_incr set chunk 4096 set size -1 foreach {f v} $args { set [string trim $f -] $v } dict set info coroutine [info coroutine] if {$size>0 && $chunk>$size} { set chunk $size } set bytes 0 set sofar 0 set method [self method] while 1 { set command {} set error {} if {$size>=0} { incr sofar $bytes set remaining [expr {$size-$sofar}] if {$remaining <= 0} { break } elseif {$chunk > $remaining} { set chunk $remaining } } lassign [yieldto chan copy $in $out -size $chunk \ -command [list [info coroutine] $method]] \ command bytes error if {$command ne $method} { error "Subroutine $method interrupted" } if {[string length $error]} { error $error } if {[chan eof $in]} { break } } } finally { my clay refcount_decr } } method html_header {{title {}} args} { set result {} append result "<!DOCTYPE html>\n<HTML><HEAD>" if {$title ne {}} { append result "<TITLE>$title</TITLE>" |
︙ | ︙ | |||
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 | lappend pathlist $part } } } return $pathlist } method wait {mode sock} { if {[info coroutine] eq {}} { chan event $sock $mode [list set ::httpd::lock_$sock $mode] vwait ::httpd::lock_$sock } else { chan event $sock $mode [info coroutine] yield } chan event $sock $mode {} } } ### # END: core.tcl ### ### # START: reply.tcl ### ::clay::define ::httpd::reply { superclass ::httpd::mime Delegate <server> { description {The server object which spawned this reply} } Dict reply {} Dict request { CONTENT_LENGTH 0 COOKIE {} HTTP_HOST {} REFERER {} REQUEST_URI {} REMOTE_ADDR {} REMOTE_HOST {} USER_AGENT {} SESSION {} } constructor {ServerObj args} { | > > > | > > > > > > > > > > > | | > > > | | | | < > > > | 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 | lappend pathlist $part } } } return $pathlist } method wait {mode sock} { my clay refcount_incr if {[info coroutine] eq {}} { chan event $sock $mode [list set ::httpd::lock_$sock $mode] vwait ::httpd::lock_$sock } else { chan event $sock $mode [info coroutine] yield } chan event $sock $mode {} my clay refcount_decr } } ### # END: core.tcl ### ### # START: reply.tcl ### ::clay::define ::httpd::reply { superclass ::httpd::mime Variable ChannelRegister {} Delegate <server> { description {The server object which spawned this reply} } Dict reply {} Dict request { CONTENT_LENGTH 0 COOKIE {} HTTP_HOST {} REFERER {} REQUEST_URI {} REMOTE_ADDR {} REMOTE_HOST {} USER_AGENT {} SESSION {} } constructor {ServerObj args} { my variable dispatched_time uuid set uuid [namespace tail [self]] set dispatched_time [clock milliseconds] my clay delegate <server> $ServerObj foreach {field value} [::clay::args_to_options {*}$args] { my clay set config $field: $value } } destructor { my close } method ChannelRegister args { my variable ChannelRegister if {![info exists ChannelRegister]} { set ChannelRegister {} } foreach c $args { if {$c ni $ChannelRegister} { lappend ChannelRegister $c } } } method close {} { my variable ChannelRegister if {![info exists ChannelRegister]} { return } foreach c $ChannelRegister { catch {chan event $c readable {}} catch {chan event $c writable {}} catch {chan flush $c} catch {chan close $c} } set ChannelRegister {} } method Log_Dispatched {} { my log Dispatched [dict create \ REMOTE_ADDR [my request get REMOTE_ADDR] \ REMOTE_HOST [my request get REMOTE_HOST] \ COOKIE [my request get HTTP_COOKIE] \ REFERER [my request get HTTP_REFERER] \ USER_AGENT [my request get HTTP_USER_AGENT] \ REQUEST_URI [my request get REQUEST_URI] \ HTTP_HOST [my request get HTTP_HOST] \ SESSION [my request get SESSION] \ ] } method dispatch {newsock datastate} { my variable chan request try { my clay refcount_incr set chan $newsock my ChannelRegister $chan chan event $chan readable {} chan configure $chan -translation {auto crlf} -buffering line if {[dict exists $datastate mixin]} { set mixinmap [dict get $datastate mixin] } else { set mixinmap {} } |
︙ | ︙ | |||
381 382 383 384 385 386 387 388 389 390 391 392 393 394 | } my Session_Load my Log_Dispatched my Dispatch } on error {err errdat} { my error 500 $err [dict get $errdat -errorinfo] my DoOutput } } method Dispatch {} { # Invoke the URL implementation. my content my DoOutput } | > > > | 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | } my Session_Load my Log_Dispatched my Dispatch } on error {err errdat} { my error 500 $err [dict get $errdat -errorinfo] my DoOutput } finally { my close my clay refcount_decr } } method Dispatch {} { # Invoke the URL implementation. my content my DoOutput } |
︙ | ︙ | |||
473 474 475 476 477 478 479 | append result $reply_body } else { append result [my reply output] } chan puts -nonewline $chan $result my log HttpAccess {} } | < | 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | append result $reply_body } else { append result [my reply output] } chan puts -nonewline $chan $result my log HttpAccess {} } } method FormData {} { my variable chan formdata # Run this only once if {[info exists formdata]} { return $formdata } |
︙ | ︙ | |||
542 543 544 545 546 547 548 | my variable chan chan configure $chan -translation binary -blocking 0 -buffering full -buffersize 4096 set postdata [::coroutine::util::read $chan $length] } return $postdata } method Session_Load {} {} | < < < < < < < < < < < | 568 569 570 571 572 573 574 575 576 577 578 579 580 581 | my variable chan chan configure $chan -translation binary -blocking 0 -buffering full -buffersize 4096 set postdata [::coroutine::util::read $chan $length] } return $postdata } method Session_Load {} {} method puts line { my variable reply_body append reply_body $line \n } method RequestFind {field} { my variable request if {[dict exists $request $field]} { |
︙ | ︙ | |||
782 783 784 785 786 787 788 789 790 791 792 793 794 795 | dict set result SERVER_SOFTWARE [my clay get server/ string] if {[string match 127.* $ip]} { dict set result LOCALHOST [expr {[lindex [split [dict getnull $result HTTP_HOST] :] 0] eq "localhost"}] } return $result } method Connect {uuid sock ip} { yield [info coroutine] chan event $sock readable {} chan configure $sock \ -blocking 0 \ -translation {auto crlf} \ -buffering line my counter url_hit | > | 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 | dict set result SERVER_SOFTWARE [my clay get server/ string] if {[string match 127.* $ip]} { dict set result LOCALHOST [expr {[lindex [split [dict getnull $result HTTP_HOST] :] 0] eq "localhost"}] } return $result } method Connect {uuid sock ip} { ::clay::cleanup yield [info coroutine] chan event $sock readable {} chan configure $sock \ -blocking 0 \ -translation {auto crlf} \ -buffering line my counter url_hit |
︙ | ︙ | |||
824 825 826 827 828 829 830 | incr counters($which) } method CheckTimeout {} { foreach obj [info commands ::httpd::object::*] { try { $obj timeOutCheck } on error {} { | | > | 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 | incr counters($which) } method CheckTimeout {} { foreach obj [info commands ::httpd::object::*] { try { $obj timeOutCheck } on error {} { $obj clay refcount_decr } } ::clay::cleanup } method debug args {} method dispatch {data} { set reply [my Dispatch_Local $data] if {[dict size $reply]} { return $reply } |
︙ | ︙ | |||
1088 1089 1090 1091 1092 1093 1094 | set HTTP_STATUS [my reply get Status] my puts [subst $msg] } } ::clay::define ::httpd::content.cache { method Dispatch {} { my variable chan | < | | | < < < < < | 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 | set HTTP_STATUS [my reply get Status] my puts [subst $msg] } } ::clay::define ::httpd::content.cache { method Dispatch {} { my variable chan my wait writable $chan chan configure $chan -translation {binary binary} chan puts -nonewline $chan [my clay get cache/ data] } } ::clay::define ::httpd::content.template { method content {} { if {[my request get HTTP_STATUS] ne {}} { my reply set Status [my request get HTTP_STATUS] } |
︙ | ︙ | |||
1238 1239 1240 1241 1242 1243 1244 | tailcall my DoOutput } if {$chan eq {}} return my wait writable $chan if {![info exists reply_file]} { tailcall my DoOutput } | < | | | | | | | | | | > | | | | | | < < < | 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 | tailcall my DoOutput } if {$chan eq {}} return my wait writable $chan if {![info exists reply_file]} { tailcall my DoOutput } chan configure $chan -translation {binary binary} my log HttpAccess {} ### # Return a stream of data from a file ### set size [file size $reply_file] my reply set Content-Length $size append result [my reply output] \n chan puts -nonewline $chan $result set reply_chan [open $reply_file r] my ChannelRegister $reply_chan my log SendReply [list length $size] ### # Output the file contents. With no -size flag, channel will copy until EOF ### chan configure $reply_chan -translation {binary binary} -buffersize 4096 -buffering full -blocking 0 my ChannelCopy $reply_chan $chan -chunk 4096 } } ### # END: file.tcl ### ### |
︙ | ︙ | |||
1417 1418 1419 1420 1421 1422 1423 | if {$sock eq {}} { my error 404 {Not Found} tailcall my DoOutput } my log HttpAccess {} chan event $sock writable [info coroutine] yield | | | | < < < | 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 | if {$sock eq {}} { my error 404 {Not Found} tailcall my DoOutput } my log HttpAccess {} chan event $sock writable [info coroutine] yield my ChannelRegister $sock my ProxyRequest $chan $sock my ProxyReply $sock $chan } } ### # END: proxy.tcl ### ### |
︙ | ︙ | |||
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 | ### # Send any POST/PUT/etc content ### my ChannelCopy $chana $chanb -size $length } else { chan flush $chanb } chan event $chanb readable [info coroutine] yield } method ProxyReply {chana chanb args} { my log ProxyReply [list args $args] chan event $chana readable {} set replyhead [my HttpHeaders $chana] | > | 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 | ### # Send any POST/PUT/etc content ### my ChannelCopy $chana $chanb -size $length } else { chan flush $chanb } my clay refcount_incr chan event $chanb readable [info coroutine] yield } method ProxyReply {chana chanb args} { my log ProxyReply [list args $args] chan event $chana readable {} set replyhead [my HttpHeaders $chana] |
︙ | ︙ | |||
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 | chan puts $chanb $replybuffer ### # Output the body. With no -size flag, channel will copy until EOF ### chan configure $chana -translation binary -blocking 0 -buffering full -buffersize 4096 chan configure $chanb -translation binary -blocking 0 -buffering full -buffersize 4096 my ChannelCopy $chana $chanb -chunk 4096 } method DirectoryListing {local_file} { my error 403 {Not Allowed} tailcall my DoOutput } } | > | 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 | chan puts $chanb $replybuffer ### # Output the body. With no -size flag, channel will copy until EOF ### chan configure $chana -translation binary -blocking 0 -buffering full -buffersize 4096 chan configure $chanb -translation binary -blocking 0 -buffering full -buffersize 4096 my ChannelCopy $chana $chanb -chunk 4096 my clay refcount_decr } method DirectoryListing {local_file} { my error 403 {Not Allowed} tailcall my DoOutput } } |
︙ | ︙ | |||
1684 1685 1686 1687 1688 1689 1690 | return } if {$char eq ":"} break append size $char } # With length in hand, read the netstring encoded headers set inbuffer [::coroutine::util::read $sock [expr {$size+1}]] | | | 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 | return } if {$char eq ":"} break append size $char } # With length in hand, read the netstring encoded headers set inbuffer [::coroutine::util::read $sock [expr {$size+1}]] chan configure $sock -translation {auto crlf} -blocking 0 -buffersize 4096 -buffering full foreach {f v} [lrange [split [string range $inbuffer 0 end-1] \0] 0 end-1] { dict set query http $f $v } if {![dict exists $query http REQUEST_PATH]} { set uri [dict get $query http REQUEST_URI] set uriinfo [::uri::split $uri] dict set query http REQUEST_PATH [dict get $uriinfo path] |
︙ | ︙ | |||
1716 1717 1718 1719 1720 1721 1722 | try { set pageobj [::httpd::reply create ::httpd::object::$uuid [self]] dict set reply mixin protocol ::httpd::protocol.scgi $pageobj dispatch $sock $reply } on error {err errdat} { my debug [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] my log BadRequest $uuid [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] | | | 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 | try { set pageobj [::httpd::reply create ::httpd::object::$uuid [self]] dict set reply mixin protocol ::httpd::protocol.scgi $pageobj dispatch $sock $reply } on error {err errdat} { my debug [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] my log BadRequest $uuid [list ip: $ip error: $err errorinfo: [dict get $errdat -errorinfo]] $pageobj clay refcount_decr catch {chan event readable $sock {}} catch {chan event writeable $sock {}} catch {chan close $sock} return } } } |
︙ | ︙ | |||
1887 1888 1889 1890 1891 1892 1893 | } $pageobj clay mixinmap {*}$mixinmap if {[dict exists $reply delegate]} { $pageobj clay delegate {*}[dict get $reply delegate] } $pageobj dispatch $sock $reply set output [$pageobj output] | | | 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 | } $pageobj clay mixinmap {*}$mixinmap if {[dict exists $reply delegate]} { $pageobj clay delegate {*}[dict get $reply delegate] } $pageobj dispatch $sock $reply set output [$pageobj output] $pageobj clay refcount_decr return $output } } ### # END: plugin.tcl ### namespace eval ::httpd { namespace export * } |
Changes to modules/httpd/httpd.test.
︙ | ︙ | |||
9 10 11 12 13 14 15 | } else { set TCLLIBMOD [file join $MODDIR .. .. tcllib modules] } source [file join $TCLLIBMOD devtools testutilities.tcl] testsNeedTcl 8.6 ;# tool requires 8.6 testsNeedTcltest 2 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < < < < < < < < < < < < < < < < < < < < < < < < | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > | | | | | | | | | < | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > | | | | > | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > | | | > | | | | | > | < | < < < < < | < | < < < < < | < | | < < < < < | < | < | | < < < < < < < < < < < < < < | | < < | < < < < < < < < < | | < | | < | > < < < | | < | | | | | | < | | | | | | > > > > > > > > > > > > | < | < < < < < | < | | < < < < < | < | | < < < < < | < | < | | < < < < < < < < < < < < < < | | < < | < < < < < < < < < | | < | > > > > < > | < < < < < < < < < < < < < < < < < < | < | < < < < < | | | < | < < < < | | < < < | | < | | | | > | | | | | | | | | | | | | | | | | | | | | | > | | | | | | | > | > | | | | > | | | > | > > | | | | | | | | | > | | | | | | > | | | > > | | | | > | < | < < < < < | < < < | | < < < < < | < < | | < < < < < | < < | < | | < < < < < < < < < < < < < < < < | | > > > | | < < < < < < < < < | | | | < < | < | > > | | | < | 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 | } else { set TCLLIBMOD [file join $MODDIR .. .. tcllib modules] } source [file join $TCLLIBMOD devtools testutilities.tcl] testsNeedTcl 8.6 ;# tool requires 8.6 testsNeedTcltest 2 set NOW [clock seconds] testsNeed TclOO 1 support { use [file join ${TCLLIBMOD} fumagic rtcore.tcl] fileutil::magic::rt use [file join ${TCLLIBMOD} fumagic filetypes.tcl] fileutil::magic::filetype use [file join ${TCLLIBMOD} textutil string.tcl] textutil::string use [file join ${TCLLIBMOD} textutil repeat.tcl] textutil::repeat use [file join ${TCLLIBMOD} textutil tabify.tcl] textutil::tabify use [file join ${TCLLIBMOD} markdown markdown.tcl] Markdown use [file join ${TCLLIBMOD} ncgi ncgi.tcl] ncgi use [file join ${TCLLIBMOD} log logger.tcl] logger use [file join ${TCLLIBMOD} base64 base64.tcl] base64 use [file join ${TCLLIBMOD} md5 md5x.tcl] md5 use [file join ${TCLLIBMOD} mime mime.tcl] mime use [file join ${TCLLIBMOD} uuid uuid.tcl] uuid use [file join ${TCLLIBMOD} cmdline cmdline.tcl] cmdline use [file join ${TCLLIBMOD} fileutil fileutil.tcl] fileutil use [file join ${TCLLIBMOD} sha1 sha1.tcl] sha1 use [file join ${TCLLIBMOD} uri uri.tcl] uri use [file join ${TCLLIBMOD} ncgi ncgi.tcl] ncgi use [file join ${TCLLIBMOD} dns ip.tcl] ip use [file join ${TCLLIBMOD} nettool nettool.tcl] nettool use [file join ${TCLLIBMOD} coroutine coroutine.tcl] coroutine use [file join ${TCLLIBMOD} dicttool dicttool.tcl] dicttool use [file join ${TCLLIBMOD} cron cron.tcl] cron use [file join ${TCLLIBMOD} virtchannel_core core.tcl] tcl::chan::core use [file join ${TCLLIBMOD} virtchannel_core events.tcl] tcl::chan::events use [file join ${TCLLIBMOD} virtchannel_base memchan.tcl] tcl::chan::memchan use [file join ${TCLLIBMOD} websocket websocket.tcl] websocket use [file join ${MODDIR} clay clay.tcl] clay } testing { useLocal httpd.tcl httpd } # Set to true for debugging and traces set ::DEBUG 0 set ::clay::debug $::DEBUG proc DEBUG args { if {!$::DEBUG} return uplevel 1 $args } # ------------------------------------------------------------------------- # Constructors for various expected replies. proc IndexReply {{head {HTTP/1.0}}} { global TESTDIR set fin [open [file join $TESTDIR pkgIndex.tcl] r] set replyfile [read $fin] close $fin append checkreply "$head 200 OK" \n append checkreply "Content-Type: text/plain" \n append checkreply "Connection: close" \n append checkreply "Content-Length: [string length $replyfile]" \n append checkreply \n append checkreply $replyfile return $checkreply } proc 404 {} { lappend map " " "" lappend map " " "" # The map removes the indentation of the value return [string map $map {HTTP/1.0 404 Not Found Content-Type: text/plain Connection: close Content-Length: * 404 Not Found }] } proc 200 {text {len *}} { lappend map " " "" # The map removes the indentation of the value # and inserts the dynamic parts lappend map @C $text lappend map @L $len return [string map $map {HTTP/1.0 200 OK Content-Type: text/plain Connection: close Content-Length: @L @C}] } proc 200+status-head {text {len *}} { lappend map " " "" # The map removes the indentation of the value # and inserts the dynamic parts lappend map @C $text lappend map @L $len return [string map $map {Status: 200 OK Content-Type: text/plain Connection: close Content-Length: @L @C}] } proc 200+status-conn {text {len *}} { lappend map " " "" # The map removes the indentation of the value # and inserts the dynamic parts lappend map @C $text lappend map @L $len return [string map $map {HTTP/1.0 200 OK Status: 200 OK Content-Type: text/plain Content-Length: @L @C}] } proc 500 {} { lappend map " " "" lappend map " " "" # The map removes the indentation of the value return [string map $map {HTTP/1.0 500 Server Internal Error Content-Type: text/plain Connection: close Content-Length: * 500 Server Internal Error }] } proc 500+status-head {} { lappend map " " "" lappend map " " "" # The map removes the indentation of the value return [string map $map {Status: 500 Server Internal Error Content-Type: text/plain Connection: close Content-Length: * 500 Server Internal Error }] } # Likely a band aid, see AKU proc norm-eol {x} { string map [list "\r\n" "\n"] $x } # ------------------------------------------------------------------------- namespace eval ::httpd {} namespace eval ::httpd::test {} proc ::httpd::test::send {port http headers body} { set sock [socket localhost $port] variable reply set reply($sock) {} chan configure $sock -translation {crlf crlf} -blocking 0 -buffering full -buffersize 4096 chan event $sock readable [list ::httpd::test::get_reply $sock] puts $sock $http if {![dict exists $headers Host]} { dict set headers Host localhost } if {[string length $body]} { if {![dict exists $headers Content-Type]} { dict set headers Content_Type text/plain } dict set headers Content-Length [string length $body] } foreach {f v} $headers { puts $sock "${f}: $v" } puts $sock {} if {[string length $body]} { chan configure $sock -translation binary -blocking 0 -buffering full -buffersize 4096 puts -nonewline $sock $body } flush $sock while {$reply($sock) eq {}} { update } #vwait [namespace current]::reply($sock) #puts ZZ\t[join [split $reply($sock) \n] "|\nZZ\t"]| return $reply($sock) } proc ::httpd::test::get_reply {sock} { variable buffer set data [read $sock] append buffer($sock) $data if {[eof $sock]} { chan event $sock readable {} set [namespace current]::reply($sock) $buffer($sock) unset buffer($sock) } } clay::define ::httpd::server { method log args {} method TemplateSearch page { set doc_root [my clay get server/ doc_root] if {$doc_root ne {} && [file exists [file join $doc_root $page.tml]]} { return [::fileutil::cat [file join $doc_root $page.tml]] } if {$doc_root ne {} && [file exists [file join $doc_root $page.html]]} { return [::fileutil::cat [file join $doc_root $page.html]] } switch $page { redirect { return {300 Redirect} } notfound { return {404 Not Found} } internal_error { return {500 Server Internal Error} } } } ::DEBUG method debug args { puts stderr $args } ::DEBUG method log args { puts stdout $args } } ### # Modify the reply class to return plain text ### clay::define ::httpd::reply { method HttpHeaders_Default {} { return { Status {200 OK} Content-Type {text/plain} Connection close } } method reset {} { my variable reply_body my reply replace [my HttpHeaders_Default] set reply_body {} } method error {code {msg {}} {errorInfo {}}} { my clay set HTTP_ERROR $code my reset set errorstring [my http_code_string $code] set qheaders [my clay dump] dict with qheaders {} my reply replace {} my reply set Status "$code $errorstring" my reply set Content-Type text/plain my puts "$code $errorstring" } } clay::define ::test::content.echo { method content {} { my variable reply_body set reply_body [my PostData [my request get CONTENT_LENGTH]] #puts [list REPLY BODY WAS $reply_body] } } clay::define ::test::content.file { superclass ::httpd::content.file method content {} { my reset set doc_root [my clay get path] my variable reply_file set reply_file [file join $doc_root pkgIndex.tcl] } } clay::define ::test::content.time { method content {} { my variable reply_body set reply_body $::NOW } } clay::define ::test::content.error { method content {} { error {The programmer asked me to die this way} } } clay::define ::test::content.cgi { superclass ::httpd::content.cgi } clay::define ::test::content.string { method content {} { my variable reply_body set reply_body [my clay get hardcoded_string] } } clay::define ::httpd::test::reply { superclass ::httpd::reply ::test::content.echo } ### # Build the server ### ::httpd::server create TESTAPP port 10001 doc_root $::TESTDIR TESTAPP plugin dict_dispatch TESTAPP uri add * / [list mixin {reply ::test::content.echo}] TESTAPP uri add * /echo [list mixin {reply ::test::content.echo}] TESTAPP uri add * /file [list mixin {reply ::test::content.file} path $::TESTDIR] TESTAPP uri add * /time [list mixin {reply ::test::content.time}] TESTAPP uri add * /error [list mixin {reply ::test::content.error}] TESTAPP uri add * /string [list mixin {reply ::test::content.string} hardcoded_string apple] # Catch all #TESTAPP uri add * * [list mixin {reply httpd::content.echo}] ::DEBUG puts httpd-client-0001 test httpd-client-0001 {Do an echo request} -body { ::httpd::test::send 10001 {POST /echo HTTP/1.0} {} {THIS IS MY CODE} } -match glob -result [200 {THIS IS MY CODE}] ::DEBUG puts httpd-client-0002 test httpd-client-0002 {Do another echo request} { ::httpd::test::send 10001 {POST /echo HTTP/1.0} {} {THOUGH THERE ARE MANY LIKE IT} } [200 {THOUGH THERE ARE MANY LIKE IT} 29] ::DEBUG puts httpd-client-0003 test httpd-client-0003 {Do another echo request} -body { ::httpd::test::send 10001 {POST /echo HTTP/1.0} {} {THIS ONE ALONE IS MINE} } -match glob -result [200 {THIS ONE ALONE IS MINE}] ::DEBUG puts httpd-client-0004 test httpd-client-0004 {URL Generates Error} -body { ::httpd::test::send 10001 {POST /error HTTP/1.0} {} {THIS ONE ALONE IS MINE} } -match glob -result [500] ::DEBUG puts httpd-client-0005 test httpd-client-0005 {URL Different output with a different request} -body { ::httpd::test::send 10001 {POST /time HTTP/1.0} {} {THIS ONE ALONE IS MINE} } -match glob -result [200 $::NOW] ::DEBUG puts httpd-client-0006 test httpd-client-0006 {Return a file} -body { ::httpd::test::send 10001 {GET /file HTTP/1.0} {} {} } -result [IndexReply] ::DEBUG puts httpd-client-0007 test httpd-client-0007 {URL Generates Not Found} -body { ::httpd::test::send 10001 {POST /doesnotexist HTTP/1.0} {} {THIS ONE ALONE IS MINE} } -match glob -result [404] ::DEBUG puts httpd-client-0008 test httpd-client-0008 {Pull a constant string} -body { ::httpd::test::send 10001 {GET /string HTTP/1.0} {} {} } -match glob -result [200 apple] # ------------------------------------------------------------------------- # Test proxies clay::define ::test::content.proxy { superclass ::httpd::content.proxy method proxy_channel {} { return [::socket localhost [my clay get proxy_port]] } } ::httpd::server create TESTPROXY port 10002 doc_root $::TESTDIR TESTAPP uri add * /proxy* [list mixin {reply ::test::content.proxy} proxy_port [TESTPROXY port_listening]] TESTPROXY plugin dict_dispatch TESTPROXY uri add * / [list mixin {reply ::test::content.echo}] TESTPROXY uri add * /echo [list mixin {reply ::test::content.echo}] TESTPROXY uri add * /file [list mixin {reply ::test::content.file} path $::TESTDIR] TESTPROXY uri add * /time [list mixin {reply ::test::content.time}] TESTPROXY uri add * /error [list mixin {reply ::test::content.error}] TESTPROXY uri add * /string [list mixin {reply ::test::content.string} hardcoded_string banana] ## AKU ## # # Note: Proxy replies are not normalized to \n. They contain \r\n # endings. The old test::compare was ok with that due to running a # trim on the lines it was comparing. Here we properly normalize # before feeding into the comparison. # # Note 2: I suspect that this leakage / non-normalization of of \r\n # in the server is a bug which should be fixed. If so, norm-eol # becomes superfluous. Right now it feels like a band-aid ::DEBUG puts httpd-proxy-0001 test httpd-proxy-0001 {Do an echo request} -body { norm-eol [::httpd::test::send 10001 {POST /proxy/echo HTTP/1.0} {} {THIS IS MY CODE}] } -match glob -result [200 {THIS IS MY CODE}] ::DEBUG puts httpd-proxy-0002 test httpd-proxy-0002 {Do another echo request} -body { norm-eol [::httpd::test::send 10001 {POST /proxy/echo HTTP/1.0} {} {THOUGH THERE ARE MANY LIKE IT}] } -result [200 {THOUGH THERE ARE MANY LIKE IT} 29] ::DEBUG puts httpd-proxy-0003 test httpd-proxy-0003 {Do another echo request} -body { norm-eol [::httpd::test::send 10001 {POST /proxy/echo HTTP/1.0} {} {THIS ONE ALONE IS MINE}] } -match glob -result [200 {THIS ONE ALONE IS MINE}] ::DEBUG puts httpd-proxy-0004 test httpd-proxy-0004 {URL Generates Error} -body { norm-eol [::httpd::test::send 10001 {POST /proxy/error HTTP/1.0} {} {THIS ONE ALONE IS MINE}] } -match glob -result [500] ::DEBUG puts httpd-proxy-0005 test httpd-proxy-0005 {URL Different output with a different request} -body { norm-eol [::httpd::test::send 10001 {POST /proxy/time HTTP/1.0} {} {THIS ONE ALONE IS MINE}] } -match glob -result [200 $::NOW] ::DEBUG puts httpd-proxy-0006 test httpd-proxy-0006 {Return a file} -body { norm-eol [::httpd::test::send 10001 {GET /proxy/file HTTP/1.0} {} {}] } -result [IndexReply] ::DEBUG puts httpd-proxy-0008 test httpd-proxy-0008 {Pull a constant string} -body { norm-eol [::httpd::test::send 10001 {GET /proxy/string HTTP/1.0} {} {}] } -result [200 banana 6] # ------------------------------------------------------------------------- # cgi TESTAPP plugin local_memchan TESTAPP uri add * /cgi-bin* [list mixin {reply ::test::content.cgi} path $::TESTDIR/assets] ::DEBUG puts httpd-cgi-0001 test httpd-cgi-0001 {CGI Post} -body { norm-eol [::httpd::test::send 10001 {POST /cgi-bin/test_cgi.tcl HTTP/1.0} {} {THIS IS MY CODE}] } -match glob -result [200+status-conn {THIS IS MY CODE }] ::DEBUG puts httpd-cgi-0002 test httpd-cgi-0002 {CGI Get} -body { ::httpd::test::send 10001 {GET /cgi-bin/test_cgi.tcl HTTP/1.0} {} {} } -match glob -result [200+status-conn {Hi! }] ### # Test the local geturl method ### test httpd-memchan-0001 {Memchan GET} { TESTAPP local_memchan geturl /time } $NOW # ------------------------------------------------------------------------- namespace eval ::scgi {} namespace eval ::scgi::test {} ### # Minimal test harness for the .tests # Not intended for public consumption # (But if you find it handy, please steal!) proc ::scgi::encode_request {headers body info} { variable server_block dict set outdict CONTENT_LENGTH [string length $body] set outdict [dict merge $outdict $server_block $info] dict set outdict PWD [pwd] foreach {key value} $headers { if {$key in { DOCUMENT_ROOT HTTPS PATH REQUEST_METHOD REQUEST_URI REMOTE_HOST REMOTE_ADDR REMOTE_PORT SCRIPT_NAME } || [string range $key 0 5] eq "HTTP_"} { dict set outdict $key $value } else { dict set outdict HTTP_[string map {"-" "_"} [string toupper $key]] $value } } set result {} foreach {name value} $outdict { append result $name \x00 $value \x00 } return "[string length $result]:$result," } proc ::scgi::test::send {port headers body} { set sock [socket localhost $port] variable reply set reply($sock) {} if {![dict exists $headers HOST]} { dict set headers HOST localhost } dict set headers REMOTE_IP 127.0.0.1 dict set headers REMOTE_HOST localhost chan configure $sock -translation binary -blocking 0 -buffering full -buffersize 4096 chan event $sock readable [list ::scgi::test::get_reply $sock] set block [::scgi::encode_request $headers $body {}] puts -nonewline $sock $block flush $sock puts -nonewline $sock $body flush $sock while {$reply($sock) eq {}} { update } #vwait [namespace current]::reply($sock) #puts ZZ\t[join [split $reply($sock) \n] "|\nZZ\t"]| return $reply($sock) } proc ::scgi::test::get_reply {sock} { variable buffer set data [read $sock] append buffer($sock) $data if {[eof $sock]} { chan event $sock readable {} set [namespace current]::reply($sock) $buffer($sock) unset buffer($sock) } } namespace eval ::scgi { variable server_block {SCGI 1.0 SERVER_SOFTWARE {TclScgiServer/0.1}} } ### # Build the reply class ### ::clay::define ::scgi::test::reply { superclass ::httpd::reply method reset {} { my variable reply_body my reply replace [my HttpHeaders_Default] set reply_body {} } } ### # Build the server ### ::clay::define scgi::test::app { superclass ::httpd::server.scgi clay set reply_class ::scgi::test::reply } ::DEBUG puts [list ::test::content.file [info commands ::test::content.file]] scgi::test::app create TESTSCGI port 10003 doc_root $::TESTDIR TESTSCGI plugin dict_dispatch TESTSCGI uri add * / [list mixin {reply ::test::content.echo}] TESTSCGI uri add * /echo [list mixin {reply ::test::content.echo}] TESTSCGI uri add * /file [list mixin {reply ::test::content.file} path $::TESTDIR] TESTSCGI uri add * /time [list mixin {reply ::test::content.time}] TESTSCGI uri add * /error [list mixin {reply ::test::content.error}] TESTSCGI uri add * /string [list mixin {reply ::test::content.string} hardcoded_string cherry] ::DEBUG puts scgi-client-0001 test scgi-client-0001 {Do an echo request} -body { ::scgi::test::send 10003 {REQUEST_METHOD POST REQUEST_URI /echo} {THIS IS MY CODE} } -match glob -result [200+status-head {THIS IS MY CODE}] ::DEBUG puts scgi-client-0002 test scgi-client-0002 {Do another echo request} -body { ::scgi::test::send 10003 {REQUEST_METHOD POST REQUEST_URI /echo} {THOUGH THERE ARE MANY LIKE IT} } -match glob -result [200+status-head {THOUGH THERE ARE MANY LIKE IT}] ::DEBUG puts scgi-client-0003 test scgi-client-0003 {Do another echo request} -body { ::scgi::test::send 10003 {REQUEST_METHOD POST REQUEST_URI /echo} {THIS ONE ALONE IS MINE} } -match glob -result [200+status-head {THIS ONE ALONE IS MINE}] ::DEBUG puts scgi-client-0004 test scgi-client-0004 {URL Generates Error} -body { ::scgi::test::send 10003 {REQUEST_METHOD POST REQUEST_URI /error} {THIS ONE ALONE IS MINE} } -match glob -result [500+status-head] ::DEBUG puts scgi-client-0005 test scgi-client-0005 {URL Different output with a different request} -body { ::scgi::test::send 10003 {REQUEST_METHOD POST REQUEST_URI /time} {THIS ONE ALONE IS MINE} } -match glob -result [200+status-head $::NOW] ::DEBUG puts scgi-client-0006 test scgi-client-0006 {Return a file} -body { ::scgi::test::send 10003 {REQUEST_METHOD GET REQUEST_URI /file} {} } -result [IndexReply Status:] ::DEBUG puts scgi-client-0008 test scgi-client-0008 {Pull a constant string} -body { ::scgi::test::send 10003 {REQUEST_METHOD GET REQUEST_URI /string} {} } -match glob -result [200+status-head cherry] ### # Test the all object have been destroyed after ::clay::cleanup ### test httpd-garbage-collection {Test that garbage collection leaves nothing behind} -body { ::clay::cleanup info commands ::httpd::object::* } -result {} ::DEBUG puts all-tests-finished # ------------------------------------------------------------------------- testsuiteCleanup # Local variables: # mode: tcl # indent-tabs-mode: nil |
︙ | ︙ |
Changes to modules/ident/ident.man.
︙ | ︙ | |||
46 47 48 49 50 51 52 | to the RFC. A detailed error message is returned under the [const error] key. [list_end] [list_end] [vset CATEGORY ident] | | | 46 47 48 49 50 51 52 53 54 | to the RFC. A detailed error message is returned under the [const error] key. [list_end] [list_end] [vset CATEGORY ident] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/imap4/imap4.man.
|
| > | | | | 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 | [vset VERSION 0.5.3] [manpage_begin imap4 n [vset VERSION]] [see_also ftp] [see_also http] [see_also imap] [see_also mime] [see_also pop3] [see_also tls] [keywords email] [keywords imap] [keywords internet] [keywords mail] [keywords net] [keywords rfc3501] [keywords ssl] [keywords tls] [moddesc {imap client}] [titledesc {imap client-side tcl implementation of imap protocol}] [category Networking] [require Tcl 8.5] [require imap4 [opt [vset VERSION]]] [description] The [package imap4] library package provides the client side of the [emph "Internet Message Access Protocol"] (IMAP) using standard sockets or secure connection via TLS/SSL. The package is fully implemented in Tcl. |
︙ | ︙ | |||
357 358 359 360 361 362 363 | Mark R. Crispin, "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, March 2003, [uri http://www.rfc-editor.org/rfc/rfc3501.txt] [para] OpenSSL, [uri http://www.openssl.org/] [vset CATEGORY imap4] | | | 358 359 360 361 362 363 364 365 366 367 368 | Mark R. Crispin, "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, March 2003, [uri http://www.rfc-editor.org/rfc/rfc3501.txt] [para] OpenSSL, [uri http://www.openssl.org/] [vset CATEGORY imap4] [include ../common-text/feedback.inc] Only a small part of rfc3501 implemented. [manpage_end] |
Changes to modules/inifile/ini.man.
︙ | ︙ | |||
92 93 94 95 96 97 98 | Reads and sets the comment character. Lines that begin with this character are treated as comments. When comments are written out each line is preceded by this character. The default is [const \;]. [list_end] [vset CATEGORY inifile] | | | 92 93 94 95 96 97 98 99 100 | Reads and sets the comment character. Lines that begin with this character are treated as comments. When comments are written out each line is preceded by this character. The default is [const \;]. [list_end] [vset CATEGORY inifile] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/interp/deleg_method.man.
︙ | ︙ | |||
41 42 43 44 45 46 47 | returns the result from the remote method as its own result. If however the option [option -async] was specified then the generated method will not wait for a result and return immediately. [list_end] [vset CATEGORY interp] | | | 41 42 43 44 45 46 47 48 49 | returns the result from the remote method as its own result. If however the option [option -async] was specified then the generated method will not wait for a result and return immediately. [list_end] [vset CATEGORY interp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/interp/deleg_proc.man.
︙ | ︙ | |||
39 40 41 42 43 44 45 | returns the result from the remote procedure as its own result. If however the option [option -async] was specified then the generated procedure will not wait for a result and return immediately. [list_end] [vset CATEGORY interp] | | | 39 40 41 42 43 44 45 46 47 | returns the result from the remote procedure as its own result. If however the option [option -async] was specified then the generated procedure will not wait for a result and return immediately. [list_end] [vset CATEGORY interp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/interp/tcllib_interp.man.
︙ | ︙ | |||
66 67 68 69 70 71 72 | [para] The result of the command is the empty string. [list_end] [vset CATEGORY interp] | | | 66 67 68 69 70 71 72 73 74 | [para] The result of the command is the empty string. [list_end] [vset CATEGORY interp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/irc/irc.man.
︙ | ︙ | |||
232 233 234 235 236 237 238 | [call [cmd msg]] Returns the message portion of the command (the part after the :). [list_end] [vset CATEGORY irc] | | | 232 233 234 235 236 237 238 239 240 | [call [cmd msg]] Returns the message portion of the command (the part after the :). [list_end] [vset CATEGORY irc] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/javascript/javascript.man.
︙ | ︙ | |||
88 89 90 91 92 93 94 | checked. The [arg parentName] argument is the name of the child's parent html checkbox object. The [arg childName] argument is the name of child html checkbox object to create. [list_end] [vset CATEGORY javascript] | | | 88 89 90 91 92 93 94 95 96 | checked. The [arg parentName] argument is the name of the child's parent html checkbox object. The [arg childName] argument is the name of child html checkbox object to create. [list_end] [vset CATEGORY javascript] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/jpeg/jpeg.man.
︙ | ︙ | |||
188 189 190 191 192 193 194 | can only work with files cant write exif data gps exif data not parsed makernote data not yet implemented [vset CATEGORY jpeg] | | | 188 189 190 191 192 193 194 195 196 | can only work with files cant write exif data gps exif data not parsed makernote data not yet implemented [vset CATEGORY jpeg] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/json/json.man.
︙ | ︙ | |||
106 107 108 109 110 111 112 | }] [section RELATED] To write json, instead of parsing it, see package [package json::write]. [vset CATEGORY json] | | | 106 107 108 109 110 111 112 113 114 | }] [section RELATED] To write json, instead of parsing it, see package [package json::write]. [vset CATEGORY json] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/json/json_write.man.
︙ | ︙ | |||
84 85 86 87 88 89 90 | [para] [section RELATED] To parse json, instead of writing it, see package [package json]. [vset CATEGORY json] | | | 84 85 86 87 88 89 90 91 92 | [para] [section RELATED] To parse json, instead of writing it, see package [package json]. [vset CATEGORY json] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/lambda/lambda.man.
︙ | ︙ | |||
81 82 83 84 85 86 87 | [list_end] [section AUTHORS] Andreas Kupries [vset CATEGORY lambda] | | | 81 82 83 84 85 86 87 88 89 | [list_end] [section AUTHORS] Andreas Kupries [vset CATEGORY lambda] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/lazyset/lazyset.man.
︙ | ︙ | |||
72 73 74 75 76 77 78 | puts $simple }] [section AUTHORS] Roy Keene [vset CATEGORY utility] | | | 72 73 74 75 76 77 78 79 80 | puts $simple }] [section AUTHORS] Roy Keene [vset CATEGORY utility] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ldap/ldap.man.
︙ | ︙ | |||
541 542 543 544 545 546 547 | puts "" } ldap::unbind $handle ldap::disconnect $handle }] [vset CATEGORY ldap] | | | 541 542 543 544 545 546 547 548 549 | puts "" } ldap::unbind $handle ldap::disconnect $handle }] [vset CATEGORY ldap] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ldap/ldapx.man.
︙ | ︙ | |||
766 767 768 769 770 771 772 | liout destroy liin destroy }] [section References] [vset CATEGORY ldap] | | | 766 767 768 769 770 771 772 773 774 | liout destroy liin destroy }] [section References] [vset CATEGORY ldap] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/log/log.man.
︙ | ︙ | |||
281 282 283 284 285 286 287 | [emph Note] that by default all messages with levels [const warning] down to [const debug] are suppressed. This is done intentionally, because (we believe that) in most situations debugging output is not wanted. Most people wish to have such output only when actually debugging an application. [vset CATEGORY log] | | | 281 282 283 284 285 286 287 288 289 | [emph Note] that by default all messages with levels [const warning] down to [const debug] are suppressed. This is done intentionally, because (we believe that) in most situations debugging output is not wanted. Most people wish to have such output only when actually debugging an application. [vset CATEGORY log] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/log/logger.man.
︙ | ︙ | |||
389 390 391 392 393 394 395 | # install as logproc ${log}::logproc debug log_local_var } ] [vset CATEGORY logger] | | | 389 390 391 392 393 394 395 396 397 | # install as logproc ${log}::logproc debug log_local_var } ] [vset CATEGORY logger] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/log/loggerAppender.man.
︙ | ︙ | |||
57 58 59 60 61 62 63 | See [cmd ::logger::appender::colorConsole] for a description of the applicable options. [list_end] [vset CATEGORY logger] | | | 57 58 59 60 61 62 63 64 65 | See [cmd ::logger::appender::colorConsole] for a description of the applicable options. [list_end] [vset CATEGORY logger] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/log/loggerUtils.man.
︙ | ︙ | |||
141 142 143 144 145 146 147 | logger::utils::applyAppender -appender console set log [logger::init applyAppender-3] ${log}::error "this is an error" }] [list_end] [vset CATEGORY logger] | | | 141 142 143 144 145 146 147 148 149 | logger::utils::applyAppender -appender console set log [logger::init applyAppender-3] ${log}::error "this is an error" }] [list_end] [vset CATEGORY logger] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/markdown/markdown.man.
︙ | ︙ | |||
45 46 47 48 49 50 51 | [call [cmd ::Markdown::reset_lang_counter]] Reset the language counters. [list_end] [vset CATEGORY textutil] | | | 45 46 47 48 49 50 51 52 53 | [call [cmd ::Markdown::reset_lang_counter]] Reset the language counters. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/ChangeLog.
1 2 3 4 5 6 7 | 2018-08-04 Arjen Markus <[email protected]> * statistics.tcl: Source stat_wasserstein.tcl and stat_logit.tcl - for new commands * statistics.test: Add corresponding tests * statistics.man: Add description of these commands * pkgIndex.tcl: Bump the version to 1.3.0 2018-07-22 Arjen Markus <[email protected]> | > > > > > > > > > > > > > > > > > > > | 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 | 2019-05-07 Arjen Markus <[email protected]> * quasirandom.test: Add tests to deal with procedures in a different namespace * quasirandom.tcl: Deal with procedures in a different namespace 2019-04-24 Arjen Markus <[email protected]> * quasirandom.test: Add support code * numtheory.tcl: Add estimation of the number of primes between two limits * numtheory.test: Add tests regarding the estimated number of primes 2019-04-23 Arjen Markus <[email protected]> * quasirandom.tcl: New package - generate quasi-random numbers (for instance for estimating multidimensional integrals) * quasirandom.test: Tests for the new package * quasirandom.man: Documentation for the new package * pkgIndex.tcl: Add the new package 2019-04-18 Arjen Markus <[email protected]> * misc.tcl: Add double() to calculation of mean and standard deviation in proc stats (ticket 0a030f850d4e3fc05da98aa954a6ec1b16e655d9) * math.test: Correct the outcome of the test for stats (consequence of ticket 0a030f850d4e3fc05da98aa954a6ec1b16e655d9) 2018-08-04 Arjen Markus <[email protected]> * statistics.tcl: Source stat_wasserstein.tcl and stat_logit.tcl - for new commands * statistics.test: Add corresponding tests * statistics.man: Add description of these commands * pkgIndex.tcl: Bump the version to 1.3.0 2018-07-22 Arjen Markus <[email protected]> |
︙ | ︙ |
Changes to modules/math/bigfloat.man.
︙ | ︙ | |||
424 425 426 427 428 429 430 | set sinProduct [lb]mul [lb]sin $angle1[rb] [lb]sin $angle2[rb][rb] set cosProduct [lb]mul [lb]cos $angle1[rb] [lb]cos $angle2[rb][rb] set angle3 [lb]asin [lb]add [lb]mul $sinProduct [lb]cos $opposite3[rb][rb] $cosProduct[rb][rb] puts "angle3 : [lb]tostr [lb]rad2deg $angle3[rb][rb]" [example_end] [vset CATEGORY {math :: bignum :: float}] | | | 424 425 426 427 428 429 430 431 432 | set sinProduct [lb]mul [lb]sin $angle1[rb] [lb]sin $angle2[rb][rb] set cosProduct [lb]mul [lb]cos $angle1[rb] [lb]cos $angle2[rb][rb] set angle3 [lb]asin [lb]add [lb]mul $sinProduct [lb]cos $opposite3[rb][rb] $cosProduct[rb][rb] puts "angle3 : [lb]tostr [lb]rad2deg $angle3[rb][rb]" [example_end] [vset CATEGORY {math :: bignum :: float}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/bignum.man.
︙ | ︙ | |||
220 221 222 223 224 225 226 | [call [cmd ::math::bignum::bits] [arg bignum]] Return the number of bits needed to represent bignum in radix 2. [list_end] [para] [vset CATEGORY {math :: bignum}] | | | 220 221 222 223 224 225 226 227 228 | [call [cmd ::math::bignum::bits] [arg bignum]] Return the number of bits needed to represent bignum in radix 2. [list_end] [para] [vset CATEGORY {math :: bignum}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/calculus.man.
︙ | ︙ | |||
443 444 445 446 447 448 449 | set length 100.0 set y [lb]::math::calculus::boundaryValueSecondOrder \ coeffs force {0.0 1.0} [lb]list $length 0.0[rb] 100[rb] [example_end] [vset CATEGORY {math :: calculus}] | | | 443 444 445 446 447 448 449 450 451 | set length 100.0 set y [lb]::math::calculus::boundaryValueSecondOrder \ coeffs force {0.0 1.0} [lb]list $length 0.0[rb] 100[rb] [example_end] [vset CATEGORY {math :: calculus}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/combinatorics.man.
︙ | ︙ | |||
100 101 102 103 104 105 106 | Results are returned as a floating point number precise to better than nine significant digits provided that [arg w] and [arg z] are both at least 1. [list_end] [vset CATEGORY math] | | | 100 101 102 103 104 105 106 107 108 | Results are returned as a floating point number precise to better than nine significant digits provided that [arg w] and [arg z] are both at least 1. [list_end] [vset CATEGORY math] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/constants.man.
︙ | ︙ | |||
128 129 130 131 132 133 134 | [def [const onesixth]] One sixth (0.1666....) [def [const huge]] (Approximately) largest number [def [const tiny]] (Approximately) smallest number not equal zero [def [const eps]] Smallest number such that 1+eps != 1 [list_end] [vset CATEGORY {math :: constants}] | | | 128 129 130 131 132 133 134 135 136 | [def [const onesixth]] One sixth (0.1666....) [def [const huge]] (Approximately) largest number [def [const tiny]] (Approximately) smallest number not equal zero [def [const eps]] Smallest number such that 1+eps != 1 [list_end] [vset CATEGORY {math :: constants}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/decimal.man.
︙ | ︙ | |||
191 192 193 194 195 196 197 | Rounds [emph decimal] to [emph digits] number of decimal points with the following rules: Round zero or five away from 0. The same as round-up, except that rounding up only occurs if the digit to be rounded up is 0 or 5, and after overflow the result is the same as for round-down. [list_end] [para] [vset CATEGORY decimal] | | | 191 192 193 194 195 196 197 198 199 | Rounds [emph decimal] to [emph digits] number of decimal points with the following rules: Round zero or five away from 0. The same as round-up, except that rounding up only occurs if the digit to be rounded up is 0 or 5, and after overflow the result is the same as for round-down. [list_end] [para] [vset CATEGORY decimal] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/decimal.test.
1 2 3 4 5 6 7 | # -*- tcl -*- # Tests for decimal arithmetic package in math library -*- tcl -*- # # This file contains a collection of tests for one or more of the Tcllib # procedures. Sourcing this file into Tcl runs the tests and # generates output for errors. No output means no errors were found. # | < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | # -*- tcl -*- # Tests for decimal arithmetic package in math library -*- tcl -*- # # This file contains a collection of tests for one or more of the Tcllib # procedures. Sourcing this file into Tcl runs the tests and # generates output for errors. No output means no errors were found. # # Copyright (c) 2011 by Mark Alston # All rights reserved. # # ------------------------------------------------------------------------- source [file join \ |
︙ | ︙ |
Changes to modules/math/fourier.man.
︙ | ︙ | |||
126 127 128 129 130 131 132 | [arg_def list in_data] List of data (amplitudes) [list_end] [para] [list_end] [vset CATEGORY {math :: fourier}] | | | 126 127 128 129 130 131 132 133 134 | [arg_def list in_data] List of data (amplitudes) [list_end] [para] [list_end] [vset CATEGORY {math :: fourier}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/fuzzy.man.
︙ | ︙ | |||
125 126 127 128 129 130 131 | APL QUOTE QUAD 8(3):16-23, March 1978. [para] D. Knuth, Art of Computer Programming, Vol. 1, Problem 1.2.4-5. [vset CATEGORY {math :: fuzzy}] | | | 125 126 127 128 129 130 131 132 133 | APL QUOTE QUAD 8(3):16-23, March 1978. [para] D. Knuth, Art of Computer Programming, Vol. 1, Problem 1.2.4-5. [vset CATEGORY {math :: fuzzy}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/interpolate.man.
︙ | ︙ | |||
291 292 293 294 295 296 297 | 0.8: 4.11 0.9: 3.95675857843 1.0: 4.12 }] As you can see, the values at the abscissae are reproduced perfectly. [vset CATEGORY {math :: interpolate}] | | | 291 292 293 294 295 296 297 298 299 | 0.8: 4.11 0.9: 3.95675857843 1.0: 4.12 }] As you can see, the values at the abscissae are reproduced perfectly. [vset CATEGORY {math :: interpolate}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/linalg.man.
︙ | ︙ | |||
960 961 962 963 964 965 966 | namespace eval compute { rename ::scale scaleTk scaleTk .scale ... } }] [vset CATEGORY {math :: linearalgebra}] | | | 960 961 962 963 964 965 966 967 968 | namespace eval compute { rename ::scale scaleTk scaleTk .scale ... } }] [vset CATEGORY {math :: linearalgebra}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/machineparameters.man.
︙ | ︙ | |||
183 184 185 186 187 188 189 | [call [arg objectname] [method print]] Print machine parameters on standard output. [list_end] [vset CATEGORY math] | | | 183 184 185 186 187 188 189 190 191 | [call [arg objectname] [method print]] Print machine parameters on standard output. [list_end] [vset CATEGORY math] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/math.man.
︙ | ︙ | |||
118 119 120 121 122 123 124 | [call [cmd ::math::sum] [arg value] [opt [arg {value ...}]]] Return the sum of one or more numeric values. [list_end] [vset CATEGORY math] | | | 118 119 120 121 122 123 124 125 126 | [call [cmd ::math::sum] [arg value] [opt [arg {value ...}]]] Return the sum of one or more numeric values. [list_end] [vset CATEGORY math] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/math.test.
︙ | ︙ | |||
214 215 216 217 218 219 220 | } [tcltest::wrongNumArgs math::stats {val1 val2 args} 1] test math-8.3 { simple math::stats } { foreach {a b c} [ math::stats 100 100 100 110 ] { break } set a [ expr round($a) ] set b [ expr round($b) ] set c [ expr round($c) ] list $a $b $c | | | 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | } [tcltest::wrongNumArgs math::stats {val1 val2 args} 1] test math-8.3 { simple math::stats } { foreach {a b c} [ math::stats 100 100 100 110 ] { break } set a [ expr round($a) ] set b [ expr round($b) ] set c [ expr round($c) ] list $a $b $c } {103 5 5} test math-9.1 { math::integrate, insufficient data points } { catch { math::integrate {1 10 2 20 3 30 4 40} } msg set msg } "at least 5 x,y pairs must be given" test math-9.2 { simple math::integrate } { math::integrate {1 10 2 20 3 30 4 40 5 50 6 60 7 70 8 80 9 90 10 100} |
︙ | ︙ |
Changes to modules/math/math_geometry.man.
︙ | ︙ | |||
607 608 609 610 611 612 613 | [list_begin enumerated] [enum] [uri http:/wiki.tcl.tk/12070 {Polygon Intersection}] [enum] [uri http://en.wikipedia.org/wiki/Line-line_intersection] [enum] [uri http://local.wasp.uwa.edu.au/~pbourke/geometry/lineline2d/] [list_end] [vset CATEGORY {math :: geometry}] | | | 607 608 609 610 611 612 613 614 615 | [list_begin enumerated] [enum] [uri http:/wiki.tcl.tk/12070 {Polygon Intersection}] [enum] [uri http://en.wikipedia.org/wiki/Line-line_intersection] [enum] [uri http://local.wasp.uwa.edu.au/~pbourke/geometry/lineline2d/] [list_end] [vset CATEGORY {math :: geometry}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/misc.tcl.
1 2 3 4 5 6 7 8 | # math.tcl -- # # Collection of math functions. # # Copyright (c) 1998-2000 by Ajuba Solutions. # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | # math.tcl -- # # Collection of math functions. # # Copyright (c) 1998-2000 by Ajuba Solutions. # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # # RCS: @(#) $Id: misc.tcl,v 1.6 2005/10/10 14:02:47 arjenmarkus Exp $ package require Tcl 8.2 ;# uses [lindex $l end-$integer] namespace eval ::math { } # ::math::cov -- |
︙ | ︙ | |||
32 33 34 35 36 37 38 | set sum [ expr { $sum+$val } ] } set mean [ expr { $sum/$N } ] set sigma_sq 0 foreach val [ concat $val1 $val2 $args ] { set sigma_sq [ expr { $sigma_sq+pow(($val-$mean),2) } ] } | | | | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | set sum [ expr { $sum+$val } ] } set mean [ expr { $sum/$N } ] set sigma_sq 0 foreach val [ concat $val1 $val2 $args ] { set sigma_sq [ expr { $sigma_sq+pow(($val-$mean),2) } ] } set sigma_sq [ expr { $sigma_sq/($N-1) } ] set sigma [ expr { sqrt($sigma_sq) } ] if { $mean != 0.0 } { set cov [ expr { ($sigma/$mean)*100 } ] } else { return -code error -errorinfo "Cov undefined for data with zero mean" -errorcode {ARITH DOMAIN} } set cov } |
︙ | ︙ | |||
70 71 72 73 74 75 76 | return $prev1 } } # ::math::integrate -- # # calculate the area under a curve defined by a set of (x,y) data pairs. | | | | | | | | | | | | | | | | | | 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 | return $prev1 } } # ::math::integrate -- # # calculate the area under a curve defined by a set of (x,y) data pairs. # the x data must increase monotonically throughout the data set for the # calculation to be meaningful, therefore the monotonic condition is # tested, and an error is thrown if the x value is found to be # decreasing. # # Arguments: # xy_pairs list of x y pairs (eg, 0 0 10 10 20 20 ...); at least 5 # data pairs are required, and if the number of data # pairs is even, a padding value of (x0, 0) will be # added. # # Results: # result A two-element list consisting of the area and error # bound (calculation is "Simpson's rule") proc ::math::integrate { xy_pairs } { set length [ llength $xy_pairs ] if { $length < 10 } { return -code error "at least 5 x,y pairs must be given" } ;## are we dealing with x,y pairs? if { [ expr {$length % 2} ] } { return -code error "unmatched xy pair in input" } ;## are there an even number of pairs? Augment. if { ! [ expr {$length % 4} ] } { set xy_pairs [ concat [ lindex $xy_pairs 0 ] 0 $xy_pairs ] } set x0 [ lindex $xy_pairs 0 ] set x1 [ lindex $xy_pairs 2 ] set xn [ lindex $xy_pairs end-1 ] set xnminus1 [ lindex $xy_pairs end-3 ] if { $x1 < $x0 } { return -code error "monotonicity broken by x1" } if { $xn < $xnminus1 } { return -code error "monotonicity broken by xn" } ;## handle the assymetrical elements 0, n, and n-1. set sum [ expr {[ lindex $xy_pairs 1 ] + [ lindex $xy_pairs end ]} ] set sum [ expr {$sum + (4*[ lindex $xy_pairs end-2 ])} ] set data [ lrange $xy_pairs 2 end-4 ] set xmax $x1 set i 1 foreach {x1 y1 x2 y2} $data { incr i if { $x1 < $xmax } { return -code error "monotonicity broken by x$i" } set xmax $x1 incr i if { $x2 < $xmax } { return -code error "monotonicity broken by x$i" } set xmax $x2 set sum [ expr {$sum + (4*$y1) + (2*$y2)} ] } if { $xmax > $xnminus1 } { return -code error "monotonicity broken by xn-1" } set h [ expr { ( $xn - $x0 ) / $i } ] set area [ expr { ( $h / 3.0 ) * $sum } ] set err_bound [ expr { ( ( $xn - $x0 ) / 180.0 ) * pow($h,4) * $xn } ] return [ list $area $err_bound ] } # ::math::max -- # # Return the maximum of two or more values # |
︙ | ︙ | |||
281 282 283 284 285 286 287 | set sum [ expr { $sum+$val } ] } set mean [ expr { $sum/$N } ] set sigma_sq 0 foreach val [ concat $val1 $val2 $args ] { set sigma_sq [ expr { $sigma_sq+pow(($val-$mean),2) } ] } | | | | | | 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 | set sum [ expr { $sum+$val } ] } set mean [ expr { $sum/$N } ] set sigma_sq 0 foreach val [ concat $val1 $val2 $args ] { set sigma_sq [ expr { $sigma_sq+pow(($val-$mean),2) } ] } set sigma_sq [ expr { $sigma_sq/($N-1) } ] set sigma [ expr { sqrt($sigma_sq) } ] set sigma } # ::math::stats -- # # Return the mean, standard deviation, and coefficient of variation as # percent, as a list. # # Arguments: # val1 first value # val2 first value # args all other values # # Results: # {mean stddev coefvar} proc ::math::stats {val1 val2 args} { set sum [ expr { $val1+$val2 } ] set N [ expr { [ llength $args ] + 2 } ] foreach val $args { set sum [ expr { $sum+$val } ] } set mean [ expr { $sum/double($N) } ] set sigma_sq 0 foreach val [ concat $val1 $val2 $args ] { set sigma_sq [ expr { $sigma_sq+pow(($val-$mean),2) } ] } set sigma_sq [ expr { $sigma_sq/double($N-1) } ] set sigma [ expr { sqrt($sigma_sq) } ] set cov [ expr { ($sigma/$mean)*100 } ] return [ list $mean $sigma $cov ] } # ::math::sum -- # |
︙ | ︙ |
Changes to modules/math/numtheory.dtx.
︙ | ︙ | |||
1761 1762 1763 1764 1765 1766 1767 | % \section*{Closings} % % \begin{tcl} %<*man> [list_end] [vset CATEGORY {math :: numtheory}] | | | 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 | % \section*{Closings} % % \begin{tcl} %<*man> [list_end] [vset CATEGORY {math :: numtheory}] [include ../common-text/feedback.inc] [manpage_end] %</man> % \end{tcl} % % \begin{tcl} %<test_common>testsuiteCleanup % \end{tcl} |
︙ | ︙ |
Changes to modules/math/numtheory.man.
︙ | ︙ | |||
175 176 177 178 179 180 181 | [list_end] [call [cmd math::numtheory::numberPrimesGauss] [arg N]] Estimate the number of primes according the formula by Gauss. [list_begin arguments] [arg_def integer N in] | | | | > > > > > > > > | | 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 | [list_end] [call [cmd math::numtheory::numberPrimesGauss] [arg N]] Estimate the number of primes according the formula by Gauss. [list_begin arguments] [arg_def integer N in] Number in question, should be larger than 0 [list_end] [call [cmd math::numtheory::numberPrimesLegendre] [arg N]] Estimate the number of primes according the formula by Legendre. [list_begin arguments] [arg_def integer N in] Number in question, should be larger than 0 [list_end] [call [cmd math::numtheory::numberPrimesLegendreModified] [arg N]] Estimate the number of primes according the modified formula by Legendre. [list_begin arguments] [arg_def integer N in] Number in question, should be larger than 0 [list_end] [call [cmd math::numtheory::differenceNumberPrimesLegendreModified] [arg lower] [arg upper]] Estimate the number of primes between tow limits according the modified formula by Legendre. [list_begin arguments] [arg_def integer lower in] Lower limit for the primes, should be larger than 0 [arg_def integer upper in] Upper limit for the primes, should be larger than 0 [list_end] [list_end] [vset CATEGORY {math :: numtheory}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/numtheory.test.
|
| | | | | > > > > > > | 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 | ## ## This is the file `numtheory.test', ## generated with the SAK utility ## (sak docstrip/regen). ## ## The original source files were: ## ## numtheory.dtx (with options: `test test_common') ## ## In other words: ## ************************************** ## * This Source is not the True Source * ## ************************************** ## the true source is the file from which this one was generated. ## source [file join\ [file dirname [file dirname [file join [pwd] [info script]]]]\ devtools testutilities.tcl] testsNeedTcl 8.5 testsNeedTcltest 2.1 testing { useLocal numtheory.tcl math::numtheory } proc compareRounded {expected actual} { return [expr {int($expected-$actual) == 0} ] } ::tcltest::customMatch rounded compareRounded test prime_trialdivision-1 "Trial division of 1" -body { ::math::numtheory::prime_trialdivision 1 } -returnCodes 2 -result 0 test prime_trialdivision-2 "Trial division of 2" -body { ::math::numtheory::prime_trialdivision 2 } -returnCodes 2 -result 1 test prime_trialdivision-3 "Trial division of 6" -body { |
︙ | ︙ | |||
203 204 205 206 207 208 209 210 | ::math::numtheory::isprime 118670087467 -randommr 500 } -result on -cleanup { namespace eval ::math::numtheory { rename Miller--Rabin "" rename _orig_Miller--Rabin Miller--Rabin } } testsuiteCleanup | > > > > > > > > > > > > > > > > > > > > > | | | 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 | ::math::numtheory::isprime 118670087467 -randommr 500 } -result on -cleanup { namespace eval ::math::numtheory { rename Miller--Rabin "" rename _orig_Miller--Rabin Miller--Rabin } } test numberPrimes-1.0 "Number of primes below 100" -match rounded -body { set result [::math::numtheory::numberPrimesLegendre 100] } -result 28 test numberPrimes-1.1 "Number of primes below 100 (modified)" -match rounded -body { set result [::math::numtheory::numberPrimesLegendreModified 100] } -result 28 test numberPrimes-1.2 "Number of primes below 0 (modified)" -body { set result [::math::numtheory::numberPrimesLegendreModified 0] } -result "The limit must be larger than 1" -returnCodes 1 test numberPrimes-1.3 "Number of primes between 100 and 200" -match rounded -body { set result [::math::numtheory::differenceNumberPrimesLegendreModified 100 200] } -result 19 test numberPrimes-1.4 "Number of primes between 100 and 0 - error expected" -body { set result [::math::numtheory::differenceNumberPrimesLegendreModified 100 0] } -result "The upper limit must be larger than 1" -returnCodes 1 testsuiteCleanup ## ## ## End of file `numtheory.test'. |
Changes to modules/math/optimize.man.
︙ | ︙ | |||
317 318 319 320 321 322 323 | [para] The theory of linear programming is the subject of many a text book and the Simplex algorithm that is implemented here is the best-known method to solve this type of problems, but it is not the only one. [vset CATEGORY {math :: optimize}] | | | 317 318 319 320 321 322 323 324 325 | [para] The theory of linear programming is the subject of many a text book and the Simplex algorithm that is implemented here is the best-known method to solve this type of problems, but it is not the only one. [vset CATEGORY {math :: optimize}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/pca.man.
︙ | ︙ | |||
128 129 130 131 132 133 134 | [section EXAMPLE] TODO: NIST example [vset CATEGORY PCA] | | | 128 129 130 131 132 133 134 135 136 | [section EXAMPLE] TODO: NIST example [vset CATEGORY PCA] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/pkgIndex.tcl.
︙ | ︙ | |||
26 27 28 29 30 31 32 33 34 | package ifneeded math::linearalgebra 1.1.6 [list source [file join $dir linalg.tcl]] package ifneeded math::calculus::symdiff 1.0.1 [list source [file join $dir symdiff.tcl]] package ifneeded math::bigfloat 2.0.2 [list source [file join $dir bigfloat2.tcl]] package ifneeded math::numtheory 1.1.1 [list source [file join $dir numtheory.tcl]] package ifneeded math::decimal 1.0.3 [list source [file join $dir decimal.tcl]] package ifneeded math::geometry 1.3.0 [list source [file join $dir geometry.tcl]] package ifneeded math::trig 1.0 [list source [file join $dir trig.tcl]] if {![package vsatisfies [package require Tcl] 8.6]} {return} | > | | 26 27 28 29 30 31 32 33 34 35 36 37 | package ifneeded math::linearalgebra 1.1.6 [list source [file join $dir linalg.tcl]] package ifneeded math::calculus::symdiff 1.0.1 [list source [file join $dir symdiff.tcl]] package ifneeded math::bigfloat 2.0.2 [list source [file join $dir bigfloat2.tcl]] package ifneeded math::numtheory 1.1.1 [list source [file join $dir numtheory.tcl]] package ifneeded math::decimal 1.0.3 [list source [file join $dir decimal.tcl]] package ifneeded math::geometry 1.3.0 [list source [file join $dir geometry.tcl]] package ifneeded math::trig 1.0 [list source [file join $dir trig.tcl]] package ifneeded math::quasirandom 1.0 [list source [file join $dir quasirandom.tcl]] if {![package vsatisfies [package require Tcl] 8.6]} {return} package ifneeded math::exact 1.0.1 [list source [file join $dir exact.tcl]] package ifneeded math::PCA 1.0 [list source [file join $dir pca.tcl]] |
Changes to modules/math/polynomials.man.
︙ | ︙ | |||
211 212 213 214 215 216 217 | To recognise that a polynomial definition is indeed a correct definition, it consists of a list of two elements: the keyword "POLYNOMIAL" and the list of coefficients in descending order. The latter makes it easier to implement Horner's rule. [vset CATEGORY {math :: polynomials}] | | | 211 212 213 214 215 216 217 218 219 | To recognise that a polynomial definition is indeed a correct definition, it consists of a list of two elements: the keyword "POLYNOMIAL" and the list of coefficients in descending order. The latter makes it easier to implement Horner's rule. [vset CATEGORY {math :: polynomials}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/primes.tcl.
|
| | | | | | > | 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 | ## ## This is the file `primes.tcl', ## generated with the SAK utility ## (sak docstrip/regen). ## ## The original source files were: ## ## numtheory.dtx (with options: `pkg_primes pkg_common') ## ## In other words: ## ************************************** ## * This Source is not the True Source * ## ************************************** ## the true source is the file from which this one was generated. ## # Copyright (c) 2010 by Lars Hellstrom. All rights reserved. # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # primes.tcl -- # Provide additional procedures for the number theory package # namespace eval ::math::numtheory { variable primes {2 3 5 7 11 13 17} variable nextPrimeCandidate 19 variable nextPrimeIncrement 1 ;# Examine numbers 6n+1 and 6n+5 namespace export firstNprimes primesLowerThan primeFactors uniquePrimeFactors factors \ totient moebius legendre jacobi gcd lcm \ numberPrimesGauss numberPrimesLegendre numberPrimesLegendreModified \ differenceNumberPrimesLegendreModified } # ComputeNextPrime -- # Determine the next prime # # Arguments: # None |
︙ | ︙ | |||
461 462 463 464 465 466 467 | # proc ::math::numtheory::numberPrimesLegendreModified {limit} { if { $limit <= 1 } { return -code error "The limit must be larger than 1" } expr {$limit / (log($limit) - 1.08366)} } | > > > > > > > > > > > > > > > > > > > > > > > > > > > | | | 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 | # proc ::math::numtheory::numberPrimesLegendreModified {limit} { if { $limit <= 1 } { return -code error "The limit must be larger than 1" } expr {$limit / (log($limit) - 1.08366)} } # differenceNumberPrimesLegendreModified -- # Return the approximate difference number of primes # between a lower and higher limit as given values # for approximate number of primes based on the # modified formula by Legendre # # Arguments: # limit1 The lower limit for the interval, largest prime to be included in the l.limit # limit2 The upper limit for the interval, largest prime to be included in the u.mlimit # # Returns: # Approximate difference number of primes # proc ::math::numtheory::differenceNumberPrimesLegendreModified {limit1 limit2} { if { $limit1 <= 1 } { return -code error "The lower limit must be larger than 1" } if { $limit2 <= 1 } { return -code error "The upper limit must be larger than 1" } set aa [::math::numtheory::numberPrimesLegendreModified [expr ($limit1)]] set bb [::math::numtheory::numberPrimesLegendreModified [expr ($limit2)]] expr {abs($bb-$aa)} } ## ## ## End of file `primes.tcl'. |
Changes to modules/math/qcomplex.man.
︙ | ︙ | |||
294 295 296 297 298 299 300 | The complex power to be used [list_end] [list_end] [vset CATEGORY {math :: complexnumbers}] | | | 294 295 296 297 298 299 300 301 302 | The complex power to be used [list_end] [list_end] [vset CATEGORY {math :: complexnumbers}] [include ../common-text/feedback.inc] [manpage_end] |
Added modules/math/quasirandom.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [vset VERSION 1] [manpage_begin math::quasirandom n [vset VERSION]] [keywords {quasi-random}] [keywords mathematics] [moddesc {Tcl Math Library}] [titledesc {Quasi-random points for integration and Monte Carlo type methods}] [category Mathematics] [require Tcl 8.5] [require TclOO] [require math::quasirandom [vset VERSION]] [description] [para] In many applications pseudo-random numbers and pseudo-random points in a (limited) sample space play an important role. For instance in any type of Monte Carlo simulation. Pseudo-random numbers, however, may be too random and as a consequence a large number of data points is required to reduce the error or fluctuation in the results to the desired value. [para] Quasi-random numbers can be used as an alternative: instead of "completely" arbitrary points, points are generated that are diverse enough to cover the entire sample space in a more or less uniform way. As a consequence convergence to the limit can be much faster, when such quasi-random numbers are well-chosen. [para] The package defines a [term class] "qrpoint" that creates a command to generate quasi-random points in 1, 2 or more dimensions. The command can either generate separate points, so that they can be used in a user-defined algorithm or use these points to calculate integrals of functions defined over 1, 2 or more dimensions. It also holds several other common algorithms. (NOTE: these are not implemented yet) [para] One particular characteristic of the generators is that there are no tuning parameters involved, which makes the use particularly simple. [section "COMMANDS"] A quasi-random point generator is created using the [term qrpoint] class: [list_begin definitions] [call [cmd "::math::quasirandom::qrpoint create"] [arg NAME] [arg DIM] [opt ARGS]] This command takes the following arguments: [list_begin arguments] [arg_def string NAME] The name of the command to be created (alternatively: the [term new] subcommand will generate a unique name) [arg_def integer/string DIM] The number of dimensions or one of: "circle", "disk", "sphere" or "ball" [arg_def strings ARGS] Zero or more key-value pairs. The supported options are: [list_begin itemized] [item] [term {-start index}]: The index for the next point to be generated (default: 1) [item] [term {-evaluations number}]: The number of evaluations to be used by default (default: 100) [list_end] [list_end] [list_end] The points that are returned lie in the hyperblock [lb]0,1[lb]^n (n the number of dimensions) or on the unit circle, within the unit disk, on the unit sphere or within the unit ball. [para] Each generator supports the following subcommands: [list_begin definitions] [call [cmd "gen next"]] Return the coordinates of the next quasi-random point [nl] [call [cmd "gen set-start"] [arg index]] Reset the index for the next quasi-random point. This is useful to control which list of points is returned. Returns the new or the current value, if no value is given. [nl] [call [cmd "gen set-evaluations"] [arg number]] Reset the default number of evaluations in compound algorithms. Note that the actual number is the smallest 4-fold larger or equal to the given number. (The 4-fold plays a role in the detailed integration routine.) [nl] [call [cmd "gen integral"] [arg func] [arg minmax] [arg args]] Calculate the integral of the given function over the block (or the circle, sphere etc.) [list_begin arguments] [arg_def string func] The name of the function to be integrated [arg_def list minmax] List of pairs of minimum and maximum coordinates. This can be used to map the quasi-random coordinates to the desired hyper-block. [nl] If the space is a circle, disk etc. then this argument should be a single value, the radius. The circle, disk, etc. is centred at the origin. If this is not what is required, then a coordinate transformation should be made within the function. [arg_def strings args] Zero or more key-value pairs. The following options are supported: [list_begin itemized] [item] [term {-evaluations number}]: The number of evaluations to be used. If not specified use the default of the generator object. [list_end] [list_end] [list_end] [section TODO] Implement other algorithms and variants [para] Implement more unit tests. [para] Comparison to pseudo-random numbers for integration. [section References] Various algorithms exist for generating quasi-random numbers. The generators created in this package are based on: [uri http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/] [manpage_end] |
Added modules/math/quasirandom.tcl.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # quasirandom.tcl -- # Generate quasi-random points in n dimensions and provide simple # methods to evaluate an integral # # Note: provide a OO-style interface # # TODO: integral-detailed, minimum, maximum # # Based on the blog "The Unreasonable Effectiveness of Quasirandom Sequences" by Martin Roberts, # http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/ # package require Tcl 8.5 package require TclOO package provide math::quasirandom 1.0 namespace eval ::math::quasirandom { # qrpoints -- # Create the class # ::oo::class create qrpoints { # constructor -- # Construct a new instance of the qrpoints class # # Arguments: # dim Number of dimensions, or one of: circle, disk, sphere, ball # args Zero or more key-value pairs: # -start - start the generation with the given multiplier (integer) # -evaluations - default number of evaluations for the integration # (possibly others as well) # constructor {dimin args} { my variable dim my variable coord_factors my variable step my variable evaluations my variable use_radius my variable effective_dim if { ( ![string is integer -strict $dimin] || $dimin <= 0 ) && $dimin ni {circle disk sphere ball} } { return -code error "The dimension argument should be a positive integer value or one of circle, disk, sphere or ball" } set use_radius 1 switch -- $dimin { "circle" { set dim 1 set effective_dim 2 ::oo::objdefine [self] { forward next my CircleNext forward Volume my CircleVolume } } "disk" { set dim 2 set effective_dim 2 ::oo::objdefine [self] { forward next my DiskNext forward Volume my DiskVolume } } "sphere" { set dim 2 set effective_dim 3 ::oo::objdefine [self] { forward next my SphereNext forward Volume my SphereVolume } } "ball" { set dim 3 set effective_dim 3 ::oo::objdefine [self] { forward next my BallNext forward Volume my BallVolume } } default { set dim $dimin set use_radius 0 ::oo::objdefine [self] { forward next my PlainNext forward Volume my PlainVolume } } } set step 1 set evaluations 100 set coord_factors [::math::quasirandom::CoordFactors $dim] foreach {key value} $args { switch -- $key { "-start" { my set-step $value } "-evaluations" { if { ![string is -strict integer $value] || $value <= 0 } { return -code error "The value for the option $key should be a positive integer value" } my set-evaluations $value } default { return -code error "Unknown option: $key -- value: $value" } } } } # PlainNext -- # Generate the next point - for a hyperblock # method PlainNext {} { my variable step my variable coord_factors set coords {} foreach f $coord_factors { lappend coords [expr {fmod( $f * $step, 1.0 )}] } incr step return $coords } # PlainVolume -- # Calculate the volume of a hyperblock # # Arguments: # minmax List of minimum and maximum per dimension # # Returns: # The volume # method PlainVolume {minmax} { set volume 1.0 foreach range $minmax { lassign $range xmin xmax set volume [expr {$volume * ($xmax-$xmin)}] } return $volume } # CircleNext -- # Generate the next point on a unit circle # method CircleNext {} { set f [lindex [my PlainNext] 0] set rad [expr {2.0 * acos(-1.0) * $f}] set coords [list [expr {cos($rad)}] [expr {sin($rad)}]] return $coords } # CircleVolume -- # Calculate the "volume" of the unit circle # # Arguments: # radius Radius of the circle # method CircleVolume {radius} { return [expr {$radius * 2.0*cos(-1.0)}] } # DiskNext -- # Generate the next point on a unit disk # method DiskNext {} { while {1} { set coords [my PlainNext] lassign $coords x y if { hypot($x-0.5,$y-0.5) <= 0.25 } { set coords [list [expr {2.0*$x-1.0}] [expr {2.0*$y-1.0}]] break } } return $coords } # DiskVolume -- # Calculate the "volume" of the unit disk # # Arguments: # radius Radius of the disk # method DiskVolume {radius} { return [expr {$radius**2 * cos(-1.0)}] } # BallNext -- # Generate the next point on a unit ball # method BallNext {} { while {1} { set coords [my PlainNext] lassign $coords x y z set r [expr {($x-0.5)**2 + ($y-0.5)**2 + ($z-0.5)**2}] if { $r <= 0.25 } { set coords [list [expr {2.0*$x-1.0}] [expr {2.0*$y-1.0}] [expr {2.0*$z-1.0}]] break } } return $coords } # BallVolume -- # Calculate the volume of the unit ball # # Arguments: # radius Radius of the ball # method BallVolume {radius} { return [expr {4.0/3.0 * $radius**3 * cos(-1.0)}] } # SphereNext -- # Generate the next point on a unit sphere # method SphereNext {} { set coords [my PlainNext] lassign $coords u v set phi [expr {2.0 * acos(-1.0) * $v}] set lambda [expr {acos(2.0 * $u - 1.0) + 0.5 * acos(-1.0)}] set x [expr {cos($lambda) * cos($phi)}] set y [expr {cos($lambda) * sin($phi)}] set z [expr {sin($lambda)}] return [list $x $y $z] } # SphereVolume -- # Calculate the "volume" of the unit sphere # # Arguments: # radius Radius of the sphere # method SphereVolume {radius} { return [expr {4.0 * $radius**2 * cos(-1.0)}] } # set-step -- # Set the first step to be used # method set-step {{value ""}} { my variable step if { $value eq "" } { return $step } if { ![string is integer -strict $value] } { return -code error "The value for the option $key should be an integer value" } set step [expr {int($value)}] } # set-evaluations -- # Set the number of evaluations for integration # method set-evaluations {{value ""}} { my variable evaluations if { $value eq "" } { return $evaluations } if { ![string is integer -strict $value] || $value <= 0 } { return -code error "The value for the option $key should be a positive integer value" } set evaluations [expr {4*int(($value+3)/4)}] ;# Make sure it is a 4-fold } # integral -- # Evaluate the integral of a function over a given (rectangular) domain # # Arguments: # func Function to be integrated # minmax List of minimum and maximum bounds for each coordinate # args Key-value pair: number of evaluations # # Returns: # Estimate of the integral based on "evaluations" evaluations # Note: no error estimate # method integral {func minmax args} { my variable dim my variable step my variable coord_factors my variable evaluations my variable use_radius my variable effective_dim set evals $evaluations set func [uplevel 1 [list namespace which -command $func]] foreach {key value} $args { switch -- $key { "-evaluations" { if { ![string is integer -strict $value] || $value <= 0 } { return -code error "The value for the option $key should be a positive integer value" } set evals $value ;# Local only! } default { return -code error "Unknown option: $key -- value: $value" } } } if { ! $use_radius } { if { [llength $minmax] != $dim } { return -code error "The number of ranges (minmax) should be equal to the dimension ($dim)" } else { set volume [my Volume $minmax] } } else { if { ! [string is double $minmax] } { return -code error "For a circle, disk, sphere or ball only the radius should be given" } else { set radius $minmax set minmax [lrepeat $effective_dim [list 0.0 $radius]] set volume [my Volume $radius] } } set sum 0.0 for {set i 0} {$i < $evals} {incr i} { set coords {} foreach c [my next] range $minmax { lassign $range xmin xmax lappend coords [expr {$xmin + ($xmax-$xmin) * $c}] } set sum [expr {$sum + [$func $coords]}] } return [expr {$sum * $volume / $evals}] } # integral-detailed -- # Evaluate the integral of a function over a given (rectangular) domain # and provide detailed information # # Arguments: # func Function to be integrated # minmax List of minimum and maximum bounds for each coordinate # args Key-value pair: number of evaluations # # Returns: # Dictionary of: # -estimate value - estimate of the integral # -evaluations number - total number of evaluations # -error value - estimate of the error # -rawvalues list - list of raw values obtained for the integral # method integral-detailed {func minmax args} { my variable evaluations set evals $evaluations set func [uplevel 1 [list namespace which -command $func]] foreach {key value} $args { switch -- $key { "-evaluations" { if { ![string is integer -strict $value] || $value <= 0 } { return -code error "The value for the option $key should be a positive integer value" } set evals $value ;# Local only! } default { return -code error "Unknown option: $key -- value: $value" } } } lappend args -evaluations [expr {($evals+3)/4}] for {set i 0} {$i < 4} {incr i} { lappend rawvalues [my integral $func $minmax {*}$args] } set sum 0.0 set sqsum 0.0 foreach value $rawvalues { set sum [expr {$sum + $value}] set sqsum [expr {$sqsum + $value**2}] } set stdev [expr {sqrt(($sqsum - $sum**2/4.0)/3.0)}] set sum [expr {$sum / 4.0}] # Standard error of mean return [dict create -estimate $sum -error [expr {$stdev/2.0}] -rawvalues $rawvalues -evaluations [expr {4*(($evals+3)/4)}]] } } ;# End of class } ;# End of namespace eval # CoordFactors -- # Determine the factors for the coordinates # # Arguments: # dim Number of dimensions # proc ::math::quasirandom::CoordFactors {dim} { set n [expr {$dim + 1}] set f 1.0 for {set i 0} {$i < 10} {incr i} { set f [expr {$f - ($f**$n-$f-1.0) / ($n*$f**($n-1)-1.0)}] } set factors {} set af 1.0 for {set i 0} {$i < $dim} {incr i} { set af [expr {$af/$f}] lappend factors $af } return $factors } # End of code for package # -------------------------------------------- # test -- # if {0} { ::math::quasirandom::qrpoints create square 2 puts [square next] puts [square next] puts [square next] proc f {coords} { lassign $coords x y expr {$x**2+$y**2} } proc g {coords} { lassign $coords x y expr {(1.0-cos($x))**2 * (1.0-cos($y))**2} } # Print four estimates - should not deviate too much from 10.0 puts [square integral f {{0 1} {0 3}}] puts [square integral f {{0 1} {0 3}}] puts [square integral f {{0 1} {0 3}}] puts [square integral f {{0 1} {0 3}}] # Print a sequence of estimates - should converge to (3pi/2)**2 foreach n {20 40 100 300 1000} { square set-evaluations $n puts "$n: [square integral g [list [list 0.0 [expr {acos(-1)}]] [list 0.0 [expr {acos(-1)}]]]]" } ::math::quasirandom::qrpoints create block 3 puts [block next] puts "Circle ..." ::math::quasirandom::qrpoints create circle circle puts [circle next] puts [circle next] puts [circle next] # Test values for CoordFactors # dim = 1: 1.6180339887498948482045... # dim = 2: 1.3247179572447460259609... # dim = 3: 1.2207440846057594753616... set f [::math::quasirandom::CoordFactors 1] puts 1.6180339887498948482045... puts [expr {1.0/$f}] set f [lindex [::math::quasirandom::CoordFactors 2] 0] puts 1.3247179572447460259609... puts [expr {1.0/$f}] set f [lindex [::math::quasirandom::CoordFactors 3] 0] puts 1.2207440846057594753616... puts [expr {1.0/$f}] } |
Added modules/math/quasirandom.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # quasirandom.test -- # Tests for the quasi-random numbers package # source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.5 testsNeedTcltest 2.1 testing { useLocal quasirandom.tcl math::quasirandom } # # Functions for integration tests # proc const {coords} { return 1.0 } proc fx {coords} { set x [lindex $coords 0] return $x } proc fy {coords} { set y [lindex $coords 1] return $y } proc fz {coords} { set z [lindex $coords 2] return $z } proc fxyz4 {coords} { lassign $coords x y z return [expr {($x*$y*$z)**4}] } # # Auxiliary proc # proc equalCoords {coords1 coords2} { set equal 1 foreach c1 $coords1 c2 $coords2 { if { $c1 != $c2 } { set equal 0 break } } return $equal } # # Create and register (in that order!) custom matching procedures # proc matchTolerant { expected actual } { set match 1 foreach a $actual e $expected { if { $e != 0.0 } { if { abs($e-$a)>1.0e-7*abs($e) && abs($e-$a)>1.0e-7*abs($a) } { set match 0 break } } else { if { abs($a) > 1.0e-7 } { set match 0 } } } return $match } proc matchOnePercent { expected actual } { set match 1 foreach a $actual e $expected { if { $e != 0.0 } { if { abs($e-$a)>1.0e-2*abs($e) && abs($e-$a)>1.0e-2*abs($a) } { set match 0 break } } else { if { abs($a) > 1.0e-2 } { set match 0 } } } return $match } ::tcltest::customMatch tolerant matchTolerant ::tcltest::customMatch error1percent matchOnePercent ::tcltest::customMatch equal equalCoords # # Testing CoordFactors: the basis of the algorithm # Note: exact matching # test "Quasirandom-0.1" "Check basic factor for 1 dimension" -body { set f [::math::quasirandom::CoordFactors 1] return [expr {1.0/$f}] } -result 1.618033988749895 test "Quasirandom-0.2" "Check basic factor for 2 dimensions" -body { set f [lindex [::math::quasirandom::CoordFactors 2] 0] return [expr {1.0/$f}] } -result 1.324717957244746 test "Quasirandom-0.3" "Check basic factor for 3 dimensions" -body { set f [lindex [::math::quasirandom::CoordFactors 3] 0] return [expr {1.0/$f}] } -result 1.2207440846057596 test "Quasirandom-0.4" "Check number of factors for 10 dimensions" -body { return [llength [::math::quasirandom::CoordFactors 10]] } -result 10 # # Basic interface to the qrpoints class # test "Quasirandom-1.0" "Simple QR generator for two dimensions" -match tolerant -body { ::math::quasirandom::qrpoints create simple 2 return [simple next] } -result {0.7548776662466927 0.5698402909980532} -cleanup {simple destroy} test "Quasirandom-1.1" "Simple QR generator - negative dimension" -body { ::math::quasirandom::qrpoints create simple -1 } -returnCodes {error} -result {The dimension argument should be a positive integer value or one of circle, disk, sphere or ball} test "Quasirandom-1.2" "Simple QR generator - set start" -body { ::math::quasirandom::qrpoints create simple 2 ::math::quasirandom::qrpoints create simple2 2 -start 2 simple next set coords [simple next] set coords2 [simple2 next] ;# Should be equal to the second point for the [simple] generator equalCoords $coords $coords2 } -result 1 -cleanup {simple destroy; simple2 destroy} # # Test simple methods # test "Quasirandom-2.1" "set-step sets and returns the value" -match equal -body { ::math::quasirandom::qrpoints create simple 2 simple set-step 100 } -result 100 -cleanup {simple destroy} test "Quasirandom-2.2" "set-evaluations sets and returns the value" -match equal -body { ::math::quasirandom::qrpoints create simple 2 simple set-evaluations 100 } -result 100 -cleanup {simple destroy} test "Quasirandom-2.3" "set-step returns the value" -match equal -body { ::math::quasirandom::qrpoints create simple 2 simple set-step 100 simple set-step } -result 100 -cleanup {simple destroy} test "Quasirandom-2.4" "set-evaluations returns the value" -match equal -body { ::math::quasirandom::qrpoints create simple 2 simple set-evaluations 100 simple set-evaluations } -result 100 -cleanup {simple destroy} # # Test of bounds on points # test "Quasirandom-3.1" "Points should fall within block" -body { ::math::quasirandom::qrpoints create simple 10 set correct_bound 1 for {set i 0} {$i < 100} {incr i} { set coords [simple next] foreach c $coords { if { $c < 0.0 || $c > 1.0 } { set correct_bound 0 break } } } return $correct_bound } -result 1 -cleanup {simple destroy} test "Quasirandom-3.2" "Points should fall on a circle" -match tolerant -body { ::math::quasirandom::qrpoints create simple circle set correct_bound 1 set radii {} for {set i 0} {$i < 100} {incr i} { set coords [simple next] lassign $coords x y lappend radii [expr {hypot($x,$y)}] } return $radii } -result [lrepeat 100 1.0] -cleanup {simple destroy} test "Quasirandom-3.3" "Points should fall within a disk" -match equal -body { ::math::quasirandom::qrpoints create simple disk set correct_bounds {} for {set i 0} {$i < 100} {incr i} { set coords [simple next] lassign $coords x y lappend correct_bounds [expr {hypot($x,$y) <= 1.0}] } return $correct_bounds } -result [lrepeat 100 1] -cleanup {simple destroy} test "Quasirandom-3.4" "Points should fall on a sphere" -match tolerant -body { ::math::quasirandom::qrpoints create simple sphere set correct_bound 1 set radii {} for {set i 0} {$i < 100} {incr i} { set coords [simple next] lassign $coords x y z lappend radii [expr {sqrt($x**2 + $y**2 + $z**2)}] } return $radii } -result [lrepeat 100 1.0] -cleanup {simple destroy} test "Quasirandom-3.5" "Points should fall within a ball" -match equal -body { ::math::quasirandom::qrpoints create simple ball set correct_bounds {} for {set i 0} {$i < 100} {incr i} { set coords [simple next] lassign $coords x y lappend correct_bounds [expr {sqrt($x**2 + $y**2 + $z**2) <= 1.0}] } return $correct_bounds } -result [lrepeat 100 1] -cleanup {simple destroy} # # Test of integral methods # # Integrating a constant function means the result is the volume # test "Quasirandom-4.1" "Integrate constant function - volume = 1" -match tolerant -body { ::math::quasirandom::qrpoints create simple 3 set result [simple integral const {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] } -result 1.0 -cleanup {simple destroy} test "Quasirandom-4.2" "Integrate constant function - volume = 8" -match tolerant -body { ::math::quasirandom::qrpoints create simple 3 set result [simple integral const {{0.0 2.0} {0.0 2.0} {0.0 2.0}}] } -result 8.0 -cleanup {simple destroy} test "Quasirandom-4.3" "Integrate constant function - circle" -match tolerant -body { ::math::quasirandom::qrpoints create simple circle set result [simple integral const 2.0] } -result [expr {2.0 * 2.0 * cos(-1.0)}] -cleanup {simple destroy} test "Quasirandom-4.3" "Integrate constant function - disk" -match tolerant -body { ::math::quasirandom::qrpoints create simple disk set result [simple integral const 2.0] } -result [expr {2.0**2 * cos(-1.0)}] -cleanup {simple destroy} test "Quasirandom-4.4" "Integrate constant function - sphere" -match tolerant -body { ::math::quasirandom::qrpoints create simple sphere set result [simple integral const 2.0] } -result [expr {4.0 * 2.0**2 * cos(-1.0)}] -cleanup {simple destroy} test "Quasirandom-4.5" "Integrate constant function - ball" -match tolerant -body { ::math::quasirandom::qrpoints create simple ball set result [simple integral const 2.0] } -result [expr {4.0/3.0 * 2.0**3 * cos(-1.0)}] -cleanup {simple destroy} # We do not use too many evaluations ... error less than 1% test "Quasirandom-4.6" "Integrate linear function (x, y, z)" -match error1percent -body { ::math::quasirandom::qrpoints create simple 3 set result [list [simple integral fx {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] \ [simple integral fy {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] \ [simple integral fz {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] ] } -result {0.5 0.5 0.5} -cleanup {simple destroy} # # The function varies "sharply", so we need more evaluations # test "Quasirandom-4.7" "Integrate (xyz)**4" -match error1percent -body { ::math::quasirandom::qrpoints create simple 3 # Exact answer is 1/125 set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 1000] } -result 0.0080 -cleanup {simple destroy} # # Detailed integration: provides error estimates but also an indication that # the values can differ quite a bit # test "Quasirandom-5.1" "Integrate constant function with details - volume = 1" -match tolerant -body { ::math::quasirandom::qrpoints create simple 3 set result [simple integral-detailed const {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] set rawvalues [dict get $result -rawvalues] } -result {1.0 1.0 1.0 1.0} -cleanup {simple destroy} test "Quasirandom-5.2" "Integrate linear function with details - volume = 1" -match tolerant -body { ::math::quasirandom::qrpoints create simple 3 set result [simple integral-detailed fx {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] set rawvalues [dict get $result -rawvalues] } -result {0.48924267415013695 0.48855550905424594 0.5278683439583554 0.48718117886246404} -cleanup {simple destroy} test "Quasirandom-5.3" "Integrate (xyz)**4 with details - volume = 1" -match tolerant -body { ::math::quasirandom::qrpoints create simple 3 set result [simple integral-detailed fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] set rawvalues [dict get $result -rawvalues] } -result {0.0022115062627913935 0.009840104253511376 0.014937934937801888 0.007838969739655276} -cleanup {simple destroy} # # Test integration procedures in a different namespace # test "Quasirandom-6.1" "Integrate ::func::func" -match tolerant -body { namespace eval ::func { proc func {xy} { lassign $xy x y expr {$x**2+$y**2} } ::math::quasirandom::qrpoints create simple 2 set ::result [simple integral func {{0.0 1.0} {0.0 1.0}}] } return $result } -result {0.67353777} -cleanup {::func::simple destroy} test "Quasirandom-6.2" "Integrate (details) ::func::func" -match tolerant -body { namespace eval ::func { proc func {xy} { lassign $xy x y expr {$x**2+$y**2} } ::math::quasirandom::qrpoints create simple 2 set ::result [simple integral-detailed func {{0.0 1.0} {0.0 1.0}}] } return [dict get $result -estimate] } -result {0.67353777} -cleanup {::func::simple destroy} # TODO: # - func in different namespace # - implement detailed integration and test the details # - implement minimization # # Hm, the less than 1% error in the above test is a coincidence. The error is more # likely to be 10%. # if {0} { ::math::quasirandom::qrpoints create simple 3 # Exact answer is 1/125 set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 100] puts "fxyz4: $result" simple set-step 0 set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 1000] puts "fxyz4: $result" set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 1000] puts "fxyz4: $result" set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 1000] puts "fxyz4: $result" package require math::statistics set samples {} for {set trial 0} {$trial < 10} {incr trial} { set sum 0.0 for {set p 0} {$p < 100} {incr p} { set x [expr {rand()}] set y [expr {rand()}] set z [expr {rand()}] set sum [expr {$sum + [fxyz4 [list $x $y $z]]}] } puts "Trial $trial: [expr {$sum/100.0}]" lappend samples [expr {$sum/100.0}] } puts "MonteCarlo (100):" puts [::math::statistics::mean $samples] puts [::math::statistics::stdev $samples] set samples {} for {set trial 0} {$trial < 10} {incr trial} { set sum 0.0 for {set p 0} {$p < 1000} {incr p} { set x [expr {rand()}] set y [expr {rand()}] set z [expr {rand()}] set sum [expr {$sum + [fxyz4 [list $x $y $z]]}] } puts "Trial $trial: [expr {$sum/1000.0}]" lappend samples [expr {$sum/1000.0}] } puts "MonteCarlo (1000):" puts [::math::statistics::mean $samples] puts [::math::statistics::stdev $samples] set samples {} for {set trial 0} {$trial < 10} {incr trial} { set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 100] lappend samples $result } puts "Quasi-random (100):" puts [::math::statistics::mean $samples] puts [::math::statistics::stdev $samples] set samples {} for {set trial 0} {$trial < 10} {incr trial} { set result [simple integral fxyz4 {{0.0 1.0} {0.0 1.0} {0.0 1.0}} -evaluations 1000] lappend samples $result } puts "Quasi-random (1000):" puts [::math::statistics::mean $samples] puts [::math::statistics::stdev $samples] puts [simple integral-detailed fx {{0.0 1.0} {0.0 1.0} {0.0 1.0}}] } # ------------------------------------------------------------------------- # End of test cases testsuiteCleanup |
Changes to modules/math/rational_funcs.man.
︙ | ︙ | |||
178 179 180 181 182 183 184 | [section "REMARKS ON THE IMPLEMENTATION"] The implementation of the rational functions relies on the math::polynomials package. For further remarks see the documentation on that package. [vset CATEGORY {math :: rationalfunctions}] | | | 178 179 180 181 182 183 184 185 186 | [section "REMARKS ON THE IMPLEMENTATION"] The implementation of the rational functions relies on the math::polynomials package. For further remarks see the documentation on that package. [vset CATEGORY {math :: rationalfunctions}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/roman.man.
︙ | ︙ | |||
43 44 45 46 47 48 49 | [list_end] Of these commands both [emph toroman] and [emph tointeger] are exported for easier use. The other two are not, as they could interfer or be confused with existing Tcl commands. [vset CATEGORY {math :: roman}] | | | 43 44 45 46 47 48 49 50 51 | [list_end] Of these commands both [emph toroman] and [emph tointeger] are exported for easier use. The other two are not, as they could interfer or be confused with existing Tcl commands. [vset CATEGORY {math :: roman}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/romberg.man.
︙ | ︙ | |||
332 333 334 335 336 337 338 | foreach { value error } [romberg_sine f -1.0 1.0] break puts [format "integral is %.6g +/- %.6g" $value $error] integral is 3.97746 +/- 2.3557e-010 }] [vset CATEGORY {math :: calculus}] | | | 332 333 334 335 336 337 338 339 340 | foreach { value error } [romberg_sine f -1.0 1.0] break puts [format "integral is %.6g +/- %.6g" $value $error] integral is 3.97746 +/- 2.3557e-010 }] [vset CATEGORY {math :: calculus}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/special.man.
︙ | ︙ | |||
464 465 466 467 468 469 470 | [para] Much information about these functions can be found in: [para] Abramowitz and Stegun: [emph "Handbook of Mathematical Functions"] (Dover, ISBN 486-61272-4) [vset CATEGORY {math :: special}] | | | 464 465 466 467 468 469 470 471 472 | [para] Much information about these functions can be found in: [para] Abramowitz and Stegun: [emph "Handbook of Mathematical Functions"] (Dover, ISBN 486-61272-4) [vset CATEGORY {math :: special}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/statistics.man.
︙ | ︙ | |||
1631 1632 1633 1634 1635 1636 1637 | Both time series show a significant periodic component [item] The histograms are not very useful in identifying the nature of the time series - they do not show the periodic nature. [list_end] [vset CATEGORY {math :: statistics}] | | | 1631 1632 1633 1634 1635 1636 1637 1638 1639 | Both time series show a significant periodic component [item] The histograms are not very useful in identifying the nature of the time series - they do not show the periodic nature. [list_end] [vset CATEGORY {math :: statistics}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/symdiff.man.
︙ | ︙ | |||
64 65 66 67 68 69 70 | ==> (($c * (($a * $x) + $b)) + ($a * (($c * $x) + $d))) math::calculus::symdiff::jacobian {x {$a * $x + $b * $y} y {$c * $x + $d * $y}} ==> {{$a} {$b}} {{$c} {$d}} }] [vset CATEGORY {math :: calculus}] | | | 64 65 66 67 68 69 70 71 72 | ==> (($c * (($a * $x) + $b)) + ($a * (($c * $x) + $d))) math::calculus::symdiff::jacobian {x {$a * $x + $b * $y} y {$c * $x + $d * $y}} ==> {{$a} {$b}} {{$c} {$d}} }] [vset CATEGORY {math :: calculus}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/math/trig.man.
︙ | ︙ | |||
187 188 189 190 191 192 193 | [list_begin arguments] [arg_def float angle] Angle (in degrees) [list_end] [list_end] [vset CATEGORY {math :: trig}] | | | 187 188 189 190 191 192 193 194 195 | [list_begin arguments] [arg_def float angle] Angle (in degrees) [list_end] [list_end] [vset CATEGORY {math :: trig}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/md4/md4.man.
︙ | ︙ | |||
160 161 162 163 164 165 166 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY md4] | | | 160 161 162 163 164 165 166 167 168 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY md4] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/md5/md5.man.
︙ | ︙ | |||
166 167 168 169 170 171 172 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY md5] | | | 166 167 168 169 170 171 172 173 174 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY md5] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/md5crypt/md5crypt.man.
︙ | ︙ | |||
77 78 79 80 81 82 83 | [example { % md5crypt::md5crypt password [md5crypt::salt] $1$dFmvyRmO$T.V3OmzqeEf3hqJp2WFcb. }] [vset CATEGORY md5crypt] | | | 77 78 79 80 81 82 83 84 85 | [example { % md5crypt::md5crypt password [md5crypt::salt] $1$dFmvyRmO$T.V3OmzqeEf3hqJp2WFcb. }] [vset CATEGORY md5crypt] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/mime/mime.man.
1 | [comment {-*- tcl -*- doctools manpage}] | > | | | 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 | [vset VERSION 1.6.1] [comment {-*- tcl -*- doctools manpage}] [manpage_begin mime n [vset VERSION]] [see_also ftp] [see_also http] [see_also pop3] [see_also smtp] [keywords email] [keywords internet] [keywords mail] [keywords mime] [keywords net] [keywords {rfc 821}] [keywords {rfc 822}] [keywords {rfc 2045}] [keywords {rfc 2046}] [keywords {rfc 2049}] [keywords smtp] [copyright {1999-2000 Marshall T. Rose}] [moddesc {Mime}] [titledesc {Manipulation of MIME body parts}] [category {Text processing}] [require Tcl 8.5] [require mime [opt [vset VERSION]]] [description] [para] The [package mime] library package provides the commands to create and manipulate MIME body parts. [list_begin definitions] |
︙ | ︙ | |||
397 398 399 400 401 402 403 | [para] See [uri {/tktview?name=447037} {Ticket 447037}] for additional information. [list_end] [vset CATEGORY mime] | | | 398 399 400 401 402 403 404 405 406 | [para] See [uri {/tktview?name=447037} {Ticket 447037}] for additional information. [list_end] [vset CATEGORY mime] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/mime/mime.tcl.
︙ | ︙ | |||
19 20 21 22 23 24 25 | # Influenced by Borenstein's/Rose's safe-tcl (circa 1993) and Darren New's # unpublished package of 1999. # # new string features and inline scan are used, requiring 8.3. package require Tcl 8.5 | | | 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | # Influenced by Borenstein's/Rose's safe-tcl (circa 1993) and Darren New's # unpublished package of 1999. # # new string features and inline scan are used, requiring 8.3. package require Tcl 8.5 package provide mime 1.6.1 if {[catch {package require Trf 2.0}]} { # Fall-back to tcl-based procedures of base64 and quoted-printable encoders # Warning! # These are a fragile emulations of the more general calling sequence # that appears to work with this code here. |
︙ | ︙ | |||
375 376 377 378 379 380 381 | variable mime set token [namespace current]::[incr mime(uid)] # FRINK: nocheck variable $token upvar 0 $token state | > | > | 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 | variable mime set token [namespace current]::[incr mime(uid)] # FRINK: nocheck variable $token upvar 0 $token state if {[catch { mime::initializeaux $token {*}$args } result eopts]} { catch {mime::finalize $token -subordinates dynamic} return -options $eopts $result } return $token } # ::mime::initializeaux -- |
︙ | ︙ | |||
654 655 656 657 658 659 660 | if {$fileP} { if {($pos > $last) || ([set x [gets $state(fd) line]] <= 0)} { set blankP 1 } else { incr pos [expr {$x + 1}] } } else { | < | | | | | | | | | | | < | | | | | | | 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 | if {$fileP} { if {($pos > $last) || ([set x [gets $state(fd) line]] <= 0)} { set blankP 1 } else { incr pos [expr {$x + 1}] } } else { if {$state(lines.current) >= $state(lines.count)} { set blankP 1 set line {} } else { set line [lindex $state(lines) $state(lines.current)] incr state(lines.current) set x [string length $line] if {$x == 0} {set blankP 1} } } if {(!$blankP) && ([string last \r $line] == ($x - 1))} { set line [string range $line 0 [expr {$x - 2}]] if {$x == 1} { set blankP 1 } } if {(!$blankP) && (([ string first { } $line] == 0) || ([ string first \t $line] == 0))} { append vline \n $line continue } |
︙ | ︙ |
Changes to modules/mime/mime.test.
︙ | ︙ | |||
22 23 24 25 26 27 28 29 30 31 32 33 34 35 | # This code loads md5x, i.e. md5 v2. Proper testing should do one # run using md5 v1, aka md5.tcl as well. use md5/md5x.tcl md5 } testing { useLocal mime.tcl mime } # ------------------------------------------------------------------------- namespace import mime::* # ------------------------------------------------------------------------- | > > > > > | 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | # This code loads md5x, i.e. md5 v2. Proper testing should do one # run using md5 v1, aka md5.tcl as well. use md5/md5x.tcl md5 } testing { useLocal mime.tcl mime } # Shorthand for access to assets. proc A {path} { file join $::tcltest::testsDirectory test-assets $path } # ------------------------------------------------------------------------- namespace import mime::* # ------------------------------------------------------------------------- |
︙ | ︙ | |||
165 166 167 168 169 170 171 | list $err3 $err3a } "foo {MIME-Version: 1.0\r Content-Type: text/plain\r \r foo}" test mime-3.7 {Test mime with a bad email [SF Bug 631314 ]} { | | < < | < | 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 | list $err3 $err3a } "foo {MIME-Version: 1.0\r Content-Type: text/plain\r \r foo}" test mime-3.7 {Test mime with a bad email [SF Bug 631314 ]} { set tok [mime::initialize -file [A badmail1.txt]] set res {} set ctok [lindex [mime::getproperty $tok parts] 0] lappend res [dictsort [mime::getproperty $tok]] lappend res [dictsort [mime::getproperty $ctok]] mime::finalize $tok string map [list $ctok CHILD] $res } {{content multipart/mixed encoding {} params {boundary ----------CSFNU9QKPGZL79} parts CHILD size 0} {content application/octet-stream encoding {} params {charset us-ascii} size 0}} test mime-3.8 {Test mime with another bad email [SF Bug 631314 ]} { set tok [mime::initialize -file [A badmail2.txt]] set res {} set ctok [lindex [mime::getproperty $tok parts] 0] lappend res [dictsort [mime::getproperty $tok]] lappend res [dictsort [mime::getproperty $ctok]] mime::finalize $tok string map [list $ctok CHILD] $res } {{content multipart/related encoding {} params {boundary ----=_NextPart_000_0000_2CBA2CBA.150C56D2} parts CHILD size 659} {content application/octet-stream encoding base64 params {} size 659}} |
︙ | ︙ | |||
598 599 600 601 602 603 604 605 606 607 608 609 | T3JpZ2luYWwtUmVjaXBpZW50OiA8L2ZheD1ibHViYkBndW1taS5ib290PgpBY3Rpb246IGZhaWxl ZApEaWFnbm9zdGljLUNvZGU6IHNtdHA7IDU1MCAjNS4xLjAgQWRkcmVzcyByZWplY3RlZC4KUmVt b3RlLU1UQTogNTMuMjQuMjgyLjE1MA== }] set parts [mime::getproperty $token parts] mime::getheader [lindex $parts end] Remote-MTA } 53.24.282.150 # ------------------------------------------------------------------------- testsuiteCleanup return | > > > > > > > > > | 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 | T3JpZ2luYWwtUmVjaXBpZW50OiA8L2ZheD1ibHViYkBndW1taS5ib290PgpBY3Rpb246IGZhaWxl ZApEaWFnbm9zdGljLUNvZGU6IHNtdHA7IDU1MCAjNS4xLjAgQWRkcmVzcyByZWplY3RlZC4KUmVt b3RlLU1UQTogNTMuMjQuMjgyLjE1MA== }] set parts [mime::getproperty $token parts] mime::getheader [lindex $parts end] Remote-MTA } 53.24.282.150 # ------------------------------------------------------------------------- test mime-12.1 {Fossil ticket 57909d2e1c} -cleanup { mime::finalize $token unset -nocomplain token } -body { set token [::mime::initialize -file [A mail-57909d2e1c.txt]] } -result {::mime::*} -match glob # ------------------------------------------------------------------------- testsuiteCleanup return |
Changes to modules/mime/pkgIndex.tcl.
1 2 3 | if {![package vsatisfies [package provide Tcl] 8.3]} {return} package ifneeded smtp 1.5 [list source [file join $dir smtp.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} {return} | | | 1 2 3 4 | if {![package vsatisfies [package provide Tcl] 8.3]} {return} package ifneeded smtp 1.5 [list source [file join $dir smtp.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} {return} package ifneeded mime 1.6.1 [list source [file join $dir mime.tcl]] |
Changes to modules/mime/smtp.man.
︙ | ︙ | |||
199 200 201 202 203 204 205 | J. Myers, "SMTP Service Extension for Authentication", RFC 2554, March 1999. ([uri http://www.rfc-editor.org/rfc/rfc2554.txt]) [list_end] [vset CATEGORY smtp] | | | 199 200 201 202 203 204 205 206 207 208 209 210 | J. Myers, "SMTP Service Extension for Authentication", RFC 2554, March 1999. ([uri http://www.rfc-editor.org/rfc/rfc2554.txt]) [list_end] [vset CATEGORY smtp] [include ../common-text/feedback.inc] [keywords mail mail email smtp mime tls \ {rfc 821} {rfc 822} {rfc 2821} {rfc 3207} {rfc 2554} internet net] [manpage_end] |
Name change from modules/mime/badmail1.txt to modules/mime/test-assets/badmail1.txt.
︙ | ︙ |
Name change from modules/mime/badmail2.txt to modules/mime/test-assets/badmail2.txt.
︙ | ︙ |
Added modules/mime/test-assets/mail-57909d2e1c.txt.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | MIME-Version: 1.0 Content-ID: <[email protected]> Content-Type: multipart/mixed; boundary="----- =_U9Pw/kikzJT5t8pT5pl5Pw==" ------- =_U9Pw/kikzJT5t8pT5pl5Pw== MIME-Version: 1.0 Content-ID: <[email protected]> Content-Disposition: inline; filename="/model.pl" Content-Description: Simile model Date-Modified: 2019-04-11 11:01:36 GMT Authentication-Code: c0c651af192d709b2757cb9ef0d8c19d Content-Type: application/x-simile Content-Transfer-Encoding: base64 c291cmNlKHByb2dyYW09J0FNRScsdmVyc2lvbj0gMTAuOSxlZGl0aW9uPWVudGVycHJpc2UsZGF0 KG5vbmUsaW5faGllcmFyY2h5LGRlc3QsMSldXSxbY3VydmU9Wy05LDFdXSkuCg== ------- =_U9Pw/kikzJT5t8pT5pl5Pw== MIME-Version: 1.0 Content-ID: <[email protected]> Content-Disposition: attachment; filename="/model.cnv" Content-Description: Simile canvas description Date-Modified: 2019-04-11 11:01:36 GMT Content-Type: application/x-simile Content-Transfer-Encoding: base64 IyB3cml0dGVuIG9uIFRodSBBcHIgMTEgMTE6MDE6MzYgR01UIDIwMTkKTG9hZE1vZGVsTG9va3Mg bl90aGlzIHJlYWx3aWR0aCgxMDguMCkgY3VycmVudGx5X2VkaXRhYmxlfSAtdGV4dCBmbG93MwoK ------- =_U9Pw/kikzJT5t8pT5pl5Pw== MIME-Version: 1.0 Content-ID: <[email protected]> Content-Disposition: attachment; filename="/model.spj" Content-Description: Simile package description Date-Modified: 2019-04-11 11:01:53 GMT Content-Type: application/x-simile Content-Transfer-Encoding: base64 Cg== ------- =_U9Pw/kikzJT5t8pT5pl5Pw== MIME-Version: 1.0 Content-Description: Run Status Content-ID: <[email protected]> Content-Type: application/x-simile Content-Transfer-Encoding: base64 ZXhlY1RpbWUgMTAwLjAgdGltZVVuaXQgdW5pdCBkaXNwbGF5SW50IDEgaW50TWV0aG9kIEV1bGVy IHBoYXNlTGlzdCAwLjE= ------- =_U9Pw/kikzJT5t8pT5pl5Pw==-- |
Changes to modules/multiplexer/multiplexer.man.
︙ | ︙ | |||
122 123 124 125 126 127 128 | EOF: The channel connecting us to the client, its ip-address, and its ip-port. [list_end] [list_end] [vset CATEGORY multiplexer] | | | 122 123 124 125 126 127 128 129 130 | EOF: The channel connecting us to the client, its ip-address, and its ip-port. [list_end] [list_end] [vset CATEGORY multiplexer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/namespacex/namespacex.man.
︙ | ︙ | |||
166 167 168 169 170 171 172 | a child namespace of namespace [arg prefix]. Returns the corresponding list of relative names of child namespaces. [list_end] [vset CATEGORY namespacex] | | | 166 167 168 169 170 171 172 173 174 | a child namespace of namespace [arg prefix]. Returns the corresponding list of relative names of child namespaces. [list_end] [vset CATEGORY namespacex] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ncgi/ncgi.man.
︙ | ︙ | |||
305 306 307 308 309 310 311 | puts -nonewline $fh $filedata close $fh }] [para] [vset CATEGORY ncgi] | | | 305 306 307 308 309 310 311 312 313 | puts -nonewline $fh $filedata close $fh }] [para] [vset CATEGORY ncgi] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nettool/nettool.man.
︙ | ︙ | |||
135 136 137 138 139 140 141 | Return a fully qualified path to a folder where [arg appname] should store it's data. The path is not created, only computed, by this command. [list_end] [para] [vset CATEGORY odie] | | | 135 136 137 138 139 140 141 142 143 | Return a fully qualified path to a folder where [arg appname] should store it's data. The path is not created, only computed, by this command. [list_end] [para] [vset CATEGORY odie] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nmea/nmea.man.
︙ | ︙ | |||
94 95 96 97 98 99 100 | puts "unknown data type $name" } }] [list_end] [vset CATEGORY nmea] | | | 94 95 96 97 98 99 100 101 102 | puts "unknown data type $name" } }] [list_end] [vset CATEGORY nmea] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nns/nns_auto.man.
︙ | ︙ | |||
111 112 113 114 115 116 117 | [para] Another loss of the connection, be it during or after re-entering the remembered information simply restarts the timer and subsequent reconnection attempts. [vset CATEGORY nameserv] | | | 111 112 113 114 115 116 117 118 119 | [para] Another loss of the connection, be it during or after re-entering the remembered information simply restarts the timer and subsequent reconnection attempts. [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nns/nns_client.man.
︙ | ︙ | |||
330 331 332 333 334 335 336 | its connection to the name service. Based on package [package uevent]. [def 0.1] Initial implementation of the client. [list_end] [vset CATEGORY nameserv] | | | 330 331 332 333 334 335 336 337 338 | its connection to the name service. Based on package [package uevent]. [def 0.1] Initial implementation of the client. [list_end] [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nns/nns_common.man.
︙ | ︙ | |||
39 40 41 42 43 44 45 | The result returned by the command is the id of the default TCP/IP port a nameservice server will listen on, and a name service client will try to connect to. [list_end] [vset CATEGORY nameserv] | | | 39 40 41 42 43 44 45 46 47 | The result returned by the command is the id of the default TCP/IP port a nameservice server will listen on, and a name service client will try to connect to. [list_end] [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nns/nns_intro.man.
︙ | ︙ | |||
120 121 122 123 124 125 126 | [para] Developers wishing to modify and/or extend or to just understand the internals of the nameservice facility however are strongly advised to read it. [vset CATEGORY nameserv] | | | 120 121 122 123 124 125 126 127 128 | [para] Developers wishing to modify and/or extend or to just understand the internals of the nameservice facility however are strongly advised to read it. [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nns/nns_protocol.man.
︙ | ︙ | |||
174 175 176 177 178 179 180 | The argument coming before the response tells the client whether the names in the response were added or removed from the service. [list_end] [vset CATEGORY nameserv] | | | 174 175 176 177 178 179 180 181 182 | The argument coming before the response tells the client whether the names in the response were added or removed from the service. [list_end] [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nns/nns_server.man.
︙ | ︙ | |||
137 138 139 140 141 142 143 | Changed name of -local switch to -localonly. [def 0.1] Initial implementation of the server. [list_end] [vset CATEGORY nameserv] | | | 137 138 139 140 141 142 143 144 145 | Changed name of -local switch to -localonly. [def 0.1] Initial implementation of the server. [list_end] [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/nntp/nntp.man.
︙ | ︙ | |||
330 331 332 333 334 335 336 | Date: [clock format [clock seconds] -format "%a, %d % b %y %H:%M:%S GMT" -gmt true] Test message body" }] [vset CATEGORY nntp] | | | 330 331 332 333 334 335 336 337 338 | Date: [clock format [clock seconds] -format "%a, %d % b %y %H:%M:%S GMT" -gmt true] Test message body" }] [vset CATEGORY nntp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ntp/ntp_time.man.
︙ | ︙ | |||
123 124 125 126 127 128 129 | time::getsntp -command on_time pool.ntp.org }] [section AUTHORS] Pat Thoyts [vset CATEGORY ntp] | | | 123 124 125 126 127 128 129 130 131 | time::getsntp -command on_time pool.ntp.org }] [section AUTHORS] Pat Thoyts [vset CATEGORY ntp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/oauth/oauth.man.
1 | [comment {-*- tcl -*- doctools manpage}] | | | 1 2 3 4 5 6 7 8 9 | [comment {-*- tcl -*- doctools manpage}] [vset PACKAGE_VERSION 1.0.3] [manpage_begin oauth n [vset PACKAGE_VERSION]] [keywords {oauth}] [keywords {RFC 5849}] [keywords {RFC 2718}] [keywords twitter] [copyright {2014 Javi P. <[email protected]>}] [moddesc {oauth}] |
︙ | ︙ | |||
183 184 185 186 187 188 189 | follow_request_sent => false notifications => false}] [list_end] [para] [vset CATEGORY oauth] | | | 183 184 185 186 187 188 189 190 191 | follow_request_sent => false notifications => false}] [list_end] [para] [vset CATEGORY oauth] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/oauth/oauth.tcl.
︙ | ︙ | |||
21 22 23 24 25 26 27 | # 1.5 Timestamp (oauth_timestamp) time in unix format of the request # 1.6 Token (oauth_token) a parameter you can obtain in your account settings # 1.7 Version (oauth_version) the OAuth version, actually 1.0 # TODO: create online documentation package require Tcl 8.5 | | | 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | # 1.5 Timestamp (oauth_timestamp) time in unix format of the request # 1.6 Token (oauth_token) a parameter you can obtain in your account settings # 1.7 Version (oauth_version) the OAuth version, actually 1.0 # TODO: create online documentation package require Tcl 8.5 package provide oauth 1.0.3 package require http package require tls package require base64 package require sha1 http::register https 443 ::tls::socket |
︙ | ︙ | |||
279 280 281 282 283 284 285 | return $tmp } # Split - # Split the string on the first separator # and return both parts as a list. proc ::oauth::Split {string sep} { | | | 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 | return $tmp } # Split - # Split the string on the first separator # and return both parts as a list. proc ::oauth::Split {string sep} { regexp "^(\[^${sep}\]+)${sep}(.*)\$" $string -> key value list $key $value } # PercentEncode -- # Encoding process in http://tools.ietf.org/html/rfc3986#section-2.1 # for Twitter authentication. (http::formatQuery is lowcase) proc ::oauth::PercentEncode {string} { |
︙ | ︙ |
Changes to modules/oauth/pkgIndex.tcl.
1 | if {![package vsatisfies [package provide Tcl] 8.5]} {return} | | | 1 2 | if {![package vsatisfies [package provide Tcl] 8.5]} {return} package ifneeded oauth 1.0.3 [list source [file join $dir oauth.tcl]] |
Changes to modules/oometa/oometa.man.
︙ | ︙ | |||
143 144 145 146 147 148 149 | is faster than [cmd {my meta getnull}] [opt [arg field]] [opt [arg ...]] [arg field]], because it performs a search instead directly instead of producing the recursive merge product between the class metadata, the local [emph meta] variable, and THEN performing the search. [list_end] [vset CATEGORY tcloo] | | | 143 144 145 146 147 148 149 150 151 152 | is faster than [cmd {my meta getnull}] [opt [arg field]] [opt [arg ...]] [arg field]], because it performs a search instead directly instead of producing the recursive merge product between the class metadata, the local [emph meta] variable, and THEN performing the search. [list_end] [vset CATEGORY tcloo] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ooutil/ooutil.man.
︙ | ︙ | |||
157 158 159 160 161 162 163 | [list_end] [section AUTHORS] Donal Fellows, Andreas Kupries [vset CATEGORY oo::util] | | | 157 158 159 160 161 162 163 164 165 | [list_end] [section AUTHORS] Donal Fellows, Andreas Kupries [vset CATEGORY oo::util] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/otp/otp.man.
︙ | ︙ | |||
87 88 89 90 91 92 93 | "Secure Hash Standard", National Institute of Standards and Technology, U.S. Department Of Commerce, April 1995. ([uri http://www.itl.nist.gov/fipspubs/fip180-1.htm]) [list_end] [vset CATEGORY otp] | | | 87 88 89 90 91 92 93 94 95 | "Secure Hash Standard", National Institute of Standards and Technology, U.S. Department Of Commerce, April 1995. ([uri http://www.itl.nist.gov/fipspubs/fip180-1.htm]) [list_end] [vset CATEGORY otp] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_intro.man.
︙ | ︙ | |||
27 28 29 30 31 32 33 | The packages implementing the plugins are not documented as regular packages, as they cannot be loaded into a general interpreter, like tclsh, without extensive preparation of the interpreter. Preparation which is done for them by the plugin manager. [vset CATEGORY page] | | | 27 28 29 30 31 32 33 34 35 | The packages implementing the plugins are not documented as regular packages, as they cannot be loaded into a general interpreter, like tclsh, without extensive preparation of the interpreter. Preparation which is done for them by the plugin manager. [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_pluginmgr.man.
︙ | ︙ | |||
792 793 794 795 796 797 798 | [section FEATURES] The plugin manager currently checks the plugins for only one feature, [const timeable]. A plugin supporting this feature is assumed to be able to collect timing statistics on request. [vset CATEGORY page] | | | 792 793 794 795 796 797 798 799 800 | [section FEATURES] The plugin manager currently checks the plugins for only one feature, [const timeable]. A plugin supporting this feature is assumed to be able to collect timing statistics on request. [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_util_flow.man.
︙ | ︙ | |||
88 89 90 91 92 93 94 | This is the variadic arguments form of the method [method visitl], see above. [list_end] [vset CATEGORY page] | | | 88 89 90 91 92 93 94 95 96 | This is the variadic arguments form of the method [method visitl], see above. [list_end] [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_util_norm_lemon.man.
︙ | ︙ | |||
43 44 45 46 47 48 49 | [para] The exact operations performed are left undocumented for the moment. [list_end] [vset CATEGORY page] | | | 43 44 45 46 47 48 49 50 51 | [para] The exact operations performed are left undocumented for the moment. [list_end] [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_util_norm_peg.man.
︙ | ︙ | |||
97 98 99 100 101 102 103 | The order matters, to shed as much nodes as possible early, and to avoid unnecessary work later. [list_end] [list_end] [vset CATEGORY page] | | | 97 98 99 100 101 102 103 104 105 | The order matters, to shed as much nodes as possible early, and to avoid unnecessary work later. [list_end] [list_end] [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_util_peg.man.
︙ | ︙ | |||
100 101 102 103 104 105 106 | See the package [package grammar::peg] for the exact syntax of [arg pe]. [list_end] [vset CATEGORY page] | | | 100 101 102 103 104 105 106 107 108 | See the package [package grammar::peg] for the exact syntax of [arg pe]. [list_end] [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/page/page_util_quote.man.
︙ | ︙ | |||
54 55 56 57 58 59 60 | converts it into a string which is accepted by the Tcl parser when used within a Tcl comment. The string is returned as the result of this command. [list_end] [vset CATEGORY page] | | | 54 55 56 57 58 59 60 61 62 | converts it into a string which is accepted by the Tcl parser when used within a Tcl comment. The string is returned as the result of this command. [list_end] [vset CATEGORY page] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/pki/pki.man.
︙ | ︙ | |||
294 295 296 297 298 299 300 | [enum] [list_end] [section AUTHORS] Roy Keene [vset CATEGORY rsa] | | | 294 295 296 297 298 299 300 301 302 | [enum] [list_end] [section AUTHORS] Roy Keene [vset CATEGORY rsa] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/pluginmgr/pluginmgr.man.
︙ | ︙ | |||
419 420 421 422 423 424 425 | Its purpose is give a user of the plugin management the ability to define commands, packages, etc. a chosen plugin may need while being loaded. [list_end] [vset CATEGORY pluginmgr] | | | 419 420 421 422 423 424 425 426 427 | Its purpose is give a user of the plugin management the ability to define commands, packages, etc. a chosen plugin may need while being loaded. [list_end] [vset CATEGORY pluginmgr] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/png/png.man.
︙ | ︙ | |||
147 148 149 150 151 152 153 | Takes a list of scanlines in the Tk_GetColor format and writes the represented image to [arg file]. [list_end] [vset CATEGORY png] | | | 147 148 149 150 151 152 153 154 155 | Takes a list of scanlines in the Tk_GetColor format and writes the represented image to [arg file]. [list_end] [vset CATEGORY png] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/pop3/pop3.man.
︙ | ︙ | |||
266 267 268 269 270 271 272 | pop3::open -stls 1 \\ $thehost $theuser $thepassword ... }] [vset CATEGORY pop3] | | | 266 267 268 269 270 271 272 273 274 | pop3::open -stls 1 \\ $thehost $theuser $thepassword ... }] [vset CATEGORY pop3] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/pop3d/pop3d.man.
︙ | ︙ | |||
265 266 267 268 269 270 271 | [list_begin enumerated] [enum] [uri http://www.rfc-editor.org/rfc/rfc1939.txt {RFC 1939}] [enum] [uri http://www.rfc-editor.org/rfc/rfc2449.txt {RFC 2449}] [list_end] [vset CATEGORY pop3d] | | | 265 266 267 268 269 270 271 272 273 | [list_begin enumerated] [enum] [uri http://www.rfc-editor.org/rfc/rfc1939.txt {RFC 1939}] [enum] [uri http://www.rfc-editor.org/rfc/rfc2449.txt {RFC 2449}] [list_end] [vset CATEGORY pop3d] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/pop3d/pop3d_dbox.man.
︙ | ︙ | |||
156 157 158 159 160 161 162 | call will fail. If [method stat] was not called before this call, [method get] will assume that there are zero messages in the mailbox. [list_end] [vset CATEGORY pop3d] | | | 156 157 158 159 160 161 162 163 164 | call will fail. If [method stat] was not called before this call, [method get] will assume that there are zero messages in the mailbox. [list_end] [vset CATEGORY pop3d] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/pop3d/pop3d_udb.man.
︙ | ︙ | |||
104 105 106 107 108 109 110 | remembered internally so that it can be used in the next call of [arg dbName] [method save] without an argument. [list_end] [vset CATEGORY pop3d] | | | 104 105 106 107 108 109 110 111 112 | remembered internally so that it can be used in the next call of [arg dbName] [method save] without an argument. [list_end] [vset CATEGORY pop3d] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/practcl/build/footer.txt.
1 | [vset CATEGORY practcl] | | | 1 2 | [vset CATEGORY practcl] [include ../common-text/feedback.inc] |
Changes to modules/practcl/practcl.man.
︙ | ︙ | |||
1839 1840 1841 1842 1843 1844 1845 | [call method [cmd "linktype"]] [list_end] [para] [vset CATEGORY practcl] | | | 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 | [call method [cmd "linktype"]] [list_end] [para] [vset CATEGORY practcl] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/practcl/practcl.tcl.
1 2 3 4 5 6 7 8 9 10 11 12 | ### # Amalgamated package for practcl # Do not edit directly, tweak the source in src/ and rerun # build.tcl ### package require Tcl 8.6 package provide practcl 0.16.3 namespace eval ::practcl {} ### # START: httpwget/wget.tcl ### | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | ### # Amalgamated package for practcl # Do not edit directly, tweak the source in src/ and rerun # build.tcl ### package require Tcl 8.6 package provide practcl 0.16.3 namespace eval ::practcl {} ### # START: httpwget/wget.tcl ### ### # END: httpwget/wget.tcl ### ### # START: clay/clay.tcl ### |
︙ | ︙ | |||
1006 1007 1008 1009 1010 1011 1012 | proc ::clay::define::destructor rawbody { set body { # Run the destructor once and only once set self [self] my variable DestroyEvent if {$DestroyEvent} return set DestroyEvent 1 | < | 966 967 968 969 970 971 972 973 974 975 976 977 978 979 | proc ::clay::define::destructor rawbody { set body { # Run the destructor once and only once set self [self] my variable DestroyEvent if {$DestroyEvent} return set DestroyEvent 1 } append body $rawbody ::oo::define [current_class] destructor $body } proc ::clay::define::Dict {name {values {}}} { set class [current_class] set name [string trim $name :/] |
︙ | ︙ | |||
1069 1070 1071 1072 1073 1074 1075 | } } proc ::clay::define::Variable {name {default {}}} { set class [current_class] set name [string trimright $name :/] $class clay set variable/ $name $default } | < < < < < < < < < < < < < < < < | 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 | } } proc ::clay::define::Variable {name {default {}}} { set class [current_class] set name [string trimright $name :/] $class clay set variable/ $name $default } ::namespace eval ::clay::define { } proc ::clay::ensemble_methodbody {ensemble einfo} { set default standard set preamble {} set eswitch {} if {[dict exists $einfo default]} { |
︙ | ︙ | |||
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 | } foreach class $clayorder { if {[$class clay exists {*}$args]} { return $class } } return {} } replace { set clay [lindex $args 0] } source { source [lindex $args 0] } | > > > > > > > > > > > > > > > > > > | 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 | } foreach class $clayorder { if {[$class clay exists {*}$args]} { return $class } } return {} } refcount { my variable refcount if {![info exists refcount]} { return 0 } return $refcount } refcount_incr { my variable refcount incr refcount } refcount_decr { my variable refcount incr refcount -1 if {$refcount <= 0} { ::clay::object_destroy [self] } } replace { set clay [lindex $args 0] } source { source [lindex $args 0] } |
︙ | ︙ | |||
1858 1859 1860 1861 1862 1863 1864 | } } ::clay::object clay branch array ::clay::object clay branch mixin ::clay::object clay branch option ::clay::object clay branch dict clay ::clay::object clay set variable DestroyEvent 0 | > > | < | < < | < < < > | < > > > > > > > > > > > > > > > > > > > > > > > | 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 | } } ::clay::object clay branch array ::clay::object clay branch mixin ::clay::object clay branch option ::clay::object clay branch dict clay ::clay::object clay set variable DestroyEvent 0 if {[info commands ::cron::object_destroy] eq {}} { # Provide a noop if we aren't running with the cron scheduler namespace eval ::cron {} proc ::cron::object_destroy args {} } ::namespace eval ::clay::event { } proc ::clay::cleanup {} { if {![info exists ::clay::idle_destroy]} return foreach obj $::clay::idle_destroy { if {[info commands $obj] ne {}} { catch {$obj destroy} } } set ::clay::idle_destroy {} } proc ::clay::object_create {objname {class {}}} { #if {$::clay::trace>0} { # puts [list $objname CREATE] #} } proc ::clay::object_rename {object newname} { if {$::clay::trace>0} { puts [list $object RENAME -> $newname] } } proc ::clay::object_destroy args { if {![info exists ::clay::idle_destroy]} { set ::clay::idle_destroy {} } foreach objname $args { if {$::clay::trace>0} { puts [list $objname DESTROY] } ::cron::object_destroy $objname if {$objname in $::clay::idle_destroy} continue lappend ::clay::idle_destroy $objname } } proc ::clay::event::cancel {self {task *}} { variable timer_event variable timer_script foreach {id event} [array get timer_event $self:$task] { ::after cancel $event |
︙ | ︙ |
Changes to modules/processman/processman.man.
︙ | ︙ | |||
66 67 68 69 70 71 72 | Start a child process, identified by [arg id]. [arg cmd] is the name of the command to execute. [arg args] are arguments to pass to that command. [list_end] [para] [vset CATEGORY odie] | | | 66 67 68 69 70 71 72 73 74 | Start a child process, identified by [arg id]. [arg cmd] is the name of the command to execute. [arg args] are arguments to pass to that command. [list_end] [para] [vset CATEGORY odie] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/profiler/profiler.man.
︙ | ︙ | |||
113 114 115 116 117 118 119 | [const avgRuntime]. The return result is a list of lists, where each sublist consists of a function name and the value of [arg key] for that function. [list_end] [vset CATEGORY profiler] | | | 113 114 115 116 117 118 119 120 121 | [const avgRuntime]. The return result is a list of lists, where each sublist consists of a function name and the value of [arg key] for that function. [list_end] [vset CATEGORY profiler] [include ../common-text/feedback.inc] [manpage_end] |
Deleted modules/pt/configuration.tcl.
|
| < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < |
Changes to modules/pt/include/feedback.inc.
1 2 | [comment {--- Standard trailer for all manpages in this module --}] [vset CATEGORY pt] | | | 1 2 3 | [comment {--- Standard trailer for all manpages in this module --}] [vset CATEGORY pt] [include ../../common-text/feedback.inc] |
Changes to modules/pt/pkgIndex.tcl.
1 2 3 4 | if {![package vsatisfies [package provide Tcl] 8.5]} return # General utilities. package ifneeded char 1.0.1 [list source [file join $dir char.tcl]] | < < | 1 2 3 4 5 6 7 8 9 10 11 | if {![package vsatisfies [package provide Tcl] 8.5]} return # General utilities. package ifneeded char 1.0.1 [list source [file join $dir char.tcl]] package ifneeded text::write 1 [list source [file join $dir text_write.tcl]] # AST support package ifneeded pt::ast 1.1 [list source [file join $dir pt_astree.tcl]] # General parser support. Currently only conversion of structured # syntax errors (or parts thereof) into a human-readable form. |
︙ | ︙ | |||
22 23 24 25 26 27 28 | package ifneeded pt::peg::container 1 [list source [file join $dir pt_peg_container.tcl]] package ifneeded pt::peg::interp 1.0.1 [list source [file join $dir pt_peg_interp.tcl]] package ifneeded pt::peg::op 1.1.0 [list source [file join $dir pt_peg_op.tcl]] package ifneeded pt::parse::peg 1.0.1 [list source [file join $dir pt_parse_peg.tcl]] # Export/import managers. Assumes an untrusted environment. | | | | 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | package ifneeded pt::peg::container 1 [list source [file join $dir pt_peg_container.tcl]] package ifneeded pt::peg::interp 1.0.1 [list source [file join $dir pt_peg_interp.tcl]] package ifneeded pt::peg::op 1.1.0 [list source [file join $dir pt_peg_op.tcl]] package ifneeded pt::parse::peg 1.0.1 [list source [file join $dir pt_parse_peg.tcl]] # Export/import managers. Assumes an untrusted environment. package ifneeded pt::peg::export 1.0.1 [list source [file join $dir pt_peg_export.tcl]] package ifneeded pt::peg::import 1.0.1 [list source [file join $dir pt_peg_import.tcl]] # Export plugins, connecting manager to the core conversion packages. package ifneeded pt::peg::export::container 1 [list source [file join $dir pt_peg_export_container.tcl]] package ifneeded pt::peg::export::json 1 [list source [file join $dir pt_peg_export_json.tcl]] package ifneeded pt::peg::export::peg 1 [list source [file join $dir pt_peg_export_peg.tcl]] # Import plugins, connecting manager to the core conversion packages. |
︙ | ︙ |
Changes to modules/pt/pt_peg_export.man.
1 | [comment {-*- tcl -*- doctools manpage}] | > | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | [comment {-*- tcl -*- doctools manpage}] [vset VERSION 1.0.1] [manpage_begin pt::peg::export n [vset VERSION]] [include include/module.inc] [titledesc {PEG Export}] [require snit] [require struct::map] [require pt::peg] [require pluginmgr] [require pt::peg::export [opt [vset VERSION]]] [description] [include include/ref_intro.inc] This package provides a manager for parsing expression grammars, with each instance handling a set of plugins for the export of them to other formats, i.e. their conversion to, for example [term nroff], [term HTML], etc. |
︙ | ︙ |
Changes to modules/pt/pt_peg_export.tcl.
1 2 3 4 5 6 7 8 | # pt_peg_export.tcl -- # # Exporting parsing expression grammars into other formats. # # Copyright (c) 2009 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. | < < | | | | 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 | # pt_peg_export.tcl -- # # Exporting parsing expression grammars into other formats. # # Copyright (c) 2009 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object manages a set of plugins for the conversion of parsing # expression grammars into some textual representation. I.e. this # object manages the conversion to specialized serializations of # parsing expression grammars. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.5 package require snit package require pt::peg package require pluginmgr package require struct::map # ### ### ### ######### ######### ######### ## API snit::type ::pt::peg::export { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction. constructor {} { install myconfig using ::struct::map ${selfns}::CONFIG return } destructor { $myconfig destroy # Clear the cache of loaded export plugins. foreach k [array names myplugin] { |
︙ | ︙ | |||
111 112 113 114 115 116 117 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 109 110 111 112 113 114 115 116 117 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide pt::peg::export 1.0.1 return |
Changes to modules/pt/pt_peg_export.test.
1 2 3 | # -*- tcl -*- # peg_export.test: tests for the pt::peg::export package. # | | < < > < | 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 | # -*- tcl -*- # peg_export.test: tests for the pt::peg::export package. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.5 testsNeedTcltest 2 support { useAccel [useTcllibC] struct/sets.tcl struct::set TestAccelInit struct::set use fileutil/fileutil.tcl fileutil ;# tests/common use snit/snit.tcl snit use pluginmgr/pluginmgr.tcl pluginmgr use struct/map.tcl struct::map useLocal pt_pexpression.tcl pt::pe useLocal pt_pegrammar.tcl pt::peg source [localPath tests/common] } testing { useLocalKeep pt_peg_export.tcl pt::peg::export |
︙ | ︙ |
Changes to modules/pt/pt_peg_import.man.
1 | [comment {-*- tcl -*- doctools manpage}] | > | | | > | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | [comment {-*- tcl -*- doctools manpage}] [vset VERSION 1.0.1] [manpage_begin pt::peg::import n [vset VERSION]] [include include/module.inc] [titledesc {PEG Import}] [require Tcl 8.5] [require snit] [require fileutil::paths] [require pt::peg] [require pluginmgr] [require pt::peg::import [opt [vset VERSION]]] [description] [include include/ref_intro.inc] This package provides a manager for parsing expression grammars, with each instance handling a set of plugins for the import of them from other formats, i.e. their conversion from, for example [term peg], [term container], [term json], etc. |
︙ | ︙ |
Changes to modules/pt/pt_peg_import.tcl.
1 2 3 4 | # import.tcl -- # # Importing parsing expression grammars from other formats. # | | < < | | | | 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 | # import.tcl -- # # Importing parsing expression grammars from other formats. # # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Each object manages a set of plugins for the creation of parsing # expression grammars from some textual representation. I.e. this # object manages the conversion from specialized serializations of # parsing expression grammars into their standard form. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require fileutil::paths package require pt::peg package require pluginmgr package require snit # ### ### ### ######### ######### ######### ## API snit::type ::pt::peg::import { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creation, destruction. constructor {} { install myinclude using ::fileutil::paths ${selfns}::INCLUDE return } destructor { $myinclude destroy # Clear the cache of loaded import plugins. foreach k [array names myplugin] { |
︙ | ︙ | |||
182 183 184 185 186 187 188 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready | | | 180 181 182 183 184 185 186 187 188 | ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide pt::peg::import 1.0.1 return |
Changes to modules/pt/pt_peg_import.test.
1 2 3 | # -*- tcl -*- # peg_import.test: tests for the pt::peg::import package. # | | < < > < | 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 | # -*- tcl -*- # peg_import.test: tests for the pt::peg::import package. # # Copyright (c) 2009-2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.5 testsNeedTcltest 2 support { use fileutil/fileutil.tcl fileutil ;# tests/common use snit/snit.tcl snit use fileutil/paths.tcl fileutil::paths use pluginmgr/pluginmgr.tcl pluginmgr useLocal pt_pexpression.tcl pt::pe useLocal pt_pegrammar.tcl pt::peg source [localPath tests/common] } testing { useLocalKeep pt_peg_import.tcl pt::peg::import |
︙ | ︙ |
Changes to modules/pt/tests/pt_peg_export.tests.
︙ | ︙ | |||
34 35 36 37 38 39 40 | test pt-peg-export-set:${setimpl}-5.0 {configuration names, wrong#args} -setup { pt::peg::export E } -body { E configuration names X } -cleanup { E destroy | | | | | | 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 | test pt-peg-export-set:${setimpl}-5.0 {configuration names, wrong#args} -setup { pt::peg::export E } -body { E configuration names X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test pt-peg-export-set:${setimpl}-6.0 {configuration get, wrong#args} -setup { pt::peg::export E } -body { E configuration get X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test pt-peg-export-set:${setimpl}-7.0 {configuration set, wrong#args} -setup { pt::peg::export E } -body { E configuration set } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test pt-peg-export-set:${setimpl}-7.1 {configuration set, wrong#args} -setup { pt::peg::export E } -body { E configuration set N V X } -cleanup { E destroy } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} # ------------------------------------------------------------------------- test pt-peg-export-set:${setimpl}-12.0 {configuration set, define single var} -setup { pt::peg::export E } -body { E configuration set N V |
︙ | ︙ |
Changes to modules/pt/tests/pt_peg_import.tests.
︙ | ︙ | |||
78 79 80 81 82 83 84 85 86 87 88 89 90 | I import object file O P F XXX } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::pt::peg::import::Snit_hmethodimport_object_file type selfns win self obj path ?format?"} # config unset - accepts any number of arguments. test pt-peg-import-5.0 {include paths, wrong#args} -setup { pt::peg::import I } -body { I include paths X } -cleanup { I destroy | > > > | | | | | | | 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 | I import object file O P F XXX } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::pt::peg::import::Snit_hmethodimport_object_file type selfns win self obj path ?format?"} # config unset - accepts any number of arguments. # ------------------------------------------------------------------------- ## `include` component, provided via fileutil::paths, search path for includes test pt-peg-import-5.0 {include paths, wrong#args} -setup { pt::peg::import I } -body { I include paths X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodpaths type selfns win self"} test pt-peg-import-6.0 {include clear, wrong#args} -setup { pt::peg::import I } -body { I include clear X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodclear type selfns win self"} test pt-peg-import-7.0 {include add, wrong#args} -setup { pt::peg::import I } -body { I include add } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test pt-peg-import-7.1 {include add, wrong#args} -setup { pt::peg::import I } -body { I include add P X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodadd type selfns win self path"} test pt-peg-import-8.0 {include remove, wrong#args} -setup { pt::peg::import I } -body { I include remove } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} test pt-peg-import-8.1 {include remove, wrong#args} -setup { pt::peg::import I } -body { I include remove P X } -cleanup { I destroy } -returnCodes error -result {wrong # args: should be "::fileutil::paths::Snit_methodremove type selfns win self path"} # ------------------------------------------------------------------------- test pt-peg-import9.0 {include paths, empty} -setup { pt::peg::import I } -body { I include paths |
︙ | ︙ |
Changes to modules/rc4/rc4.man.
︙ | ︙ | |||
112 113 114 115 116 117 118 | rc4::rc4 -in $socket -command [list ::Finish $ApplicationState] }] [section "AUTHORS"] Pat Thoyts [vset CATEGORY rc4] | | | 112 113 114 115 116 117 118 119 120 | rc4::rc4 -in $socket -command [list ::Finish $ApplicationState] }] [section "AUTHORS"] Pat Thoyts [vset CATEGORY rc4] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/rcs/rcs.man.
︙ | ︙ | |||
322 323 324 325 326 327 328 | [example {{{d 1 2} {d 4 1} {a 4 {The named is the mother of all things. }} {a 11 {They both may be called deep and profound. Deeper and more profound, The door of all subtleties!}}}}] [vset CATEGORY rcs] | | | 322 323 324 325 326 327 328 329 330 | [example {{{d 1 2} {d 4 1} {a 4 {The named is the mother of all things. }} {a 11 {They both may be called deep and profound. Deeper and more profound, The door of all subtleties!}}}}] [vset CATEGORY rcs] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/report/report.man.
︙ | ︙ | |||
468 469 470 471 472 473 474 | +---+-------------------+-------+-------+--------+ % % # alternate way of doing the above % m format 2string r }] [vset CATEGORY report] | | | 468 469 470 471 472 473 474 475 476 | +---+-------------------+-------+-------+--------+ % % # alternate way of doing the above % m format 2string r }] [vset CATEGORY report] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/rest/rest.man.
︙ | ︙ | |||
545 546 547 548 549 550 551 | package require tls http::register https 443 ::tls::socket }] [include ../common-text/tls-security-notes.inc] [vset CATEGORY rest] | | | 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 | package require tls http::register https 443 ::tls::socket }] [include ../common-text/tls-security-notes.inc] [vset CATEGORY rest] [include ../common-text/feedback.inc] [comment { TOKENS the value is substituted into the url at call time. tokens in the form of %name:default_value% will be an optional argument with a default value. }] [manpage_end] |
Changes to modules/ripemd/ripemd128.man.
︙ | ︙ | |||
183 184 185 186 187 188 189 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY ripemd] | | | 183 184 185 186 187 188 189 190 191 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY ripemd] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/ripemd/ripemd160.man.
︙ | ︙ | |||
167 168 169 170 171 172 173 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY ripemd] | | | 167 168 169 170 171 172 173 174 175 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY ripemd] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sasl/gtoken.man.
︙ | ︙ | |||
19 20 21 22 23 24 25 | [include ../common-text/tls-security-notes.inc] [section AUTHORS] Pat Thoyts [vset CATEGORY sasl] | | | 19 20 21 22 23 24 25 26 27 | [include ../common-text/tls-security-notes.inc] [section AUTHORS] Pat Thoyts [vset CATEGORY sasl] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sasl/ntlm.man.
︙ | ︙ | |||
28 29 30 31 32 33 34 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY sasl] | | | 28 29 30 31 32 33 34 35 36 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY sasl] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sasl/sasl.man.
︙ | ︙ | |||
332 333 334 335 336 337 338 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY sasl] | | | 332 333 334 335 336 337 338 339 340 | [list_end] [section AUTHORS] Pat Thoyts [vset CATEGORY sasl] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sasl/scram.man.
︙ | ︙ | |||
28 29 30 31 32 33 34 | [list_end] [section AUTHORS] Sergei Golovan [vset CATEGORY sasl] | | | 28 29 30 31 32 33 34 35 36 | [list_end] [section AUTHORS] Sergei Golovan [vset CATEGORY sasl] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sha1/pkgIndex.tcl.
1 2 3 4 5 6 7 8 9 10 11 | # Tcl package index file, version 1.1 # This file is generated by the "pkg_mkIndex" command # and sourced either when an application starts up or # by a "package unknown" script. It invokes the # "package ifneeded" command to set up package-related # information so that packages will be loaded automatically # in response to "package require" commands. When this # script is sourced, the variable $dir must contain the # full path name of this file's directory. if {![package vsatisfies [package provide Tcl] 8.2]} {return} | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | # Tcl package index file, version 1.1 # This file is generated by the "pkg_mkIndex" command # and sourced either when an application starts up or # by a "package unknown" script. It invokes the # "package ifneeded" command to set up package-related # information so that packages will be loaded automatically # in response to "package require" commands. When this # script is sourced, the variable $dir must contain the # full path name of this file's directory. if {![package vsatisfies [package provide Tcl] 8.2]} {return} package ifneeded sha256 1.0.4 [list source [file join $dir sha256.tcl]] package ifneeded sha1 2.0.4 [list source [file join $dir sha1.tcl]] package ifneeded sha1 1.1.1 [list source [file join $dir sha1v1.tcl]] |
Changes to modules/sha1/sha1.man.
|
| > | | | 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 | [vset VERSION 2.0.4] [manpage_begin sha1 n [vset VERSION]] [see_also md4] [see_also md5] [see_also ripemd128] [see_also ripemd160] [keywords {FIPS 180-1}] [keywords hashing] [keywords message-digest] [keywords {rfc 2104}] [keywords security] [keywords sha1] [moddesc {SHA-x Message-Digest Algorithm}] [copyright {2005, Pat Thoyts <[email protected]>}] [titledesc {SHA1 Message-Digest Algorithm}] [category {Hashes, checksums, and encryption}] [require Tcl 8.2] [require sha1 [opt [vset VERSION]]] [description] [para] This package provides an implementation in Tcl of the SHA1 message-digest algorithm as specified by FIPS PUB 180-1 (1). This algorithm takes a message and generates a 160-bit digest from the input. The SHA1 algorithm is related to the MD4 algorithm (2) but has |
︙ | ︙ | |||
174 175 176 177 178 179 180 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY sha1] | | | 175 176 177 178 179 180 181 182 183 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY sha1] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sha1/sha1.tcl.
︙ | ︙ | |||
640 641 642 643 644 645 646 647 648 649 650 | # ------------------------------------------------------------------------- # fileevent handler for chunked file hashing. # proc ::sha1::Chunk {token channel {chunksize 4096}} { upvar #0 $token state if {[eof $channel]} { fileevent $channel readable {} set state(reading) 0 } | > > | < | 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 | # ------------------------------------------------------------------------- # fileevent handler for chunked file hashing. # proc ::sha1::Chunk {token channel {chunksize 4096}} { upvar #0 $token state SHA1Update $token [read $channel $chunksize] if {[eof $channel]} { fileevent $channel readable {} set state(reading) 0 } return } # ------------------------------------------------------------------------- proc ::sha1::sha1 {args} { array set opts {-hex 0 -filename {} -channel {} -chunksize 4096} if {[llength $args] == 1} { |
︙ | ︙ | |||
800 801 802 803 804 805 806 | SwitchTo $e break } } unset e } | | | 801 802 803 804 805 806 807 808 809 810 811 812 813 814 | SwitchTo $e break } } unset e } package provide sha1 2.0.4 # ------------------------------------------------------------------------- # Local Variables: # mode: tcl # indent-tabs-mode: nil # End: |
Changes to modules/sha1/sha256.man.
|
| > | | | 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 | [vset VERSION 1.0.4] [manpage_begin sha256 n [vset VERSION]] [see_also md4] [see_also md5] [see_also ripemd128] [see_also ripemd160] [see_also sha1] [keywords {FIPS 180-1}] [keywords hashing] [keywords message-digest] [keywords {rfc 2104}] [keywords security] [keywords sha256] [moddesc {SHA-x Message-Digest Algorithm}] [copyright {2008, Andreas Kupries <[email protected]>}] [titledesc {SHA256 Message-Digest Algorithm}] [category {Hashes, checksums, and encryption}] [require Tcl 8.2] [require sha256 [opt [vset VERSION]]] [description] [para] This package provides an implementation in Tcl of the SHA256 and SHA224 message-digest algorithms as specified by FIPS PUB 180-1 (1). These algorithms take a message and generates a 256-bit (224-bit) digest from the input. The SHA2 algorithms are related to the SHA1 |
︙ | ︙ | |||
186 187 188 189 190 191 192 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY sha1] | | | 187 188 189 190 191 192 193 194 195 | Krawczyk, H., Bellare, M. and Canetti, R. "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997. ([uri http://www.rfc-editor.org/rfc/rfc2104.txt]) [list_end] [vset CATEGORY sha1] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/sha1/sha256.tcl.
︙ | ︙ | |||
27 28 29 30 31 32 33 34 35 36 37 38 39 40 | namespace eval ::sha2 { variable accel array set accel {tcl 0 critcl 0} variable loaded {} namespace export sha256 hmac \ SHA256Init SHA256Update SHA256Final variable uid if {![info exists uid]} { set uid 0 } variable K | > | 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | namespace eval ::sha2 { variable accel array set accel {tcl 0 critcl 0} variable loaded {} namespace export sha256 hmac \ SHA256Init SHA256Update SHA256Final variable uid if {![info exists uid]} { set uid 0 } variable K |
︙ | ︙ | |||
171 172 173 174 175 176 177 | if {![string equal $loaded ""]} { foreach c { SHA256Init SHA224Init SHA256Final SHA224Final SHA256Update } { | | | | 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 | if {![string equal $loaded ""]} { foreach c { SHA256Init SHA224Init SHA256Final SHA224Final SHA256Update } { interp alias {} ::sha2::$c {} } } # Activate the new implementation, if there is any. if {![string equal $key ""]} { foreach c { SHA256Init SHA224Init SHA256Final SHA224Final SHA256Update } { interp alias {} ::sha2::$c {} ::sha2::${c}-${key} } } # Remember the active implementation, for deactivation by future # switches. set loaded $key |
︙ | ︙ | |||
655 656 657 658 659 660 661 662 663 664 665 | # ------------------------------------------------------------------------- # fileevent handler for chunked file hashing. # proc ::sha2::Chunk {token channel {chunksize 4096}} { upvar #0 $token state if {[eof $channel]} { fileevent $channel readable {} set state(reading) 0 } | > > | < | 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 | # ------------------------------------------------------------------------- # fileevent handler for chunked file hashing. # proc ::sha2::Chunk {token channel {chunksize 4096}} { upvar #0 $token state SHA256Update $token [read $channel $chunksize] if {[eof $channel]} { fileevent $channel readable {} set state(reading) 0 } return } # ------------------------------------------------------------------------- proc ::sha2::_sha256 {ver args} { array set opts {-hex 0 -filename {} -channel {} -chunksize 4096} if {[llength $args] == 1} { |
︙ | ︙ | |||
695 696 697 698 699 700 701 | if {$opts(-filename) != {}} { set opts(-channel) [open $opts(-filename) r] fconfigure $opts(-channel) -translation binary } if {$opts(-channel) == {}} { | < | 697 698 699 700 701 702 703 704 705 706 707 708 709 710 | if {$opts(-filename) != {}} { set opts(-channel) [open $opts(-filename) r] fconfigure $opts(-channel) -translation binary } if {$opts(-channel) == {}} { if {[llength $args] != 1} { return -code error "wrong # args: should be\ \"[namespace current]::sha$ver ?-hex|-bin? -filename file\ | -channel channel | string\"" } set tok [SHA${ver}Init] SHA${ver}Update $tok [lindex $args 0] |
︙ | ︙ | |||
819 820 821 822 823 824 825 | SwitchTo $e break } } unset e } | | | 820 821 822 823 824 825 826 827 828 829 830 831 832 833 | SwitchTo $e break } } unset e } package provide sha256 1.0.4 # ------------------------------------------------------------------------- # Local Variables: # mode: tcl # indent-tabs-mode: nil # End: |
Changes to modules/smtpd/smtpd.man.
︙ | ︙ | |||
286 287 288 289 290 291 292 | This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the file [file license.terms] for more details. [vset CATEGORY smtpd] | | | 286 287 288 289 290 291 292 293 294 | This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the file [file license.terms] for more details. [vset CATEGORY smtpd] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/snit/snit.man.
︙ | ︙ | |||
2831 2832 2833 2834 2835 2836 2837 | Andreas Kupries, Marty Backe, Andy Goth, Jeff Hobbs, Brian Griffin, Donal Fellows, Miguel Sofer, Kenneth Green, and Anton Kovalenko. If I've forgotten anyone, my apologies; let me know and I'll add your name to the list. [vset CATEGORY snit] | | | 2831 2832 2833 2834 2835 2836 2837 2838 2839 | Andreas Kupries, Marty Backe, Andy Goth, Jeff Hobbs, Brian Griffin, Donal Fellows, Miguel Sofer, Kenneth Green, and Anton Kovalenko. If I've forgotten anyone, my apologies; let me know and I'll add your name to the list. [vset CATEGORY snit] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/snit/snitfaq.man.
︙ | ︙ | |||
4106 4107 4108 4109 4110 4111 4112 | mylib::propagate -background to {comp1 comp2 comp3} mylib::propagate -foreground to {comp1 comp2 comp3} } }] [vset CATEGORY snit] | | | 4106 4107 4108 4109 4110 4111 4112 4113 4114 | mylib::propagate -background to {comp1 comp2 comp3} mylib::propagate -foreground to {comp1 comp2 comp3} } }] [vset CATEGORY snit] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/soundex/soundex.man.
︙ | ︙ | |||
37 38 39 40 41 42 43 | [example { % ::soundex::knuth Knuth K530 }] [vset CATEGORY soundex] | | | 37 38 39 40 41 42 43 44 45 | [example { % ::soundex::knuth Knuth K530 }] [vset CATEGORY soundex] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/stooop/stooop.man.
︙ | ︙ | |||
215 216 217 218 219 220 221 | [list_end] [section EXAMPLES] Please see the full HTML documentation in [uri stooop_man.html]. [vset CATEGORY stooop] | | | 215 216 217 218 219 220 221 222 223 | [list_end] [section EXAMPLES] Please see the full HTML documentation in [uri stooop_man.html]. [vset CATEGORY stooop] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/stooop/switched.man.
︙ | ︙ | |||
320 321 322 323 324 325 326 | ... } }] [list_end] [vset CATEGORY stooop] | | | 320 321 322 323 324 325 326 327 328 | ... } }] [list_end] [vset CATEGORY stooop] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/string/token.man.
︙ | ︙ | |||
89 90 91 92 93 94 95 | [para] Further note that all regex patterns are implicitly prefixed with the constraint escape [const \A] to ensure that a match starts exactly at the character index found in [arg startvar]. [list_end] [vset CATEGORY textutil] | | | 89 90 91 92 93 94 95 96 97 | [para] Further note that all regex patterns are implicitly prefixed with the constraint escape [const \A] to ensure that a match starts exactly at the character index found in [arg startvar]. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/string/token_shell.man.
︙ | ︙ | |||
133 134 135 136 137 138 139 | [para] Whitespace may occur before the first word, or after the last word. Whitespace must occur between adjacent words. [list_end] [list_end] [vset CATEGORY textutil] | | | 133 134 135 136 137 138 139 140 141 | [para] Whitespace may occur before the first word, or after the last word. Whitespace must occur between adjacent words. [list_end] [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/stringprep/stringprep.man.
︙ | ︙ | |||
143 144 145 146 147 148 149 | [list_end] [section "AUTHORS"] Sergei Golovan [vset CATEGORY stringprep] | | | 143 144 145 146 147 148 149 150 151 | [list_end] [section "AUTHORS"] Sergei Golovan [vset CATEGORY stringprep] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/stringprep/stringprep_data.man.
︙ | ︙ | |||
13 14 15 16 17 18 19 | The [package stringprep::data] package is a helper for [package stringprep], providing it with the data tables needed to perform its functions. It is an [emph internal] package which should not be accessed on its own. Because of that it has no publicly documented API either. Its implementation is generated by a script. [vset CATEGORY stringprep] | | | 13 14 15 16 17 18 19 20 21 | The [package stringprep::data] package is a helper for [package stringprep], providing it with the data tables needed to perform its functions. It is an [emph internal] package which should not be accessed on its own. Because of that it has no publicly documented API either. Its implementation is generated by a script. [vset CATEGORY stringprep] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/stringprep/unicode.man.
︙ | ︙ | |||
75 76 77 78 79 80 81 | [list_end] [section "AUTHORS"] Sergei Golovan [vset CATEGORY stringprep] | | | 75 76 77 78 79 80 81 82 83 | [list_end] [section "AUTHORS"] Sergei Golovan [vset CATEGORY stringprep] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/stringprep/unicode_data.man.
︙ | ︙ | |||
13 14 15 16 17 18 19 | The [package unicode::data] package is a helper for [package unicode], providing it with the data tables needed to perform its functions. It is an [emph internal] package which should not be accessed on its own. Because of that it has no publicly documented API either. Its implementation is generated by a script. [vset CATEGORY stringprep] | | | 13 14 15 16 17 18 19 20 21 | The [package unicode::data] package is a helper for [package unicode], providing it with the data tables needed to perform its functions. It is an [emph internal] package which should not be accessed on its own. Because of that it has no publicly documented API either. Its implementation is generated by a script. [vset CATEGORY stringprep] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/disjointset.man.
︙ | ︙ | |||
228 229 230 231 232 233 234 | [call [arg disjointsetName] [method destroy]] Destroys the disjoint set object and all associated memory. [list_end] [vset CATEGORY {struct :: disjointset}] | | | 228 229 230 231 232 233 234 235 236 | [call [arg disjointsetName] [method destroy]] Destroys the disjoint set object and all associated memory. [list_end] [vset CATEGORY {struct :: disjointset}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/graph.man.
|
| | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | [comment {-*- tcl -*-}][vset VERSION 2.4.2] [manpage_begin struct::graph n [vset VERSION]] [keywords adjacent] [keywords arc] [keywords cgraph] [keywords degree] [keywords edge] [keywords graph] [keywords loop] [keywords neighbour] [keywords node] [keywords serialization] [keywords subgraph] [keywords vertex] [copyright {2002-2009,2019 Andreas Kupries <[email protected]>}] [moddesc {Tcl Data Structures}] [titledesc {Create and manipulate directed graph objects}] [category {Data structures}] [require Tcl 8.4] [require struct::graph [opt [vset VERSION]]] [require struct::list [opt 1.5]] [require struct::set [opt 2.2.3]] |
︙ | ︙ | |||
393 394 395 396 397 398 399 | command can be used as well. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself. [para] The restrictions imposed by either [option -in], [option -out], | | | 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 | command can be used as well. The restrictions that involve connected nodes take a variable number of nodes as argument, specified after the name of the restriction itself. [para] The restrictions imposed by either [option -in], [option -out], [option -adj], [option -inner], or [option -embedding] are applied first. Specifying more than one of them is illegal. [para] After that the restrictions set via [option -key] (and [option -value]) are applied. Specifying more than one [option -key] (and [option -value]) is illegal. Specifying [option -value] alone, |
︙ | ︙ | |||
444 445 446 447 448 449 450 451 452 453 454 455 456 457 | [def [option -embedding]] Return a list of all arcs adjacent to exactly one of the nodes in the set. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph. [def "[option -key] [arg key]"] Limit the list of arcs that are returned to those arcs that have an associated key [arg key]. [def "[option -value] [arg value]"] | > > > > > > > > > > > > > > > > | 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 | [def [option -embedding]] Return a list of all arcs adjacent to exactly one of the nodes in the set. This is the set of arcs connecting the subgraph spawned by the specified nodes to the rest of the graph. [list_end] [emph Attention]: After the above options any word with a leading dash which is not a valid option is treated as a node name instead of an invalid option to error out on. This condition holds until either a valid option terminates the list of nodes, or the end of the command is reached, whichever comes first. [para] The remaining filter options are: [para] [list_begin definitions] [def "[option -key] [arg key]"] Limit the list of arcs that are returned to those arcs that have an associated key [arg key]. [def "[option -value] [arg value]"] |
︙ | ︙ | |||
605 606 607 608 609 610 611 | of returned nodes based on neighboring nodes, or based on the keyed values associated with the node. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself. [para] | | > | > > > > > | | 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | of returned nodes based on neighboring nodes, or based on the keyed values associated with the node. The restrictions that involve neighboring nodes have a list of nodes as argument, specified after the name of the restriction itself. [para] The possible restrictions are the same as for method [method arcs]. Note that while the exact meanings change slightly, as they operate on nodes instead of arcs, the general behaviour is the same, especially when it comes to the handling of words with a leading dash in node lists. [para] The command recognizes: [list_begin definitions] [def [option -in]] Return a list of all nodes with at least one outgoing arc ending in a node found in the specified set of nodes. Alternatively specified as the set of source nodes for the [option -in] arcs of the node set. The |
︙ | ︙ | |||
934 935 936 937 938 939 940 | Both methods [method arcs] and [method nodes] have been extended with the ability to select arcs and nodes based on an arbitrary filtering criterium. [list_end] [vset CATEGORY {struct :: graph}] | | | 956 957 958 959 960 961 962 963 964 | Both methods [method arcs] and [method nodes] have been extended with the ability to select arcs and nodes based on an arbitrary filtering criterium. [list_end] [vset CATEGORY {struct :: graph}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/graph.tcl.
︙ | ︙ | |||
173 174 175 176 177 178 179 | ## Ready namespace eval ::struct { # Export the constructor command. namespace export graph } | | | 173 174 175 176 177 178 179 180 | ## Ready namespace eval ::struct { # Export the constructor command. namespace export graph } package provide struct::graph 2.4.2 |
Changes to modules/struct/graph.test.
1 2 3 4 5 6 7 8 | # -*- tcl -*- # graph.test: tests for the graph structure. # # This file contains a collection of tests for one or more of the Tcl # built-in commands. Sourcing this file into Tcl runs the tests and # generates output for errors. No output means no errors were found. # # Copyright (c) 1998-2000 by Ajuba Solutions. | | < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | # -*- tcl -*- # graph.test: tests for the graph structure. # # This file contains a collection of tests for one or more of the Tcl # built-in commands. Sourcing this file into Tcl runs the tests and # generates output for errors. No output means no errors were found. # # Copyright (c) 1998-2000 by Ajuba Solutions. # Copyright (c) 2017,2019 Andreas Kupries # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] |
︙ | ︙ |
Changes to modules/struct/graph/tests/nodes.test.
︙ | ︙ | |||
11 12 13 14 15 16 17 18 19 20 21 22 23 24 | # (3) graph nodes -in NODE... # graph nodes -out NODE... # graph nodes -adj NODE... # graph nodes -inner NODE... # graph nodes -embedded NODE... # We can use one in each group (1,2,3) # ------------------------------------------------------------------------- # Wrong # args: Missing, Too many # Cannot have missing arguments (zero is fine), # except when switches are in use. That however # is tested with the switches. Ditto for too many | > > > > > | 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | # (3) graph nodes -in NODE... # graph nodes -out NODE... # graph nodes -adj NODE... # graph nodes -inner NODE... # graph nodes -embedded NODE... # We can use one in each group (1,2,3) # Note: node names may have a leading dash ('-'). # Heuristics: Unknown options after (3) are considered node names # until we reach a valid option. # ------------------------------------------------------------------------- # Wrong # args: Missing, Too many # Cannot have missing arguments (zero is fine), # except when switches are in use. That however # is tested with the switches. Ditto for too many |
︙ | ︙ | |||
232 233 234 235 236 237 238 | } # ------------------------------------------------------------------------- # Ok arguments. set n 0 foreach {switch nodes expected} { | | | | | | | | | | > > > > > > > > > > > > > > > > | | > > | > > > | 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 | } # ------------------------------------------------------------------------- # Ok arguments. set n 0 foreach {switch nodes expected} { -in {1 2 3} {-1 1 2 3 4 5 6} -in {4 5 6} {} -out {1 2 3} {1 2 3} -out {4 5 6} {1 2 3} -adj {1 2 3} {-1 1 2 3 4 5 6} -adj {4 5 6} {1 2 3} -inner {1 2 3} {1 2 3} -inner {4 5 6} {} -embedding {1 2 3} {-1 4 5 6} -embedding {4 5 6} {1 2 3} -in {1 2} {-1 1 3 4 5} -in {4 5} {} -out {1 2} {2 3} -out {4 5} {1 2} -adj {1 2} {-1 1 2 3 4 5} -adj {4 5} {1 2} -inner {1 2} {1 2} -inner {4 5} {} -embedding {1 2} {-1 3 4 5} -embedding {4 5} {1 2} -in {1} {3 4} -in {4} {} -out {1} {2} -out {4} {1} -adj {1} {2 3 4} -adj {4} {1} -inner {1} {} -inner {4} {} -embedding {1} {2 3 4} -embedding {4} {1} -in {1 4} {3 4} -in {4 2} {-1 1 5} -out {1 4} {1 2} -out {4 2} {1 3} -adj {1 4} {1 2 3 4} -adj {4 2} {-1 1 3 5} -inner {1 4} {1 4} -inner {4 2} {} -embedding {1 4} {2 3} -embedding {4 2} {-1 1 3 5} -in {1 -1} {3 4} -out {1 -1} 2 -adj {1 -1} {2 3 4} -inner {1 -1} {} -embedding {1 -1} {2 3 4} } { lappend expected $switch $nodes test graph-${impl}-${setimpl}-nodes-ioaie-3.$n "nodes, $switch" { SETUP # Nodes (digits -1,1-6) and arcs (letters A-G), no direction # 4 # |A # 1 -1 # D/ \ /G # / \E/ # 3 --- 2 # C/ F \B # 6 5 mygraph node insert 1 2 3 4 5 6 -1 mygraph arc insert 4 1 A mygraph arc insert 5 2 B mygraph arc insert 6 3 C mygraph arc insert 3 1 D mygraph arc insert 1 2 E mygraph arc insert 2 3 F mygraph arc insert -1 2 G set result [lsort [eval [linsert $nodes 0 mygraph nodes $switch]]] mygraph destroy lappend result $switch $nodes set result } $expected ; # {} incr n } # --------------------------------------------------- # Test with many parallel arcs, beyond the number of nodes, i.e. lots # of duplicated sources and destinations, to check that the dup # removal works correctly. See bug [SF 1923685]. set n 0 foreach {switch nodes expected} { -in 2 1 -out 2 3 -adj 2 {1 3} -inner {1 2 3} {1 2 3} -embedding 2 {1 3} } { lappend expected $switch $nodes test graph-${impl}-${setimpl}-nodes-parallel-ioaie-bug1923685-4.$n "nodes, $switch, parallel arcs, bug 1923685" { SETUP mygraph node insert 1 2 3 4 mygraph arc insert 1 2 A ; mygraph arc insert 2 3 A. mygraph arc insert 1 2 B ; mygraph arc insert 2 3 B. mygraph arc insert 1 2 C ; mygraph arc insert 2 3 C. mygraph arc insert 1 2 D ; mygraph arc insert 2 3 D. mygraph arc insert 1 2 E ; mygraph arc insert 2 3 E. mygraph arc insert 1 2 F ; mygraph arc insert 2 3 F. mygraph arc insert 1 2 G ; mygraph arc insert 2 3 G. mygraph arc insert 1 2 H ; mygraph arc insert 2 3 H. set result [lsort [eval [linsert $nodes 0 mygraph nodes $switch]]] mygraph destroy lappend result $switch $nodes set result } $expected ; # {} incr n } # --------------------------------------------------- |
Changes to modules/struct/graph1.man.
︙ | ︙ | |||
367 368 369 370 371 372 373 | node appended. For a pre-order walk, all nodes are [const enter]ed, for a post-order all nodes are left. In a both-order walk the first visit of a node [const enter]s it, the second visit [const leave]s it. [list_end] [vset CATEGORY {struct :: graph}] | | | 367 368 369 370 371 372 373 374 375 | node appended. For a pre-order walk, all nodes are [const enter]ed, for a post-order all nodes are left. In a both-order walk the first visit of a node [const enter]s it, the second visit [const leave]s it. [list_end] [vset CATEGORY {struct :: graph}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/graph_tcl.tcl.
1 2 3 4 | # graph_tcl.tcl -- # # Implementation of a graph data structure for Tcl. # | | | < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | # graph_tcl.tcl -- # # Implementation of a graph data structure for Tcl. # # Copyright (c) 2000-2009,2019 by Andreas Kupries <[email protected]> # Copyright (c) 2008 by Alejandro Paz <[email protected]> # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. package require Tcl 8.4 package require struct::list package require struct::set namespace eval ::struct::graph { # Data storage in the graph module |
︙ | ︙ | |||
2997 2998 2999 3000 3001 3002 3003 | upvar 1 value value ; set value {} upvar 1 haveFilter haveFilter ; set haveFilter 0 upvar 1 fcmd fcmd ; set fcmd {} upvar 1 cond cond ; set cond "none" upvar 1 condNodes condNodes ; set condNodes {} set wa_usage "wrong # args: should be \"$name $what ?-key key? ?-value value? ?-filter cmd? ?-in|-out|-adj|-inner|-embedding node node...?\"" | > | > > > > > > > | > | 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 | upvar 1 value value ; set value {} upvar 1 haveFilter haveFilter ; set haveFilter 0 upvar 1 fcmd fcmd ; set fcmd {} upvar 1 cond cond ; set cond "none" upvar 1 condNodes condNodes ; set condNodes {} set wa_usage "wrong # args: should be \"$name $what ?-key key? ?-value value? ?-filter cmd? ?-in|-out|-adj|-inner|-embedding node node...?\"" set seenodes 0 for {set i 0} {$i < [llength $arguments]} {incr i} { set arg [lindex $arguments $i] switch -glob -- $arg { -in - -out - -adj - -inner - -embedding { if {$haveCond} { return -code error "invalid restriction:\ illegal multiple use of\ \"-in\"|\"-out\"|\"-adj\"|\"-inner\"|\"-embedding\"" } set haveCond 1 set cond [string range $arg 1 end] set seenodes 1 } -key { if {($i + 1) == [llength $arguments]} { return -code error $wa_usage } if {$haveKey} { return -code error {invalid restriction: illegal multiple use of "-key"} } incr i set key [lindex $arguments $i] set haveKey 1 set seenodes 0 } -value { if {($i + 1) == [llength $arguments]} { return -code error $wa_usage } if {$haveValue} { return -code error {invalid restriction: illegal multiple use of "-value"} } incr i set value [lindex $arguments $i] set haveValue 1 set seenodes 0 } -filter { if {($i + 1) == [llength $arguments]} { return -code error $wa_usage } if {$haveFilter} { return -code error {invalid restriction: illegal multiple use of "-filter"} } incr i set fcmd [lindex $arguments $i] set haveFilter 1 set seenodes 0 } -* { if {$seenodes} { lappend condNodes $arg } else { return -code error "bad restriction \"$arg\": must be -adj, -embedding,\ -filter, -in, -inner, -key, -out, or -value" } } default { lappend condNodes $arg } } } |
︙ | ︙ |
Changes to modules/struct/graphops.man.
︙ | ︙ | |||
1311 1312 1313 1314 1315 1316 1317 | [enum] [uri http://www.csc.kth.se/~viggo/wwwcompendium/node128.html {K-Center problem}] [enum] [uri http://en.wikipedia.org/wiki/Breadth-first_search {BFS}] [enum] [uri http://en.wikipedia.org/wiki/Degree-constrained_spanning_tree {Minimum Degree Spanning Tree}] [enum] [uri http://en.wikipedia.org/wiki/Approximation_algorithm {Approximation algorithm}] [list_end] [vset CATEGORY {struct :: graph}] | | | 1311 1312 1313 1314 1315 1316 1317 1318 1319 | [enum] [uri http://www.csc.kth.se/~viggo/wwwcompendium/node128.html {K-Center problem}] [enum] [uri http://en.wikipedia.org/wiki/Breadth-first_search {BFS}] [enum] [uri http://en.wikipedia.org/wiki/Degree-constrained_spanning_tree {Minimum Degree Spanning Tree}] [enum] [uri http://en.wikipedia.org/wiki/Approximation_algorithm {Approximation algorithm}] [list_end] [vset CATEGORY {struct :: graph}] [include ../common-text/feedback.inc] [manpage_end] |
Name change from modules/doctools2base/config.tcl to modules/struct/map.tcl.
|
| | < < < < | < < > > | < > > > | | > > > > > > > > > > > > > > > > > > > > > > > > > | | | | | | | | | | | | 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 | # map.tcl -- # Copyright (c) 2009-2019 Andreas Kupries <[email protected]> # # Object wrapper around array/dict. Useful as key/value store in # larger systems. # # Examples: # - configuration mgmt in doctools v2 import/export managers # - pt import/export managers # # Each object manages a key/value map. # ### ### ### ######### ######### ######### ## Requisites package require Tcl 8.4 package require snit # ### ### ### ######### ######### ######### ## API # ATTENTION: ## # From an API point of view the code below is equivalent to the much # shorter `snit::type struct::map { ... }`. # # Then why the more complex form ? # # When snit compiles the class to Tcl code, and later on when methods # are executed it will happen in the `struct` namespace. The moment # this package is used together with `struct::set` all unqualified # `set` statements will go bonkers, eiter in snit, or, here, in method # `set`, because they get resolved to the `struct::set` dispatcher # instead of `::set`. Moving the implementation a level deeper makes # the `struct::map` namespace the context, with no conflict. # Future / TODO: Convert all the OO stuff here over to TclOO, as much # as possible (snit configure/cget support is currently still better, # ditto hierarchical methods). namespace eval ::struct {} proc ::struct::map {args} { uplevel 1 [linsert $args 0 struct::map::I] } snit::type ::struct::map::I { # ### ### ### ######### ######### ######### ## Options :: None # ### ### ### ######### ######### ######### ## Creating, destruction # Default constructor. # Default destructor. # ### ### ### ######### ######### ######### ## Public methods. Reading and writing the map. method names {} { return [array names mymap] } method get {} { return [array get mymap] } method set {name {value {}}} { # 7 instead of 3 in the condition below, because of the 4 # implicit arguments snit is providing to each method. if {[llength [info level 0]] == 7} { ::set mymap($name) $value } elseif {![info exists mymap($name)]} { return -code error "can't read \"$name\": no such variable" } return $mymap($name) } method unset {args} { if {![llength $args]} { lappend args * } foreach pattern $args { array unset mymap $pattern } return } # ### ### ### ######### ######### ######### ## Internal methods :: None. # ### ### ### ######### ######### ######### ## State :: Map data, Tcl array variable mymap -array {} ## # ### ### ### ######### ######### ######### } # ### ### ### ######### ######### ######### ## Ready package provide struct::map 1 return |
Added modules/struct/map.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # -*- tcl -*- # map.test: Testsuite for package struct::map # # Copyright (c) 2019 by Andreas Kupries <[email protected]> # All rights reserved. # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.4 testsNeedTcltest 2.0 support { use snit/snit.tcl snit } testing { useLocal map.tcl struct::map } # --------------------------------------------------------------------- # [] constructor # [] destructor # [] get # [] names # [] set # [] unset #---------------------------------------------------------------------- ## Constructor, destructor test struct-map-1.0 {constructor, wrong args, too many} -body { struct::map M X } -returnCodes error -result {Error in constructor: wrong # args: should be "::struct::map::I::Snit_constructor type selfns win self"} test struct-map-1.1 {instance, bogus method} -setup { struct::map M } -cleanup { M destroy } -body { M bogus } -returnCodes error -result {"::M bogus" is not defined} #---------------------------------------------------------------------- ## get test struct-map-2.0 {get, wrong args, too many} -setup { struct::map M } -cleanup { M destroy } -body { M get X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodget type selfns win self"} test struct-map-2.1 {get, base state, none} -setup { struct::map M } -cleanup { M destroy } -body { M get } -result {} #---------------------------------------------------------------------- ## names test struct-map-3.0 {names, wrong args, too many} -setup { struct::map M } -cleanup { M destroy } -body { M names X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodnames type selfns win self"} test struct-map-3.1 {names, base state, none} -setup { struct::map M } -cleanup { M destroy } -body { M names } -result {} #---------------------------------------------------------------------- ## set test struct-map-4.0 {set, wrong args, not enough} -setup { struct::map M } -cleanup { M destroy } -body { M set } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test struct-map-4.1 {set, wrong args, too many} -setup { struct::map M } -cleanup { M destroy } -body { M set K V X } -returnCodes error -result {wrong # args: should be "::struct::map::I::Snit_methodset type selfns win self name ?value?"} test struct-map-4.2 {set, state change, result} -setup { struct::map M } -cleanup { M destroy } -body { list [M names] [M get] [M set K V] [M names] [M get] } -result {{} {} V K {K V}} #---------------------------------------------------------------------- ## unset test struct-map-5.2 {unset, known key, state change, result} -setup { struct::map M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset K] [M names] [M get] } -result {K {K V} {} {} {}} test struct-map-5.3 {unset, missing key, no state change, result} -setup { struct::map M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset K'] [M names] [M get] } -result {K {K V} {} K {K V}} test struct-map-5.4 {unset, no pattern, clear, result} -setup { struct::map M M set K V } -cleanup { M destroy } -body { list [M names] [M get] [M unset] [M names] [M get] } -result {K {K V} {} {} {}} #---------------------------------------------------------------------- testsuiteCleanup return |
Changes to modules/struct/matrix.man.
︙ | ︙ | |||
531 532 533 534 535 536 537 | +---+-------------------+-------+-------+--------+ % % # alternate way of doing the above % r printmatrix m }] [vset CATEGORY {struct :: matrix}] | | | 531 532 533 534 535 536 537 538 539 | +---+-------------------+-------+-------+--------+ % % # alternate way of doing the above % r printmatrix m }] [vset CATEGORY {struct :: matrix}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/matrix1.man.
︙ | ︙ | |||
373 374 375 376 377 378 379 | +---+-------------------+-------+-------+--------+ % % # alternate way of doing the above % r printmatrix m }] [vset CATEGORY {struct :: matrix}] | | | 373 374 375 376 377 378 379 380 381 | +---+-------------------+-------+-------+--------+ % % # alternate way of doing the above % r printmatrix m }] [vset CATEGORY {struct :: matrix}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/pkgIndex.tcl.
︙ | ︙ | |||
14 15 16 17 18 19 20 | package ifneeded struct::graph 1.2.1 [list source [file join $dir graph1.tcl]] package ifneeded struct::tree 1.2.2 [list source [file join $dir tree1.tcl]] package ifneeded struct::matrix 1.2.1 [list source [file join $dir matrix1.tcl]] if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded struct::list 1.8.4 [list source [file join $dir list.tcl]] | | > | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | package ifneeded struct::graph 1.2.1 [list source [file join $dir graph1.tcl]] package ifneeded struct::tree 1.2.2 [list source [file join $dir tree1.tcl]] package ifneeded struct::matrix 1.2.1 [list source [file join $dir matrix1.tcl]] if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded struct::list 1.8.4 [list source [file join $dir list.tcl]] package ifneeded struct::graph 2.4.2 [list source [file join $dir graph.tcl]] package ifneeded struct::map 1 [list source [file join $dir map.tcl]] if {![package vsatisfies [package provide Tcl] 8.5]} {return} if {![package vsatisfies [package provide Tcl] 8.6]} {return} package ifneeded struct::disjointset 1.1 [list source [file join $dir disjointset.tcl]] package ifneeded struct::graph::op 0.11.3 [list source [file join $dir graphops.tcl]] |
Changes to modules/struct/pool.man.
︙ | ︙ | |||
435 436 437 438 439 440 441 | # all connections are currently occupied # store the client request in a queue for later processing, # or return a 'Server busy' message to the client. } }] [vset CATEGORY {struct :: pool}] | | | 435 436 437 438 439 440 441 442 443 | # all connections are currently occupied # store the client request in a queue for later processing, # or return a 'Server busy' message to the client. } }] [vset CATEGORY {struct :: pool}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/prioqueue.man.
︙ | ︙ | |||
103 104 105 106 107 108 109 | [call [arg prioqueueName] [cmd size]] Return the number of items in the prioqueue. [list_end] [vset CATEGORY {struct :: prioqueue}] | | | 103 104 105 106 107 108 109 110 111 | [call [arg prioqueueName] [cmd size]] Return the number of items in the prioqueue. [list_end] [vset CATEGORY {struct :: prioqueue}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/queue.man.
︙ | ︙ | |||
88 89 90 91 92 93 94 | [call [arg queueName] [cmd size]] Return the number of items in the queue. [list_end] [vset CATEGORY {struct :: queue}] | | | 88 89 90 91 92 93 94 95 96 | [call [arg queueName] [cmd size]] Return the number of items in the queue. [list_end] [vset CATEGORY {struct :: queue}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/record.man.
︙ | ︙ | |||
385 386 387 388 389 390 391 | % }] [para] [vset CATEGORY {struct :: record}] | | | 385 386 387 388 389 390 391 392 393 | % }] [para] [vset CATEGORY {struct :: record}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/skiplist.man.
︙ | ︙ | |||
78 79 80 81 82 83 84 | Walk the skiplist from the first node to the last. At each node, the command [arg cmd] will be evaluated with the key and value of the current node appended. [list_end] [vset CATEGORY {struct :: skiplist}] | | | 78 79 80 81 82 83 84 85 86 | Walk the skiplist from the first node to the last. At each node, the command [arg cmd] will be evaluated with the key and value of the current node appended. [list_end] [vset CATEGORY {struct :: skiplist}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/stack.man.
︙ | ︙ | |||
100 101 102 103 104 105 106 | [call [arg stackName] [method size]] Return the number of items on the stack. [list_end] [vset CATEGORY {struct :: stack}] | | | 100 101 102 103 104 105 106 107 108 | [call [arg stackName] [method size]] Return the number of items on the stack. [list_end] [vset CATEGORY {struct :: stack}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/struct_list.man.
︙ | ︙ | |||
822 823 824 825 826 827 828 | Donald E. Knuth, "Fascicle 2b of 'The Art of Computer Programming' volume 4". Available on the Web at the author's personal site: [uri http://www-cs-faculty.stanford.edu/~knuth/fasc2b.ps.gz]. [list_end] [vset CATEGORY {struct :: list}] | | | 822 823 824 825 826 827 828 829 830 | Donald E. Knuth, "Fascicle 2b of 'The Art of Computer Programming' volume 4". Available on the Web at the author's personal site: [uri http://www-cs-faculty.stanford.edu/~knuth/fasc2b.ps.gz]. [list_end] [vset CATEGORY {struct :: list}] [include ../common-text/feedback.inc] [manpage_end] |
Added modules/struct/struct_map.man.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | [comment {-*- text -*- doctools manpage}] [vset VERSION 1] [manpage_begin struct::map n [vset VERSION]] [titledesc {Manage key/value maps}] [require struct::map [opt [vset VERSION]]] [description] Provides a snit class whose instances manage a key/value map. In other words, an object wrapper around Tcl arrays. [section API] The main command provides construction of maps: [list_begin definitions] [call [cmd ::struct::map] [arg mapName]] Creates a new, empty map with an associated global Tcl command whose name is [arg mapName]. It may be used to invoke various operations on the map. It has the following general form: [list_begin definitions] [call [cmd mapName] [method method] [opt [arg "arg arg ..."]]] [method method] and [arg arg]uments determine the exact behavior of the command. [list_end][comment --instance-command--] If [arg mapName] is specified as [const %AUTO%] a unique name will be generated by the package itself. The result of the command is the fully-qualified name of the instance command. [list_end][comment --class-command--] [para] The following commands are possible for map objects: [list_begin definitions] [call [arg mapName] [method get]] Returns the entire map as a Tcl dictionary. [call [arg mapName] [method names]] Returns the list of all keys known to the map, in arbitrary order. [call [arg mapName] [method set] [arg name] [opt [arg value]]] Sets key [arg name] to the specified [arg value], if the value specified. Returns the value for the key. Throws an error if the key is not known. [call [arg mapName] [method unset] [opt [arg pattern]...]] Removes all keys matching at least one of the glob [arg pattern]s from the map. If no pattern is specified all keys are removed. In other words, the default pattern is [const *]. The result of the command is the empty string. [list_end] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/struct_set.man.
︙ | ︙ | |||
128 129 130 131 132 133 134 | ([const false]). [list_end] [section REFERENCES] [vset CATEGORY {struct :: set}] | | | 128 129 130 131 132 133 134 135 136 | ([const false]). [list_end] [section REFERENCES] [vset CATEGORY {struct :: set}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/struct_tree.man.
︙ | ︙ | |||
784 785 786 787 788 789 790 | mytree insert 0 end 3 ; # Now create node 3 as child of node 0 mytree insert 0 end ; # Create another child of 0, with a # generated name. The name is returned # as the result of the command. }] [vset CATEGORY {struct :: tree}] | | | 784 785 786 787 788 789 790 791 792 | mytree insert 0 end 3 ; # Now create node 3 as child of node 0 mytree insert 0 end ; # Create another child of 0, with a # generated name. The name is returned # as the result of the command. }] [vset CATEGORY {struct :: tree}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/struct/struct_tree1.man.
︙ | ︙ | |||
284 285 286 287 288 289 290 | [const enter] for the first evaluation, and [const leave] for the second. [list_end] [list_end] [vset CATEGORY {struct :: tree}] | | | 284 285 286 287 288 289 290 291 292 | [const enter] for the first evaluation, and [const leave] for the second. [list_end] [list_end] [vset CATEGORY {struct :: tree}] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tar/tar.man.
︙ | ︙ | |||
161 162 163 164 165 166 167 | % ::tar::contents new.tar file3 }] [list_end] [vset CATEGORY tar] | | | 161 162 163 164 165 166 167 168 169 | % ::tar::contents new.tar file3 }] [list_end] [vset CATEGORY tar] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ansi_cattr.man.
︙ | ︙ | |||
75 76 77 78 79 80 81 | [call [cmd ::term::ansi::code::attr::norevers]] Reverse off. [call [cmd ::term::ansi::code::attr::nohidden]] Hidden off. [call [cmd ::term::ansi::code::attr::nostrike]] Strike-through off. [call [cmd ::term::ansi::code::attr::reset]] Reset all attributes to their default values. [list_end] [vset CATEGORY term] | | | 75 76 77 78 79 80 81 82 83 | [call [cmd ::term::ansi::code::attr::norevers]] Reverse off. [call [cmd ::term::ansi::code::attr::nohidden]] Hidden off. [call [cmd ::term::ansi::code::attr::nostrike]] Strike-through off. [call [cmd ::term::ansi::code::attr::reset]] Reset all attributes to their default values. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ansi_cctrl.man.
︙ | ︙ | |||
191 192 193 194 195 196 197 | [call [cmd ::term::ansi::code::ctrl::showat] [arg row] [arg col] [arg text]] Format the block of text for display at the specified location. [list_end] [vset CATEGORY term] | | | 191 192 193 194 195 196 197 198 199 | [call [cmd ::term::ansi::code::ctrl::showat] [arg row] [arg col] [arg text]] Format the block of text for display at the specified location. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ansi_cmacros.man.
︙ | ︙ | |||
58 59 60 61 62 63 64 | the right margin, after normalizing internal tabs, and then put into a frame made of box-graphics. The result is returned as the result of the command. [list_end] [vset CATEGORY term] | | | 58 59 60 61 62 63 64 65 66 | the right margin, after normalizing internal tabs, and then put into a frame made of box-graphics. The result is returned as the result of the command. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ansi_code.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | This command defines a procedure [arg name] which returns the control sequence [arg code]. [list_end] [vset CATEGORY term] | | | 38 39 40 41 42 43 44 45 46 | This command defines a procedure [arg name] which returns the control sequence [arg code]. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ansi_ctrlu.man.
︙ | ︙ | |||
71 72 73 74 75 76 77 | This command queries the terminal connected to the standard input for the number of rows (aka lines) available for display. [list_end] [vset CATEGORY term] | | | 71 72 73 74 75 76 77 78 79 | This command queries the terminal connected to the standard input for the number of rows (aka lines) available for display. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ansi_send.man.
︙ | ︙ | |||
258 259 260 261 262 263 264 | [call [cmd ::term::ansi::send::showat] [arg row] [arg col] [arg text]] Show the block of text at the specified location. [list_end] [vset CATEGORY term] | | | 258 259 260 261 262 263 264 265 266 | [call [cmd ::term::ansi::send::showat] [arg row] [arg col] [arg text]] Show the block of text at the specified location. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/imenu.man.
︙ | ︙ | |||
147 148 149 150 151 152 153 | [def Enter/Return] The interaction with the object is terminated. [list_end] [vset CATEGORY term] | | | 147 148 149 150 151 152 153 154 155 | [def Enter/Return] The interaction with the object is terminated. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/ipager.man.
︙ | ︙ | |||
146 147 148 149 150 151 152 | [def Enter/Return] The interaction with the object is terminated. [list_end] [vset CATEGORY term] | | | 146 147 148 149 150 151 152 153 154 | [def Enter/Return] The interaction with the object is terminated. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/receive.man.
︙ | ︙ | |||
69 70 71 72 73 74 75 | [para] If not specified [arg chan] defaults to [const stdin]. [list_end] [vset CATEGORY term] | | | 69 70 71 72 73 74 75 76 77 | [para] If not specified [arg chan] defaults to [const stdin]. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/term.man.
︙ | ︙ | |||
12 13 14 15 16 17 18 | It is planned to have this package provide highlevel general terminal control commands, in the vein of ncurses or similar packages. Currently nothing has been implemented however. I.e. this package is empty. It can be loaded, yet provides nothing. [vset CATEGORY term] | | | 12 13 14 15 16 17 18 19 20 | It is planned to have this package provide highlevel general terminal control commands, in the vein of ncurses or similar packages. Currently nothing has been implemented however. I.e. this package is empty. It can be loaded, yet provides nothing. [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/term_bind.man.
︙ | ︙ | |||
116 117 118 119 120 121 122 | [para] In other words, the set of recognized strings has to form a [term {prefix code}]. [vset CATEGORY term] | | | 116 117 118 119 120 121 122 123 124 | [para] In other words, the set of recognized strings has to form a [term {prefix code}]. [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/term/term_send.man.
︙ | ︙ | |||
28 29 30 31 32 33 34 | This convenience command is like [cmd ::term::send::wrch], except that the destination channel is fixed to [emph stdout]. [list_end] [vset CATEGORY term] | | | 28 29 30 31 32 33 34 35 36 | This convenience command is like [cmd ::term::send::wrch], except that the destination channel is fixed to [emph stdout]. [list_end] [vset CATEGORY term] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/adjust.man.
︙ | ︙ | |||
200 201 202 203 204 205 206 | Together with [cmd ::textutil::adjust::adjust] it is possible to create properly wrapped paragraphs with arbitrary indentations. [list_end] [vset CATEGORY textutil] | | | 200 201 202 203 204 205 206 207 208 | Together with [cmd ::textutil::adjust::adjust] it is possible to create properly wrapped paragraphs with arbitrary indentations. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/expander.man.
︙ | ︙ | |||
503 504 505 506 507 508 509 | [section HISTORY] [cmd expander] was written by William H. Duquette; it is a repackaging of the central algorithm of the expand macro processing tool. [vset CATEGORY textutil] | | | 503 504 505 506 507 508 509 510 511 | [section HISTORY] [cmd expander] was written by William H. Duquette; it is a repackaging of the central algorithm of the expand macro processing tool. [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/repeat.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | [call [cmd ::textutil::repeat::blank] [arg num]] A convenience command. Returns a string of [arg num] spaces. [list_end] [vset CATEGORY textutil] | | | 38 39 40 41 42 43 44 45 46 | [call [cmd ::textutil::repeat::blank] [arg num]] A convenience command. Returns a string of [arg num] spaces. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/tabify.man.
︙ | ︙ | |||
64 65 66 67 68 69 70 | There is one asymmetry though: A tab can be replaced with a single space, but not the other way around. [list_end] [vset CATEGORY textutil] | | | 64 65 66 67 68 69 70 71 72 | There is one asymmetry though: A tab can be replaced with a single space, but not the other way around. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/textutil.man.
︙ | ︙ | |||
380 381 382 383 384 385 386 | If no strings were specified the result is the empty string. If only one string was specified, the string itself is returned, as it is its own longest common prefix. [list_end] [vset CATEGORY textutil] | | | 380 381 382 383 384 385 386 387 388 | If no strings were specified the result is the empty string. If only one string was specified, the string itself is returned, as it is its own longest common prefix. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/textutil_split.man.
︙ | ︙ | |||
48 49 50 51 52 53 54 | like [cmd split] does. The regular expression [arg regexp] defaults to "[lb]\\t \\r\\n[rb]+". [list_end] [vset CATEGORY textutil] | | | 48 49 50 51 52 53 54 55 56 | like [cmd split] does. The regular expression [arg regexp] defaults to "[lb]\\t \\r\\n[rb]+". [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/textutil_string.man.
︙ | ︙ | |||
65 66 67 68 69 70 71 | If no strings were specified the result is the empty string. If only one string was specified, the string itself is returned, as it is its own longest common prefix. [list_end] [vset CATEGORY textutil] | | | 65 66 67 68 69 70 71 72 73 | If no strings were specified the result is the empty string. If only one string was specified, the string itself is returned, as it is its own longest common prefix. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/textutil/trim.man.
︙ | ︙ | |||
67 68 69 70 71 72 73 | Looks for empty lines (including lines consisting of only whitespace) at the beginning of the [arg string] and removes it. The modified string is returned as the result of the command. [list_end] [vset CATEGORY textutil] | | | 67 68 69 70 71 72 73 74 75 | Looks for empty lines (including lines consisting of only whitespace) at the beginning of the [arg string] and removes it. The modified string is returned as the result of the command. [list_end] [vset CATEGORY textutil] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tie/tie.man.
︙ | ︙ | |||
527 528 529 530 531 532 533 | set a($idx) $val ds setv idx val unset a($idx) ds unsetv idx $a($idx) ds getv idx ----------- ----------- }] [vset CATEGORY tie] | | | 527 528 529 530 531 532 533 534 535 | set a($idx) $val ds setv idx val unset a($idx) ds unsetv idx $a($idx) ds getv idx ----------- ----------- }] [vset CATEGORY tie] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tie/tie_std.man.
︙ | ︙ | |||
27 28 29 30 31 32 33 | [para] They are automatically loaded and registered by [package tie] when it itself is requested, and as such there is no need to request them on their own, although it is possible to do so. [vset CATEGORY tie] | | | 27 28 29 30 31 32 33 34 35 | [para] They are automatically loaded and registered by [package tie] when it itself is requested, and as such there is no need to request them on their own, although it is possible to do so. [vset CATEGORY tie] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tiff/tiff.man.
︙ | ︙ | |||
166 167 168 169 170 171 172 | [list_begin enumerated] [enum] Cannot write exif ifd [enum] Reading limited to uncompressed 8 bit rgb and 8 bit palletized images [enum] Writing limited to uncompressed 8 bit rgb [list_end] [vset CATEGORY tiff] | | | 166 167 168 169 170 171 172 173 174 | [list_begin enumerated] [enum] Cannot write exif ifd [enum] Reading limited to uncompressed 8 bit rgb and 8 bit palletized images [enum] Writing limited to uncompressed 8 bit rgb [list_end] [vset CATEGORY tiff] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tool/meta.man.
︙ | ︙ | |||
157 158 159 160 161 162 163 | [list_end] [section AUTHORS] Donal Fellows, Andreas Kupries [vset CATEGORY oo::util] | | | 157 158 159 160 161 162 163 164 165 | [list_end] [section AUTHORS] Donal Fellows, Andreas Kupries [vset CATEGORY oo::util] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tool/tool.man.
︙ | ︙ | |||
226 227 228 229 230 231 232 | [list_end] [section AUTHORS] Sean Woods [vset CATEGORY tcloo] | | | 226 227 228 229 230 231 232 233 234 235 236 | [list_end] [section AUTHORS] Sean Woods [vset CATEGORY tcloo] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/tool/tool_dict_ensemble.man.
︙ | ︙ | |||
26 27 28 29 30 31 32 | [list_end] [section AUTHORS] Sean Woods [vset CATEGORY tool] | | | 26 27 28 29 30 31 32 33 34 | [list_end] [section AUTHORS] Sean Woods [vset CATEGORY tool] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/transfer/connect.man.
︙ | ︙ | |||
160 161 162 163 164 165 166 | [include include/connect_options.inc] [list_end] [vset OBJCREATE {transfer::connect C}] [include include/secure.inc] [vset CATEGORY transfer] | | | 160 161 162 163 164 165 166 167 168 | [include include/connect_options.inc] [list_end] [vset OBJCREATE {transfer::connect C}] [include include/secure.inc] [vset CATEGORY transfer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/transfer/copyops.man.
︙ | ︙ | |||
155 156 157 158 159 160 161 | these options are required, and they default to the settings of the output channel if not specified. [list_end][comment options] [list_end][comment definitions/api] [vset CATEGORY transfer] | | | 155 156 157 158 159 160 161 162 163 | these options are required, and they default to the settings of the output channel if not specified. [list_end][comment options] [list_end][comment definitions/api] [vset CATEGORY transfer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/transfer/ddest.man.
︙ | ︙ | |||
114 115 116 117 118 119 120 | configure the object. [list_begin options] [include include/ddest_options.inc] [list_end] [vset CATEGORY transfer] | | | 114 115 116 117 118 119 120 121 122 | configure the object. [list_begin options] [include include/ddest_options.inc] [list_end] [vset CATEGORY transfer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/transfer/dsource.man.
︙ | ︙ | |||
146 147 148 149 150 151 152 | actually configure the object. [list_begin options] [include include/dsource_options.inc] [list_end] [vset CATEGORY transfer] | | | 146 147 148 149 150 151 152 153 154 | actually configure the object. [list_begin options] [include include/dsource_options.inc] [list_end] [vset CATEGORY transfer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/transfer/receiver.man.
︙ | ︙ | |||
174 175 176 177 178 179 180 | [include include/ddest_options.inc] [list_end] [vset OBJCREATE {transfer::receiver R}] [include include/secure.inc] [vset CATEGORY transfer] | | | 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | [include include/ddest_options.inc] [list_end] [vset OBJCREATE {transfer::receiver R}] [include include/secure.inc] [vset CATEGORY transfer] [include ../common-text/feedback.inc] [comment { This option specifies the command to invoke when the transmission of the information in the data source has been completed. The arguments given to this command are the same as given to the completion callback of method [cmd receive], see package [package transfer::data::destination]. |
︙ | ︙ |
Changes to modules/transfer/tqueue.man.
︙ | ︙ | |||
166 167 168 169 170 171 172 | It should be noted that in this application the system also needs an additional data structure which keeps track of outstanding results as they may come back in a different order than the requests from the client, and releases them to the actual queue in the proper order. [vset CATEGORY transfer] | | | 166 167 168 169 170 171 172 173 174 | It should be noted that in this application the system also needs an additional data structure which keeps track of outstanding results as they may come back in a different order than the requests from the client, and releases them to the actual queue in the proper order. [vset CATEGORY transfer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/transfer/transmitter.man.
︙ | ︙ | |||
176 177 178 179 180 181 182 | [include include/dsource_options.inc] [list_end] [vset OBJCREATE {transfer::transmitter T}] [include include/secure.inc] [vset CATEGORY transfer] | | | 176 177 178 179 180 181 182 183 184 | [include include/dsource_options.inc] [list_end] [vset OBJCREATE {transfer::transmitter T}] [include include/secure.inc] [vset CATEGORY transfer] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/treeql/treeql.man.
︙ | ︙ | |||
811 812 813 814 815 816 817 | [uri http://wiki.tcl.tk/treeql TreeQL] on the Tcler's Wiki. Discuss this package there. [list_end] [vset CATEGORY treeql] | | | 811 812 813 814 815 816 817 818 819 | [uri http://wiki.tcl.tk/treeql TreeQL] on the Tcler's Wiki. Discuss this package there. [list_end] [vset CATEGORY treeql] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/try/tcllib_throw.man.
︙ | ︙ | |||
32 33 34 35 36 37 38 | [section EXAMPLES] [para][example_begin] [cmd throw] {MYERROR CODE} "My error message" [example_end] [vset CATEGORY try] | | | 32 33 34 35 36 37 38 39 40 | [section EXAMPLES] [para][example_begin] [cmd throw] {MYERROR CODE} "My error message" [example_end] [vset CATEGORY try] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/try/tcllib_try.man.
︙ | ︙ | |||
115 116 117 118 119 120 121 | puts "failed to open /some/file/name: it's a directory" } [method trap] {POSIX ENOENT} {} { puts "failed to open /some/file/name: it doesn't exist" } [example_end] [vset CATEGORY try] | | | 115 116 117 118 119 120 121 122 123 | puts "failed to open /some/file/name: it's a directory" } [method trap] {POSIX ENOENT} {} { puts "failed to open /some/file/name: it doesn't exist" } [example_end] [vset CATEGORY try] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/udpcluster/udpcluster.man.
︙ | ︙ | |||
51 52 53 54 55 56 57 | Results will Historical Notes: [para] This tool was originally known as nns::cluster, but as development progressed, it was clear that it wasn't interacting with any of the other facilities in NNS. [vset CATEGORY nameserv] | | | 51 52 53 54 55 56 57 58 59 | Results will Historical Notes: [para] This tool was originally known as nns::cluster, but as development progressed, it was clear that it wasn't interacting with any of the other facilities in NNS. [vset CATEGORY nameserv] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/uev/uevent.man.
︙ | ︙ | |||
188 189 190 191 192 193 194 | [para] The result of the command is the empty string. [comment ============================================================] [list_end] [vset CATEGORY uevent] | | | 188 189 190 191 192 193 194 195 196 | [para] The result of the command is the empty string. [comment ============================================================] [list_end] [vset CATEGORY uevent] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/uev/uevent_onidle.man.
︙ | ︙ | |||
56 57 58 59 60 61 62 | [section Examples] Examples of this type of deferal are buried in the (C-level) implementations all the Tk widgets, defering geometry calculations and window redraw activity in this manner. [vset CATEGORY uevent] | | | 56 57 58 59 60 61 62 63 64 | [section Examples] Examples of this type of deferal are buried in the (C-level) implementations all the Tk widgets, defering geometry calculations and window redraw activity in this manner. [vset CATEGORY uevent] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/units/units.man.
︙ | ︙ | |||
384 385 386 387 388 389 390 | GNU Units program at [uri http://www.gnu.org/software/units/] [section "AUTHORS"] Robert W. Techentin [vset CATEGORY units] | | | 384 385 386 387 388 389 390 391 392 | GNU Units program at [uri http://www.gnu.org/software/units/] [section "AUTHORS"] Robert W. Techentin [vset CATEGORY units] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/uri/uri.man.
︙ | ︙ | |||
385 386 387 388 389 390 391 | [para] Original code (regular expressions) by Andreas Kupries. Modularisation by Steve Ball, also the split/join/resolve functionality. RFC 3986 conformance by Keith Nash. [vset CATEGORY uri] | | | 385 386 387 388 389 390 391 392 393 | [para] Original code (regular expressions) by Andreas Kupries. Modularisation by Steve Ball, also the split/join/resolve functionality. RFC 3986 conformance by Keith Nash. [vset CATEGORY uri] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/uri/urn-scheme.man.
︙ | ︙ | |||
33 34 35 36 37 38 39 | This commands performs the reverse of [cmd ::uri::urn::quote]. It takes an [term urn] url, removes the quoting from all disallowed characters, and returns the modified urls as its result. [list_end] [vset CATEGORY uri] | | | 33 34 35 36 37 38 39 40 41 | This commands performs the reverse of [cmd ::uri::urn::quote]. It takes an [term urn] url, removes the quoting from all disallowed characters, and returns the modified urls as its result. [list_end] [vset CATEGORY uri] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/uuid/uuid.man.
︙ | ︙ | |||
47 48 49 50 51 52 53 | [enum] Paul J. Leach, "UUIDs and GUIDs", February 1998. ([uri http://www.opengroup.org/dce/info/draft-leach-uuids-guids-01.txt]) [list_end] [vset CATEGORY uuid] | | | 47 48 49 50 51 52 53 54 55 | [enum] Paul J. Leach, "UUIDs and GUIDs", February 1998. ([uri http://www.opengroup.org/dce/info/draft-leach-uuids-guids-01.txt]) [list_end] [vset CATEGORY uuid] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/valtype/include/vtype.inc.
︙ | ︙ | |||
94 95 96 97 98 99 100 | th input may be an outright fake too. [include [vset CODES].inc] [list_end] [vset CATEGORY valtype] | | | 94 95 96 97 98 99 100 101 102 | th input may be an outright fake too. [include [vset CODES].inc] [list_end] [vset CATEGORY valtype] [include ../../common-text/feedback.inc] [manpage_end] |
Changes to modules/valtype/valtype_common.man.
︙ | ︙ | |||
102 103 104 105 106 107 108 | data-entry error, with digits transposed, forgotten, etc. Of course, th input may be an outright fake too. [include include/c_lenpfx.inc] [list_end] [vset CATEGORY valtype] | | | 102 103 104 105 106 107 108 109 110 | data-entry error, with digits transposed, forgotten, etc. Of course, th input may be an outright fake too. [include include/c_lenpfx.inc] [list_end] [vset CATEGORY valtype] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/ChangeLog.
1 2 3 4 5 6 7 | 2013-12-17 Andreas Kupries <[email protected]> * randseed.man: Fixed package name. 2013-11-22 Andreas Kupries <[email protected]> * memchan.tcl (Events): Ticket [864a0c83e3]. Do not suppress | > > > > | 1 2 3 4 5 6 7 8 9 10 11 | 2019-03-12 Aldo Buratti * cat.tcl - BUGFIX in event-handling . Version bumped to 1.0.3 * 2013-12-17 Andreas Kupries <[email protected]> * randseed.man: Fixed package name. 2013-11-22 Andreas Kupries <[email protected]> * memchan.tcl (Events): Ticket [864a0c83e3]. Do not suppress |
︙ | ︙ |
Changes to modules/virtchannel_base/cat.man.
1 | [comment {-*- tcl -*- doctools manpage}] | > | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | [comment {-*- tcl -*- doctools manpage}] [vset Version 1.0.3] [manpage_begin tcl::chan::cat n [vset Version]] [keywords {concatenation channel}] [keywords {reflected channel}] [keywords {tip 219}] [keywords {virtual channel}] [copyright {2011 Andreas Kupries <[email protected]>}] [moddesc {Reflected/virtual channel support}] [category Channels] [titledesc {Concatenation channel}] [require Tcl 8.5] [require TclOO] [require tcl::chan::core [opt 1]] [require tcl::chan::cat [opt [vset Version]]] [description] [para] The [package tcl::chan::cat] package provides a command creating concatenation channels. These are non-seekable channels owning a list of subordinate channels whose contents they return in order, until all are exhausted. In this manner the channel is the concatentation of the |
︙ | ︙ | |||
39 40 41 42 43 44 45 | This command creates the concatenation channel using all the provided channels, and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 40 41 42 43 44 45 46 47 48 | This command creates the concatenation channel using all the provided channels, and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/cat.tcl.
1 2 | # -*- tcl -*- # # ## ### ##### ######## ############# | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | # -*- tcl -*- # # ## ### ##### ######## ############# # (C) 2011,2019 Andreas Kupries # Facade concatenating the contents of the channels it was constructed # with. Owns the sub-ordinate channels and closes them on exhaustion and/or # when closed itself. # @@ Meta Begin # Package tcl::chan::cat 1.0.3 # Meta as::author {Andreas Kupries} # Meta as::copyright 2011 # Meta as::license BSD # Meta description Facade concatenating the contents of the channels it # Meta description was constructed with. Owns the sub-ordinate channels # Meta description and closes them on exhaustion and/or when closed itself. # Meta platform tcl |
︙ | ︙ | |||
39 40 41 42 43 44 45 | # We are not using the standard event handling class, because here # it will not be timer-driven. We propagate anything related to # events to catin and catout instead and let them handle things. constructor {args} { set channels $args | | < | 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | # We are not using the standard event handling class, because here # it will not be timer-driven. We propagate anything related to # events to catin and catout instead and let them handle things. constructor {args} { set channels $args # Disable translation (and hence encoding) in the wrapped channels. # This will happen in our generic layer instead. foreach c $channels { fconfigure $c -translation binary } set delay 10 set watching 0 return } |
︙ | ︙ | |||
66 67 68 69 70 71 72 | method watch {c requestmask} { if {"read" in $requestmask} { # Activate event handling. Either drive an eof home via # timers, or activate things in the foremost sub-ordinate. set watching 1 if {![llength $channels]} { | | < | < | | | | | | | | > | | < | | < | | 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 | method watch {c requestmask} { if {"read" in $requestmask} { # Activate event handling. Either drive an eof home via # timers, or activate things in the foremost sub-ordinate. set watching 1 if {![llength $channels]} { set timer [after $delay [namespace code [list my Post $c]]] } else { chan event [lindex $channels 0] readable [list chan postevent $c read] } } else { # Stop events. Either kill timer, or disable in the # foremost sub-ordinate. set watching 0 if {![llength $channels]} { catch { after cancel $timer } } else { chan event [lindex $channels 0] readable {} } } return } method read {c n} { if {![llength $channels]} { # This signals EOF higher up. return {} } set buf {} while {([string length $buf] < $n) && [llength $channels]} { set in [lindex $channels 0] set toread [expr {$n - [string length $buf]}] append buf [::read $in $toread] if {[eof $in]} { close $in set channels [lrange $channels 1 end] # The close of the exhausted subordinate killed any # fileevent handling we may have had attached to this # channel. Update the settings (i.e. move to the next # subordinate, or to timer-based, to drive the eof # home). if {$watching} { my watch $c read } } } # When `buf` is empty, all channels have been exhausted and # closed, therefore returning this empty string will cause an # EOF higher up. return $buf } method Post {c} { set timer [after $delay [namespace code [list my Post $c]]] chan postevent $c read return } } # # ## ### ##### ######## ############# package provide tcl::chan::cat 1.0.3 return |
Added modules/virtchannel_base/cat.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | #- - -- --- ----- -------- ------------- --------------------- # cat.test -*- tcl -*- # (C) 2019 Andreas Kupries. BSD licensed. #- - -- --- ----- -------- ------------- --------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.5 testsNeedTcltest 2.0 testsNeed TclOO 1 support { use virtchannel_core/core.tcl tcl::chan::core use virtchannel_core/events.tcl tcl::chan::events useLocal string.tcl tcl::chan::string } testing { useLocal cat.tcl tcl::chan::cat } #- - -- --- ----- -------- ------------- --------------------- ## No wrong#args, allowed to zero and up #- - -- --- ----- -------- ------------- --------------------- test tcl-chan-cat-2.0 {tell, nothing} -setup { set c [tcl::chan::cat] } -body { tell $c } -cleanup { close $c unset c } -result -1 test tcl-chan-cat-2.1 {ticket 1975182bdd - file events} -setup { # setup a cat'enated channel set fa [tcl::chan::string "ABCDE..XYZ"] set fb [tcl::chan::string "0123456789"] set ch [tcl::chan::cat $fa $fb] } -body { set r {} chan event $ch readable { if { [eof $ch] } { set done . } else { lappend r [read $ch 4] } } vwait done set r } -cleanup { close $ch unset ch fa fb r } -result {ABCD E..X YZ01 2345 6789 {}} #- - -- --- ----- -------- ------------- --------------------- # Explicit cleanup of loaded support classes. rename tcl::chan::events {} rename tcl::chan::core {} testsuiteCleanup return # Local Variables: # mode: tcl # indent-tabs-mode: nil # End: |
Changes to modules/virtchannel_base/facade.man.
︙ | ︙ | |||
65 66 67 68 69 70 71 | This command creates the facade channel around the provided channel [arg chan], and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 65 66 67 68 69 70 71 72 73 | This command creates the facade channel around the provided channel [arg chan], and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/halfpipe.man.
︙ | ︙ | |||
73 74 75 76 77 78 79 | This callback is invoked when the channel has run out of data to read. A single argument is supplied, the handle of the channel. [list_end] [vset CATEGORY virtchannel] | | | 73 74 75 76 77 78 79 80 81 | This callback is invoked when the channel has run out of data to read. A single argument is supplied, the handle of the channel. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/nullzero.man.
︙ | ︙ | |||
36 37 38 39 40 41 42 | [call [cmd ::tcl::chan::nullzero]] This command creates a new nullzero channel and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 36 37 38 39 40 41 42 43 44 | [call [cmd ::tcl::chan::nullzero]] This command creates a new nullzero channel and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/pkgIndex.tcl.
1 2 | if {![package vsatisfies [package provide Tcl] 8.5]} {return} | | | 1 2 3 4 5 6 7 8 9 10 | if {![package vsatisfies [package provide Tcl] 8.5]} {return} package ifneeded tcl::chan::cat 1.0.3 [list source [file join $dir cat.tcl]] package ifneeded tcl::chan::facade 1.0.1 [list source [file join $dir facade.tcl]] package ifneeded tcl::chan::fifo 1 [list source [file join $dir fifo.tcl]] package ifneeded tcl::chan::fifo2 1 [list source [file join $dir fifo2.tcl]] package ifneeded tcl::chan::halfpipe 1 [list source [file join $dir halfpipe.tcl]] package ifneeded tcl::chan::memchan 1.0.4 [list source [file join $dir memchan.tcl]] package ifneeded tcl::chan::null 1 [list source [file join $dir null.tcl]] package ifneeded tcl::chan::nullzero 1 [list source [file join $dir nullzero.tcl]] |
︙ | ︙ |
Changes to modules/virtchannel_base/randseed.man.
︙ | ︙ | |||
35 36 37 38 39 40 41 | This command takes to seed lists and combines them into a single list by XORing them elementwise, modulo 256. If the lists are not of equial length the shorter of the two is padded with 0s before merging. [list_end] [vset CATEGORY virtchannel] | | | 35 36 37 38 39 40 41 42 43 | This command takes to seed lists and combines them into a single list by XORing them elementwise, modulo 256. If the lists are not of equial length the shorter of the two is padded with 0s before merging. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/std.man.
︙ | ︙ | |||
35 36 37 38 39 40 41 | [para] The channel is created only once, on the first call, and all future calls simply return this handle. [list_end] [vset CATEGORY virtchannel] | | | 35 36 37 38 39 40 41 42 43 | [para] The channel is created only once, on the first call, and all future calls simply return this handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_fifo.man.
︙ | ︙ | |||
35 36 37 38 39 40 41 | [call [cmd ::tcl::chan::fifo]] This command creates a new fifo channel and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 35 36 37 38 39 40 41 42 43 | [call [cmd ::tcl::chan::fifo]] This command creates a new fifo channel and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_fifo2.man.
︙ | ︙ | |||
42 43 44 45 46 47 48 | This command creates a new connected pair of fifo channels and returns their handles, as a list containing two elements. [list_end] [vset CATEGORY virtchannel] | | | 42 43 44 45 46 47 48 49 50 | This command creates a new connected pair of fifo channels and returns their handles, as a list containing two elements. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_memchan.man.
︙ | ︙ | |||
37 38 39 40 41 42 43 | [call [cmd ::tcl::chan::memchan]] This command creates a new memchan channel and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 37 38 39 40 41 42 43 44 45 | [call [cmd ::tcl::chan::memchan]] This command creates a new memchan channel and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_null.man.
︙ | ︙ | |||
37 38 39 40 41 42 43 | [call [cmd ::tcl::chan::null]] This command creates a new null channel and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 37 38 39 40 41 42 43 44 45 | [call [cmd ::tcl::chan::null]] This command creates a new null channel and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_random.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | The seed is a list of integer numbers used to initialize the internal feedback shift register of the generator. [list_end] [vset CATEGORY virtchannel] | | | 38 39 40 41 42 43 44 45 46 | The seed is a list of integer numbers used to initialize the internal feedback shift register of the generator. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_string.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | This command creates a new string channel and returns its handle. The channel provides random read-only access to the [arg content] string. [list_end] [vset CATEGORY virtchannel] | | | 38 39 40 41 42 43 44 45 46 | This command creates a new string channel and returns its handle. The channel provides random read-only access to the [arg content] string. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_variable.man.
︙ | ︙ | |||
39 40 41 42 43 44 45 | This command creates a new variable channel and returns its handle. The content of the channel is stored in the associated namespace variable [arg varname]. [list_end] [vset CATEGORY virtchannel] | | | 39 40 41 42 43 44 45 46 47 | This command creates a new variable channel and returns its handle. The content of the channel is stored in the associated namespace variable [arg varname]. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/tcllib_zero.man.
︙ | ︙ | |||
37 38 39 40 41 42 43 | [call [cmd ::tcl::chan::zero]] This command creates a new zero channel and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 37 38 39 40 41 42 43 44 45 | [call [cmd ::tcl::chan::zero]] This command creates a new zero channel and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_base/textwindow.man.
︙ | ︙ | |||
31 32 33 34 35 36 37 | This command creates a new textwindow channel and returns its handle. Data written to this channel will appear in the associated [arg widget]. [list_end] [vset CATEGORY virtchannel] | | | 31 32 33 34 35 36 37 38 39 | This command creates a new textwindow channel and returns its handle. Data written to this channel will appear in the associated [arg widget]. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_core/core.man.
︙ | ︙ | |||
64 65 66 67 68 69 70 | initialized for, see the method [method initialize]. When destroyed from within a call of [method finalize] this does not happen, under the assumption that the channel is being destroyed by Tcl. [list_end] [vset CATEGORY virtchannel] | | | 64 65 66 67 68 69 70 71 72 | initialized for, see the method [method initialize]. When destroyed from within a call of [method finalize] this does not happen, under the assumption that the channel is being destroyed by Tcl. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_core/events.man.
︙ | ︙ | |||
71 72 73 74 75 76 77 | system coming in through the [method watch] method the event core is able to determine which events it should (not) generate and act accordingly. [list_end] [vset CATEGORY virtchannel] | | | 71 72 73 74 75 76 77 78 79 | system coming in through the [method watch] method the event core is able to determine which events it should (not) generate and act accordingly. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_core/transformcore.man.
︙ | ︙ | |||
64 65 66 67 68 69 70 | it was initialized for, see the method [method initialize]. When destroyed from within a call of [method finalize] this does not happen, under the assumption that the channel and transform are being destroyed by Tcl. [list_end] [vset CATEGORY virtchannel] | | | 64 65 66 67 68 69 70 71 72 | it was initialized for, see the method [method initialize]. When destroyed from within a call of [method finalize] this does not happen, under the assumption that the channel and transform are being destroyed by Tcl. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/adler32.man.
︙ | ︙ | |||
62 63 64 65 66 67 68 | [para] If not specified, or the empty string, the checksum of the write direction is not saved. [list_end] [list_end] [vset CATEGORY virtchannel] | | | 62 63 64 65 66 67 68 69 70 | [para] If not specified, or the empty string, the checksum of the write direction is not saved. [list_end] [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/hex.man.
︙ | ︙ | |||
35 36 37 38 39 40 41 | This command creates a hex transformation on top of the channel [arg chan] and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 35 36 37 38 39 40 41 42 43 | This command creates a hex transformation on top of the channel [arg chan] and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/identity.man.
︙ | ︙ | |||
42 43 44 45 46 47 48 | This command creates an identity transformation on top of the channel [arg chan] and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 42 43 44 45 46 47 48 49 50 | This command creates an identity transformation on top of the channel [arg chan] and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/limitsize.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | [para] [arg max] is the number of bytes which can be read from the channel before EOF is signaled by the transformation. Note that popping the transformation clears the EOF it generated as well. [list_end] [vset CATEGORY virtchannel] | | | 38 39 40 41 42 43 44 45 46 | [para] [arg max] is the number of bytes which can be read from the channel before EOF is signaled by the transformation. Note that popping the transformation clears the EOF it generated as well. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/observe.man.
︙ | ︙ | |||
42 43 44 45 46 47 48 | This command creates an observer transformation on top of the channel [arg chan] and returns its handle. The channel handles [arg logr] and [arg logw] are there the data is copied to. [list_end] [vset CATEGORY virtchannel] | | | 42 43 44 45 46 47 48 49 50 | This command creates an observer transformation on top of the channel [arg chan] and returns its handle. The channel handles [arg logr] and [arg logw] are there the data is copied to. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/rot.man.
︙ | ︙ | |||
49 50 51 52 53 54 55 | ASCII 65...90, and 97...122, i.e. the upper- and lower-case alphabetic characters, i.e. "A...Z" and "a...z". All other bytes are passed through unchanged. [list_end] [vset CATEGORY virtchannel] | | | 49 50 51 52 53 54 55 56 57 | ASCII 65...90, and 97...122, i.e. the upper- and lower-case alphabetic characters, i.e. "A...Z" and "a...z". All other bytes are passed through unchanged. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/spacer.man.
︙ | ︙ | |||
37 38 39 40 41 42 43 | bytes of data written, and on the read side the same is done in reverse, removing the spacing. If [arg space] is not specified it defaults to a single space character (ASCII 32). [list_end] [vset CATEGORY virtchannel] | | | 37 38 39 40 41 42 43 44 45 | bytes of data written, and on the read side the same is done in reverse, removing the spacing. If [arg space] is not specified it defaults to a single space character (ASCII 32). [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/tcllib_zlib.man.
︙ | ︙ | |||
38 39 40 41 42 43 44 | [para] The [arg level] specifies how much effort is put into the compression, from [const 0] to [const 9], and defaults to [const 4]. [list_end] [vset CATEGORY virtchannel] | | | 38 39 40 41 42 43 44 45 46 | [para] The [arg level] specifies how much effort is put into the compression, from [const 0] to [const 9], and defaults to [const 4]. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/vt_base64.man.
︙ | ︙ | |||
36 37 38 39 40 41 42 | This command creates a base64 transformation on top of the channel [arg chan] and returns its handle. [list_end] [vset CATEGORY virtchannel] | | | 36 37 38 39 40 41 42 43 44 | This command creates a base64 transformation on top of the channel [arg chan] and returns its handle. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/vt_counter.man.
︙ | ︙ | |||
60 61 62 63 64 65 66 | [para] If not specified, or the empty string, the counter of the write direction is not saved. [list_end] [list_end] [vset CATEGORY virtchannel] | | | 60 61 62 63 64 65 66 67 68 | [para] If not specified, or the empty string, the counter of the write direction is not saved. [list_end] [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/vt_crc32.man.
︙ | ︙ | |||
62 63 64 65 66 67 68 | [para] If not specified, or the empty string, the checksum of the write direction is not saved. [list_end] [list_end] [vset CATEGORY virtchannel] | | | 62 63 64 65 66 67 68 69 70 | [para] If not specified, or the empty string, the checksum of the write direction is not saved. [list_end] [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/virtchannel_transform/vt_otp.man.
︙ | ︙ | |||
45 46 47 48 49 50 51 | one-time pads for the write and read directions, respectively. Their contents are reads and xored with the bytes written to and read from the channel. [list_end] [vset CATEGORY virtchannel] | | | 45 46 47 48 49 50 51 52 53 | one-time pads for the write and read directions, respectively. Their contents are reads and xored with the bytes written to and read from the channel. [list_end] [vset CATEGORY virtchannel] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/websocket/websocket.man.
︙ | ︙ | |||
377 378 379 380 381 382 383 | after 400 test $sock vwait forever [example_end] [include ../common-text/tls-security-notes.inc] [vset CATEGORY websocket] | | | 377 378 379 380 381 382 383 384 385 | after 400 test $sock vwait forever [example_end] [include ../common-text/tls-security-notes.inc] [vset CATEGORY websocket] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/wip/wip.man.
︙ | ︙ | |||
376 377 378 379 380 381 382 | [list_end] [section EXAMPLES] No examples yet. [vset CATEGORY wip] | | | 376 377 378 379 380 381 382 383 384 | [list_end] [section EXAMPLES] No examples yet. [vset CATEGORY wip] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/yaml/huddle.man.
︙ | ︙ | |||
550 551 552 553 554 555 556 | [section LIMITATIONS] [para] now printing. [vset CATEGORY huddle] | | | 550 551 552 553 554 555 556 557 558 | [section LIMITATIONS] [para] now printing. [vset CATEGORY huddle] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/yaml/yaml.man.
︙ | ︙ | |||
181 182 183 184 185 186 187 | [para] Too many braces, or too few braces. [para] Not enough character set of line feeds. Please use only "\n" as line breaks. [vset CATEGORY yaml] | | | 181 182 183 184 185 186 187 188 189 | [para] Too many braces, or too few braces. [para] Not enough character set of line feeds. Please use only "\n" as line breaks. [vset CATEGORY yaml] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/zip/decode.man.
︙ | ︙ | |||
127 128 129 130 131 132 133 | [arg archive] file in the given destination directory [arg dstdir]. [para] The result of the command is the empty string. [list_end] [vset CATEGORY zipfile] | | | 127 128 129 130 131 132 133 134 135 | [arg archive] file in the given destination directory [arg dstdir]. [para] The result of the command is the empty string. [list_end] [vset CATEGORY zipfile] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/zip/encode.man.
︙ | ︙ | |||
84 85 86 87 88 89 90 | specific order was documented. It was lexicographically sorted. The change was made to support [cmd zip]-based file formats which require a specific order of files in the archive, for example [file .epub]. [list_end] [vset CATEGORY zipfile] | | | 84 85 86 87 88 89 90 91 92 | specific order was documented. It was lexicographically sorted. The change was made to support [cmd zip]-based file formats which require a specific order of files in the archive, for example [file .epub]. [list_end] [vset CATEGORY zipfile] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/zip/mkzip.man.
|
| | | 1 2 3 4 5 6 7 8 | [vset ZIP_mkzip_VERSION 1.2.1] [comment {-*- tcl -*- doctools manpage}] [manpage_begin zipfile::mkzip n [vset ZIP_mkzip_VERSION]] [keywords decompression zip] [copyright {2009 Pat Thoyts}] [moddesc {Zip archive creation}] [titledesc {Build a zip archive}] [category File] |
︙ | ︙ | |||
96 97 98 99 100 101 102 | is specified. [list_end] [list_end] [vset CATEGORY zipfile] | | | 96 97 98 99 100 101 102 103 104 | is specified. [list_end] [list_end] [vset CATEGORY zipfile] [include ../common-text/feedback.inc] [manpage_end] |
Changes to modules/zip/mkzip.tcl.
1 2 3 4 5 6 7 8 9 10 11 | # -*- tcl -*- # mkzip.tcl -- Copyright (C) 2009 Pat Thoyts <[email protected]> # # Create ZIP archives in Tcl. # # Create a zipkit using mkzip filename.zkit -zipkit -directory xyz.vfs # or a zipfile using mkzip filename.zip -directory dirname -exclude "*~" # ## BSD License ## # Package providing commands for the generation of a zip archive. | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | # -*- tcl -*- # mkzip.tcl -- Copyright (C) 2009 Pat Thoyts <[email protected]> # # Create ZIP archives in Tcl. # # Create a zipkit using mkzip filename.zkit -zipkit -directory xyz.vfs # or a zipfile using mkzip filename.zip -directory dirname -exclude "*~" # ## BSD License ## # Package providing commands for the generation of a zip archive. # version 1.2.1 package require Tcl 8.6 namespace eval ::zipfile {} namespace eval ::zipfile::decode {} namespace eval ::zipfile::encode {} namespace eval ::zipfile::mkzip {} |
︙ | ︙ | |||
60 61 62 63 64 65 66 | # a set of glob expressions to match against files and to avoid. # The match arg is internal. # eg: walk library {CVS/* *~ .#*} to exclude CVS and emacs cruft. # proc ::zipfile::mkzip::walk {base {excludes ""} {match *} {path {}}} { set result {} set imatch [file join $path $match] | | | | 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 | # a set of glob expressions to match against files and to avoid. # The match arg is internal. # eg: walk library {CVS/* *~ .#*} to exclude CVS and emacs cruft. # proc ::zipfile::mkzip::walk {base {excludes ""} {match *} {path {}}} { set result {} set imatch [file join $path $match] set files [glob -nocomplain -tails -types f -directory $base -- $imatch] foreach file $files { set excluded 0 foreach glob $excludes { if {[string match $glob $file]} { set excluded 1 break } } if {!$excluded} {lappend result $file} } foreach dir [glob -nocomplain -tails -types d -directory $base -- $imatch] { set subdir [walk $base $excludes $match $dir] if {[llength $subdir]>0} { set result [concat $result [list $dir] $subdir] } } return $result } |
︙ | ︙ | |||
275 276 277 278 279 280 281 | close $zf return } # ### ### ### ######### ######### ######### ## Ready | | | 275 276 277 278 279 280 281 282 | close $zf return } # ### ### ### ######### ######### ######### ## Ready package provide zipfile::mkzip 1.2.1 |
Added modules/zip/mkzip.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | # mkzip.test - Copyright (C) 2019 Andreas Kupries <[email protected]> # ------------------------------------------------------------------------- source [file join \ [file dirname [file dirname [file join [pwd] [info script]]]] \ devtools testutilities.tcl] testsNeedTcl 8.6 testsNeedTcltest 2 testing { useLocal mkzip.tcl zipfile::mkzip } # ------------------------------------------------------------------------- test zipfile-mkzip-mkzip-1.0 {mkzip, wrong args, not enough} -body { zipfile::mkzip::mkzip } -returnCodes error -result {wrong # args: should be "zipfile::mkzip::mkzip filename ?arg ...?"} test zipfile-mkzip-mkzip-2.0 {mkzip, tkt b9725d990b} -setup { tcltest::makeDirectory foo tcltest::makeDirectory foo/-1 } -cleanup { tcltest::removeDirectory foo file delete foo.zip } -body { zipfile::mkzip::mkzip foo.zip -directory foo } -result {} # ------------------------------------------------------------------------- testsuiteCleanup # ------------------------------------------------------------------------- # Local Variables: # mode: tcl # indent-tabs-mode: nil # End: |
Changes to modules/zip/pkgIndex.tcl.
1 2 3 4 5 6 7 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded zipfile::decode 0.7.1 [list source [file join $dir decode.tcl]] package ifneeded zipfile::encode 0.4 [list source [file join $dir encode.tcl]] if {![package vsatisfies [package provide Tcl] 8.6]} {return} | | | 1 2 3 4 5 6 7 8 | if {![package vsatisfies [package provide Tcl] 8.4]} {return} package ifneeded zipfile::decode 0.7.1 [list source [file join $dir decode.tcl]] package ifneeded zipfile::encode 0.4 [list source [file join $dir encode.tcl]] if {![package vsatisfies [package provide Tcl] 8.6]} {return} package ifneeded zipfile::mkzip 1.2.1 [list source [file join $dir mkzip.tcl]] |
Changes to support/devel/sak/doc/kwic.txt.
︙ | ︙ | |||
1346 1347 1348 1349 1350 1351 1352 1353 1354 | [key html] [manpage modules/html/html.man html] [manpage modules/htmlparse/htmlparse.man htmlparse] [manpage modules/javascript/javascript.man javascript] [manpage modules/ncgi/ncgi.man ncgi] [key http] [manpage modules/http/autoproxy.man autoproxy] [manpage modules/map/map_geocode_nominatim.man map::geocode::nominatim] [manpage modules/map/map_slippy_fetcher.man map::slippy::fetcher] | > < | | | 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 | [key html] [manpage modules/html/html.man html] [manpage modules/htmlparse/htmlparse.man htmlparse] [manpage modules/javascript/javascript.man javascript] [manpage modules/ncgi/ncgi.man ncgi] [key http] [manpage modules/http/autoproxy.man autoproxy] [manpage modules/httpd/httpd.man httpd] [manpage modules/map/map_geocode_nominatim.man map::geocode::nominatim] [manpage modules/map/map_slippy_fetcher.man map::slippy::fetcher] [manpage modules/uri/uri.man uri] [manpage modules/websocket/websocket.man websocket] [key httpd] [manpage modules/httpd/httpd.man httpd] [key https] [manpage modules/uri/uri.man uri] [key httpserver] [manpage modules/httpd/httpd.man httpd] [key huddle] [manpage modules/yaml/huddle.man huddle] [manpage modules/yaml/yaml.man yaml] [key {human readable}] [manpage modules/bench/bench_read.man bench::in] [manpage modules/bench/bench_wtext.man bench::out::text] [key hyphenation] |
︙ | ︙ | |||
1872 1873 1874 1875 1876 1877 1878 | [manpage modules/math/rational_funcs.man math::rationalfunctions] [manpage modules/math/special.man math::special] [manpage modules/math/trig.man math::trig] [manpage modules/simulation/annealing.man simulation::annealing] [manpage modules/simulation/montecarlo.man simulation::montecarlo] [manpage modules/simulation/simulation_random.man simulation::random] [key mathematics] | | > | | 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 | [manpage modules/math/rational_funcs.man math::rationalfunctions] [manpage modules/math/special.man math::special] [manpage modules/math/trig.man math::trig] [manpage modules/simulation/annealing.man simulation::annealing] [manpage modules/simulation/montecarlo.man simulation::montecarlo] [manpage modules/simulation/simulation_random.man simulation::random] [key mathematics] [manpage modules/math/fourier.man math::fourier] [manpage modules/math/quasirandom.man math::quasirandom] [manpage modules/math/statistics.man math::statistics] [key matrices] [manpage modules/math/linalg.man math::linearalgebra] [key matrix] [manpage modules/csv/csv.man csv] [manpage modules/math/linalg.man math::linearalgebra] [manpage modules/report/report.man report] [manpage modules/struct/matrix.man struct::matrix] |
︙ | ︙ | |||
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 | [manpage modules/cron/cron.man cron] [manpage modules/nettool/nettool.man nettool] [manpage modules/processman/processman.man processman] [key on-idle] [manpage modules/uev/uevent_onidle.man uevent::onidle] [key {one time pad}] [manpage modules/virtchannel_transform/vt_otp.man tcl::transform::otp] [key optimization] [manpage modules/math/optimize.man math::optimize] [manpage modules/simulation/annealing.man simulation::annealing] [key {ordered list}] [manpage modules/struct/prioqueue.man struct::prioqueue] [key otp] [manpage modules/virtchannel_transform/vt_otp.man tcl::transform::otp] | > > | 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 | [manpage modules/cron/cron.man cron] [manpage modules/nettool/nettool.man nettool] [manpage modules/processman/processman.man processman] [key on-idle] [manpage modules/uev/uevent_onidle.man uevent::onidle] [key {one time pad}] [manpage modules/virtchannel_transform/vt_otp.man tcl::transform::otp] [key oo] [manpage modules/clay/clay.man clay] [key optimization] [manpage modules/math/optimize.man math::optimize] [manpage modules/simulation/annealing.man simulation::annealing] [key {ordered list}] [manpage modules/struct/prioqueue.man struct::prioqueue] [key otp] [manpage modules/virtchannel_transform/vt_otp.man tcl::transform::otp] |
︙ | ︙ | |||
2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 | [manpage modules/pt/pt_util.man pt::util] [manpage modules/pt/pt_to_api.man pt_export_api] [manpage modules/pt/pt_from_api.man pt_import_api] [manpage modules/pt/pt_introduction.man pt_introduction] [manpage modules/pt/pt_parse_peg.man pt_parse_peg] [manpage modules/pt/pt_parser_api.man pt_parser_api] [manpage modules/pt/pt_peg_op.man pt_peg_op] [key queue] [manpage modules/csv/csv.man csv] [manpage modules/htmlparse/htmlparse.man htmlparse] [manpage modules/struct/stack.man struct::stack] [manpage modules/transfer/tqueue.man transfer::copy::queue] [key quoting] [manpage modules/page/page_util_quote.man page_util_quote] | > > | 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 | [manpage modules/pt/pt_util.man pt::util] [manpage modules/pt/pt_to_api.man pt_export_api] [manpage modules/pt/pt_from_api.man pt_import_api] [manpage modules/pt/pt_introduction.man pt_introduction] [manpage modules/pt/pt_parse_peg.man pt_parse_peg] [manpage modules/pt/pt_parser_api.man pt_parser_api] [manpage modules/pt/pt_peg_op.man pt_peg_op] [key quasi-random] [manpage modules/math/quasirandom.man math::quasirandom] [key queue] [manpage modules/csv/csv.man csv] [manpage modules/htmlparse/htmlparse.man htmlparse] [manpage modules/struct/stack.man struct::stack] [manpage modules/transfer/tqueue.man transfer::copy::queue] [key quoting] [manpage modules/page/page_util_quote.man page_util_quote] |
︙ | ︙ | |||
2944 2945 2946 2947 2948 2949 2950 2951 | [manpage modules/nns/nns_intro.man nns_intro] [manpage apps/nnsd.man nnsd] [manpage modules/udpcluster/udpcluster.man udpcluster] [key service] [manpage modules/log/logger.man logger] [key services] [manpage modules/ftpd/ftpd.man ftpd] [manpage modules/smtpd/smtpd.man smtpd] | > < | 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 | [manpage modules/nns/nns_intro.man nns_intro] [manpage apps/nnsd.man nnsd] [manpage modules/udpcluster/udpcluster.man udpcluster] [key service] [manpage modules/log/logger.man logger] [key services] [manpage modules/ftpd/ftpd.man ftpd] [manpage modules/httpd/httpd.man httpd] [manpage modules/smtpd/smtpd.man smtpd] [key set] [manpage modules/struct/queue.man struct::queue] [manpage modules/struct/struct_set.man struct::set] [key sha1] [manpage modules/sha1/sha1.man sha1] [key sha256] [manpage modules/sha1/sha256.man sha256] |
︙ | ︙ | |||
3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 | [manpage modules/doctools2idx/idx_container.man doctools::idx] [manpage modules/doctools2idx/idx_export.man doctools::idx::export] [manpage modules/doctools2toc/toc_container.man doctools::toc] [manpage modules/doctools2toc/toc_export.man doctools::toc::export] [key tcllib] [manpage modules/csv/csv.man csv] [key TclOO] [manpage modules/ooutil/ooutil.man oo::util] [manpage modules/tool/meta.man oo::util] [manpage modules/oometa/oometa.man oometa] [manpage modules/tool/tool.man tool] | > > < | 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 | [manpage modules/doctools2idx/idx_container.man doctools::idx] [manpage modules/doctools2idx/idx_export.man doctools::idx::export] [manpage modules/doctools2toc/toc_container.man doctools::toc] [manpage modules/doctools2toc/toc_export.man doctools::toc::export] [key tcllib] [manpage modules/csv/csv.man csv] [key TclOO] [manpage modules/clay/clay.man clay] [manpage modules/httpd/httpd.man httpd] [manpage modules/ooutil/ooutil.man oo::util] [manpage modules/tool/meta.man oo::util] [manpage modules/oometa/oometa.man oometa] [manpage modules/tool/tool.man tool] [manpage modules/tool/tool_dict_ensemble.man tool::dict_ensemble] [key TCLPARAM] [manpage modules/pt/pt_peg_to_tclparam.man pt::peg::to::tclparam] [key TDPL] [manpage modules/grammar_peg/peg.man grammar::peg] [manpage modules/grammar_peg/peg_interp.man grammar::peg::interp] [manpage apps/pt.man pt] |
︙ | ︙ | |||
3760 3761 3762 3763 3764 3765 3766 | [manpage modules/doctools/doctoc.man doctools::toc] [manpage modules/doctools2toc/toc_export.man doctools::toc::export] [manpage modules/doctools2toc/toc_export_wiki.man doctools::toc::export::wiki] [key word] [manpage modules/doctools2base/tcl_parse.man doctools::tcl::parse] [manpage modules/wip/wip.man wip] [key WWW] | | | 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 | [manpage modules/doctools/doctoc.man doctools::toc] [manpage modules/doctools2toc/toc_export.man doctools::toc::export] [manpage modules/doctools2toc/toc_export_wiki.man doctools::toc::export::wiki] [key word] [manpage modules/doctools2base/tcl_parse.man doctools::tcl::parse] [manpage modules/wip/wip.man wip] [key WWW] [manpage modules/httpd/httpd.man httpd] [key www] [manpage modules/uri/uri.man uri] [key x.208] [manpage modules/asn/asn.man asn] [key x.209] [manpage modules/asn/asn.man asn] [key x.500] |
︙ | ︙ |
Changes to support/devel/sak/doc/manpages.txt.
︙ | ︙ | |||
23 24 25 26 27 28 29 30 31 32 33 34 35 36 | modules/bench/bench_lang_spec.man modules/bench/bench_read.man modules/bench/bench_wcsv.man modules/bench/bench_wtext.man modules/bibtex/bibtex.man modules/blowfish/blowfish.man modules/cache/async.man modules/clock/iso8601.man modules/clock/rfc2822.man modules/cmdline/cmdline.man modules/comm/comm.man modules/comm/comm_wire.man modules/control/control.man modules/coroutine/coro_auto.man | > | 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | modules/bench/bench_lang_spec.man modules/bench/bench_read.man modules/bench/bench_wcsv.man modules/bench/bench_wtext.man modules/bibtex/bibtex.man modules/blowfish/blowfish.man modules/cache/async.man modules/clay/clay.man modules/clock/iso8601.man modules/clock/rfc2822.man modules/cmdline/cmdline.man modules/comm/comm.man modules/comm/comm_wire.man modules/control/control.man modules/coroutine/coro_auto.man |
︙ | ︙ | |||
119 120 121 122 123 124 125 126 127 128 129 130 131 132 | modules/doctools2toc/toc_msgcat_fr.man modules/doctools2toc/toc_parse.man modules/doctools2toc/toc_structure.man modules/dtplite/pkg_dtplite.man modules/fileutil/fileutil.man modules/fileutil/multi.man modules/fileutil/multiop.man modules/fileutil/traverse.man modules/ftp/ftp.man modules/ftp/ftp_geturl.man modules/ftpd/ftpd.man modules/fumagic/cfront.man modules/fumagic/cgen.man modules/fumagic/filetypes.man | > | 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | modules/doctools2toc/toc_msgcat_fr.man modules/doctools2toc/toc_parse.man modules/doctools2toc/toc_structure.man modules/dtplite/pkg_dtplite.man modules/fileutil/fileutil.man modules/fileutil/multi.man modules/fileutil/multiop.man modules/fileutil/paths.man modules/fileutil/traverse.man modules/ftp/ftp.man modules/ftp/ftp_geturl.man modules/ftpd/ftpd.man modules/fumagic/cfront.man modules/fumagic/cgen.man modules/fumagic/filetypes.man |
︙ | ︙ | |||
194 195 196 197 198 199 200 201 202 203 204 205 206 207 | modules/math/math.man modules/math/math_geometry.man modules/math/numtheory.man modules/math/optimize.man modules/math/pca.man modules/math/polynomials.man modules/math/qcomplex.man modules/math/rational_funcs.man modules/math/roman.man modules/math/romberg.man modules/math/special.man modules/math/statistics.man modules/math/symdiff.man modules/math/trig.man | > | 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | modules/math/math.man modules/math/math_geometry.man modules/math/numtheory.man modules/math/optimize.man modules/math/pca.man modules/math/polynomials.man modules/math/qcomplex.man modules/math/quasirandom.man modules/math/rational_funcs.man modules/math/roman.man modules/math/romberg.man modules/math/special.man modules/math/statistics.man modules/math/symdiff.man modules/math/trig.man |
︙ | ︙ | |||
322 323 324 325 326 327 328 329 330 331 332 333 334 335 | modules/struct/pool.man modules/struct/prioqueue.man modules/struct/queue.man modules/struct/record.man modules/struct/skiplist.man modules/struct/stack.man modules/struct/struct_list.man modules/struct/struct_set.man modules/struct/struct_tree.man modules/struct/struct_tree1.man modules/tar/tar.man modules/tepam/tepam_argument_dialogbox.man modules/tepam/tepam_doc_gen.man modules/tepam/tepam_introduction.man | > | 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 | modules/struct/pool.man modules/struct/prioqueue.man modules/struct/queue.man modules/struct/record.man modules/struct/skiplist.man modules/struct/stack.man modules/struct/struct_list.man modules/struct/struct_map.man modules/struct/struct_set.man modules/struct/struct_tree.man modules/struct/struct_tree1.man modules/tar/tar.man modules/tepam/tepam_argument_dialogbox.man modules/tepam/tepam_doc_gen.man modules/tepam/tepam_introduction.man |
︙ | ︙ |
Changes to support/devel/sak/doc/toc.txt.
︙ | ︙ | |||
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 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/simulation/annealing.man simulation::annealing {Simulated annealing}] [item modules/simulation/montecarlo.man simulation::montecarlo {Monte Carlo simulations}] [item modules/simulation/simulation_random.man simulation::random {Pseudo-random number generators}] [division_end] [division_start Networking] [item modules/asn/asn.man asn {ASN.1 BER encoder/decoder}] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [item modules/bee/bee.man bee {BitTorrent Serialization Format Encoder/Decoder}] [item modules/dns/tcllib_dns.man dns {Tcl Domain Name Service Client}] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [item modules/ftpd/ftpd.man ftpd {Tcl FTP server implementation}] [item modules/ident/ident.man ident {Ident protocol client}] [item modules/irc/irc.man irc {Create IRC connection and interface.}] [item modules/ldap/ldap.man ldap {LDAP client}] [item modules/ldap/ldapx.man ldapx {LDAP extended object interface}] [item modules/nns/nns_client.man nameserv {Name service facility, Client}] [item modules/nns/nns_auto.man nameserv::auto {Name service facility, Client Extension}] [item modules/nns/nns_common.man nameserv::common {Name service facility, shared definitions}] [item modules/nns/nns_protocol.man nameserv::protocol {Name service facility, client/server protocol}] | > > > | 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 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/quasirandom.man math::quasirandom {Quasi-random points for integration and Monte Carlo type methods}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/simulation/annealing.man simulation::annealing {Simulated annealing}] [item modules/simulation/montecarlo.man simulation::montecarlo {Monte Carlo simulations}] [item modules/simulation/simulation_random.man simulation::random {Pseudo-random number generators}] [division_end] [division_start Networking] [item modules/asn/asn.man asn {ASN.1 BER encoder/decoder}] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [item modules/bee/bee.man bee {BitTorrent Serialization Format Encoder/Decoder}] [item modules/dns/tcllib_dns.man dns {Tcl Domain Name Service Client}] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [item modules/ftpd/ftpd.man ftpd {Tcl FTP server implementation}] [item modules/httpd/httpd.man httpd {A TclOO and coroutine based web server}] [item modules/ident/ident.man ident {Ident protocol client}] [item modules/imap4/imap4.man imap4 {imap client-side tcl implementation of imap protocol}] [item modules/irc/irc.man irc {Create IRC connection and interface.}] [item modules/ldap/ldap.man ldap {LDAP client}] [item modules/ldap/ldapx.man ldapx {LDAP extended object interface}] [item modules/nns/nns_client.man nameserv {Name service facility, Client}] [item modules/nns/nns_auto.man nameserv::auto {Name service facility, Client Extension}] [item modules/nns/nns_common.man nameserv::common {Name service facility, shared definitions}] [item modules/nns/nns_protocol.man nameserv::protocol {Name service facility, client/server protocol}] |
︙ | ︙ | |||
254 255 256 257 258 259 260 | [item modules/sasl/sasl.man SASL {Implementation of SASL mechanisms for Tcl}] [item modules/sasl/ntlm.man SASL::NTLM {Implementation of SASL NTLM mechanism for Tcl}] [item modules/sasl/scram.man SASL::SCRAM {Implementation of SASL SCRAM mechanism for Tcl}] [item modules/sasl/gtoken.man SASL::XGoogleToken {Implementation of SASL NTLM mechanism for Tcl}] [item modules/mime/smtp.man smtp {Client-side tcl implementation of the smtp protocol}] [item modules/smtpd/smtpd.man smtpd {Tcl SMTP server implementation}] [item modules/dns/tcllib_ip.man tcllib_ip {IPv4 and IPv6 address manipulation}] | < | 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | [item modules/sasl/sasl.man SASL {Implementation of SASL mechanisms for Tcl}] [item modules/sasl/ntlm.man SASL::NTLM {Implementation of SASL NTLM mechanism for Tcl}] [item modules/sasl/scram.man SASL::SCRAM {Implementation of SASL SCRAM mechanism for Tcl}] [item modules/sasl/gtoken.man SASL::XGoogleToken {Implementation of SASL NTLM mechanism for Tcl}] [item modules/mime/smtp.man smtp {Client-side tcl implementation of the smtp protocol}] [item modules/smtpd/smtpd.man smtpd {Tcl SMTP server implementation}] [item modules/dns/tcllib_ip.man tcllib_ip {IPv4 and IPv6 address manipulation}] [item modules/udpcluster/udpcluster.man udpcluster {UDP Peer-to-Peer cluster}] [item modules/uri/uri.man uri {URI utilities}] [item modules/uri/urn-scheme.man uri_urn {URI utilities, URN scheme}] [item modules/websocket/websocket.man websocket {Tcl implementation of the websocket protocol}] [division_end] [division_start {Page Parser Generator}] [item apps/page.man page {Parser Generator}] |
︙ | ︙ | |||
320 321 322 323 324 325 326 327 328 329 330 331 332 333 | [item modules/pt/pt_peg_op.man pt_peg_op {Parser Tools PE Grammar Utility Operations}] [division_end] [division_start {Procedures, arguments, parameters, options}] [item modules/tepam/tepam_introduction.man tepam {An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager}] [item modules/tepam/tepam_procedure.man tepam::procedure {TEPAM procedure, reference manual}] [division_end] [division_start {Programming tools}] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [item modules/comm/comm.man comm {A remote communication facility for Tcl (8.3 and later)}] [item modules/comm/comm_wire.man comm_wire {The comm wire protocol}] [item modules/control/control.man control {Procedures for control flow structures.}] [item modules/interp/deleg_method.man deleg_method {Creation of comm delegates (snit methods)}] [item modules/interp/deleg_proc.man deleg_proc {Creation of comm delegates (procedures)}] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] | > | 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 | [item modules/pt/pt_peg_op.man pt_peg_op {Parser Tools PE Grammar Utility Operations}] [division_end] [division_start {Procedures, arguments, parameters, options}] [item modules/tepam/tepam_introduction.man tepam {An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager}] [item modules/tepam/tepam_procedure.man tepam::procedure {TEPAM procedure, reference manual}] [division_end] [division_start {Programming tools}] [item modules/clay/clay.man clay {A minimalist framework for large scale OO Projects}] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [item modules/comm/comm.man comm {A remote communication facility for Tcl (8.3 and later)}] [item modules/comm/comm_wire.man comm_wire {The comm wire protocol}] [item modules/control/control.man control {Procedures for control flow structures.}] [item modules/interp/deleg_method.man deleg_method {Creation of comm delegates (snit methods)}] [item modules/interp/deleg_proc.man deleg_proc {Creation of comm delegates (procedures)}] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] |
︙ | ︙ | |||
433 434 435 436 437 438 439 440 441 | [item modules/transfer/ddest.man transfer::data::destination {Data destination}] [item modules/transfer/dsource.man transfer::data::source {Data source}] [item modules/transfer/receiver.man transfer::receiver {Data source}] [item modules/transfer/transmitter.man transfer::transmitter {Data source}] [division_end] [division_start Unfiled] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [item modules/generator/generator.man generator {Procedures for creating and using generators.}] [item modules/yaml/huddle.man huddle {Create and manipulate huddle object}] | > < > | 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 | [item modules/transfer/ddest.man transfer::data::destination {Data destination}] [item modules/transfer/dsource.man transfer::data::source {Data source}] [item modules/transfer/receiver.man transfer::receiver {Data source}] [item modules/transfer/transmitter.man transfer::transmitter {Data source}] [division_end] [division_start Unfiled] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [item modules/fileutil/paths.man fileutil::paths {Manage search path pools}] [item modules/generator/generator.man generator {Procedures for creating and using generators.}] [item modules/yaml/huddle.man huddle {Create and manipulate huddle object}] [item modules/map/map_geocode_nominatim.man map::geocode::nominatim {Resolving geographical names with a Nominatim service}] [item modules/map/map_slippy.man map::slippy {Common code for slippy based map packages}] [item modules/map/map_slippy_cache.man map::slippy::cache {Management of a tile cache in the local filesystem}] [item modules/map/map_slippy_fetcher.man map::slippy::fetcher {Accessing a server providing tiles for slippy-based maps}] [item modules/mapproj/mapproj.man mapproj {Map projection routines}] [item modules/math/symdiff.man math::calculus::symdiff {Symbolic differentiation for Tcl}] [item modules/namespacex/namespacex.man namespacex {Namespace utility commands}] [item modules/rest/rest.man rest {define REST web APIs and call them inline or asychronously}] [item modules/stringprep/stringprep.man stringprep {Implementation of stringprep}] [item modules/stringprep/stringprep_data.man stringprep::data {stringprep data tables, generated, internal}] [item modules/struct/struct_map.man struct::map {Manage key/value maps}] [item modules/math/machineparameters.man tclrep/machineparameters {Compute double precision machine parameters.}] [item modules/uev/uevent_onidle.man uevent::onidle {Request merging and deferal to idle time}] [item modules/stringprep/unicode.man unicode {Implementation of Unicode normalization}] [item modules/stringprep/unicode_data.man unicode::data {unicode data tables, generated, internal}] [item modules/units/units.man units {unit conversion}] [item modules/yaml/yaml.man yaml {YAML Format Encoder/Decoder}] [division_end] |
︙ | ︙ | |||
535 536 537 538 539 540 541 542 543 544 545 546 547 548 | [division_end] [division_start blowfish] [item modules/blowfish/blowfish.man blowfish {Implementation of the Blowfish block cipher}] [division_end] [division_start cache] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [division_end] [division_start clock] [item modules/clock/iso8601.man clock_iso8601 {Parsing ISO 8601 dates/times}] [item modules/clock/rfc2822.man clock_rfc2822 {Parsing ISO 8601 dates/times}] [division_end] [division_start cmdline] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [division_end] | > > > | 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 | [division_end] [division_start blowfish] [item modules/blowfish/blowfish.man blowfish {Implementation of the Blowfish block cipher}] [division_end] [division_start cache] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [division_end] [division_start clay] [item modules/clay/clay.man clay {A minimalist framework for large scale OO Projects}] [division_end] [division_start clock] [item modules/clock/iso8601.man clock_iso8601 {Parsing ISO 8601 dates/times}] [item modules/clock/rfc2822.man clock_rfc2822 {Parsing ISO 8601 dates/times}] [division_end] [division_start cmdline] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [division_end] |
︙ | ︙ | |||
672 673 674 675 676 677 678 679 680 681 682 683 684 685 | [division_start dtplite] [item modules/dtplite/pkg_dtplite.man dtplite {Lightweight DocTools Markup Processor}] [division_end] [division_start fileutil] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] [item modules/fileutil/multi.man fileutil::multi {Multi-file operation, scatter/gather, standard object}] [item modules/fileutil/multiop.man fileutil::multi::op {Multi-file operation, scatter/gather}] [item modules/fileutil/traverse.man fileutil_traverse {Iterative directory traversal}] [division_end] [division_start ftp] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [division_end] [division_start ftpd] | > | 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | [division_start dtplite] [item modules/dtplite/pkg_dtplite.man dtplite {Lightweight DocTools Markup Processor}] [division_end] [division_start fileutil] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] [item modules/fileutil/multi.man fileutil::multi {Multi-file operation, scatter/gather, standard object}] [item modules/fileutil/multiop.man fileutil::multi::op {Multi-file operation, scatter/gather}] [item modules/fileutil/paths.man fileutil::paths {Manage search path pools}] [item modules/fileutil/traverse.man fileutil_traverse {Iterative directory traversal}] [division_end] [division_start ftp] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [division_end] [division_start ftpd] |
︙ | ︙ | |||
729 730 731 732 733 734 735 | [division_start htmlparse] [item modules/htmlparse/htmlparse.man htmlparse {Procedures to parse HTML strings}] [division_end] [division_start http] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [division_end] [division_start httpd] | | | 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 | [division_start htmlparse] [item modules/htmlparse/htmlparse.man htmlparse {Procedures to parse HTML strings}] [division_end] [division_start http] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [division_end] [division_start httpd] [item modules/httpd/httpd.man httpd {A TclOO and coroutine based web server}] [division_end] [division_start ident] [item modules/ident/ident.man ident {Ident protocol client}] [division_end] [division_start imap4] [item modules/imap4/imap4.man imap4 {imap client-side tcl implementation of imap protocol}] [division_end] |
︙ | ︙ | |||
808 809 810 811 812 813 814 815 816 817 818 819 820 821 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/math/machineparameters.man tclrep/machineparameters {Compute double precision machine parameters.}] [division_end] | > | 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/quasirandom.man math::quasirandom {Quasi-random points for integration and Monte Carlo type methods}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/math/machineparameters.man tclrep/machineparameters {Compute double precision machine parameters.}] [division_end] |
︙ | ︙ | |||
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 | [division_end] [division_start struct] [item modules/struct/disjointset.man struct::disjointset {Disjoint set data structure}] [item modules/struct/graph.man struct::graph {Create and manipulate directed graph objects}] [item modules/struct/graphops.man struct::graph::op {Operation for (un)directed graph objects}] [item modules/struct/graph1.man struct::graph_v1 {Create and manipulate directed graph objects}] [item modules/struct/struct_list.man struct::list {Procedures for manipulating lists}] [item modules/struct/matrix.man struct::matrix {Create and manipulate matrix objects}] [item modules/struct/matrix1.man struct::matrix_v1 {Create and manipulate matrix objects}] [item modules/struct/pool.man struct::pool {Create and manipulate pool objects (of discrete items)}] [item modules/struct/prioqueue.man struct::prioqueue {Create and manipulate prioqueue objects}] [item modules/struct/queue.man struct::queue {Create and manipulate queue objects}] [item modules/struct/record.man struct::record {Define and create records (similar to 'C' structures)}] [item modules/struct/struct_set.man struct::set {Procedures for manipulating sets}] | > | 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 | [division_end] [division_start struct] [item modules/struct/disjointset.man struct::disjointset {Disjoint set data structure}] [item modules/struct/graph.man struct::graph {Create and manipulate directed graph objects}] [item modules/struct/graphops.man struct::graph::op {Operation for (un)directed graph objects}] [item modules/struct/graph1.man struct::graph_v1 {Create and manipulate directed graph objects}] [item modules/struct/struct_list.man struct::list {Procedures for manipulating lists}] [item modules/struct/struct_map.man struct::map {Manage key/value maps}] [item modules/struct/matrix.man struct::matrix {Create and manipulate matrix objects}] [item modules/struct/matrix1.man struct::matrix_v1 {Create and manipulate matrix objects}] [item modules/struct/pool.man struct::pool {Create and manipulate pool objects (of discrete items)}] [item modules/struct/prioqueue.man struct::prioqueue {Create and manipulate prioqueue objects}] [item modules/struct/queue.man struct::queue {Create and manipulate queue objects}] [item modules/struct/record.man struct::record {Define and create records (similar to 'C' structures)}] [item modules/struct/struct_set.man struct::set {Procedures for manipulating sets}] |
︙ | ︙ |
Changes to support/devel/sak/doc/toc_cats.txt.
︙ | ︙ | |||
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 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/simulation/annealing.man simulation::annealing {Simulated annealing}] [item modules/simulation/montecarlo.man simulation::montecarlo {Monte Carlo simulations}] [item modules/simulation/simulation_random.man simulation::random {Pseudo-random number generators}] [division_end] [division_start Networking] [item modules/asn/asn.man asn {ASN.1 BER encoder/decoder}] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [item modules/bee/bee.man bee {BitTorrent Serialization Format Encoder/Decoder}] [item modules/dns/tcllib_dns.man dns {Tcl Domain Name Service Client}] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [item modules/ftpd/ftpd.man ftpd {Tcl FTP server implementation}] [item modules/ident/ident.man ident {Ident protocol client}] [item modules/irc/irc.man irc {Create IRC connection and interface.}] [item modules/ldap/ldap.man ldap {LDAP client}] [item modules/ldap/ldapx.man ldapx {LDAP extended object interface}] [item modules/nns/nns_client.man nameserv {Name service facility, Client}] [item modules/nns/nns_auto.man nameserv::auto {Name service facility, Client Extension}] [item modules/nns/nns_common.man nameserv::common {Name service facility, shared definitions}] [item modules/nns/nns_protocol.man nameserv::protocol {Name service facility, client/server protocol}] | > > > | 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 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/quasirandom.man math::quasirandom {Quasi-random points for integration and Monte Carlo type methods}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/simulation/annealing.man simulation::annealing {Simulated annealing}] [item modules/simulation/montecarlo.man simulation::montecarlo {Monte Carlo simulations}] [item modules/simulation/simulation_random.man simulation::random {Pseudo-random number generators}] [division_end] [division_start Networking] [item modules/asn/asn.man asn {ASN.1 BER encoder/decoder}] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [item modules/bee/bee.man bee {BitTorrent Serialization Format Encoder/Decoder}] [item modules/dns/tcllib_dns.man dns {Tcl Domain Name Service Client}] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [item modules/ftpd/ftpd.man ftpd {Tcl FTP server implementation}] [item modules/httpd/httpd.man httpd {A TclOO and coroutine based web server}] [item modules/ident/ident.man ident {Ident protocol client}] [item modules/imap4/imap4.man imap4 {imap client-side tcl implementation of imap protocol}] [item modules/irc/irc.man irc {Create IRC connection and interface.}] [item modules/ldap/ldap.man ldap {LDAP client}] [item modules/ldap/ldapx.man ldapx {LDAP extended object interface}] [item modules/nns/nns_client.man nameserv {Name service facility, Client}] [item modules/nns/nns_auto.man nameserv::auto {Name service facility, Client Extension}] [item modules/nns/nns_common.man nameserv::common {Name service facility, shared definitions}] [item modules/nns/nns_protocol.man nameserv::protocol {Name service facility, client/server protocol}] |
︙ | ︙ | |||
254 255 256 257 258 259 260 | [item modules/sasl/sasl.man SASL {Implementation of SASL mechanisms for Tcl}] [item modules/sasl/ntlm.man SASL::NTLM {Implementation of SASL NTLM mechanism for Tcl}] [item modules/sasl/scram.man SASL::SCRAM {Implementation of SASL SCRAM mechanism for Tcl}] [item modules/sasl/gtoken.man SASL::XGoogleToken {Implementation of SASL NTLM mechanism for Tcl}] [item modules/mime/smtp.man smtp {Client-side tcl implementation of the smtp protocol}] [item modules/smtpd/smtpd.man smtpd {Tcl SMTP server implementation}] [item modules/dns/tcllib_ip.man tcllib_ip {IPv4 and IPv6 address manipulation}] | < | 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | [item modules/sasl/sasl.man SASL {Implementation of SASL mechanisms for Tcl}] [item modules/sasl/ntlm.man SASL::NTLM {Implementation of SASL NTLM mechanism for Tcl}] [item modules/sasl/scram.man SASL::SCRAM {Implementation of SASL SCRAM mechanism for Tcl}] [item modules/sasl/gtoken.man SASL::XGoogleToken {Implementation of SASL NTLM mechanism for Tcl}] [item modules/mime/smtp.man smtp {Client-side tcl implementation of the smtp protocol}] [item modules/smtpd/smtpd.man smtpd {Tcl SMTP server implementation}] [item modules/dns/tcllib_ip.man tcllib_ip {IPv4 and IPv6 address manipulation}] [item modules/udpcluster/udpcluster.man udpcluster {UDP Peer-to-Peer cluster}] [item modules/uri/uri.man uri {URI utilities}] [item modules/uri/urn-scheme.man uri_urn {URI utilities, URN scheme}] [item modules/websocket/websocket.man websocket {Tcl implementation of the websocket protocol}] [division_end] [division_start {Page Parser Generator}] [item apps/page.man page {Parser Generator}] |
︙ | ︙ | |||
320 321 322 323 324 325 326 327 328 329 330 331 332 333 | [item modules/pt/pt_peg_op.man pt_peg_op {Parser Tools PE Grammar Utility Operations}] [division_end] [division_start {Procedures, arguments, parameters, options}] [item modules/tepam/tepam_introduction.man tepam {An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager}] [item modules/tepam/tepam_procedure.man tepam::procedure {TEPAM procedure, reference manual}] [division_end] [division_start {Programming tools}] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [item modules/comm/comm.man comm {A remote communication facility for Tcl (8.3 and later)}] [item modules/comm/comm_wire.man comm_wire {The comm wire protocol}] [item modules/control/control.man control {Procedures for control flow structures.}] [item modules/interp/deleg_method.man deleg_method {Creation of comm delegates (snit methods)}] [item modules/interp/deleg_proc.man deleg_proc {Creation of comm delegates (procedures)}] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] | > | 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 | [item modules/pt/pt_peg_op.man pt_peg_op {Parser Tools PE Grammar Utility Operations}] [division_end] [division_start {Procedures, arguments, parameters, options}] [item modules/tepam/tepam_introduction.man tepam {An introduction into TEPAM, Tcl's Enhanced Procedure and Argument Manager}] [item modules/tepam/tepam_procedure.man tepam::procedure {TEPAM procedure, reference manual}] [division_end] [division_start {Programming tools}] [item modules/clay/clay.man clay {A minimalist framework for large scale OO Projects}] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [item modules/comm/comm.man comm {A remote communication facility for Tcl (8.3 and later)}] [item modules/comm/comm_wire.man comm_wire {The comm wire protocol}] [item modules/control/control.man control {Procedures for control flow structures.}] [item modules/interp/deleg_method.man deleg_method {Creation of comm delegates (snit methods)}] [item modules/interp/deleg_proc.man deleg_proc {Creation of comm delegates (procedures)}] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] |
︙ | ︙ | |||
433 434 435 436 437 438 439 440 441 | [item modules/transfer/ddest.man transfer::data::destination {Data destination}] [item modules/transfer/dsource.man transfer::data::source {Data source}] [item modules/transfer/receiver.man transfer::receiver {Data source}] [item modules/transfer/transmitter.man transfer::transmitter {Data source}] [division_end] [division_start Unfiled] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [item modules/generator/generator.man generator {Procedures for creating and using generators.}] [item modules/yaml/huddle.man huddle {Create and manipulate huddle object}] | > < > | 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 | [item modules/transfer/ddest.man transfer::data::destination {Data destination}] [item modules/transfer/dsource.man transfer::data::source {Data source}] [item modules/transfer/receiver.man transfer::receiver {Data source}] [item modules/transfer/transmitter.man transfer::transmitter {Data source}] [division_end] [division_start Unfiled] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [item modules/fileutil/paths.man fileutil::paths {Manage search path pools}] [item modules/generator/generator.man generator {Procedures for creating and using generators.}] [item modules/yaml/huddle.man huddle {Create and manipulate huddle object}] [item modules/map/map_geocode_nominatim.man map::geocode::nominatim {Resolving geographical names with a Nominatim service}] [item modules/map/map_slippy.man map::slippy {Common code for slippy based map packages}] [item modules/map/map_slippy_cache.man map::slippy::cache {Management of a tile cache in the local filesystem}] [item modules/map/map_slippy_fetcher.man map::slippy::fetcher {Accessing a server providing tiles for slippy-based maps}] [item modules/mapproj/mapproj.man mapproj {Map projection routines}] [item modules/math/symdiff.man math::calculus::symdiff {Symbolic differentiation for Tcl}] [item modules/namespacex/namespacex.man namespacex {Namespace utility commands}] [item modules/rest/rest.man rest {define REST web APIs and call them inline or asychronously}] [item modules/stringprep/stringprep.man stringprep {Implementation of stringprep}] [item modules/stringprep/stringprep_data.man stringprep::data {stringprep data tables, generated, internal}] [item modules/struct/struct_map.man struct::map {Manage key/value maps}] [item modules/math/machineparameters.man tclrep/machineparameters {Compute double precision machine parameters.}] [item modules/uev/uevent_onidle.man uevent::onidle {Request merging and deferal to idle time}] [item modules/stringprep/unicode.man unicode {Implementation of Unicode normalization}] [item modules/stringprep/unicode_data.man unicode::data {unicode data tables, generated, internal}] [item modules/units/units.man units {unit conversion}] [item modules/yaml/yaml.man yaml {YAML Format Encoder/Decoder}] [division_end] |
︙ | ︙ |
Changes to support/devel/sak/doc/toc_mods.txt.
︙ | ︙ | |||
38 39 40 41 42 43 44 45 46 47 48 49 50 51 | [division_end] [division_start blowfish] [item modules/blowfish/blowfish.man blowfish {Implementation of the Blowfish block cipher}] [division_end] [division_start cache] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [division_end] [division_start clock] [item modules/clock/iso8601.man clock_iso8601 {Parsing ISO 8601 dates/times}] [item modules/clock/rfc2822.man clock_rfc2822 {Parsing ISO 8601 dates/times}] [division_end] [division_start cmdline] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [division_end] | > > > | 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | [division_end] [division_start blowfish] [item modules/blowfish/blowfish.man blowfish {Implementation of the Blowfish block cipher}] [division_end] [division_start cache] [item modules/cache/async.man cache::async {Asynchronous in-memory cache}] [division_end] [division_start clay] [item modules/clay/clay.man clay {A minimalist framework for large scale OO Projects}] [division_end] [division_start clock] [item modules/clock/iso8601.man clock_iso8601 {Parsing ISO 8601 dates/times}] [item modules/clock/rfc2822.man clock_rfc2822 {Parsing ISO 8601 dates/times}] [division_end] [division_start cmdline] [item modules/cmdline/cmdline.man cmdline {Procedures to process command lines and options.}] [division_end] |
︙ | ︙ | |||
175 176 177 178 179 180 181 182 183 184 185 186 187 188 | [division_start dtplite] [item modules/dtplite/pkg_dtplite.man dtplite {Lightweight DocTools Markup Processor}] [division_end] [division_start fileutil] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] [item modules/fileutil/multi.man fileutil::multi {Multi-file operation, scatter/gather, standard object}] [item modules/fileutil/multiop.man fileutil::multi::op {Multi-file operation, scatter/gather}] [item modules/fileutil/traverse.man fileutil_traverse {Iterative directory traversal}] [division_end] [division_start ftp] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [division_end] [division_start ftpd] | > | 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | [division_start dtplite] [item modules/dtplite/pkg_dtplite.man dtplite {Lightweight DocTools Markup Processor}] [division_end] [division_start fileutil] [item modules/fileutil/fileutil.man fileutil {Procedures implementing some file utilities}] [item modules/fileutil/multi.man fileutil::multi {Multi-file operation, scatter/gather, standard object}] [item modules/fileutil/multiop.man fileutil::multi::op {Multi-file operation, scatter/gather}] [item modules/fileutil/paths.man fileutil::paths {Manage search path pools}] [item modules/fileutil/traverse.man fileutil_traverse {Iterative directory traversal}] [division_end] [division_start ftp] [item modules/ftp/ftp.man ftp {Client-side tcl implementation of the ftp protocol}] [item modules/ftp/ftp_geturl.man ftp::geturl {Uri handler for ftp urls}] [division_end] [division_start ftpd] |
︙ | ︙ | |||
232 233 234 235 236 237 238 | [division_start htmlparse] [item modules/htmlparse/htmlparse.man htmlparse {Procedures to parse HTML strings}] [division_end] [division_start http] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [division_end] [division_start httpd] | | | 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | [division_start htmlparse] [item modules/htmlparse/htmlparse.man htmlparse {Procedures to parse HTML strings}] [division_end] [division_start http] [item modules/http/autoproxy.man autoproxy {Automatic HTTP proxy usage and authentication}] [division_end] [division_start httpd] [item modules/httpd/httpd.man httpd {A TclOO and coroutine based web server}] [division_end] [division_start ident] [item modules/ident/ident.man ident {Ident protocol client}] [division_end] [division_start imap4] [item modules/imap4/imap4.man imap4 {imap client-side tcl implementation of imap protocol}] [division_end] |
︙ | ︙ | |||
311 312 313 314 315 316 317 318 319 320 321 322 323 324 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/math/machineparameters.man tclrep/machineparameters {Compute double precision machine parameters.}] [division_end] | > | 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | [item modules/math/math_geometry.man math::geometry {Geometrical computations}] [item modules/math/interpolate.man math::interpolate {Interpolation routines}] [item modules/math/linalg.man math::linearalgebra {Linear Algebra}] [item modules/math/numtheory.man math::numtheory {Number Theory}] [item modules/math/optimize.man math::optimize {Optimisation routines}] [item modules/math/pca.man math::PCA {Package for Principal Component Analysis}] [item modules/math/polynomials.man math::polynomials {Polynomial functions}] [item modules/math/quasirandom.man math::quasirandom {Quasi-random points for integration and Monte Carlo type methods}] [item modules/math/rational_funcs.man math::rationalfunctions {Polynomial functions}] [item modules/math/roman.man math::roman {Tools for creating and manipulating roman numerals}] [item modules/math/special.man math::special {Special mathematical functions}] [item modules/math/statistics.man math::statistics {Basic statistical functions and procedures}] [item modules/math/trig.man math::trig {Trigonometric anf hyperbolic functions}] [item modules/math/machineparameters.man tclrep/machineparameters {Compute double precision machine parameters.}] [division_end] |
︙ | ︙ | |||
512 513 514 515 516 517 518 519 520 521 522 523 524 525 | [division_end] [division_start struct] [item modules/struct/disjointset.man struct::disjointset {Disjoint set data structure}] [item modules/struct/graph.man struct::graph {Create and manipulate directed graph objects}] [item modules/struct/graphops.man struct::graph::op {Operation for (un)directed graph objects}] [item modules/struct/graph1.man struct::graph_v1 {Create and manipulate directed graph objects}] [item modules/struct/struct_list.man struct::list {Procedures for manipulating lists}] [item modules/struct/matrix.man struct::matrix {Create and manipulate matrix objects}] [item modules/struct/matrix1.man struct::matrix_v1 {Create and manipulate matrix objects}] [item modules/struct/pool.man struct::pool {Create and manipulate pool objects (of discrete items)}] [item modules/struct/prioqueue.man struct::prioqueue {Create and manipulate prioqueue objects}] [item modules/struct/queue.man struct::queue {Create and manipulate queue objects}] [item modules/struct/record.man struct::record {Define and create records (similar to 'C' structures)}] [item modules/struct/struct_set.man struct::set {Procedures for manipulating sets}] | > | 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | [division_end] [division_start struct] [item modules/struct/disjointset.man struct::disjointset {Disjoint set data structure}] [item modules/struct/graph.man struct::graph {Create and manipulate directed graph objects}] [item modules/struct/graphops.man struct::graph::op {Operation for (un)directed graph objects}] [item modules/struct/graph1.man struct::graph_v1 {Create and manipulate directed graph objects}] [item modules/struct/struct_list.man struct::list {Procedures for manipulating lists}] [item modules/struct/struct_map.man struct::map {Manage key/value maps}] [item modules/struct/matrix.man struct::matrix {Create and manipulate matrix objects}] [item modules/struct/matrix1.man struct::matrix_v1 {Create and manipulate matrix objects}] [item modules/struct/pool.man struct::pool {Create and manipulate pool objects (of discrete items)}] [item modules/struct/prioqueue.man struct::prioqueue {Create and manipulate prioqueue objects}] [item modules/struct/queue.man struct::queue {Create and manipulate queue objects}] [item modules/struct/record.man struct::record {Define and create records (similar to 'C' structures)}] [item modules/struct/struct_set.man struct::set {Procedures for manipulating sets}] |
︙ | ︙ |
Changes to support/devel/sak/localdoc/localdoc.tcl.
︙ | ︙ | |||
40 41 42 43 44 45 46 | set nav ../../../../home puts "Reindex the documentation..." sak::doc::imake __dummy__ $excluded sak::doc::index __dummy__ $excluded puts "Removing old documentation..." | | > < | 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | set nav ../../../../home puts "Reindex the documentation..." sak::doc::imake __dummy__ $excluded sak::doc::index __dummy__ $excluded puts "Removing old documentation..." # Keep the main index around however, manually created, edited, # not to be touched # TODO: catch errors and restore automatically file rename embedded/index.md e_index.md file delete -force embedded file mkdir embedded/md # Put the saved main page back into place, early. file rename e_index.md embedded/index.md run-idoc-man $baseconfig |
︙ | ︙ |
Changes to support/installation/modules.tcl.
︙ | ︙ | |||
29 30 31 32 33 34 35 36 37 38 39 40 41 42 | # -------------------------------------------------------------- # @@ Registration START Exclude calendar Exclude exif # name pkg doc example Module aes _tcl _man _null Module amazon-s3 _tcl _man _null Module asn _tcl _man _null Module base32 _tcl _man _null Module base64 _tcl _man _null Module bee _tcl _man _null | > > > > > | 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | # -------------------------------------------------------------- # @@ Registration START Exclude calendar Exclude exif # name pkg doc example Module 0compatibility _tcl _null _null # Wrapper packages redirecting deprecated/moved packages to their old # implementations. See pkgIndex.tcl for more notes. # name pkg doc example Module aes _tcl _man _null Module amazon-s3 _tcl _man _null Module asn _tcl _man _null Module base32 _tcl _man _null Module base64 _tcl _man _null Module bee _tcl _man _null |
︙ | ︙ |