CUTILITY

CUTILITY has been deprecated and will no longer be updated. LWCCOM has replaced CUTILITY as the LightWave Client management CLI.

The CUTILITY program is used to perform LightWave Client management tasks from the TACL command line. The general syntax the start the CUTILITY program is:

TEXT

> run CUTILITY / run-options / command-line-options

Important

Always run CUTILITY with the --update-filesystem option after installing a new version of LightWave Client.

run-options

The standard TACL run options. Note that process does not open the IN or OUT file.

command-line-options

@<command-file>

Reads command line options from <command-file>. Options specified on the command line override any duplicates specified in the file. At most, one '@' option may used. The file itself cannot contain an '@' option (i.e., no nesting).

--api-to-ddl <api-file-name> <ddl-file-name> [!]

Generates a DDL source file from an API definition stored in an Enscribe file. Specify the '!' option to indicate that the output DDL source file should be replaced if it exists. Note that this feature became available in release 1.0.1.

--check-cf <file-name>

Validates the specified credentials file.

--clean

When items are deleted from the filesystem via the Console, they are only marked for deletion and not immediately physically deleted. Rather, the data is physically deleted over time by a housekeeping process within CONSOLE. The --clean option immediately 'cleans up' (physically deletes) any data currently marked for deletion. Use this option if you want to remove unused data from the filesystem without waiting for the housekeeping process to run.

--create-cf <output-credentials-file> [ ! ] <credentials-string> | +<credentials-input-file> | '?' [ <target-file-name> ]

Creates an encrypted LightWave Client credentials file. See Using Credentials Files for more information about credentials files. The <output-credentials-file> parameter is the name of the credentials file to create. Use the '!' character to specify that the file should be overwritten if it already exists. The input credentials may be supplied on the command line, supplied in an edit file by prefixing the name of the file with '+', or you may be prompted for the credentials by specifying '?'. When prompted, the credentials are not displayed on the terminal.

As an added security measure, the credentials file contains the name and location of the file itself. Thus, a credentials file will be invalid if renamed or moved to a new location. To create a credentials file for use in another location (e.g. another system), use <target-file-name>. When specified, the credentials file will be created such that it will be valid when copied to the target file name.

--create-filesystem

Creates a new LightWave Client filesystem in the location specified by the --filesystem option.

--export-api <api-name> <output-api-file> [!]

Exports an API definition from the filesystem to an Enscribe file. Specify the '!' option to indicate that the output Enscribe file should be replaced if it exists. Note that when using this feature, if the --filesystem option is not specified, the filesystem location is assumed to be the current subvol. Note that this feature became available in release 1.0.1.

--filesystem <subvolume-spec>

Specifies the subvolume location of the target LightWave Client filesystem. <subvolume-spec> may optionally include a volume name. A value of '*' indicates the current subvolume. The filesystem must be located on a TMF-audited volume. Refer to Managing the Filesystem for more information.

--import-api <input-api-file> < <api-name> | '*' > [!]

Imports an API definition stored in an Enscribe file into the filesystem. If '*' is specified as the API name, the API stored in the definition will be used. Specify the '!' option to indicate that an existing API with the same name should be replaced if it exists. Note that when using this feature, if the --filesystem option is not specified, the filesystem location is assumed to be the current subvol. Note that this feature became available in release 1.0.1.

--set-password <username> <password>

Overwrites the password for the named user.

--update-filesystem

Updates a LightWave Client filesystem in the location specified by the --filesystem option. The update process uses the file named CCPnnnnn (where nnnnn is a version number) in the installation subvolume to update the Console web application. If there is more than one CCPnnnnn file, the latest version is used. The update process may make the filesystem incompatible with earlier releases of LightWave Client.