Initial import
[samba] / docs / htmldocs / manpages / smbmount.8.html
diff --git a/docs/htmldocs/manpages/smbmount.8.html b/docs/htmldocs/manpages/smbmount.8.html
new file mode 100644 (file)
index 0000000..bd23da5
--- /dev/null
@@ -0,0 +1,108 @@
+<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.68.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 class="refnamediv"><h2>Name</h2><p>smbmount &#8212; mount an smbfs filesystem</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">smbmount</code>  {service} {mount-point} [-o options]</p></div></div><div class="refsect1" lang="en"><a name="id2489051"></a><h2>DESCRIPTION</h2><p><span><strong class="command">smbmount</strong></span> mounts a Linux SMB filesystem. It 
+       is usually invoked as <span><strong class="command">mount.smbfs</strong></span> by
+       the <a href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the 
+       "-t smbfs" option. This command only works in Linux, and the kernel must
+       support the smbfs filesystem. </p><p>Options to <span><strong class="command">smbmount</strong></span> are specified as a comma-separated
+       list of key=value pairs. It is possible to send options other
+       than those listed here, assuming that smbfs supports them. If
+       you get mount failures, check your kernel log for errors on
+       unknown options.</p><p><span><strong class="command">smbmount</strong></span> is a daemon. After mounting it keeps running until
+       the mounted smbfs is umounted. It will log things that happen
+       when in daemon mode using the "machine name" smbmount, so
+       typically this output will end up in <code class="filename">log.smbmount</code>. The <span><strong class="command">
+       smbmount</strong></span> 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> <span><strong class="command">smbmount</strong></span> 
+       calls <a href="smbmnt.8.html"><span class="citerefentry"><span class="refentrytitle">smbmnt</span>(8)</span></a> to do the actual mount. You 
+       must make sure that <span><strong class="command">smbmnt</strong></span> is in the path so 
+       that it can be found. </p></div></div><div class="refsect1" lang="en"><a name="id2450658"></a><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 this is not given, then the environment variable <code class="envar"> USER</code>
+               is used. This option can also take the form "user%password" or "user/workgroup" or "user/workgroup%password"
+               to allow the password and workgroup 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 option is not given then the environment 
+               variable <code class="literal">PASSWD</code> is used. If it can find no password 
+               <span><strong class="command">smbmount</strong></span> will prompt for a passeword, unless the guest option is given.
+               </p><p>
+               Note that passwords which contain the argument delimiter character (i.e. a comma ',') will failed to be parsed
+               correctly on the command line.  However, the same password defined in the PASSWD environment variable or a
+               credentials file (see below) will be read correctly.
+               </p></dd><dt><span class="term">credentials=&lt;filename&gt;</span></dt><dd><p>specifies a file that contains a username and/or password. 
+The format of the file is:
+</p><pre class="programlisting">
+username = &lt;value&gt;
+password = &lt;value&gt;
+</pre><p>This is preferred over having passwords in plaintext in a
+               shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any
+               credentials file properly.
+               </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 
+               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
+               the mounted filesystem.
+               It may be specified as either a username or a numeric uid.
+               </p></dd><dt><span class="term">gid=&lt;arg&gt;</span></dt><dd><p>sets the gid that will own all files on
+               the mounted filesystem.
+               It may be specified as either a groupname or a numeric 
+               gid. </p></dd><dt><span class="term">port=&lt;arg&gt;</span></dt><dd><p>sets the remote SMB port number. The default 
+               is 445, fallback is 139. </p></dd><dt><span class="term">fmask=&lt;arg&gt;</span></dt><dd><p>sets the file mask. This determines the 
+               permissions that remote files have in the local filesystem. 
+               This is not a umask, but the actual permissions for the files.
+               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 
+               permissions that remote directories have in the local filesystem. 
+               This is not a umask, but the actual permissions for the directories.
+               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 
+               tracking down SMB connection problems. A suggested value to
+               start with is 4. If set too high there will be a lot of
+               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.
+               </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> <em class="parameter"><code>socket options</code></em> option.
+               </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>
+               sets the charset used by the Linux side for codepage
+               to charset translations (NLS). Argument should be the
+               name of a charset, like iso8859-1. (Note: only kernel
+               2.4.0 or later)
+               </p></dd><dt><span class="term">codepage=&lt;arg&gt;</span></dt><dd><p>
+               sets the codepage the server uses. See the iocharset
+               option. Example value cp850. (Note: only kernel 2.4.0
+               or later)
+               </p></dd><dt><span class="term">ttl=&lt;arg&gt;</span></dt><dd><p>
+               sets how long a directory listing is cached in milliseconds
+               (also affects visibility of file size and date
+               changes). A higher value means that changes on the
+               server take longer to be noticed but it can give
+               better performance on large directories, especially
+               over long distances. Default is 1000ms but something
+               like 10000ms (10 seconds) is probably more reasonable
+               in many cases.
+               (Note: only kernel 2.4.2 or later)
+               </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2451073"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the username of the
+       person using the client.  This information is used only if the
+       protocol level is high enough to support session-level
+       passwords. The variable can be used to set both username and
+       password by using the format username%password.</p><p>The variable <code class="envar">PASSWD</code> may contain the password of the
+       person using the client.  This information is used only if the
+       protocol level is high enough to support session-level
+       passwords.</p><p>The variable <code class="envar">PASSWD_FILE</code> may contain the pathname
+       of a file to read the password from. A single line of input is
+       read and used as the password.</p></div><div class="refsect1" lang="en"><a name="id2451110"></a><h2>OTHER COMMANDS</h2><p>
+       File systems that have been mounted using the <span><strong class="command">smbmount</strong></span>
+       can be unmounted using the <span><strong class="command">smbumount</strong></span> or the UNIX system
+       <span><strong class="command">umount</strong></span> command.
+       </p></div><div class="refsect1" lang="en"><a name="id2450061"></a><h2>BUGS</h2><p>Passwords and other options containing , can not be handled.
+       For passwords an alternative way of passing them is in a credentials
+       file or in the PASSWD environment.</p><p>The credentials file does not handle usernames or passwords with
+       leading space.</p><p>One smbfs bug is important enough to mention here, even if it
+       is a bit misplaced:</p><div class="itemizedlist"><ul type="disc"><li><p>Mounts sometimes stop working. This is usually
+       caused by smbmount terminating. Since smbfs needs smbmount to
+       reconnect when the server disconnects, the mount will eventually go
+       dead. An umount/mount normally fixes this. At least 2 ways to
+       trigger this bug are known.</p></li></ul></div><p>Note that the typical response to a bug report is suggestion
+       to try the latest version first. So please try doing that first,
+       and always include which versions you use of relevant software
+       when reporting bugs (minimum: samba, kernel, distribution)</p></div><div class="refsect1" lang="en"><a name="id2450103"></a><h2>SEE ALSO</h2><p>Documentation/filesystems/smbfs.txt in the linux kernel
+       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 
+       Sharity or perhaps replacing the SMB server with a NFS server.</p></div><div class="refsect1" lang="en"><a name="id2450133"></a><h2>AUTHOR</h2><p>Volker Lendecke, Andrew Tridgell, Michael H. Warfield 
+       and others.</p><p>The current maintainer of smbfs and the userspace
+       tools <span><strong class="command">smbmount</strong></span>, <span><strong class="command">smbumount</strong></span>,
+       and <span><strong class="command">smbmnt</strong></span> is <a href="mailto:urban@teststation.com" target="_top">Urban Widmark</a>.
+       The <a href="mailto:samba@samba.org" target="_top">SAMBA Mailing list</a>
+       is the preferred place to ask questions regarding these programs.
+       </p><p>The conversion of this manpage for Samba 2.2 was performed 
+       by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
+       was done by Alexander Bokovoy.</p></div></div></body></html>