1 .TH SSHFS "1" "April 2008" "SSHFS version 2.0" "User Commands"
3 SSHFS \- filesystem client based on ssh
7 \fBsshfs\fP [\fIuser\fP@]\fBhost\fP:[\fIdir\fP] \fBmountpoint\fP [\fIoptions\fP]
10 \fBfusermount -u mountpoint\fP
12 SSHFS (Secure SHell FileSystem) is a file system for Linux (and other
13 operating systems with a FUSE implementation, such as Mac OS X or FreeBSD)
14 capable of operating on files on a remote computer using just a secure
15 shell login on the remote computer. On the local computer where the SSHFS
16 is mounted, the implementation makes use of the FUSE (Filesystem in
17 Userspace) kernel module. The practical effect of this is that the end user
18 can seamlessly interact with remote files being securely served over SSH
19 just as if they were local files on his/her computer. On the remote
20 computer the SFTP subsystem of SSH is used.
22 If \fIhost\fP is a numeric IPv6 address, it needs to be enclosed in
25 .SS "general options:"
27 \fB\-o\fR opt,[opt...]
30 \fB\-h\fR \fB\-\-help\fR
33 \fB\-V\fR \fB\-\-version\fR
38 equivalent to '\-o port=PORT'
41 equivalent to '\-o compression=yes'
43 \fB\-F\fR ssh_configfile
44 specifies alternative ssh configuration file
47 equivalent to '\-o ssh_protocol=1'
52 \fB\-o\fR delay_connect
53 delay connection to server
58 \fB\-o\fR no_readahead
59 synchronous reads (no speculative readahead)
62 print some debugging information
65 enable caching {yes,no} (default: yes)
67 \fB\-o\fR cache_timeout=N
68 sets timeout for caches in seconds (default: 20)
70 \fB\-o\fR cache_X_timeout=N
71 sets timeout for {stat,dir,link} cache
73 \fB\-o\fR workaround=LIST
74 colon separated list of workarounds
78 no workarounds enabled
81 all workarounds enabled
84 fix renaming to existing file (default: off)
87 set nodelay tcp flag in ssh (default: off)
90 fix truncate for old servers (default: off)
93 fix buffer fillup bug in server (default: on)
97 user/group ID mapping, possible types are:
101 no translation of the ID space (default)
104 only translate UID of connecting user
107 translate UIDs/GIDs based upon the contents of \fBuidfile \fR and
111 \fB\-o\fR uidfile=FILE
112 file containing username:uid mappings for \fBidmap=file\fR
115 \fB\-o\fR gidfile=FILE
116 file containing groupname:gid mappings for \fBidmap=file\fR
120 with idmap=file, how to handle missing mappings
124 don't do any re-mapping
127 return an error (default)
130 \fB\-o\fR ssh_command=CMD
131 execute CMD instead of 'ssh'
133 \fB\-o\fR ssh_protocol=N
134 ssh protocol to use (default: 2)
136 \fB\-o\fR sftp_server=SERV
137 path to sftp server or subsystem (default: sftp)
139 \fB\-o\fR directport=PORT
140 directly connect to PORT bypassing ssh
142 communicate over stdin and stdout bypassing network
144 \fB\-o\fR transform_symlinks
145 transform absolute symlinks to relative
147 \fB\-o\fR follow_symlinks
148 follow symlinks on the server
150 \fB\-o\fR no_check_root
151 don't check for existence of 'dir' on server
153 \fB\-o\fR password_stdin
154 read password from stdin (only for pam_mount!)
157 ssh options (see man ssh_config)
160 \fB\-d\fR \fB\-o\fR debug
161 enable debug output (implies \fB\-f\fR)
167 disable multi\-threaded operation
169 \fB\-o\fR allow_other
170 allow access to other users
176 allow mounts over non\-empty file/dir
178 \fB\-o\fR default_permissions
179 enable permission checking by kernel
181 \fB\-o\fR fsname=NAME
184 \fB\-o\fR subtype=NAME
188 issue large read requests (2.4 only)
191 set maximum size of read requests
193 \fB\-o\fR hard_remove
194 immediate removal (don't hide files)
197 let filesystem set inode numbers
199 \fB\-o\fR readdir_ino
200 try to fill in d_ino in readdir
205 \fB\-o\fR kernel_cache
206 cache files in kernel
208 \fB\-o\fR [no]auto_cache
209 enable caching based on modification times
212 set file permissions (octal)
220 \fB\-o\fR entry_timeout=T
221 cache timeout for names (1.0s)
223 \fB\-o\fR negative_timeout=T
224 cache timeout for deleted names (0.0s)
226 \fB\-o\fR attr_timeout=T
227 cache timeout for attributes (1.0s)
229 \fB\-o\fR ac_attr_timeout=T
230 auto cache timeout for attributes (attr_timeout)
233 allow requests to be interrupted
235 \fB\-o\fR intr_signal=NUM
236 signal to send on interrupt (10)
238 \fB\-o\fR modules=M1[:M2...]
239 names of modules to push onto filesystem stack
241 \fB\-o\fR max_write=N
242 set maximum size of write requests
244 \fB\-o\fR max_readahead=N
245 set maximum readahead
248 perform reads asynchronously (default)
251 perform reads synchronously
252 .SS "Module options:"
257 prepend this directory to all paths (mandatory)
259 \fB\-o\fR [no]rellinksa
260 transform absolute symlinks to relative
264 \fB\-o\fR from_code=CHARSET
265 original encoding of file names (default: UTF-8)
267 \fB\-o\fR to_code=CHARSET
268 new encoding of the file names (default: ISO-8859-2)
272 SSHFS has been written by Miklos Szeredi <miklos@szeredi.hu>.
274 This man page was written by Bartosz Fenski <fenio@debian.org> for the
275 Debian GNU/Linux distribution (but it may be used by others).