summaryrefslogtreecommitdiff
path: root/docs/docbook/manpages/smbmount.8.sgml
blob: a1a510ecd7cad9f7d81cea1a900564033a4e0d2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="smbmount">

<refmeta>
	<refentrytitle>smbmount</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>smbmount</refname>
	<refpurpose>mount and smbfs filesystem</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbumount</command>
		<arg choice="req">service</arg>
		<arg choice="req">mount-point</arg>
		<arg choice="opt">-o options</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para><command>smbmount</command> mounts a SMB filesystem. It 
	is usually invoked as <command>mount.smb</command> from 
	the <command>mount(8)</command> command when using the 
	"-t smb" option. The kernel must support the smbfs filesystem. </para>

	<para>Options to smbmount are specified as a comma separated list 
	of key=value pairs.</para>

	<para><emphasis>NOTE:</emphasis> <command>smbmount</command> 
	calls <command>smbmnt(8)</command> to do the actual mount. You 
	must make sure that <command>smbmnt</command> is in the path so 
	that it can be found. </para>
	
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>username=&lt;arg&gt;</term>
		<listitem><para>specifies the username to connect as. If
		this is not given then the environment variable <parameter>
		$USER</parameter> 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.</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>password=&lt;arg&gt;</term>
		<listitem><para>specifies the SMB password. If not given then 
		<command>smbmount</command> will prompt for a passeword, unless 
		the guest option is given. </para></listitem>
		</varlistentry>



		<varlistentry>
		<term>netbiosname=&lt;arg&gt;</term>
		<listitem><para>sets the source NetBIOS name. It defaults 
		to the local hostname. </para></listitem>
		</varlistentry>



		<varlistentry>
		<term>uid=&lt;arg&gt;</term>
		<listitem><para>sets the uid that files will be mounted as. 
		It may be specified as either a username or a numeric uid.
		</para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>gid=&lt;arg&gt;</term>
		<listitem><para>sets the gid that files will be mounted as. 
		It may be specified as either a groupname or a numeric 
		gid. </para></listitem>		
		</varlistentry>
		
		
		<varlistentry>
		<term>port=&lt;arg&gt;</term>
		<listitem><para>sets the remote SMB port number. The default 
		is 139. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>fmask=&lt;arg&gt;</term>
		<listitem><para>sets the file mask. This determines the 
		permissions that remote files have in the local filesystem. 
		The default is based on the current umask. </para></listitem>
		</varlistentry>
		

		<varlistentry>
		<term>dmask=&lt;arg&gt;</term>
		<listitem><para>sets the directory mask. This deterines the 
		permissions that remote directories have in the local filesystem. 
		The default is based on the current umask. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>debug=&lt;arg&gt;</term>
		<listitem><para>sets the debug level. This is useful for 
		tracking down SMB connection problems. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>ip=&lt;arg&gt;</term>
		<listitem><para>sets the destination host or IP address.
		</para></listitem>
		</varlistentry>



		<varlistentry>
		<term>workgroup=&lt;arg&gt;</term>
		<listitem><para>sets the workgroup on the destination </para>
		</listitem>
		</varlistentry>


		<varlistentry>
		<term>sockopt=&lt;arg&gt;</term>
		<listitem><para>sets the TCP socket options. See the <ulink
		url="smb.conf.5.html#SOCKETOPTIONS"><filename>smb.conf
		</filename></ulink> <parameter>socket options</parameter> option.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>scope=&lt;arg&gt;</term>
		<listitem><para>sets the NetBIOS scope </para></listitem>
		</varlistentry>

		<varlistentry>
		<term>guest</term>
		<listitem><para>don't prompt for a password </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>ro</term>
		<listitem><para>mount read-only </para></listitem>
		</varlistentry>

		<varlistentry>
		<term>rw</term><listitem><para>mount read-write </para></listitem>
		</varlistentry>
	</variablelist>


</refsect1>


<refsect1>
	<title>AUTHOR</title>
	
	<para>The current maintainer of smbfs and the userspace
	tools <command>smbmount</command>, <command>smbumount</command>,
	and <command>smbmnt</command> is <ulink 
	url="mailto:urban@teststation.com">Urban Widmark</ulink></para>
	
	<para>The conversion of this manpage for Samba 2.2 was performed 
	by Gerald Carter</para>
</refsect1>

</refentry>