Merge pull request #660 from trapexit/docs

add UPGRADE section

README.md

@@ -1,6 +1,6 @@
 % mergerfs(1) mergerfs user manual
 % Antonio SJ Musumeci <trapexit@spawn.link>
-% 2019-06-03
+% 2019-09-03
 
 # NAME
 
@@ -491,6 +491,20 @@ A B C
 ```
 
 
+# UPGRADE
+
+mergerfs can be upgraded live by mounting on top of the previous version. Simply install the new version of mergerfs and follow the instructions below.
+
+Add `nonempty` to your mergerfs option list and call mergerfs again or if using `/etc/fstab` call for it to mount again. Existing open files and such will continue to work fine though they won't see runtime changes since any such change would be the new mount. If you plan on changing settings with the new mount you should / could apply those before mounting the new version.
+
+```
+$ sudo mount /mnt/mergerfs
+$ mount | grep mergerfs
+media on /mnt/mergerfs type fuse.mergerfs (rw,relatime,user_id=0,group_id=0,default_permissions,allow_other)
+media on /mnt/mergerfs type fuse.mergerfs (rw,relatime,user_id=0,group_id=0,default_permissions,allow_other)
+```
+
+
 # TOOLING
 
 * https://github.com/trapexit/mergerfs-tools
@@ -499,6 +513,7 @@ A B C
   * mergerfs.dedup: Will help identify and optionally remove duplicate files
   * mergerfs.dup: Ensure there are at least N copies of a file across the pool
   * mergerfs.balance: Rebalance files across drives by moving them from the most filled to the least filled
+  * mergerfs.consolidate: move files within a single mergerfs directory to the drive with most free space
   * mergerfs.mktrash: Creates FreeDesktop.org Trash specification compatible directories on a mergerfs mount
 * https://github.com/trapexit/scorch
   * scorch: A tool to help discover silent corruption of files and keep track of files

man/mergerfs.1

@@ -1,7 +1,7 @@
 .\"t
 .\" Automatically generated by Pandoc 1.19.2.4
 .\"
-.TH "mergerfs" "1" "2019\-06\-03" "mergerfs user manual" ""
+.TH "mergerfs" "1" "2019\-09\-03" "mergerfs user manual" ""
 .hy
 .SH NAME
 .PP
@@ -1063,6 +1063,29 @@ A\ B\ C
 /mnt/b/full/path/to/A
 \f[]
 .fi
+.SH UPGRADE
+.PP
+mergerfs can be upgraded live by mounting on top of the previous
+version.
+Simply install the new version of mergerfs and follow the instructions
+below.
+.PP
+Add \f[C]nonempty\f[] to your mergerfs option list and call mergerfs
+again or if using \f[C]/etc/fstab\f[] call for it to mount again.
+Existing open files and such will continue to work fine though they
+won\[aq]t see runtime changes since any such change would be the new
+mount.
+If you plan on changing settings with the new mount you should / could
+apply those before mounting the new version.
+.IP
+.nf
+\f[C]
+$\ sudo\ mount\ /mnt/mergerfs
+$\ mount\ |\ grep\ mergerfs
+media\ on\ /mnt/mergerfs\ type\ fuse.mergerfs\ (rw,relatime,user_id=0,group_id=0,default_permissions,allow_other)
+media\ on\ /mnt/mergerfs\ type\ fuse.mergerfs\ (rw,relatime,user_id=0,group_id=0,default_permissions,allow_other)
+\f[]
+.fi
 .SH TOOLING
 .IP \[bu] 2
 https://github.com/trapexit/mergerfs\-tools
@@ -1081,6 +1104,9 @@ pool
 mergerfs.balance: Rebalance files across drives by moving them from the
 most filled to the least filled
 .IP \[bu] 2
+mergerfs.consolidate: move files within a single mergerfs directory to
+the drive with most free space
+.IP \[bu] 2
 mergerfs.mktrash: Creates FreeDesktop.org Trash specification compatible
 directories on a mergerfs mount
 .IP \[bu] 2