sshfs.1

   1 .TH SSHFS "1" "April 2008" "SSHFS version 2.0" "User Commands"
   2 .SH NAME
   3 SSHFS \- filesystem client based on ssh
   4 .SH SYNOPSIS
   5 .SS mounting
   6 .TP
   7 \fBsshfs\fP [\fIuser\fP@]\fBhost\fP:[\fIdir\fP] \fBmountpoint\fP [\fIoptions\fP]
   8 .SS unmounting
   9 .TP
  10 \fBfusermount -u mountpoint\fP
  11 .SH DESCRIPTION
  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.
  21 .PP
  22 If \fIhost\fP is a numeric IPv6 address, it needs to be enclosed in
  23 square brackets.
  24 .SH OPTIONS
  25 .SS "general options:"
  26 .TP
  27 \fB\-o\fR opt,[opt...]
  28 mount options
  29 .TP
  30 \fB\-h\fR   \fB\-\-help\fR
  31 print help
  32 .TP
  33 \fB\-V\fR   \fB\-\-version\fR
  34 print version
  35 .SS "SSHFS options:"
  36 .TP
  37 \fB\-p\fR PORT
  38 equivalent to '\-o port=PORT'
  39 .TP
  40 \fB\-C\fR
  41 equivalent to '\-o compression=yes'
  42 .TP
  43 \fB\-F\fR ssh_configfile
  44 specifies alternative ssh configuration file
  45 .TP
  46 \fB\-1\fR
  47 equivalent to '\-o ssh_protocol=1'
  48 .TP
  49 \fB\-o\fR reconnect
  50 reconnect to server
  51 .TP
  52 \fB\-o\fR delay_connect
  53 delay connection to server
  54 .TP
  55 \fB\-o\fR sshfs_sync
  56 synchronous writes
  57 .TP
  58 \fB\-o\fR no_readahead
  59 synchronous reads (no speculative readahead)
  60 .TP
  61 \fB\-o\fR sshfs_debug
  62 print some debugging information
  63 .TP
  64 \fB\-o\fR cache=BOOL
  65 enable caching {yes,no} (default: yes)
  66 .TP
  67 \fB\-o\fR cache_timeout=N
  68 sets timeout for caches in seconds (default: 20)
  69 .TP
  70 \fB\-o\fR cache_X_timeout=N
  71 sets timeout for {stat,dir,link} cache
  72 .TP
  73 \fB\-o\fR workaround=LIST
  74 colon separated list of workarounds
  75 .RS 8
  76 .TP
  77 none
  78 no workarounds enabled
  79 .TP
  80 all
  81 all workarounds enabled
  82 .TP
  83 [no]rename
  84 fix renaming to existing file (default: off)
  85 .TP
  86 [no]nodelaysrv
  87 set nodelay tcp flag in ssh (default: off)
  88 .TP
  89 [no]truncate
  90 fix truncate for old servers (default: off)
  91 .TP
  92 [no]buflimit
  93 fix buffer fillup bug in server (default: on)
  94 .RE
  95 .TP
  96 \fB\-o\fR idmap=TYPE
  97 user/group ID mapping, possible types are:
  98 .RS 8
  99 .TP
 100 none
 101 no translation of the ID space (default)
 102 .TP
 103 user
 104 only translate UID of connecting user
 105 .TP
 106 file
 107 translate UIDs/GIDs based upon the contents of \fBuidfile \fR and
 108 \fBgidfile\fR
 109 .RE
 110 .TP
 111 \fB\-o\fR uidfile=FILE
 112 file containing username:uid mappings for \fBidmap=file\fR
 113 .RE
 114 .TP
 115 \fB\-o\fR gidfile=FILE
 116 file containing groupname:gid mappings for \fBidmap=file\fR
 117 .RE
 118 .TP
 119 \fB\-o\fR nomap=TYPE
 120 with idmap=file, how to handle missing mappings
 121 .RS 8
 122 .TP
 123 ignore
 124 don't do any re-mapping
 125 .TP
 126 error
 127 return an error (default)
 128 .RE
 129 .TP
 130 \fB\-o\fR ssh_command=CMD
 131 execute CMD instead of 'ssh'
 132 .TP
 133 \fB\-o\fR ssh_protocol=N
 134 ssh protocol to use (default: 2)
 135 .TP
 136 \fB\-o\fR sftp_server=SERV
 137 path to sftp server or subsystem (default: sftp)
 138 .TP
 139 \fB\-o\fR directport=PORT
 140 directly connect to PORT bypassing ssh
 141 .TP
 142 \fB\-o\fR transform_symlinks
 143 transform absolute symlinks to relative
 144 .TP
 145 \fB\-o\fR follow_symlinks
 146 follow symlinks on the server
 147 .TP
 148 \fB\-o\fR no_check_root
 149 don't check for existence of 'dir' on server
 150 .TP
 151 \fB\-o\fR password_stdin
 152 read password from stdin (only for pam_mount!)
 153 .TP
 154 \fB\-o\fR SSHOPT=VAL
 155 ssh options (see man ssh_config)
 156 .SS "FUSE options:"
 157 .TP
 158 \fB\-d\fR   \fB\-o\fR debug
 159 enable debug output (implies \fB\-f\fR)
 160 .TP
 161 \fB\-f\fR
 162 foreground operation
 163 .TP
 164 \fB\-s\fR
 165 disable multi\-threaded operation
 166 .TP
 167 \fB\-o\fR allow_other
 168 allow access to other users
 169 .TP
 170 \fB\-o\fR allow_root
 171 allow access to root
 172 .TP
 173 \fB\-o\fR nonempty
 174 allow mounts over non\-empty file/dir
 175 .HP
 176 \fB\-o\fR default_permissions
 177 enable permission checking by kernel
 178 .TP
 179 \fB\-o\fR fsname=NAME
 180 set filesystem name
 181 .TP
 182 \fB\-o\fR subtype=NAME
 183 set filesystem type
 184 .TP
 185 \fB\-o\fR large_read
 186 issue large read requests (2.4 only)
 187 .TP
 188 \fB\-o\fR max_read=N
 189 set maximum size of read requests
 190 .TP
 191 \fB\-o\fR hard_remove
 192 immediate removal (don't hide files)
 193 .TP
 194 \fB\-o\fR use_ino
 195 let filesystem set inode numbers
 196 .TP
 197 \fB\-o\fR readdir_ino
 198 try to fill in d_ino in readdir
 199 .TP
 200 \fB\-o\fR direct_io
 201 use direct I/O
 202 .TP
 203 \fB\-o\fR kernel_cache
 204 cache files in kernel
 205 .TP
 206 \fB\-o\fR [no]auto_cache
 207 enable caching based on modification times
 208 .TP
 209 \fB\-o\fR umask=M
 210 set file permissions (octal)
 211 .TP
 212 \fB\-o\fR uid=N
 213 set file owner
 214 .TP
 215 \fB\-o\fR gid=N
 216 set file group
 217 .TP
 218 \fB\-o\fR entry_timeout=T
 219 cache timeout for names (1.0s)
 220 .TP
 221 \fB\-o\fR negative_timeout=T
 222 cache timeout for deleted names (0.0s)
 223 .TP
 224 \fB\-o\fR attr_timeout=T
 225 cache timeout for attributes (1.0s)
 226 .TP
 227 \fB\-o\fR ac_attr_timeout=T
 228 auto cache timeout for attributes (attr_timeout)
 229 .TP
 230 \fB\-o\fR intr
 231 allow requests to be interrupted
 232 .TP
 233 \fB\-o\fR intr_signal=NUM
 234 signal to send on interrupt (10)
 235 .TP
 236 \fB\-o\fR modules=M1[:M2...]
 237 names of modules to push onto filesystem stack
 238 .TP
 239 \fB\-o\fR max_write=N
 240 set maximum size of write requests
 241 .TP
 242 \fB\-o\fR max_readahead=N
 243 set maximum readahead
 244 .TP
 245 \fB\-o\fR async_read
 246 perform reads asynchronously (default)
 247 .TP
 248 \fB\-o\fR sync_read
 249 perform reads synchronously
 250 .SS "Module options:"
 251 .TP
 252 [subdir]
 253 .TP
 254 \fB\-o\fR subdir=DIR
 255 prepend this directory to all paths (mandatory)
 256 .TP
 257 \fB\-o\fR [no]rellinksa
 258 transform absolute symlinks to relative
 259 .TP
 260 [iconv]
 261 .TP
 262 \fB\-o\fR from_code=CHARSET
 263 original encoding of file names (default: UTF-8)
 264 .TP
 265 \fB\-o\fR to_code=CHARSET
 266 new encoding of the file names (default: ISO-8859-2)
 267 .PD
 268 .SH "AUTHORS"
 269 .LP
 270 SSHFS has been written by Miklos Szeredi <miklos@szeredi.hu>.
 271 .LP
 272 This man page was written by Bartosz Fenski <fenio@debian.org> for the
 273 Debian GNU/Linux distribution (but it may be used by others).
 274
 275