Add more content to the description of "registry shares".
[Samba/bjacke.git] / docs / manpages-3 / smbmount.8.xml
blob85d0458f0add36eae86435d666ed5dbfa8b21ff1
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="smbmount.8">
5 <refmeta>
6         <refentrytitle>smbmount</refentrytitle>
7         <manvolnum>8</manvolnum>
8 </refmeta>
11 <refnamediv>
12         <refname>smbmount</refname>
13         <refpurpose>mount an smbfs filesystem</refpurpose>
14 </refnamediv>
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>smbmount</command>
19                 <arg choice="req">service</arg>
20                 <arg choice="req">mount-point</arg>
21                 <arg choice="opt">-o options</arg>
22         </cmdsynopsis>
23 </refsynopsisdiv>
25 <refsect1>
26         <title>DESCRIPTION</title>
28         <para><command>smbmount</command> mounts a Linux SMB filesystem. It 
29         is usually invoked as <command>mount.smbfs</command> by
30         the <citerefentry><refentrytitle>mount</refentrytitle>
31         <manvolnum>8</manvolnum></citerefentry> command when using the 
32         "-t smbfs" option. This command only works in Linux, and the kernel must
33         support the smbfs filesystem.</para>
35         <para>WARNING: <command>smbmount</command> is deprecated and not
36         maintained any longer. <command>mount.cifs</command> (mount -t cifs)
37         should be used instead of <command>smbmount</command>.</para>
39         <para>Options to <command>smbmount</command> are specified as a comma-separated
40         list of key=value pairs. It is possible to send options other
41         than those listed here, assuming that smbfs supports them. If
42         you get mount failures, check your kernel log for errors on
43         unknown options.</para>
45         <para><command>smbmount</command> is a daemon. After mounting it keeps running until
46         the mounted smbfs is umounted. It will log things that happen
47         when in daemon mode using the "machine name" smbmount, so
48         typically this output will end up in <filename>log.smbmount</filename>. The <command>
49         smbmount</command> process may also be called mount.smbfs.</para>
51         <note><para> <command>smbmount</command> 
52         calls <citerefentry><refentrytitle>smbmnt</refentrytitle>
53         <manvolnum>8</manvolnum></citerefentry> to do the actual mount. You 
54         must make sure that <command>smbmnt</command> is in the path so 
55         that it can be found. </para></note>
56         
57 </refsect1>
59 <refsect1>
60         <title>OPTIONS</title>
62         <variablelist>
63                 <varlistentry>
64                 <term>username=&lt;arg&gt;</term>
65                 <listitem><para>
66                 specifies the username to connect as. If this is not given, then the environment variable <envar> USER</envar>
67                 is used. This option can also take the form "user%password" or "user/workgroup" or "user/workgroup%password"
68                 to allow the password and workgroup to be specified as part of the username.
69                 </para></listitem>
70                 </varlistentry>
72                 <varlistentry>
73                 <term>password=&lt;arg&gt;</term>
74                 <listitem><para>
75                 specifies the SMB password. If this option is not given then the environment 
76                 variable <literal>PASSWD</literal> is used. If it can find no password 
77                 <command>smbmount</command> will prompt for a password, unless the guest option is given.
78                 </para>
80                 <para>
81                 Note that passwords which contain the argument delimiter character (i.e. a comma ',') will failed to be parsed
82                 correctly on the command line.  However, the same password defined in the PASSWD environment variable or a
83                 credentials file (see below) will be read correctly.
84                 </para>
85                 </listitem>
86                 </varlistentry>
88                 <varlistentry>
89                 <term>credentials=&lt;filename&gt;</term>
90                 <listitem><para>specifies a file that contains a username and/or password. 
91 The format of the file is:
92 <programlisting>
93 username=value
94 password=value
95 </programlisting></para>
97                 <para>This is preferred over having passwords in plaintext in a
98                 shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any
99                 credentials file properly.
100                 </para></listitem>
101                 </varlistentry>
103                 <varlistentry>
104                 <term>krb</term>
105                 <listitem><para>Use kerberos (Active Directory). </para></listitem>
106                 </varlistentry>
108                 <varlistentry>
109                 <term>netbiosname=&lt;arg&gt;</term>
110                 <listitem><para>sets the source NetBIOS name. It defaults 
111                 to the local hostname. </para></listitem>
112                 </varlistentry>
114                 <varlistentry>
115                 <term>uid=&lt;arg&gt;</term>
116                 <listitem><para>sets the uid that will own all files on
117                 the mounted filesystem.
118                 It may be specified as either a username or a numeric uid.
119                 </para></listitem>
120                 </varlistentry>
121                 
122                 
123                 <varlistentry>
124                 <term>gid=&lt;arg&gt;</term>
125                 <listitem><para>sets the gid that will own all files on
126                 the mounted filesystem.
127                 It may be specified as either a groupname or a numeric 
128                 gid. </para></listitem>         
129                 </varlistentry>
130                 
131                 
132                 <varlistentry>
133                 <term>port=&lt;arg&gt;</term>
134                 <listitem><para>sets the remote SMB port number. The default 
135                 is 445, fallback is 139. </para></listitem>
136                 </varlistentry>
137                 
138                 
139                 <varlistentry>
140                 <term>fmask=&lt;arg&gt;</term>
141                 <listitem><para>sets the file mask. This determines the 
142                 permissions that remote files have in the local filesystem. 
143                 This is not a umask, but the actual permissions for the files.
144                 The default is based on the current umask. </para></listitem>
145                 </varlistentry>
146                 
148                 <varlistentry>
149                 <term>dmask=&lt;arg&gt;</term>
150                 <listitem><para>Sets the directory mask. This determines the 
151                 permissions that remote directories have in the local filesystem. 
152                 This is not a umask, but the actual permissions for the directories.
153                 The default is based on the current umask. </para></listitem>
154                 </varlistentry>
155                 
156                 
157                 <varlistentry>
158                 <term>debug=&lt;arg&gt;</term>
159                 <listitem><para>Sets the debug level. This is useful for 
160                 tracking down SMB connection problems. A suggested value to
161                 start with is 4. If set too high there will be a lot of
162                 output, possibly hiding the useful output.</para></listitem>
163                 </varlistentry>
164                 
165                 
166                 <varlistentry>
167                 <term>ip=&lt;arg&gt;</term>
168                 <listitem><para>Sets the destination host or IP address.
169                 </para></listitem>
170                 </varlistentry>
174                 <varlistentry>
175                 <term>workgroup=&lt;arg&gt;</term>
176                 <listitem><para>Sets the workgroup on the destination </para>
177                 </listitem>
178                 </varlistentry>
181                 <varlistentry>
182                 <term>sockopt=&lt;arg&gt;</term>
183                 <listitem><para>Sets the TCP socket options. See the <ulink
184                 url="smb.conf.5.html#SOCKETOPTIONS"><citerefentry><refentrytitle>smb.conf</refentrytitle>
185                 <manvolnum>5</manvolnum></citerefentry></ulink> <parameter>socket options</parameter> option.
186                 </para></listitem>
187                 </varlistentry>
190                 <varlistentry>
191                 <term>scope=&lt;arg&gt;</term>
192                 <listitem><para>Sets the NetBIOS scope </para></listitem>
193                 </varlistentry>
195                 <varlistentry>
196                 <term>guest</term>
197                 <listitem><para>Don't prompt for a password </para></listitem>
198                 </varlistentry>
200                 <varlistentry>
201                 <term>ro</term>
202                 <listitem><para>mount read-only </para></listitem>
203                 </varlistentry>
205                 <varlistentry>
206                 <term>rw</term><listitem><para>mount read-write </para></listitem>
207                 </varlistentry>
209                 <varlistentry>
210                 <term>iocharset=&lt;arg&gt;</term>
211                 <listitem><para>
212                 sets the charset used by the Linux side for codepage
213                 to charset translations (NLS). Argument should be the
214                 name of a charset, like iso8859-1. (Note: only kernel
215                 2.4.0 or later)
216                 </para></listitem>
217                 </varlistentry>
219                 <varlistentry>
220                 <term>codepage=&lt;arg&gt;</term>
221                 <listitem><para>
222                 sets the codepage the server uses. See the iocharset
223                 option. Example value cp850. (Note: only kernel 2.4.0
224                 or later)
225                 </para></listitem>
226                 </varlistentry>
228                 <varlistentry>
229                 <term>ttl=&lt;arg&gt;</term>
230                 <listitem><para>
231                 sets how long a directory listing is cached in milliseconds
232                 (also affects visibility of file size and date
233                 changes). A higher value means that changes on the
234                 server take longer to be noticed but it can give
235                 better performance on large directories, especially
236                 over long distances. Default is 1000ms but something
237                 like 10000ms (10 seconds) is probably more reasonable
238                 in many cases.
239                 (Note: only kernel 2.4.2 or later)
240                 </para></listitem>
241                 </varlistentry>
243         </variablelist>
246 </refsect1>
248 <refsect1>
249         <title>ENVIRONMENT VARIABLES</title>
251         <para>The variable <envar>USER</envar> may contain the username of the
252         person using the client.  This information is used only if the
253         protocol level is high enough to support session-level
254         passwords. The variable can be used to set both username and
255         password by using the format username%password.</para>
257         <para>The variable <envar>PASSWD</envar> may contain the password of the
258         person using the client.  This information is used only if the
259         protocol level is high enough to support session-level
260         passwords.</para>
262         <para>The variable <envar>PASSWD_FILE</envar> may contain the pathname
263         of a file to read the password from. A single line of input is
264         read and used as the password.</para>
265 </refsect1>
267 <refsect1>
268         <title>OTHER COMMANDS</title>
270         <para>
271         File systems that have been mounted using the <command>smbmount</command>
272         can be unmounted using the <command>smbumount</command> or the UNIX system
273         <command>umount</command> command.
274         </para>
276 </refsect1>
279 <refsect1>
280         <title>BUGS</title>
282         <para>Passwords and other options containing , can not be handled.
283         For passwords an alternative way of passing them is in a credentials
284         file or in the PASSWD environment.</para>
286         <para>The credentials file does not handle usernames or passwords with
287         leading space.</para>
289         <para>One smbfs bug is important enough to mention here, even if it
290         is a bit misplaced:</para>
292         <itemizedlist>
294         <listitem><para>Mounts sometimes stop working. This is usually
295         caused by smbmount terminating. Since smbfs needs smbmount to
296         reconnect when the server disconnects, the mount will eventually go
297         dead. An umount/mount normally fixes this. At least 2 ways to
298         trigger this bug are known.</para></listitem>
300         </itemizedlist>
302         <para>Note that the typical response to a bug report is suggestion
303         to try the latest version first. So please try doing that first,
304         and always include which versions you use of relevant software
305         when reporting bugs (minimum: samba, kernel, distribution)</para>
307 </refsect1>
310 <refsect1>
311         <title>SEE ALSO</title>
313         <para>Documentation/filesystems/smbfs.txt in the linux kernel
314         source tree may contain additional options and information.</para>
316         <para>FreeBSD also has a smbfs, but it is not related to smbmount</para>
318         <para>For Solaris, HP-UX and others you may want to look at <citerefentry><refentrytitle>smbsh</refentrytitle>
319         <manvolnum>1</manvolnum></citerefentry> or at other solutions, such as 
320         Sharity or perhaps replacing the SMB server with a NFS server.</para>
322 </refsect1>
325 <refsect1>
326         <title>AUTHOR</title>
327         
328         <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield 
329         and others.</para>
330         
331         <para>The current maintainer of smbfs and the userspace
332         tools <command>smbmount</command>, <command>smbumount</command>,
333         and <command>smbmnt</command> is <ulink 
334         url="mailto:urban@teststation.com">Urban Widmark</ulink>.
335         The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
336         is the preferred place to ask questions regarding these programs.
337         </para>
338         
339         <para>The conversion of this manpage for Samba 2.2 was performed 
340         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
341         was done by Alexander Bokovoy.</para>
342 </refsect1>
344 </refentry>