borg/docs/usage.rst
Thomas Waldmann cfd368624e
find: new command to search files across archives, #9974
borg find iterates over the archives selected by the usual archive
filter options (all archives by default) from newest to oldest, over
all items of each archive, and outputs one line per item matching the
given PATHs (paths or patterns, matching like in borg list /
borg extract).

Output lines are formatted like borg list default output, but are
prefixed with a short archive ID and the archive name. As the
archives of a series all share the same name, only the archive ID
uniquely identifies the archive.

Output is customizable via --format / BORG_FIND_FORMAT (ItemFormatter
keys) and --json-lines.

There is no extra index for file paths (keeping one up to date would
cost considerable runtime and space), so this reads the metadata of
all selected archives.
2026-08-14 14:10:11 +02:00

75 lines
1.8 KiB
ReStructuredText

.. include:: global.rst.inc
.. highlight:: none
.. _detailed_usage:
Usage
=====
.. raw:: html
Redirecting...
<script type="text/javascript">
// Fixes old links that were just anchor fragments
var hash = window.location.hash.substring(1);
// usage.html is empty; it contains no content. It purely serves to implement a "correct" toctree
// due to reST/Sphinx limitations. Refer to https://github.com/sphinx-doc/sphinx/pull/3622
// Redirect to general docs
if(hash == "") {
var replaced = window.location.pathname.replace("usage.html", "usage/general.html");
if (replaced != window.location.pathname) {
window.location.pathname = replaced;
}
}
// Fixup anchored links from when usage.html contained all the commands
else if(hash.startsWith("borg-key") || hash == "borg-change-passphrase") {
window.location.hash = "";
window.location.pathname = window.location.pathname.replace("usage.html", "usage/key.html");
}
else if(hash.startsWith("borg-")) {
window.location.hash = "";
window.location.pathname = window.location.pathname.replace("usage.html", "usage/") + hash.substr(5) + ".html";
}
</script>
.. toctree::
usage/general
usage/repo-create
usage/repo-space
usage/repo-list
usage/repo-info
usage/repo-compress
usage/repo-delete
usage/serve
usage/version
usage/compact
usage/lock
usage/key
usage/create
usage/extract
usage/check
usage/list
usage/find
usage/tag
usage/rename
usage/diff
usage/delete
usage/prune
usage/undelete
usage/info
usage/analyze
usage/mount
usage/webdav
usage/recreate
usage/tar
usage/transfer
usage/benchmark
usage/help
usage/completion
usage/debug
usage/notes