source: trunk/tkcon/docs/procs.html @ 931

Last change on this file since 931 was 931, checked in by toby, 11 years ago

include rest of files

File size: 6.4 KB
Line 
1<HTML>
2<HEAD>
3<TITLE>tkcon: Procedures</TITLE>
4<LINK REL="STYLESHEET" TYPE="text/css" HREF="./style.css">
5</HEAD>
6
7<BODY BGCOLOR=#FFFFFF>
8
9<TABLE WIDTH=100% BORDER=0 CELLSPACING=2 CELLPADDING=0 BGCOLOR=#000000><TR><TD>
10<!-- start header info -->
11<TABLE WIDTH=100% BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=#FFFFFF>
12<TR>
13<TH><FONT SIZE=+3>tkcon: Procedures</FONT></TH>
14<TD align=right>
15<A href="http://tkcon.sourceforge.net/"> 
16<IMG src="http://sourceforge.net/sflogo.php?group_id=11462&type=1" width="88"
17height="31" border="0" alt="SourceForge Logo"></A>
18</TD>
19</TR>
20</TABLE>
21<!-- end header info -->
22
23</TD></TR><TR><TD>
24<!-- start main navigation table -->
25<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2 BGCOLOR=#CCCCCC width=100%>
26<TR>
27<TH CLASS="hi"><A HREF="index.html" CLASS="hi">Documentation</A></TH>
28<TH><A HREF="purpose.html">Purpose &amp; Features</A></TH>
29<TH><A HREF="limits.html">Limitations</A></TH>
30<TH><A HREF="todo.html">To&nbsp;Do</A></TH>
31<TH><A HREF="license.terms">License</A></TH>
32</TR><TR>
33<TH COLSPAN=2><A HREF="plugin.html">Online Demo</A>
34(requires <A HREF="http://tcl.activestate.com/software/plugin/">Tk plugin</A>)</TH>
35<TH COLSPAN=3><A HREF="nontcl.html">Using TkCon with other Tk Languages</A></TH>
36</TR>
37</TABLE>
38<!-- end main navigation table -->
39</TD></TR><TR><TD>
40<!-- start secondary navigation table -->
41<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2 BGCOLOR=#BBBBBB width=100%>
42<TR>
43<TH><A HREF="start.html">Getting Started</A></TH>
44<TH><A HREF="bindings.html">Special Bindings</A></TH>
45<TH CLASS="hi2"><A HREF="procs.html" CLASS="hi2">Procedures</A></TH>
46<TH><A HREF="demopic.gif">Screenshot</A></TH>
47</TR>
48<TR>
49<TH><A HREF="dump.html"><CODE>dump</CODE></A></TH>
50<TH><A HREF="tkcon.html"><CODE>tkcon</CODE></A></TH>
51<TH><A HREF="idebug.html"><CODE>idebug</CODE></A></TH>
52<TH><A HREF="observe.html"><CODE>observe</CODE></A></TH>
53</TR>
54</TABLE>
55<!-- end secondary navigation table -->
56</TD></TR><TR><TD BGCOLOR=#FFFFFF>
57<DIV CLASS="indent">
58 <P>
59There are several new procedures introduced in TkCon to improve
60productivity and/or account for lost functionality in the Tcl environment
61that users are used to in native environments.  There are also some
62redefined procedures.  Here is a non-comprehensive list:
63
64<DL COMPACT>
65
66<DT> <B>alias</B> <I>?sourceCmd targetCmd ?arg arg ...??</I>
67<DD> Simple alias mechanism.  It will overwrite existing commands.
68When called without args, it returns current aliases.  Note that TkCon
69makes some aliases for you (in slaves).
70<font color=#FF0000>Don't delete those</font>.
71
72<DT> <B>clear</B> <I>?percentage?</I>
73<DD> Clears the text widget.  Same as the &lt;Control-l&gt; binding, except
74this will accept a percentage of the buffer to clear (1-100, 100 default).
75
76<DT> <B>dir</B> <i>?-all? ?-full? ?-long? ?pattern pattern ...?</i>
77<DD> Cheap way to get directory listings.  Uses glob style pattern matching.
78
79<DT> <B>dump</B> <I>type ?-nocomplain? ?-filter pattern? ?--?
80pattern ?pattern ...?</I>
81<DD> The <CODE>dump</CODE> command provides a way for the user to spit out
82state information about the interpreter in a Tcl readable (and human
83readable) form.
84See <a href="dump.html">further <B>dump</B> docs</a> for details.
85
86<DT> <B>echo</B> <I>?arg arg ...?</I>
87<DD> Concatenates the args and spits the result to the console (stdout).
88
89<DT> <B>edit</B> <I>?-type type? ?-find str? ?-attach interp?</I> arg
90<font size=-1 color=#990033>NEW in v1.4, still under construction</font>
91<DD> Opens an editor with the data from <I>arg</I>.  The optional <I>type</I>
92argument can be one of: <I>proc</I>, <I>var</I> or <I>file</I>.  For
93proc or var, the <I>arg</I> may be a pattern.
94
95<DT> <B>idebug</B> <I>command ?args?</I>
96<DD> Interactive debugging command.
97See <a href="idebug.html">further <B>idebug</B> docs</a> for details.
98
99<DT> <B>lremove</B> <I>?-all? ?-regexp -glob? list items</I>
100<DD> Removes one or more items from a list and returns the new list.  If
101<I>-all</I> is specified, it removes all instances of each item in the
102list.  If <I>-regexp</I> or <I>-glob</I> is specified, it interprets each
103item in the items list as a regexp or glob pattern to match against.
104
105<DT> <B>less</B>
106<DD> Aliased to <B>edit</B>.
107
108<DT> <B>ls</B>
109<DD> Aliased to <B>dir -full</B>.
110
111<DT> <B>more</B>
112<DD> Aliased to <B>edit</B>.
113
114<DT> <B>observe</B> <I>type ?args?</I>
115<DD> This command provides passive runtime debugging output for variables
116and commands.
117See <a href="observe.html">further <B>observe</B> docs</a> for details.
118
119<DT> <B>puts</B> (same options as always)
120<DD> Redefined to put the output into TkCon
121
122<DT> <B>tkcon</B> <I>method ?args?</I>
123<DD> Multi-purpose command.
124See <a href="tkcon.html">further <B>tkcon</B> docs</a> for details.
125
126<DT> <B>tclindex</B> <I>?-extensions patternlist? ?-index TCL_BOOLEAN?
127?-package TCL_BOOLEAN? ?dir1 dir2 ...?</I>
128<DD> Convenience proc to update the tclIndex (controlled by -index switch)
129and/or pkgIndex.tcl (controlled by -package switch) file in the named
130directories based on the given pattern for files.  It defaults to creating
131the tclIndex but not the pkgIndex.tcl file, with the directory defaulting
132to [pwd].  The extension defaults to *.tcl, with *.[info sharelibextension]
133added when -package is true.
134
135<DT> <B>unalias</B> <I>cmd</I>
136<DD> unaliases command
137
138<DT> <B>what</B> <i>string</i>
139<DD> The <CODE>what</CODE> command will identify the word given in
140<i>string</i> in the Tcl environment and return a list of types that
141it was recognized as.  Possible types are: alias, procedure, command,
142array variable, scalar variable, directory, file, widget, and executable.
143Used by procedures <CODE>dump</CODE> and <CODE>which</CODE>.
144
145<DT> <B>which</B> <i>command</i>
146<DD> Like the 'which' command of Unix shells, this will tell you if a
147particular command is known, and if so, whether it is internal or external
148to the interpreter.  If it is an internal command and there is a slot in
149auto_index for it, it tells you the file that auto_index would load.  This
150does not necessarily mean that that is where the file came from, but if it
151were not in the interpreter previously, then that is where the command was
152found.
153
154</DL>
155
156There are several procedures that I use as helpers that some may find
157helpful in there coding (ie - expanding pathnames).  Feel free to lift
158them from the code (but do assign proper attribution).
159</DIV>
160</TD></TR></TABLE>
161
162<HR NOSHADE SIZE=1>
163<ADDRESS><FONT SIZE=2>&copy;
164<A HREF="mailto:jeff.hobbs@acm.org">Jeffrey Hobbs</A></FONT></ADDRESS>
165
166</BODY>
167</HTML>
Note: See TracBrowser for help on using the repository browser.