DESIGN commands


PROGRAM NAME

runwksp - Execute a saved cantata workspace, with or without GUI

DESCRIPTION

The runwksp program executes a visual program, or workspace, that was previously created with cantata. The workspace to be run may be an encapsulated workspace (specify [-tb] and [-oname]) or simply a saved workspace file (specify [-i]). You are expected to be familiar with the concepts of saved workspaces, encapsulated workspace, and workspace GUI's before using runwksp; see the Visual Programming Manual or the online documentation of cantata for details on these and related subjects.

The [-hidden] argument may be used to suppress display of the visual program; it will cause runwksp to execute the visual program "invisibly". This will produce the same results as you would see if you displayed the visual program and clicked on the "Run" button to run the network. Operators will be echoed to the tty as they are executed. This is the mechanism that is used to execute an encapsultated workspace from the command line. IMPORTANT NOTE: although the display of the visual program is suppressed when the [-hidden] argument is used, you must still be on a workstation running X Windows in order to execute runwksp, as runskwp is an X Windows based application.

The [-args] argument is used to provide arguments to an encapsulated workspace. The arguments provided must be legal arguments to the encapsulated workspace, as defined by the author when the encapsulated workspace was created; note that the syntax for an encapsulated workspace can be inspected by running the encapsulated workspace with the [-U] argument. All arguments must be in proper syntax, and the argument string as a whole must be delineated with double quotation marks. For example, if an encapsulated workspace takes a string argument [-str] and an integer argument [-n], the value provided for the [-args] argument of runwksp might be of the form:
-args "-str thisisatest -n 5"
Note that the [-args] argument is not applicable when the [-i] argument is used to specify a saved workspace file; it only applies to encapsulated workspaces.

The [-showgui] argument is used to indicate that the workspace GUI associated with the encapsulated workspace is to be is to be displayed. When the workspace GUI has been displayed, you can specify the arguments to the encapsulated workspace as desired using the GUI, and click on the "Run" button of the GUI in order to execute the workspace.

The [-x], [-y], [-width], and [-height] arguments may be used to specify the (x,y) device coordinates at which the workspace will appear, as well as the width and the height of the workspace. These arguments are, of course, only applicable when the [-hidden] option is not being used. Note that when x and y have values of -1, manual placement of the workspace window is performed; when specified as values between 0 and the screen dimensions, the workspace window will pop up at the specified location.

REQUIRED ARGUMENTS

none

OPTIONAL ARGUMENTS

-args
type: string
desc: Arguments to be passed to the encapsulated workspace
default: {none}
-hidden
type: flag
desc: hide workspace; just run it
-silent
type: flag
desc: Do not echo commands to tty
-showgui
type: flag
desc: whether the display workspace gui is initially shown
-report
type: flag
desc: enable checkpoint/debug reporting
-rootwindow
type: flag
desc: run application on root window
-x
type: integer
desc: x location of GUI
default: -1
bounds: -1 < [-x] < 1000
-width
type: integer
desc: The window width
default: 512
bounds: -1 < [-width] < 1000
-y
type: integer
desc: y location of GUI
default: -1
bounds: -1 < [-y] < 1000
-height
type: integer
desc: The window height
default: 512
bounds: -1 < [-height] < 1000

Mutually Exclusive Group; if desired, specify ONE of:

-wksp
type: infile
desc: Input workspace file to be run
default: {none}
OR

ALL OF the Mutually Inclusive Group:

-tb
type: string
desc: the toolbox in which the encapsulated workspace
default: {none}
AND
-oname
type: string
desc: The encapsulated workspace object name
default: {none}

EXAMPLES

SEE ALSO

RESTRICTIONS

REFERENCES

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.