Common Flag Arguments

The following flag arguments may be used with any command line API call.

‑c FUNC

This flag identifies the API function to execute, and is required for all calls.

‑D 

This flag indicates that when the API function executes, additional debug information may be written to standard error.

‑R sPath

This flag specifies the path to the root of the TopLeaf repository. If this flag is not present, TopLeaf uses the rules described in “Repository Location” to select the TopLeaf repository.

‑v

This flag causes version information to be written to standard output. When this flag is present all other arguments are ignored, and tlapi exits immediately.

The output is in the form

tlapi VERS BN BD mailbox@turnkey.com.au

where VERS is the version, BN is the build number and BD is the build date.

‑x

This flag indicates that extended status information will be written to standard output.

The output is in the form

tlapi: code exit status

where code is 0 for success or one of the status codes listed in Status Codes.

‑X

This flag indicates that a status message will be written to standard output.

The output is in the form

tlapi: message

where message is either “Success” or one of the messages listed in Status Codes.