tarsnap/tar/tarsnap.conf.5-mdoc.in

.\"-
.\" Copyright 2008, 2009 Colin Percival
.\" All rights reserved
.\"
.Dd @DATE@
.Dt TARSNAP.CONF 5
.Os
.Sh NAME
.Nm tarsnap.conf
.Nd configuration file for
.Xr tarsnap 1
.Sh DESCRIPTION
The
.Nm
file is read by the
.Xr tarsnap 1
utility and specifies default options which will be
ignored if the options in question are specified at
the command line.
Options may be specified in
.Pa @sysconfdir@/tarsnap.conf
and/or
.Pa ~/.tarsnaprc ;
if the two files conflict, the user's local configuration
takes precedence.
.Pp
The
.Nm
file(s) contain lines consisting of a case-sensitive option name and
zero or one parameters depending upon the option.
Empty lines and lines starting with a
.Ql #
character are ignored.
.Pp
If a parameter begins with a
.Ql ~
character, it will be replaced by the home directory of the effective user ID.
.Pp
The following options may be specified:
.Bl -tag -width "no-aggressive-networking"
.It Cm aggressive-networking
.It Cm cachedir Ar cache-dir
.It Cm checkpoint-bytes Ar bytespercheckpoint
.It Cm disk-pause Ar X
.It Cm exclude Ar pattern
.It Cm force-resources
.It Cm humanize-numbers
.It Cm include Ar pattern
.It Cm insane-filesystems
.It Cm iso-dates
.It Cm keyfile Pa key-file
.It Cm lowmem
.It Cm maxbw
.It Cm maxbw-rate
.It Cm maxbw-rate-down
.It Cm maxbw-rate-up
.It Cm nodump
.It Cm normalmem
.It Cm no-aggressive-networking
.It Cm no-config-exclude
.It Cm no-config-include
.It Cm no-disk-pause
.It Cm no-force-resources
.It Cm no-humanize-numbers
.It Cm no-insane-filesystems
.It Cm no-iso-dates
.It Cm no-maxbw
.It Cm no-maxbw-rate-down
.It Cm no-maxbw-rate-up
.It Cm no-nodump
.It Cm no-print-stats
.It Cm no-quiet
.It Cm no-retry-forever
.It Cm no-snaptime
.It Cm no-store-atime
.It Cm no-totals
.It Cm print-stats
.It Cm quiet
.It Cm retry-forever
.It Cm snaptime Pa file
.It Cm store-atime
.It Cm totals
.It Cm verylowmem
.El
.Pp
Each option is handled the same way as the corresponding
.Fl -option ;
see
.Xr tarsnap 1
for more details.
Note that the
.Cm normalmem
and
.Cm no-*
options are only useful in the user-specific
.Pa ~/.tarsnaprc
configuration file, at which point they act to override options set in the
global
.Pa @sysconfdir@/tarsnap.conf
configuration file.
.Sh FILES
.Bl -tag -width indent
.It Pa @sysconfdir@/tarsnap.conf
The system global
.Nm
configuration file.
Parameters specified here only take effect if they are not
specified via the current user's local configuration file
or via the command line.
.It Pa ~/.tarsnaprc
The
.Nm
configuration file for the current user.
Parameters specified here take effect unless they are
specified via the command line.
.El
.Sh SEE ALSO
.Xr tarsnap 1