tix/man/tixwish.1

   1 '\"
   2 '\" Copyright (c) 1996, Expert Interface Technologies
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 '\" The file man.macros and some of the macros used by this file are
   8 '\" copyrighted: (c) 1990 The Regents of the University of California.
   9 '\"              (c) 1994-1995 Sun Microsystems, Inc.
  10 '\" The license terms of the Tcl/Tk distrobution are in the file
  11 '\" license.tcl.
  12 .so man.macros
  13 .HS wish tixcmds 4.0
  14 .BS
  15 '\" Note:  do not modify the .SH NAME line immediately below!
  16 '
  17 .SH NAME
  18 tixwish \-  Windowing shell for interpreting Tix commands.
  19 '
  20 .SH SYNOPSIS
  21 \fBtixwish\fR ?\fIfileName arg arg ...\fR?
  22 '
  23 .SH OPTIONS
  24 '
  25 .IP "\fB\-display \fIdisplay\fR" 20
  26 Display (and screen) on which to display window.
  27 '
  28 .IP "\fB\-geometry \fIgeometry\fR" 20
  29 Initial geometry to use for window.  If this option is specified, its
  30 value is stored in the \fBgeometry\fR global variable of the application's
  31 Tcl interpreter.
  32 '
  33 .IP "\fB\-name \fIname\fR" 20
  34 '
  35 Use \fIname\fR as the title to be displayed in the window, and
  36 as the name of the interpreter for \fBsend\fR commands.
  37 '
  38 .IP "\fB\-sync\fR" 20
  39 '
  40 Execute all X server commands synchronously, so that errors are
  41 reported immediately. This will result in much slower execution, but
  42 it is useful for debugging.
  43 .BE
  44
  45 .SH DESCRIPTION
  46 .PP
  47 \fBTixwish\fR is a simple program consisting of the Tcl command
  48 language, the Tk toolkit, and a main program that reads commands from
  49 standard input or from a file.  It creates a main window and then
  50 processes Tcl commands.
  51 '
  52 If \fBtixwish\fR is invoked with no arguments, or with a first
  53 argument that starts with ``\-'', then it reads Tcl commands
  54 interactively from standard input.
  55 '
  56 It will continue processing commands until all windows have been
  57 deleted or until end-of-file is reached on standard input.  If there
  58 exists a file \fB.tixwishrc\fR in the home directory of the user,
  59 \fBtixwish\fR evaluates the file as a Tcl script just before reading
  60 the first command from standard input.
  61 '
  62 .PP
  63 '
  64 If \fBtixwish\fR is invoked with an initial \fIfileName\fR argument,
  65 then \fIfileName\fR is treated as the name of a script file.
  66 \fBTixwish\fR will evaluate the script in \fIfileName\fR (which
  67 presumably creates a user interface), then it will respond to events
  68 until all windows have been deleted.  Commands will not be read from
  69 standard input.  There is no automatic evaluation of \fB.tixwishrc\fR
  70 in this case, but the script file can always \fBsource\fR it if
  71 desired.
  72
  73 .SH "OPTIONS"
  74 .PP
  75 \fBTixwish\fR automatically processes all of the command-line options
  76 described in the \fBOPTIONS\fR summary above.  Any other command-line
  77 arguments besides these are passed through to the application using
  78 the \fBargc\fR and \fBargv\fR variables described later.
  79
  80 .SH "APPLICATION NAME AND CLASS"
  81 .PP
  82 .VS
  83 The name of the application, which is used for purposes such as
  84 \fBsend\fR commands, is taken from the \fB\-name\fR option,
  85 if it is specified;  otherwise it is taken from \fIfileName\fR,
  86 if it is specified, or from the command name by which
  87 \fBtixwish\fR was invoked.  In the last two cases, if the name contains a ``/''
  88 character, then only the characters after the last slash are used
  89 as the application name.
  90 .PP
  91 The class of the application, which is used for purposes such as
  92 specifying options with a \fBRESOURCE_MANAGER\fR property or .Xdefaults
  93 file, is the same as its name except that the first letter is
  94 capitalized.
  95 .VE
  96
  97 .SH "VARIABLES"
  98 .PP
  99 \fBTixwish\fR sets the following Tcl variables:
 100 .TP 15
 101 \fBargc\fR
 102 Contains a count of the number of \fIarg\fR arguments (0 if none),
 103 not including the options described above.
 104 .TP 15
 105 \fBargv\fR
 106 Contains a Tcl list whose elements are the \fIarg\fR arguments (not
 107 including the options described above), in order, or an empty string
 108 if there are no \fIarg\fR arguments.
 109 .TP 15
 110 \fBargv0\fR
 111 Contains \fIfileName\fR if it was specified.
 112 Otherwise, contains the name by which \fBtixwish\fR was invoked.
 113 .TP 15
 114 \fBgeometry\fR
 115 If the \fB\-geometry\fR option is specified, \fBtixwish\fR copies its
 116 value into this variable.  If the variable still exists after
 117 \fIfileName\fR has been evaluated, \fBtixwish\fR uses the value of
 118 the variable in a \fBwm geometry\fR command to set the main
 119 window's geometry.
 120 .TP 15
 121 \fBtcl_interactive\fR
 122 '
 123 Contains 1 if \fBtixwish\fR is reading commands interactively
 124 (\fBfileName\fR was not specified and standard input is a
 125 terminal-like device), 0 otherwise.
 126 '
 127 .SH "X RESOURCES"
 128 '
 129 \fBTixwish\fR makes use of several X Resources to determine the
 130 \fBToolkit Options\fR for the Tix library. These X resources must be
 131 set using \fBRESOURCE_MANAGER\fR properties or .Xdefaults files
 132 \fBbefore\fR \fBtixwish\fR starts running. These resources must be
 133 associated with the main window of the \fBtixwish\fR application.
 134 These options include:
 135 '
 136 '----------BEGIN
 137 .LP
 138 .nf
 139 Name:           \fBtixScheme\fR
 140 Class:          \fBTixScheme\fR
 141 .fi
 142 .IP
 143 Specifies the color scheme to use for the Tix application. Currently
 144 only these schemes are supported: Blue, Gray, SGIGray, TixGray, and
 145 TK.
 146 '----------END
 147 '
 148 '----------BEGIN
 149 .LP
 150 .nf
 151 Name:           \fBtixFontSet\fR
 152 Class:          \fBTixFontSet\fR
 153 .fi
 154 .IP
 155 Specifies the FontSet to use for the Tix application. A FontSet
 156 designates the fonts to use for different types of widgets. Currently
 157 only these FontSets are supported: 12Point, 14Point and TK.
 158 '----------END
 159 .PP
 160 For example, you may put these two lines in your .Xdefaults file
 161 .nf
 162     *tixwish.tixScheme: Gray
 163     *tixwish.tixFontSet: 12Point
 164 .fi
 165 .SH "SCRIPT FILES"
 166 .PP
 167 If you create a Tcl script in a file whose first line is
 168 .DS
 169 \fB#!/usr/local/bin/tixwish\fR
 170 .DE
 171 then you can invoke the script file directly from your shell if you
 172 mark it as executable.  This assumes that \fBtixwish\fR has been
 173 installed in the default location in /usr/local/bin; if it's installed
 174 somewhere else then you'll have to modify the above line to match.
 175 Many UNIX systems do not allow the \fB#!\fR line to exceed about 30
 176 characters in length, so be sure that the \fBtixwish\fR executable can be
 177 accessed with a short file name.
 178
 179 .SH PROMPTS
 180 .PP
 181 When \fBtixwish\fR is invoked interactively it normally prompts for each
 182 command with ``\fB% \fR''.  You can change the prompt by setting the
 183 variables \fBtcl_prompt1\fR and \fBtcl_prompt2\fR.  If variable
 184 \fBtcl_prompt1\fR exists then it must consist of a Tcl script to
 185 output a prompt; instead of outputting a prompt \fBtixwish\fR will
 186 evaluate the script in \fBtcl_prompt1\fR.  The variable
 187 \fBtcl_prompt2\fR is used in a similar way when a newline is typed but
 188 the current command isn't yet complete; if \fBtcl_prompt2\fR isn't set
 189 then no prompt is output for incomplete commands.
 190
 191 .SH KEYWORDS
 192 shell, wish, Tk, toolkit