STOREBA...TEBACKUP(1)

📦 version 3.5.2, in nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

🎀 STOREBA...TEBACKUP — storeBackupUpdateBackup.pl 🎀

okay bestie, so this is storeBackupUpdateBackup.pl, and it lives in the User Contributed Perl Documentation section of your manual, section 1. it's the little cleanup gremlin that comes in after storeBackup.pl and updates / finalizes the backups that script made — specifically the ones made with the --lateLink and --lateCompress options. think of it as the "closing shift" of your backup pipeline ✨

🌸 SYNOPSIS 🌸

no cap, there are four whole moods this thing can be in. here they are, verbatim:

        storeBackupUpdateBackup.pl -b backupDirectory [--autorepair]
              [--print] [--verbose] [--debug] [--lockFile] [--noCompress]
              [--progressReport number] [--checkOnly] [--copyBackupOnly]
              [--dontCopyBackup] [-A archiveDurationDeltaCache]
              [--dontDelInDeltaCache] [--createNewSeries]
              [--noWarningDiffSeriesInBackupCopy] [--maxHardLinks]
              [--logFile
               [--plusLogStdout] [--suppressTime] [-m maxFilelen]
               [[-n noOfOldFiles] | [--saveLogs]]
               [--compressWith compressprog]]

(yes the [--logFile bracket situation is exactly like that in the original — hands off, we don't fix it 💅)

        storeBackupUpdateBackup.pl --interactive --backupDir topLevlDir
              [--autorepair] [--print]
        storeBackupUpdateBackup.pl --genBackupBaseTreeConf directory
        storeBackupUpdateBackup.pl --genDeltaCacheConf directory

💀 WARNING 💀

!!! USAGE IN PARALLEL WITH storeBackup.pl CAN DESTROY YOUR BACKUPS !!!

fr fr, read that one twice. running this at the same time as storeBackup.pl can destroy your backups. that's not a vibe check, that's a warning label. 😭

✨ OPTIONS ✨

here's the whole menu, bestie — every single flag, no skips:

  • --interactive, -i — interactive mode for reparing / deleting currupted backups created with option '--lateLinks' (yes, those typos are the original's, we're keeping the lore 🫶). it's giving "sit down and decide what to do about the mess" energy.
  • --backupDir, -b — top level directory of all backups. it must exist, so don't come crying if you point it at a ghost directory 🙈
  • --autorepair, -a — repair simple inconsistencies automaticly, without requesting the action from you. lowkey the "just handle it" flag.
  • --print — print the configuration read from the configuration file, then stop. show me the receipts and dip 📋
  • --verbose, -v — verbose messages. more words, more info, more slay.
  • --debug, -d — generate detailed information about the files, with the linking information in it. deep dive mode 🔍
  • --lockFile, -L — the lock file. if one exists, new instances will finish if an old one is already running. if you set it to the same file as in storeBackup, it will prevent $prog from running in parallel to storeBackup, and the default is $lockFile.

important caveats, bestie, listen up 👑: this type of lock file does not work across multiple servers, and it is not designed to separate storeBackup.pl and storeBackupUpdateBackup.pl or any other storeBackup process in a separate PID space.

the default lock file for root is in /var/lock, and for others it's in $HOME.

  • --noCompress — maximal number of parallel compress operations, default = choosen automatically. (that spelling? original. we stan.)
  • --checkOnly, -c — do not perform any action, only check consistency. spectator mode 🍿
  • --copyBackupOnly — only do the task of replicating incremental (lateLinks) backup; no hard linking, no compression, etc.
  • --dontCopyBackup — do not do any replication task to copy incremental (lateLink) backups.
NOTE: if used on the master cache, this option disrupts the data flow for replication! ⚠️
  • --archiveDurationDeltaCache, -A — the duration after which already-in-backupCopy copied and linked backups will be deleted. this affects all series in the deltacache's processedBackups directory.

the duration has to be specified in the format 'dhms', eg. 10d4h means 10 days and 4 hours. default is 99d. (similar to option keepAll in storeBackupDel.pl)

  • --dontDelInDeltaCache — do not delete any backup in deltaCache. periodt, nothing gets yeeted. 🚫
  • --createNewSeries, -C — automatically create new series in deltaCache and the replication directory / directories. this is especially useful if you use wildcards to specify series name which should be added 'on the fly'. ✨
  • --progressReport — print progress report:
    • after each 'number' files when compressing
    • after each 'number * 1000' files when linking
    • after each 'number * 10000' files when performing chmod
  • --noWarningDiffSeriesInBackupCopy, -N — do not write a warning if there is a different set of series inside the backup copy (replication directory) than in the actual deltaCache. silence, but make it intentional 🤫
  • --maxHardLinks — maximum number of hard links to use. zero (default) means the limit depends on the file system used only.
  • --logFile, -l — logFile. Default: stdout.
  • --plusLogStdout — if you specify a log file with --logFile, you can additionally print the output to STDOUT with this flag. double the output, double the fun 💖
  • --suppressTime — suppress output of time in the logfile.
  • --maxFilelen, -m — maximal length of log file, default = 1e6.
  • --noOfOldFiles, -n — number of old log files, default = 5.
  • --saveLogs — save log files with date and time instead of deleting the old (with [-noOfOldFiles]). keep the memories 🎀
  • --compressWith — compress saved log files (e.g. with 'gzip -9'). default is 'bzip2'.
  • --genBackupBaseTreeConf — generate a template of the backup-copy configuration file for the backup directories (both source and target). template time 🌱
  • --genDeltaCacheConf — generate a template of the backup-copy configuration file for the deltaCache directory.

Copyright (c) 2008-2022 by Heinz-Josef Claes. Published under the GNU General Public License v3 or any later version.

and that's the whole page, bestie 🦋 — brought to you by perl v5.34.0, dated 2022-05-02, in that classic User Contributed Perl Documentation section. go forth, finalize those backups, and please, please don't run it in parallel with storeBackup.pl. mwah 💅💖

📦 where this page comes from