updated Makefile to use the ldp DSSSL and regenerated all docs.
[Samba.git] / docs / htmldocs / smbmount.8.html
blobc8c9727be915352c17e618abd093a5745618d772
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 ><EM
76 >NOTE:</EM
77 > <B
78 CLASS="COMMAND"
79 >smbmount</B
81 calls <B
82 CLASS="COMMAND"
83 >smbmnt(8)</B
84 > to do the actual mount. You
85 must make sure that <B
86 CLASS="COMMAND"
87 >smbmnt</B
88 > is in the path so
89 that it can be found. </P
90 ></DIV
91 ><DIV
92 CLASS="REFSECT1"
93 ><A
94 NAME="AEN27"
95 ></A
96 ><H2
97 >OPTIONS</H2
98 ><P
99 ></P
100 ><DIV
101 CLASS="VARIABLELIST"
102 ><DL
103 ><DT
104 >username=&#60;arg&#62;</DT
105 ><DD
107 >specifies the username to connect as. If
108 this is not given, then the environment variable <TT
109 CLASS="ENVAR"
110 > USER</TT
111 > is used. This option can also take the
112 form "user%password" or "user/workgroup" or
113 "user/workgroup%password" to allow the password and workgroup
114 to be specified as part of the username.</P
115 ></DD
116 ><DT
117 >password=&#60;arg&#62;</DT
118 ><DD
120 >specifies the SMB password. If this
121 option is not given then the environment variable
123 CLASS="ENVAR"
124 >PASSWD</TT
125 > is used. If it can find
126 no password <B
127 CLASS="COMMAND"
128 >smbmount</B
129 > will prompt
130 for a passeword, unless the guest option is
131 given. </P
132 ></DD
133 ><DT
134 >credentials=&#60;filename&#62;</DT
135 ><DD
137 >specifies a file that contains a username
138 and/or password. The format of the file is:</P
140 > <TABLE
141 BORDER="0"
142 BGCOLOR="#E0E0E0"
143 WIDTH="90%"
144 ><TR
145 ><TD
146 ><PRE
147 CLASS="PROGRAMLISTING"
148 > username = &#60;value&#62;
149 password = &#60;value&#62;
150 </PRE
151 ></TD
152 ></TR
153 ></TABLE
157 >This is preferred over having passwords in plaintext in a
158 shared file, such as /etc/fstab. Be sure to protect any
159 credentials file properly.
161 ></DD
162 ><DT
163 >netbiosname=&#60;arg&#62;</DT
164 ><DD
166 >sets the source NetBIOS name. It defaults
167 to the local hostname. </P
168 ></DD
169 ><DT
170 >uid=&#60;arg&#62;</DT
171 ><DD
173 >sets the uid that will own all files on
174 the mounted filesystem.
175 It may be specified as either a username or a numeric uid.
177 ></DD
178 ><DT
179 >gid=&#60;arg&#62;</DT
180 ><DD
182 >sets the gid that will own all files on
183 the mounted filesystem.
184 It may be specified as either a groupname or a numeric
185 gid. </P
186 ></DD
187 ><DT
188 >port=&#60;arg&#62;</DT
189 ><DD
191 >sets the remote SMB port number. The default
192 is 139. </P
193 ></DD
194 ><DT
195 >fmask=&#60;arg&#62;</DT
196 ><DD
198 >sets the file mask. This determines the
199 permissions that remote files have in the local filesystem.
200 The default is based on the current umask. </P
201 ></DD
202 ><DT
203 >dmask=&#60;arg&#62;</DT
204 ><DD
206 >sets the directory mask. This deterines the
207 permissions that remote directories have in the local filesystem.
208 The default is based on the current umask. </P
209 ></DD
210 ><DT
211 >debug=&#60;arg&#62;</DT
212 ><DD
214 >sets the debug level. This is useful for
215 tracking down SMB connection problems. </P
216 ></DD
217 ><DT
218 >ip=&#60;arg&#62;</DT
219 ><DD
221 >sets the destination host or IP address.
223 ></DD
224 ><DT
225 >workgroup=&#60;arg&#62;</DT
226 ><DD
228 >sets the workgroup on the destination </P
229 ></DD
230 ><DT
231 >sockopt=&#60;arg&#62;</DT
232 ><DD
234 >sets the TCP socket options. See the <A
235 HREF="smb.conf.5.html#SOCKETOPTIONS"
236 TARGET="_top"
237 ><TT
238 CLASS="FILENAME"
239 >smb.conf
240 </TT
241 ></A
242 > <TT
243 CLASS="PARAMETER"
245 >socket options</I
246 ></TT
247 > option.
249 ></DD
250 ><DT
251 >scope=&#60;arg&#62;</DT
252 ><DD
254 >sets the NetBIOS scope </P
255 ></DD
256 ><DT
257 >guest</DT
258 ><DD
260 >don't prompt for a password </P
261 ></DD
262 ><DT
263 >ro</DT
264 ><DD
266 >mount read-only </P
267 ></DD
268 ><DT
269 >rw</DT
270 ><DD
272 >mount read-write </P
273 ></DD
274 ><DT
275 >iocharset=&#60;arg&#62;</DT
276 ><DD
278 > sets the charset used by the linux side for codepage
279 to charset translations (NLS). Argument should be the
280 name of a charset, like iso8859-1. (Note: only kernel
281 2.4.0 or later)
283 ></DD
284 ><DT
285 >codepage=&#60;arg&#62;</DT
286 ><DD
288 > sets the codepage the server uses. See the iocharset
289 option. Example value cp850. (Note: only kernel 2.4.0
290 or later)
292 ></DD
293 ><DT
294 >ttl=&#60;arg&#62;</DT
295 ><DD
297 > how long a directory listing is cached in milliseconds
298 (also affects visibility of file size and date
299 changes). A higher value means that changes on the
300 server take longer to be noticed but it can give
301 better performance on large directories, especially
302 over long distances. Default is 1000ms but something
303 like 10000ms (10 seconds) is probably more reasonable
304 in many cases.
305 (Note: only kernel 2.4.2 or later)
307 ></DD
308 ></DL
309 ></DIV
310 ></DIV
311 ><DIV
312 CLASS="REFSECT1"
314 NAME="AEN119"
315 ></A
316 ><H2
317 >ENVIRONMENT VARIABLES</H2
319 >The variable <TT
320 CLASS="ENVAR"
321 >USER</TT
322 > may contain the username of the
323 person using the client. This information is used only if the
324 protocol level is high enough to support session-level
325 passwords. The variable can be used to set both username and
326 password by using the format username%password.</P
328 >The variable <TT
329 CLASS="ENVAR"
330 >PASSWD</TT
331 > may contain the password of the
332 person using the client. This information is used only if the
333 protocol level is high enough to support session-level
334 passwords.</P
336 >The variable <TT
337 CLASS="ENVAR"
338 >PASSWD_FILE</TT
339 > may contain the pathname of
340 a file to read the password from. A single line of input is
341 read and used as password.</P
342 ></DIV
343 ><DIV
344 CLASS="REFSECT1"
346 NAME="AEN127"
347 ></A
348 ><H2
349 >BUGS</H2
351 >Not many known smbmount bugs. But one smbfs bug is
352 important enough to mention here anyway:</P
354 ></P
355 ><UL
356 ><LI
358 >Mounts sometimes stop working. This is usually
359 caused by smbmount terminating. Since smbfs needs smbmount to
360 reconnect when the server disconnects, the mount will go
361 dead. A re-mount normally fixes this. At least 2 ways to
362 trigger this bug are known.</P
363 ></LI
364 ></UL
366 >Note that the typical response to a bugreport is suggestion
367 to try the latest version first. So please try doing that first,
368 and always include which versions you use of relevant software
369 when reporting bugs (minimum: samba, kernel, distribution)</P
370 ></DIV
371 ><DIV
372 CLASS="REFSECT1"
374 NAME="AEN134"
375 ></A
376 ><H2
377 >SEE ALSO</H2
379 >Documentation/filesystems/smbfs.txt in the kernel source tree
380 may contain additional options and information.</P
381 ></DIV
382 ><DIV
383 CLASS="REFSECT1"
385 NAME="AEN137"
386 ></A
387 ><H2
388 >AUTHOR</H2
390 >Volker Lendecke, Andrew Tridgell, Michael H. Warfield
391 and others.</P
393 >The current maintainer of smbfs and the userspace
394 tools <B
395 CLASS="COMMAND"
396 >smbmount</B
397 >, <B
398 CLASS="COMMAND"
399 >smbumount</B
401 and <B
402 CLASS="COMMAND"
403 >smbmnt</B
404 > is <A
405 HREF="mailto:urban@teststation.com"
406 TARGET="_top"
407 >Urban Widmark</A
409 The <A
410 HREF="mailto:samba@samba.org"
411 TARGET="_top"
412 >SAMBA Mailing list</A
414 is the preferred place to ask questions regarding these programs.
417 >The conversion of this manpage for Samba 2.2 was performed
418 by Gerald Carter</P
419 ></DIV
420 ></BODY
421 ></HTML