aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikolaus Rath <Nikolaus@rath.org>2017-09-19 22:34:50 +0100
committerNikolaus Rath <Nikolaus@rath.org>2017-09-19 22:34:50 +0100
commite4de7d257f463beb89d61f951547bd277866c4bb (patch)
tree58d9a4ca7082c24882ed36622349bfa07b2febf1
parent2a818faea50a7a6fb1bda61027edeb25db007ad0 (diff)
downloadsshfs-e4de7d257f463beb89d61f951547bd277866c4bb.tar
sshfs-e4de7d257f463beb89d61f951547bd277866c4bb.tar.gz
sshfs-e4de7d257f463beb89d61f951547bd277866c4bb.tar.bz2
sshfs-e4de7d257f463beb89d61f951547bd277866c4bb.zip
Improve documentation for symlink handling options.
Fixes: #51.
-rw-r--r--sshfs.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/sshfs.rst b/sshfs.rst
index f768fa0..cc55d27 100644
--- a/sshfs.rst
+++ b/sshfs.rst
@@ -159,11 +159,17 @@ Options
option.
-o transform_symlinks
- transform absolute symlinks on remote side to relative symlinks.
+ transform absolute symlinks on remote side to relative
+ symlinks. This means that if e.g. on the server side
+ ``/foo/bar/com`` is a symlink to ``/foo/blub``, SSHFS will
+ transform the link target to ``../blub`` on the client side.
-o follow_symlinks
follow symlinks on the server, i.e. present them as regular
- files on the client.
+ files on the client. If a symlink is dangling (i.e, the target does
+ not exist) the behavior depends on the remote server - the entry
+ may appear as a symlink on the client, or it may appear as a
+ regular file that cannot be accessed.
-o no_check_root
don't check for existence of 'dir' on server