The htarrc file contains settings that are read during HTAR initialization.  The HPSS administrator may optionally create a global htarrc file that is read by all HTAR clients on a machine, and users may optionally create a private file in $HOME/.htarrc.

In general, settings that are in the user's private .htarrc file override settings that in the global htarrc file, and command line options override all htarrc settings.  

HTARRC File Structure

[Note: this information is relevant to HTAR Version 6.0 and beyond]

The htarrc file consists of comment lines and declarations.

Comment lines are lines that are empty or that begin with a sharp sign "#" or a semicolon ";" as the first non-whitespace character of the line. 

Parameter Line Format

Parameter lines are of the form



        key = value

keyword and key are case-insensitve.

Whitespace preceding and following the "=" is optional.

If value is a string, it is enclosed in either single or double quotes.

Comments starting with "#" or ";" may optionally follow value on a parameter line.

Any other tokens on a line after value are ignored with a warning message.

Parameters are listed in the following table.  

For YES/NO values, the option  may be specified as any of the following case-insensitive values, without the quotes:

      "y", "yes", "t", "true", "on" : sets the value to TRUE (enabled)

      "n", "no", "f", "false", "off" : sets the value to FALSE (disabled)

For UINT32 values, the option is specified as an unsigned 32-bit integer, with any of the standard suffixes (shown below). Values > 32 bits are silently truncated with no warning).

For UINT64 values, the option is specified as an unsigned 64-bit integer, with any of the standard suffixes:

   K, KB: kibibytes (10241)  

   K, KB: kibibytes (10241)
   M, MB: mebibytes (10242)
   G, GB: gibibytes (10243)
   T, TB: tebibytes (10244)
   P, PB: pebibytes (10245)
   X, XB: exbibytes (10246)

For PATHNAME values, the option is specified as a string, which is treated as a template, optionally containing tokens of the form "%X", which are expanded as follows:

    %H  : user's home directory

    %N  : local hostname, as returned by the gethostbyname system call

    %P  : the current process ID, as returned by the getpid system call

    %U  : login name, as returned by the getpwuid system call

For STRING values, the option is a single or double-quoted string.  The quotes are removed ; if the string contains a quote of the same type as the beginning quote (single or double), it may be backslash quoted, e.g. "here's a \"double quoted string\"".  For readability, it's normally better to just use a single quote for strings containing double quotes, or vice-versa.

(Options that are not yet implemented are for planned features that currently have not been designed; options that are marked as currently unused are currently only partially implemented and may be enabled in a short term future version).

Keyword Option Type Default: Explanation
AbortOnOversizeFile YES/NO (not yet implemented)
AbortOnLongPathnames YES/NO (not yet implemented)
AbortOnMemberFileMissing YES/NO (not yet implemented)
AbortOnMemberFileReadError YES/NO (not yet implemented)
AbortOnMemberFileWriteError YES/NO (not yet implemented)
DisplayExcludedObjects YES/NO (YES) If YES, htar will display objects that are excluded during the initial scan of a "create" operation
okfile PATHNAME currently unused
exfile PATHNAME currently unused
statefile PATHNAME currently unused
disable_gets YES/NO (NO) If YES, causes HTAR to abort for any operation involving HPSS reads, including index file I/O
read_disable_msg STRING "Read operations disabled until further notice - see site wiki for more info"
disable_puts YES/NO (NO) If YES, causes HTAR to abort for any operation involving HPSS writes,including index file I/O
write_disable_msg STRING "Write operations disabled until further notice - see site wiki for more info"
max_archive_size UINT64 (not yet implemented)
max_member_files UINT32 (not yet implemented)
max_family_members UINT32 (not yet implemented)