diff options
Diffstat (limited to 'docs/htmldocs/smbmount.8.html')
| -rw-r--r-- | docs/htmldocs/smbmount.8.html | 326 |
1 files changed, 277 insertions, 49 deletions
diff --git a/docs/htmldocs/smbmount.8.html b/docs/htmldocs/smbmount.8.html index eff8fea825..60e0288035 100644 --- a/docs/htmldocs/smbmount.8.html +++ b/docs/htmldocs/smbmount.8.html @@ -1,71 +1,237 @@ -<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 — 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 - is usually invoked as <b class="command">mount.smbfs</b> by - the <a href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the +<?xml version="1.0"?> + +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + + <!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities; + ]> +<refentry id="smbmount.8"> + +<refmeta> + <refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmount</refname> + <refpurpose>mount an smbfs filesystem</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis sepchar=" "> + <command moreinfo="none">smbmount</command> + <arg rep="norepeat" choice="req">service</arg> + <arg rep="norepeat" choice="req">mount-point</arg> + <arg rep="norepeat" choice="opt">-o options</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para><command moreinfo="none">smbmount</command> mounts a Linux SMB filesystem. It + is usually invoked as <command moreinfo="none">mount.smbfs</command> by + the <citerefentry><refentrytitle>mount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> 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 <b class="command">smbmount</b> are specified as a comma-separated + support the smbfs filesystem. </para> + + <para>Options to <command moreinfo="none">smbmount</command> 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><b class="command">smbmount</b> is a daemon. After mounting it keeps running until + unknown options.</para> + + <para><command moreinfo="none">smbmount</command> 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 <tt class="filename">log.smbmount</tt>. The <b class="command"> - 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> - 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 <b class="command">smbmnt</b> is in the path so - 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=<arg></span></dt><dd><p>specifies the username to connect as. If - this is not given, then the environment variable <tt class="envar"> - USER</tt> is used. This option can also take the + typically this output will end up in <filename moreinfo="none">log.smbmount</filename>. The <command moreinfo="none"> + smbmount</command> process may also be called mount.smbfs.</para> + + <note><para> <command moreinfo="none">smbmount</command> + calls <citerefentry><refentrytitle>smbmnt</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to do the actual mount. You + must make sure that <command moreinfo="none">smbmnt</command> is in the path so + that it can be found. </para></note> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>username=<arg></term> + <listitem><para>specifies the username to connect as. If + this is not given, then the environment variable <envar> + USER</envar> 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=<arg></span></dt><dd><p>specifies the SMB password. If this + to be specified as part of the username.</para></listitem> + </varlistentry> + + <varlistentry> + <term>password=<arg></term> + <listitem><para>specifies the SMB password. If this option is not given then the environment variable - <tt class="envar">PASSWD</tt> is used. If it can find - no password <b class="command">smbmount</b> will prompt + <envar>PASSWD</envar> is used. If it can find + no password <command moreinfo="none">smbmount</command> will prompt for a passeword, unless the guest option is - given. </p><p> + given. </para> + + <para> 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=<filename></span></dt><dd xmlns:ns1=""><ns1:p>specifies a file that contains a username and/or password. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>credentials=<filename></term> + <listitem><para>specifies a file that contains a username and/or password. The format of the file is: -</ns1:p><pre class="programlisting"> +<programlisting format="linespecific"> username = <value> password = <value> -</pre><p>This is preferred over having passwords in plaintext in a - shared file, such as <tt class="filename">/etc/fstab</tt>. Be sure to protect any +</programlisting></para> + + <para>This is preferred over having passwords in plaintext in a + shared file, such as <filename moreinfo="none">/etc/fstab</filename>. 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=<arg></span></dt><dd><p>sets the source NetBIOS name. It defaults - to the local hostname. </p></dd><dt><span class="term">uid=<arg></span></dt><dd><p>sets the uid that will own all files on + </para></listitem> + </varlistentry> + + <varlistentry> + <term>krb</term> + <listitem><para>Use kerberos (Active Directory). </para></listitem> + </varlistentry> + + <varlistentry> + <term>netbiosname=<arg></term> + <listitem><para>sets the source NetBIOS name. It defaults + to the local hostname. </para></listitem> + </varlistentry> + + <varlistentry> + <term>uid=<arg></term> + <listitem><para>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=<arg></span></dt><dd><p>sets the gid that will own all files on + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>gid=<arg></term> + <listitem><para>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=<arg></span></dt><dd><p>sets the remote SMB port number. The default - is 139. </p></dd><dt><span class="term">fmask=<arg></span></dt><dd><p>sets the file mask. This determines the + gid. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>port=<arg></term> + <listitem><para>sets the remote SMB port number. The default + is 139. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>fmask=<arg></term> + <listitem><para>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=<arg></span></dt><dd><p>Sets the directory mask. This determines the + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>dmask=<arg></term> + <listitem><para>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=<arg></span></dt><dd><p>Sets the debug level. This is useful for + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>debug=<arg></term> + <listitem><para>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=<arg></span></dt><dd><p>Sets the destination host or IP address. - </p></dd><dt><span class="term">workgroup=<arg></span></dt><dd><p>Sets the workgroup on the destination </p></dd><dt><span class="term">sockopt=<arg></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. - </p></dd><dt><span class="term">scope=<arg></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=<arg></span></dt><dd><p> + output, possibly hiding the useful output.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>ip=<arg></term> + <listitem><para>Sets the destination host or IP address. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>workgroup=<arg></term> + <listitem><para>Sets the workgroup on the destination </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>sockopt=<arg></term> + <listitem><para>Sets the TCP socket options. See the <ulink url="smb.conf.5.html#SOCKETOPTIONS"><citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></ulink> <parameter moreinfo="none">socket options</parameter> option. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>scope=<arg></term> + <listitem><para>Sets the NetBIOS scope </para></listitem> + </varlistentry> + + <varlistentry> + <term>guest</term> + <listitem><para>Don't prompt for a password </para></listitem> + </varlistentry> + + <varlistentry> + <term>ro</term> + <listitem><para>mount read-only </para></listitem> + </varlistentry> + + <varlistentry> + <term>rw</term><listitem><para>mount read-write </para></listitem> + </varlistentry> + + <varlistentry> + <term>iocharset=<arg></term> + <listitem><para> 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=<arg></span></dt><dd><p> + </para></listitem> + </varlistentry> + + <varlistentry> + <term>codepage=<arg></term> + <listitem><para> 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=<arg></span></dt><dd><p> + </para></listitem> + </varlistentry> + + <varlistentry> + <term>ttl=<arg></term> + <listitem><para> 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 @@ -75,34 +241,96 @@ password = <value> 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"><h2>ENVIRONMENT VARIABLES</h2><p>The variable <tt class="envar">USER</tt> may contain the username of the + </para></listitem> + </varlistentry> + + </variablelist> + + +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The variable <envar>USER</envar> 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 <tt class="envar">PASSWD</tt> may contain the password of the + password by using the format username%password.</para> + + <para>The variable <envar>PASSWD</envar> 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 <tt class="envar">PASSWD_FILE</tt> may contain the pathname + passwords.</para> + + <para>The variable <envar>PASSWD_FILE</envar> 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"><h2>BUGS</h2><p>Passwords and other options containing , can not be handled. + read and used as the password.</para> +</refsect1> + + +<refsect1> + <title>BUGS</title> + + <para>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 + file or in the PASSWD environment.</para> + + <para>The credentials file does not handle usernames or passwords with + leading space.</para> + + <para>One smbfs bug is important enough to mention here, even if it + is a bit misplaced:</para> + + <itemizedlist> + + <listitem><para>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 + trigger this bug are known.</para></listitem> + + </itemizedlist> + + <para>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"><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"><h2>AUTHOR</h2><p>Volker Lendecke, Andrew Tridgell, Michael H. Warfield - and others.</p><p>The current maintainer of smbfs and the userspace - tools <b class="command">smbmount</b>, <b class="command">smbumount</b>, - and <b class="command">smbmnt</b> 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> + when reporting bugs (minimum: samba, kernel, distribution)</para> + +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + + <para>Documentation/filesystems/smbfs.txt in the linux kernel + source tree may contain additional options and information.</para> + + <para>FreeBSD also has a smbfs, but it is not related to smbmount</para> + + <para>For Solaris, HP-UX and others you may want to look at <citerefentry><refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server.</para> + +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command moreinfo="none">smbmount</command>, <command moreinfo="none">smbumount</command>, + and <command moreinfo="none">smbmnt</command> is <ulink url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> is the preferred place to ask questions regarding these programs. - </p><p>The conversion of this manpage for Samba 2.2 was performed + </para> + + <para>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> + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> |