borg2-with-lock(1)

borg2-with-lock1

Run a user specified command with the repository lock held

Usage

borg [common options] with-lock [options] COMMAND [ARGS ...]

Overview

This command runs a user-specified command while locking the repository. For example:

$ BORG_REPO=/mnt/borgrepo borg with-lock rsync -av /mnt/borgrepo /somewhere/else/borgrepo

It will first try to acquire the lock (make sure that no other operation is running in the repo), then execute the given command as a subprocess and wait for its termination, release the lock and return the user command's return code as borg's return code.

NOTE:

If you copy a repository with the lock held, the lock will be present in the copy. Thus, before using borg on the copy from a different host, you need to use "borg break-lock" on the copied repository, because Borg is cautious and does not automatically remove stale locks made by a different host.

Options

See borg-common(1) for common options of Borg commands.

arguments

COMMAND

command to run

ARGS

command arguments

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

Author

The Borg Collective

From borgbackup2 2.0.0b19-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.