cmdr: Check-in [4bacb86a2f]

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview

Comment:	Continued filling out the cmdr requirements.
Timelines:	family \| ancestors \| descendants \| both \| trunk
Files:	files \| file ages \| folders
SHA1:	4bacb86a2f13f74c159a4a66ac06ad392db65e35
User & Date:	andreask 2013-10-21 21:55:57

Context

2013-10-23
04:58		Added first manpages, for the utility packages (util, vcommon, help*). check-in: b1fbdec2c5 user: aku tags: trunk
2013-10-21
21:55		Continued filling out the cmdr requirements. check-in: 4bacb86a2f user: andreask tags: trunk
21:36		Filled out the basic changelog, and extended the set of requirements. check-in: 714b81acaf user: andreask tags: trunk

Changes

Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to doc/parts/requirements.inc.

[comment {--- Project requirements --}]
[include rq_tcl85.inc]
[include rq_kettle.inc]
[include rq_tcllib.inc]
[comment {-- [include rq_tcloo.inc] --}]
[comment {-- [include rq_linenoise.inc] --}]
[comment {-- [include rq_linenoiseutils.inc] --}]


|

<
|

>

[comment {--- Project requirements --}]
[include rq_tcl85.inc]
[include rq_tcloo.inc]
[include rq_tcllib.inc]

[include rq_linenoise.inc]
[comment {-- [include rq_linenoiseutils.inc] --}]
[include rq_kettle.inc]

Added doc/parts/rq_linenoise.inc.

>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

[subsection Linenoise]

The framework uses the [package linenoise] package in its implementation.
This package requires Tcl 8.5 or higher.

[para] Out of the many possibilites for getting Linenoise (OS vendor,
os-independent vendor, building from sources) use whatever you are
comfortable with.

[para] For myself, I am most comfortable with using
[uri http://www.activestate.com ActiveState's]
ActiveTcl distribution and TEApot.

[para] See the previous section ([sectref Tcl]) for disclosure and
information on how to get it.

[para] Assuming that ActiveTcl got installed running the command

[example {
    teacup install linenoise
}]

will install the package for your platform, if you have not done the
more inclusive

[example {
    teacup update
}]

to get everything and the kitchensink.

[para] For those wishing to build and install Linenoise on their own,
the relevant sources can be found at
[uri http://github.com/andreas-kupries/tcl-linenoise] together with
the necessary instructions on how to build it.

[para] If there are problems with building, installing, or using
linenoise please file a bug against Linenoise, or the vendor
of your distribution, and not [package [vset PROJECT]].

Changes to doc/parts/rq_tcllib.inc.

[para] See the previous section ([sectref Tcl]) for disclosure and
information on how to get it.

[para] Assuming that ActiveTcl got installed running the commands

[example {









    teacup install
}]

will install them for your platform, if you have not done the more
inclusive

[example {
    teacup update







>
>
>
>
>
>
>
>
>
|

[para] See the previous section ([sectref Tcl]) for disclosure and
information on how to get it.

[para] Assuming that ActiveTcl got installed running the commands

[example {
    teacup install debug
    teacup install debug::caller
    teacup install json::write
    teacup install lambda
    teacup install oo::util
    teacup install string::token::shell
    teacup install struct::queue
    teacup install term::ansi::code::ctrl
    teacup install textutil::adjust
    teacup install try
}]

will install them for your platform, if you have not done the more
inclusive

[example {
    teacup update

Added doc/parts/rq_tcloo.inc.

>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

[subsection TclOO]

The framework uses the [package TclOO] package in its implementation.
This package requires Tcl 8.5 or higher.

[para] In Tcl 8.6 the package is part of the core itself, without
requiring a separate installation.

[para] For Tcl 8.5 it has to be installed separately.

[para] Out of the many possibilites for getting TclOO (OS vendor,
os-independent vendor, building from sources) use whatever you are
comfortable with.

[para] For myself, I am most comfortable with using
[uri http://www.activestate.com ActiveState's]
ActiveTcl distribution and TEApot.

[para] See the previous section ([sectref Tcl]) for disclosure and
information on how to get it.

[para] Assuming that ActiveTcl got installed running the command

[example {
    teacup install TclOO
}]

will install the package for your platform, if you have not done the
more inclusive

[example {
    teacup update
}]

to get everything and the kitchensink.

[para] For those wishing to build and install TclOO on their own, the
relevant sources can be found at [uri http://core.tcl.tk/tcloo]
together with the necessary instructions on how to build it.

[para] If there are problems with building, installing, or using TclOO
and its packages please file a bug against TclOO, or the vendor of
your distribution, and not [package [vset PROJECT]].

Changes to embedded/man/files/cmdr_howto_installation.n.

.PP
Do you wish to build Tcl on your own ?
The sources of all versions can be found at
.TP
Tcl
\fIhttp://core.tcl.tk/tcl/\fR
.PP
.SS KETTLE
This project uses the Kettle application and package as its build system.

.PP
Please go to either the main repository at
\fIhttp://core.tcl.tk/akupries/kettle\fR
or the backup at
\fIhttp://chiselapp.com/andreas_kupries/repositories/Kettle\fR
and follow the instructions given at these sites to create a working
installation. They are not repeated here. If there are problems with
these instructions please file a bug against the Kettle project, and
not \fBCmdr\fR.

.PP































.SS TCLLIB
The framework requires ten packages found in Tcllib.
These are
.IP [1]
\fBdebug\fR
.IP [2]
\fBdebug::caller\fR
................................................................................
See the previous section (\fBTcl\fR) for disclosure and
information on how to get it.
.PP
Assuming that ActiveTcl got installed running the commands
.CS











    teacup install

.CE
will install them for your platform, if you have not done the more
inclusive
.CS


................................................................................
For those wishing to build and install Tcllib on their own, the
relevant sources can be found at \fIhttp://core.tcl.tk/tcllib\fR
together with the necessary instructions on how to build it.
.PP
If there are problems with building, installing, or using
Tcllib and its packages please file a bug against Tcllib, or the
vendor of your distribution, and not \fBcmdr\fR.




















































.SH "BUILD & INSTALLATION"
Cmdr uses the Kettle application and package to handle building
and installation. It is assumed to be installed and working. Please see
section \fBKettle\fR in \fBRequisites\fR for more information.
.PP
Note that all access to Kettle is mediated by the "\fIbuild.tcl\fR"
script, found in the top-level directory of the project.







|
|
>

<
|
|
|
|
|
|
|
>

>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







 







>
>
>
>
>
>
>
>
>
|







 







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

.PP
Do you wish to build Tcl on your own ?
The sources of all versions can be found at
.TP
Tcl
\fIhttp://core.tcl.tk/tcl/\fR
.PP
.SS TCLOO
The framework uses the \fBTclOO\fR package in its implementation.
This package requires Tcl 8.5 or higher.
.PP

In Tcl 8.6 the package is part of the core itself, without
requiring a separate installation.
.PP
For Tcl 8.5 it has to be installed separately.
.PP
Out of the many possibilites for getting TclOO (OS vendor,
os-independent vendor, building from sources) use whatever you are
comfortable with.
.PP
For myself, I am most comfortable with using
\fIActiveState's\fR [http://www.activestate.com]
ActiveTcl distribution and TEApot.
.PP
See the previous section (\fBTcl\fR) for disclosure and
information on how to get it.
.PP
Assuming that ActiveTcl got installed running the command
.CS


    teacup install TclOO

.CE
will install the package for your platform, if you have not done the
more inclusive
.CS


    teacup update

.CE
to get everything and the kitchensink.
.PP
For those wishing to build and install TclOO on their own, the
relevant sources can be found at \fIhttp://core.tcl.tk/tcloo\fR
together with the necessary instructions on how to build it.
.PP
If there are problems with building, installing, or using TclOO
and its packages please file a bug against TclOO, or the vendor of
your distribution, and not \fBcmdr\fR.
.SS TCLLIB
The framework requires ten packages found in Tcllib.
These are
.IP [1]
\fBdebug\fR
.IP [2]
\fBdebug::caller\fR
................................................................................
See the previous section (\fBTcl\fR) for disclosure and
information on how to get it.
.PP
Assuming that ActiveTcl got installed running the commands
.CS


    teacup install debug
    teacup install debug::caller
    teacup install json::write
    teacup install lambda
    teacup install oo::util
    teacup install string::token::shell
    teacup install struct::queue
    teacup install term::ansi::code::ctrl
    teacup install textutil::adjust
    teacup install try

.CE
will install them for your platform, if you have not done the more
inclusive
.CS


................................................................................
For those wishing to build and install Tcllib on their own, the
relevant sources can be found at \fIhttp://core.tcl.tk/tcllib\fR
together with the necessary instructions on how to build it.
.PP
If there are problems with building, installing, or using
Tcllib and its packages please file a bug against Tcllib, or the
vendor of your distribution, and not \fBcmdr\fR.
.SS LINENOISE
The framework uses the \fBlinenoise\fR package in its implementation.
This package requires Tcl 8.5 or higher.
.PP
Out of the many possibilites for getting Linenoise (OS vendor,
os-independent vendor, building from sources) use whatever you are
comfortable with.
.PP
For myself, I am most comfortable with using
\fIActiveState's\fR [http://www.activestate.com]
ActiveTcl distribution and TEApot.
.PP
See the previous section (\fBTcl\fR) for disclosure and
information on how to get it.
.PP
Assuming that ActiveTcl got installed running the command
.CS


    teacup install linenoise

.CE
will install the package for your platform, if you have not done the
more inclusive
.CS


    teacup update

.CE
to get everything and the kitchensink.
.PP
For those wishing to build and install Linenoise on their own,
the relevant sources can be found at
\fIhttp://github.com/andreas-kupries/tcl-linenoise\fR together with
the necessary instructions on how to build it.
.PP
If there are problems with building, installing, or using
linenoise please file a bug against Linenoise, or the vendor
of your distribution, and not \fBcmdr\fR.
.SS KETTLE
This project uses the Kettle application and package as its build system.
.PP
Please go to either the main repository at
\fIhttp://core.tcl.tk/akupries/kettle\fR
or the backup at
\fIhttp://chiselapp.com/andreas_kupries/repositories/Kettle\fR
and follow the instructions given at these sites to create a working
installation. They are not repeated here. If there are problems with
these instructions please file a bug against the Kettle project, and
not \fBCmdr\fR.
.PP
.SH "BUILD & INSTALLATION"
Cmdr uses the Kettle application and package to handle building
and installation. It is assumed to be installed and working. Please see
section \fBKettle\fR in \fBRequisites\fR for more information.
.PP
Note that all access to Kettle is mediated by the "\fIbuild.tcl\fR"
script, found in the top-level directory of the project.

Changes to embedded/www/doc/files/cmdr_howto_installation.html.

<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#section2">Requisites</a>
<ul>
<li class="subsection"><a href="#subsection1">Tcl</a></li>
<li class="subsection"><a href="#subsection2">Kettle</a></li>
<li class="subsection"><a href="#subsection3">Tcllib</a></li>


</ul>
</li>
<li class="section"><a href="#section3">Build &amp; Installation</a></li>
<li class="section"><a href="#section4">Related Documents</a></li>
<li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li>
<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
................................................................................
<p>Do you wish to build Tcl on your own ?
The sources of all versions can be found at</p>
<dl class="definitions">
<dt>Tcl</dt>
<dd><p><a href="http://core.tcl.tk/tcl/">http://core.tcl.tk/tcl/</a></p></dd>
</dl>
</div>
<div id="subsection2" class="subsection"><h3><a name="subsection2">Kettle</a></h3>
<p>This project uses the Kettle application and package as its build system.</p>
<p>Please go to either the main repository at
<a href="http://core.tcl.tk/akupries/kettle">http://core.tcl.tk/akupries/kettle</a>
or the backup at
<a href="http://chiselapp.com/andreas_kupries/repositories/Kettle">http://chiselapp.com/andreas_kupries/repositories/Kettle</a>
and follow the instructions given at these sites to create a working




















installation. They are not repeated here. If there are problems with
these instructions please file a bug against the Kettle project, and
not <b class="package">Cmdr</b>.</p>
</div>
<div id="subsection3" class="subsection"><h3><a name="subsection3">Tcllib</a></h3>
<p>The framework requires ten packages found in Tcllib.
These are</p>
<ol class="enumerated">
<li><p><b class="package">debug</b></p></li>
<li><p><b class="package">debug::caller</b></p></li>
................................................................................
<p>For myself, I am most comfortable with using
<a href="http://www.activestate.com">ActiveState's</a>
ActiveTcl distribution and TEApot.</p>
<p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
information on how to get it.</p>
<p>Assuming that ActiveTcl got installed running the commands</p>
<pre class="example">









    teacup install
</pre>
<p>will install them for your platform, if you have not done the more
inclusive</p>
<pre class="example">
    teacup update
</pre>
<p>to get everything and the kitchensink.</p>
................................................................................
<p>For those wishing to build and install Tcllib on their own, the
relevant sources can be found at <a href="http://core.tcl.tk/tcllib">http://core.tcl.tk/tcllib</a>
together with the necessary instructions on how to build it.</p>
<p>If there are problems with building, installing, or using
Tcllib and its packages please file a bug against Tcllib, or the
vendor of your distribution, and not <b class="package">cmdr</b>.</p>
</div>




























</div>












<div id="section3" class="section"><h2><a name="section3">Build &amp; Installation</a></h2>
<p>Cmdr uses the Kettle application and package to handle building
and installation. It is assumed to be installed and working. Please see
section <span class="sectref"><a href="#subsection2">Kettle</a></span> in <span class="sectref"><a href="#section2">Requisites</a></span> for more information.</p>
<p>Note that all access to Kettle is mediated by the &quot;<b class="file">build.tcl</b>&quot;
script, found in the top-level directory of the project.</p>
<p>For the most basic installation of Cmdr run</p>
<pre class="example">
% /path/to/cmdr/build.tcl install
</pre>
<p>This command uses the <b class="syscmd">kettle</b> application found in the







|

>
>







 







|
|
|
|
|
|
|
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|
|
|







 







>
>
>
>
>
>
>
>
>
|







 







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>

>
>
>
>
>
>
>
>
>
>
>
>



|

<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#section2">Requisites</a>
<ul>
<li class="subsection"><a href="#subsection1">Tcl</a></li>
<li class="subsection"><a href="#subsection2">TclOO</a></li>
<li class="subsection"><a href="#subsection3">Tcllib</a></li>
<li class="subsection"><a href="#subsection4">Linenoise</a></li>
<li class="subsection"><a href="#subsection5">Kettle</a></li>
</ul>
</li>
<li class="section"><a href="#section3">Build &amp; Installation</a></li>
<li class="section"><a href="#section4">Related Documents</a></li>
<li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li>
<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
................................................................................
<p>Do you wish to build Tcl on your own ?
The sources of all versions can be found at</p>
<dl class="definitions">
<dt>Tcl</dt>
<dd><p><a href="http://core.tcl.tk/tcl/">http://core.tcl.tk/tcl/</a></p></dd>
</dl>
</div>
<div id="subsection2" class="subsection"><h3><a name="subsection2">TclOO</a></h3>
<p>The framework uses the <b class="package">TclOO</b> package in its implementation.
This package requires Tcl 8.5 or higher.</p>
<p>In Tcl 8.6 the package is part of the core itself, without
requiring a separate installation.</p>
<p>For Tcl 8.5 it has to be installed separately.</p>
<p>Out of the many possibilites for getting TclOO (OS vendor,
os-independent vendor, building from sources) use whatever you are
comfortable with.</p>
<p>For myself, I am most comfortable with using
<a href="http://www.activestate.com">ActiveState's</a>
ActiveTcl distribution and TEApot.</p>
<p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
information on how to get it.</p>
<p>Assuming that ActiveTcl got installed running the command</p>
<pre class="example">
    teacup install TclOO
</pre>
<p>will install the package for your platform, if you have not done the
more inclusive</p>
<pre class="example">
    teacup update
</pre>
<p>to get everything and the kitchensink.</p>
<p>For those wishing to build and install TclOO on their own, the
relevant sources can be found at <a href="http://core.tcl.tk/tcloo">http://core.tcl.tk/tcloo</a>
together with the necessary instructions on how to build it.</p>
<p>If there are problems with building, installing, or using TclOO
and its packages please file a bug against TclOO, or the vendor of
your distribution, and not <b class="package">cmdr</b>.</p>
</div>
<div id="subsection3" class="subsection"><h3><a name="subsection3">Tcllib</a></h3>
<p>The framework requires ten packages found in Tcllib.
These are</p>
<ol class="enumerated">
<li><p><b class="package">debug</b></p></li>
<li><p><b class="package">debug::caller</b></p></li>
................................................................................
<p>For myself, I am most comfortable with using
<a href="http://www.activestate.com">ActiveState's</a>
ActiveTcl distribution and TEApot.</p>
<p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
information on how to get it.</p>
<p>Assuming that ActiveTcl got installed running the commands</p>
<pre class="example">
    teacup install debug
    teacup install debug::caller
    teacup install json::write
    teacup install lambda
    teacup install oo::util
    teacup install string::token::shell
    teacup install struct::queue
    teacup install term::ansi::code::ctrl
    teacup install textutil::adjust
    teacup install try
</pre>
<p>will install them for your platform, if you have not done the more
inclusive</p>
<pre class="example">
    teacup update
</pre>
<p>to get everything and the kitchensink.</p>
................................................................................
<p>For those wishing to build and install Tcllib on their own, the
relevant sources can be found at <a href="http://core.tcl.tk/tcllib">http://core.tcl.tk/tcllib</a>
together with the necessary instructions on how to build it.</p>
<p>If there are problems with building, installing, or using
Tcllib and its packages please file a bug against Tcllib, or the
vendor of your distribution, and not <b class="package">cmdr</b>.</p>
</div>
<div id="subsection4" class="subsection"><h3><a name="subsection4">Linenoise</a></h3>
<p>The framework uses the <b class="package">linenoise</b> package in its implementation.
This package requires Tcl 8.5 or higher.</p>
<p>Out of the many possibilites for getting Linenoise (OS vendor,
os-independent vendor, building from sources) use whatever you are
comfortable with.</p>
<p>For myself, I am most comfortable with using
<a href="http://www.activestate.com">ActiveState's</a>
ActiveTcl distribution and TEApot.</p>
<p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
information on how to get it.</p>
<p>Assuming that ActiveTcl got installed running the command</p>
<pre class="example">
    teacup install linenoise
</pre>
<p>will install the package for your platform, if you have not done the
more inclusive</p>
<pre class="example">
    teacup update
</pre>
<p>to get everything and the kitchensink.</p>
<p>For those wishing to build and install Linenoise on their own,
the relevant sources can be found at
<a href="http://github.com/andreas-kupries/tcl-linenoise">http://github.com/andreas-kupries/tcl-linenoise</a> together with
the necessary instructions on how to build it.</p>
<p>If there are problems with building, installing, or using
linenoise please file a bug against Linenoise, or the vendor
of your distribution, and not <b class="package">cmdr</b>.</p>
</div>
<div id="subsection5" class="subsection"><h3><a name="subsection5">Kettle</a></h3>
<p>This project uses the Kettle application and package as its build system.</p>
<p>Please go to either the main repository at
<a href="http://core.tcl.tk/akupries/kettle">http://core.tcl.tk/akupries/kettle</a>
or the backup at
<a href="http://chiselapp.com/andreas_kupries/repositories/Kettle">http://chiselapp.com/andreas_kupries/repositories/Kettle</a>
and follow the instructions given at these sites to create a working
installation. They are not repeated here. If there are problems with
these instructions please file a bug against the Kettle project, and
not <b class="package">Cmdr</b>.</p>
</div>
</div>
<div id="section3" class="section"><h2><a name="section3">Build &amp; Installation</a></h2>
<p>Cmdr uses the Kettle application and package to handle building
and installation. It is assumed to be installed and working. Please see
section <span class="sectref"><a href="#subsection5">Kettle</a></span> in <span class="sectref"><a href="#section2">Requisites</a></span> for more information.</p>
<p>Note that all access to Kettle is mediated by the &quot;<b class="file">build.tcl</b>&quot;
script, found in the top-level directory of the project.</p>
<p>For the most basic installation of Cmdr run</p>
<pre class="example">
% /path/to/cmdr/build.tcl install
</pre>
<p>This command uses the <b class="syscmd">kettle</b> application found in the