docs/htmldocs/smbmount.8.html

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