From c005463111f3f29169d3b006c063f7335e713dd6 Mon Sep 17 00:00:00 2001
From: Antonio SJ Musumeci <trapexit@spawn.link>
Date: Fri, 4 May 2018 09:00:27 -0400
Subject: [PATCH] change examples to use /mnt rather than /tmp

---
 README.md      | 42 +++++++++++++++++++++++-------------------
 man/mergerfs.1 | 50 +++++++++++++++++++++++++++++---------------------
 2 files changed, 52 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index 85452f6d..fc939894 100644
--- a/README.md
+++ b/README.md
@@ -340,30 +340,30 @@ Output: the policy string except for categories where its funcs have multiple ty
 ##### 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.moveonenospc: false
 ...
 
-[trapexit:/tmp/mount] $ xattr -p user.mergerfs.category.search .mergerfs
+[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.category.search .mergerfs
 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
 
-[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 ####
@@ -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
 
 ```
-[trapexit:/tmp/mount] $ ls
+[trapexit:/mnt/mergerfs] $ ls
 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
-[trapexit:/tmp/mount] $ xattr -p user.mergerfs.basepath A
+[trapexit:/mnt/mergerfs] $ xattr -p user.mergerfs.basepath 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
-[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/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
 
+#### 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?
 
 Yes. MergerFS is a proxy and does **NOT** interfere with the normal form or function of the drives / mounts / paths it manages.
diff --git a/man/mergerfs.1 b/man/mergerfs.1
index 872384c1..e07666ac 100644
--- a/man/mergerfs.1
+++ b/man/mergerfs.1
@@ -1,5 +1,5 @@
 .\"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" ""
 .hy
@@ -700,7 +700,7 @@ $\ sudo\ make\ install
 \f[]
 .fi
 .SH RUNTIME
-.SS \&.mergerfs pseudo file
+.SS .mergerfs pseudo file
 .IP
 .nf
 \f[C]
@@ -796,30 +796,30 @@ In that case it will be a comma separated list
 .IP
 .nf
 \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.moveonenospc:\ false
 \&...
 
-[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.category.search\ .mergerfs
+[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.category.search\ .mergerfs
 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
 
-[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[]
 .fi
 .SS file / directory xattrs
@@ -845,15 +845,15 @@ full paths to all files found
 .IP
 .nf
 \f[C]
-[trapexit:/tmp/mount]\ $\ ls
+[trapexit:/mnt/mergerfs]\ $\ ls
 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
-[trapexit:/tmp/mount]\ $\ xattr\ \-p\ user.mergerfs.basepath\ A
+[trapexit:/mnt/mergerfs]\ $\ xattr\ \-p\ user.mergerfs.basepath\ 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
-[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/b/full/path/to/A
 \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
 files are not used and files are deleted immedately.
 .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
 use?
 .PP