github-mirror/mergerfs
2
0
Fork 0
mirror of https://github.com/trapexit/mergerfs.git synced 2025-02-02 11:36:15 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #817 from trapexit/readme

Browse Source 
README.md: add note indicating only tagged releases are supported
This commit is contained in:
trapexit 2020-08-26 11:03:50 -04:00 committed by GitHub
commit 9424784fad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -1,6 +1,6 @@
% mergerfs(1) mergerfs user manual % mergerfs(1) mergerfs user manual
% Antonio SJ Musumeci <trapexit@spawn.link> % Antonio SJ Musumeci <trapexit@spawn.link>
% 2020-08-20 % 2020-08-26
# NAME # NAME
@ -412,7 +412,8 @@ The options `statfs` and `statfs_ignore` can be used to modify `statfs` behavior
# BUILD / UPDATE # BUILD / UPDATE
**NOTE:** Prebuilt packages can be found at: https://github.com/trapexit/mergerfs/releases **NOTE:** Prebuilt packages can be found at and recommended for most users: https://github.com/trapexit/mergerfs/releases
**NOTE:** Only tagged releases are supported. `master` and other branches should be considered works in progress.
First get the code from [github](https://github.com/trapexit/mergerfs). First get the code from [github](https://github.com/trapexit/mergerfs).

51
man/mergerfs.1
View File

@ -1,7 +1,7 @@
.\"t .\"t
.\" Automatically generated by Pandoc 1.19.2.4 .\" Automatically generated by Pandoc 1.19.2.4
.\" .\"
.TH "mergerfs" "1" "2020\-08\-20" "mergerfs user manual" "" .TH "mergerfs" "1" "2020\-08\-26" "mergerfs user manual" ""
.hy .hy
.SH NAME .SH NAME
.PP .PP
@ -736,8 +736,8 @@ _
T{ T{
all all
T}@T{ T}@T{
Search: same as \f[B]epall\f[]. Search: Same as \f[B]epall\f[].
Action: same as \f[B]epall\f[]. Action: Same as \f[B]epall\f[].
Create: for \f[B]mkdir\f[], \f[B]mknod\f[], and \f[B]symlink\f[] it will Create: for \f[B]mkdir\f[], \f[B]mknod\f[], and \f[B]symlink\f[] it will
apply to all branches. apply to all branches.
\f[B]create\f[] works like \f[B]ff\f[]. \f[B]create\f[] works like \f[B]ff\f[].
@ -745,7 +745,7 @@ T}
T{ T{
epall (existing path, all) epall (existing path, all)
T}@T{ T}@T{
Search: same as \f[B]epff\f[] (but more expensive because it doesn\[aq]t Search: Same as \f[B]epff\f[] (but more expensive because it doesn\[aq]t
stop after finding a valid branch). stop after finding a valid branch).
Action: apply to all found. Action: apply to all found.
Create: for \f[B]mkdir\f[], \f[B]mknod\f[], and \f[B]symlink\f[] it will Create: for \f[B]mkdir\f[], \f[B]mknod\f[], and \f[B]symlink\f[] it will
@ -797,61 +797,61 @@ T}
T{ T{
ff (first found) ff (first found)
T}@T{ T}@T{
Search: same as \f[B]epff\f[]. Search: Same as \f[B]epff\f[].
Action: same as \f[B]epff\f[]. Action: Same as \f[B]epff\f[].
Create: Given the order of the drives, as defined at mount time or Create: Given the order of the drives, as defined at mount time or
configured at runtime, act on the first one found. configured at runtime, act on the first one found.
T} T}
T{ T{
lfs (least free space) lfs (least free space)
T}@T{ T}@T{
Search: same as \f[B]eplfs\f[]. Search: Same as \f[B]eplfs\f[].
Action: same as \f[B]eplfs\f[]. Action: Same as \f[B]eplfs\f[].
Create: Pick the drive with the least available free space. Create: Pick the drive with the least available free space.
T} T}
T{ T{
lus (least used space) lus (least used space)
T}@T{ T}@T{
Search: same as \f[B]eplus\f[]. Search: Same as \f[B]eplus\f[].
Action: same as \f[B]eplus\f[]. Action: Same as \f[B]eplus\f[].
Create: Pick the drive with the least used space. Create: Pick the drive with the least used space.
T} T}
T{ T{
mfs (most free space) mfs (most free space)
T}@T{ T}@T{
Search: same as \f[B]epmfs\f[]. Search: Same as \f[B]epmfs\f[].
Action: same as \f[B]epmfs\f[]. Action: Same as \f[B]epmfs\f[].
Create: Pick the drive with the most available free space. Create: Pick the drive with the most available free space.
T} T}
T{ T{
msplfs (most shared path, least free space) msplfs (most shared path, least free space)
T}@T{ T}@T{
Search: same as \f[B]eplfs\f[]. Search: Same as \f[B]eplfs\f[].
Action: same as \f[B]eplfs\f[]. Action: Same as \f[B]eplfs\f[].
Create: like \f[B]eplfs\f[] but walk back the path if it fails to find a Create: like \f[B]eplfs\f[] but walk back the path if it fails to find a
branch at that level. branch at that level.
T} T}
T{ T{
msplus (most shared path, least used space) msplus (most shared path, least used space)
T}@T{ T}@T{
Search: same as \f[B]eplus\f[]. Search: Same as \f[B]eplus\f[].
Action: same as \f[B]eplus\f[]. Action: Same as \f[B]eplus\f[].
Create: like \f[B]eplus\f[] but walk back the path if it fails to find a Create: like \f[B]eplus\f[] but walk back the path if it fails to find a
branch at that level. branch at that level.
T} T}
T{ T{
mspmfs (most shared path, most free space) mspmfs (most shared path, most free space)
T}@T{ T}@T{
Search: same as \f[B]epmfss\f[]. Search: Same as \f[B]epmfss\f[].
Action: same as \f[B]epmfs\f[]. Action: Same as \f[B]epmfs\f[].
Create: like \f[B]eplmfs\f[] but walk back the path if it fails to find Create: like \f[B]eplmfs\f[] but walk back the path if it fails to find
a branch at that level. a branch at that level.
T} T}
T{ T{
msppfrd (most shared path, percentage free random distribution) msppfrd (most shared path, percentage free random distribution)
T}@T{ T}@T{
Search: same as \f[B]eppfrd\f[]. Search: Same as \f[B]eppfrd\f[].
Action: same as \f[B]eppfrd\f[]. Action: Same as \f[B]eppfrd\f[].
Create: Like \f[B]eppfrd\f[] but will walk back the path if it fails to Create: Like \f[B]eppfrd\f[] but will walk back the path if it fails to
find a branch at that level. find a branch at that level.
T} T}
@ -863,8 +863,8 @@ T}
T{ T{
pfrd (percentage free random distribution) pfrd (percentage free random distribution)
T}@T{ T}@T{
Search: same as \f[B]eppfrd\f[]. Search: Same as \f[B]eppfrd\f[].
Action: same as \f[B]eppfrd\f[]. Action: Same as \f[B]eppfrd\f[].
Create: Chooses a branch at random with the likelihood of selection Create: Chooses a branch at random with the likelihood of selection
based on a branch\[aq]s available space relative to the total. based on a branch\[aq]s available space relative to the total.
T} T}
@ -1077,8 +1077,11 @@ The options \f[C]statfs\f[] and \f[C]statfs_ignore\f[] can be used to
modify \f[C]statfs\f[] behavior. modify \f[C]statfs\f[] behavior.
.SH BUILD / UPDATE .SH BUILD / UPDATE
.PP .PP
\f[B]NOTE:\f[] Prebuilt packages can be found at: \f[B]NOTE:\f[] Prebuilt packages can be found at and recommended for
https://github.com/trapexit/mergerfs/releases most users: https://github.com/trapexit/mergerfs/releases \f[B]NOTE:\f[]
Only tagged releases are supported.
\f[C]master\f[] and other branches should be considered works in
progress.
.PP .PP
First get the code from github (https://github.com/trapexit/mergerfs). First get the code from github (https://github.com/trapexit/mergerfs).
.IP .IP