From 8caac8724cbc729348e4952efbed9096a00109c3 Mon Sep 17 00:00:00 2001 From: Frederik Ring Date: Tue, 19 Apr 2022 21:21:23 +0200 Subject: [PATCH] Add documentation for header format option --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 02c2439..480b647 100644 --- a/README.md +++ b/README.md @@ -351,6 +351,19 @@ You can populate below template according to your requirements and use it as you # LOCK_TIMEOUT="60m" +########### HEADER FORMAT USED BY THE TAR ARCHIVE + +# By default, tar archive creation will pick a header format that is appropriate +# for the archive's contents. In case you have special requirements or need to +# work with tools that do not support all standard header formats, you can use +# this option to enforce a certain header format. Valid options are "USTAR", +# "PAX" and "GNU". Be aware that setting this value might create situations where +# it's not possible to encode the information about a certain file, making the +# backup fail. +# In case no value is set, an appropriate format will be selected for each file. + +# TAR_ARCHIVE_HEADER_FORMAT="USTAR" + ########### EMAIL NOTIFICATIONS # ************************************************************************