1SSHFS(1)                         User Commands                        SSHFS(1)
2
3
4

NAME

6       SSHFS - filesystem client based on ssh
7

SYNOPSIS

9   mounting
10       sshfs [user@]host:[dir] mountpoint [options]
11
12   unmounting
13       fusermount -u mountpoint
14

DESCRIPTION

16       SSHFS  (Secure  SHell FileSystem) is a file system for Linux (and other
17       operating systems with a FUSE implementation, such as Mac OS X or Free‐
18       BSD)  capable  of  operating on files on a remote computer using just a
19       secure shell login on the remote computer. On the local computer  where
20       the  SSHFS  is  mounted,  the  implementation  makes  use  of  the FUSE
21       (Filesystem in Userspace) kernel module. The practical effect  of  this
22       is  that  the  end user can seamlessly interact with remote files being
23       securely served over SSH just as if they were local  files  on  his/her
24       computer. On the remote computer the SFTP subsystem of SSH is used.
25
26       If  host  is  a numeric IPv6 address, it needs to be enclosed in square
27       brackets.
28

OPTIONS

30   general options:
31       -o opt,[opt...]
32              mount options
33
34       -h   --help
35              print help
36
37       -V   --version
38              print version
39
40   SSHFS options:
41       -p PORT
42              equivalent to '-o port=PORT'
43
44       -C     equivalent to '-o compression=yes'
45
46       -F ssh_configfile
47              specifies alternative ssh configuration file
48
49       -1     equivalent to '-o ssh_protocol=1'
50
51       -o reconnect
52              reconnect to server
53
54       -o delay_connect
55              delay connection to server
56
57       -o sshfs_sync
58              synchronous writes
59
60       -o no_readahead
61              synchronous reads (no speculative readahead)
62
63       -o sshfs_debug
64              print some debugging information
65
66       -o cache=BOOL
67              enable caching {yes,no} (default: yes)
68
69       -o cache_timeout=N
70              sets timeout for caches in seconds (default: 20)
71
72       -o cache_X_timeout=N
73              sets timeout for {stat,dir,link} cache
74
75       -o workaround=LIST
76              colon separated list of workarounds
77
78               none   no workarounds enabled
79
80               all    all workarounds enabled
81
82               [no]rename
83                      fix renaming to existing file (default: off)
84
85               [no]nodelaysrv
86                      set nodelay tcp flag in ssh (default: off)
87
88               [no]truncate
89                      fix truncate for old servers (default: off)
90
91               [no]buflimit
92                      fix buffer fillup bug in server (default: on)
93
94       -o idmap=TYPE
95              user/group ID mapping, possible types are:
96
97               none   no translation of the ID space (default)
98
99               user   only translate UID of connecting user
100
101       -o ssh_command=CMD
102              execute CMD instead of 'ssh'
103
104       -o ssh_protocol=N
105              ssh protocol to use (default: 2)
106
107       -o sftp_server=SERV
108              path to sftp server or subsystem (default: sftp)
109
110       -o directport=PORT
111              directly connect to PORT bypassing ssh
112
113       -o transform_symlinks
114              transform absolute symlinks to relative
115
116       -o follow_symlinks
117              follow symlinks on the server
118
119       -o no_check_root
120              don't check for existence of 'dir' on server
121
122       -o password_stdin
123              read password from stdin (only for pam_mount!)
124
125       -o SSHOPT=VAL
126              ssh options (see man ssh_config)
127
128   FUSE options:
129       -d   -o debug
130              enable debug output (implies -f)
131
132       -f     foreground operation
133
134       -s     disable multi-threaded operation
135
136       -o allow_other
137              allow access to other users
138
139       -o allow_root
140              allow access to root
141
142       -o nonempty
143              allow mounts over non-empty file/dir
144
145       -o default_permissions enable permission checking by kernel
146
147       -o fsname=NAME
148              set filesystem name
149
150       -o subtype=NAME
151              set filesystem type
152
153       -o large_read
154              issue large read requests (2.4 only)
155
156       -o max_read=N
157              set maximum size of read requests
158
159       -o hard_remove
160              immediate removal (don't hide files)
161
162       -o use_ino
163              let filesystem set inode numbers
164
165       -o readdir_ino
166              try to fill in d_ino in readdir
167
168       -o direct_io
169              use direct I/O
170
171       -o kernel_cache
172              cache files in kernel
173
174       -o [no]auto_cache
175              enable caching based on modification times
176
177       -o umask=M
178              set file permissions (octal)
179
180       -o uid=N
181              set file owner
182
183       -o gid=N
184              set file group
185
186       -o entry_timeout=T
187              cache timeout for names (1.0s)
188
189       -o negative_timeout=T
190              cache timeout for deleted names (0.0s)
191
192       -o attr_timeout=T
193              cache timeout for attributes (1.0s)
194
195       -o ac_attr_timeout=T
196              auto cache timeout for attributes (attr_timeout)
197
198       -o intr
199              allow requests to be interrupted
200
201       -o intr_signal=NUM
202              signal to send on interrupt (10)
203
204       -o modules=M1[:M2...]
205              names of modules to push onto filesystem stack
206
207       -o max_write=N
208              set maximum size of write requests
209
210       -o max_readahead=N
211              set maximum readahead
212
213       -o async_read
214              perform reads asynchronously (default)
215
216       -o sync_read
217              perform reads synchronously
218
219   Module options:
220       [subdir]
221
222       -o subdir=DIR
223              prepend this directory to all paths (mandatory)
224
225       -o [no]rellinksa
226              transform absolute symlinks to relative
227
228       [iconv]
229
230       -o from_code=CHARSET
231              original encoding of file names (default: UTF-8)
232
233       -o to_code=CHARSET
234              new encoding of the file names (default: ISO-8859-2)
235

AUTHORS

237       SSHFS has been written by Miklos Szeredi <miklos@szeredi.hu>.
238
239       This man page was written by Bartosz Fenski <fenio@debian.org> for  the
240       Debian GNU/Linux distribution (but it may be used by others).
241
242
243
244
245
246SSHFS version 2.0                 April 2008                          SSHFS(1)