From: Jeff Hobbs Date: Thu, 21 Jun 2007 23:07:16 +0000 (+0000) Subject: * docs/tkcon.1.man, docs/tkcon.n.man, docs/tkconrc.5.man (new): X-Git-Tag: tkcon-2-5~8 X-Git-Url: http://privyetmir.co.uk/gitweb.cgi?a=commitdiff_plain;h=ecd6aa017ae3551434c1b7e9b9b881a80a2d26a3;p=tkcon * docs/tkcon.1.man, docs/tkcon.n.man, docs/tkconrc.5.man (new): * docs/dump.n.man, docs/observe.n.man, docs/idebug.n.man (new): * index.html, docs/demopic.gif (removed), docs/demopic.png (new): * docs/plugin.html, docs/start.html, docs/tkcon.html: Updated docs and added doctools equivalents courtesy Sergei Golovan * docs/style.css: updated stylesheet --- diff --git a/ChangeLog b/ChangeLog index e1767ca..5a9340b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2007-06-21 Jeff Hobbs + + * docs/tkcon.1.man, docs/tkcon.n.man, docs/tkconrc.5.man (new): + * docs/dump.n.man, docs/observe.n.man, docs/idebug.n.man (new): + * index.html, docs/demopic.gif (removed), docs/demopic.png (new): + * docs/plugin.html, docs/start.html, docs/tkcon.html: + Updated docs and added doctools equivalents courtesy Sergei Golovan + * docs/style.css: updated stylesheet + 2007-04-04 Jeff Hobbs *** BUMPED TO VERSION 2.5 *** diff --git a/docs/demopic.gif b/docs/demopic.gif deleted file mode 100755 index 83a9e3a..0000000 Binary files a/docs/demopic.gif and /dev/null differ diff --git a/docs/demopic.png b/docs/demopic.png new file mode 100644 index 0000000..799c09c Binary files /dev/null and b/docs/demopic.png differ diff --git a/docs/dump.n.man b/docs/dump.n.man new file mode 100644 index 0000000..de2839f --- /dev/null +++ b/docs/dump.n.man @@ -0,0 +1,60 @@ +[comment {-*- tcl -*- dump manpage}] +[manpage_begin dump n 2.5] +[copyright {Jeffrey Hobbs }] +[moddesc {TkCon}] +[titledesc {Dump information about Tcl interpreter in TkCon}] + +[description] +[para] +The dump command provides a way for the user to spit out state +information about the interpreter in a Tcl readable +(and human readable) form. +It takes the general form: + +[list_begin definitions] + +[call [cmd dump] [arg method]\ + [opt [arg -nocomplain]]\ + [opt [arg "-filter pattern"]]\ + [opt [cmd --]]\ + [arg pattern]\ + [opt [arg "pattern ..."]]] + +[list_end] + +[para] +The patterns represent glob-style patterns (as in [cmd string] [arg {match pattern $str}]). +[arg -nocomplain] will prevent dump from throwing an error if no items +matched the pattern. +[arg -filter] is interpreted as appropriate for the method. +The various methods are: + +[list_begin definitions] + +[lst_item "[cmd dump] [arg command] [arg args]"] +Outputs one or more commands. + +[lst_item "[cmd dump] [arg procedure] [arg args]"] +Outputs one or more procs in sourceable form. + +[lst_item "[cmd dump] [arg variable] [arg args]"] +Outputs the values of variables in sourceable form. +Recognizes nested arrays. +The -filter pattern is used as to filter array element +names and is interepreted as a glob pattern (defaults to {*}). +It is passed down for nested arrays. + +[lst_item "[cmd dump] [arg widget] [arg args]"] +Outputs one or more widgets by giving their configuration options. +The -filter pattern is used as to filter the config options and +is interpreted as a case insensitive regexp pattern (defaults to {.*}). + +[list_end] + +[see_also [cmd tkcon](1)] +[see_also [cmd tkconrc](5) [cmd tkcon](n) [cmd idebug](n)] +[see_also [cmd observe](n)] +[keywords Tk console dump] + +[manpage_end] + diff --git a/docs/idebug.n.man b/docs/idebug.n.man new file mode 100644 index 0000000..1547081 --- /dev/null +++ b/docs/idebug.n.man @@ -0,0 +1,83 @@ +[comment {-*- tcl -*- idebug manpage}] +[manpage_begin idebug n 2.5] +[copyright {Jeffrey Hobbs }] +[moddesc {TkCon}] +[titledesc {Interactive debugging environment in TkCon}] + +[description] +[para] +The idebug command provides an interactive debugging +environment for procedures via TkCon. +You can place idebug break commands into your procedure +to create breakpoints. +It will pop up the TkCon console and put you into a +"debugging" mode. +The [arg body], [arg show] & [arg trace] methods are +intended for internal use only. + +This procedure works for minimal debugging sessions. +Comments are encouraged. + +[list_begin definitions] + +[call [cmd idebug] [arg body] [opt [arg level]]] +Prints out the body of the command (if it is a procedure) +at the specified level. +level defaults to the current level. + +[call [cmd idebug] [arg break] [opt [arg id]]] +Creates a breakpoint within a procedure. +This will only trigger if idebug is on and the [arg id] matches the pattern. +If so, TkCon will pop to the front with the prompt changed +to an idebug prompt. +You are given the basic ability to observe the call stack +an query/set variables or execute Tcl commands at any level. +A separate history is maintained in debugging mode. +To see the special commands available at the debug prompt, +type ? and hit return. + +[call [cmd idebug] \{[arg "[arg echo] [opt [arg id]]"]\} [opt [arg args]]] +Behaves just like [cmd echo], but only triggers when idebug is on. +You can specify an optional [arg id] to further restrict triggering. +If no id is specified, it defaults to the name of the command +in which the call was made. + +[call [cmd idebug] [arg id] [opt [arg id]]] +Query or set the idebug id. +This id is used by other idebug methods to determine if +they should trigger or not. +The idebug id can be a glob pattern and defaults to *. + +[call [cmd idebug] [arg off]] +Turns idebug off. + +[call [cmd idebug] [arg on] [opt [arg id]]] +Turns idebug on. +If [arg id] is specified, it sets the id to it. + +[call [cmd idebug] \{[arg "[arg puts] [opt [arg id]]"]\} [arg args]] +Behaves just like [cmd puts], but only triggers when idebug is on. +You can specify an optional [arg id] to further restrict triggering. +If no id is specified, it defaults to the name of the +command in which the call was made. + +[call [cmd idebug] [arg show] [arg type] [opt [arg level]] [opt [arg VERBOSE]]] +type must be one of vars, locals or globals. +This method will output the variables/locals/globals present +in a particular level. +If [arg VERBOSE] is added, then it actually [cmd dump]s out the values as well. +level defaults to the level in which this method was called. + +[call [cmd idebug] [arg trace] [opt [arg level]]] +Prints out the stack trace from the specified level up to the top level. +level defaults to the current level. + +[list_end] + +[see_also [cmd tkcon](1)] +[see_also [cmd tkconrc](5) [cmd tkcon](n) [cmd dump](n)] +[see_also [cmd observe](n)] +[keywords Tk console debug] + +[manpage_end] + diff --git a/docs/observe.n.man b/docs/observe.n.man new file mode 100644 index 0000000..d9630ba --- /dev/null +++ b/docs/observe.n.man @@ -0,0 +1,55 @@ +[comment {-*- tcl -*- observe manpage}] +[manpage_begin observe n 2.5] +[copyright {Jeffrey Hobbs }] +[moddesc {TkCon}] +[titledesc {Runtime debugging output in TkCon}] + +[description] +[para] +This command provides runtime debugging output for variables +and commands without the need to edit your code. +For variables, the underlying mechanism uses [cmd trace] and [cmd dump] var. +For commands, it renames the observed procedure and uses a +special wrapper procedure. +WARNING: using this procedure after checkpointing state will +result in major problems if you clean state because the +renamed (true) commands will be lost. + +[para] +This procedure is experimental. +Comments are encouraged. + +[list_begin definitions] + +[call [cmd observe] [arg command] [arg cmdname] [opt [arg maxlevel]]] +This will create a wrapper command which prints out (using [cmd dump]) +the call stack to the console. +maxlevel represents the maximum number of levels of the call +stack which will be printed (defaults to 4). + +[call [cmd observe] [arg cdelete] [arg cmdname]] +Removes the wrapper around an observed command. + +[call [cmd observe] [arg cinfo] [arg cmdname]] +Prints out useless info. + +[call [cmd observe] [arg variable] [arg varname] [arg operation] [opt [arg args]]] +Currently a wrapper around trace that uses [cmd dump] to print out +the value of the named variable whenever the specified +operation on that variable occurs (must be [arg read], [arg write] or [arg unset]). + +[call [cmd observe] [arg vdelete] [arg varname] [arg operation]] +Deletes the trace wrapper around the named variable. + +[call [cmd observe] [arg vinfo] [arg varname]] +Prints out trace info about the named variable. + +[list_end] + +[see_also [cmd tkcon](1)] +[see_also [cmd tkconrc](5) [cmd tkcon](n) [cmd dump](n)] +[see_also [cmd idebug](n)] +[keywords Tk console debug] + +[manpage_end] + diff --git a/docs/plugin.html b/docs/plugin.html index 7747cd3..1cc1896 100755 --- a/docs/plugin.html +++ b/docs/plugin.html @@ -71,7 +71,7 @@ debugging tclets. The demo below uses the CVS head of tkcon.

Have a look at some of the features: (culled from the -tkcon documentation) +tkcon documentation)
  • Variable / Path / Procedure Name Expansion. Type in set tc at the prompt. Hit <Control-Shift-V>. diff --git a/docs/start.html b/docs/start.html index 30f604c..901f326 100755 --- a/docs/start.html +++ b/docs/start.html @@ -270,6 +270,11 @@ auto_path when the after the resource file is loaded in).
    A tcl script to execute in the main interpreter after the slave interpreter is created and the user interface is initialized. +
    ::tkcon::OPT(maxlinelen) +
    A number that specifies the limit of long result lines. +True result is still captured in $_ (and 'puts $_' works). +Defaults to 0 (unlimited). +
    ::tkcon::OPT(maxmenu)
    A number that specifies the maximum number of packages to show vertically in the Interp->Packages menu before breaking into diff --git a/docs/style.css b/docs/style.css index d9ea817..b9aefa3 100644 --- a/docs/style.css +++ b/docs/style.css @@ -1,57 +1,35 @@