Langue: en

Version: 384788 (fedora - 01/12/10)

Section: 5 (Format de fichier)


dirvish.conf - dirvish configuration file.


The dirvish.conf file provides configuration information and default values for dirvish.

The file format is fairly simple. Each option requires either a single-value or a list of values and unless otherwise indicated must be specified according to its expected type. Single value options are specified by lines of the form option: value. Options expecting list must be specified in a multi-line format as shown here where the lines specifying values are indented by any kind of whitespace even if only one value is being specified.

Each value must be provided on its own line. Any leading and trailing whitespace is discarded. Options whose names with an initial capital (ex: Foo) are discarded by dirvish itself but may be used by support utilities. Blank lines are ignored.

While this simplistic format may allow for configuration errors it allows arbitrary options to be declared that custom support scripts could use.

A # introduces a comment to the end of the line.

On startup the dirvish utilities will first load a master dirvish.conf file. /etc/dirvish.conf will be tried first but if not present /etc/dirvish/master.conf will be tried.

During installation dirvish may have been configured expect the system-wide configuration files in some location other than /etc/dirvish.

Multiple configuration files will be loaded by the and command-line options as well as the config: and client: configuration parameters. To prevent looping each configuration file can only be loaded once.


Like the command line each option may be specified any number of times. Those options that expect lists will accumulate all of their arguments and for single value options each specification will override the ones before.

Boolean values need to specified as 1 or 0 or may be specified using SET or UNSET. Some Boolean values are set by default and must be explicitly unset if unwanted.

Each option is marked here with one of (B) for Boolean, (S) single value, (L) list or (0) other.

.BI SET " option option ..." " (O)"
.BI UNSET " option option ..." " (O)"
Set or unset one or more boolean options.

NOTE: The SET and UNSET directives do not use colons <:>.

.BI RESET " option" " (O)"
Reset a list option so that it contains no values.

This may be used to start specification of the option.

NOTE: The RESET directive does not use a colon <:>.

.BR "bank:" " (L)"
Specify paths to directories containing vaults.

A bank] is a directory containing one or more vault]s. The system supports multiple bank]s so that filesystem mount-points can be managed more effectively.

When a vault] is specified the bank]s will be searched in list order until the vault] is found. This way vault]s can be moved between bank]s or added without having to update a master index.

Multiple ltiple: values will accumulate.

.BI branch: " branch_name" " (S)"
Specify a branch] to use.

A branch] is a sequence of image]s.

This also specifies a default value for reference:.

Setting this in a config file may cause the command line option to be overridden. Use edefault-default: instead.

.BI branch-default: " branch_name" " (S)"
Specify a default branch] to use.
.BI client: " [username@]client_name" " (S)"
specify a client to back up.

Setting this to the same value as hostname will cause dirvish to do a local copy and stay off the network. This automatically invokes whole-file.

The first time this parameter is set /etc/dirvish/client_name or /etc/dirvish/client_name.conf will be loaded.

.BR "checksum:" " (B)"
Force the checksum comparison of file contents even when the inode fails to indicate a change has occurred.