---

• -A: The runtime log is sent with the email notification
• --coloring: Coloring settings for emails and console messages
• -e: email address to which the notification will be sent
• -E: Optional parameters for the eMailClient programs
• --eMailColoring: Control where the used eMailClient accepts coloring information
• -f: Specification of a configuration file
• -g: Progress bar
• -G: Language of the messages
• -h: Help
• -l: Loglevel
• -L: Directory where the debuglog and runtime messages are stored
• -m: Message details
• -s: eMailClientProgram which is used to send the eMail
• -S: Unconditional update
• --timestamps: All messages are output with a leading timestamp
• -U: Update of raspiBackup
• --updateConfig: Update the raspiBackup configuration
• --unsupportedEnvironment: Unsupported HW and SW is accepted
• --version: Display the version information
• -v: All messages from the backup tool used are logged
• -V: Reactivation of a previous raspiBackup version
• -y: Copy the current raspiBackup version to predefined local hosts via scp

---

-A: The runtime log is sent with the email notification

The runtime log is sent with the email notification.

--coloring: Coloring settings for emails and console messages

The messages in the email and on the console can be be colored. Possible values are C for console and/or M for eMail. If Postfix is used as email client, see also option --eMailColoring.

-e: email address to which the notification will be sent

email address that receives a status email and the messages of the backup run is sent to

Attention: The notification email is sent by the root user. I.e. the e-mail client on the system must be configured so that with

echo "eMail-Text" | sudo mail -s "Subject" "Recipient eMail"

the e-mail is sent successfully.

With the configuration option DEFAULT_SENDER_EMAIL the default sender address default sender address "root@$(hostname)" can be changed if required.

Note: The e-mail notification only works if an MTA such as nullmailer, msmtp, Postfix or Exim4 has been configured correctly. For some email clients there are configuration-examples.md. Otherwise FAQ38 should be taken into account. The e-mail function can be tested relatively easily with the "Fake" option -F option. There are also other notification options such as Pushover, Slack or Telegram are supported.

-E: Optional parameters for the eMailClient programs

Optional additional parameters that are specified in the eMail program call. For sendEmail, for example, it must look like this: "-f sender.mail@absenderdomain -s smtp-server:587 -xu Username -xp Password".

Attention: The parameters for -E must be enclosed in quotation marks ". must be enclosed in quotation marks. Especially for testing the e-mail notification function, the parameter -F is helpful.

Attention: If the parameter -l 1 is used, the password is in the log and should be should be masked manually before sending the log.

--eMailColoring: Control where the used eMailClient accepts coloring information

By default, eMailColoring is controlled via the "Subject" line, as this is the this way is used by most eMail clients. However, if you use Postfix as an eMail client, you must specify OPTION as a parameter, as Postfix controls the coloring with a separate option.

-f: Specification of a configuration file

Specification of a configuration file that is read in. See all possible configuration files and their import sequence.

-g: Progress bar

This option displays a progress bar during backup and restore. is displayed. No progress bar is available for tar backups.

-G: Language of the messages

Specifies the language of the messages. The default is the system language if it is supported. Otherwise, all messages are in English.

A list of supported languages can be found here.

If you want to help to give raspiBackup another language, you are welcome to do so, to do so. Details can be found in this description.

-h: Help

Output of the invocation syntax with its parameters

-l: Loglevel

Defines whether a debug log is created:

• off -> No debug log is created
• debug -> A debug log is created

Caution: The log output may contain sensitive information. raspiBackup masks e.g. external static IP addresses, email addresses, passwords for mount commands or email servers, etc. However, there may still be sensitive information may still be contained in the debug log, which should be masked manually. The debug log is always stored in the backup directory. If there are errors and the backup directory is deleted again, the log is first saved in the home directory of the caller.

-L: Directory where the debuglog and runtime messages are stored

Defines the destination of the log file raspiBackup.log.

• varlog: The log file is written to /var/log/
• backup: The log file is written to the backup created
• current: The log file is written to the current directory.
• <file prefixi>: The debug log is written there with the extension .log and the message file with the extension .msg.

Example: /home/pi/raspiBackup

At the end there are /home/pi/raspiBackup.log and /home/pi/raspiBackup.msg.

No logs are stored in the backup directory.

-m: Message details

Message details

• minimal: Only important messages are displayed
• detailed: Many messages about the progress are output

-s: eMailClientProgram which is used to send the eMail

email program which is used {mail|sendEmail|ssmtp|msmtp}. For Postfix and nullmailer, mail must be used and mailtools must be installed. For sendEmail the parameter -E must also be used for additional mandatory parameters (see Parameter -E description for details).

An eMailPlugin can also be used to send eMails. With this any other eMailClients can be integrated into raspiBackup. The -s parameter must then be "mailext". For details on the eMailPlugin see this page.

-S: Unconditional update

An update with the -U option is also carried out if the versions match. It has the effect that both a local beta version and a local local normal version is replaced with the current code version. It is primarily primarily intended to update the code version of an existing local beta version. update an existing local beta version.

--timestamps: All messages are output with a leading timestamp

This option causes a timestamp to be output before each message.

-U: Update of raspiBackup

The local raspiBackup version is replaced by the latest version, if a new version exists. The previous version is saved as raspiBackup.sh.n.m, where n and m is the version number of raspiBackup is. See parameter -V to restore a previous version.

Attention: You should first read this page and inform yourself about the changes and new features.

There is also the option -S, with which beta versions can be updated to the latest can be updated to the latest version.

The 'V' option can be used to revert to an older version.

--updateConfig: Update the raspiBackup configuration

With this option you can force an update of the configuration configuration if it has not been updated during a normal update with the option -U.

--unsupportedEnvironment: Unsupported HW and SW is accepted

If raspiBackup is started on unsupported supported environments this option must be specified.

--version: Display the version information

The version of raspiBackup is displayed in the following format:

Version: 0.6.3.2 CommitSHA: 8fbcd1a CommitDate: 2018-02-19 CommitTime: 19:18:31#

-v: All messages from the backup tool used are logged

The backup tools tar and rsync used display detailed information (verbose mode). This option is particularly useful for initial manual backup tests backup tests in order to be able to track the backup progress.

-V: Reactivation of a previous raspiBackup version

A list of all existing previous versions is displayed and you can select the can select the version to be restored. The current version is backed up and can then be restored later using this option restored later (see also -U parameter)

-y: Copy the current raspiBackup version to predefined local hosts via scp

This option copies the current script to all hosts defined in the configuration file. configuration file. Access must be possible via authorized_keys without a password. This means that raspiBackup can be quickly distributed to a large hosts after a version update.