STOREBACKUPMOUNT(1)

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

💅 STOREBACKUPMOUNT(1) — the perl one, user-contributed, we love her

okay so bestie, before we dive in: this is a page from the User Contributed Perl Documentation section, and she's here to mount your stuff, run your storeBackup programs, and unmount it all again. let's go 🎀

✨ NAME ✨

storeBackupMount mounts file systems — the ones defined in /etc/fstab, yeah — and then starts the storeBackup-related programs for you. 🫶

two vibes for ordering, and they are not the same, ok:

  • if you go the command line route, the order of execution follows the order of the --storeBackup* options you typed
  • if you go the configuration file route, the order of execution follows the option orderOfExecution

no cap, that's it. ✨

🌸 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...]

like, pick a lane, any lane 💁‍♀️

🦋 DESCRIPTION 🦋

this script literally does these things, 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

main character energy from start to finish, honestly.

💅 OPTIONS 💅

  • --help — show this help. the classic. 🎀
  • --generate, -g — generate a template of the configuration file. starter pack, basically ✨
  • --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). this option can be repeated multiple times 🔁
  • --debug, -d — generate some debug messages. she's chatty, we stan 💬
  • --logFile, -l — logFile for this process. default is STDOUT.
  • --suppressTime — suppress output of time in logfile. timestamps? not today 🙈
  • --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]). hoarder behavior but make it cute 🗂️
  • --compressWith — compress saved log files (e.g. with 'gzip -9'). default is 'bzip2'. this parameter is parsed like a line in the configuration file and normally has to be quoted. ⚠️ quoted, bestie, don't forget
  • --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. a little look, no commitment 🫶
  • --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 ⏳
  • --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 "I'm the main character" root.

🔥 EXIT STATUS 🔥

  • 0 -> everything is ok ✨ slay
  • 1 -> error from called program 😭
  • 2 -> error from storeBackupMount 💀
  • 3 -> error from both programs. double trouble, not the fun kind 🙈

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, you're officially literate in storeBackupMount 💖

this lil artifact is perl v5.34.0, dated 2022-03-20 — go forth and mount responsibly 🧚‍♀️

📦 where this page comes from