STOREBACKUPMOUNT(1)

πŸ“¦
version 3.5.2 Β· 3 versions
, in ubuntu stonking

🌸 STOREBACKUPMOUNT πŸ’…

okay bestie, welcome to the storeBackupMount page β€” it lives in the User Contributed Perl Documentation section, and it's genuinely one of those little scripts that does SO much heavy lifting for you. sit down, get comfy, we're doing this 🫢


✨ NAME ✨

Mounts file systems (defined in /etc/fstab) and starts storeBackup related programs.

lowkey important detail: if you're using the command line, the order of execution depends on the order of the --storeBackup* options. and if you're using the configuration file, the order of execution depends on option orderOfExecution. periodt. πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

        storeBackupMount.pl --help
or
        storeBackupMount.pl -g configFile
or
        storeBackupMount.pl -f configFile
or
        storeBackupMount.pl [-s servers] [-d] [-l logFile
               [--suppressTime] [-m maxFilelen]
               [[-n noOfOldFiles] | [--saveLogs]]
               [--compressWith compressprog]]
            [--storeBackup storeBackup-Params]
            [--storeBackupUpdateBackup storeBackupUpdateBackup-Params]
            [--storeBackupCheckBackup storeBackupCheckBackup-Params]
            [--storeBackupCheckSource storeBackupCheckSource-Params]
            [--storeBackupDel storeBackupDel-Params]
            [--printAndStop] [-k killTime] [-T tmpdir] [mountPoints...]

🌈 DESCRIPTION 🌈

so here's the whole vibe, this script does all of this, in order:

  • checks an nfs server with ping πŸ‘€
  • mounts that server via a list of mount points
  • starts storeBackup (with a config file)
  • umounts that server

it's giving "personal assistant who never sleeps" energy ngl πŸ’–


πŸŽ€ OPTIONS πŸŽ€

  • --help β€” show this help. classic. iconic. always there for you πŸ™ˆ
  • --generate, -g β€” generate a template of the configuration file. starter pack fr fr ✨
  • --file, -f β€” configuration file (instead of, or additionally to, options on the command line)
  • --servers, -s β€” name(s) or ip address(es) of the nfs server(s). ngl this option can be repeated multiple times πŸ’…
  • --debug, -d β€” generate some debug messages. for when you need the tea β˜•
  • --logFile, -l β€” logFile for this process. default is STDOUT.
  • --suppressTime β€” suppress output of time in logfile. time? never heard of her πŸ•°οΈ
  • --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]). keeping the receipts πŸ“
  • --compressWith β€” compress saved log files (e.g. with 'gzip -9'). default is 'bzip2'. heads up: this parameter is parsed like a line in the configuration file and normally has to be quoted.
  • --storeBackup β€” run storeBackup.pl. use this parameter as options for storeBackup.pl. this parameter is parsed like the line in the configuration file and normally has to be quoted, eg. '-f stbu.conf'
  • --storeBackupUpdateBackup β€” run storeBackupUpdateBackup.pl. use this parameter as options for storeBackupUpdateBackup.pl. this parameter is parsed like the line in the configuration file and normally has to be quoted, eg. '-b /backupDir'
  • --storeBackupCheckBackup β€” run storeBackupCheckBackup.pl. use this parameter as options for storeBackupCheckBackup.pl. this parameter is parsed like the line in the configuration file and normally has to be quoted, eg. '-c /backupDir'
  • --storeBackupCheckSource β€” run storeBackupCheckSource.pl. use this parameter as options for storeBackupCheckSource.pl. this parameter is parsed like the line in the configuration file and normally has to be quoted, eg. '-s /home/bob -b /backupDir'
  • --storeBackupDel β€” run storeBackupDel.pl. use this parameter as options for storeBackupDel.pl. this parameter is parsed like the line in the configuration file and normally has to be quoted, eg. '-f stbu.conf'
  • --printAndStop, -p β€” print options and stop processing. mic drop, out 🎀
  • --killTime -k β€” time until any of the programs started will be killed. default is 365 days. the time range has to be specified in format 'dhms', e.g. 10d4h means 10 days and 4 hours. yes bestie, it will absolutely end things πŸ’€
  • --tmpdir, -T β€” directory for temporary files, default is </tmp>
  • mountPoints β€” List of mount points needed to perform the backup. This must be a list of paths which have to be defined in /etc/fstab.
    • if you add 'ro,' or 'rw,' to the beginning of a mount point, you can overwrite that option set in /etc/fstab
    • example:
    ro,/fileSystemToRead
       will mount /fileSystemToRead read only, even if the
       corresponding entry in /etc/fstab mounts is read/write
🚨 only root is allowed to use this feature! like, actual root. not your vibes. only root. πŸ™…β€β™€οΈ

⭐ EXIT STATUS ⭐

  • 0 β†’ everything is ok πŸ₯³ slay
  • 1 β†’ error from called program 😭
  • 2 β†’ error from storeBackupMount 😬
  • 3 β†’ error from both programs πŸ’€ double trouble

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


okay that's the whole page bestie, go forth and mount responsibly πŸ§šβ€β™€οΈπŸŒΈ

sign-off time: this was pulled from perl v5.40.1, dated 2026-05-23, and yeah β€” it's the STOREBACKUPMOUNT(1) page πŸ’– byeee πŸ‘‹

πŸ“¦ where this page comes from