Skip to content

Commit

Permalink
Merge pull request #8458 from ThomasWaldmann/doc-updates
Browse files Browse the repository at this point in the history
Doc updates
  • Loading branch information
ThomasWaldmann authored Oct 5, 2024
2 parents ea619e7 + 3d3fc24 commit 91c0def
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 7 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (C) 2015-2023 The Borg Collective (see AUTHORS file)
Copyright (C) 2015-2024 The Borg Collective (see AUTHORS file)
Copyright (C) 2010-2014 Jonas Borgström <jonas@borgstrom.se>
All rights reserved.

Expand Down
6 changes: 5 additions & 1 deletion docs/binaries/00_README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ borg-macos1012 macOS (built on macOS Sierra 10.12 with latest macFUSE from
borg-freebsd14 FreeBSD (built on FreeBSD 14)

*.tgz similar to above, but built as a directory with files,
not as a single self-extracting binary.
not as a single self-extracting binary. using the directory
build is faster and doesn't need as much space in the temp
directory as the one-file build.
*.asc GnuPG signatures for *


Expand Down Expand Up @@ -53,6 +55,8 @@ Installing
----------

It is suggested that you rename or symlink the binary to just "borg".
If you need "borgfs", just also symlink it to the same binary, it will
detect internally under which name it was invoked.

On UNIX-like platforms, /usr/local/bin/ or ~/bin/ is a nice place for it,
but you can invoke it from every place by giving a full path to it.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

# General information about the project.
project = "Borg - Deduplicating Archiver"
copyright = "2010-2014 Jonas Borgström, 2015-2022 The Borg Collective (see AUTHORS file)"
copyright = "2010-2014 Jonas Borgström, 2015-2024 The Borg Collective (see AUTHORS file)"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
2 changes: 2 additions & 0 deletions docs/usage/general/return-codes.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ Return code Meaning
If you use ``--show-rc``, the return code is also logged at the indicated
level as the last log entry.
The modern exit codes (return codes, "rc") are documented there: :ref:`msgid`
20 changes: 16 additions & 4 deletions src/borg/archiver/mount_cmds.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,26 @@ def build_parser_mount_umount(self, subparsers, common_parser, mid_common_parser

mount_epilog = process_epilog(
"""
This command mounts an archive as a FUSE filesystem. This can be useful
for browsing an archive or restoring individual files. When restoring,
take into account that the current FUSE implementation does not support
special fs flags and ACLs.
This command mounts a repository or an archive as a FUSE filesystem.
This can be useful for browsing or restoring individual files.
When restoring, take into account that the current FUSE implementation does
not support special fs flags and ACLs.
When mounting a repository, the top directories will be named like the
archives and the directory structure below these will be loaded on-demand from
the repository when entering these directories, so expect some delay.
Unless the ``--foreground`` option is given the command will run in the
background until the filesystem is ``umounted``.
Performance tips:
- when doing a "whole repository" mount:
do not enter archive dirs if not needed, this avoids on-demand loading.
- only mount a specific archive, not the whole repository.
- only mount specific paths in a specific archive, not the complete archive.
The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be
used in fstab entries:
``/path/to/repo /mnt/point fuse.borgfs defaults,noauto 0 0``
Expand Down

0 comments on commit 91c0def

Please sign in to comment.