Using the Command Line Client › Invoke the Command-line Client

Invoke the Command-line Client

The Build Tool Command-line Client is invoked using the following command syntax:

Windows

%GENxx%gen\bldtool.bat -c COMMAND

Or

%GENxx%gen\bldtool.bat -c COMMAND [options]

Note: xx refers to the current release of CA Gen. For the current release number, see the Release Notes.

UNIX or Linux

$IEFH/bt/bldtool -c COMMAND

Or

$IEFH/bt/bldtool -c COMMAND [options]

There are two ways to invoke the Command-line Client, depending on whether you want to provide options:

• When no options are passed when invoked, enter the interactive mode of the Command-line Client. You can enter various commands, as described later in this section.
• When options are passed during the invocation, processing takes place based on these options, and control returns after the processing is completed. This is known as the batch mode.

The options when invoking the Command-line Client are as follows:

-c

Interface Type: One of COMMAND, CLIENT, or SERVER. Use COMMAND to invoke the Command-line Client.

Default: CLIENT

-a

Action to perform: BUILD, CLEAN, SPLIT, SHUTDOWN, STATUS, or HELP. This is a required option. Batch only.

Default: None

Note: SHUTDOWN is the only action that can be used for a remote Build Tool server.

-n

Specifies the ICM or RMT file to process.

Default: All ICM and RMT modules either in the current path or the path that is specified by the –l parameter.

-l

Specifies the path (location) used to locate the specified ICM or RMT file to process. The -l parameter must be delimited with double quotes if the path contains spaces. Use of "." (unquoted) is acceptable and is translated to represent the current directory. An environment variable, set to such a location, can also be used.

Default: None

-d

Specifies the dialect to use. If not present, the default is US English.

Default: None (US English)

Important! When building a generated application with dialects, do not modify the default profile manager target location tokens. They must remain set to MODELDIR.

-r

Specifies the name of a remote host machine (UNIX, Linux, or Windows) that is used to perform remote processing. The Build Tool server must be running on this machine before invoking a processing command. Parameters -u and -p are also required. This parameter accepts both IPv4 and IPv6 host names, and is used only for the SHUTDOWN action.

Default: None

-u

Specifies the User ID for the remote host machine referred to with the -r parameter. This parameter must accompany the -p parameter, and is used only for the SHUTDOWN action.

Default: None

-p

Specifies the password for the remote host machine referred to with the -r parameter. This parameter must accompany the -u parameter, and is used only for the SHUTDOWN action.

Default: None

-i

Specifies the port number for the Build Tool Server on a remote host referred to with the -r parameter, and is used only for the SHUTDOWN action.

Default: 7776

-f

Specifies the user profile to use when processing. This user profile must be previously set up using the Build Tool GUI Client and resides in the $HOME directory (UNIX and Linux) or under the %USERPROFILE% directory (Windows). The profile file is case-sensitive.

Default: Default Profile

Use these options (in addition to -c COMMAND) to invoke the Build Tool Command-line Client through a batch command procedure. When invoked in this manner, the set of options is passed directly to the Build Tool and processing is initiated sequentially. After the processing is complete, the control returns to the calling command procedure.