summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2010-01-14 14:00:39 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2010-01-14 14:00:39 (GMT)
commitc735992f7daa038e0b63cd4070133a0986c50d3e (patch)
tree75d49325fe4385b4749da4dda0017938e6f6243b
parent3c27e50e2a919f0c6fb8790ca2419010f6c814a6 (diff)
downloadtk-c735992f7daa038e0b63cd4070133a0986c50d3e.zip
tk-c735992f7daa038e0b63cd4070133a0986c50d3e.tar.gz
tk-c735992f7daa038e0b63cd4070133a0986c50d3e.tar.bz2
Adjust formatting to make this look nicer
-rw-r--r--doc/loadTk.n21
1 files changed, 10 insertions, 11 deletions
diff --git a/doc/loadTk.n b/doc/loadTk.n
index 776e561..06f7336 100644
--- a/doc/loadTk.n
+++ b/doc/loadTk.n
@@ -4,16 +4,16 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: loadTk.n,v 1.15 2009/11/01 23:49:50 mistachkin Exp $
+'\" RCS: @(#) $Id: loadTk.n,v 1.16 2010/01/14 14:00:39 dkf Exp $
'\"
.so man.macros
.TH "Safe Tk" n 8.0 Tk "Tk Built-In Commands"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-loadTk \- Load Tk into a safe interpreter.
+safe::loadTk \- Load Tk into a safe interpreter.
.SH SYNOPSIS
-\fB::safe::loadTk \fIslave\fR ?\fB\-use\fR \fIwindowId\fR? ?\fB\-display\fR \fIdisplayName\fR?
+\fBsafe::loadTk \fIslave\fR ?\fB\-use\fR \fIwindowId\fR? ?\fB\-display\fR \fIdisplayName\fR?
.BE
.SH DESCRIPTION
.PP
@@ -22,10 +22,10 @@ restricted and mediated access to auto-loading and packages for safe
interpreters. Safe Tk adds the ability to configure the interpreter for safe
Tk operations and load Tk into safe interpreters.
.PP
-The \fB::safe::loadTk\fR command initializes the required data structures in
+The \fBsafe::loadTk\fR command initializes the required data structures in
the named safe interpreter and then loads Tk into it. The interpreter must
-have been created with \fB::safe::interpCreate\fR or have been initialized
-with \fB::safe::interpInit\fR. The command returns the name of the safe
+have been created with \fBsafe::interpCreate\fR or have been initialized
+with \fBsafe::interpInit\fR. The command returns the name of the safe
interpreter. If \fB\-use\fR is specified, the window identified by the
specified system dependent identifier \fIwindowId\fR is used to contain the
.QW .
@@ -34,8 +34,7 @@ a window belonging to another application. As a convenience, if the window you
plan to use is a Tk Window of the application you can use the window name
(e.g.,
.QW \fB.x.y\fR )
-instead of its window Id (e.g.,
-.QW "\fB[winfo id .x.y]\fR" ).
+instead of its window Id (e.g., from \fBwinfo id\fR \fB.x.y\fR).
When \fB\-use\fR is not specified, a new toplevel window is created for the
.QW .
window of the safe interpreter. On X11 if you want the embedded window to use
@@ -46,14 +45,14 @@ the \fBSECURITY ISSUES\fR section below for implementation details.
Please read the \fBsafe\fR manual page for Tcl to learn about the basic
security considerations for Safe Tcl.
.PP
-\fB::safe::loadTk\fR adds the value of \fBtk_library\fR taken from the master
+\fBsafe::loadTk\fR adds the value of \fBtk_library\fR taken from the master
interpreter to the virtual access path of the safe interpreter so that
auto-loading will work in the safe interpreter.
.PP
Tk initialization is now safe with respect to not trusting the slave's state
-for startup. \fB::safe::loadTk\fR registers the slave's name so when the Tk
+for startup. \fBsafe::loadTk\fR registers the slave's name so when the Tk
initialization (\fBTk_SafeInit\fR) is called and in turn calls the master's
-\fB::safe::InitTk\fR it will return the desired \fBargv\fR equivalent
+\fBsafe::InitTk\fR it will return the desired \fBargv\fR equivalent
(\fB\-use\fR \fIwindowId\fR, correct \fB\-display\fR, etc.)
.PP
When \fB\-use\fR is not used, the new toplevel created is specially decorated