D.1 Running the Command-Line Utilities

Run the command-line utilities while logged in as the user and group where Calendar Server is running, or as root. This was specified during installation; the defaults are icsuser and icsgroup.

For example, if your Calendar Server base directory is cal-svr-base, to run the cscal utility list command, you would do the following after logging in:

cd cal-svr-base/SUNWics5/cal/sbin
./cscal list

D.1.1 Syntax for Command-Line Utilities

Calendar Server command-line utilities use the following syntax:

utility [ -option [value]] command [target]

where:

utility is the executable name of the utility, such as cscal or csuser.

option determines which action the command performs. Options are in lowercase and preceded by a hyphen (-), such as -d. An option enclosed in brackets ([]) is optional. If indicated, of two or more options can be used at the same time.

value further qualifies the action specified by option, such as a description used with the -d option. A value enclosed in brackets ([]) is optional. Values that include spaces must be enclosed in quotation marks (" "). Multiple values must be enclosed in quotation marks (""), and each value must be separated by a space, unless indicated otherwise, such as the use of a semicolon delimited list.

command is an action the utility performs such as list or create. Commands separated by a vertical bar (|) indicate that either one (but not both) can be used at the same time.

target is the object on which the command takes effect, such as a calendar ID or user ID.

D.1.2 Usage Rules for Command-Line Utilities

The following rules are general usage guidelines for the command line utilities:

• If you specify only the utility name, it lists all commands, options, and several examples.

• If you do not specify a required password, the utility prompts you for it.

• The -v (verbose) and -q (quiet) options are available for each utility.

• If a command is dangerous (that is, one that could cause a data loss), the utility prompts for confirmation before executing the command. Examples of dangerous commands are cscal, which can delete a calendar, and csuser, which can delete a user. The -q (quiet) option, however, disables confirmation prompting.

• The version command is available for each utility.

D.1.3 Return Code in Scripts

If you run the command-line utilities from a script, the return code is “0” if the utility run successfully or “-1” for a failure.