butterrc.5

.\" Text automatically generated by txt2man
.TH butter 5 "06 January 2016" "" ""
.SH NAME
\fBbutterrc \fP- butter configuration
\fB
.SH SYNOPSIS
.nf
.fam C
  \fBSet\fP \fIsome\fP \fIglobal\fP \fIvariables\fP \fIfor\fP butter.

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
butterrc is a bash shell script that will be sourced after butter sets its
built-in \fIglobal\fP \fIvariables\fP.
.SH PATHS
butter_root
.PP
.nf
.fam C
      This is where your btrfs root should be mounted.

      default value is /mnt/butter.

.fam T
.fi
butter_host
.PP
.nf
.fam C
      This will identify your host in the $butter_root folder.

      default value is either:
        o The value of /etc/machine-id; should the file exist
        o The output of `uname -n`

.fam T
.fi
.SH PROPERTIES
butter_prop_prefix
.PP
.nf
.fam C
      This will be used for all properties used by butter.  It must begin with
      "^user." (see xattr(7)).

      default value is "user.be.popho.butter"

.fam T
.fi
default_max_snapshots
.PP
.nf
.fam C
      This number is the default number of snapshots to keep for any given
      subvolume.  If there are no specific instructions given to butter(8)
      while snapshotting, this number will be used.

      default value is "5"

.fam T
.fi
default_rm_snapshots
.PP
.nf
.fam C
      This number is the default number of snapshots to remove when using
      `butter snapremove`, if no specific instructions are given.

      default value is "1"

.fam T
.fi
butter_prop_array
.PP
.nf
.fam C
      This array contains a list of allowed properties to set on the different
      subvolumes that butter will handle.