Updated manual page with missing options.

Fixes: libfuse#82.
joncv · Sep 20, 2017 · 85b950d · 85b950d
1 parent b32c4a4
commit 85b950d
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 15 deletions.
diff --git a/ChangeLog.rst b/ChangeLog.rst
@@ -1,3 +1,8 @@
+Unreleased Changes
+------------------
+
+* Added missing options to man page.
+
 Release 3.2.0 (2017-08-06)
 --------------------------
 

diff --git a/sshfs.rst b/sshfs.rst
@@ -153,10 +153,8 @@ Options
    communicate over stdin and stdout bypassing network
 
 -o disable_hardlink
-   `link(2)` will return with errno set to ENOSYS.  Hard links
-   don't currently work perfectly on sshfs, and this confuses some
-   programs.  If that happens try disabling hard links with this
-   option.
+   With this option set, attempts to call `link(2)` will fail with
+   error code ENOSYS.
 
 -o transform_symlinks
    transform absolute symlinks on remote side to relative
@@ -177,6 +175,44 @@ Options
 -o password_stdin
    read password from stdin (only for pam_mount!)
 
+-o writeback_cache=BOOL
+   Enables (*yes*) or disables (*no*) the FUSE writeback cache. When
+   writeback caching is enabled, write operations are not immediately
+   sent to the SSH server but first collected and merged locally. This
+   can significantly improve performance. However, if the file is
+   changed on the server while there are unsent changes on the client,
+   data corruption is likely to result.
+
+-o unreliable_append
+   When writeback caching is enabled, SSHFS cannot reliably support
+   the ``O_APPEND`` open flag and thus signals an error on open.  To
+   enable support for unreliable ``O_APPEND`` (which may overwrite
+   data if the file changes on the server at a bad time), mount the
+   file system with ``-o unreliable_append``.
+
+-o dir_cache=BOOL
+   Enables (*yes*) or disables (*no*) the SSHFS directory cache.  The
+   directory cache holds the names of directory entries. Enabling it
+   allows `readdir(3)` system calls to be processed without network
+   access.
+
+-o dcache_max_size=N
+   sets the maximum size of the directory cache.
+
+-o dcache_timeout=N
+   sets timeout for directory cache in seconds.
+
+-o dcache_{stat,link,dir}_timeout=N
+   sets separate timeout for {attributes, symlinks, names} in  the
+   directory cache.
+
+-o dcache_clean_interval=N
+   sets the interval for automatic cleaning of the directory cache.
+
+-o dcache_min_clean_interval=N
+   sets the interval for forced cleaning of the directory cache
+   when full.
+
 In addition, SSHFS accepts several options common to all FUSE file
 systems. These are described in the `mount.fuse` manpage (look
 for "general", "libfuse specific", and "high-level API" options).
@@ -206,17 +242,6 @@ someone (or something) recreates the destination file after SSHFS has
 removed it, but before SSHFS had the time to rename the old file. In
 this case, the rename will still fail.
 
-
-O_APPEND
-~~~~~~~~
-
-When writeback caching is enabled, SSHFS cannot reliably support the
-``O_APPEND`` open flag and thus signals an error on open.  To enable
-support for unreliable ``O_APPEND`` (which may overwrite data if the
-file changes on the server at a bad time), mount the file system with
-``-o unreliable_append``.
-
-
 See also
 ========