File: return-codes.rst.inc

package info (click to toggle)
borgbackup 1.4.3-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,728 kB
  • sloc: python: 26,637; pascal: 3,245; ansic: 2,597; sh: 151; makefile: 133; tcl: 94
file content (22 lines) | stat: -rw-r--r-- 857 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Return codes
~~~~~~~~~~~~

Borg can exit with the following return codes (rc):

=========== =======
Return code Meaning
=========== =======
0           success (logged as INFO)
1           generic warning (operation reached its normal end, but there were warnings --
            you should check the log, logged as WARNING)
2           generic error (like a fatal error, a local or remote exception, the operation
            did not reach its normal end, logged as ERROR)
3..99       specific error (enabled by BORG_EXIT_CODES=modern)
100..127    specific warning (enabled by BORG_EXIT_CODES=modern)
128+N       killed by signal N (e.g. 137 == kill -9)
=========== =======

If you use ``--show-rc``, the return code is also logged at the indicated
level as the last log entry.

The modern exit codes (return codes, "rc") are documented there: :ref:`msgid`