summaryrefslogtreecommitdiffstats
path: root/doc/dde.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-01-18 15:59:22 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-01-18 15:59:22 (GMT)
commit6ffdf3453e1742088513fa2f50f02707b6c20275 (patch)
tree9b0d2bc7d8dda4e0f3fdf2b84ba38bc9a6fb35ab /doc/dde.n
parent5d08e68e4938403a0d5f4b7d720638b445f2c3eb (diff)
downloadtcl-6ffdf3453e1742088513fa2f50f02707b6c20275.zip
tcl-6ffdf3453e1742088513fa2f50f02707b6c20275.tar.gz
tcl-6ffdf3453e1742088513fa2f50f02707b6c20275.tar.bz2
Minor fixes for indented paragraph handling
Diffstat (limited to 'doc/dde.n')
-rw-r--r--doc/dde.n14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/dde.n b/doc/dde.n
index 6a77272..d5a6e78 100644
--- a/doc/dde.n
+++ b/doc/dde.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: dde.n,v 1.23 2007/12/13 15:22:32 dgp Exp $
+'\" RCS: @(#) $Id: dde.n,v 1.24 2008/01/18 15:59:22 dkf Exp $
'\"
.so man.macros
.TH dde n 1.3 dde "Tcl Bundled Packages"
@@ -48,6 +48,7 @@ The following commands are a subset of the full Dynamic Data Exchange
set of commands.
.TP
\fBdde servername \fR?\fB\-force\fR? ?\fB\-handler \fIproc\fR? ?\fB\-\|\-\fR? ?\fItopic\fR?
+.
\fBdde servername\fR registers the interpreter as a DDE server with
the service name \fBTclEval\fR and the topic name specified by \fItopic\fR.
If no \fItopic\fR is given, \fBdde servername\fR returns the name
@@ -61,14 +62,17 @@ is appended to the name to make it
unique. The command's result will be the name actually used. The
\fB\-force\fR option is used to force registration of precisely the
given \fItopic\fR name.
-.IP
+.RS
+.PP
The \fB\-handler\fR option specifies a Tcl procedure that will be called to
process calls to the dde server. If the package has been loaded into a
safe interpreter then a \fB\-handler\fR procedure must be defined. The
procedure is called with all the arguments provided by the remote
call.
+.RE
.TP
\fBdde execute\fR ?\fB\-async\fR? \fIservice topic data\fR
+.
\fBdde execute\fR takes the \fIdata\fR and sends it to the server indicated
by \fIservice\fR with the topic indicated by \fItopic\fR. Typically,
\fIservice\fR is the name of an application, and \fItopic\fR is a file to
@@ -80,6 +84,7 @@ script did not run, unless the \fB\-async\fR flag was used, in which case
the command returns immediately with no error.
.TP
\fBdde poke \fIservice topic item data\fR
+.
\fBdde poke\fR passes the \fIdata\fR to the server indicated by
\fIservice\fR using the \fItopic\fR and \fIitem\fR specified. Typically,
\fIservice\fR is the name of an application. \fItopic\fR is application
@@ -89,6 +94,7 @@ it must always be non-null. The \fIdata\fR field is given to the remote
application.
.TP
\fBdde request\fR ?\fB\-binary\fR? \fIservice topic item\fR
+.
\fBdde request\fR is typically used to get the value of something; the
value of a cell in Microsoft Excel or the text of a selection in
Microsoft Word. \fIservice\fR is typically the name of an application,
@@ -99,6 +105,7 @@ string with terminating null. If \fB\-binary\fR is specified, the
result is returned as a byte array.
.TP
\fBdde services \fIservice topic\fR
+.
\fBdde services\fR returns a list of service-topic pairs that
currently exist on the machine. If \fIservice\fR and \fItopic\fR are
both empty strings ({}), then all service-topic pairs currently
@@ -110,6 +117,7 @@ service-topic pair currently exists, it is returned; otherwise, an
empty string is returned.
.TP
\fBdde eval\fR ?\fB\-async\fR? \fItopic cmd \fR?\fIarg arg ...\fR?
+.
\fBdde eval\fR evaluates a command and its arguments using the interpreter
specified by \fItopic\fR. The DDE service must be the \fBTclEval\fR
service. The \fB\-async\fR option requests asynchronous invocation. The
@@ -155,9 +163,7 @@ particularly important website:
package require dde
\fBdde execute\fR iexplore WWW_OpenURL http://www.tcl.tk/
.CE
-
.SH "SEE ALSO"
tk(n), winfo(n), send(n)
-
.SH KEYWORDS
application, dde, name, remote execution