docs/htmldocs/smbmount.8.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >smbmount</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
   8 ><BODY
   9 CLASS="REFENTRY"
  10 BGCOLOR="#FFFFFF"
  11 TEXT="#000000"
  12 LINK="#0000FF"
  13 VLINK="#840084"
  14 ALINK="#0000FF"
  15 ><H1
  16 ><A
  17 NAME="SMBMOUNT"
  18 >smbmount</A
  19 ></H1
  20 ><DIV
  21 CLASS="REFNAMEDIV"
  22 ><A
  23 NAME="AEN5"
  24 ></A
  25 ><H2
  26 >Name</H2
  27 >smbmount&nbsp;--&nbsp;mount an smbfs filesystem</DIV
  28 ><DIV
  29 CLASS="REFSYNOPSISDIV"
  30 ><A
  31 NAME="AEN8"
  32 ></A
  33 ><H2
  34 >Synopsis</H2
  35 ><P
  36 ><B
  37 CLASS="COMMAND"
  38 >smbmount</B
  39 >  {service} {mount-point} [-o options]</P
  40 ></DIV
  41 ><DIV
  42 CLASS="REFSECT1"
  43 ><A
  44 NAME="AEN14"
  45 ></A
  46 ><H2
  47 >DESCRIPTION</H2
  48 ><P
  49 ><B
  50 CLASS="COMMAND"
  51 >smbmount</B
  52 > mounts a Linux SMB filesystem. It
  53         is usually invoked as <B
  54 CLASS="COMMAND"
  55 >mount.smbfs</B
  56 > by
  57         the <B
  58 CLASS="COMMAND"
  59 >mount(8)</B
  60 > command when using the
  61         "-t smbfs" option. This command only works in Linux, and the kernel must
  62         support the smbfs filesystem. </P
  63 ><P
  64 >Options to <B
  65 CLASS="COMMAND"
  66 >smbmount</B
  67 > are specified as a comma-separated
  68         list of key=value pairs. It is possible to send options other
  69         than those listed here, assuming that smbfs supports them. If
  70         you get mount failures, check your kernel log for errors on
  71         unknown options.</P
  72 ><P
  73 ><B
  74 CLASS="COMMAND"
  75 >smbmount</B
  76 > is a daemon. After mounting it keeps running until
  77         the mounted smbfs is umounted. It will log things that happen
  78         when in daemon mode using the "machine name" smbmount, so
  79         typically this output will end up in <TT
  80 CLASS="FILENAME"
  81 >log.smbmount</TT
  82 >. The
  83         <B
  84 CLASS="COMMAND"
  85 >smbmount</B
  86 > process may also be called mount.smbfs.</P
  87 ><P
  88 ><EM
  89 >NOTE:</EM
  90 > <B
  91 CLASS="COMMAND"
  92 >smbmount</B
  93 >
  94         calls <B
  95 CLASS="COMMAND"
  96 >smbmnt(8)</B
  97 > to do the actual mount. You
  98         must make sure that <B
  99 CLASS="COMMAND"
 100 >smbmnt</B
 101 > is in the path so
 102         that it can be found. </P
 103 ></DIV
 104 ><DIV
 105 CLASS="REFSECT1"
 106 ><A
 107 NAME="AEN31"
 108 ></A
 109 ><H2
 110 >OPTIONS</H2
 111 ><P
 112 ></P
 113 ><DIV
 114 CLASS="VARIABLELIST"
 115 ><DL
 116 ><DT
 117 >username=&#60;arg&#62;</DT
 118 ><DD
 119 ><P
 120 >specifies the username to connect as. If
 121                 this is not given, then the environment variable <TT
 122 CLASS="ENVAR"
 123 >               USER</TT
 124 > is used. This option can also take the
 125                 form "user%password" or "user/workgroup" or
 126                 "user/workgroup%password" to allow the password and workgroup
 127                 to be specified as part of the username.</P
 128 ></DD
 129 ><DT
 130 >password=&#60;arg&#62;</DT
 131 ><DD
 132 ><P
 133 >specifies the SMB password. If this
 134                 option is not given then the environment variable
 135                 <TT
 136 CLASS="ENVAR"
 137 >PASSWD</TT
 138 > is used. If it can find
 139                 no password <B
 140 CLASS="COMMAND"
 141 >smbmount</B
 142 > will prompt
 143                 for a passeword, unless the guest option is
 144                 given. </P
 145 ><P
 146 >               Note that password which contain the arguement delimiter
 147                 character (i.e. a comma ',') will failed to be parsed correctly
 148                 on the command line.  However, the same password defined
 149                 in the PASSWD environment variable or a credentials file (see
 150                 below) will be read correctly.
 151                 </P
 152 ></DD
 153 ><DT
 154 >credentials=&#60;filename&#62;</DT
 155 ><DD
 156 ><P
 157 >specifies a file that contains a username
 158                 and/or password. The format of the file is:</P
 159 ><P
 160 >               <TABLE
 161 BORDER="0"
 162 BGCOLOR="#E0E0E0"
 163 WIDTH="90%"
 164 ><TR
 165 ><TD
 166 ><PRE
 167 CLASS="PROGRAMLISTING"
 168 >               username = &#60;value&#62;
 169                 password = &#60;value&#62;
 170                 </PRE
 171 ></TD
 172 ></TR
 173 ></TABLE
 174 >
 175                 </P
 176 ><P
 177 >This is preferred over having passwords in plaintext in a
 178                 shared file, such as <TT
 179 CLASS="FILENAME"
 180 >/etc/fstab</TT
 181 >. Be sure to protect any
 182                 credentials file properly.
 183                 </P
 184 ></DD
 185 ><DT
 186 >netbiosname=&#60;arg&#62;</DT
 187 ><DD
 188 ><P
 189 >sets the source NetBIOS name. It defaults
 190                 to the local hostname. </P
 191 ></DD
 192 ><DT
 193 >uid=&#60;arg&#62;</DT
 194 ><DD
 195 ><P
 196 >sets the uid that will own all files on
 197                 the mounted filesystem.
 198                 It may be specified as either a username or a numeric uid.
 199                 </P
 200 ></DD
 201 ><DT
 202 >gid=&#60;arg&#62;</DT
 203 ><DD
 204 ><P
 205 >sets the gid that will own all files on
 206                 the mounted filesystem.
 207                 It may be specified as either a groupname or a numeric
 208                 gid. </P
 209 ></DD
 210 ><DT
 211 >port=&#60;arg&#62;</DT
 212 ><DD
 213 ><P
 214 >sets the remote SMB port number. The default
 215                 is 139. </P
 216 ></DD
 217 ><DT
 218 >fmask=&#60;arg&#62;</DT
 219 ><DD
 220 ><P
 221 >sets the file mask. This determines the
 222                 permissions that remote files have in the local filesystem.
 223                 The default is based on the current umask. </P
 224 ></DD
 225 ><DT
 226 >dmask=&#60;arg&#62;</DT
 227 ><DD
 228 ><P
 229 >sets the directory mask. This determines the
 230                 permissions that remote directories have in the local filesystem.
 231                 The default is based on the current umask. </P
 232 ></DD
 233 ><DT
 234 >debug=&#60;arg&#62;</DT
 235 ><DD
 236 ><P
 237 >sets the debug level. This is useful for
 238                 tracking down SMB connection problems. A suggested value to
 239                 start with is 4. If set too high there will be a lot of
 240                 output, possibly hiding the useful output.</P
 241 ></DD
 242 ><DT
 243 >ip=&#60;arg&#62;</DT
 244 ><DD
 245 ><P
 246 >sets the destination host or IP address.
 247                 </P
 248 ></DD
 249 ><DT
 250 >workgroup=&#60;arg&#62;</DT
 251 ><DD
 252 ><P
 253 >sets the workgroup on the destination </P
 254 ></DD
 255 ><DT
 256 >sockopt=&#60;arg&#62;</DT
 257 ><DD
 258 ><P
 259 >sets the TCP socket options. See the <A
 260 HREF="smb.conf.5.html#SOCKETOPTIONS"
 261 TARGET="_top"
 262 ><TT
 263 CLASS="FILENAME"
 264 >smb.conf
 265                 </TT
 266 ></A
 267 > <TT
 268 CLASS="PARAMETER"
 269 ><I
 270 >socket options</I
 271 ></TT
 272 > option.
 273                 </P
 274 ></DD
 275 ><DT
 276 >scope=&#60;arg&#62;</DT
 277 ><DD
 278 ><P
 279 >sets the NetBIOS scope </P
 280 ></DD
 281 ><DT
 282 >guest</DT
 283 ><DD
 284 ><P
 285 >don't prompt for a password </P
 286 ></DD
 287 ><DT
 288 >ro</DT
 289 ><DD
 290 ><P
 291 >mount read-only </P
 292 ></DD
 293 ><DT
 294 >rw</DT
 295 ><DD
 296 ><P
 297 >mount read-write </P
 298 ></DD
 299 ><DT
 300 >iocharset=&#60;arg&#62;</DT
 301 ><DD
 302 ><P
 303 >               sets the charset used by the Linux side for codepage
 304                 to charset translations (NLS). Argument should be the
 305                 name of a charset, like iso8859-1. (Note: only kernel
 306                 2.4.0 or later)
 307                 </P
 308 ></DD
 309 ><DT
 310 >codepage=&#60;arg&#62;</DT
 311 ><DD
 312 ><P
 313 >               sets the codepage the server uses. See the iocharset
 314                 option. Example value cp850. (Note: only kernel 2.4.0
 315                 or later)
 316                 </P
 317 ></DD
 318 ><DT
 319 >ttl=&#60;arg&#62;</DT
 320 ><DD
 321 ><P
 322 >               how long a directory listing is cached in milliseconds
 323                 (also affects visibility of file size and date
 324                 changes). A higher value means that changes on the
 325                 server take longer to be noticed but it can give
 326                 better performance on large directories, especially
 327                 over long distances. Default is 1000ms but something
 328                 like 10000ms (10 seconds) is probably more reasonable
 329                 in many cases.
 330                 (Note: only kernel 2.4.2 or later)
 331                 </P
 332 ></DD
 333 ></DL
 334 ></DIV
 335 ></DIV
 336 ><DIV
 337 CLASS="REFSECT1"
 338 ><A
 339 NAME="AEN125"
 340 ></A
 341 ><H2
 342 >ENVIRONMENT VARIABLES</H2
 343 ><P
 344 >The variable <TT
 345 CLASS="ENVAR"
 346 >USER</TT
 347 > may contain the username of the
 348         person using the client.  This information is used only if the
 349         protocol level is high enough to support session-level
 350         passwords. The variable can be used to set both username and
 351         password by using the format username%password.</P
 352 ><P
 353 >The variable <TT
 354 CLASS="ENVAR"
 355 >PASSWD</TT
 356 > may contain the password of the
 357         person using the client.  This information is used only if the
 358         protocol level is high enough to support session-level
 359         passwords.</P
 360 ><P
 361 >The variable <TT
 362 CLASS="ENVAR"
 363 >PASSWD_FILE</TT
 364 > may contain the pathname
 365         of a file to read the password from. A single line of input is
 366         read and used as the password.</P
 367 ></DIV
 368 ><DIV
 369 CLASS="REFSECT1"
 370 ><A
 371 NAME="AEN133"
 372 ></A
 373 ><H2
 374 >BUGS</H2
 375 ><P
 376 >Passwords and other options containing , can not be handled.
 377         For passwords an alternative way of passing them is in a credentials
 378         file or in the PASSWD environment.</P
 379 ><P
 380 >The credentials file does not handle usernames or passwords with
 381         leading space.</P
 382 ><P
 383 >One smbfs bug is important enough to mention here, even if it
 384         is a bit misplaced:</P
 385 ><P
 386 ></P
 387 ><UL
 388 ><LI
 389 ><P
 390 >Mounts sometimes stop working. This is usually
 391         caused by smbmount terminating. Since smbfs needs smbmount to
 392         reconnect when the server disconnects, the mount will eventually go
 393         dead. An umount/mount normally fixes this. At least 2 ways to
 394         trigger this bug are known.</P
 395 ></LI
 396 ></UL
 397 ><P
 398 >Note that the typical response to a bug report is suggestion
 399         to try the latest version first. So please try doing that first,
 400         and always include which versions you use of relevant software
 401         when reporting bugs (minimum: samba, kernel, distribution)</P
 402 ></DIV
 403 ><DIV
 404 CLASS="REFSECT1"
 405 ><A
 406 NAME="AEN142"
 407 ></A
 408 ><H2
 409 >SEE ALSO</H2
 410 ><P
 411 >Documentation/filesystems/smbfs.txt in the linux kernel
 412         source tree may contain additional options and information.</P
 413 ><P
 414 >FreeBSD also has a smbfs, but it is not related to smbmount</P
 415 ><P
 416 >For Solaris, HP-UX and others you may want to look at
 417         <A
 418 HREF="smbsh.1.html"
 419 TARGET="_top"
 420 ><B
 421 CLASS="COMMAND"
 422 >smbsh(1)</B
 423 ></A
 424 > or at other
 425         solutions, such as sharity or perhaps replacing the SMB server with
 426         a NFS server.</P
 427 ></DIV
 428 ><DIV
 429 CLASS="REFSECT1"
 430 ><A
 431 NAME="AEN149"
 432 ></A
 433 ><H2
 434 >AUTHOR</H2
 435 ><P
 436 >Volker Lendecke, Andrew Tridgell, Michael H. Warfield
 437         and others.</P
 438 ><P
 439 >The current maintainer of smbfs and the userspace
 440         tools <B
 441 CLASS="COMMAND"
 442 >smbmount</B
 443 >, <B
 444 CLASS="COMMAND"
 445 >smbumount</B
 446 >,
 447         and <B
 448 CLASS="COMMAND"
 449 >smbmnt</B
 450 > is <A
 451 HREF="mailto:urban@teststation.com"
 452 TARGET="_top"
 453 >Urban Widmark</A
 454 >.
 455         The <A
 456 HREF="mailto:samba@samba.org"
 457 TARGET="_top"
 458 >SAMBA Mailing list</A
 459 >
 460         is the preferred place to ask questions regarding these programs.
 461         </P
 462 ><P
 463 >The conversion of this manpage for Samba 2.2 was performed
 464         by Gerald Carter</P
 465 ></DIV
 466 ></BODY
 467 ></HTML
 468 >