Name¶

borg-tag - Manage tags.

SYNOPSIS¶

borg [common options] tag [options] [NAME]

DESCRIPTION¶

Manage archive tags.

Borg archives can have a set of tags which can be used for matching archives.

You can set the tags to a specific set of tags or you can add or remove tags from the current set of tags.

User-defined tags must not start with @ because such tags are considered special and users are only allowed to use known special tags:

@PROT: protects archives against archive deletion or pruning.

Pre-existing special tags cannot be removed via --set. You can still use --set, but you must also give pre-existing special tags (so they won't be removed). If they are not given, borg emits a warning and does not set the tags of that archive.

--clear removes all normal tags, but keeps special tags. Combined with --add, it replaces the normal tags.

To change tags, you must select the archives: give an archive NAME or use archive filter options like --match-archives. To change the tags of all archives, use --match-archives 'sh:*'.

Each of --set, --add and --remove takes exactly one tag. To give multiple tags, use the option multiple times.

Examples:

# add the tags "important" and "keep" to the archive with the given ID
$ borg tag --add important --add keep aid:1ddaae55
# remove the tag "keep" from all archives named "home"
$ borg tag --remove keep --match-archives home
# set the tags of the archive with the given ID to exactly "foo" and "bar"
$ borg tag --set foo --set bar aid:1ddaae55
# remove all normal tags (but not special tags like @PROT) from the archive with the given ID
$ borg tag --clear aid:1ddaae55
# protect the archive with the given ID against deletion and pruning
$ borg tag --add @PROT aid:1ddaae55

OPTIONS¶

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

SEE ALSO¶

borg-common(1)

Author¶

The Borg Collective