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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mount.8     8.8 (Berkeley) 6/16/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 26, 2004
  32 .Dt MOUNT 8
  33 .Os
  34 .Sh NAME
  35 .Nm mount
  36 .Nd mount file systems
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl adfpruvw
  40 .Op Fl F Ar fstab
  41 .Op Fl o Ar options
  42 .Op Fl t Ar ufs | external_type
  43 .Nm
  44 .Op Fl dfpruvw
  45 .Ar special | node
  46 .Nm
  47 .Op Fl dfpruvw
  48 .Op Fl o Ar options
  49 .Op Fl t Ar ufs | external_type
  50 .Ar special node
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility calls the
  55 .Xr nmount 2
  56 system call to prepare and graft a
  57 .Ar "special device"
  58 or the remote node (rhost:path) on to the file system tree at the point
  59 .Ar node .
  60 If either
  61 .Ar special
  62 or
  63 .Ar node
  64 are not provided, the appropriate information is taken from the
  65 .Xr fstab 5
  66 file.
  67 .Pp
  68 The system maintains a list of currently mounted file systems.
  69 If no arguments are given to
  70 .Nm ,
  71 this list is printed.
  72 .Pp
  73 The options are as follows:
  74 .Bl -tag -width indent
  75 .It Fl a
  76 All the file systems described in
  77 .Xr fstab 5
  78 are mounted.
  79 Exceptions are those marked as
  80 .Dq noauto ,
  81 excluded by the
  82 .Fl t
  83 flag (see below), or if they are already mounted (except the
  84 root file system which is always remounted to preserve
  85 traditional single user mode behavior).
  86 .It Fl d
  87 Causes everything to be done except for the actual system call.
  88 This option is useful in conjunction with the
  89 .Fl v
  90 flag to
  91 determine what the
  92 .Nm
  93 command is trying to do.
  94 .It Fl F Ar fstab
  95 Specify the
  96 .Pa fstab
  97 file to use.
  98 .It Fl f
  99 Forces the revocation of write access when trying to downgrade
 100 a file system mount status from read-write to read-only.
 101 Also
 102 forces the R/W mount of an unclean file system (dangerous; use with
 103 caution).
 104 .It Fl o
 105 Options are specified with a
 106 .Fl o
 107 flag followed by a comma separated string of options.
 108 In case of conflicting options being specified, the rightmost option
 109 takes effect.
 110 The following options are available:
 111 .Bl -tag -width indent
 112 .It Cm acls
 113 Enable Access Control Lists, or ACLS, which can be customized via the
 114 .Xr setfacl 1
 115 and
 116 .Xr getfacl 1
 117 commands.
 118 .It Cm async
 119 All
 120 .Tn I/O
 121 to the file system should be done asynchronously.
 122 This is a
 123 .Em dangerous
 124 flag to set,
 125 and should not be used unless you are prepared to recreate the file
 126 system should your system crash.
 127 .It Cm current
 128 When used with the
 129 .Fl u
 130 flag, this is the same as specifying the options currently in effect for
 131 the mounted file system.
 132 .It Cm force
 133 The same as
 134 .Fl f ;
 135 forces the revocation of write access when trying to downgrade
 136 a file system mount status from read-write to read-only.
 137 Also
 138 forces the R/W mount of an unclean file system (dangerous; use with caution).
 139 .It Cm fstab
 140 When used with the
 141 .Fl u
 142 flag, this is the same as specifying all the options listed in the
 143 .Xr fstab 5
 144 file for the file system.
 145 .It Cm multilabel
 146 Enable multi-label Mandatory Access Control, or MAC, on the specified file
 147 system.
 148 If the file system supports multilabel operation, individual labels will
 149 be maintained for each object in the file system, rather than using a
 150 single label for all objects.
 151 An alternative to the
 152 .Fl l
 153 flag in
 154 .Xr tunefs 8 .
 155 See
 156 .Xr mac 4
 157 for more information, which cause the multilabel mount flag to be set
 158 automatically at mount-time.
 159 .It Cm noasync
 160 Metadata I/O should be done synchronously, while data I/O should be done
 161 asynchronously.
 162 This is the default.
 163 .It Cm noatime
 164 Do not update the file access time when reading from a file.
 165 This option
 166 is useful on file systems where there are large numbers of files and
 167 performance is more critical than updating the file access time (which is
 168 rarely ever important).
 169 This option is currently only supported on local file systems.
 170 .It Cm noauto
 171 This file system should be skipped when
 172 .Nm
 173 is run with the
 174 .Fl a
 175 flag.
 176 .It Cm noclusterr
 177 Disable read clustering.
 178 .It Cm noclusterw
 179 Disable write clustering.
 180 .It Cm noexec
 181 Do not allow execution of any binaries on the mounted file system.
 182 This option is useful for a server that has file systems containing
 183 binaries for architectures other than its own.
 184 Note: This option was not designed as a security feature and no
 185 guarantee is made that it will prevent malicious code execution; for
 186 example, it is still possible to execute scripts which reside on a
 187 .Cm noexec
 188 mounted partition.
 189 .It Cm nosuid
 190 Do not allow set-user-identifier or set-group-identifier bits to take effect.
 191 Note: this option is worthless if a public available suid or sgid
 192 wrapper like
 193 .Xr suidperl 1
 194 is installed on your system.
 195 It is set automatically when the user does not have super-user privileges.
 196 .It Cm nosymfollow
 197 Do not follow symlinks
 198 on the mounted file system.
 199 .It Cm ro
 200 The same as
 201 .Fl r ;
 202 mount the file system read-only (even the super-user may not write it).
 203 .It Cm sync
 204 All
 205 .Tn I/O
 206 to the file system should be done synchronously.
 207 .It Cm snapshot
 208 This option allows a snapshot of the specified file system to be taken.
 209 The
 210 .Fl u
 211 flag is required with this option.
 212 Note that snapshot files must be created in the file system that is being
 213 snapshotted.
 214 You may create up to 20 snapshots per file system.
 215 Active snapshots are recorded in the superblock, so they persist across unmount
 216 and remount operations and across system reboots.
 217 When you are done with a snapshot, it can be removed with the
 218 .Xr rm 1
 219 command.
 220 Snapshots may be removed in any order, however you may not get back all the
 221 space contained in the snapshot as another snapshot may claim some of the blocks
 222 that it is releasing.
 223 Note that the schg flag is set on snapshots to ensure that not even the root
 224 user can write to them.
 225 The unlink command makes an exception for snapshot files in that it allows them
 226 to be removed even though they have the schg flag set, so it is not necessary to
 227 clear the schg flag before removing a snapshot file.
 228 .Pp
 229 Once you have taken a snapshot, there are three interesting things that you can
 230 do with it:
 231 .Pp
 232 .Bl -enum -compact
 233 .It
 234 Run
 235 .Xr fsck 8
 236 on the snapshot file.
 237 Assuming that the file system was clean when it was mounted, you should always
 238 get a clean (and unchanging) result from running fsck on the snapshot.
 239 This is essentially what the background fsck process does.
 240 .Pp
 241 .It
 242 Run
 243 .Xr dump 8
 244 on the snapshot.
 245 You will get a dump that is consistent with the file system as of the timestamp
 246 of the snapshot.
 247 .Pp
 248 .It
 249 Mount the snapshot as a frozen image of the file system.
 250 To mount the snapshot
 251 .Pa /var/snapshot/snap1 :
 252 .Bd -literal
 253 mdconfig -a -t vnode -f /var/snapshot/snap1 -u 4
 254 mount -r /dev/md4 /mnt
 255 .Ed
 256 .Pp
 257 You can now cruise around your frozen
 258 .Pa /var
 259 file system at
 260 .Pa /mnt .
 261 Everything will be in the same state that it was at the time the snapshot was
 262 taken.
 263 The one exception is that any earlier snapshots will appear as zero length
 264 files.
 265 When you are done with the mounted snapshot:
 266 .Bd -literal
 267 umount /mnt
 268 mdconfig -d -u 4
 269 .Ed
 270 .Pp
 271 Further details can be found in the file at
 272 .Pa /usr/src/sys/ufs/ffs/README.snapshot .
 273 .El
 274 .It Cm suiddir
 275 A directory on the mounted file system will respond to the SUID bit
 276 being set, by setting the owner of any new files to be the same
 277 as the owner of the directory.
 278 New directories will inherit the bit from their parents.
 279 Execute bits are removed from
 280 the file, and it will not be given to root.
 281 .Pp
 282 This feature is designed for use on fileservers serving PC users via
 283 ftp, SAMBA, or netatalk.
 284 It provides security holes for shell users and as
 285 such should not be used on shell machines, especially on home directories.
 286 This option requires the SUIDDIR
 287 option in the kernel to work.
 288 Only UFS file systems support this option.
 289 See
 290 .Xr chmod 2
 291 for more information.
 292 .It Cm update
 293 The same as
 294 .Fl u ;
 295 indicate that the status of an already mounted file system should be changed.
 296 .It Cm union
 297 Causes the namespace at the mount point to appear as the union
 298 of the mounted file system root and the existing directory.
 299 Lookups will be done in the mounted file system first.
 300 If those operations fail due to a non-existent file the underlying
 301 directory is then accessed.
 302 All creates are done in the mounted file system.
 303 .El
 304 .Pp
 305 Any additional options specific to a file system type that is not
 306 one of the internally known types (see the
 307 .Fl t
 308 option) may be passed as a comma separated list; these options are
 309 distinguished by a leading
 310 .Dq \&-
 311 (dash).
 312 Options that take a value are specified using the syntax -option=value.
 313 For example, the
 314 .Nm
 315 command:
 316 .Bd -literal -offset indent
 317 mount -t unionfs -o -b /sys $HOME/sys
 318 .Ed
 319 .Pp
 320 causes
 321 .Nm
 322 to execute the equivalent of:
 323 .Bd -literal -offset indent
 324 /sbin/mount_unionfs -b /sys $HOME/sys
 325 .Ed
 326 .Pp
 327 Additional options specific to file system types
 328 which are not internally known
 329 (see the description of the
 330 .Fl t
 331 option below)
 332 may be described in the manual pages for the associated
 333 .Pa /sbin/mount_ Ns Sy XXX
 334 utilities.
 335 .It Fl p
 336 Print mount information in
 337 .Xr fstab 5
 338 format.
 339 Implies also the
 340 .Fl v
 341 option.
 342 .It Fl r
 343 The file system is to be mounted read-only.
 344 Mount the file system read-only (even the super-user may not write it).
 345 The same as the
 346 .Cm ro
 347 argument to the
 348 .Fl o
 349 option.
 350 .It Fl t Ar ufs | external_type
 351 The argument following the
 352 .Fl t
 353 is used to indicate the file system type.
 354 The type
 355 .Ar ufs
 356 is the default.
 357 The
 358 .Fl t
 359 option can be used
 360 to indicate that the actions should only be taken on
 361 file systems of the specified type.
 362 More than one type may be specified in a comma separated list.
 363 The list of file system types can be prefixed with
 364 .Dq no
 365 to specify the file system types for which action should
 366 .Em not
 367 be taken.
 368 For example, the
 369 .Nm
 370 command:
 371 .Bd -literal -offset indent
 372 mount -a -t nonfs,nullfs
 373 .Ed
 374 .Pp
 375 mounts all file systems except those of type
 376 .Tn NFS
 377 and
 378 .Tn NULLFS .
 379 .Pp
 380 The default behavior of
 381 .Nm
 382 is to pass the
 383 .Fl t
 384 option directly to the
 385 .Xr nmount 2
 386 system call in the
 387 .Li fstype
 388 option.
 389 .Pp
 390 However, for the following file system types:
 391 .Ar cd9660 ,
 392 .Ar mfs ,
 393 .Ar msdosfs ,
 394 .Ar nfs ,
 395 .Ar nfs4 ,
 396 .Ar ntfs ,
 397 .Ar nwfs ,
 398 .Ar nullfs ,
 399 .Ar portalfs ,
 400 .Ar smbfs ,
 401 .Ar udf ,
 402 .Ar umapfs ,
 403 and
 404 .Ar unionfs ,
 405 .Nm
 406 will not call
 407 .Xr nmount 2
 408 directly and will instead attempt to execute a program in
 409 .Pa /sbin/mount_ Ns Sy XXX
 410 where
 411 .Sy XXX
 412 is replaced by the file system type name.
 413 For example, nfs file systems are mounted by the program
 414 .Pa /sbin/mount_nfs .
 415 .Pp
 416 Most file systems will be dynamically loaded by the kernel
 417 if not already present, and if the kernel module is available.
 418 .It Fl u
 419 The
 420 .Fl u
 421 flag indicates that the status of an already mounted file
 422 system should be changed.
 423 Any of the options discussed above (the
 424 .Fl o
 425 option)
 426 may be changed;
 427 also a file system can be changed from read-only to read-write
 428 or vice versa.
 429 An attempt to change from read-write to read-only will fail if any
 430 files on the file system are currently open for writing unless the
 431 .Fl f
 432 flag is also specified.
 433 The set of options is determined by applying the options specified
 434 in the argument to
 435 .Fl o
 436 and finally applying the
 437 .Fl r
 438 or
 439 .Fl w
 440 option.
 441 .It Fl v
 442 Verbose mode.
 443 .It Fl w
 444 The file system object is to be read and write.
 445 .El
 446 .Sh ENVIRONMENT
 447 .Bl -tag -width ".Ev PATH_FSTAB"
 448 .It Ev PATH_FSTAB
 449 If the environment variable
 450 .Ev PATH_FSTAB
 451 is set, all operations are performed against the specified file.
 452 .Ev PATH_FSTAB
 453 will not be honored if the process environment or memory address space is
 454 considered
 455 .Dq tainted .
 456 (See
 457 .Xr issetugid 2
 458 for more information.)
 459 .El
 460 .Sh FILES
 461 .Bl -tag -width /etc/fstab -compact
 462 .It Pa /etc/fstab
 463 file system table
 464 .El
 465 .Sh DIAGNOSTICS
 466 Various, most of them are self-explanatory.
 467 .Pp
 468 .Dl XXXXX file system is not available
 469 .Pp
 470 The kernel does not support the respective file system type.
 471 Note that
 472 support for a particular file system might be provided either on a static
 473 (kernel compile-time), or dynamic basis (loaded as a kernel module by
 474 .Xr kldload 8 ) .
 475 .Sh SEE ALSO
 476 .Xr getfacl 1 ,
 477 .Xr setfacl 1 ,
 478 .Xr nmount 2 ,
 479 .Xr acl 3 ,
 480 .Xr mac 4 ,
 481 .Xr fstab 5 ,
 482 .Xr kldload 8 ,
 483 .Xr ext2fs 5 ,
 484 .Xr procfs 5 ,
 485 .Xr mount_cd9660 8 ,
 486 .Xr mount_msdosfs 8 ,
 487 .Xr mount_nfs 8 ,
 488 .Xr mount_ntfs 8 ,
 489 .Xr mount_nullfs 8 ,
 490 .Xr mount_nwfs 8 ,
 491 .Xr mount_portalfs 8 ,
 492 .Xr mount_smbfs 8 ,
 493 .Xr mount_std 8 ,
 494 .Xr mount_udf 8 ,
 495 .Xr mount_umapfs 8 ,
 496 .Xr mount_unionfs 8 ,
 497 .Xr umount 8
 498 .Sh CAVEATS
 499 After a successful
 500 .Nm ,
 501 the permissions on the original mount point determine if
 502 .Pa ..\&
 503 is accessible from the mounted file system.
 504 The minimum permissions for
 505 the mount point for traversal across the mount point in both
 506 directions to be possible for all users is 0111 (execute for all).
 507 .Sh HISTORY
 508 A
 509 .Nm
 510 utility appeared in
 511 .At v1 .
 512 .Sh BUGS
 513 It is possible for a corrupted file system to cause a crash.