first pass at updating head branch to be to be the same as the SAMBA_2_0 branch
[tprouty/samba.git] / docs / manpages / smbmount.8
1 .TH "smbmount " "1" "25 September 1999" "Samba" "SAMBA" 
2 .PP 
3 .SH "NAME" 
4 smbmount \- mount an SMB filesystem
5 .PP 
6 .SH "SYNOPSIS" 
7 \fBsmbmount\fP service mountpoint [ -o options ]
8 .PP 
9 .SH "DESCRIPTION" 
10 .PP 
11 smbmount mounts a SMB filesystem\&. It is usually invoked as mount\&.smb
12 from the mount(8) command when using the "-t smb" option\&. The kernel
13 must support the smbfs filesystem\&.
14 .PP 
15 Options to smbmount are specified as a comma separated list of
16 key=value pairs\&. 
17 .PP 
18 NOTE: smbmount calls smbmnt to do the actual mount\&. You must make sure
19 that smbmnt is in the path so that it can be found\&.
20 .PP 
21 .IP "\fBusername=<arg>\fP" 
22 specifies the username to connect as\&. If this is
23 not given then the environment variable USER is used\&. This option can
24 also take the form user%password or user/workgroup or
25 user/workgroup%password to allow the password and workgroup to be
26 specified as part of the username\&.
27 .IP 
28 .IP "\fBpassword=<arg>\fP" 
29 specifies the SMB password\&. If not given then
30 smbmount will prompt for a passeword, unless the guest option is
31 given\&.
32 .IP 
33 .IP "\fBnetbiosname=<arg>\fP" 
34 sets the source NetBIOS name\&. It defaults to
35 the local hostname\&.
36 .IP 
37 .IP "\fBuid=<arg>\fP" 
38 sets the uid that files will be mounted as\&. It may be
39 specified as either a username or a numeric uid\&.
40 .IP 
41 .IP "\fBgid=<arg>\fP" 
42 sets the gid that files will be mounted as\&. It may be
43 specified as either a groupname or a numeric gid\&.
44 .IP 
45 .IP "\fBport=<arg>\fP" 
46 sets the remote SMB port number\&. The default is 139\&.
47 .IP 
48 .IP "\fBfmask=<arg>\fP" 
49 sets the file mask\&. This deterines the permissions
50 that remote files have in the local filesystem\&. The default is based
51 on the current umask\&.
52 .IP 
53 .IP "\fBdmask=<arg>\fP" 
54 sets the directory mask\&. This deterines the
55 permissions that remote directories have in the local filesystem\&. The
56 default is based on the current umask\&.
57 .IP 
58 .IP "\fBdebug=<arg>\fP" 
59 sets the debug level\&. This is useful for tracking
60 down SMB connection problems\&.
61 .IP 
62 .IP "\fBip=<arg>\fP" 
63 sets the destination host or IP address\&.
64 .IP 
65 .IP "\fBworkgroup=<arg>\fP" 
66 sets the workgroup on the destination
67 .IP 
68 .IP "\fBsockopt=<arg>\fP" 
69 sets the TCP socket options\&. See the smb\&.conf
70 "socket options" option\&.
71 .IP 
72 .IP "\fBscope=<arg>\fP" 
73 sets the NetBIOS scope
74 .IP 
75 .IP "\fBguest\fP" 
76 don\'t prompt for a password
77 .IP 
78 .IP "\fBro\fP" 
79 mount read-only
80 .IP 
81 .IP "\fBrw\fP" 
82 mount read-write
83 .IP 
84 .PP 
85 .SH "AUTHOR" 
86 The maintainer of smbfs, smbmnt and smbmount is Andrew Tridgell
87 \fItridge@samba\&.org\fP