You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1696 lines
36 KiB

  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="description" content="mergerfs - a featureful union filesystem">
  7. <link rel="canonical" href="https://trapexit.github.io/mergerfs/config/branches/">
  8. <link rel="prev" href="../deprecated_options/">
  9. <link rel="next" href="../functions_categories_and_policies/">
  10. <link rel="icon" href="../../assets/images/favicon.png">
  11. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
  12. <title>branches - mergerfs</title>
  13. <link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.min.css">
  14. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  15. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  16. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  17. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  18. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#branches" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <header class="md-header md-header--shadow" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="../.." title="mergerfs" class="md-header__button md-logo" aria-label="mergerfs" data-md-component="logo">
  34. <img src="../../logo.jpeg" alt="logo">
  35. </a>
  36. <label class="md-header__button md-icon" for="__drawer">
  37. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  38. </label>
  39. <div class="md-header__title" data-md-component="header-title">
  40. <div class="md-header__ellipsis">
  41. <div class="md-header__topic">
  42. <span class="md-ellipsis">
  43. mergerfs
  44. </span>
  45. </div>
  46. <div class="md-header__topic" data-md-component="header-topic">
  47. <span class="md-ellipsis">
  48. branches
  49. </span>
  50. </div>
  51. </div>
  52. </div>
  53. <form class="md-header__option" data-md-component="palette">
  54. <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
  55. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
  56. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg>
  57. </label>
  58. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
  59. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  61. </label>
  62. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
  63. <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
  64. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  65. </label>
  66. </form>
  67. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  68. <label class="md-header__button md-icon" for="__search">
  69. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  70. </label>
  71. <div class="md-search" data-md-component="search" role="dialog">
  72. <label class="md-search__overlay" for="__search"></label>
  73. <div class="md-search__inner" role="search">
  74. <form class="md-search__form" name="search">
  75. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  76. <label class="md-search__icon md-icon" for="__search">
  77. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  79. </label>
  80. <nav class="md-search__options" aria-label="Search">
  81. <a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
  82. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
  83. </a>
  84. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  85. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  86. </button>
  87. </nav>
  88. </form>
  89. <div class="md-search__output">
  90. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  91. <div class="md-search-result" data-md-component="search-result">
  92. <div class="md-search-result__meta">
  93. Initializing search
  94. </div>
  95. <ol class="md-search-result__list" role="presentation"></ol>
  96. </div>
  97. </div>
  98. </div>
  99. </div>
  100. </div>
  101. <div class="md-header__source">
  102. <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source">
  103. <div class="md-source__icon md-icon">
  104. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  105. </div>
  106. <div class="md-source__repository">
  107. mergerfs
  108. </div>
  109. </a>
  110. </div>
  111. </nav>
  112. </header>
  113. <div class="md-container" data-md-component="container">
  114. <main class="md-main" data-md-component="main">
  115. <div class="md-main__inner md-grid">
  116. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  117. <div class="md-sidebar__scrollwrap">
  118. <div class="md-sidebar__inner">
  119. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  120. <label class="md-nav__title" for="__drawer">
  121. <a href="../.." title="mergerfs" class="md-nav__button md-logo" aria-label="mergerfs" data-md-component="logo">
  122. <img src="../../logo.jpeg" alt="logo">
  123. </a>
  124. mergerfs
  125. </label>
  126. <div class="md-nav__source">
  127. <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source">
  128. <div class="md-source__icon md-icon">
  129. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  130. </div>
  131. <div class="md-source__repository">
  132. mergerfs
  133. </div>
  134. </a>
  135. </div>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../.." class="md-nav__link">
  139. <span class="md-ellipsis">
  140. Home
  141. </span>
  142. </a>
  143. </li>
  144. <li class="md-nav__item">
  145. <a href="../../quickstart/" class="md-nav__link">
  146. <span class="md-ellipsis">
  147. QuickStart
  148. </span>
  149. </a>
  150. </li>
  151. <li class="md-nav__item md-nav__item--nested">
  152. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
  153. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  154. <span class="md-ellipsis">
  155. Installation
  156. </span>
  157. <span class="md-nav__icon md-icon"></span>
  158. </label>
  159. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  160. <label class="md-nav__title" for="__nav_3">
  161. <span class="md-nav__icon md-icon"></span>
  162. Installation
  163. </label>
  164. <ul class="md-nav__list" data-md-scrollfix>
  165. <li class="md-nav__item">
  166. <a href="../../setup/installation/" class="md-nav__link">
  167. <span class="md-ellipsis">
  168. Installation
  169. </span>
  170. </a>
  171. </li>
  172. <li class="md-nav__item">
  173. <a href="../../setup/upgrade/" class="md-nav__link">
  174. <span class="md-ellipsis">
  175. Upgrade
  176. </span>
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="../../setup/build/" class="md-nav__link">
  181. <span class="md-ellipsis">
  182. Build
  183. </span>
  184. </a>
  185. </li>
  186. </ul>
  187. </nav>
  188. </li>
  189. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  190. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  191. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  192. <span class="md-ellipsis">
  193. Config
  194. </span>
  195. <span class="md-nav__icon md-icon"></span>
  196. </label>
  197. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  198. <label class="md-nav__title" for="__nav_4">
  199. <span class="md-nav__icon md-icon"></span>
  200. Config
  201. </label>
  202. <ul class="md-nav__list" data-md-scrollfix>
  203. <li class="md-nav__item">
  204. <a href="../terminology/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. Terminology
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../options/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Options
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../deprecated_options/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecated Options
  221. </span>
  222. </a>
  223. </li>
  224. <li class="md-nav__item md-nav__item--active">
  225. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  226. <label class="md-nav__link md-nav__link--active" for="__toc">
  227. <span class="md-ellipsis">
  228. branches
  229. </span>
  230. <span class="md-nav__icon md-icon"></span>
  231. </label>
  232. <a href="./" class="md-nav__link md-nav__link--active">
  233. <span class="md-ellipsis">
  234. branches
  235. </span>
  236. </a>
  237. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  238. <label class="md-nav__title" for="__toc">
  239. <span class="md-nav__icon md-icon"></span>
  240. Table of contents
  241. </label>
  242. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  243. <li class="md-nav__item">
  244. <a href="#branch-mode" class="md-nav__link">
  245. <span class="md-ellipsis">
  246. branch mode
  247. </span>
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="#minfreespace" class="md-nav__link">
  252. <span class="md-ellipsis">
  253. minfreespace
  254. </span>
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="#globbing" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. globbing
  261. </span>
  262. </a>
  263. </li>
  264. </ul>
  265. </nav>
  266. </li>
  267. <li class="md-nav__item">
  268. <a href="../functions_categories_and_policies/" class="md-nav__link">
  269. <span class="md-ellipsis">
  270. functions, categories and policies
  271. </span>
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="../func_readdir/" class="md-nav__link">
  276. <span class="md-ellipsis">
  277. func.readdir
  278. </span>
  279. </a>
  280. </li>
  281. <li class="md-nav__item">
  282. <a href="../rename_and_link/" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. rename and link
  285. </span>
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="../cache/" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. caching
  292. </span>
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="../readahead/" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. readahead
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../inodecalc/" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. inodecalc
  306. </span>
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="../threads/" class="md-nav__link">
  311. <span class="md-ellipsis">
  312. threads
  313. </span>
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../pin-threads/" class="md-nav__link">
  318. <span class="md-ellipsis">
  319. pin-threads
  320. </span>
  321. </a>
  322. </li>
  323. <li class="md-nav__item">
  324. <a href="../link_cow/" class="md-nav__link">
  325. <span class="md-ellipsis">
  326. link_cow
  327. </span>
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../fuse_msg_size/" class="md-nav__link">
  332. <span class="md-ellipsis">
  333. fuse_msg_size
  334. </span>
  335. </a>
  336. </li>
  337. <li class="md-nav__item">
  338. <a href="../follow-symlinks/" class="md-nav__link">
  339. <span class="md-ellipsis">
  340. follow-symlinks
  341. </span>
  342. </a>
  343. </li>
  344. <li class="md-nav__item">
  345. <a href="../link-exdev/" class="md-nav__link">
  346. <span class="md-ellipsis">
  347. link-exdev
  348. </span>
  349. </a>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="../rename-exdev/" class="md-nav__link">
  353. <span class="md-ellipsis">
  354. rename-exdev
  355. </span>
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="../symlinkify/" class="md-nav__link">
  360. <span class="md-ellipsis">
  361. symlinkify
  362. </span>
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../nullrw/" class="md-nav__link">
  367. <span class="md-ellipsis">
  368. nullrw
  369. </span>
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../xattr/" class="md-nav__link">
  374. <span class="md-ellipsis">
  375. xattr
  376. </span>
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="../nfsopenhack/" class="md-nav__link">
  381. <span class="md-ellipsis">
  382. nfsopenhack
  383. </span>
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="../statfs/" class="md-nav__link">
  388. <span class="md-ellipsis">
  389. statfs / statvfs
  390. </span>
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="../flush-on-close/" class="md-nav__link">
  395. <span class="md-ellipsis">
  396. flush-on-close
  397. </span>
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../export-support/" class="md-nav__link">
  402. <span class="md-ellipsis">
  403. export-support
  404. </span>
  405. </a>
  406. </li>
  407. </ul>
  408. </nav>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../error_handling/" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. Error Handling
  414. </span>
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="../../runtime_interfaces/" class="md-nav__link">
  419. <span class="md-ellipsis">
  420. Runtime Interfaces
  421. </span>
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../remote_filesystems/" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. Remote Filesystems
  428. </span>
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../../tips_notes/" class="md-nav__link">
  433. <span class="md-ellipsis">
  434. Tips and Notes
  435. </span>
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../known_issues_bugs/" class="md-nav__link">
  440. <span class="md-ellipsis">
  441. Known Issues and Bugs
  442. </span>
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="../../project_comparisons/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Project Comparisons
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="../../performance/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Tweaking Performance
  456. </span>
  457. </a>
  458. </li>
  459. <li class="md-nav__item">
  460. <a href="../../benchmarking/" class="md-nav__link">
  461. <span class="md-ellipsis">
  462. Benchmarking
  463. </span>
  464. </a>
  465. </li>
  466. <li class="md-nav__item">
  467. <a href="../../tooling/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Tooling
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item md-nav__item--nested">
  474. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
  475. <label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">
  476. <span class="md-ellipsis">
  477. FAQ
  478. </span>
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
  482. <label class="md-nav__title" for="__nav_14">
  483. <span class="md-nav__icon md-icon"></span>
  484. FAQ
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../../faq/reliability_and_scalability/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Reliability and Scalability
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item">
  495. <a href="../../faq/usage_and_functionality/" class="md-nav__link">
  496. <span class="md-ellipsis">
  497. Usage and Functionality
  498. </span>
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../../faq/configuration_and_policies/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. Configuration and Policies
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../faq/compatibility_and_integration/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. Compatibility and Integration
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../faq/recommendations_and_warnings/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Recommendations and Warnings
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../faq/technical_behavior_and_limitations/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Technical Behavior and Limitations
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../faq/limit_drive_spinup/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Limiting drive spinup
  533. </span>
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../related_projects/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Related Projects
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../media_and_publicity/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Media and Publicity
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../support/" class="md-nav__link">
  555. <span class="md-ellipsis">
  556. Support
  557. </span>
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../sponsorship_and_donations/" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Sponsorship and Donations
  564. </span>
  565. </a>
  566. </li>
  567. </ul>
  568. </nav>
  569. </div>
  570. </div>
  571. </div>
  572. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  573. <div class="md-sidebar__scrollwrap">
  574. <div class="md-sidebar__inner">
  575. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  576. <label class="md-nav__title" for="__toc">
  577. <span class="md-nav__icon md-icon"></span>
  578. Table of contents
  579. </label>
  580. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  581. <li class="md-nav__item">
  582. <a href="#branch-mode" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. branch mode
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="#minfreespace" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. minfreespace
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="#globbing" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. globbing
  599. </span>
  600. </a>
  601. </li>
  602. </ul>
  603. </nav>
  604. </div>
  605. </div>
  606. </div>
  607. <div class="md-content" data-md-component="content">
  608. <article class="md-content__inner md-typeset">
  609. <a href="https://github.com/trapexit/mergerfs/tree/master/mkdocs/docs/config/branches.md" title="Edit this page" class="md-content__button md-icon">
  610. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
  611. </a>
  612. <a href="https://github.com/trapexit/mergerfs/tree/master/mkdocs/docs/config/branches.md" title="View source of this page" class="md-content__button md-icon">
  613. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
  614. </a>
  615. <h1 id="branches">branches</h1>
  616. <p>The 'branches' argument is a colon (':') delimited list of paths to be
  617. pooled together. It does not matter if the paths are on the same or
  618. different filesystems nor does it matter the filesystem type (within
  619. reason). Used and available space will not be duplicated for paths on
  620. the same filesystem and any features which aren't supported by the
  621. underlying filesystem (such as file attributes or extended attributes)
  622. will return the appropriate errors.</p>
  623. <p>Branches currently have two options which can be set. A type which
  624. impacts whether or not the branch is included in a policy calculation
  625. and a individual minfreespace value. The values are set by prepending
  626. an <code>=</code> at the end of a branch designation and using commas as
  627. delimiters. Example: <code>/mnt/drive=RW,1234</code></p>
  628. <h3 id="branch-mode">branch mode</h3>
  629. <ul>
  630. <li>RW: (read/write) - Default behavior. Will be eligible in all policy
  631. categories.</li>
  632. <li>RO: (read-only) - Will be excluded from <code>create</code> and <code>action</code>
  633. policies. Same as a read-only mounted filesystem would be (though
  634. faster to process).</li>
  635. <li>NC: (no-create) - Will be excluded from <code>create</code> policies. You can't
  636. create on that branch but you can change or delete.</li>
  637. </ul>
  638. <h3 id="minfreespace">minfreespace</h3>
  639. <p>Same purpose and syntax as the global option but specific to the
  640. branch. If not set the global value is used.</p>
  641. <h3 id="globbing">globbing</h3>
  642. <p>To make it easier to include multiple branches mergerfs supports
  643. <a href="http://linux.die.net/man/7/glob">globbing</a>. <strong>The globbing tokens
  644. MUST be escaped when using via the shell else the shell itself will
  645. apply the glob itself.</strong></p>
  646. <div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a># mergerfs /mnt/hdd\*:/mnt/ssd /media
  647. </span></code></pre></div>
  648. <p>The above line will use all mount points in /mnt prefixed with <strong>hdd</strong>
  649. and <strong>ssd</strong>.</p>
  650. <p>To have the pool mounted at boot or otherwise accessible from related
  651. tools use <code>/etc/fstab</code>.</p>
  652. <div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a># &lt;file system&gt; &lt;mount point&gt; &lt;type&gt; &lt;options&gt; &lt;dump&gt; &lt;pass&gt;
  653. </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>/mnt/hdd*:/mnt/ssd /media mergerfs minfreespace=16G 0 0
  654. </span></code></pre></div>
  655. <p><strong>NOTE:</strong> The globbing is done at mount or when updated using the runtime API. If a new directory is added matching the glob after the fact it will not be automatically included.</p>
  656. </article>
  657. </div>
  658. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  659. </div>
  660. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  661. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  662. Back to top
  663. </button>
  664. </main>
  665. <footer class="md-footer">
  666. <nav class="md-footer__inner md-grid" aria-label="Footer" >
  667. <a href="../deprecated_options/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Deprecated Options">
  668. <div class="md-footer__button md-icon">
  669. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  670. </div>
  671. <div class="md-footer__title">
  672. <span class="md-footer__direction">
  673. Previous
  674. </span>
  675. <div class="md-ellipsis">
  676. Deprecated Options
  677. </div>
  678. </div>
  679. </a>
  680. <a href="../functions_categories_and_policies/" class="md-footer__link md-footer__link--next" aria-label="Next: functions, categories and policies">
  681. <div class="md-footer__title">
  682. <span class="md-footer__direction">
  683. Next
  684. </span>
  685. <div class="md-ellipsis">
  686. functions, categories and policies
  687. </div>
  688. </div>
  689. <div class="md-footer__button md-icon">
  690. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
  691. </div>
  692. </a>
  693. </nav>
  694. <div class="md-footer-meta md-typeset">
  695. <div class="md-footer-meta__inner md-grid">
  696. <div class="md-copyright">
  697. Made with
  698. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  699. Material for MkDocs
  700. </a>
  701. </div>
  702. </div>
  703. </div>
  704. </footer>
  705. </div>
  706. <div class="md-dialog" data-md-component="dialog">
  707. <div class="md-dialog__inner md-typeset"></div>
  708. </div>
  709. <script id="__config" type="application/json">{"base": "../..", "features": ["content.action.edit", "content.action.view", "content.code.copy", "content.code.select", "navigation.footer", "navigation.instant", "navigation.instant.prefetch", "navigation.path", "navigation.top", "navigation.tracking", "optimize", "search.share", "toc.follow"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
  710. <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
  711. </body>
  712. </html>