1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 09:19:31 +00:00
borg/docs/usage/mount.rst.inc
Marian Beermann 0a369c0985
Better help texts and Sphinx reproduction of usage
- Group options
- Nicer list of options in Sphinx
- Deduplicate 'Common options'
  (including --help)

The latter is done by explicitly declaring --help in the common_parser,
which is then inherited by the sub-parsers; no change in observable
behaviour.
2016-04-10 01:28:19 +02:00

37 lines
972 B
PHP

.. _borg_mount:
borg mount
----------
::
borg mount <options> REPOSITORY_OR_ARCHIVE MOUNTPOINT
positional arguments
REPOSITORY_OR_ARCHIVE
repository/archive to mount
MOUNTPOINT
where to mount filesystem
optional arguments
``-f``, ``--foreground``
| stay in foreground, do not daemonize
``-o``
| Extra mount options
`Common options`_
|
Description
~~~~~~~~~~~
This command mounts an archive as a FUSE filesystem. This can be useful for
browsing an archive or restoring individual files. Unless the ``--foreground``
option is given the command will run in the background until the filesystem
is ``umounted``.
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``
To allow a regular user to use fstab entries, add the ``user`` option:
``/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0``