1 .\" Man page generated from reStructuredText.
2 .
3 .TH SSHFS 1 "" "" "User Commands"
4 .SH NAME
5 SSHFS \- filesystem client based on SSH
6 .
7 .nr rst2man-indent-level 0
8 .
9 .de1 rstReportMargin
10 \\$1 \\n[an-margin]
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13 -
14 \\n[rst2man-indent0]
15 \\n[rst2man-indent1]
16 \\n[rst2man-indent2]
17 ..
18 .de1 INDENT
19 .\" .rstReportMargin pre:
20 . RS \\$1
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
24 ..
25 .de UNINDENT
26 . RE
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32 ..
33 .SH SYNOPSIS
34 .sp
35 To mount a filesystem:
36 .INDENT 0.0
37 .INDENT 3.5
38 .sp
39 .nf
40 .ft C
41 sshfs [user@]host:[dir] mountpoint [options]
42 .ft P
43 .fi
44 .UNINDENT
45 .UNINDENT
46 .sp
47 If \fIhost\fP is a numeric IPv6 address, it needs to be enclosed in square
48 brackets.
49 .sp
50 To unmount it:
51 .INDENT 0.0
52 .INDENT 3.5
53 .sp
54 .nf
55 .ft C
56 fusermount3 \-u mountpoint # Linux
57 umount mountpoint # OS X, FreeBSD
58 .ft P
59 .fi
60 .UNINDENT
61 .UNINDENT
62 .SH DESCRIPTION
63 .sp
64 SSHFS allows you to mount a remote filesystem using SSH (more
65 precisely, the SFTP subsystem). Most SSH servers support and enable
66 this SFTP access by default, so SSHFS is very simple to use \- there\(aqs
67 nothing to do on the server\-side.
68 .sp
69 SSHFS uses FUSE (Filesystem in Userspace) and should work on any
70 operating system that provides a FUSE implementation. Currently,
71 this includes Linux, FreeBSD and Mac OS X.
72 .sp
73 It is recommended to run SSHFS as regular user (not as root). For
74 this to work the mountpoint must be owned by the user. If username is
75 omitted SSHFS will use the local username. If the directory is
76 omitted, SSHFS will mount the (remote) home directory. If you need to
77 enter a password sshfs will ask for it (actually it just runs ssh
78 which ask for the password if needed).
79 .SH OPTIONS
80 .INDENT 0.0
81 .TP
82 .B \-o opt,[opt...]
83 mount options, see below for details. A a variety of SSH options can
84 be given here as well, see the manual pages for \fIsftp(1)\fP and
85 \fIssh_config(5)\fP\&.
86 .UNINDENT
87 .INDENT 0.0
88 .TP
89 .B \-h\fP,\fB \-\-help
90 print help and exit.
91 .TP
92 .B \-V\fP,\fB \-\-version
93 print version information and exit.
94 .TP
95 .B \-d\fP,\fB \-\-debug
96 print debugging information.
97 .TP
98 .BI \-p \ PORT
99 equivalent to \(aq\-o port=PORT\(aq
100 .TP
101 .B \-f
102 do not daemonize, stay in foreground.
103 .TP
104 .B \-s
105 Single threaded operation.
106 .TP
107 .B \-C
108 equivalent to \(aq\-o compression=yes\(aq
109 .TP
110 .BI \-F \ ssh_configfile
111 specifies alternative ssh configuration file
112 .TP
113 .B \-1
114 equivalent to \(aq\-o ssh_protocol=1\(aq
115 .TP
116 .BI \-o \ reconnect
117 automatically reconnect to server if connection is
118 interrupted. Attempts to access files that were opened before the
119 reconnection will give errors and need to be re\-opened.
120 .TP
121 .BI \-o \ delay_connect
122 Don\(aqt immediately connect to server, wait until mountpoint is first
123 accessed.
124 .TP
125 .BI \-o \ sshfs_sync
126 synchronous writes. This will slow things down, but may be useful
127 in some situations.
128 .TP
129 .BI \-o \ no_readahead
130 Only read exactly the data that was requested, instead of
131 speculatively reading more to anticipate the next read request.
132 .TP
133 .BI \-o \ sync_readdir
134 synchronous readdir. This will slow things down, but may be useful
135 in some situations.
136 .UNINDENT
137 .INDENT 0.0
138 .TP
139 .B \-o workaround=LIST
140 Enable the specified workaround. See the \fICaveats\fP section below
141 for some additional information. Possible values are:
142 .INDENT 7.0
143 .TP
144 .B rename
145 Emulate overwriting an existing file by deleting and
146 renaming.
147 .TP
148 .B truncate
149 Work around servers that don\(aqt support truncate by
150 coping the whole file, truncating it locally, and sending it
151 back.
152 .TP
153 .B fstat
154 Work around broken servers that don\(aqt support \fIfstat()\fP by
155 using \fIstat\fP instead.
156 .TP
157 .B buflimit
158 Work around OpenSSH "buffer fillup" bug.
159 .UNINDENT
160 .TP
161 .B \-o idmap=TYPE
162 How to map remote UID/GIDs to local values. Possible values are:
163 .INDENT 7.0
164 .TP
165 .B none
166 no translation of the ID space (default).
167 .TP
168 .B user
169 map the UID/GID of the remote user to UID/GID of the
170 mounting user.
171 .TP
172 .B file
173 translate UIDs/GIDs based upon the contents of \fI\-\-uidfile\fP
174 and \fI\-\-gidfile\fP\&.
175 .UNINDENT
176 .TP
177 .B \-o uidfile=FILE
178 file containing \fBusername:uid\fP mappings for \fI\-o idmap=file\fP
179 .TP
180 .B \-o gidfile=FILE
181 file containing \fBgroupname:gid\fP mappings for \fI\-o idmap=file\fP
182 .TP
183 .B \-o nomap=TYPE
184 with idmap=file, how to handle missing mappings:
185 .INDENT 7.0
186 .TP
187 .B ignore
188 don\(aqt do any re\-mapping
189 .TP
190 .B error
191 return an error (default)
192 .UNINDENT
193 .TP
194 .B \-o ssh_command=CMD
195 execute CMD instead of \(aqssh\(aq
196 .TP
197 .B \-o ssh_protocol=N
198 ssh protocol to use (default: 2)
199 .TP
200 .B \-o sftp_server=SERV
201 path to sftp server or subsystem (default: sftp)
202 .TP
203 .B \-o directport=PORT
204 directly connect to PORT bypassing ssh
205 .UNINDENT
206 .INDENT 0.0
207 .TP
208 .BI \-o \ slave
209 communicate over stdin and stdout bypassing network
210 .TP
211 .BI \-o \ disable_hardlink
212 With this option set, attempts to call \fIlink(2)\fP will fail with
213 error code ENOSYS.
214 .TP
215 .BI \-o \ transform_symlinks
216 transform absolute symlinks on remote side to relative
217 symlinks. This means that if e.g. on the server side
218 \fB/foo/bar/com\fP is a symlink to \fB/foo/blub\fP, SSHFS will
219 transform the link target to \fB\&../blub\fP on the client side.
220 .TP
221 .BI \-o \ follow_symlinks
222 follow symlinks on the server, i.e. present them as regular
223 files on the client. If a symlink is dangling (i.e, the target does
224 not exist) the behavior depends on the remote server \- the entry
225 may appear as a symlink on the client, or it may appear as a
226 regular file that cannot be accessed.
227 .TP
228 .BI \-o \ no_check_root
229 don\(aqt check for existence of \(aqdir\(aq on server
230 .TP
231 .BI \-o \ password_stdin
232 read password from stdin (only for pam_mount!)
233 .UNINDENT
234 .INDENT 0.0
235 .TP
236 .B \-o dir_cache=BOOL
237 Enables (\fIyes\fP) or disables (\fIno\fP) the SSHFS directory cache. The
238 directory cache holds the names of directory entries. Enabling it
239 allows \fIreaddir(3)\fP system calls to be processed without network
240 access.
241 .TP
242 .B \-o dcache_max_size=N
243 sets the maximum size of the directory cache.
244 .TP
245 .B \-o dcache_timeout=N
246 sets timeout for directory cache in seconds.
247 .TP
248 .B \-o dcache_{stat,link,dir}_timeout=N
249 sets separate timeout for {attributes, symlinks, names} in the
250 directory cache.
251 .TP
252 .B \-o dcache_clean_interval=N
253 sets the interval for automatic cleaning of the directory cache.
254 .TP
255 .B \-o dcache_min_clean_interval=N
256 sets the interval for forced cleaning of the directory cache
257 when full.
258 .UNINDENT
259 .sp
260 In addition, SSHFS accepts several options common to all FUSE file
261 systems. These are described in the \fImount.fuse\fP manpage (look
262 for "general", "libfuse specific", and "high\-level API" options).
263 .SH CAVEATS / WORKAROUNDS
264 .SS Hardlinks
265 .sp
266 If the SSH server supports the \fIhardlinks\fP extension, SSHFS will allow
267 you to create hardlinks. However, hardlinks will always appear as
268 individual files when seen through an SSHFS mount, i.e. they will
269 appear to have different inodes and an \fIst_nlink\fP value of 1.
270 .SS Rename
271 .sp
272 Some SSH servers do not support atomically overwriting the destination
273 when renaming a file. In this case you will get an error when you
274 attempt to rename a file and the destination already exists. A
275 workaround is to first remove the destination file, and then do the
276 rename. SSHFS can do this automatically if you call it with \fI\-o
277 workaround=rename\fP\&. However, in this case it is still possible that
278 someone (or something) recreates the destination file after SSHFS has
279 removed it, but before SSHFS had the time to rename the old file. In
280 this case, the rename will still fail.
281 .SS SSHFS hangs
282 .sp
283 In some cases, attempts to access the SSHFS mountpoint may freeze if
284 no filesystem activity has occured for some time. This is typically
285 caused by the SSH connection being dropped because of inactivity
286 without SSHFS being informed about that. As a workaround, you can try
287 to mount with \fB\-o ServerAliveInterval=15\fP\&. This will force the SSH
288 connection to stay alive even if you have no activity.
289 .SH MOUNTING FROM /ETC/FSTAB
290 .sp
291 To mount an SSHFS filesystem from \fB/etc/fstab\fP, simply use \fBsshfs\(ga
292 as the file system type. (For backwards compatibility, you may also
293 use \(ga\(gafuse.sshfs\fP).
294 .SH SEE ALSO
295 .sp
296 The \fImount.fuse(8)\fP manpage.
297 .SH GETTING HELP
298 .sp
299 If you need help, please ask on the <\fI\%fuse\-sshfs@lists.sourceforge.net\fP>
300 mailing list (subscribe at
301 \fI\%https://lists.sourceforge.net/lists/listinfo/fuse\-sshfs\fP).
302 .sp
303 Please report any bugs on the GitHub issue tracker at
304 \fI\%https://github.com/libfuse/libfuse/issues\fP\&.
305 .SH AUTHORS
306 .sp
307 SSHFS is currently maintained by Nikolaus Rath <\fI\%Nikolaus@rath.org\fP>,
308 and was created by Miklos Szeredi <\fI\%miklos@szeredi.hu\fP>.
309 .sp
310 This man page was originally written by Bartosz Fenski
311 <\fI\%fenio@debian.org\fP> for the Debian GNU/Linux distribution (but it may
312 be used by others).
313 .\" Generated by docutils manpage writer.
314 .
|
