Index: doc/parts/requirements.inc ================================================================== --- doc/parts/requirements.inc +++ doc/parts/requirements.inc @@ -1,7 +1,7 @@ [comment {--- Project requirements --}] [include rq_tcl85.inc] -[include rq_kettle.inc] +[include rq_tcloo.inc] [include rq_tcllib.inc] -[comment {-- [include rq_tcloo.inc] --}] -[comment {-- [include rq_linenoise.inc] --}] +[include rq_linenoise.inc] [comment {-- [include rq_linenoiseutils.inc] --}] +[include rq_kettle.inc] ADDED doc/parts/rq_linenoise.inc Index: doc/parts/rq_linenoise.inc ================================================================== --- /dev/null +++ doc/parts/rq_linenoise.inc @@ -0,0 +1,40 @@ + +[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]]. Index: doc/parts/rq_tcllib.inc ================================================================== --- doc/parts/rq_tcllib.inc +++ doc/parts/rq_tcllib.inc @@ -29,11 +29,20 @@ information on how to get it. [para] Assuming that ActiveTcl got installed running the commands [example { - teacup install + 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 ADDED doc/parts/rq_tcloo.inc Index: doc/parts/rq_tcloo.inc ================================================================== --- /dev/null +++ doc/parts/rq_tcloo.inc @@ -0,0 +1,44 @@ + +[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]]. Index: embedded/man/files/cmdr_howto_installation.n ================================================================== --- embedded/man/files/cmdr_howto_installation.n +++ embedded/man/files/cmdr_howto_installation.n @@ -290,22 +290,54 @@ 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 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 @@ -342,11 +374,20 @@ .PP Assuming that ActiveTcl got installed running the commands .CS - teacup install + 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 @@ -362,10 +403,62 @@ 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 Index: embedded/www/doc/files/cmdr_howto_installation.html ================================================================== --- embedded/www/doc/files/cmdr_howto_installation.html +++ embedded/www/doc/files/cmdr_howto_installation.html @@ -114,12 +114,14 @@
  • Table Of Contents
  • Description
  • Requisites
  • Build & Installation
  • Related Documents
  • Bugs, Ideas, Feedback
  • @@ -162,20 +164,40 @@
    Tcl

    http://core.tcl.tk/tcl/

    -

    Kettle

    -

    This project uses the Kettle application and package as its build system.

    -

    Please go to either the main repository at -http://core.tcl.tk/akupries/kettle -or the backup at -http://chiselapp.com/andreas_kupries/repositories/Kettle -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 Cmdr.

    +

    TclOO

    +

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

    +

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

    +

    For Tcl 8.5 it has to be installed separately.

    +

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

    +

    For myself, I am most comfortable with using +ActiveState's +ActiveTcl distribution and TEApot.

    +

    See the previous section (Tcl) for disclosure and +information on how to get it.

    +

    Assuming that ActiveTcl got installed running the command

    +
    +    teacup install TclOO
    +
    +

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

    +
    +    teacup update
    +
    +

    to get everything and the kitchensink.

    +

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

    +

    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 cmdr.

    Tcllib

    The framework requires ten packages found in Tcllib. These are

      @@ -198,11 +220,20 @@ ActiveTcl distribution and TEApot.

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

      Assuming that ActiveTcl got installed running the commands

      -    teacup install
      +    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

           teacup update
      @@ -213,15 +244,55 @@
       together with the necessary instructions on how to build it.

      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 cmdr.

    +

    Linenoise

    +

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

    +

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

    +

    For myself, I am most comfortable with using +ActiveState's +ActiveTcl distribution and TEApot.

    +

    See the previous section (Tcl) for disclosure and +information on how to get it.

    +

    Assuming that ActiveTcl got installed running the command

    +
    +    teacup install linenoise
    +
    +

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

    +
    +    teacup update
    +
    +

    to get everything and the kitchensink.

    +

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

    +

    If there are problems with building, installing, or using +linenoise please file a bug against Linenoise, or the vendor +of your distribution, and not cmdr.

    +
    +

    Kettle

    +

    This project uses the Kettle application and package as its build system.

    +

    Please go to either the main repository at +http://core.tcl.tk/akupries/kettle +or the backup at +http://chiselapp.com/andreas_kupries/repositories/Kettle +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 Cmdr.

    +

    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 Kettle in Requisites for more information.

    +section Kettle in Requisites for more information.

    Note that all access to Kettle is mediated by the "build.tcl" script, found in the top-level directory of the project.

    For the most basic installation of Cmdr run

     % /path/to/cmdr/build.tcl install