Mirror
/
mergerfs
mirror of https://github.com/trapexit/mergerfs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #482 from trapexit/docs 

change examples to use /mnt rather than /tmp
pull/493/head
trapexit 7 years ago
committed by GitHub
parent
50384f4e86 c005463111
commit
4b1f9afe1e
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 40 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 42
      README.md
  2. 50
      man/mergerfs.1

42
README.md
View File

@ -340,30 +340,30 @@ Output: the policy string except for categories where its funcs have multiple ty
##### Example ##### ##### Example #####
``` ```
[trapexit:/tmp/mount] $ xattr -l .mergerfs
user.mergerfs.srcmounts: /tmp/a:/tmp/b
[trapexit:/mnt/mergerfs] $ xattr -l .mergerfs
user.mergerfs.srcmounts: /mnt/a:/mnt/b
user.mergerfs.minfreespace: 4294967295 user.mergerfs.minfreespace: 4294967295
user.mergerfs.moveonenospc: false user.mergerfs.moveonenospc: false
... ...
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.category.search .mergerfs
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.category.search .mergerfs
ff ff
[trapexit:/tmp/mount] $ xattr -w user.mergerfs.category.search newest .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.category.search .mergerfs
[trapexit:/mnt/mergerfs] $ xattr -w user.mergerfs.category.search newest .mergerfs
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.category.search .mergerfs
newest newest
[trapexit:/tmp/mount] $ xattr -w user.mergerfs.srcmounts +/tmp/c .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.srcmounts .mergerfs
/tmp/a:/tmp/b:/tmp/c
[trapexit:/mnt/mergerfs] $ xattr -w user.mergerfs.srcmounts +/mnt/c .mergerfs
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.srcmounts .mergerfs
/mnt/a:/mnt/b:/mnt/c
[trapexit:/tmp/mount] $ xattr -w user.mergerfs.srcmounts =/tmp/c .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.srcmounts .mergerfs
/tmp/c
[trapexit:/mnt/mergerfs] $ xattr -w user.mergerfs.srcmounts =/mnt/c .mergerfs
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.srcmounts .mergerfs
/mnt/c
[trapexit:/tmp/mount] $ xattr -w user.mergerfs.srcmounts '+</tmp/a:/tmp/b' .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.srcmounts .mergerfs
/tmp/a:/tmp/b:/tmp/c
[trapexit:/mnt/mergerfs] $ xattr -w user.mergerfs.srcmounts '+</mnt/a:/mnt/b' .mergerfs
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.srcmounts .mergerfs
/mnt/a:/mnt/b:/mnt/c
``` ```
#### file / directory xattrs #### #### file / directory xattrs ####
@ -376,15 +376,15 @@ While they won't show up when using [listxattr](http://linux.die.net/man/2/listx
* **user.mergerfs.allpaths:** a NUL ('\0') separated list of full paths to all files found * **user.mergerfs.allpaths:** a NUL ('\0') separated list of full paths to all files found
``` ```
[trapexit:/tmp/mount] $ ls
[trapexit:/mnt/mergerfs] $ ls
A B C A B C
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.fullpath A
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.fullpath A
/mnt/a/full/path/to/A /mnt/a/full/path/to/A
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.basepath A
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.basepath A
/mnt/a /mnt/a
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.relpath A
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.relpath A
/full/path/to/A /full/path/to/A
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.allpaths A | tr '\0' '\n'
[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.allpaths A | tr '\0' '\n'
/mnt/a/full/path/to/A /mnt/a/full/path/to/A
/mnt/b/full/path/to/A /mnt/b/full/path/to/A
``` ```
@ -610,6 +610,10 @@ Using the **hard_remove** option will make it so these temporary files are not u
# FAQ # FAQ
#### How well does mergerfs scale? Is it "production ready?"
Users have reported running mergerfs on everything from a Raspberry Pi to dual socket Xeon systems with >20 cores. I'm aware of at least a few companies which use mergerfs in production. [Open Media Vault](https://www.openmediavault.org) includes mergerfs is it's sole solution for pooling drives.
#### Can mergerfs be used with drives which already have data / are in use? #### Can mergerfs be used with drives which already have data / are in use?
Yes. MergerFS is a proxy and does **NOT** interfere with the normal form or function of the drives / mounts / paths it manages. Yes. MergerFS is a proxy and does **NOT** interfere with the normal form or function of the drives / mounts / paths it manages.

50
man/mergerfs.1
View File

@ -1,5 +1,5 @@
.\"t .\"t
.\" Automatically generated by Pandoc 1.16.0.2
.\" Automatically generated by Pandoc 1.19.2.4
.\" .\"
.TH "mergerfs" "1" "2018\-03\-09" "mergerfs user manual" "" .TH "mergerfs" "1" "2018\-03\-09" "mergerfs user manual" ""
.hy .hy
@ -700,7 +700,7 @@ $\ sudo\ make\ install
\f[] \f[]
.fi .fi
.SH RUNTIME .SH RUNTIME
.SS \&.mergerfs pseudo file
.SS .mergerfs pseudo file
.IP .IP
.nf .nf
\f[C] \f[C]
@ -796,30 +796,30 @@ In that case it will be a comma separated list
.IP .IP
.nf .nf
\f[C] \f[C]
[trapexit:/tmp/mount]\ $\ xattr\ \-l\ .mergerfs
user.mergerfs.srcmounts:\ /tmp/a:/tmp/b
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-l\ .mergerfs
user.mergerfs.srcmounts:\ /mnt/a:/mnt/b
user.mergerfs.minfreespace:\ 4294967295 user.mergerfs.minfreespace:\ 4294967295
user.mergerfs.moveonenospc:\ false user.mergerfs.moveonenospc:\ false
\&... \&...
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.category.search\ .mergerfs
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.category.search\ .mergerfs
ff ff
[trapexit:/tmp/mount]\ $\ xattr\ \-w\ user.mergerfs.category.search\ newest\ .mergerfs
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.category.search\ .mergerfs
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-w\ user.mergerfs.category.search\ newest\ .mergerfs
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.category.search\ .mergerfs
newest newest
[trapexit:/tmp/mount]\ $\ xattr\ \-w\ user.mergerfs.srcmounts\ +/tmp/c\ .mergerfs
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.srcmounts\ .mergerfs
/tmp/a:/tmp/b:/tmp/c
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-w\ user.mergerfs.srcmounts\ +/mnt/c\ .mergerfs
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.srcmounts\ .mergerfs
/mnt/a:/mnt/b:/mnt/c
[trapexit:/tmp/mount]\ $\ xattr\ \-w\ user.mergerfs.srcmounts\ =/tmp/c\ .mergerfs
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.srcmounts\ .mergerfs
/tmp/c
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-w\ user.mergerfs.srcmounts\ =/mnt/c\ .mergerfs
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.srcmounts\ .mergerfs
/mnt/c
[trapexit:/tmp/mount]\ $\ xattr\ \-w\ user.mergerfs.srcmounts\ \[aq]+</tmp/a:/tmp/b\[aq]\ .mergerfs
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.srcmounts\ .mergerfs
/tmp/a:/tmp/b:/tmp/c
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-w\ user.mergerfs.srcmounts\ \[aq]+</mnt/a:/mnt/b\[aq]\ .mergerfs
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.srcmounts\ .mergerfs
/mnt/a:/mnt/b:/mnt/c
\f[] \f[]
.fi .fi
.SS file / directory xattrs .SS file / directory xattrs
@ -845,15 +845,15 @@ full paths to all files found
.IP .IP
.nf .nf
\f[C] \f[C]
[trapexit:/tmp/mount]\ $\ ls
[trapexit:/mnt/mergerfs]\ $\ ls
A\ B\ C A\ B\ C
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.fullpath\ A
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.fullpath\ A
/mnt/a/full/path/to/A /mnt/a/full/path/to/A
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.basepath\ A
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.basepath\ A
/mnt/a /mnt/a
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.relpath\ A
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.relpath\ A
/full/path/to/A /full/path/to/A
[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.allpaths\ A\ |\ tr\ \[aq]\\0\[aq]\ \[aq]\\n\[aq]
[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.allpaths\ A\ |\ tr\ \[aq]\\0\[aq]\ \[aq]\\n\[aq]
/mnt/a/full/path/to/A /mnt/a/full/path/to/A
/mnt/b/full/path/to/A /mnt/b/full/path/to/A
\f[] \f[]
@ -1309,6 +1309,14 @@ account of the hidden file being still there.
Using the \f[B]hard_remove\f[] option will make it so these temporary Using the \f[B]hard_remove\f[] option will make it so these temporary
files are not used and files are deleted immedately. files are not used and files are deleted immedately.
.SH FAQ .SH FAQ
.SS How well does mergerfs scale? Is it "production ready?"
.PP
Users have reported running mergerfs on everything from a Raspberry Pi
to dual socket Xeon systems with >20 cores.
I\[aq]m aware of at least a few companies which use mergerfs in
production.
Open Media Vault (https://www.openmediavault.org) includes mergerfs is
it\[aq]s sole solution for pooling drives.
.SS Can mergerfs be used with drives which already have data / are in .SS Can mergerfs be used with drives which already have data / are in
use? use?
.PP .PP

Write Preview
Loading…
Cancel
Save