Scroll to navigation

SSHFS(1) User Commands SSHFS(1)

NAME

SSHFS - filesystem client based on ssh

SYNOPSIS

mounting

unmounting

DESCRIPTION

SSHFS (Secure SHell FileSystem) is a file system for Linux (and other operating systems with a FUSE implementation, such as Mac OS X or FreeBSD) capable of operating on files on a remote computer using just a secure shell login on the remote computer. On the local computer where the SSHFS is mounted, the implementation makes use of the FUSE (Filesystem in Userspace) kernel module. The practical effect of this is that the end user can seamlessly interact with remote files being securely served over SSH just as if they were local files on his/her computer. On the remote computer the SFTP subsystem of SSH is used.

If host is a numeric IPv6 address, it needs to be enclosed in square brackets.

OPTIONS

general options:

mount options
print help
print version

SSHFS options:

equivalent to '-o port=PORT'
equivalent to '-o compression=yes'
specifies alternative ssh configuration file
-1
equivalent to '-o ssh_protocol=1'
reconnect to server
delay connection to server
synchronous writes
synchronous reads (no speculative readahead)
synchronous readdir
print some debugging information
enable caching {yes,no} (default: yes)
sets timeout for caches in seconds (default: 20)
sets timeout for {stat,dir,link} cache
colon separated list of workarounds
no workarounds enabled
all workarounds enabled
[no]rename
fix renaming to existing file (default: off)
[no]nodelaysrv
set nodelay tcp flag in ssh (default: off)
[no]truncate
fix truncate for old servers (default: off)
[no]buflimit
fix buffer fillup bug in server (default: on)
user/group ID mapping (default: none)
no translation of the ID space
only translate UID/GID of connecting user
translate UIDs/GIDs based upon the contents of uidfile and gidfile
file containing username:uid mappings for idmap=file

file containing groupname:gid mappings for idmap=file

with idmap=file, how to handle missing mappings
don't do any re-mapping
return an error (default)
execute CMD instead of 'ssh'
ssh protocol to use (default: 2)
path to sftp server or subsystem (default: sftp)
directly connect to PORT bypassing ssh -o slave communicate over stdin and stdout bypassing network
communicate over stdin and stdout bypassing network
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.
transform absolute symlinks to relative
follow symlinks on the server
don't check for existence of 'dir' on server
read password from stdin (only for pam_mount!)
ssh options (see man ssh_config)

FUSE options:

enable debug output (implies -f)
foreground operation
disable multi-threaded operation
allow access to other users
allow access to root
allow mounts over non-empty file/dir

-o default_permissions enable permission checking by kernel

set filesystem name
set filesystem type
issue large read requests (2.4 only)
set maximum size of read requests
immediate removal (don't hide files)
let filesystem set inode numbers
try to fill in d_ino in readdir
use direct I/O
cache files in kernel
enable caching based on modification times
set file permissions (octal)
set file owner
set file group
cache timeout for names (1.0s)
cache timeout for deleted names (0.0s)
cache timeout for attributes (1.0s)
auto cache timeout for attributes (attr_timeout)
allow requests to be interrupted
signal to send on interrupt (10)
names of modules to push onto filesystem stack
set maximum size of write requests
set maximum readahead
perform reads asynchronously (default)
perform reads synchronously

Module options:

[subdir]
prepend this directory to all paths (mandatory)
transform absolute symlinks to relative
[iconv]
original encoding of file names (default: UTF-8)
new encoding of the file names (default: ISO-8859-2)

AUTHORS

SSHFS has been written by Miklos Szeredi <miklos@szeredi.hu>.

This man page was written by Bartosz Fenski <fenio@debian.org> for the Debian GNU/Linux distribution (but it may be used by others).

April 2008 SSHFS version 2.0