diff --git a/docs/usage/list.rst b/docs/usage/list.rst index f0789edd2a..71dfe8eca0 100644 --- a/docs/usage/list.rst +++ b/docs/usage/list.rst @@ -31,4 +31,14 @@ Examples drwxrwxr-x user user 0 Sun, 2015-02-01 11:00:00 code drwxrwxr-x user user 0 Sun, 2015-02-01 11:00:00 code/myproject -rw-rw-r-- user user 1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.ext + -rw-rw-r-- user user 1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.text + ... + + $ borg list /path/to/repo/::archiveA --pattern 're:\.ext$' + -rw-rw-r-- user user 1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.ext + ... + + $ borg list /path/to/repo/::archiveA --pattern 're:.ext$' + -rw-rw-r-- user user 1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.ext + -rw-rw-r-- user user 1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.text ... diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 3bb5fbd968..f45ff30589 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -2881,6 +2881,23 @@ def define_archive_filters_group(subparser, *, sort_by=True, first_last=True): For FUSE configuration and mount options, see the mount.fuse(8) manual page. + Borg's default behavior is to use the archived user and group names of each + file and map them to the system's respective user and group ids. + Alternatively, using ``numeric-ids`` will instead use the archived user and + group ids without any mapping. + + The ``uid`` and ``gid`` mount options (implemented by Borg) can be used to + override the user and group ids of all files (i.e., ``borg mount -o + uid=1000,gid=1000``). + + The man page references ``user_id`` and ``group_id`` mount options + (implemented by fuse) which specify the user and group id of the mount owner + (aka, the user who does the mounting). It is set automatically by libfuse (or + the filesystem if libfuse is not used). However, you should not specify these + manually. Unlike the ``uid`` and ``gid`` mount options which affect all files, + ``user_id`` and ``group_id`` affect the user and group id of the mounted + (base) directory. + Additional mount options supported by borg: - versions: when used with a repository mount, this gives a merged, versioned