diff --git a/btrbk.conf.example b/btrbk.conf.example index 5049c63..ecf91e2 100644 --- a/btrbk.conf.example +++ b/btrbk.conf.example @@ -1,6 +1,19 @@ +# # Example btrbk configuration file +# +# Note that the options can be overridden in the +# volume/subvolume/target sections. Refer to man btrbk.conf(5) for a +# more detailed explanation of this. +# -# Create snapshot into subdirectory +# Directory in which the btrfs snapshots are created. Relative to +# of the volume section. +# If not set, the snapshots are directly created in: +# / +# +# NOTE: btrbk does not autmatically create this directory, and the +# snapshot creation will fail if it is not present. +# snapshot_dir _btrbk_snap # Always create snapshots, even if the target volume is unreachable @@ -40,18 +53,23 @@ receive_log no # -# Volume section: "volume " -# : Directory of a btrfs volume (or subvolume) containing the -# subvolume to be backuped (usually the mount-point of a -# btrfs filesystem mounted with subvolid=0 option) +# Volume section: "volume " +# Directory of a btrfs volume (or subvolume) +# containing the subvolume to be backuped +# (usually the mount-point of a btrfs filesystem +# mounted with subvolid=0 option) # -# Subvolume section: "subvolume -# : Subvolume to be backuped, relative to in -# volume section +# Subvolume section: "subvolume + +# Subvolume to be backuped, relative to +# in volume section # -# Target section: "target " -# : Backup type, currently only "send-receive" -# : Directory of a btrfs volume (or subvolume) receiving the backups +# Target section: "target " + +# Backup type, currently only "send-receive" + +# Directory of a btrfs volume (or subvolume) +# receiving the backups # # # NOTE: The parser does not care about indentation, this is only for