XDDTSTOOL(1)
NAME
xddtstool - A request server for xddts.
SYNOPSIS
xddtstool
DESCRIPTION
xddtstool is a program that services SoftBench requests to
connect with the xddts program. There is no user interface.
All functionality must be accessed through the message
interface.
When xddtstool first starts, it looks to see if an xddts
program is running on the same display that the xddtstool is
associated with. If an xddts program is running, the
xddtstool attempts to establish a communications channel
with it. If no appropriate xddts program is running,
xddtstool attempts to execute an xddts program and then open
a communications channel with it. After communication has
been established, xddtstool then finishes initializing and
reports itself as ready to SoftBench.
Options
In the following descriptions of the options, context refers
to the triple: host, directory, file; specifying the
environment in which xddtstool will run and/or service
requests.
xddtstool is a "NET" based tool and will honor requests from
any tool with any context (host, dir, file). Because of
this, the typical "-host", "-dir", "-file" have no meaning
to this tool. There are no other options for this tool.
xddtstool has no user interface. Access to all
functionality is through messages.
MESSAGES
The following describes the message interface supported by
the message class XDDTS for use with SoftBench Encapsulator.
See the SoftBench Encapsulator: Programmer's Guide for
information on using messages. Standard messages understood
by SoftBench tools are described in softbench(5).
The following standard request messages are recognized by
xddtstool.
Request XDDTS STATUS context
Request XDDTS ICONIFY context
Request XDDTS NORMALIZE context
Request XDDTS STATUS context
request XDDTS STOP context
When xddtstool receives a stop message, it will only request
that the xddts program terminate if the xddts program was
initiated by the xddtstool program.
In addition to the standard softbench messages, the
following message is recognized after xddtstool has
initialized and established a connection with an existing
xddts or run a subordinate xddts.
Request XDDTS DISPLAY-DEFECT context DEFECT-ID=defect-id
Notify XDDTS DISPLAY-DEFECT context DEFECT-ID=defect-id
Failure XDDTS DISPLAY-DEFECT context DEFECT-ID=defect-id error-message
This message requests the attached xddts program display the
defect whose id is specified by the "DEFECT-ID=" string in
the data field of the message. If the program is not in-use
(That is that the user is not currently updating a defect or
the program is not re-building an index) and the defect id
is located in the database, xddts will display the defect
and xddtstool will send a Notify message back to the message
server. Otherwise a Failure message will be sent.
Environment Variables
The following environment variables are used by xddts:
DDTSPATH Specifies an alternate execution path for ddts
programs. This path is used by xddtstool to find
the proper location of the xddts program if it is
not in the "normal" directory (~ddts/bin).
XDDTSMAXWAIT
The number of seconds that xddtstool will wait for
xddts to become active when initiated by
xddtstool.
SEE ALSO
xddts(1)
ClearDDTS User's Guide