IBM Tivoli Storage Manager, Version 7.1

Setting options in the client options file

This section describes how to set options in your client options file, and how to use options with commands.

To set an option in this file, enter the option name and one or more blank spaces, followed by the option value.

Windows operating systems To view or modify the options file, click Edit > Preferences from the Tivoli® Storage Manager client GUI. The Preferences editor updates the client options file.

Mac OS X operating systems AIX operating systems HP-UX operating systems Linux operating systems Oracle Solaris operating systems To view or modify an options file, click Edit > Preferences from the Tivoli Storage Manager client Java™ GUI. The Preferences editor updates the client system-options file or client user-options file.

Important: For Mac OS X, the system-options file must be a plain text file, encoded as Unicode (UTF-8). By default, TextEdit does not save files as plain text. Select Format > Make PlainText to save the user-options file as a plain text file. Set the Plain Text Encoding: to Unicode (UTF-8). Do not add the .txt extension.

You can use the query options command to display all or part of your options and their current settings. This command accepts an argument to specify a subset of options. The default is to display all options.

You can also edit an options file with your favorite text editor.

To set an option in your client options file, enter the option name and one or more blank spaces, followed by the option value. For example:

   compression  yes
   nodename     client_a

Some options consist of only the option name, such as verbose and quiet. You can enter the entire option name or its abbreviation. For example, you can specify the verbose option as either of the following:

   verbose
   ve

Windows operating systems Follow these additional rules when entering options in your client options file (dsm.opt):

Mac OS X operating systems AIX operating systems HP-UX operating systems Linux operating systems Oracle Solaris operating systems Follow these additional rules when entering options in your client user-options file (dsm.opt):

Begin each comment with an asterisk (*) as the first character in a line.
Do not enter comments on the same line as an option.
Optionally, indent options with spaces or tabs.
Enter each option on a separate line and enter all parameters for an option on the same line.
Enter each option on a separate line and enter all parameters for an option on the same line. For example, to specify a group of five different file systems as your default client domain, enter one of the following:
```
   domain /home /mfg /planning /mrkting /mgmt
   Domain / /Volumes/fs2 /Volumes/fs2 /Volumes/fs3 /Volumes/fs4
```
Enter one or more blank spaces between parameters.
On AIX, Mac OS, HP-UX, and Solaris, the maximum number of characters for a file name is 255. The maximum combined length of the file name and path name is 1024 characters. The Unicode representation of a character can occupy several bytes, so the maximum number of characters that a file name might contain can vary.

On Linux, the maximum length for a file name is 255 bytes. The maximum combined length of both the file name and path name is 4096 bytes. This matches the PATH_MAX that is supported by the operating system. The Unicode representation of a character can occupy several bytes, so the maximum number of characters that comprises a path and file name can vary. The limitation is the number of bytes in the path and file components, which might or might not correspond to an equal number of characters.
On Windows, the maximum number of bytes for a file name and file path combined is 5192. However, the file name itself cannot exceed 255 bytes and the path leading to the file cannot exceed 5192 bytes. Furthermore, directory names, including the directory delimiter, within a path are limited to 255 bytes. The Unicode representation of a character can occupy several bytes, so the maximum number of characters that a file name might contain can vary.
For more information about file path names and limits, refer to Table 1.

For archive or retrieve operations, the maximum length that you can specify for a path and file name, combined, remains at 1024 bytes.

Table 1. File path and name limits
	`Path`	`File name`
`MBCS encoding`	`New limit Legacy limit`	`Limit`
`1`	`5192 1016`	`255`
`2`	`4092 508`	`127`
`3`	`2728 338`	`85`

Windows operating systems In the table, MBCS encoding has these meanings:

Basic Latin: For example, standard US English characters, numbers, symbols, and control characters that are traditionally represented in 7-bit ASCII have a 1:1 ratio of bytes to characters.
Latin extensions: For example, Latin characters with tildes, grave or acute accents, and so on, as well as Greek, Coptic, Cyrillic, Armenian, Hebrew and Arabic characters typically have a 2:1 ratio of bytes to characters.
Chinese, Japanese, Korean, Vietnamese: These characters and other East Asian language characters typically have a 3:1 ratio of bytes to characters.

Mac OS X operating systems AIX operating systems HP-UX operating systems Linux operating systems Oracle Solaris operating systems If you update the client user-options file while a session is active, you must restart the session to pick up the changes.

Windows operating systems If you update the client options file while a session is active, you must restart the session to pick up the changes. If you use the Setup wizard to make changes, the changes are effective immediately. If you are not using the TSM Client Acceptor to manage the scheduler, you must also restart the scheduler.

You can use the query options command to display all or part of your options and their current settings. The default is to display all options.

Feedback