Copyright (c) 2007 Antti Kantee. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd May 9, 2007 .Dt MOUNT_PSSHFS 8 .Os .Sh NAME .Nm mount_psshfs .Nd sshfs implementation for puffs .Sh SYNOPSIS .Nm .Op Ar options .Ar user@host[:path] .Ar mount_point .Sh DESCRIPTION The .Nm utility can be used to mount a file system using the ssh sftp subprotocol, making a remote directory hierarchy appear in the local directory tree. This functionality is commonly known as .Em sshfs .
p The mandatory parameters are the target host name and local mount point. The target host parameter can optionally contain a username whose credentials will be used by the remote sshd, and a relative or absolute path for the remote mountpoint's root. If no user is given, the credentials of the user issuing the mount command are used. If no path is given, the user's home directory on the remote machine will be used.
p The following command line options are available:
p l -tag -width xxx t Fl e Makes the mounted file system nfs exportable. If this option is used, it is very important to understand that .Nm can not provide complete support for nfs due to the limitations in the backend. Files are valid only for the time that .Nm is running and in the event of e.g. a server crash, all client retries to access files will fail. t Fl o Ar [no]option This flag can be used to give standard mount options and options to puffs. The most notable of these is .Fl o Ar nocache , which disables the name cache and page cache for the file system. It slows operations down, but will behave better when multiple entities are accessing the same directory tree via various routes. t Fl O Ar sshopt=value Pass an option to .Xr ssh 1 , for example .Fl O Ar Port=22 . For a list of valid options, see .Xr ssh_config 5 . t Fl s This flag can be used to make the program stay on top. The default is to detach from the terminal and run in the background. .El .Sh EXAMPLES The following example illustrates how to mount the directory .Em /usr on server .Em bigiron as user .Em abc on local directory .Em /mnt with ssh transport compression enabled: d -literal -offset indent mount_psshfs -O Compression=yes abc@bigiron:/usr /mnt .Ed
p It is possible to use .Xr fstab 5 for psshfs mounts, with SSH public key authentication:
p .Dl "abc@bigiron:/usr /mnt psshfs rw,noauto,-O=BatchMode=yes,-O=IdentityFile=/root/.ssh/id_rsa 0 0" .Sh SEE ALSO .Xr fstab 5 , .Xr sftp 1 , .Xr puffs 3 , .Xr puffs 4 , .Xr mount 8 , .Xr ssh_config 5 , .Xr sshd 8 .Sh HISTORY The .Nm utility first appeared in .Nx 5.0 . .Sh CAVEATS Permissions are not handled. Do not expect the file system to behave except for a single user.
Indexes created Thu Oct 23 22:10:10 GMT 2025