large sync up with 2.2
[Samba/gbeck.git] / docs / htmldocs / smbmount.8.html
blobba07f08ed47c761e71830dcc761ef26165d83a2a
1 <HTML
2 ><HEAD
3 ><TITLE
4 >smbmount</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
8 ><BODY
9 CLASS="REFENTRY"
10 BGCOLOR="#FFFFFF"
11 TEXT="#000000"
12 LINK="#0000FF"
13 VLINK="#840084"
14 ALINK="#0000FF"
15 ><H1
16 ><A
17 NAME="SMBMOUNT"
18 >smbmount</A
19 ></H1
20 ><DIV
21 CLASS="REFNAMEDIV"
22 ><A
23 NAME="AEN5"
24 ></A
25 ><H2
26 >Name</H2
27 >smbmount&nbsp;--&nbsp;mount an smbfs filesystem</DIV
28 ><DIV
29 CLASS="REFSYNOPSISDIV"
30 ><A
31 NAME="AEN8"
32 ></A
33 ><H2
34 >Synopsis</H2
35 ><P
36 ><B
37 CLASS="COMMAND"
38 >smbumount</B
39 > {service} {mount-point} [-o options]</P
40 ></DIV
41 ><DIV
42 CLASS="REFSECT1"
43 ><A
44 NAME="AEN14"
45 ></A
46 ><H2
47 >DESCRIPTION</H2
48 ><P
49 ><B
50 CLASS="COMMAND"
51 >smbmount</B
52 > mounts a SMB filesystem. It
53 is usually invoked as <B
54 CLASS="COMMAND"
55 >mount.smb</B
56 > from
57 the <B
58 CLASS="COMMAND"
59 >mount(8)</B
60 > command when using the
61 "-t smb" option. The kernel must support the smbfs filesystem. </P
62 ><P
63 >Options to smbmount are specified as a comma separated
64 list of key=value pairs. It is possible to send options other
65 than those listed here, assuming that smbfs supports them. If
66 you get mount failures, check your kernel log for errors on
67 unknown options.</P
68 ><P
69 >smbmount is a daemon. After mounting it keeps running until
70 the mounted smbfs is umounted. It will log things that happen
71 when in daemon mode using the "machine name" smbmount, so
72 typically this output will end up in log.smbmount. The
73 smbmount process may also be called mount.smbfs.</P
74 ><P
75 ><I
76 CLASS="EMPHASIS"
77 >NOTE:</I
78 > <B
79 CLASS="COMMAND"
80 >smbmount</B
82 calls <B
83 CLASS="COMMAND"
84 >smbmnt(8)</B
85 > to do the actual mount. You
86 must make sure that <B
87 CLASS="COMMAND"
88 >smbmnt</B
89 > is in the path so
90 that it can be found. </P
91 ></DIV
92 ><DIV
93 CLASS="REFSECT1"
94 ><A
95 NAME="AEN27"
96 ></A
97 ><H2
98 >OPTIONS</H2
99 ><P
100 ></P
101 ><DIV
102 CLASS="VARIABLELIST"
103 ><DL
104 ><DT
105 >username=&lt;arg&gt;</DT
106 ><DD
108 >specifies the username to connect as. If
109 this is not given, then the environment variable <TT
110 CLASS="ENVAR"
111 > USER</TT
112 > is used. This option can also take the
113 form "user%password" or "user/workgroup" or
114 "user/workgroup%password" to allow the password and workgroup
115 to be specified as part of the username.</P
116 ></DD
117 ><DT
118 >password=&lt;arg&gt;</DT
119 ><DD
121 >specifies the SMB password. If this
122 option is not given then the environment variable
124 CLASS="ENVAR"
125 >PASSWD</TT
126 > is used. If it can find
127 no password <B
128 CLASS="COMMAND"
129 >smbmount</B
130 > will prompt
131 for a passeword, unless the guest option is
132 given. </P
133 ></DD
134 ><DT
135 >credentials=&lt;filename&gt;</DT
136 ><DD
138 >specifies a file that contains a username
139 and/or password. The format of the file is:</P
141 > <PRE
142 CLASS="PROGRAMLISTING"
143 > username = &lt;value&gt;
144 password = &lt;value&gt;
145 </PRE
149 >This is preferred over having passwords in plaintext in a
150 shared file, such as /etc/fstab. Be sure to protect any
151 credentials file properly.
153 ></DD
154 ><DT
155 >netbiosname=&lt;arg&gt;</DT
156 ><DD
158 >sets the source NetBIOS name. It defaults
159 to the local hostname. </P
160 ></DD
161 ><DT
162 >uid=&lt;arg&gt;</DT
163 ><DD
165 >sets the uid that will own all files on
166 the mounted filesystem.
167 It may be specified as either a username or a numeric uid.
169 ></DD
170 ><DT
171 >gid=&lt;arg&gt;</DT
172 ><DD
174 >sets the gid that will own all files on
175 the mounted filesystem.
176 It may be specified as either a groupname or a numeric
177 gid. </P
178 ></DD
179 ><DT
180 >port=&lt;arg&gt;</DT
181 ><DD
183 >sets the remote SMB port number. The default
184 is 139. </P
185 ></DD
186 ><DT
187 >fmask=&lt;arg&gt;</DT
188 ><DD
190 >sets the file mask. This determines the
191 permissions that remote files have in the local filesystem.
192 The default is based on the current umask. </P
193 ></DD
194 ><DT
195 >dmask=&lt;arg&gt;</DT
196 ><DD
198 >sets the directory mask. This deterines the
199 permissions that remote directories have in the local filesystem.
200 The default is based on the current umask. </P
201 ></DD
202 ><DT
203 >debug=&lt;arg&gt;</DT
204 ><DD
206 >sets the debug level. This is useful for
207 tracking down SMB connection problems. </P
208 ></DD
209 ><DT
210 >ip=&lt;arg&gt;</DT
211 ><DD
213 >sets the destination host or IP address.
215 ></DD
216 ><DT
217 >workgroup=&lt;arg&gt;</DT
218 ><DD
220 >sets the workgroup on the destination </P
221 ></DD
222 ><DT
223 >sockopt=&lt;arg&gt;</DT
224 ><DD
226 >sets the TCP socket options. See the <A
227 HREF="smb.conf.5.html#SOCKETOPTIONS"
228 TARGET="_top"
229 ><TT
230 CLASS="FILENAME"
231 >smb.conf
232 </TT
233 ></A
234 > <TT
235 CLASS="PARAMETER"
237 >socket options</I
238 ></TT
239 > option.
241 ></DD
242 ><DT
243 >scope=&lt;arg&gt;</DT
244 ><DD
246 >sets the NetBIOS scope </P
247 ></DD
248 ><DT
249 >guest</DT
250 ><DD
252 >don't prompt for a password </P
253 ></DD
254 ><DT
255 >ro</DT
256 ><DD
258 >mount read-only </P
259 ></DD
260 ><DT
261 >rw</DT
262 ><DD
264 >mount read-write </P
265 ></DD
266 ><DT
267 >iocharset=&lt;arg&gt;</DT
268 ><DD
270 > sets the charset used by the linux side for codepage
271 to charset translations (NLS). Argument should be the
272 name of a charset, like iso8859-1. (Note: only kernel
273 2.4.0 or later)
275 ></DD
276 ><DT
277 >codepage=&lt;arg&gt;</DT
278 ><DD
280 > sets the codepage the server uses. See the iocharset
281 option. Example value cp850. (Note: only kernel 2.4.0
282 or later)
284 ></DD
285 ><DT
286 >ttl=&lt;arg&gt;</DT
287 ><DD
289 > how long a directory listing is cached in milliseconds
290 (also affects visibility of file size and date
291 changes). A higher value means that changes on the
292 server take longer to be noticed but it can give
293 better performance on large directories, especially
294 over long distances. Default is 1000ms but something
295 like 10000ms (10 seconds) is probably more reasonable
296 in many cases.
297 (Note: only kernel 2.4.2 or later)
299 ></DD
300 ></DL
301 ></DIV
302 ></DIV
303 ><DIV
304 CLASS="REFSECT1"
306 NAME="AEN119"
307 ></A
308 ><H2
309 >ENVIRONMENT VARIABLES</H2
311 >The variable <TT
312 CLASS="ENVAR"
313 >USER</TT
314 > may contain the username of the
315 person using the client. This information is used only if the
316 protocol level is high enough to support session-level
317 passwords. The variable can be used to set both username and
318 password by using the format username%password.</P
320 >The variable <TT
321 CLASS="ENVAR"
322 >PASSWD</TT
323 > may contain the password of the
324 person using the client. This information is used only if the
325 protocol level is high enough to support session-level
326 passwords.</P
328 >The variable <TT
329 CLASS="ENVAR"
330 >PASSWD_FILE</TT
331 > may contain the pathname of
332 a file to read the password from. A single line of input is
333 read and used as password.</P
334 ></DIV
335 ><DIV
336 CLASS="REFSECT1"
338 NAME="AEN127"
339 ></A
340 ><H2
341 >BUGS</H2
343 >Not many known smbmount bugs. But one smbfs bug is
344 important enough to mention here anyway:</P
346 ></P
347 ><UL
348 ><LI
350 >Mounts sometimes stop working. This is usually
351 caused by smbmount terminating. Since smbfs needs smbmount to
352 reconnect when the server disconnects, the mount will go
353 dead. A re-mount normally fixes this. At least 2 ways to
354 trigger this bug are known.</P
355 ></LI
356 ></UL
358 >Note that the typical response to a bugreport is suggestion
359 to try the latest version first. So please try doing that first,
360 and always include which versions you use of relevant software
361 when reporting bugs (minimum: samba, kernel, distribution)</P
362 ></DIV
363 ><DIV
364 CLASS="REFSECT1"
366 NAME="AEN134"
367 ></A
368 ><H2
369 >SEE ALSO</H2
371 >Documentation/filesystems/smbfs.txt in the kernel source tree
372 may contain additional options and information.</P
373 ></DIV
374 ><DIV
375 CLASS="REFSECT1"
377 NAME="AEN137"
378 ></A
379 ><H2
380 >AUTHOR</H2
382 >Volker Lendecke, Andrew Tridgell, Michael H. Warfield
383 and others.</P
385 >The current maintainer of smbfs and the userspace
386 tools <B
387 CLASS="COMMAND"
388 >smbmount</B
389 >, <B
390 CLASS="COMMAND"
391 >smbumount</B
393 and <B
394 CLASS="COMMAND"
395 >smbmnt</B
396 > is <A
397 HREF="mailto:urban@teststation.com"
398 TARGET="_top"
399 >Urban Widmark</A
401 The <A
402 HREF="mailto:samba@samba.org"
403 TARGET="_top"
404 >SAMBA Mailing list</A
406 is the preferred place to ask questions regarding these programs.
409 >The conversion of this manpage for Samba 2.2 was performed
410 by Gerald Carter</P
411 ></DIV
412 ></BODY
413 ></HTML