source: trunk/samba/docs/htmldocs/manpages/smbmount.8.html @ 22

Last change on this file since 22 was 1, checked in by Paul Smedley, 14 years ago

Initial code import

File size: 10.6 KB
Line 
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.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="id230784"></a><h2>DESCRIPTION</h2><p><span><strong class="command">smbmount</strong></span> mounts a Linux SMB filesystem. It
2        is usually invoked as <span><strong class="command">mount.smbfs</strong></span> by
3        the <a href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the
4        "-t smbfs" option. This command only works in Linux, and the kernel must
5        support the smbfs filesystem. </p><p>Options to <span><strong class="command">smbmount</strong></span> 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><span><strong class="command">smbmount</strong></span> 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 "machine name" smbmount, so
12        typically this output will end up in <code class="filename">log.smbmount</code>. The <span><strong class="command">
13        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> 
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 <span><strong class="command">smbmnt</strong></span> is in the path so
16        that it can be found. </p></div></div><div class="refsect1" lang="en"><a name="id231197"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">username=&lt;arg&gt;</span></dt><dd><p>
17                specifies the username to connect as. If this is not given, then the environment variable <code class="envar"> USER</code>
18                is used. This option can also take the form "user%password" or "user/workgroup" or "user/workgroup%password"
19                to allow the password and workgroup to be specified as part of the username.
20                </p></dd><dt><span class="term">password=&lt;arg&gt;</span></dt><dd><p>
21                specifies the SMB password. If this option is not given then the environment
22                variable <code class="literal">PASSWD</code> is used. If it can find no password
23                <span><strong class="command">smbmount</strong></span> will prompt for a password, unless the guest option is given.
24                </p><p>
25                Note that passwords which contain the argument delimiter character (i.e. a comma ',') will failed to be parsed
26                correctly on the command line.  However, the same password defined in the PASSWD environment variable or a
27                credentials file (see below) will be read correctly.
28                </p></dd><dt><span class="term">credentials=&lt;filename&gt;</span></dt><dd><p>specifies a file that contains a username and/or password.
29The format of the file is:
30</p><pre class="programlisting">
31username = &lt;value&gt;
32password = &lt;value&gt;
33</pre><p>This is preferred over having passwords in plaintext in a
34                shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any
35                credentials file properly.
36                </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
37                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
38                the mounted filesystem.
39                It may be specified as either a username or a numeric uid.
40                </p></dd><dt><span class="term">gid=&lt;arg&gt;</span></dt><dd><p>sets the gid that will own all files on
41                the mounted filesystem.
42                It may be specified as either a groupname or a numeric
43                gid. </p></dd><dt><span class="term">port=&lt;arg&gt;</span></dt><dd><p>sets the remote SMB port number. The default
44                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
45                permissions that remote files have in the local filesystem.
46                This is not a umask, but the actual permissions for the files.
47                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
48                permissions that remote directories have in the local filesystem.
49                This is not a umask, but the actual permissions for the directories.
50                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
51                tracking down SMB connection problems. A suggested value to
52                start with is 4. If set too high there will be a lot of
53                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.
54                </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.
55                </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>
56                sets the charset used by the Linux side for codepage
57                to charset translations (NLS). Argument should be the
58                name of a charset, like iso8859-1. (Note: only kernel
59                2.4.0 or later)
60                </p></dd><dt><span class="term">codepage=&lt;arg&gt;</span></dt><dd><p>
61                sets the codepage the server uses. See the iocharset
62                option. Example value cp850. (Note: only kernel 2.4.0
63                or later)
64                </p></dd><dt><span class="term">ttl=&lt;arg&gt;</span></dt><dd><p>
65                sets how long a directory listing is cached in milliseconds
66                (also affects visibility of file size and date
67                changes). A higher value means that changes on the
68                server take longer to be noticed but it can give
69                better performance on large directories, especially
70                over long distances. Default is 1000ms but something
71                like 10000ms (10 seconds) is probably more reasonable
72                in many cases.
73                (Note: only kernel 2.4.2 or later)
74                </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id229335"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the username of the
75        person using the client.  This information is used only if the
76        protocol level is high enough to support session-level
77        passwords. The variable can be used to set both username and
78        password by using the format username%password.</p><p>The variable <code class="envar">PASSWD</code> may contain the password 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.</p><p>The variable <code class="envar">PASSWD_FILE</code> may contain the pathname
82        of a file to read the password from. A single line of input is
83        read and used as the password.</p></div><div class="refsect1" lang="en"><a name="id229368"></a><h2>OTHER COMMANDS</h2><p>
84        File systems that have been mounted using the <span><strong class="command">smbmount</strong></span>
85        can be unmounted using the <span><strong class="command">smbumount</strong></span> or the UNIX system
86        <span><strong class="command">umount</strong></span> command.
87        </p></div><div class="refsect1" lang="en"><a name="id229395"></a><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"><a name="id271922"></a><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"><a name="id271949"></a><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 <span><strong class="command">smbmount</strong></span>, <span><strong class="command">smbumount</strong></span>,
103        and <span><strong class="command">smbmnt</strong></span> 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>
Note: See TracBrowser for help on using the repository browser.