sbin/mount/mount.8

   1 .\" Copyright (c) 1980, 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mount.8     8.8 (Berkeley) 6/16/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 16, 1994
  36 .Dt MOUNT 8
  37 .Os
  38 .Sh NAME
  39 .Nm mount
  40 .Nd mount file systems
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl adfpruvw
  44 .Op Fl t Ar ufs | external_type
  45 .Nm
  46 .Op Fl dfpruvw
  47 .Ar special | node
  48 .Nm
  49 .Op Fl dfpruvw
  50 .Op Fl o Ar options
  51 .Op Fl t Ar ufs | external_type
  52 .Ar special node
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 command
  57 calls the
  58 .Xr mount 2
  59 system call to prepare and graft a
  60 .Ar "special device"
  61 or the remote node (rhost:path) on to the file system tree at the point
  62 .Ar node .
  63 If either
  64 .Ar special
  65 or
  66 .Ar node
  67 are not provided, the appropriate information is taken from the
  68 .Xr fstab 5
  69 file.
  70 .Pp
  71 The system maintains a list of currently mounted file systems.
  72 If no arguments are given to
  73 .Nm ,
  74 this list is printed.
  75 .Pp
  76 The options are as follows:
  77 .Bl -tag -width indent
  78 .It Fl a
  79 All the filesystems described in
  80 .Xr fstab 5
  81 are mounted.
  82 Exceptions are those marked as
  83 .Dq noauto ,
  84 excluded by the
  85 .Fl t
  86 flag (see below), or if they are already mounted (except the
  87 root filesystem which is always remounted to preserve
  88 traditional single user mode behavior).
  89 .It Fl d
  90 Causes everything to be done except for the actual system call.
  91 This option is useful in conjunction with the
  92 .Fl v
  93 flag to
  94 determine what the
  95 .Nm
  96 command is trying to do.
  97 .It Fl f
  98 Forces the revocation of write access when trying to downgrade
  99 a filesystem mount status from read-write to read-only.
 100 Also
 101 forces the R/W mount of an unclean filesystem (dangerous; use with
 102 caution).
 103 .It Fl o
 104 Options are specified with a
 105 .Fl o
 106 flag followed by a comma separated string of options.
 107 In case of conflicting options being specified, the rightmost option
 108 takes effect.
 109 The following options are available:
 110 .Bl -tag -width indent
 111 .It Cm async
 112 All
 113 .Tn I/O
 114 to the file system should be done asynchronously.
 115 This is a
 116 .Em dangerous
 117 flag to set,
 118 and should not be used unless you are prepared to recreate the file
 119 system should your system crash.
 120 .It Cm current
 121 When used with the
 122 .Fl u
 123 flag, this is the same as specifying the options currently in effect for
 124 the mounted filesystem.
 125 .It Cm force
 126 The same as
 127 .Fl f ;
 128 forces the revocation of write access when trying to downgrade
 129 a filesystem mount status from read-write to read-only.
 130 Also
 131 forces the R/W mount of an unclean filesystem (dangerous; use with caution).
 132 .It Cm fstab
 133 When used with the
 134 .Fl u
 135 flag, this is the same as specifying all the options listed in the
 136 .Xr fstab 5
 137 file for the filesystem.
 138 .It Cm noasync
 139 Metadata I/O should be done synchronously, while data I/O should be done
 140 asynchronously.
 141 This is the default.
 142 .It Cm noatime
 143 Do not update the file access time when reading from a file.
 144 This option
 145 is useful on filesystems where there are large numbers of files and
 146 performance is more critical than updating the file access time (which is
 147 rarely ever important).
 148 This option is currently only supported on local filesystems.
 149 .It Cm noauto
 150 This filesystem should be skipped when
 151 .Nm
 152 is run with the
 153 .Fl a
 154 flag.
 155 .It Cm noclusterr
 156 Disable read clustering.
 157 .It Cm noclusterw
 158 Disable write clustering.
 159 .It Cm nodev
 160 Do not interpret character or block special devices on the file system.
 161 This option is useful for a server that has file systems containing
 162 special devices for architectures other than its own.
 163 .It Cm noexec
 164 Do not allow execution of any binaries on the mounted file system.
 165 This option is useful for a server that has file systems containing
 166 binaries for architectures other than its own.
 167 .It Cm nosuid
 168 Do not allow set-user-identifier or set-group-identifier bits to take effect.
 169 Note: this option is worthless if a public available suid or sgid
 170 wrapper like
 171 .Xr suidperl 1
 172 is installed on your system.
 173 .It Cm nosymfollow
 174 Do not follow symlinks
 175 on the mounted file system.
 176 .It Cm rdonly
 177 The same as
 178 .Fl r ;
 179 mount the file system read-only (even the super-user may not write it).
 180 .It Cm sync
 181 All
 182 .Tn I/O
 183 to the file system should be done synchronously.
 184 .It Cm suiddir
 185 A directory on the mounted filesystem will respond to the SUID bit
 186 being set, by setting the owner of any new files to be the same
 187 as the owner of the directory.
 188 New directories will inherit the bit from their parents.
 189 Execute bits are removed from
 190 the file, and it will not be given to root.
 191 .Pp
 192 This feature is designed for use on fileservers serving PC users via
 193 ftp, SAMBA, or netatalk.
 194 It provides security holes for shell users and as
 195 such should not be used on shell machines, especially on home directories.
 196 This option requires the SUIDDIR
 197 option in the kernel to work.
 198 Only UFS filesystems support this option.
 199 See
 200 .Xr chmod 2
 201 for more information.
 202 .It Cm update
 203 The same as
 204 .Fl u ;
 205 indicate that the status of an already mounted file system should be changed.
 206 .It Cm union
 207 Causes the namespace at the mount point to appear as the union
 208 of the mounted filesystem root and the existing directory.
 209 Lookups will be done in the mounted filesystem first.
 210 If those operations fail due to a non-existent file the underlying
 211 directory is then accessed.
 212 All creates are done in the mounted filesystem.
 213 .El
 214 .Pp
 215 Any additional options specific to a filesystem type that is not
 216 one of the internally known types (see the
 217 .Fl t
 218 option) may be passed as a comma separated list; these options are
 219 distinguished by a leading
 220 .Dq \&-
 221 (dash).
 222 Options that take a value are specified using the syntax -option=value.
 223 For example, the
 224 .Nm
 225 command:
 226 .Bd -literal -offset indent
 227 mount -t unionfs -o -b /sys $HOME/sys
 228 .Ed
 229 .Pp
 230 causes
 231 .Nm
 232 to execute the equivalent of:
 233 .Bd -literal -offset indent
 234 /sbin/mount_unionfs -b /sys $HOME/sys
 235 .Ed
 236 .Pp
 237 Additional options specific to filesystem types
 238 which are not internally known
 239 (see the description of the
 240 .Fl t
 241 option below)
 242 may be described in the manual pages for the associated
 243 .Pa /sbin/mount_ Ns Sy XXX
 244 utilities.
 245 .It Fl p
 246 Print mount information in
 247 .Xr fstab 5
 248 format.
 249 Implies also the
 250 .Fl v
 251 option.
 252 .It Fl r
 253 The file system is to be mounted read-only.
 254 Mount the file system read-only (even the super-user may not write it).
 255 The same as the
 256 .Cm rdonly
 257 argument to the
 258 .Fl o
 259 option.
 260 .It Fl t Ar ufs | external_type
 261 The argument following the
 262 .Fl t
 263 is used to indicate the file system type.
 264 The type
 265 .Ar ufs
 266 is the default.
 267 The
 268 .Fl t
 269 option can be used
 270 to indicate that the actions should only be taken on
 271 filesystems of the specified type.
 272 More than one type may be specified in a comma separated list.
 273 The list of filesystem types can be prefixed with
 274 .Dq no
 275 to specify the filesystem types for which action should
 276 .Em not
 277 be taken.
 278 For example, the
 279 .Nm
 280 command:
 281 .Bd -literal -offset indent
 282 mount -a -t nonfs,nullfs
 283 .Ed
 284 .Pp
 285 mounts all filesystems except those of type
 286 .Tn NFS
 287 and
 288 .Tn NULLFS .
 289 .Pp
 290 If the type is not one of the internally known types,
 291 .Nm
 292 will attempt to execute a program in
 293 .Pa /sbin/mount_ Ns Sy XXX
 294 where
 295 .Sy XXX
 296 is replaced by the type name.
 297 For example, nfs filesystems are mounted by the program
 298 .Pa /sbin/mount_nfs .
 299 .Pp
 300 Most filesystems will be dynamically loaded by their
 301 .Nm
 302 programs
 303 if not already present in the kernel, using the
 304 .Xr vfsload 3
 305 subroutine.
 306 Because this mechanism requires writable temporary space,
 307 the filesystem type containing
 308 .Pa /tmp
 309 must be compiled into the kernel, and the filesystems containing
 310 .Pa /tmp
 311 and
 312 .Pa /usr/bin/ld
 313 must be listed in
 314 .Pa /etc/fstab
 315 before any filesystems which might be dynamically loaded.
 316 .It Fl u
 317 The
 318 .Fl u
 319 flag indicates that the status of an already mounted file
 320 system should be changed.
 321 Any of the options discussed above (the
 322 .Fl o
 323 option)
 324 may be changed;
 325 also a file system can be changed from read-only to read-write
 326 or vice versa.
 327 An attempt to change from read-write to read-only will fail if any
 328 files on the filesystem are currently open for writing unless the
 329 .Fl f
 330 flag is also specified.
 331 The set of options is determined by applying the options specified
 332 in the argument to
 333 .Fl o
 334 and finally applying the
 335 .Fl r
 336 or
 337 .Fl w
 338 option.
 339 .It Fl v
 340 Verbose mode.
 341 .It Fl w
 342 The file system object is to be read and write.
 343 .El
 344 .Sh DIAGNOSTICS
 345 Various, most of them are self-explanatory.
 346 .Pp
 347 .Dl XXXXX filesystem is not available
 348 .Pp
 349 The kernel does not support the respective filesystem type.
 350 Note that
 351 support for a particular filesystem might be provided either on a static
 352 (kernel compile-time), or dynamic basis (loaded as a kernel module by
 353 .Xr kldload 8 ) .
 354 Normally,
 355 .Nm
 356 or its subprocesses attempt to dynamically load a filesystem module if
 357 it has not been configured statically, using
 358 .Xr vfsload 3 .
 359 In this case, the above error message can also mean that you did not
 360 have permission to load the module.
 361 .Sh FILES
 362 .Bl -tag -width /etc/fstab -compact
 363 .It Pa /etc/fstab
 364 file system table
 365 .El
 366 .Sh SEE ALSO
 367 .Xr mount 2 ,
 368 .Xr vfsload 3 ,
 369 .Xr fstab 5 ,
 370 .Xr kldload 8 ,
 371 .Xr mount_cd9660 8 ,
 372 .Xr mount_devfs 8 ,
 373 .Xr mount_ext2fs 8 ,
 374 .Xr mount_fdescfs 8 ,
 375 .Xr mount_hpfs 8 ,
 376 .Xr mount_linprocfs 8 ,
 377 .Xr mount_msdosfs 8 ,
 378 .Xr mount_nfs 8 ,
 379 .Xr mount_ntfs 8 ,
 380 .Xr mount_nullfs 8 ,
 381 .Xr mount_nwfs 8 ,
 382 .Xr mount_portalfs 8 ,
 383 .Xr mount_procfs 8 ,
 384 .Xr mount_std 8 ,
 385 .Xr mount_umapfs 8 ,
 386 .Xr mount_unionfs 8 ,
 387 .Xr umount 8
 388 .Sh BUGS
 389 It is possible for a corrupted file system to cause a crash.
 390 .Sh CAVEATS
 391 After a successful
 392 .Nm ,
 393 the permissions on the original mount point determine if
 394 .Pa ..\&
 395 is accessible from the mounted file system.
 396 The minimum permissions for
 397 the mount point for traversal across the mount point in both
 398 directions to be possible for all users is 0111 (execute for all).
 399 .Sh HISTORY
 400 A
 401 .Nm
 402 command appeared in
 403 .At v1 .