MAN page from Fedora 28 tk-8.6.8-1.fc28.x86_64.rpm


Section: Tk Applications (1)
Updated: 8.0



wish - Simple windowing shell 


wish ?-encoding name? ?fileName arg arg ...? 


-encoding name
Specifies the encoding of the text stored in fileName.This option is only recognized prior to the fileName argument.
-colormap new
Specifies that the window should have a new private colormap instead ofusing the default colormap for the screen.
-display display
Display (and screen) on which to display window.
-geometry geometry
Initial geometry to use for window. If this option is specified, itsvalue is stored in the geometry global variable of the application'sTcl interpreter.
-name name
Use name as the title to be displayed in the window, andas the name of the interpreter for send commands.
Execute all X server commands synchronously, so that errorsare reported immediately. This will result in much slowerexecution, but it is useful for debugging.
-use id
Specifies that the main window for the application is to be embedded inthe window whose identifier is id, instead of being created as anindependent toplevel window. Id must be specified in the sameway as the value for the -use option for toplevel widgets ( has a form like that returned by the winfo id command).
Note that on some platforms this will only work correctly if idrefers to a Tk frame or toplevel that has its-container option enabled.
-visual visual
Specifies the visual to use for the window.Visual may have any of the forms supported by the Tk_GetVisualprocedure.
Pass all remaining arguments through to the script's argvvariable without interpreting them.This provides a mechanism for passing arguments such as -nameto a script instead of having wish interpret them.



Wish is a simple program consisting of the Tcl commandlanguage, the Tk toolkit, and a main program that reads commandsfrom standard input or from a file.It creates a main window and then processes Tcl commands.If wish is invoked with arguments, then the first fewarguments, ?-encoding name? ?fileName?, specify thename of a script file, and, optionally, theencoding of the text data stored in that script file. A valuefor fileName is recognized if the appropriate argumentdoes not start with``-''.

If there are no arguments, or the arguments do not specify a fileName,then wish reads Tcl commands interactively from standard input.It will continue processing commands until all windows have beendeleted or until end-of-file is reached on standard input.If there exists a file``.wishrc''in the home directory of the user, wish evaluates the file as aTcl script just before reading the first command from standard input.

If arguments to wish do specify a fileName, then fileName is treated as the name of a script file.Wish will evaluate the script in fileName (whichpresumably creates a user interface), then it will respond to eventsuntil all windows have been deleted.Commands will not be read from standard input.There is no automatic evaluation of``.wishrc''when the name of a script file is presented on the wish command line,but the script file can always source it if desired.

Note that on Windows, the wishversion.exe program variesfrom the tclshversion.exe program in an additionalimportant way: it does not connect to a standard Windows console andis instead a windowed program. Because of this, it additionallyprovides access to its own console command. 


Wish automatically processes all of the command-line optionsdescribed in the OPTIONS summary above.Any other command-line arguments besides these are passed throughto the application using the argc and argv variablesdescribed later. 


The name of the application, which is used for purposes such assend commands, is taken from the -name option,if it is specified; otherwise it is taken from fileName,if it is specified, or from the command name by whichwish was invoked. In the last two cases, if the name contains a``/''character, then only the characters after the last slash are usedas the application name.

The class of the application, which is used for purposes such asspecifying options with a RESOURCE_MANAGER property or .Xdefaultsfile, is the same as its name except that the first letter iscapitalized. 


Wish sets the following Tcl variables:

Contains a count of the number of arg arguments (0 if none),not including the options described above.
Contains a Tcl list whose elements are the arg argumentsthat follow a -- option or do not match any of theoptions described in OPTIONS above, in order, or an empty stringif there are no such arguments.
Contains fileName if it was specified.Otherwise, contains the name by which wish was invoked.
If the -geometry option is specified, wish copies itsvalue into this variable. If the variable still exists afterfileName has been evaluated, wish uses the value ofthe variable in a wm geometry command to set the mainwindow's geometry.
Contains 1 if wish is reading commands interactively (fileNamewas not specified and standard input is a terminal-likedevice), 0 otherwise.


If you create a Tcl script in a file whose first line is

then you can invoke the script file directly from your shell ifyou mark it as executable.This assumes that wish has been installed in the defaultlocation in /usr/local/bin; if it is installed somewhere elsethen you will have to modify the above line to match.Many UNIX systems do not allow the #! line to exceed about30 characters in length, so be sure that the wish executablecan be accessed with a short file name.

An even better approach is to start your script files with thefollowing three lines:

#!/bin/sh# the next line restarts using wish \exec wish "$0" ${1+"$@"}
This approach has three advantages over the approach in the previousparagraph. First, the location of the wish binary does not haveto be hard-wired into the script: it can be anywhere in your shellsearch path. Second, it gets around the 30-character file name limitin the previous approach.Third, this approach will work even if wish isitself a shell script (this is done on some systems in order tohandle multiple architectures or operating systems: the wishscript selects one of several binaries to run). The three linescause both sh and wish to process the script, but theexec is only executed by processes the script first; it treats the secondline as a comment and executes the third line.The exec statement cause the shell to stop processing andinstead to start up wish to reprocess the entire script.When wish starts up, it treats all three lines as comments,since the backslash at the end of the second line causes the thirdline to be treated as part of the comment on the second line.

The end of a script file may be marked either by the physical end ofthe medium, or by the character,``\032''(``\u001a'', control-Z).If this character is present in the file, the wish applicationwill read text up to but not including the character. An applicationthat requires this character in the file may encode it as``\032'',``\x1a'',or``\u001a'';or may generate it by use of commands such as format or binary. 


When wish is invoked interactively it normally prompts for eachcommand with``% ''.You can change the prompt by setting thevariables tcl_prompt1 and tcl_prompt2. If variabletcl_prompt1 exists then it must consist of a Tcl scriptto output a prompt; instead of outputting a prompt wishwill evaluate the script in tcl_prompt1.The variable tcl_prompt2 is used in a similar way whena newline is typed but the current command is not yet complete;if tcl_prompt2 is not set then no prompt is output forincomplete commands. 


tclsh(1), toplevel(n), Tk_Main(3), Tk_MainLoop(3), Tk_MainWindow(3) 


application, argument, interpreter, prompt, script file, shell,toolkit, toplevel




This document was created byman2html,using the manual pages.