diff options
Diffstat (limited to 'docs/man/borg.1')
| -rw-r--r-- | docs/man/borg.1 | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/docs/man/borg.1 b/docs/man/borg.1 index 4af8964a6..f6c7c4e2d 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG" 1 "2023-12-02" "" "borg backup tool" +.TH "BORG" 1 "2024-01-01" "" "borg backup tool" .SH NAME borg \- deduplicating and encrypting backup tool .SH SYNOPSIS @@ -361,18 +361,30 @@ _ T{ 1 T} T{ -warning (operation reached its normal end, but there were warnings \-\- +generic warning (operation reached its normal end, but there were warnings \-\- you should check the log, logged as WARNING) T} _ T{ 2 T} T{ -error (like a fatal error, a local or remote exception, the operation +generic error (like a fatal error, a local or remote exception, the operation did not reach its normal end, logged as ERROR) T} _ T{ +3..99 +T} T{ +specific error (enabled by BORG_EXIT_CODES=modern) +T} +_ +T{ +100..127 +T} T{ +specific warning (enabled by BORG_EXIT_CODES=modern) +T} +_ +T{ 128+N T} T{ killed by signal N (e.g. 137 == kill \-9) @@ -427,6 +439,10 @@ Main usecase for this is to fully automate \fBborg change\-passphrase\fP\&. .B BORG_DISPLAY_PASSPHRASE When set, use the value to answer the \(dqdisplay the passphrase for verification\(dq question when defining a new passphrase for encrypted repositories. .TP +.B BORG_EXIT_CODES +When set to \(dqmodern\(dq, the borg process will return more specific exit codes (rc). +Default is \(dqlegacy\(dq and returns rc 2 for all errors, 1 for all warnings, 0 for success. +.TP .B BORG_HOST_ID Borg usually computes a host id from the FQDN plus the results of \fBuuid.getnode()\fP (which usually returns a unique id based on the MAC address of the network interface. Except if that MAC happens to be all\-zero \- in |