aboutsummaryrefslogtreecommitdiffstats
path: root/src/bindfs.1
diff options
context:
space:
mode:
authorMartin Pärtel <martin.partel@gmail.com>2015-09-20 18:59:02 +0100
committerMartin Pärtel <martin.partel@gmail.com>2015-09-20 19:12:01 +0100
commita2f68ef6ae14522291458ff587c39c28cee430dc (patch)
treeac9d32a7665609dfe5b44e0c0d4d0d12251c5e12 /src/bindfs.1
parent7d8af8cc90ac8a986c3322e3b564eb33dc2794cb (diff)
downloadbindfs-a2f68ef6ae14522291458ff587c39c28cee430dc.tar.gz
Improved and documented --resolve_symlinks in some edge cases.
Diffstat (limited to 'src/bindfs.1')
-rw-r--r--src/bindfs.138
1 files changed, 29 insertions, 9 deletions
diff --git a/src/bindfs.1 b/src/bindfs.1
index 55fc349..01887ac 100644
--- a/src/bindfs.1
+++ b/src/bindfs.1
@@ -221,6 +221,35 @@ following (1024-based) suffixes: \fBk\fP, \fBM\fP, \fBG\fP, \fBT\fP.
.B \-\-write\-rate=\fIN\fP, \-o write\-rate=\fIN\fP
Same as above, but for writes.
+.SH LINK HANDLING
+
+.TP
+.B \-\-hide\-hard\-links, \-o hide\-hard\-links
+Shows the hard link count of all files as 1.
+
+.TP
+.B \-\-resolve\-symlinks, \-o resolve-symlinks
+Transparently resolves symbolic links. Disables creation of new symbolic
+links.
+
+With the following exceptions, operations will operate directly on the target
+file instead of the symlink. Renaming/moving a resolved symlink (inside the same
+mount point) will move the symlink instead of the underlying file. Deleting a
+resolved symlink will delete the underlying symlink but not the destination
+file. This can be configured with \fB\-\-resolved-symlink-deletion\fP.
+
+Note that when some programs, such as \fBvim\fP, save files, they actually move
+the old file out of the way, create a new file in its place, and finally delete
+the old file. Doing these operations on a resolved symlink will replace it with
+a regular file.
+
+Symlinks pointing outside the source directory are supported with the following
+exception: accessing the mountpoint recursively through a resolved symlink is
+not supported and will return an error. This is because a FUSE filesystem cannot
+reliably call itself recursively without deadlocking, especially in
+single-threaded mode.
+
+
.SH MISCELLANEOUS OPTIONS
.TP
@@ -259,15 +288,6 @@ will be reflected in a mirrored file's ctime.
The underlying file's ctime will still be updated normally.
.TP
-.B \-\-hide-hard-links, \-o hide-hard-links
-Shows the hard link count of all files as 1.
-
-.TP
-.B \-\-resolve\-symlinks, \-o resolve-symlinks
-Transparently resolves symbolic links. Disables creation of new symbolic
-links.
-
-.TP
.B \-\-multithreaded, \-o multithreaded
Run bindfs in multithreaded mode. While bindfs is designed to be
otherwise thread-safe, there is currently a race condition that may pose