diff options
Diffstat (limited to 'docs/docbook/manpages/smbmount.8.sgml')
| -rw-r--r-- | docs/docbook/manpages/smbmount.8.sgml | 154 |
1 files changed, 137 insertions, 17 deletions
diff --git a/docs/docbook/manpages/smbmount.8.sgml b/docs/docbook/manpages/smbmount.8.sgml index a1a510ecd7..391d7d6882 100644 --- a/docs/docbook/manpages/smbmount.8.sgml +++ b/docs/docbook/manpages/smbmount.8.sgml @@ -9,7 +9,7 @@ <refnamediv> <refname>smbmount</refname> - <refpurpose>mount and smbfs filesystem</refpurpose> + <refpurpose>mount an smbfs filesystem</refpurpose> </refnamediv> <refsynopsisdiv> @@ -29,8 +29,17 @@ the <command>mount(8)</command> command when using the "-t smb" option. The kernel must support the smbfs filesystem. </para> - <para>Options to smbmount are specified as a comma separated list - of key=value pairs.</para> + <para>Options to smbmount 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.</para> + + <para>smbmount 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 log.smbmount. The + smbmount process may also be called mount.smbfs.</para> <para><emphasis>NOTE:</emphasis> <command>smbmount</command> calls <command>smbmnt(8)</command> to do the actual mount. You @@ -46,22 +55,40 @@ <varlistentry> <term>username=<arg></term> <listitem><para>specifies the username to connect as. If - this is not given then the environment variable <parameter> - $USER</parameter> is used. This option can also take the - form "user%password" or "user/workgroup" or - "user/workgroup%password" to allow the password and workgroup + 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.</para></listitem> </varlistentry> - <varlistentry> <term>password=<arg></term> - <listitem><para>specifies the SMB password. If not given then - <command>smbmount</command> will prompt for a passeword, unless - the guest option is given. </para></listitem> + <listitem><para>specifies the SMB password. If this + option is not given then the environment variable + <envar>PASSWD</envar> is used. If it can find + no password <command>smbmount</command> will prompt + for a passeword, unless the guest option is + given. </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:</para> + + <para> + <programlisting> + username = <value> + password = <value> + </programlisting> + </para> + + <para>This is preferred over having passwords in plaintext in a + shared file, such as /etc/fstab. Be sure to protect any + credentials file properly. + </para></listitem> + </varlistentry> <varlistentry> <term>netbiosname=<arg></term> @@ -69,11 +96,10 @@ to the local hostname. </para></listitem> </varlistentry> - - <varlistentry> <term>uid=<arg></term> - <listitem><para>sets the uid that files will be mounted as. + <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. </para></listitem> </varlistentry> @@ -81,7 +107,8 @@ <varlistentry> <term>gid=<arg></term> - <listitem><para>sets the gid that files will be mounted as. + <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. </para></listitem> </varlistentry> @@ -160,19 +187,112 @@ <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) + </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) + </para></listitem> + </varlistentry> + + <varlistentry> + <term>ttl=<arg></term> + <listitem><para> + 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) + </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.</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.</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 password.</para> +</refsect1> + + +<refsect1> + <title>BUGS</title> + + <para>Not many known smbmount bugs. But one smbfs bug is + important enough to mention here anyway:</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 go + dead. A re-mount normally fixes this. At least 2 ways to + trigger this bug are known.</para></listitem> + + </itemizedlist> + + <para>Note that the typical response to a bugreport 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)</para> + +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + + <para>Documentation/filesystems/smbfs.txt in the kernel source tree + may contain additional options and information.</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>smbmount</command>, <command>smbumount</command>, and <command>smbmnt</command> is <ulink - url="mailto:urban@teststation.com">Urban Widmark</ulink></para> + 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. + </para> <para>The conversion of this manpage for Samba 2.2 was performed by Gerald Carter</para> |