| 1 | '\" |
| 2 | '\" Copyright (c) 1991-1994 The Regents of the University of California. |
| 3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| 4 | '\" |
| 5 | '\" See the file "license.terms" for information on usage and redistribution |
| 6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 7 | '\" |
| 8 | '\" RCS: @(#) $Id: wish.1,v 1.3 2003/02/13 22:09:12 kennykb Exp $ |
| 9 | '\" |
| 10 | '\" The definitions below are for supplemental macros used in Tcl/Tk |
| 11 | '\" manual entries. |
| 12 | '\" |
| 13 | '\" .AP type name in/out ?indent? |
| 14 | '\" Start paragraph describing an argument to a library procedure. |
| 15 | '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| 16 | '\" or "in/out" to describe whether procedure reads or modifies arg, |
| 17 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| 18 | '\" needed; use .AS below instead) |
| 19 | '\" |
| 20 | '\" .AS ?type? ?name? |
| 21 | '\" Give maximum sizes of arguments for setting tab stops. Type and |
| 22 | '\" name are examples of largest possible arguments that will be passed |
| 23 | '\" to .AP later. If args are omitted, default tab stops are used. |
| 24 | '\" |
| 25 | '\" .BS |
| 26 | '\" Start box enclosure. From here until next .BE, everything will be |
| 27 | '\" enclosed in one large box. |
| 28 | '\" |
| 29 | '\" .BE |
| 30 | '\" End of box enclosure. |
| 31 | '\" |
| 32 | '\" .CS |
| 33 | '\" Begin code excerpt. |
| 34 | '\" |
| 35 | '\" .CE |
| 36 | '\" End code excerpt. |
| 37 | '\" |
| 38 | '\" .VS ?version? ?br? |
| 39 | '\" Begin vertical sidebar, for use in marking newly-changed parts |
| 40 | '\" of man pages. The first argument is ignored and used for recording |
| 41 | '\" the version when the .VS was added, so that the sidebars can be |
| 42 | '\" found and removed when they reach a certain age. If another argument |
| 43 | '\" is present, then a line break is forced before starting the sidebar. |
| 44 | '\" |
| 45 | '\" .VE |
| 46 | '\" End of vertical sidebar. |
| 47 | '\" |
| 48 | '\" .DS |
| 49 | '\" Begin an indented unfilled display. |
| 50 | '\" |
| 51 | '\" .DE |
| 52 | '\" End of indented unfilled display. |
| 53 | '\" |
| 54 | '\" .SO |
| 55 | '\" Start of list of standard options for a Tk widget. The |
| 56 | '\" options follow on successive lines, in four columns separated |
| 57 | '\" by tabs. |
| 58 | '\" |
| 59 | '\" .SE |
| 60 | '\" End of list of standard options for a Tk widget. |
| 61 | '\" |
| 62 | '\" .OP cmdName dbName dbClass |
| 63 | '\" Start of description of a specific option. cmdName gives the |
| 64 | '\" option's name as specified in the class command, dbName gives |
| 65 | '\" the option's name in the option database, and dbClass gives |
| 66 | '\" the option's class in the option database. |
| 67 | '\" |
| 68 | '\" .UL arg1 arg2 |
| 69 | '\" Print arg1 underlined, then print arg2 normally. |
| 70 | '\" |
| 71 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| 72 | '\" |
| 73 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| 74 | .if t .wh -1.3i ^B |
| 75 | .nr ^l \n(.l |
| 76 | .ad b |
| 77 | '\" # Start an argument description |
| 78 | .de AP |
| 79 | .ie !"\\$4"" .TP \\$4 |
| 80 | .el \{\ |
| 81 | . ie !"\\$2"" .TP \\n()Cu |
| 82 | . el .TP 15 |
| 83 | .\} |
| 84 | .ta \\n()Au \\n()Bu |
| 85 | .ie !"\\$3"" \{\ |
| 86 | \&\\$1 \\fI\\$2\\fP (\\$3) |
| 87 | .\".b |
| 88 | .\} |
| 89 | .el \{\ |
| 90 | .br |
| 91 | .ie !"\\$2"" \{\ |
| 92 | \&\\$1 \\fI\\$2\\fP |
| 93 | .\} |
| 94 | .el \{\ |
| 95 | \&\\fI\\$1\\fP |
| 96 | .\} |
| 97 | .\} |
| 98 | .. |
| 99 | '\" # define tabbing values for .AP |
| 100 | .de AS |
| 101 | .nr )A 10n |
| 102 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| 103 | .nr )B \\n()Au+15n |
| 104 | .\" |
| 105 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| 106 | .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| 107 | .. |
| 108 | .AS Tcl_Interp Tcl_CreateInterp in/out |
| 109 | '\" # BS - start boxed text |
| 110 | '\" # ^y = starting y location |
| 111 | '\" # ^b = 1 |
| 112 | .de BS |
| 113 | .br |
| 114 | .mk ^y |
| 115 | .nr ^b 1u |
| 116 | .if n .nf |
| 117 | .if n .ti 0 |
| 118 | .if n \l'\\n(.lu\(ul' |
| 119 | .if n .fi |
| 120 | .. |
| 121 | '\" # BE - end boxed text (draw box now) |
| 122 | .de BE |
| 123 | .nf |
| 124 | .ti 0 |
| 125 | .mk ^t |
| 126 | .ie n \l'\\n(^lu\(ul' |
| 127 | .el \{\ |
| 128 | .\" Draw four-sided box normally, but don't draw top of |
| 129 | .\" box if the box started on an earlier page. |
| 130 | .ie !\\n(^b-1 \{\ |
| 131 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 132 | .\} |
| 133 | .el \}\ |
| 134 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 135 | .\} |
| 136 | .\} |
| 137 | .fi |
| 138 | .br |
| 139 | .nr ^b 0 |
| 140 | .. |
| 141 | '\" # VS - start vertical sidebar |
| 142 | '\" # ^Y = starting y location |
| 143 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| 144 | .de VS |
| 145 | .if !"\\$2"" .br |
| 146 | .mk ^Y |
| 147 | .ie n 'mc \s12\(br\s0 |
| 148 | .el .nr ^v 1u |
| 149 | .. |
| 150 | '\" # VE - end of vertical sidebar |
| 151 | .de VE |
| 152 | .ie n 'mc |
| 153 | .el \{\ |
| 154 | .ev 2 |
| 155 | .nf |
| 156 | .ti 0 |
| 157 | .mk ^t |
| 158 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| 159 | .sp -1 |
| 160 | .fi |
| 161 | .ev |
| 162 | .\} |
| 163 | .nr ^v 0 |
| 164 | .. |
| 165 | '\" # Special macro to handle page bottom: finish off current |
| 166 | '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| 167 | '\" # page bottom macro. |
| 168 | .de ^B |
| 169 | .ev 2 |
| 170 | 'ti 0 |
| 171 | 'nf |
| 172 | .mk ^t |
| 173 | .if \\n(^b \{\ |
| 174 | .\" Draw three-sided box if this is the box's first page, |
| 175 | .\" draw two sides but no top otherwise. |
| 176 | .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 177 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 178 | .\} |
| 179 | .if \\n(^v \{\ |
| 180 | .nr ^x \\n(^tu+1v-\\n(^Yu |
| 181 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| 182 | .\} |
| 183 | .bp |
| 184 | 'fi |
| 185 | .ev |
| 186 | .if \\n(^b \{\ |
| 187 | .mk ^y |
| 188 | .nr ^b 2 |
| 189 | .\} |
| 190 | .if \\n(^v \{\ |
| 191 | .mk ^Y |
| 192 | .\} |
| 193 | .. |
| 194 | '\" # DS - begin display |
| 195 | .de DS |
| 196 | .RS |
| 197 | .nf |
| 198 | .sp |
| 199 | .. |
| 200 | '\" # DE - end display |
| 201 | .de DE |
| 202 | .fi |
| 203 | .RE |
| 204 | .sp |
| 205 | .. |
| 206 | '\" # SO - start of list of standard options |
| 207 | .de SO |
| 208 | .SH "STANDARD OPTIONS" |
| 209 | .LP |
| 210 | .nf |
| 211 | .ta 5.5c 11c |
| 212 | .ft B |
| 213 | .. |
| 214 | '\" # SE - end of list of standard options |
| 215 | .de SE |
| 216 | .fi |
| 217 | .ft R |
| 218 | .LP |
| 219 | See the \\fBoptions\\fR manual entry for details on the standard options. |
| 220 | .. |
| 221 | '\" # OP - start of full description for a single option |
| 222 | .de OP |
| 223 | .LP |
| 224 | .nf |
| 225 | .ta 4c |
| 226 | Command-Line Name: \\fB\\$1\\fR |
| 227 | Database Name: \\fB\\$2\\fR |
| 228 | Database Class: \\fB\\$3\\fR |
| 229 | .fi |
| 230 | .IP |
| 231 | .. |
| 232 | '\" # CS - begin code excerpt |
| 233 | .de CS |
| 234 | .RS |
| 235 | .nf |
| 236 | .ta .25i .5i .75i 1i |
| 237 | .. |
| 238 | '\" # CE - end code excerpt |
| 239 | .de CE |
| 240 | .fi |
| 241 | .RE |
| 242 | .. |
| 243 | .de UL |
| 244 | \\$1\l'|0\(ul'\\$2 |
| 245 | .. |
| 246 | .TH wish 1 8.0 Tk "Tk Applications" |
| 247 | .BS |
| 248 | '\" Note: do not modify the .SH NAME line immediately below! |
| 249 | .SH NAME |
| 250 | wish \- Simple windowing shell |
| 251 | .SH SYNOPSIS |
| 252 | \fBwish\fR ?\fIfileName arg arg ...\fR? |
| 253 | .SH OPTIONS |
| 254 | .IP "\fB\-colormap \fInew\fR" 20 |
| 255 | Specifies that the window should have a new private colormap instead of |
| 256 | using the default colormap for the screen. |
| 257 | .IP "\fB\-display \fIdisplay\fR" 20 |
| 258 | Display (and screen) on which to display window. |
| 259 | .IP "\fB\-geometry \fIgeometry\fR" 20 |
| 260 | Initial geometry to use for window. If this option is specified, its |
| 261 | value is stored in the \fBgeometry\fR global variable of the application's |
| 262 | Tcl interpreter. |
| 263 | .IP "\fB\-name \fIname\fR" 20 |
| 264 | Use \fIname\fR as the title to be displayed in the window, and |
| 265 | as the name of the interpreter for \fBsend\fR commands. |
| 266 | .IP "\fB\-sync\fR" 20 |
| 267 | Execute all X server commands synchronously, so that errors |
| 268 | are reported immediately. This will result in much slower |
| 269 | execution, but it is useful for debugging. |
| 270 | .VS 8.0 br |
| 271 | .IP "\fB\-use\fR \fIid\fR" 20 |
| 272 | Specifies that the main window for the application is to be embedded in |
| 273 | the window whose identifier is \fIid\fR, instead of being created as an |
| 274 | independent toplevel window. \fIId\fR must be specified in the same |
| 275 | way as the value for the \fB\-use\fR option for toplevel widgets (i.e. |
| 276 | it has a form like that returned by the \fBwinfo id\fR command). |
| 277 | .VE |
| 278 | .IP "\fB\-visual \fIvisual\fR" 20 |
| 279 | Specifies the visual to use for the window. |
| 280 | \fIVisual\fR may have any of the forms supported by the \fBTk_GetVisual\fR |
| 281 | procedure. |
| 282 | .IP "\fB\-\|\-\fR" 20 |
| 283 | Pass all remaining arguments through to the script's \fBargv\fR |
| 284 | variable without interpreting them. |
| 285 | This provides a mechanism for passing arguments such as \fB\-name\fR |
| 286 | to a script instead of having \fBwish\fR interpret them. |
| 287 | .BE |
| 288 | |
| 289 | .SH DESCRIPTION |
| 290 | .PP |
| 291 | \fBWish\fR is a simple program consisting of the Tcl command |
| 292 | language, the Tk toolkit, and a main program that reads commands |
| 293 | from standard input or from a file. |
| 294 | It creates a main window and then processes Tcl commands. |
| 295 | If \fBwish\fR is invoked with no arguments, or with a first argument |
| 296 | that starts with ``\-'', then it reads Tcl commands interactively from |
| 297 | standard input. |
| 298 | It will continue processing commands until all windows have been |
| 299 | deleted or until end-of-file is reached on standard input. |
| 300 | If there exists a file \fB.wishrc\fR in the home directory of |
| 301 | the user, \fBwish\fR evaluates the file as a Tcl script |
| 302 | just before reading the first command from standard input. |
| 303 | .PP |
| 304 | If \fBwish\fR is invoked with an initial \fIfileName\fR argument, then |
| 305 | \fIfileName\fR is treated as the name of a script file. |
| 306 | \fBWish\fR will evaluate the script in \fIfileName\fR (which |
| 307 | presumably creates a user interface), then it will respond to events |
| 308 | until all windows have been deleted. |
| 309 | Commands will not be read from standard input. |
| 310 | There is no automatic evaluation of \fB.wishrc\fR when the name |
| 311 | of a script file is presented on the \fBwish\fR command line, |
| 312 | but the script file can always \fBsource\fR it if desired. |
| 313 | |
| 314 | .SH "OPTIONS" |
| 315 | .PP |
| 316 | \fBWish\fR automatically processes all of the command-line options |
| 317 | described in the \fBOPTIONS\fR summary above. |
| 318 | Any other command-line arguments besides these are passed through |
| 319 | to the application using the \fBargc\fR and \fBargv\fR variables |
| 320 | described later. |
| 321 | |
| 322 | .SH "APPLICATION NAME AND CLASS" |
| 323 | .PP |
| 324 | The name of the application, which is used for purposes such as |
| 325 | \fBsend\fR commands, is taken from the \fB\-name\fR option, |
| 326 | if it is specified; otherwise it is taken from \fIfileName\fR, |
| 327 | if it is specified, or from the command name by which |
| 328 | \fBwish\fR was invoked. In the last two cases, if the name contains a ``/'' |
| 329 | character, then only the characters after the last slash are used |
| 330 | as the application name. |
| 331 | .PP |
| 332 | The class of the application, which is used for purposes such as |
| 333 | specifying options with a \fBRESOURCE_MANAGER\fR property or .Xdefaults |
| 334 | file, is the same as its name except that the first letter is |
| 335 | capitalized. |
| 336 | |
| 337 | .SH "VARIABLES" |
| 338 | .PP |
| 339 | \fBWish\fR sets the following Tcl variables: |
| 340 | .TP 15 |
| 341 | \fBargc\fR |
| 342 | Contains a count of the number of \fIarg\fR arguments (0 if none), |
| 343 | not including the options described above. |
| 344 | .TP 15 |
| 345 | \fBargv\fR |
| 346 | Contains a Tcl list whose elements are the \fIarg\fR arguments |
| 347 | that follow a \fB\-\|\-\fR option or don't match any of the |
| 348 | options described in OPTIONS above, in order, or an empty string |
| 349 | if there are no such arguments. |
| 350 | .TP 15 |
| 351 | \fBargv0\fR |
| 352 | Contains \fIfileName\fR if it was specified. |
| 353 | Otherwise, contains the name by which \fBwish\fR was invoked. |
| 354 | .TP 15 |
| 355 | \fBgeometry\fR |
| 356 | If the \fB\-geometry\fR option is specified, \fBwish\fR copies its |
| 357 | value into this variable. If the variable still exists after |
| 358 | \fIfileName\fR has been evaluated, \fBwish\fR uses the value of |
| 359 | the variable in a \fBwm geometry\fR command to set the main |
| 360 | window's geometry. |
| 361 | .TP 15 |
| 362 | \fBtcl_interactive\fR |
| 363 | Contains 1 if \fBwish\fR is reading commands interactively (\fIfileName\fR |
| 364 | was not specified and standard input is a terminal-like |
| 365 | device), 0 otherwise. |
| 366 | |
| 367 | .SH "SCRIPT FILES" |
| 368 | .PP |
| 369 | If you create a Tcl script in a file whose first line is |
| 370 | .CS |
| 371 | \fB#!/usr/local/bin/wish\fR |
| 372 | .CE |
| 373 | then you can invoke the script file directly from your shell if |
| 374 | you mark it as executable. |
| 375 | This assumes that \fBwish\fR has been installed in the default |
| 376 | location in /usr/local/bin; if it's installed somewhere else |
| 377 | then you'll have to modify the above line to match. |
| 378 | Many UNIX systems do not allow the \fB#!\fR line to exceed about |
| 379 | 30 characters in length, so be sure that the \fBwish\fR executable |
| 380 | can be accessed with a short file name. |
| 381 | .PP |
| 382 | An even better approach is to start your script files with the |
| 383 | following three lines: |
| 384 | .CS |
| 385 | \fB#!/bin/sh |
| 386 | # the next line restarts using wish \e |
| 387 | exec wish "$0" "$@"\fR |
| 388 | .CE |
| 389 | This approach has three advantages over the approach in the previous |
| 390 | paragraph. First, the location of the \fBwish\fR binary doesn't have |
| 391 | to be hard-wired into the script: it can be anywhere in your shell |
| 392 | search path. Second, it gets around the 30-character file name limit |
| 393 | in the previous approach. |
| 394 | Third, this approach will work even if \fBwish\fR is |
| 395 | itself a shell script (this is done on some systems in order to |
| 396 | handle multiple architectures or operating systems: the \fBwish\fR |
| 397 | script selects one of several binaries to run). The three lines |
| 398 | cause both \fBsh\fR and \fBwish\fR to process the script, but the |
| 399 | \fBexec\fR is only executed by \fBsh\fR. |
| 400 | \fBsh\fR processes the script first; it treats the second |
| 401 | line as a comment and executes the third line. |
| 402 | The \fBexec\fR statement cause the shell to stop processing and |
| 403 | instead to start up \fBwish\fR to reprocess the entire script. |
| 404 | When \fBwish\fR starts up, it treats all three lines as comments, |
| 405 | since the backslash at the end of the second line causes the third |
| 406 | line to be treated as part of the comment on the second line. |
| 407 | .PP |
| 408 | .VS 8.4 |
| 409 | The end of a script file may be marked either by the physical end of |
| 410 | the medium, or by the character, '\\032' ('\\u001a', control-Z). |
| 411 | If this character is present in the file, the \fBwish\fR application |
| 412 | will read text up to but not including the character. An application |
| 413 | that requires this character in the file may encode it as |
| 414 | ``\\032'', ``\\x1a'', or ``\\u001a''; or may generate it by use of commands |
| 415 | such as \fBformat\fR or \fBbinary\fR. |
| 416 | .VE |
| 417 | .SH PROMPTS |
| 418 | .PP |
| 419 | When \fBwish\fR is invoked interactively it normally prompts for each |
| 420 | command with ``\fB% \fR''. You can change the prompt by setting the |
| 421 | variables \fBtcl_prompt1\fR and \fBtcl_prompt2\fR. If variable |
| 422 | \fBtcl_prompt1\fR exists then it must consist of a Tcl script |
| 423 | to output a prompt; instead of outputting a prompt \fBwish\fR |
| 424 | will evaluate the script in \fBtcl_prompt1\fR. |
| 425 | The variable \fBtcl_prompt2\fR is used in a similar way when |
| 426 | a newline is typed but the current command isn't yet complete; |
| 427 | if \fBtcl_prompt2\fR isn't set then no prompt is output for |
| 428 | incomplete commands. |
| 429 | |
| 430 | .SH KEYWORDS |
| 431 | shell, toolkit |