Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sbin / mount_msdos / mount_msdos.8
1 .\"     $NetBSD: mount_msdos.8,v 1.13 1998/02/06 05:57:00 perry Exp $
2 .\"
3 .\" Copyright (c) 1993,1994 Christopher G. Demetriou
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgment:
16 .\"      This product includes software developed by Christopher G. Demetriou.
17 .\" 3. The name of the author may not be used to endorse or promote products
18 .\"    derived from this software without specific prior written permission
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .\" $FreeBSD: src/sbin/mount_msdos/mount_msdos.8,v 1.19.2.1 2000/12/08 14:03:59 ru Exp $
32 .\"
33 .Dd April 7, 1994
34 .Dt MOUNT_MSDOS 8
35 .Os
36 .Sh NAME
37 .Nm mount_msdos
38 .Nd mount an MS-DOS file system
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl o Ar options
42 .Op Fl u Ar uid
43 .Op Fl g Ar gid
44 .Op Fl m Ar mask
45 .Op Fl s
46 .Op Fl l
47 .Op Fl 9
48 .\".Op Fl G
49 .Op Fl L Ar locale
50 .Op Fl W Ar table
51 .Pa special
52 .Pa node
53 .Sh DESCRIPTION
54 The
55 .Nm
56 command attaches the MS-DOS filesystem residing on
57 the device
58 .Pa special
59 to the global filesystem namespace at the location
60 indicated by
61 .Pa node .
62 This command is normally executed by
63 .Xr mount 8
64 at boot time, but can be used by any user to mount an
65 MS-DOS file system on any directory that they own (provided,
66 of course, that they have appropriate access to the device that
67 contains the file system).
68 .Pp
69 The options are as follows:
70 .Bl -tag -width Ds
71 .It Fl o Ar options
72 Use the specified mount
73 .Ar options ,
74 as described in
75 .Xr mount 8 ,
76 or one of the MSDOS filesystem-specific options
77 .Ar shortnames ,
78 .Ar longnames
79 or
80 .Ar nowin95 ,
81 all of which can be used to affect Windows name translation in the
82 underlying filesystem.
83 .It Fl u Ar uid
84 Set the owner of the files in the file system to
85 .Ar uid .
86 The default owner is the owner of the directory
87 on which the file system is being mounted.
88 .It Fl g Ar gid
89 Set the group of the files in the file system to
90 .Ar gid .
91 The default group is the group of the directory
92 on which the file system is being mounted.
93 .It Fl m Ar mask
94 Specify the maximum file permissions for files
95 in the file system.
96 (For example, a
97 .Ar mask
98 of
99 .Li 755
100 specifies that, by default, the owner should have
101 read, write, and execute permissions for files, but
102 others should only have read and execute permissions.
103 See
104 .Xr chmod 1
105 for more information about octal file modes.)
106 Only the nine low-order bits of
107 .Ar mask
108 are used.
109 The default
110 .Ar mask
111 is taken from the
112 directory on which the file system is being mounted.
113 .It Fl s
114 Force behaviour to
115 ignore and not generate Win'95 long filenames.
116 .It Fl l
117 Force listing and generation of
118 Win'95 long filenames
119 and separate creation/modification/access dates.
120 .Pp
121 If neither
122 .Fl s
123 nor
124 .Fl l
125 are given,
126 .Nm
127 searches the root directory of the filesystem to
128 be mounted for any existing Win'95 long filenames.
129 If no such entries are found, but short DOS filenames are found,
130 .Fl s
131 is the default.
132 Otherwise
133 .Fl l
134 is assumed.
135 .It Fl 9
136 Ignore the special Win'95 directory entries even
137 if deleting or renaming a file.
138 This forces
139 .Fl s .
140 .\".It Fl G
141 .\"This option causes the filesystem to be interpreted as an Atari-Gemdos
142 .\"filesystem. The differences to the MS-DOS filesystem are minimal and
143 .\"limited to the boot block. This option enforces
144 .\".Fl s .
145 .It Fl L Ar locale
146 Specify locale name used for internal uppercase and lowercase conversions
147 for DOS and Win'95 names.
148 By default ISO 8859-1 assumed as local character set.
149 .It Fl W Ar table
150 Specify text file with 3 conversion tables:
151 .Bl -enum
152 .It
153 Local character set to Unicode conversion table (upper half) for Win'95 long
154 names, 128 Unicode codes separated by 8 per row.
155 If some code not present in Unicode, use
156 0x003F code ('?') as replacement.
157 .It
158 DOS to local character set conversion table (upper half) for DOS names,
159 128 character codes separated by 8 per row.
160 Code 0x3F ('?') used for impossible translations.
161 .It
162 Local character set to DOS conversion table (upper half) for DOS names,
163 128 character codes separated by 8 per row.
164 Some codes have special meaning:
165 .Bl -hang
166 .It 0x00
167 character disallowed in DOS file name;
168 .It 0x01
169 character should be replaced by '_' in DOS file name;
170 .It 0x02
171 character should be skipped in DOS file name;
172 .El
173 .El
174 .Pp
175 By default ISO 8859-1 assumed as local character set.
176 If file path isn't absolute,
177 .Pa /usr/libdata/msdosfs/
178 prefix prepended.
179 .El
180 .Sh FILES
181 .Bl -tag -width /usr/libdata/msdosfs -compact
182 .It Pa /usr/libdata/msdosfs
183 default place for character sets conversion tables
184 .El
185 .Sh SEE ALSO
186 .Xr mount 2 ,
187 .Xr unmount 2 ,
188 .Xr fstab 5 ,
189 .Xr mount 8
190 .Sh CAVEATS
191 The use of the
192 .Fl 9
193 flag could result in damaged filesystems,
194 albeit the damage is in part taken care of by
195 procedures similar to the ones used in Win'95.
196 .Pp
197 .Fx 2.1
198 and earlier versions could not handle cluster sizes larger than 16K.
199 Just mounting an MS-DOS file system could cause corruption to any
200 mounted file system.
201 Cluster sizes larger than 16K are unavoidable for file system sizes
202 larger than 1G, and also occur when filesystems larger than 1G are
203 shrunk to smaller than 1G using FIPS.
204 .Sh HISTORY
205 The
206 .Nm
207 utility first appeared in
208 .Fx 2.0 .
209 Its predecessor, the
210 .Nm mount_pcfs
211 utility appeared in
212 .Fx 1.0 ,
213 and was abandoned in favor
214 of the more aptly-named
215 .Nm .