source: branches/samba-3.0/docs/manpages/smbmount.8

Last change on this file was 336, checked in by Herwig Bauernfeind, 16 years ago

Update 3.0 to 3.0.37 (unsupported security update)

File size: 12.1 KB
Line 
1.\" Title: smbmount
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 09/30/2009
5.\" Manual: [FIXME: manual]
6.\" Source: [FIXME: source]
7.\" Language: English
8.\"
9.TH "SMBMOUNT" "8" "09/30/2009" "[FIXME: source]" "[FIXME: manual]"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170smbmount \- mount an smbfs filesystem
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCsmbmount\F[] {service} {mount\-point} [\-o\ options]
175.fam
176.SH "DESCRIPTION"
177.PP
178\FCsmbmount\F[]
179mounts a Linux SMB filesystem\&. It is usually invoked as
180\FCmount\&.smbfs\F[]
181by the
182\fBmount\fR(8)
183command when using the "\-t smbfs" option\&. This command only works in Linux, and the kernel must support the smbfs filesystem\&.
184.PP
185WARNING:
186\FCsmbmount\F[]
187is deprecated and not maintained any longer\&.
188\FCmount\&.cifs\F[]
189(mount \-t cifs) should be used instead of
190\FCsmbmount\F[]\&.
191.PP
192Options to
193\FCsmbmount\F[]
194are 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\&.
195.PP
196\FCsmbmount\F[]
197is 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
198\FClog\&.smbmount\F[]\&. The
199\FC smbmount\F[]
200process may also be called mount\&.smbfs\&.
201.if n \{\
202.sp
203.\}
204.RS 4
205.BM yellow
206.it 1 an-trap
207.nr an-no-space-flag 1
208.nr an-break-flag 1
209.br
210.ps +1
211\fBNote\fR
212.ps -1
213.br
214.PP
215
216\FCsmbmount\F[]
217calls
218\fBsmbmnt\fR(8)
219to do the actual mount\&. You must make sure that
220\FCsmbmnt\F[]
221is in the path so that it can be found\&.
222.sp .5v
223.EM yellow
224.RE
225.SH "OPTIONS"
226.PP
227username=<arg>
228.RS 4
229specifies the username to connect as\&. If this is not given, then the environment variable
230\fB USER\fR
231is 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\&.
232.RE
233.PP
234password=<arg>
235.RS 4
236specifies the SMB password\&. If this option is not given then the environment variable
237\FCPASSWD\F[]
238is used\&. If it can find no password
239\FCsmbmount\F[]
240will prompt for a password, unless the guest option is given\&.
241.sp
242Note 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\&.
243.RE
244.PP
245credentials=<filename>
246.RS 4
247specifies a file that contains a username and/or password\&. The format of the file is:
248.sp
249.if n \{\
250.RS 4
251.\}
252.fam C
253.ps -1
254.nf
255.if t \{\
256.sp -1
257.\}
258.BB lightgray adjust-for-leading-newline
259.sp -1
260
261username=value
262password=value
263.EB lightgray adjust-for-leading-newline
264.if t \{\
265.sp 1
266.\}
267.fi
268.fam
269.ps +1
270.if n \{\
271.RE
272.\}
273.sp
274This is preferred over having passwords in plaintext in a shared file, such as
275\FC/etc/fstab\F[]\&. Be sure to protect any credentials file properly\&.
276.RE
277.PP
278krb
279.RS 4
280Use kerberos (Active Directory)\&.
281.RE
282.PP
283netbiosname=<arg>
284.RS 4
285sets the source NetBIOS name\&. It defaults to the local hostname\&.
286.RE
287.PP
288uid=<arg>
289.RS 4
290sets the uid that will own all files on the mounted filesystem\&. It may be specified as either a username or a numeric uid\&.
291.RE
292.PP
293gid=<arg>
294.RS 4
295sets the gid that will own all files on the mounted filesystem\&. It may be specified as either a groupname or a numeric gid\&.
296.RE
297.PP
298port=<arg>
299.RS 4
300sets the remote SMB port number\&. The default is 445, fallback is 139\&.
301.RE
302.PP
303fmask=<arg>
304.RS 4
305sets 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\&.
306.RE
307.PP
308dmask=<arg>
309.RS 4
310Sets 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\&.
311.RE
312.PP
313debug=<arg>
314.RS 4
315Sets 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\&.
316.RE
317.PP
318ip=<arg>
319.RS 4
320Sets the destination host or IP address\&.
321.RE
322.PP
323workgroup=<arg>
324.RS 4
325Sets the workgroup on the destination
326.RE
327.PP
328sockopt=<arg>
329.RS 4
330Sets the TCP socket options\&. See the
331\fBsmb.conf\fR(5)
332\fIsocket options\fR
333option\&.
334.RE
335.PP
336scope=<arg>
337.RS 4
338Sets the NetBIOS scope
339.RE
340.PP
341guest
342.RS 4
343Don\'t prompt for a password
344.RE
345.PP
346ro
347.RS 4
348mount read\-only
349.RE
350.PP
351rw
352.RS 4
353mount read\-write
354.RE
355.PP
356iocharset=<arg>
357.RS 4
358sets 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)
359.RE
360.PP
361codepage=<arg>
362.RS 4
363sets the codepage the server uses\&. See the iocharset option\&. Example value cp850\&. (Note: only kernel 2\&.4\&.0 or later)
364.RE
365.PP
366ttl=<arg>
367.RS 4
368sets 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)
369.RE
370.SH "ENVIRONMENT VARIABLES"
371.PP
372The variable
373\fBUSER\fR
374may 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\&.
375.PP
376The variable
377\fBPASSWD\fR
378may 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\&.
379.PP
380The variable
381\fBPASSWD_FILE\fR
382may contain the pathname of a file to read the password from\&. A single line of input is read and used as the password\&.
383.SH "OTHER COMMANDS"
384.PP
385File systems that have been mounted using the
386\FCsmbmount\F[]
387can be unmounted using the
388\FCsmbumount\F[]
389or the UNIX system
390\FCumount\F[]
391command\&.
392.SH "BUGS"
393.PP
394Passwords 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\&.
395.PP
396The credentials file does not handle usernames or passwords with leading space\&.
397.PP
398One smbfs bug is important enough to mention here, even if it is a bit misplaced:
399.sp
400.RS 4
401.ie n \{\
402\h'-04'\(bu\h'+03'\c
403.\}
404.el \{\
405.sp -1
406.IP \(bu 2.3
407.\}
408Mounts 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\&.
409.sp
410.RE
411.PP
412Note 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)
413.SH "SEE ALSO"
414.PP
415Documentation/filesystems/smbfs\&.txt in the linux kernel source tree may contain additional options and information\&.
416.PP
417FreeBSD also has a smbfs, but it is not related to smbmount
418.PP
419For Solaris, HP\-UX and others you may want to look at
420\fBsmbsh\fR(1)
421or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server\&.
422.SH "AUTHOR"
423.PP
424Volker Lendecke, Andrew Tridgell, Michael H\&. Warfield and others\&.
425.PP
426The current maintainer of smbfs and the userspace tools
427\FCsmbmount\F[],
428\FCsmbumount\F[], and
429\FCsmbmnt\F[]
430is
431Urban Widmark\&. The
432SAMBA Mailing list
433is the preferred place to ask questions regarding these programs\&.
434.PP
435The 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\&.
Note: See TracBrowser for help on using the repository browser.