Topaz Command-Line Syntax

Previous chapter

This section presents the formal command syntax and the available command-line options.

By default the topaz command invokes an RPC executable. This is the same as specifying the -r option on the topaz command line:

topaz [ -r ] [ -q ] [ -i | -I topazini ] [ -S scriptFile ] [ -n hostName:netldiName ] [ -u useName ] [ -X caCertPaths ] [ -- other args ]

When invoked with the -L or -l option, Topaz runs in linked mode. The command line accepts additional options that apply only when starting linked version:

topaz -l | -L [ -q ] [ -i | -I topazini ] [ -S scriptFile ] [ -u useName ] [ -e exeConfig ] [ -z systemConfig ] [ -T tocSizeKB ] [ -C configParams ] [ -- other args ]

In linked topaz (topaz -l or -L), you may also login RPC sessions, as well as login a single linked session. Settings that only apply to linked sessions (-e, -z, -T, and -C) do not apply for RPC sessions started from linked topaz.

topaz can also provides usage and version information:

topaz -h | -v

-C configParams

Provides configuration parameters, in configuration file syntax, that override settings in the configuration files. Only applies to linked sessions (RPC sessions may use the -C syntax in the Gem’s NRS).

For example,



The GemStone executable configuration file. This only applies to linked sessions. See Executable Configuration File.


Displays a usage line and exits.


Ignore the initialization file, .topazini.

-I topazini

Specify a complete path and file to a topazini initialization files, and use this rather then any .topazini in the default location.


Invoke the linked version of Topaz, and do not apply any command set gemnetid that may appear in the .topazini file or a file passed in using -I.

-n hostName:netldiName

For a login using X509-Secured GemStone only, to specify the NetLDI to spawn the Gem, part of the X509-secured GemStone login parameters. The host name or IP, and the netldi name or listening port, for an X509-secured NetLDI.


Invoke the linked version of Topaz, and ignore any 'set gemnet' in topaz initialization file.


Start Topaz in quiet mode, suppressing printout of the banner and other information.


Invoke the RPC (remote procedure call) version of Topaz.

-S scriptFile

Specifies a script file that will be processed with INPUT, suppressing output except if an error occurs.

-T tocSizeKB

The GEM_TEMPOBJ_CACHE_SIZE that will be used. Overrides any settings provided in configuration files passed as arguments with the -e or -z options. Only applies to linked sessions.

-u useName

Sets the cache name, as recorded by statmonitor for viewing in VSD. This is also useful for identifying processes in OS utilities such as top or ps.


Prints version and exits.


On Windows client only; forces terminal behavior regardless of I/O device.

-X CaCertPaths

For a login using X509-Secured GemStone only, to set certificates. Requires additional infrastructure to be running, including X509-secured NetLDIs and caches. The argument must specify three paths in the defined order: cacert, chained key for user, and private key for user.

For example:

-X 'stoneCA-dev.cert.pem;DataCurator.chain.pem;DataCurator.privkey.pem'


The GemStone system configuration file (applies only to linked sessions). See System Configuration File.

-- otherArgs

Arbitrary text arguments otherArgs may be included after the “--” end of arguments marker, which must follow any of the above topaz arguments are included.


Previous chapter