Sync usage with man page.
[netbsd-mini2440.git] / dist / smbfs / mount_smbfs / mount_smbfs.8
blob6dc769fd051da2f6566aa6c57ded0f6da8a53c6d
1 .\" $NetBSD: mount_smbfs.8,v 1.12 2007/07/21 22:41:09 rumble Exp $
2 .\" from: Id: mount_smbfs.8,v 1.10 2002/04/16 02:47:41 bp Exp
3 .\"
4 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 .\" POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .Dd November 9, 2003
29 .Dt MOUNT_SMBFS 8
30 .Os
31 .Sh NAME
32 .Nm mount_smbfs
33 .Nd "mount a shared resource from an SMB/CIFS file server"
34 .Sh SYNOPSIS
35 .Nm
36 .Op Fl E Ar cs1 : Ns Ar cs2
37 .Op Fl I Ar host
38 .Op Fl L Ar locale
39 .Op Fl M Ar crights : Ns Ar srights
40 .Op Fl N
41 .Op Fl O Ar cowner : Ns Ar cgroup Ns / Ns Ar sowner : Ns Ar sgroup
42 .Op Fl R Ar retrycount
43 .Op Fl T Ar timeout
44 .Op Fl W Ar workgroup
45 .Op Fl c Ar case
46 .Op Fl d Ar mode
47 .Op Fl f Ar mode
48 .Op Fl g Ar gid
49 .Op Fl n Ar opt
50 .Op Fl u Ar uid
51 .Sm off
52 .No // Ar user No @ Ar server / Ar share
53 .Sm on
54 .Ar node
55 .Sh DESCRIPTION
56 The
57 .Nm
58 command mounts a share from a remote server using SMB/CIFS protocol.
59 .Pp
60 The options are as follows:
61 .Bl -tag -width indent
62 .It Fl E Ar cs1 : Ns Ar cs2
63 Specifies local
64 .Pq Ar cs1
65 and server's
66 .Pq Ar cs2
67 character sets.
68 .It Fl I Ar host
69 Do not use NetBIOS name resolver and connect directly to
70 .Ar host ,
71 which can be either a valid DNS name or an IP address.
72 .It Fl L Ar locale
73 Use
74 .Ar locale
75 for lower/upper case conversion routines.
76 Set the locale for case conversion.
77 By default,
78 .Nm
79 tries to use an environment variable
80 .Ev LC_*
81 to determine it.
82 .It Fl M Ar crights : Ns Ar srights
83 Assign access rights to the newly created connection.
84 .\" See
85 .\" .Xr nsmb 8
86 .\" for theory.
87 .It Fl N
88 Do not ask for a password.
89 At run time,
90 .Nm
91 reads the
92 .Pa ~/.nsmbrc
93 file for additional configuration parameters and a password.
94 If no password is found,
95 .Nm
96 prompts for it.
97 .It Fl O Ar cowner : Ns Ar cgroup Ns / Ns Ar sowner : Ns Ar sgroup
98 Assign owner/group attributes to the newly created connection.
99 .\" See
100 .\" .Xr nsmb 8
101 .\" for theory.
102 .It Fl R Ar retrycount
103 How many retries should be done before the SMB requester decides to drop
104 the connection.
105 .It Fl T Ar timeout
106 Timeout in seconds for each request.
107 .It Fl W Ar workgroup
108 This option specifies the workgroup to be used in the authentication request.
109 .It Fl c Ar case
110 Set a
111 .Ar case
112 option which affects name representation.
113 .Ar case
114 can be one of the following:
115 .Bl -tag -width ".Em Value"
116 .It Em Value
117 .Em Meaning
118 .It Cm l
119 All existing file names are converted to lower case.
120 Newly created file gets a lower case.
121 .It Cm u
122 All existing file names are converted to upper case.
123 Newly created file gets an upper case.
125 .It Fl f Ar mode , Fl d Ar mode
126 Specify permissions that should be assigned to files and directories.
127 The values must be specified as octal numbers.
128 Default value for the file mode
129 is taken from mount point, default value for the directory mode adds execute
130 permission where the file mode gives read permission.
132 Note that these permissions can differ from the rights granted by SMB
133 server.
134 .It Fl u Ar uid , Fl g Ar gid
135 User ID and group ID assigned to files.
136 The default are owner and group IDs from
137 the directory where the volume is mounted.
138 .It No // Ns Ar user Ns @ Ns Ar server Ns / Ns Ar share
141 command will use
142 .Ar server
143 as the NetBIOS name of remote computer,
144 .Ar user
145 as the remote user name and
146 .Ar share
147 as the resource name on a remote server.
148 If your connections are refused, try using the
149 .Fl I
150 option and use a server name of
151 .Bk -words
152 .Sq "*SMBSERVER" .
154 .It Ar node
155 Path to mount point.
157 .Sh FILES
158 .Bl -tag -width " /etc/nsmb.conf" -compact
159 .It Pa /etc/nsmb.conf
160 System wide parameters for smbfs mounts.
161 .It Pa ~/.nsmbrc
162 Keeps static parameters for connections and other information.
164 .Pa /usr/share/examples/smbfs/dot.nsmbrc
165 for details.
167 .Sh EXAMPLES
168 The following example illustrates how to connect to SMB server
169 .Em SAMBA
170 as user
171 .Em GUEST ,
172 and mount shares
173 .Em PUBLIC
175 .Em TMP :
176 .Bd -literal -offset indent
177 mount_smbfs -I samba.mydomain.com //guest@samba/public /smb/public
178 mount_smbfs -I 192.168.20.3 -E koi8-r:cp866 //guest@samba/tmp /smb/tmp
181 If you keep on getting "Connection reset by peer" errors, try:
182 .Bd -literal -offset indent
183 mount_smbfs -N -I 10.0.0.4 //'*SMBSERVER'/tmp /smb/tmp
186 It is possible to use
187 .Xr fstab 5
188 for smbfs mounts:
190 .Dl "//guest@samba/public    /smb/public     smbfs  rw,noauto 0   0"
191 .Sh SEE ALSO
192 .Xr mount 8
193 .Sh HISTORY
194 Support for SMBFS first appeared in
195 .Fx 4.4 .
196 It has been ported to
198 and first appeared in
199 .Nx 2.0 .
200 .Sh AUTHORS
201 .An Boris Popov Aq bp@butya.kz ,
202 .Aq bp@FreeBSD.org .
204 port done by
205 .An Matt Debergalis
206 .Aq deberg@NetBSD.org ,
208 .An Jaromir Dolecek
209 .Aq jdolecek@NetBSD.org .