docs/htmldocs/smbmount.8.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbmount</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbmount.8"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbmount &#8212; mount an smbfs filesystem</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbmount</tt>  {service} {mount-point} [-o options]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p><b class="command">smbmount</b> mounts a Linux SMB filesystem. It
   2         is usually invoked as <b class="command">mount.smbfs</b> by
   3         the <a href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the
   4         &quot;-t smbfs&quot; option. This command only works in Linux, and the kernel must
   5         support the smbfs filesystem. </p><p>Options to <b class="command">smbmount</b> are specified as a comma-separated
   6         list of key=value pairs. It is possible to send options other
   7         than those listed here, assuming that smbfs supports them. If
   8         you get mount failures, check your kernel log for errors on
   9         unknown options.</p><p><b class="command">smbmount</b> is a daemon. After mounting it keeps running until
  10         the mounted smbfs is umounted. It will log things that happen
  11         when in daemon mode using the &quot;machine name&quot; smbmount, so
  12         typically this output will end up in <tt class="filename">log.smbmount</tt>. The <b class="command">
  13         smbmount</b> process may also be called mount.smbfs.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> <b class="command">smbmount</b>
  14         calls <a href="smbmnt.8.html"><span class="citerefentry"><span class="refentrytitle">smbmnt</span>(8)</span></a> to do the actual mount. You
  15         must make sure that <b class="command">smbmnt</b> is in the path so
  16         that it can be found. </p></div></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">username=&lt;arg&gt;</span></dt><dd><p>specifies the username to connect as. If
  17                 this is not given, then the environment variable <tt class="envar">
  18                 USER</tt> is used. This option can also take the
  19                 form &quot;user%password&quot; or &quot;user/workgroup&quot; or
  20                 &quot;user/workgroup%password&quot; to allow the password and workgroup
  21                 to be specified as part of the username.</p></dd><dt><span class="term">password=&lt;arg&gt;</span></dt><dd><p>specifies the SMB password. If this
  22                 option is not given then the environment variable
  23                 <tt class="envar">PASSWD</tt> is used. If it can find
  24                 no password <b class="command">smbmount</b> will prompt
  25                 for a passeword, unless the guest option is
  26                 given. </p><p>
  27                 Note that passwords which contain the argument delimiter
  28                 character (i.e. a comma ',') will failed to be parsed correctly
  29                 on the command line.  However, the same password defined
  30                 in the PASSWD environment variable or a credentials file (see
  31                 below) will be read correctly.
  32                 </p></dd><dt><span class="term">credentials=&lt;filename&gt;</span></dt><dd><p>specifies a file that contains a username and/or password.
  33 The format of the file is:
  34 </p><pre class="programlisting">
  35 username = &lt;value&gt;
  36 password = &lt;value&gt;
  37 </pre><p>This is preferred over having passwords in plaintext in a
  38                 shared file, such as <tt class="filename">/etc/fstab</tt>. Be sure to protect any
  39                 credentials file properly.
  40                 </p></dd><dt><span class="term">krb</span></dt><dd><p>Use kerberos (Active Directory). </p></dd><dt><span class="term">netbiosname=&lt;arg&gt;</span></dt><dd><p>sets the source NetBIOS name. It defaults
  41                 to the local hostname. </p></dd><dt><span class="term">uid=&lt;arg&gt;</span></dt><dd><p>sets the uid that will own all files on
  42                 the mounted filesystem.
  43                 It may be specified as either a username or a numeric uid.
  44                 </p></dd><dt><span class="term">gid=&lt;arg&gt;</span></dt><dd><p>sets the gid that will own all files on
  45                 the mounted filesystem.
  46                 It may be specified as either a groupname or a numeric
  47                 gid. </p></dd><dt><span class="term">port=&lt;arg&gt;</span></dt><dd><p>sets the remote SMB port number. The default
  48                 is 139. </p></dd><dt><span class="term">fmask=&lt;arg&gt;</span></dt><dd><p>sets the file mask. This determines the
  49                 permissions that remote files have in the local filesystem.
  50                 This is not a umask, but the actual permissions for the files.
  51                 The default is based on the current umask. </p></dd><dt><span class="term">dmask=&lt;arg&gt;</span></dt><dd><p>Sets the directory mask. This determines the
  52                 permissions that remote directories have in the local filesystem.
  53                 This is not a umask, but the actual permissions for the directories.
  54                 The default is based on the current umask. </p></dd><dt><span class="term">debug=&lt;arg&gt;</span></dt><dd><p>Sets the debug level. This is useful for
  55                 tracking down SMB connection problems. A suggested value to
  56                 start with is 4. If set too high there will be a lot of
  57                 output, possibly hiding the useful output.</p></dd><dt><span class="term">ip=&lt;arg&gt;</span></dt><dd><p>Sets the destination host or IP address.
  58                 </p></dd><dt><span class="term">workgroup=&lt;arg&gt;</span></dt><dd><p>Sets the workgroup on the destination </p></dd><dt><span class="term">sockopt=&lt;arg&gt;</span></dt><dd><p>Sets the TCP socket options. See the <a href="smb.conf.5.html#SOCKETOPTIONS" target="_top"><a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></a> <i class="parameter"><tt>socket options</tt></i> option.
  59                 </p></dd><dt><span class="term">scope=&lt;arg&gt;</span></dt><dd><p>Sets the NetBIOS scope </p></dd><dt><span class="term">guest</span></dt><dd><p>Don't prompt for a password </p></dd><dt><span class="term">ro</span></dt><dd><p>mount read-only </p></dd><dt><span class="term">rw</span></dt><dd><p>mount read-write </p></dd><dt><span class="term">iocharset=&lt;arg&gt;</span></dt><dd><p>
  60                 sets the charset used by the Linux side for codepage
  61                 to charset translations (NLS). Argument should be the
  62                 name of a charset, like iso8859-1. (Note: only kernel
  63                 2.4.0 or later)
  64                 </p></dd><dt><span class="term">codepage=&lt;arg&gt;</span></dt><dd><p>
  65                 sets the codepage the server uses. See the iocharset
  66                 option. Example value cp850. (Note: only kernel 2.4.0
  67                 or later)
  68                 </p></dd><dt><span class="term">ttl=&lt;arg&gt;</span></dt><dd><p>
  69                 sets how long a directory listing is cached in milliseconds
  70                 (also affects visibility of file size and date
  71                 changes). A higher value means that changes on the
  72                 server take longer to be noticed but it can give
  73                 better performance on large directories, especially
  74                 over long distances. Default is 1000ms but something
  75                 like 10000ms (10 seconds) is probably more reasonable
  76                 in many cases.
  77                 (Note: only kernel 2.4.2 or later)
  78                 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>ENVIRONMENT VARIABLES</h2><p>The variable <tt class="envar">USER</tt> may contain the username of the
  79         person using the client.  This information is used only if the
  80         protocol level is high enough to support session-level
  81         passwords. The variable can be used to set both username and
  82         password by using the format username%password.</p><p>The variable <tt class="envar">PASSWD</tt> may contain the password of the
  83         person using the client.  This information is used only if the
  84         protocol level is high enough to support session-level
  85         passwords.</p><p>The variable <tt class="envar">PASSWD_FILE</tt> may contain the pathname
  86         of a file to read the password from. A single line of input is
  87         read and used as the password.</p></div><div class="refsect1" lang="en"><h2>BUGS</h2><p>Passwords and other options containing , can not be handled.
  88         For passwords an alternative way of passing them is in a credentials
  89         file or in the PASSWD environment.</p><p>The credentials file does not handle usernames or passwords with
  90         leading space.</p><p>One smbfs bug is important enough to mention here, even if it
  91         is a bit misplaced:</p><div class="itemizedlist"><ul type="disc"><li><p>Mounts sometimes stop working. This is usually
  92         caused by smbmount terminating. Since smbfs needs smbmount to
  93         reconnect when the server disconnects, the mount will eventually go
  94         dead. An umount/mount normally fixes this. At least 2 ways to
  95         trigger this bug are known.</p></li></ul></div><p>Note that the typical response to a bug report is suggestion
  96         to try the latest version first. So please try doing that first,
  97         and always include which versions you use of relevant software
  98         when reporting bugs (minimum: samba, kernel, distribution)</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p>Documentation/filesystems/smbfs.txt in the linux kernel
  99         source tree may contain additional options and information.</p><p>FreeBSD also has a smbfs, but it is not related to smbmount</p><p>For Solaris, HP-UX and others you may want to look at <a href="smbsh.1.html"><span class="citerefentry"><span class="refentrytitle">smbsh</span>(1)</span></a> or at other solutions, such as
 100         Sharity or perhaps replacing the SMB server with a NFS server.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>Volker Lendecke, Andrew Tridgell, Michael H. Warfield
 101         and others.</p><p>The current maintainer of smbfs and the userspace
 102         tools <b class="command">smbmount</b>, <b class="command">smbumount</b>,
 103         and <b class="command">smbmnt</b> is <a href="mailto:urban@teststation.com" target="_top">Urban Widmark</a>.
 104         The <a href="mailto:samba@samba.org" target="_top">SAMBA Mailing list</a>
 105         is the preferred place to ask questions regarding these programs.
 106         </p><p>The conversion of this manpage for Samba 2.2 was performed
 107         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
 108         was done by Alexander Bokovoy.</p></div></div></body></html>