home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / wish.1 < prev    next >
Encoding:
Text File  |  1993-07-07  |  3.9 KB  |  99 lines
  1. '\"
  2. '\" Copyright (c) 1991 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/wish.1,v 1.8 93/07/07 11:32:35 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .so man.macros
  24. .HS wish tkcmds
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. wish \- Simple windowing shell
  29. .SH SYNOPSIS
  30. \fBwish\fR ?\fIoptions\fR? ?\fIarg arg ...\fR?
  31. .SH OPTIONS
  32. .IP "\fB\-display \fIdisplay\fR" 15
  33. Display (and screen) on which to display window.
  34. .IP "\fB\-file \fIfileName\fR" 15
  35. Read commands from \fIfileName\fR rather than standard input.  The
  36. last element in \fIfileName\fR will be used as the title for the
  37. application and name of its interpreter for \fBsend\fR
  38. commands (unless overridden by the \fB\-name\fR option\fR).
  39. .IP "\fB\-geometry \fIgeometry\fR" 15
  40. Initial geometry to use for window.
  41. .IP "\fB\-name \fIname\fR" 15
  42. Use \fIname\fR as the title to be displayed in the window, and
  43. as the name of the interpreter for \fBsend\fR commands.
  44. .IP "\fB\-sync\fR" 15
  45. Execute all X server commands synchronously, so that errors
  46. are reported immediately.  This will result in much slower
  47. execution, but it is useful for debugging.
  48. .IP "\fB\-help\fR" 15
  49. Print a summary of the command-line options and exit.
  50. .BE
  51.  
  52. .SH DESCRIPTION
  53. .PP
  54. \fBWish\fR is a simple program consisting of the Tcl command
  55. language, the Tk toolkit, and a main program that reads commands
  56. from standard input or from a file.
  57. It creates a main window and then processes Tcl commands.
  58. If \fBwish\fR is invoked with no \fB\-f\fR option then it
  59. reads Tcl commands interactively from standard input.
  60. It will continue processing commands until all windows have been
  61. deleted or until end-of-file is reached on standard input.
  62. .PP
  63. If the \fB\-file\fR option is provided to Tk, then \fBwish\fR reads Tcl
  64. commands from the file named in the \fB\-file\fR option.  These
  65. commands will normally create an interactive interface consisting
  66. of one or more widgets.  When the end of the command file is
  67. reached, \fBwish\fR will continue to respond to X events until
  68. all windows have been deleted.
  69. .PP
  70. \fBWish\fR sets the following Tcl variables to describe its
  71. command-line arguments, not including the command-line options
  72. listed above:
  73. .TP
  74. \fBargc\fR
  75. Contains a count of the number of \fIarg\fR arguments (0 if none).
  76. .TP
  77. \fBargv\fR
  78. Contains a Tcl list whose elements are the \fIarg\fR arguments,
  79. in order, or an empty string if there are no \fIarg\fR arguments.
  80. .TP
  81. \fBargv0\fR
  82. .VS
  83. Contains \fIfileName\fR if it was specified.
  84. Otherwise, contains the name by which \fBwish\fR was invoked.
  85. .VE
  86. .PP
  87. If you create a Tcl script in a file whose first line is
  88. .DS
  89. \fB#!/usr/local/bin/wish -f
  90. .DE
  91. then you can invoke the script file directly from your shell if
  92. you mark it as executable.
  93. This assumes that \fBwish\fR has been installed in the default
  94. location in /usr/local/bin;  if it's installed somewhere else
  95. then you'll have to modify the above line to match.
  96.  
  97. .SH KEYWORDS
  98. shell, toolkit
  99.