Include HTML docs and removed NROFF version
authorPat Thoyts <patthoyts@users.sourceforge.net>
Thu, 17 Jun 2004 17:59:24 +0000 (17:59 +0000)
committerPat Thoyts <patthoyts@users.sourceforge.net>
Thu, 17 Jun 2004 17:59:24 +0000 (17:59 +0000)
doc/winsend.html [new file with mode: 0644]
doc/winsend.n [deleted file]

diff --git a/doc/winsend.html b/doc/winsend.html
new file mode 100644 (file)
index 0000000..e1f61f5
--- /dev/null
@@ -0,0 +1,207 @@
+<html><head>
+<title>winsend - winsend </title>
+</head>
+<! -- Generated from file 'winsend.man' by tcllib/doctools with format 'html'
+   -->
+<! -- Copyright &copy; 2002 Pat Thoyts &lt;patthoyts@users.sourceforge.net&gt;
+   -->
+<! -- CVS: $Id$ winsend.n
+   -->
+
+<body>
+<h1> winsend(n) 1.0  &quot;winsend&quot;</h1>
+<h2><a name="name">NAME</a></h2>
+<p>
+<p> winsend - send implementation for windows platform
+
+<! -- $Id$
+   -->
+
+
+
+
+<h2><a name="tableofcontents">TABLE OF CONTENTS</a></h2>
+<p>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tableofcontents">TABLE OF CONTENTS</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#synopsis">SYNOPSIS</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#description">DESCRIPTION</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#commands">COMMANDS</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#examples">EXAMPLES</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#downloadandinstallation">DOWNLOAD and INSTALLATION</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#authors">AUTHORS</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#seealso">SEE ALSO</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#keywords">KEYWORDS</a><br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="#copyright">COPYRIGHT</a><br><h2><a name="synopsis">SYNOPSIS</a></h2>
+<p>
+package require <b>Tcl 8.3</b><br>
+package require <b>winsend ?1.0?</b><br>
+<br><table border=1 width=100% cellspacing=0 cellpadding=0><tr            bgcolor=lightyellow><td bgcolor=lightyellow><table 0 width=100% cellspacing=0 cellpadding=0><tr valign=top ><td ><a href="#1"><b class='cmd'>winsend</b> <i class='arg'>command</i> ?<i class='arg'>arguments ...</i>?</a></td></tr>
+</table></td></tr></table>
+<h2><a name="description">DESCRIPTION</a></h2>
+<p>
+<p>
+
+The <strong>winsend</strong> package is an attempt to provide the complete
+functionality of the Tk <b class='cmd'>send</b> command using the Microsoft Windows
+platform. The two key points are inter-process communications between
+one interpreter and another, and automatic registration of
+interpreters with a central source. With the Tk <b class='cmd'>send</b> command this is
+done via the X Windows server. The <b class='cmd'>winfo interps</b> command returns
+a list of registered interpreters and the <b class='cmd'>send</b> command allows
+you to execute Tcl commands in the named interpreter. Finally <b class='cmd'>tk
+appname</b> allows the programmer to select the registration name.
+
+<p>
+
+There are alternative methods for providing remote command xecution on
+the windows platform. The <strong>comm</strong> package that is now part of 
+<strong>tcllib</strong> provides cross-platform remote command execution by the
+use of TCP sockets. The disadvantage of this package is the lack of
+interpreter registration. Potential clients need to be told of the
+port number to use to communicate with the server application.
+
+<p>
+
+The other method is the <strong>dde</strong> package which is supplied as part of
+the Tcl core. This provides automatic registration and the available
+interpreters can be listed by excuting 
+<b class='cmd'>dde servers TclEval {}</b>. The disadvantage if the DDE system 
+is that a badly written
+windows application can hang your application. DDE uses windows
+messages to do its work. If an application isn't processing it's
+message queue then the dde command given above will never complete.
+
+<p>
+
+An alternative is available using Microsoft's COM technology. COM is
+designed to permit interprocess communication through the use of
+interfaces. There is also a system provided registration object where
+a reference to a running interpreter can be lodged. Querying the list
+of available servers only communicates with the Running Object Table
+(the ROT) and doesn't need to send messages to any
+applications. Sending commands does require the server interpreter to
+be processing events - but if the server is not processing these
+events then the command will time out. This is a significant advantage
+over DDE. Also, because we are using standard OLE automation
+interfaces it becomes possible for any other Automation capable
+application to send commands to Tcl for execution. Such applications
+include Microsoft Office applications, Internet Explorer and many
+others. For instance the following VB script can be run using the
+Windows Scripting Host cscript application using 
+<b class='cmd'>cscript test.vbs</b>
+<p><table><tr><td bgcolor=black>&nbsp;</td><td><pre class='sample'>
+ Set interp = GetObject(&quot;TclEval\tkcon.tcl&quot;)
+ interp.Send &quot;puts {Hello from VB Script}&quot;
+ WScript.Echo interp.Send(&quot;info tcl&quot;)</pre></td></tr></table></p>
+
+Provided you have an instance of Tcl running registered with 
+<b class='cmd'>winsend appname tkcon.tcl</b> you should see the message appear in
+the Tcl window and the Tcl version should be printed to the cscript
+console window.
+
+<! -- ----------------------------------------------------------
+   -->
+
+<h2><a name="commands">COMMANDS</a></h2>
+<p>
+
+<dl>
+
+<dt><a name="1"><b class='cmd'>winsend</b> <i class='arg'>command</i> ?<i class='arg'>arguments ...</i>?</a><dd>
+
+
+<dl>
+<dt><b class='cmd'>interps</b><dd>
+   Get the list of registered interpreter names for use with
+send. Similar to the Tk <b class='cmd'>winfo interps</b> command.
+
+<br><br>
+<dt><b class='cmd'>appname</b> ?<i class='arg'>name</i>?<dd>
+   When called with no arguments this returns the registered name of
+this interpreter. If a single argument is given, this is used to
+re-register the application using the new name. If the registration
+fails for some reason, such as the name is already in use, then an
+error is returned and the old appname remains in use.
+
+<br><br>
+<dt><b class='cmd'>send</b> <i class='arg'>appname</i> <i class='arg'>cmd</i> ?<i class='arg'>arg arg ...</i>?<dd>
+   As for the Tk <b class='cmd'>send</b> command this concatenates <i class='arg'>cmd</i> and
+all <i class='arg'>args</i> and passes the resulting string to the <i class='arg'>appname</i>
+interpreter for evaluation. It returns the result or error from this
+command evaluation.
+
+</dl>
+
+</dl>
+
+<! -- ----------------------------------------------------------
+   -->
+
+<h2><a name="examples">EXAMPLES</a></h2>
+<p>
+
+<p>
+<p><table><tr><td bgcolor=black>&nbsp;</td><td><pre class='sample'>
+% package require winsend
+1.0
+% winsend appname MyApp
+MyApp
+% winsend send MyApp info tcl
+8.3
+</pre></td></tr></table></p>
+
+<p>
+
+An example session between two interpreters
+<p><table><tr><td bgcolor=black>&nbsp;</td><td><pre class='sample'>
+An example (from tkcon):         from a concurrent tclsh:
+  % package require winsend  |     % package require winsend
+  1.0                        |     1.0
+  % winsend interps          |     % winsend interps
+  tkcon.tcl                  |     tkcon.tcl TCLSH.EXE
+                             |     % winsend send tkcon.tcl set x 1
+                             |     1
+  % set x                    |
+  1                          |
+  % winsend send TCLSH.EXE set y 2
+                             |     % after 2000 {set zx 1} ; vwait zx
+  2                          |     % set y
+                             |     2
+                             |     % exit
+  % winsend interps          |
+  tkcon.tcl                  |
+</pre></td></tr></table></p>
+
+<! -- ----------------------------------------------------------
+   -->
+
+<h2><a name="downloadandinstallation">DOWNLOAD and INSTALLATION</a></h2>
+<p>
+
+The latest version is available at
+<a href="http://prdownloads.sourceforge.net/tclsoap/winsend-1.0.zip">http://prdownloads.sourceforge.net/tclsoap/winsend-1.0.zip</a>
+This includes the source and the DLLs. To install, copy the DLLs and
+the &quot;<strong>pkgIndex.tcl</strong>&quot; file to a subdirectory of your <strong>auto_path</strong>
+variable. For instance, to &quot;<strong>c:/Program Files/Tcl/lib/winsend10/</strong>&quot;
+
+<p>
+
+Documentation is located at 
+<a href="http://tclsoap.sourceforge.net/winsend.html">http://tclsoap.sourceforge.net/winsend.html</a>
+
+<! -- ----------------------------------------------------------
+   -->
+
+
+
+<! -- ----------------------------------------------------------
+   -->
+
+<h2><a name="authors">AUTHORS</a></h2>
+<p>
+Pat Thoyts
+
+<! -- ----------------------------------------------------------
+   -->
+
+
+<h2><a name="seealso">SEE ALSO</a></h2>
+<p>
+send(n), tk(n), winfo(n)
+<h2><a name="keywords">KEYWORDS</a></h2>
+<p>
+Automation, COM, appname, send, tk, winfo
+<h2><a name="copyright">COPYRIGHT</a></h2>
+<p>
+Copyright &copy; 2002 Pat Thoyts &lt;patthoyts@users.sourceforge.net&gt;<br>
+</body></html>
diff --git a/doc/winsend.n b/doc/winsend.n
deleted file mode 100644 (file)
index 08c12f3..0000000
+++ /dev/null
@@ -1,171 +0,0 @@
-'\"
-'\" Generated from file 'winsend.man' by tcllib/doctools with format 'nroff'
-'\" Copyright (c) 2002 Pat Thoyts <patthoyts@users.sourceforge.net>
-'\"
-.so man.macros
-.TH "winsend" n 0.6  "winsend"
-.BS
-.SH "NAME"
-winsend \- send implementation for windows platform
-'\" $Id$
-.SH "SYNOPSIS"
-package require \fBTcl  8.3\fR
-.sp
-package require \fBwinsend  ?0.6?\fR
-.sp
-\fBwinsend\fR \fIcommand\fR ?\fIarguments ...\fR?\fR
-.sp
-.BE
-.SH "DESCRIPTION"
-.PP
-The \fBwinsend\fR package is an attempt to provide the complete
-functionality of the Tk \fBsend\fR command using the Microsoft Windows
-platform. The two key points are inter-process communications between
-one interpreter and another, and automatic registration of
-interpreters with a central source. With the Tk \fBsend\fR command this is
-done via the X Windows server. The \fBwinfo interps\fR command returns
-a list of registered interpreters and the \fBsend\fR command allows
-you to execute Tcl commands in the named interpreter. Finally \fBtk
-appname\fR allows the programmer to select the registration name.
-.PP
-There are alternative methods for providing remote command xecution on
-the windows platform. The \fBcomm\fR package that is now part of
-\fBtcllib\fR provides cross-platform remote command execution by the
-use of TCP sockets. The disadvantage of this package is the lack of
-interpreter registration. Potential clients need to be told of the
-port number to use to communicate with the server application.
-.PP
-The other method is the \fBdde\fR package which is supplied as part of
-the Tcl core. This provides automatic registration and the available
-interpreters can be listed by excuting
-\fBdde servers TclEval {}\fR. The disadvantage if the DDE system
-is that a badly written
-windows application can hang your application. DDE uses windows
-messages to do its work. If an application isn't processing it's
-message queue then the dde command given above will never complete.
-.PP
-An alternative is available using Microsoft's COM technology. COM is
-designed to permit interprocess communication through the use of
-interfaces. There is also a system provided registration object where
-a reference to a running interpreter can be lodged. Querying the list
-of available servers only communicates with the Running Object Table
-(the ROT) and doesn't need to send messages to any
-applications. Sending commands does require the server interpreter to
-be processing events - but if the server is not processing these
-events then the command will time out. This is a significant advantage
-over DDE. Also, because we are using standard OLE automation
-interfaces it becomes possible for any other Automation capable
-application to send commands to Tcl for execution. Such applications
-include Microsoft Office applications, Internet Explorer and many
-others. For instance the following VB script can be run using the
-Windows Scripting Host cscript application using
-\fBcscript test.vbs\fR
-.nf
- Set interp = GetObject("\\.\TclInterp\tkcon.tcl")
- interp.Send "puts {Hello from VB Script}"
- WScript.Echo interp.Send("info tcl").fi
-
-Provided you have an instance of Tcl running registered with 
-\fBwinsend appname tkcon.tcl\fR you should see the message appear in
-the Tcl window and the Tcl version should be printed to the cscript
-console window.
-
-'\" ----------------------------------------------------------
-
-.SH "COMMANDS"
-
-
-
-
-.TP
-\fBwinsend\fR \fIcommand\fR ?\fIarguments ...\fR?\fR
-
-
-.RS
-
-.TP
-\fBinterps\fR
-   Get the list of registered interpreter names for use with
-send. Similar to the Tk \fBwinfo interps\fR command.
-
-
-.TP
-\fBappname\fR ?\fIname\fR?
-   When called with no arguments this returns the registered name of
-this interpreter. If a single argument is given, this is used to
-re-register the application using the new name. If the registration
-fails for some reason, such as the name is already in use, then an
-error is returned and the old appname remains in use.
-
-
-.TP
-\fBsend\fR \fIappname\fR \fIcmd\fR ?\fIarg arg ...\fR?
-   As for the Tk \fBsend\fR command this concatenates \fIcmd\fR and
-all \fIargs\fR and passes the resulting string to the \fIappname\fR
-interpreter for evaluation. It returns the result or error from this
-command evaluation.
-
-
-.RE
-
-
-
-'\" ----------------------------------------------------------
-
-.SH "EXAMPLES"
-
-
-.PP
-
-
-.nf
-% package require winsend
-0.6
-% winsend appname MyApp
-MyApp
-% winsend send MyApp info tcl
-8.3
-.fi
-.PP
-An example session between two interpreters
-.nf
-An example (from tkcon):         from a concurrent tclsh:
-  % package require winsend  |     % package require winsend
-  0.6                        |     0.6
-  % winsend interps          |     % winsend interps
-  tkcon.tcl                  |     tkcon.tcl TCLSH.EXE
-                             |     % winsend send tkcon.tcl set x 1
-                             |     1
-  % set x                    |
-  1                          |
-  % winsend send TCLSH.EXE set y 2
-                             |     % after 2000 {set zx 1} ; vwait zx
-  2                          |     % set y
-                             |     2
-                             |     % exit
-  % winsend interps          |
-  tkcon.tcl                  |
-.fi
-'\" ----------------------------------------------------------
-.SH "DOWNLOAD and INSTALLATION"
-The latest version is available at
-\fIhttp://prdownloads.sourceforge.net/tclsoap/winsend-0.6.zip\fR
-This includes the source and the DLLs. To install, copy the DLLs and
-the "\fIpkgIndex.tcl\fR" file to a subdirectory of your \fBauto_path\fR
-variable. For instance, to "\fIc:/Program Files/Tcl/lib/winsend06/\fR"
-.PP
-Documentation is located at
-\fIhttp://tclsoap.sourceforge.net/winsend.html\fR
-'\" ----------------------------------------------------------
-.SH "SEE ALSO"
-send(n), winfo(n), tk(n)
-'\" ----------------------------------------------------------
-.SH "AUTHORS"
-Pat Thoyts
-'\" ----------------------------------------------------------
-.SH "KEYWORDS"
-send, appname, tk, winfo, COM, Automation
-.SH "COPYRIGHT"
-.nf
-Copyright (c) 2002 Pat Thoyts <patthoyts@users.sourceforge.net>
-.fi
\ No newline at end of file