2016-07-05 21:30:08 +00:00
.. IMPORTANT : this file is auto - generated from borg ' s built - in help , do not edit !
2015-11-13 15:42:16 +00:00
.. _borg_mount :
borg mount
----------
2017-06-06 22:44:53 +00:00
.. code - block :: none
2015-11-13 15:42:16 +00:00
2017-06-06 22:44:53 +00:00
borg [ common options ] mount [ options ] REPOSITORY_OR_ARCHIVE MOUNTPOINT
2016-04-09 23:28:18 +00:00
2017-06-20 13:22:24 +00:00
.. only :: html
.. class :: borg - options - table
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| ** 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 |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| .. class :: borg - common - opt - ref |
| |
| : ref : `common_options` |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| ** filters ** |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - P `` , `` -- prefix `` | only consider archive names starting with this prefix . |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - a `` , `` -- glob - archives `` | only consider archive names matching the glob . sh : rules apply , see " borg help patterns " . `` -- prefix `` and `` -- glob - archives `` are mutually exclusive . |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- sort - by `` | Comma - separated list of sorting keys ; valid keys are : timestamp , name , id ; default is : timestamp |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- first N `` | consider first N archives after other filters were applied |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- last N `` | consider last N archives after other filters were applied |
+-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. raw :: html
< script type = 'text/javascript' >
$ ( window ) . load ( function () {
$ ( '.borg-options-table colgroup' ) . remove ();
})
</ script >
.. only :: latex
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
: ref : `common_options`
|
filters
- P , -- prefix only consider archive names starting with this prefix .
- a , -- glob - archives only consider archive names matching the glob . sh : rules apply , see " borg help patterns " . `` -- prefix `` and `` -- glob - archives `` are mutually exclusive .
-- sort - by Comma - separated list of sorting keys ; valid keys are : timestamp , name , id ; default is : timestamp
-- first N consider first N archives after other filters were applied
-- last N consider last N archives after other filters were applied
2017-06-20 09:49:26 +00:00
2016-11-28 01:25:56 +00:00
2015-11-13 15:42:16 +00:00
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 `` .
2016-03-17 00:40:17 +00:00
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 ``
2016-07-05 23:33:53 +00:00
2016-07-10 17:00:55 +00:00
For mount options , see the fuse ( 8 ) manual page . Additional mount options
supported by borg :
2016-08-27 22:17:24 +00:00
- versions : when used with a repository mount , this gives a merged , versioned
view of the files in the archives . EXPERIMENTAL , layout may change in future .
2016-07-10 17:00:55 +00:00
- allow_damaged_files : by default damaged files ( where missing chunks were
2017-06-17 10:28:42 +00:00
replaced with runs of zeros by borg check `` -- repair `` ) are not readable and
2016-07-10 17:00:55 +00:00
return EIO ( I / O error ) . Set this option to read such files .
2016-07-10 23:23:27 +00:00
2016-07-05 23:33:53 +00:00
The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users
to tweak the performance . It sets the number of cached data chunks ; additional
memory usage can be up to ~ 8 MiB times this number . The default is the number
of CPU cores .
2017-01-29 04:54:25 +00:00
When the daemonized process receives a signal or crashes , it does not unmount .
Unmounting in these cases could cause an active rsync or similar process
to unintentionally delete data .
When running in the foreground ^ C / SIGINT unmounts cleanly , but other
2017-03-26 23:45:45 +00:00
signals or crashes do not .