| blob | 734ec75a59c94ef80128d1901b16a9b92f779e90 |
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "SMBMOUNT" 8 "" "" ""
21 .SH "NAME"
22 smbmount - mount an smbfs filesystem
23 .SH "SYNOPSIS"
24 .HP 9
25 \fBsmbmount\fR {service} {mount-point} [-o options]
26 .SH "DESCRIPTION"
27 .PP
28 \fBsmbmount\fR
29 mounts a Linux SMB filesystem. It is usually invoked as
30 \fBmount.smbfs\fR
31 by the
32 \fBmount\fR(8)
33 command when using the "-t smbfs" option. This command only works in Linux, and the kernel must support the smbfs filesystem.
34 .PP
35 Options to
36 \fBsmbmount\fR
37 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.
38 .PP
39 \fBsmbmount\fR
40 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
41 \fIlog.smbmount\fR. The
42 \fB smbmount\fR
43 process may also be called mount.smbfs.
44 .sp
45 .it 1 an-trap
46 .nr an-no-space-flag 1
47 .nr an-break-flag 1
48 .br
49 \fBNote\fR
50 .PP
52 \fBsmbmount\fR
53 calls
54 \fBsmbmnt\fR(8)
55 to do the actual mount. You must make sure that
56 \fBsmbmnt\fR
57 is in the path so that it can be found.
58 .SH "OPTIONS"
59 .TP 3n
60 username=<arg>
61 specifies the username to connect as. If this is not given, then the environment variable
62 \fB USER\fR
63 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.
64 .TP 3n
65 password=<arg>
66 specifies the SMB password. If this option is not given then the environment variable
67 PASSWD
68 is used. If it can find no password
69 \fBsmbmount\fR
70 will prompt for a passeword, unless the guest option is given.
71 .sp
72 Note 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.
73 .TP 3n
74 credentials=<filename>
75 specifies a file that contains a username and/or password. The format of the file is:
77 .sp
78 .nf
80 username = <value>
81 password = <value>
82 .fi
84 .sp
85 This is preferred over having passwords in plaintext in a shared file, such as
86 \fI/etc/fstab\fR. Be sure to protect any credentials file properly.
87 .TP 3n
88 krb
89 Use kerberos (Active Directory).
90 .TP 3n
91 netbiosname=<arg>
92 sets the source NetBIOS name. It defaults to the local hostname.
93 .TP 3n
94 uid=<arg>
95 sets the uid that will own all files on the mounted filesystem. It may be specified as either a username or a numeric uid.
96 .TP 3n
97 gid=<arg>
98 sets the gid that will own all files on the mounted filesystem. It may be specified as either a groupname or a numeric gid.
99 .TP 3n
100 port=<arg>
101 sets the remote SMB port number. The default is 445, fallback is 139.
102 .TP 3n
103 fmask=<arg>
104 sets 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.
105 .TP 3n
106 dmask=<arg>
107 Sets 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.
108 .TP 3n
109 debug=<arg>
110 Sets 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.
111 .TP 3n
112 ip=<arg>
113 Sets the destination host or IP address.
114 .TP 3n
115 workgroup=<arg>
116 Sets the workgroup on the destination
117 .TP 3n
118 sockopt=<arg>
119 Sets the TCP socket options. See the
120 \fBsmb.conf\fR(5)
121 \fIsocket options\fR
122 option.
123 .TP 3n
124 scope=<arg>
125 Sets the NetBIOS scope
126 .TP 3n
127 guest
128 Don't prompt for a password
129 .TP 3n
130 ro
131 mount read-only
132 .TP 3n
133 rw
134 mount read-write
135 .TP 3n
136 iocharset=<arg>
137 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)
138 .TP 3n
139 codepage=<arg>
140 sets the codepage the server uses. See the iocharset option. Example value cp850. (Note: only kernel 2.4.0 or later)
141 .TP 3n
142 ttl=<arg>
143 sets 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)
144 .SH "ENVIRONMENT VARIABLES"
145 .PP
146 The variable
147 \fBUSER\fR
148 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.
149 .PP
150 The variable
151 \fBPASSWD\fR
152 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.
153 .PP
154 The variable
155 \fBPASSWD_FILE\fR
156 may contain the pathname of a file to read the password from. A single line of input is read and used as the password.
157 .SH "OTHER COMMANDS"
158 .PP
159 File systems that have been mounted using the
160 \fBsmbmount\fR
161 can be unmounted using the
162 \fBsmbumount\fR
163 or the UNIX system
164 \fBumount\fR
165 command.
166 .SH "BUGS"
167 .PP
168 Passwords 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.
169 .PP
170 The credentials file does not handle usernames or passwords with leading space.
171 .PP
172 One smbfs bug is important enough to mention here, even if it is a bit misplaced:
173 .TP 3n
174 •
175 Mounts 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.
176 .sp
177 .RE
178 .PP
179 Note 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)
180 .SH "SEE ALSO"
181 .PP
182 Documentation/filesystems/smbfs.txt in the linux kernel source tree may contain additional options and information.
183 .PP
184 FreeBSD also has a smbfs, but it is not related to smbmount
185 .PP
186 For Solaris, HP-UX and others you may want to look at
187 \fBsmbsh\fR(1)
188 or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server.
189 .SH "AUTHOR"
190 .PP
191 Volker Lendecke, Andrew Tridgell, Michael H. Warfield and others.
192 .PP
193 The current maintainer of smbfs and the userspace tools
194 \fBsmbmount\fR,
195 \fBsmbumount\fR, and
196 \fBsmbmnt\fR
197 is
198 Urban Widmark. The
199 SAMBA Mailing list
200 is the preferred place to ask questions regarding these programs.
201 .PP
202 The 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.