borg(1) borg backup tool borg(1) (NAME) borg - (SYNOPSIS) borg [ ] <> [] [] (DESCRIPTION) BorgBackup ( : Borg) . . Borg . (Deduplication) Borg . . Borg (archive) . (repository) . Borg . Borg ( ) . (EXAMPLES) 1. (initialize) : $ borg init --encryption=repokey /path/to/repo 2. ~/src ~/Documents Monday: $ borg create /path/to/repo::Monday ~/src ~/Documents 3. Tuesday: $ borg create --stats /path/to/repo::Tuesday ~/src ~/Documents . --stats Borg ( ) : ------------------------------------------------------------------------------ Archive name: Tuesday Archive fingerprint: bd31004d58f51ea06ff735d2e5ac49376901b21d58035f8fb05dbf866566e3c2 Time (start): Tue, 2016-02-16 18:15:11 Time (end): Tue, 2016-02-16 18:15:11 Duration: 0.19 seconds Number of files: 127 ------------------------------------------------------------------------------ Original size Compressed size Deduplicated size This archive: 4.16 MB 4.17 MB 26.78 kB All archives: 8.33 MB 8.34 MB 4.19 MB Unique chunks Total chunks Chunk index: 132 261 ------------------------------------------------------------------------------ 4. : $ borg list /path/to/repo Monday Mon, 2016-02-15 19:14:44 Tuesday Tue, 2016-02-16 19:15:11 5. Monday: $ borg list /path/to/repo::Monday drwxr-xr-x user group 0 Mon, 2016-02-15 18:22:30 home/user/Documents -rw-r--r-- user group 7961 Mon, 2016-02-15 18:22:30 home/user/Documents/Important.doc ... 6. Monday : $ borg extract /path/to/repo::Monday 7. Monday ( ): $ borg delete /path/to/repo::Monday 8. (segment files) : $ borg compact /path/to/repo : Borg ( WARNING ). --progress --list . -v ( --verbose --info) INFO . (NOTES) : Borg ( : -s --progress) ( : repo::archive path) : borg create -s --progress repo::archive path # borg create repo::archive path -s --progress # borg create -s repo::archive path --progress # borg create repo::archive -s --progress path # argparse : (Repository URLs) ( ): /path/to/repo - path/to/repo - ~/path/to/repo ~other/path/to/repo ( ). : file:// URL . ssh (): ssh://user@host:port/path/to/repo - (port) user@host:/path/to/repo - URL : ssh://user@host:port/./path/to/repo - ssh://user@host:port/~/path/to/repo - ssh://user@host:port/~other/path/to/repo - () SCP: user@host:path/to/repo - user@host:~/path/to/repo - user@host:~other/path/to/repo - : user@host:/./path/to/repo user@host:/~/path/to/repo user@host:/~other/path/to/repo . BORG_REPO : export BORG_REPO='ssh://user@host:port/path/to/repo' - BORG_REPO . :: ( borg mount :: /mnt). / (Repository / Archive Locations) ( ) ::archive_name . / () . ( borg mount ). BORG_REPO ( ) ::archive_name - BORG_REPO . (Logging) Borg () stderr . stderr stderr . borg . (redirect) : borg create repo::archive myfiles 2>> logfile BORG_LOGGING_CONF . WARNING . Borg ( --list --progress) . : DEBUG < INFO < WARNING < ERROR < CRITICAL --debug DEBUG - (debug) (info) (warning) (error) (critical) . --info ( -v --verbose) INFO - . --warning () WARNING - . --error ERROR - . --critical CRITICAL - . - . : --critical --error . (Return codes) Borg (rc) : +-----------------------+-----------------------------------+ | | | +-----------------------+-----------------------------------+ |0 | | | | ( INFO | | | ) | +-----------------------+-----------------------------------+ |1 | | | | ( | | | | | | | | | | | | | | | -- | | | | | | | | | | | | WARNING | | | ) | +-----------------------+-----------------------------------+ |2 | | | | ( | | | | | | | | | | | | | | | | | | | | | | | | | | | ERROR | | | ) | +-----------------------+-----------------------------------+ |3..99 | | | | ( | | | BORG_EXIT_CODES=modern) | +-----------------------+-----------------------------------+ |100..127 | | | | ( | | | BORG_EXIT_CODES=modern) | +-----------------------+-----------------------------------+ |128+N | | | | N | | | ( 137 == | | | kill -9) | +-----------------------+-----------------------------------+ --show-rc . ( "rc") : msgid (Environment Variables) Borg : (General): BORG_REPO . ::archive . :: . BORG_PASSPHRASE . . BORG_NEW_PASSPHRASE . BORG_PASSCOMMAND ( ) . . $HOME ~ . BORG_PASSPHRASE . BORG_NEW_PASSPHRASE . BORG_PASSPHRASE_FD (file descriptor) . borg (anonymous pipe) . BORG_PASSPHRASE ( ) . BORG_PASSPHRASE BORG_PASSCOMMAND . BORG_NEW_PASSPHRASE . . BORG_PASSPHRASE BORG_PASSCOMMAND . borg key change-passphrase . BORG_DISPLAY_PASSPHRASE << >> (display the passphrase for verification) . BORG_EXIT_CODES <> borg (rc) . <> . BORG_HOST_ID Borg FQDN uuid.getnode() ( MAC MAC - ). MAC . FQDN FQDN . . BORG_HOSTNAME ( ) borg ( 9651#). {hostname} . BORG_USERNAME ( ) borg . {user} . BORG_LOGGING_CONF INI . docs/misc/logging.conf . BORG_RSH ssh . ssh ssh -i /path/to/private/key . man ssh . --rsh CMD . BORG_REMOTE_PATH borg ( <> ). --remote-path PATH . BORG_FILES_CACHE_SUFFIX borg ( ) . . BORG_FILES_CACHE_TTL << >> (time to live) (: 20). . (FAQ) : always_chunking BORG_USE_CHUNKS_ARCHIVE no (: yes) chunks.archive.d . . BORG_SHOW_SYSINFO no (: yes) ( ...) . . BORG_MSGPACK_VERSION_CHECK Borg msgpack . yes ( ) . msgpack no . msgpack . BORG_FUSE_IMPL FUSE borg borg mount . : o pyfuse3,llfuse: pyfuse3 llfuse. o llfuse,pyfuse3: llfuse pyfuse3. o pyfuse3: pyfuse3. o llfuse: llfuse. o none: . BORG_SELFTEST (self-tests) borg . borg . BORG_SELFTEST=disabled . borg borg borg ( ) / / borg . BORG_WORKAROUNDS (workarounds) borg . : basesyncfile BaseSyncFile sync_file_range. borg WSL ( ) systemd.nspawn ( ARM) . ( ). retry_erofs O_NOATIME O_NOATIME EROFS . (volume shadow copies) WSL1 ( ) . authenticated_no_key authenticated ( ). key = anything . ( ): BORG_WORKAROUNDS=authenticated_no_key borg extract repo::archive : BORG_WORKAROUNDS=authenticated_no_key borg delete repo (init) . . ignore_invalid_archive_tam TAM 1.2.5 borg 7791# . CVE-2023-36811 archives_tam_vuln . . << >> ( ): BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=no ( =yes) <> BORG_RELOCATED_REPO_ACCESS_IS_OK=no ( =yes) <> BORG_CHECK_I_KNOW_WHAT_I_AM_DOING=NO ( =YES) <> ( check --repair) BORG_DELETE_I_KNOW_WHAT_I_AM_DOING=NO ( =YES) <> : . ( ) . . (Directories and files): BORG_BASE_DIR $HOME ~$USER ~ ( ). borg BORG_BASE_DIR : ( ). BORG_CACHE_DIR $BORG_BASE_DIR/.cache/borg . BORG_BASE_DIR XDG XDG_CACHE_HOME $XDG_CACHE_HOME/borg . . : cache_security BORG_CONFIG_DIR $BORG_BASE_DIR/.config/borg . BORG_BASE_DIR XDG XDG_CONFIG_HOME $XDG_CONFIG_HOME/borg . borg : home_config_borg BORG_SECURITY_DIR $BORG_CONFIG_DIR/security . Borg NONCE (<< >> - ) . BORG_KEYS_DIR $BORG_CONFIG_DIR/keys . . BORG_KEY_FILE . : o keyfile ( repokey). o . o . o borg . o ( ) (borg init). o . o . TMPDIR ( ) tempfile . (Building): BORG_OPENSSL_PREFIX OpenSSL (setup.py). BORG_LIBLZ4_PREFIX . 'include/lz4.h' Borg liblz4 . (setup.py) BORG_LIBZSTD_PREFIX . 'include/zstd.h' Borg libzstd . (setup.py) : o <> . o ( 600 root:root). (File systems) Borg ( ) FAT ( ) . Borg -- -- . . Borg borg check --verify-data . Borg: o o o . ( ) . o . o rename(2) / MoveFile(Ex) ( ) . o (Hardlinks) borg_upgrade ( --inplace ). ( ) . (Units) Borg . () ( kB ). IEC ( KiB ). (Date and Time) ISO-8601 : YYYY-MM-DD HH:MM:SS ( ). : . UTC . (Resource Usage) Borg . Borg / ( :ssh) . Borg ( ) + . (CPU) : o borg create: (chunking) (hashing) ( ) o chunks cache sync: (hashtable). o borg extract: ( ) o borg check: . o borg prune / borg delete archive: o borg delete repo: (single-threaded) . zlib lzma . ( ) ( ). (CPU) : / () (index) . borg check: (checksums) ( ) borg delete repo: ( /): borg / ssh - - . (RAM) : (chunks index) . ( ). lzma . (RAM) : . ( ). ( ): . . ( create ). ( ): . ( create ) . . ( ): . . ( create ) . (): FUSE . . (): . /tmp . $TMPDIR $TEMP $TMP sshd . bashrc. ( ) PermitUserEnvironment yes sshd_config environment="TMPDIR=/my/big/tmpdir" authorized_hosts . ( ): ( - ). ( /): ( /) ( ssh://). . . (Support for file metadata) Borg : o ( ) o : o ( mknod) o FIFO (<< >> named pipes) o --read-special . mknod(2) mkfifo(2) . o FIFO ( ) o : mtime atime ctime o : birthtime ( ) o : o (UID / GID) o ( ) o / ( u/g/o suid sgid sticky) : +-----------------+----------+-----------+-----------+ |Platform | ACLs [5] | xattr [6] | Flags [7] | +-----------------+----------+-----------+-----------+ |Linux | Yes | Yes | Yes [1] | +-----------------+----------+-----------+-----------+ |macOS | Yes | Yes | Yes (all) | +-----------------+----------+-----------+-----------+ |FreeBSD | Yes | Yes | Yes (all) | +-----------------+----------+-----------+-----------+ |OpenBSD | n/a | n/a | Yes (all) | +-----------------+----------+-----------+-----------+ |NetBSD | n/a | No [2] | Yes (all) | +-----------------+----------+-----------+-----------+ |Solaris and | No [3] | No [3] | n/a | |derivatives | | | | +-----------------+----------+-----------+-----------+ |Windows (cygwin) | No [4] | No | No | +-----------------+----------+-----------+-----------+ . . ntfs-3g ACL NTFS . [1] <> <> <> <> . 618# . [2] 1332# [3] 1337# [4] Cygwin ACL NTFS . [5] (ACL) . ACL . ACL NTFS ntfs-3g . [6] (extended attributes) - . resource fork Mac OS X . [7] BSD flags. [1] . BSD . (SEE ALSO) borg-common(1) borg-init(1), borg-create(1), borg-mount(1), borg-extract(1), borg-list(1), borg-info(1), borg-delete(1), borg-prune(1), borg-recreate(1) borg-compression(1), borg-patterns(1), borg-placeholders(1) o o o o o (Author) The Borg Collective orphan: 2026-07-18 borg(1)