cmdr
Check-in [4bacb86a2f]
Not logged in
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.

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 Side-by-Side Diffs Ignore Whitespace Patch

Changes to doc/parts/requirements.inc.

     1      1   [comment {--- Project requirements --}]
     2      2   [include rq_tcl85.inc]
     3         -[include rq_kettle.inc]
            3  +[include rq_tcloo.inc]
     4      4   [include rq_tcllib.inc]
     5         -[comment {-- [include rq_tcloo.inc] --}]
     6         -[comment {-- [include rq_linenoise.inc] --}]
            5  +[include rq_linenoise.inc]
     7      6   [comment {-- [include rq_linenoiseutils.inc] --}]
            7  +[include rq_kettle.inc]

Added doc/parts/rq_linenoise.inc.

            1  +
            2  +[subsection Linenoise]
            3  +
            4  +The framework uses the [package linenoise] package in its implementation.
            5  +This package requires Tcl 8.5 or higher.
            6  +
            7  +[para] Out of the many possibilites for getting Linenoise (OS vendor,
            8  +os-independent vendor, building from sources) use whatever you are
            9  +comfortable with.
           10  +
           11  +[para] For myself, I am most comfortable with using
           12  +[uri http://www.activestate.com ActiveState's]
           13  +ActiveTcl distribution and TEApot.
           14  +
           15  +[para] See the previous section ([sectref Tcl]) for disclosure and
           16  +information on how to get it.
           17  +
           18  +[para] Assuming that ActiveTcl got installed running the command
           19  +
           20  +[example {
           21  +    teacup install linenoise
           22  +}]
           23  +
           24  +will install the package for your platform, if you have not done the
           25  +more inclusive
           26  +
           27  +[example {
           28  +    teacup update
           29  +}]
           30  +
           31  +to get everything and the kitchensink.
           32  +
           33  +[para] For those wishing to build and install Linenoise on their own,
           34  +the relevant sources can be found at
           35  +[uri http://github.com/andreas-kupries/tcl-linenoise] together with
           36  +the necessary instructions on how to build it.
           37  +
           38  +[para] If there are problems with building, installing, or using
           39  +linenoise please file a bug against Linenoise, or the vendor
           40  +of your distribution, and not [package [vset PROJECT]].

Changes to doc/parts/rq_tcllib.inc.

    27     27   
    28     28   [para] See the previous section ([sectref Tcl]) for disclosure and
    29     29   information on how to get it.
    30     30   
    31     31   [para] Assuming that ActiveTcl got installed running the commands
    32     32   
    33     33   [example {
    34         -    teacup install
           34  +    teacup install debug
           35  +    teacup install debug::caller
           36  +    teacup install json::write
           37  +    teacup install lambda
           38  +    teacup install oo::util
           39  +    teacup install string::token::shell
           40  +    teacup install struct::queue
           41  +    teacup install term::ansi::code::ctrl
           42  +    teacup install textutil::adjust
           43  +    teacup install try
    35     44   }]
    36     45   
    37     46   will install them for your platform, if you have not done the more
    38     47   inclusive
    39     48   
    40     49   [example {
    41     50       teacup update

Added doc/parts/rq_tcloo.inc.

            1  +
            2  +[subsection TclOO]
            3  +
            4  +The framework uses the [package TclOO] package in its implementation.
            5  +This package requires Tcl 8.5 or higher.
            6  +
            7  +[para] In Tcl 8.6 the package is part of the core itself, without
            8  +requiring a separate installation.
            9  +
           10  +[para] For Tcl 8.5 it has to be installed separately.
           11  +
           12  +[para] Out of the many possibilites for getting TclOO (OS vendor,
           13  +os-independent vendor, building from sources) use whatever you are
           14  +comfortable with.
           15  +
           16  +[para] For myself, I am most comfortable with using
           17  +[uri http://www.activestate.com ActiveState's]
           18  +ActiveTcl distribution and TEApot.
           19  +
           20  +[para] See the previous section ([sectref Tcl]) for disclosure and
           21  +information on how to get it.
           22  +
           23  +[para] Assuming that ActiveTcl got installed running the command
           24  +
           25  +[example {
           26  +    teacup install TclOO
           27  +}]
           28  +
           29  +will install the package for your platform, if you have not done the
           30  +more inclusive
           31  +
           32  +[example {
           33  +    teacup update
           34  +}]
           35  +
           36  +to get everything and the kitchensink.
           37  +
           38  +[para] For those wishing to build and install TclOO on their own, the
           39  +relevant sources can be found at [uri http://core.tcl.tk/tcloo]
           40  +together with the necessary instructions on how to build it.
           41  +
           42  +[para] If there are problems with building, installing, or using TclOO
           43  +and its packages please file a bug against TclOO, or the vendor of
           44  +your distribution, and not [package [vset PROJECT]].

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

   288    288   .PP
   289    289   Do you wish to build Tcl on your own ?
   290    290   The sources of all versions can be found at
   291    291   .TP
   292    292   Tcl
   293    293   \fIhttp://core.tcl.tk/tcl/\fR
   294    294   .PP
   295         -.SS KETTLE
   296         -This project uses the Kettle application and package as its build system.
   297         -.PP
   298         -Please go to either the main repository at
   299         -\fIhttp://core.tcl.tk/akupries/kettle\fR
   300         -or the backup at
   301         -\fIhttp://chiselapp.com/andreas_kupries/repositories/Kettle\fR
   302         -and follow the instructions given at these sites to create a working
   303         -installation. They are not repeated here. If there are problems with
   304         -these instructions please file a bug against the Kettle project, and
   305         -not \fBCmdr\fR.
   306         -.PP
          295  +.SS TCLOO
          296  +The framework uses the \fBTclOO\fR package in its implementation.
          297  +This package requires Tcl 8.5 or higher.
          298  +.PP
          299  +In Tcl 8.6 the package is part of the core itself, without
          300  +requiring a separate installation.
          301  +.PP
          302  +For Tcl 8.5 it has to be installed separately.
          303  +.PP
          304  +Out of the many possibilites for getting TclOO (OS vendor,
          305  +os-independent vendor, building from sources) use whatever you are
          306  +comfortable with.
          307  +.PP
          308  +For myself, I am most comfortable with using
          309  +\fIActiveState's\fR [http://www.activestate.com]
          310  +ActiveTcl distribution and TEApot.
          311  +.PP
          312  +See the previous section (\fBTcl\fR) for disclosure and
          313  +information on how to get it.
          314  +.PP
          315  +Assuming that ActiveTcl got installed running the command
          316  +.CS
          317  +
          318  +
          319  +    teacup install TclOO
          320  +
          321  +.CE
          322  +will install the package for your platform, if you have not done the
          323  +more inclusive
          324  +.CS
          325  +
          326  +
          327  +    teacup update
          328  +
          329  +.CE
          330  +to get everything and the kitchensink.
          331  +.PP
          332  +For those wishing to build and install TclOO on their own, the
          333  +relevant sources can be found at \fIhttp://core.tcl.tk/tcloo\fR
          334  +together with the necessary instructions on how to build it.
          335  +.PP
          336  +If there are problems with building, installing, or using TclOO
          337  +and its packages please file a bug against TclOO, or the vendor of
          338  +your distribution, and not \fBcmdr\fR.
   307    339   .SS TCLLIB
   308    340   The framework requires ten packages found in Tcllib.
   309    341   These are
   310    342   .IP [1]
   311    343   \fBdebug\fR
   312    344   .IP [2]
   313    345   \fBdebug::caller\fR
................................................................................
   340    372   See the previous section (\fBTcl\fR) for disclosure and
   341    373   information on how to get it.
   342    374   .PP
   343    375   Assuming that ActiveTcl got installed running the commands
   344    376   .CS
   345    377   
   346    378   
   347         -    teacup install
          379  +    teacup install debug
          380  +    teacup install debug::caller
          381  +    teacup install json::write
          382  +    teacup install lambda
          383  +    teacup install oo::util
          384  +    teacup install string::token::shell
          385  +    teacup install struct::queue
          386  +    teacup install term::ansi::code::ctrl
          387  +    teacup install textutil::adjust
          388  +    teacup install try
   348    389   
   349    390   .CE
   350    391   will install them for your platform, if you have not done the more
   351    392   inclusive
   352    393   .CS
   353    394   
   354    395   
................................................................................
   360    401   For those wishing to build and install Tcllib on their own, the
   361    402   relevant sources can be found at \fIhttp://core.tcl.tk/tcllib\fR
   362    403   together with the necessary instructions on how to build it.
   363    404   .PP
   364    405   If there are problems with building, installing, or using
   365    406   Tcllib and its packages please file a bug against Tcllib, or the
   366    407   vendor of your distribution, and not \fBcmdr\fR.
          408  +.SS LINENOISE
          409  +The framework uses the \fBlinenoise\fR package in its implementation.
          410  +This package requires Tcl 8.5 or higher.
          411  +.PP
          412  +Out of the many possibilites for getting Linenoise (OS vendor,
          413  +os-independent vendor, building from sources) use whatever you are
          414  +comfortable with.
          415  +.PP
          416  +For myself, I am most comfortable with using
          417  +\fIActiveState's\fR [http://www.activestate.com]
          418  +ActiveTcl distribution and TEApot.
          419  +.PP
          420  +See the previous section (\fBTcl\fR) for disclosure and
          421  +information on how to get it.
          422  +.PP
          423  +Assuming that ActiveTcl got installed running the command
          424  +.CS
          425  +
          426  +
          427  +    teacup install linenoise
          428  +
          429  +.CE
          430  +will install the package for your platform, if you have not done the
          431  +more inclusive
          432  +.CS
          433  +
          434  +
          435  +    teacup update
          436  +
          437  +.CE
          438  +to get everything and the kitchensink.
          439  +.PP
          440  +For those wishing to build and install Linenoise on their own,
          441  +the relevant sources can be found at
          442  +\fIhttp://github.com/andreas-kupries/tcl-linenoise\fR together with
          443  +the necessary instructions on how to build it.
          444  +.PP
          445  +If there are problems with building, installing, or using
          446  +linenoise please file a bug against Linenoise, or the vendor
          447  +of your distribution, and not \fBcmdr\fR.
          448  +.SS KETTLE
          449  +This project uses the Kettle application and package as its build system.
          450  +.PP
          451  +Please go to either the main repository at
          452  +\fIhttp://core.tcl.tk/akupries/kettle\fR
          453  +or the backup at
          454  +\fIhttp://chiselapp.com/andreas_kupries/repositories/Kettle\fR
          455  +and follow the instructions given at these sites to create a working
          456  +installation. They are not repeated here. If there are problems with
          457  +these instructions please file a bug against the Kettle project, and
          458  +not \fBCmdr\fR.
          459  +.PP
   367    460   .SH "BUILD & INSTALLATION"
   368    461   Cmdr uses the Kettle application and package to handle building
   369    462   and installation. It is assumed to be installed and working. Please see
   370    463   section \fBKettle\fR in \fBRequisites\fR for more information.
   371    464   .PP
   372    465   Note that all access to Kettle is mediated by the "\fIbuild.tcl\fR"
   373    466   script, found in the top-level directory of the project.

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

   112    112   <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
   113    113   <ul class="toc">
   114    114   <li class="section"><a href="#toc">Table Of Contents</a></li>
   115    115   <li class="section"><a href="#section1">Description</a></li>
   116    116   <li class="section"><a href="#section2">Requisites</a>
   117    117   <ul>
   118    118   <li class="subsection"><a href="#subsection1">Tcl</a></li>
   119         -<li class="subsection"><a href="#subsection2">Kettle</a></li>
          119  +<li class="subsection"><a href="#subsection2">TclOO</a></li>
   120    120   <li class="subsection"><a href="#subsection3">Tcllib</a></li>
          121  +<li class="subsection"><a href="#subsection4">Linenoise</a></li>
          122  +<li class="subsection"><a href="#subsection5">Kettle</a></li>
   121    123   </ul>
   122    124   </li>
   123    125   <li class="section"><a href="#section3">Build &amp; Installation</a></li>
   124    126   <li class="section"><a href="#section4">Related Documents</a></li>
   125    127   <li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li>
   126    128   <li class="section"><a href="#keywords">Keywords</a></li>
   127    129   <li class="section"><a href="#copyright">Copyright</a></li>
................................................................................
   160    162   <p>Do you wish to build Tcl on your own ?
   161    163   The sources of all versions can be found at</p>
   162    164   <dl class="definitions">
   163    165   <dt>Tcl</dt>
   164    166   <dd><p><a href="http://core.tcl.tk/tcl/">http://core.tcl.tk/tcl/</a></p></dd>
   165    167   </dl>
   166    168   </div>
   167         -<div id="subsection2" class="subsection"><h3><a name="subsection2">Kettle</a></h3>
   168         -<p>This project uses the Kettle application and package as its build system.</p>
   169         -<p>Please go to either the main repository at
   170         -<a href="http://core.tcl.tk/akupries/kettle">http://core.tcl.tk/akupries/kettle</a>
   171         -or the backup at
   172         -<a href="http://chiselapp.com/andreas_kupries/repositories/Kettle">http://chiselapp.com/andreas_kupries/repositories/Kettle</a>
   173         -and follow the instructions given at these sites to create a working
   174         -installation. They are not repeated here. If there are problems with
   175         -these instructions please file a bug against the Kettle project, and
   176         -not <b class="package">Cmdr</b>.</p>
          169  +<div id="subsection2" class="subsection"><h3><a name="subsection2">TclOO</a></h3>
          170  +<p>The framework uses the <b class="package">TclOO</b> package in its implementation.
          171  +This package requires Tcl 8.5 or higher.</p>
          172  +<p>In Tcl 8.6 the package is part of the core itself, without
          173  +requiring a separate installation.</p>
          174  +<p>For Tcl 8.5 it has to be installed separately.</p>
          175  +<p>Out of the many possibilites for getting TclOO (OS vendor,
          176  +os-independent vendor, building from sources) use whatever you are
          177  +comfortable with.</p>
          178  +<p>For myself, I am most comfortable with using
          179  +<a href="http://www.activestate.com">ActiveState's</a>
          180  +ActiveTcl distribution and TEApot.</p>
          181  +<p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
          182  +information on how to get it.</p>
          183  +<p>Assuming that ActiveTcl got installed running the command</p>
          184  +<pre class="example">
          185  +    teacup install TclOO
          186  +</pre>
          187  +<p>will install the package for your platform, if you have not done the
          188  +more inclusive</p>
          189  +<pre class="example">
          190  +    teacup update
          191  +</pre>
          192  +<p>to get everything and the kitchensink.</p>
          193  +<p>For those wishing to build and install TclOO on their own, the
          194  +relevant sources can be found at <a href="http://core.tcl.tk/tcloo">http://core.tcl.tk/tcloo</a>
          195  +together with the necessary instructions on how to build it.</p>
          196  +<p>If there are problems with building, installing, or using TclOO
          197  +and its packages please file a bug against TclOO, or the vendor of
          198  +your distribution, and not <b class="package">cmdr</b>.</p>
   177    199   </div>
   178    200   <div id="subsection3" class="subsection"><h3><a name="subsection3">Tcllib</a></h3>
   179    201   <p>The framework requires ten packages found in Tcllib.
   180    202   These are</p>
   181    203   <ol class="enumerated">
   182    204   <li><p><b class="package">debug</b></p></li>
   183    205   <li><p><b class="package">debug::caller</b></p></li>
................................................................................
   196    218   <p>For myself, I am most comfortable with using
   197    219   <a href="http://www.activestate.com">ActiveState's</a>
   198    220   ActiveTcl distribution and TEApot.</p>
   199    221   <p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
   200    222   information on how to get it.</p>
   201    223   <p>Assuming that ActiveTcl got installed running the commands</p>
   202    224   <pre class="example">
   203         -    teacup install
          225  +    teacup install debug
          226  +    teacup install debug::caller
          227  +    teacup install json::write
          228  +    teacup install lambda
          229  +    teacup install oo::util
          230  +    teacup install string::token::shell
          231  +    teacup install struct::queue
          232  +    teacup install term::ansi::code::ctrl
          233  +    teacup install textutil::adjust
          234  +    teacup install try
   204    235   </pre>
   205    236   <p>will install them for your platform, if you have not done the more
   206    237   inclusive</p>
   207    238   <pre class="example">
   208    239       teacup update
   209    240   </pre>
   210    241   <p>to get everything and the kitchensink.</p>
................................................................................
   211    242   <p>For those wishing to build and install Tcllib on their own, the
   212    243   relevant sources can be found at <a href="http://core.tcl.tk/tcllib">http://core.tcl.tk/tcllib</a>
   213    244   together with the necessary instructions on how to build it.</p>
   214    245   <p>If there are problems with building, installing, or using
   215    246   Tcllib and its packages please file a bug against Tcllib, or the
   216    247   vendor of your distribution, and not <b class="package">cmdr</b>.</p>
   217    248   </div>
          249  +<div id="subsection4" class="subsection"><h3><a name="subsection4">Linenoise</a></h3>
          250  +<p>The framework uses the <b class="package">linenoise</b> package in its implementation.
          251  +This package requires Tcl 8.5 or higher.</p>
          252  +<p>Out of the many possibilites for getting Linenoise (OS vendor,
          253  +os-independent vendor, building from sources) use whatever you are
          254  +comfortable with.</p>
          255  +<p>For myself, I am most comfortable with using
          256  +<a href="http://www.activestate.com">ActiveState's</a>
          257  +ActiveTcl distribution and TEApot.</p>
          258  +<p>See the previous section (<span class="sectref"><a href="#subsection1">Tcl</a></span>) for disclosure and
          259  +information on how to get it.</p>
          260  +<p>Assuming that ActiveTcl got installed running the command</p>
          261  +<pre class="example">
          262  +    teacup install linenoise
          263  +</pre>
          264  +<p>will install the package for your platform, if you have not done the
          265  +more inclusive</p>
          266  +<pre class="example">
          267  +    teacup update
          268  +</pre>
          269  +<p>to get everything and the kitchensink.</p>
          270  +<p>For those wishing to build and install Linenoise on their own,
          271  +the relevant sources can be found at
          272  +<a href="http://github.com/andreas-kupries/tcl-linenoise">http://github.com/andreas-kupries/tcl-linenoise</a> together with
          273  +the necessary instructions on how to build it.</p>
          274  +<p>If there are problems with building, installing, or using
          275  +linenoise please file a bug against Linenoise, or the vendor
          276  +of your distribution, and not <b class="package">cmdr</b>.</p>
          277  +</div>
          278  +<div id="subsection5" class="subsection"><h3><a name="subsection5">Kettle</a></h3>
          279  +<p>This project uses the Kettle application and package as its build system.</p>
          280  +<p>Please go to either the main repository at
          281  +<a href="http://core.tcl.tk/akupries/kettle">http://core.tcl.tk/akupries/kettle</a>
          282  +or the backup at
          283  +<a href="http://chiselapp.com/andreas_kupries/repositories/Kettle">http://chiselapp.com/andreas_kupries/repositories/Kettle</a>
          284  +and follow the instructions given at these sites to create a working
          285  +installation. They are not repeated here. If there are problems with
          286  +these instructions please file a bug against the Kettle project, and
          287  +not <b class="package">Cmdr</b>.</p>
          288  +</div>
   218    289   </div>
   219    290   <div id="section3" class="section"><h2><a name="section3">Build &amp; Installation</a></h2>
   220    291   <p>Cmdr uses the Kettle application and package to handle building
   221    292   and installation. It is assumed to be installed and working. Please see
   222         -section <span class="sectref"><a href="#subsection2">Kettle</a></span> in <span class="sectref"><a href="#section2">Requisites</a></span> for more information.</p>
          293  +section <span class="sectref"><a href="#subsection5">Kettle</a></span> in <span class="sectref"><a href="#section2">Requisites</a></span> for more information.</p>
   223    294   <p>Note that all access to Kettle is mediated by the &quot;<b class="file">build.tcl</b>&quot;
   224    295   script, found in the top-level directory of the project.</p>
   225    296   <p>For the most basic installation of Cmdr run</p>
   226    297   <pre class="example">
   227    298   % /path/to/cmdr/build.tcl install
   228    299   </pre>
   229    300   <p>This command uses the <b class="syscmd">kettle</b> application found in the