Skip to content

Commit 94a1c82

Browse files
author
jan.nijtmans
committed
(cherry-pick): wish doc: change synopsis from "wish ?-encoding encoding?" to "wish ?options?". There are more options nowdays.
1 parent 9131f22 commit 94a1c82

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

doc/wish.1

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,34 @@
1212
.SH NAME
1313
wish \- Simple windowing shell
1414
.SH SYNOPSIS
15-
\fBwish\fR ?\fB\-encoding \fIname\fR? ?\fIfileName arg arg ...\fR?
15+
\fBwish\fR ?\fBoptions\fR? ?\fIfileName arg ...\fR?
1616
.SH OPTIONS
17+
.\" OPTION: -encoding
1718
.IP "\fB\-encoding \fIname\fR" 20
1819
Specifies the encoding of the text stored in \fIfileName\fR.
1920
This option is only recognized prior to the \fIfileName\fR argument.
21+
.\" OPTION: -colormap
2022
.IP "\fB\-colormap \fInew\fR" 20
2123
Specifies that the window should have a new private colormap instead of
2224
using the default colormap for the screen.
25+
.\" OPTION: -display
2326
.IP "\fB\-display \fIdisplay\fR" 20
2427
Display (and screen) on which to display window.
28+
.\" OPTION: -geometry
2529
.IP "\fB\-geometry \fIgeometry\fR" 20
2630
Initial geometry to use for window. If this option is specified, its
2731
value is stored in the \fBgeometry\fR global variable of the application's
2832
Tcl interpreter.
33+
.\" OPTION: -name
2934
.IP "\fB\-name \fIname\fR" 20
3035
Use \fIname\fR as the title to be displayed in the window, and
3136
as the name of the interpreter for \fBsend\fR commands.
37+
.\" OPTION: -sync
3238
.IP "\fB\-sync\fR" 20
3339
Execute all X server commands synchronously, so that errors
3440
are reported immediately. This will result in much slower
3541
execution, but it is useful for debugging.
42+
.\" OPTION: -use
3643
.IP "\fB\-use\fR \fIid\fR" 20
3744
Specifies that the main window for the application is to be embedded in
3845
the window whose identifier is \fIid\fR, instead of being created as an
@@ -44,10 +51,12 @@ Note that on some platforms this will only work correctly if \fIid\fR
4451
refers to a Tk \fBframe\fR or \fBtoplevel\fR that has its
4552
\fB\-container\fR option enabled.
4653
.RE
54+
.\" OPTION: -visual
4755
.IP "\fB\-visual \fIvisual\fR" 20
4856
Specifies the visual to use for the window.
4957
\fIVisual\fR may have any of the forms supported by the \fBTk_GetVisual\fR
5058
procedure.
59+
.\" OPTION: --
5160
.IP "\fB\-\|\-\fR" 20
5261
Pass all remaining arguments through to the script's \fBargv\fR
5362
variable without interpreting them.
@@ -117,30 +126,40 @@ file, is the same as its name except that the first letter is
117126
capitalized.
118127
.SH "VARIABLES"
119128
.PP
120-
\fBWish\fR sets the following Tcl variables:
129+
\fBWish\fR sets the following global Tcl variables:
130+
.\" VARIABLE: argc
121131
.TP 15
122132
\fBargc\fR
133+
.
123134
Contains a count of the number of \fIarg\fR arguments (0 if none),
124135
not including the options described above.
136+
.\" VARIABLE: argv
125137
.TP 15
126138
\fBargv\fR
139+
.
127140
Contains a Tcl list whose elements are the \fIarg\fR arguments
128141
that follow a \fB\-\|\-\fR option or do not match any of the
129142
options described in \fBOPTIONS\fR above, in order, or an empty string
130143
if there are no such arguments.
144+
.\" VARIABLE: argv0
131145
.TP 15
132146
\fBargv0\fR
147+
.
133148
Contains \fIfileName\fR if it was specified.
134149
Otherwise, contains the name by which \fBwish\fR was invoked.
150+
.\" VARIABLE: geometry
135151
.TP 15
136152
\fBgeometry\fR
153+
.
137154
If the \fB\-geometry\fR option is specified, \fBwish\fR copies its
138155
value into this variable. If the variable still exists after
139156
\fIfileName\fR has been evaluated, \fBwish\fR uses the value of
140157
the variable in a \fBwm geometry\fR command to set the main
141158
window's geometry.
159+
.\" VARIABLE: tcl_interactive
142160
.TP 15
143161
\fBtcl_interactive\fR
162+
.
144163
Contains 1 if \fBwish\fR is reading commands interactively (\fIfileName\fR
145164
was not specified and standard input is a terminal-like
146165
device), 0 otherwise.

0 commit comments

Comments
 (0)