1 .\" $NetBSD: mount_psshfs.8,v 1.24 2010/02/03 17:16:29 pooka Exp $
3 .\" Copyright (c) 2007-2009 Antti Kantee. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Nd sshfs implementation for puffs
40 utility can be used to mount a file system using the ssh sftp
41 subprotocol, making a remote directory hierarchy appear in the
43 This functionality is commonly known as
46 The mandatory parameters are the target host name and local mount
48 The target host parameter can optionally contain a username whose
49 credentials will be used by the remote sshd, and a relative or
50 absolute path for the remote mount point's root.
51 If no user is given, the credentials of the user issuing the mount
53 If no path is given, the user's home directory on the remote machine
56 The following command line options are available:
61 connections to the server.
62 Currently, the value has to be 1 or 2.
63 If 2 is specified, a second connection is opened for the reading
64 and writing of data, while directory operations are performed on
66 This can greatly increase directory operation performance (ls,
69 completely saturates the available bandwidth by doing bulk data copying.
72 Makes the mounted file system NFS exportable.
73 If this option is used, it is very important to understand that
75 can not provide complete support for NFS due to the limitations in
77 Files are valid only for the time that
79 is running and in the event of e.g. a server crash, all client retries
80 to access files will fail.
81 .It Fl F Ar configfile
82 Pass a configuration file to
84 This will make it ignore the system-wide
85 .Pa /etc/ssh/ssh_config
86 configuration file and use
93 to the effective gid of the file server and vice versa.
96 .It Fl o Ar [no]option
97 This flag can be used to give standard mount options and options
99 .It Fl O Ar sshopt=value
104 For a list of valid options, see
110 to try to reconnect to the server if the connection fails.
111 The option is very experimental and does not preserve open files
112 or retry current requests and should generally only be used if the
113 trade-offs are well understood.
114 .It Fl r Ar max_reads
115 Limits maximum outstanding read requests for each node to
117 This can be used to improve interactive performance on low-bandwidth links
118 when also performing bulk data reads.
120 This flag can be used to make the program stay on top.
121 The default is to detach from the terminal and run in the background.
125 caches directory contents and node attributes for 30 seconds before
126 re-fetching from the server to check if anything has changed on
128 This option is used to adjust the timeout period to
131 A value 0 means the cache is never valid and \-1 means it is
133 It is possible to force a re-read regardless of timeout status by sending
139 Note: the file system will still free nodes when requested by the
140 kernel and will lose all cached information in doing so.
141 How frequently this happens depends on system activity and the total
142 number of available vnodes in the system (kern.maxvnodes).
143 .It Fl u Ar mangleuid
146 to the effective uid of the file server and vice versa.
147 .\"This is a simple special case of the functionality of
148 .\".Xr mount_umap 8 .
149 For example: you mount remote me@darkmoon as the local user "me".
150 If the uid of "me" on the local system is 101 and on
151 darkmoon it is 202, you would use
154 to see files owned by 202 on darkmoon as owned by 101 when browsing the
156 Apart from the cosmetic effect, this makes things like
157 "chown me file" work.
162 The following example illustrates how to mount the directory
170 with ssh transport compression enabled:
171 .Bd -literal -offset indent
172 mount_psshfs -O Compression=yes abc@bigiron:/usr /mnt
175 It is possible to use
177 for psshfs mounts, with SSH public key authentication:
179 .Dl "abc@bigiron:/usr /mnt psshfs rw,noauto,-O=BatchMode=yes,-O=IdentityFile=/root/.ssh/id_rsa,-t=-1"
191 utility first appeared in
193 It was inspired by FUSE sshfs.
195 Permissions are not handled.
196 Do not expect the file system to behave except for a single user.
198 Depending on if the server supports the
200 stavfs protocol extension,
201 free disk space may be displayed for the mount by
203 This information reflects the status at the server's mountpoint
204 and may differ for subdiretories under the mount root.