1.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! 2 3.. _borg_borgfs: 4 5borg borgfs 6----------- 7.. code-block:: none 8 9 borg [common options] borgfs [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT [PATH...] 10 11.. only:: html 12 13 .. class:: borg-options-table 14 15 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 16 | **positional arguments** | 17 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 18 | | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to mount | 19 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 20 | | ``MOUNTPOINT`` | where to mount filesystem | 21 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 22 | | ``PATH`` | paths to extract; patterns are supported | 23 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 24 | **optional arguments** | 25 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 26 | | ``-V``, ``--version`` | show version number and exit | 27 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 28 | | ``-f``, ``--foreground`` | stay in foreground, do not daemonize | 29 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 30 | | ``-o`` | Extra mount options | 31 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 32 | .. class:: borg-common-opt-ref | 33 | | 34 | :ref:`common_options` | 35 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 36 | **Archive filters** — Archive filters can be applied to repository targets. | 37 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 38 | | ``-P PREFIX``, ``--prefix PREFIX`` | only consider archive names starting with this prefix. | 39 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 40 | | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. | 41 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 42 | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp | 43 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 44 | | ``--first N`` | consider first N archives after other filters were applied | 45 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 46 | | ``--last N`` | consider last N archives after other filters were applied | 47 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 48 | **Exclusion options** | 49 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 50 | | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN | 51 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 52 | | ``--exclude-from EXCLUDEFILE`` | read exclude patterns from EXCLUDEFILE, one per line | 53 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 54 | | ``--pattern PATTERN`` | experimental: include/exclude paths matching PATTERN | 55 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 56 | | ``--patterns-from PATTERNFILE`` | experimental: read include/exclude patterns from PATTERNFILE, one per line | 57 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 58 | | ``--strip-components NUMBER`` | Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. | 59 +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ 60 61 .. raw:: html 62 63 <script type='text/javascript'> 64 $(document).ready(function () { 65 $('.borg-options-table colgroup').remove(); 66 }) 67 </script> 68 69.. only:: latex 70 71 REPOSITORY_OR_ARCHIVE 72 repository/archive to mount 73 MOUNTPOINT 74 where to mount filesystem 75 PATH 76 paths to extract; patterns are supported 77 78 79 optional arguments 80 -V, --version show version number and exit 81 -f, --foreground stay in foreground, do not daemonize 82 -o Extra mount options 83 84 85 :ref:`common_options` 86 | 87 88 Archive filters 89 -P PREFIX, --prefix PREFIX only consider archive names starting with this prefix. 90 -a GLOB, --glob-archives GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. 91 --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp 92 --first N consider first N archives after other filters were applied 93 --last N consider last N archives after other filters were applied 94 95 96 Exclusion options 97 -e PATTERN, --exclude PATTERN exclude paths matching PATTERN 98 --exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line 99 --pattern PATTERN experimental: include/exclude paths matching PATTERN 100 --patterns-from PATTERNFILE experimental: read include/exclude patterns from PATTERNFILE, one per line 101 --strip-components NUMBER Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. 102 103 104Description 105~~~~~~~~~~~ 106 107This command mounts an archive as a FUSE filesystem. This can be useful for 108browsing an archive or restoring individual files. Unless the ``--foreground`` 109option is given the command will run in the background until the filesystem 110is ``umounted``. 111 112The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be 113used in fstab entries: 114``/path/to/repo /mnt/point fuse.borgfs defaults,noauto 0 0`` 115 116To allow a regular user to use fstab entries, add the ``user`` option: 117``/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0`` 118 119For mount options, see the fuse(8) manual page. Additional mount options 120supported by borg: 121 122- versions: when used with a repository mount, this gives a merged, versioned 123 view of the files in the archives. EXPERIMENTAL, layout may change in future. 124- allow_damaged_files: by default damaged files (where missing chunks were 125 replaced with runs of zeros by borg check ``--repair``) are not readable and 126 return EIO (I/O error). Set this option to read such files. 127 128The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users 129to tweak the performance. It sets the number of cached data chunks; additional 130memory usage can be up to ~8 MiB times this number. The default is the number 131of CPU cores. 132 133When the daemonized process receives a signal or crashes, it does not unmount. 134Unmounting in these cases could cause an active rsync or similar process 135to unintentionally delete data. 136 137When running in the foreground ^C/SIGINT unmounts cleanly, but other 138signals or crashes do not.