You are on page 1of 4

SSHFS(1)

User Commands

SSHFS(1)

NAME
SSHFS lesystem client based on ssh

SYNOPSIS
mounting sshfs [user@]host:[dir] mountpoint [options] unmounting fusermount -u mountpoint

DESCRIPTION
SSHFS (Secure SHell FileSystem) is a le system for Linux (and other operating systems with a FUSE implementation, such as Mac OS X or FreeBSD) capable of operating on les 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 les being securely served over SSH just as if they were local les 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: o opt,[opt...] mount options h help print help V version print version SSHFS options: p PORT equivalent to o port=PORT C equivalent to o compression=yes F ssh_congle species alternative ssh conguration le 1 equivalent to o ssh_protocol=1 o reconnect reconnect to server o delay_connect delay connection to server o sshfs_sync synchronous writes o no_readahead synchronous reads (no speculative readahead) o sshfs_debug print some debugging information o cache=BOOL enable caching {yes,no} (default: yes) o cache_timeout=N sets timeout for caches in seconds (default: 20) o cache_X_timeout=N sets timeout for {stat,dir,link} cache

SSHFS version 2.0

April 2008

SSHFS(1)

User Commands

SSHFS(1)

o workaround=LIST colon separated list of workarounds none all no workarounds enabled all workarounds enabled

[no]rename x renaming to existing le (default: off) [no]nodelaysrv set nodelay tcp ag in ssh (default: off) [no]truncate x truncate for old servers (default: off) [no]buimit x buffer llup bug in server (default: on) o idmap=TYPE user/group ID mapping, possible types are: none user le no translation of the ID space (default) only translate UID of connecting user translate UIDs/GIDs based upon the contents of uidle and gidle

o uidle=FILE le containing username:uid mappings for idmap=le o gidle=FILE le containing groupname:gid mappings for idmap=le o nomap=TYPE with idmap=le, how to handle missing mappings ignore error dont do any re-mapping return an error (default)

o ssh_command=CMD execute CMD instead of ssh o ssh_protocol=N ssh protocol to use (default: 2) o sftp_server=SERV path to sftp server or subsystem (default: sftp) o directport=PORT directly connect to PORT bypassing ssh o slave communicate over stdin and stdout bypassing network o transform_symlinks transform absolute symlinks to relative o follow_symlinks follow symlinks on the server o no_check_root dont check for existence of dir on server o password_stdin read password from stdin (only for pam_mount!) o SSHOPT=VAL ssh options (see man ssh_cong)

SSHFS version 2.0

April 2008

SSHFS(1)

User Commands

SSHFS(1)

FUSE options: d o debug enable debug output (implies f) f s foreground operation disable multithreaded operation

o allow_other allow access to other users o allow_root allow access to root o nonempty allow mounts over nonempty le/dir o default_permissions enable permission checking by kernel o fsname=NAME set lesystem name o subtype=NAME set lesystem type o large_read issue large read requests (2.4 only) o max_read=N set maximum size of read requests o hard_remove immediate removal (dont hide les) o use_ino let lesystem set inode numbers o readdir_ino try to ll in d_ino in readdir o direct_io use direct I/O o kernel_cache cache les in kernel o [no]auto_cache enable caching based on modication times o umask=M set le permissions (octal) o uid=N set le owner o gid=N set le group o entry_timeout=T cache timeout for names (1.0s) o negative_timeout=T cache timeout for deleted names (0.0s) o attr_timeout=T cache timeout for attributes (1.0s)

SSHFS version 2.0

April 2008

SSHFS(1)

User Commands

SSHFS(1)

o ac_attr_timeout=T auto cache timeout for attributes (attr_timeout) o intr allow requests to be interrupted o intr_signal=NUM signal to send on interrupt (10) o modules=M1[:M2...] names of modules to push onto lesystem stack o max_write=N set maximum size of write requests o max_readahead=N set maximum readahead o async_read perform reads asynchronously (default) o sync_read perform reads synchronously Module options: [subdir] o subdir=DIR prepend this directory to all paths (mandatory) o [no]rellinksa transform absolute symlinks to relative [iconv] o from_code=CHARSET original encoding of le names (default: UTF-8) o to_code=CHARSET new encoding of the le 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).

SSHFS version 2.0

April 2008