summaryrefslogtreecommitdiffstats
path: root/doc/place.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2024-01-21 00:00:49 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2024-01-21 00:00:49 (GMT)
commit81ac88e72f468bd35eb1eb30d6947b6feb0af48d (patch)
tree6459c6811aa54d681c9a14888949e59a5a1e735d /doc/place.n
parent668c3b43a9c64988d3d62ba2b75798dae2d0ed46 (diff)
downloadtk-81ac88e72f468bd35eb1eb30d6947b6feb0af48d.zip
tk-81ac88e72f468bd35eb1eb30d6947b6feb0af48d.tar.gz
tk-81ac88e72f468bd35eb1eb30d6947b6feb0af48d.tar.bz2
Many small tweaks to docs
The main one is I've added a comment in to make primary subcommands ("methods") more obvious when editing.
Diffstat (limited to 'doc/place.n')
-rw-r--r--doc/place.n18
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/place.n b/doc/place.n
index b56ad58..b1189cd 100644
--- a/doc/place.n
+++ b/doc/place.n
@@ -30,13 +30,16 @@ centered inside the container.
.PP
.TP
\fBplace \fIwindow option value \fR?\fIoption value ...\fR?
+.
Arrange for the placer to manage the geometry of a content whose
pathName is \fIwindow\fR. The remaining arguments consist of one or
more \fIoption\-value\fR pairs that specify the way in which
\fIwindow\fR's geometry is managed. \fIOption\fR may have any of the
values accepted by the \fBplace configure\fR command.
+.\" METHOD: configure
.TP
\fBplace configure \fIwindow \fR?\fIoption\fR? ?\fIvalue option value ...\fR?
+.
Query or modify the geometry options of the content given by
\fIwindow\fR. If no \fIoption\fR is specified, this command returns a
list describing the available options (see \fBTk_ConfigureInfo\fR for
@@ -177,23 +180,30 @@ If the same value is specified separately with
two different options, such as \fB\-x\fR and \fB\-relx\fR, then
the most recent option is used and the older one is ignored.
.RE
+.\" METHOD: content
+.TP
+\fBplace content \fIwindow\fR
+.
+Returns a list of all the content windows for which \fIwindow\fR is the container.
+If there is no content for \fIwindow\fR then an empty string is returned.
+.\" METHOD: forget
.TP
\fBplace forget \fIwindow\fR
+.
Causes the placer to stop managing the geometry of \fIwindow\fR. As a
side effect of this command \fIwindow\fR will be unmapped so that it
does not appear on the screen. If \fIwindow\fR is not currently managed
by the placer then the command has no effect. This command returns an
empty string.
+.\" METHOD: info
.TP
\fBplace info \fIwindow\fR
+.
Returns a list giving the current configuration of \fIwindow\fR.
The list consists of \fIoption\-value\fR pairs in exactly the
same form as might be specified to the \fBplace configure\fR
command.
-.TP
-\fBplace content \fIwindow\fR
-Returns a list of all the content windows for which \fIwindow\fR is the container.
-If there is no content for \fIwindow\fR then an empty string is returned.
+.\" METHOD: slaves
.TP
\fBplace slaves \fIwindow\fR
.