borg with-lock

borg [common options] with-lock [options] REPOSITORY COMMAND [ARGS...]
positional arguments
  REPOSITORY repository to lock
  COMMAND command to run
  ARGS command arguments

Common options

Description

This command runs a user-specified command while the repository lock is held.

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.

As example you can use “borg with-lock” to copy a repo to another location (see can_i_copy_or_synchronize_my_repo_to_another_location in the FAQ).

borg break-lock

borg [common options] break-lock [options] [REPOSITORY]
positional arguments
  REPOSITORY repository for which to break the locks

Common options

Description

This command breaks the repository and cache locks. Please use carefully and only while no borg process (on any machine) is trying to access the Cache or the Repository.