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 July 12, 2012
  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 adflpruvw
  40 .Op Fl F Ar fstab
  41 .Op Fl o Ar options
  42 .Op Fl t Cm ufs | Ar 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 Cm ufs | Ar 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
  58 device 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 Li noauto ,
  81 those marked as
  82 .Dq Li late
  83 (unless the
  84 .Fl l
  85 option was specified),
  86 those excluded by the
  87 .Fl t
  88 flag (see below), or if they are already mounted (except the
  89 root file system which is always remounted to preserve
  90 traditional single user mode behavior).
  91 .It Fl d
  92 Causes everything to be done except for the actual system call.
  93 This option is useful in conjunction with the
  94 .Fl v
  95 flag to
  96 determine what the
  97 .Nm
  98 command is trying to do.
  99 .It Fl F Ar fstab
 100 Specify the
 101 .Pa fstab
 102 file to use.
 103 .It Fl f
 104 Forces the revocation of write access when trying to downgrade
 105 a file system mount status from read-write to read-only.
 106 Also
 107 forces the R/W mount of an unclean file system (dangerous; use with
 108 caution).
 109 .It Fl l
 110 When used in conjunction with the
 111 .Fl a
 112 option, also mount those file systems which are marked as
 113 .Dq Li late .
 114 .It Fl o
 115 Options are specified with a
 116 .Fl o
 117 flag followed by a comma separated string of options.
 118 In case of conflicting options being specified, the rightmost option
 119 takes effect.
 120 The following options are available:
 121 .Bl -tag -width indent
 122 .It Cm acls
 123 Enable POSIX.1e Access Control Lists, or ACLs, which can be customized via the
 124 .Xr setfacl 1
 125 and
 126 .Xr getfacl 1
 127 commands.
 128 This flag is mutually exclusive with
 129 .Cm nfsv4acls
 130 flag.
 131 .It Cm async
 132 All
 133 .Tn I/O
 134 to the file system should be done asynchronously.
 135 This is a
 136 .Em dangerous
 137 flag to set, since it does not guarantee that the file system structure
 138 on the disk will remain consistent.
 139 For this reason, the
 140 .Cm async
 141 flag should be used sparingly, and only when some data recovery
 142 mechanism is present.
 143 .It Cm current
 144 When used with the
 145 .Fl u
 146 flag, this is the same as specifying the options currently in effect for
 147 the mounted file system.
 148 .It Cm failok
 149 If this option is specified,
 150 .Nm
 151 will return 0 even if an error occurs
 152 during the mount of the filesystem.
 153 .It Cm force
 154 The same as
 155 .Fl f ;
 156 forces the revocation of write access when trying to downgrade
 157 a file system mount status from read-write to read-only.
 158 Also
 159 forces the R/W mount of an unclean file system (dangerous; use with caution).
 160 .It Cm fstab
 161 When used with the
 162 .Fl u
 163 flag, this is the same as specifying all the options listed in the
 164 .Xr fstab 5
 165 file for the file system.
 166 .It Cm late
 167 This file system should be skipped when
 168 .Nm
 169 is run with the
 170 .Fl a
 171 flag but without the
 172 .Fl l
 173 flag.
 174 .It Cm mountprog Ns = Ns Aq Ar program
 175 Force
 176 .Nm
 177 to use the specified program to mount the file system, instead of calling
 178 .Xr nmount 2
 179 directly.
 180 For example:
 181 .Bd -literal
 182 mount -t foofs -o mountprog=/mydir/fooprog /dev/acd0 /mnt
 183 .Ed
 184 .It Cm multilabel
 185 Enable multi-label Mandatory Access Control, or MAC, on the specified file
 186 system.
 187 If the file system supports multilabel operation, individual labels will
 188 be maintained for each object in the file system, rather than using a
 189 single label for all objects.
 190 An alternative to the
 191 .Fl l
 192 flag in
 193 .Xr tunefs 8 .
 194 See
 195 .Xr mac 4
 196 for more information, which cause the multilabel mount flag to be set
 197 automatically at mount-time.
 198 .It Cm nfsv4acls
 199 Enable NFSv4 ACLs, which can be customized via the
 200 .Xr setfacl 1
 201 and
 202 .Xr getfacl 1
 203 commands.
 204 This flag is mutually exclusive with
 205 .Cm acls
 206 flag.
 207 .It Cm noasync
 208 Metadata I/O should be done synchronously, while data I/O should be done
 209 asynchronously.
 210 This is the default.
 211 .It Cm noatime
 212 Do not update the file access time when reading from a file.
 213 This option
 214 is useful on file systems where there are large numbers of files and
 215 performance is more critical than updating the file access time (which is
 216 rarely ever important).
 217 This option is currently only supported on local file systems.
 218 .It Cm noauto
 219 This file system should be skipped when
 220 .Nm
 221 is run with the
 222 .Fl a
 223 flag.
 224 .It Cm noclusterr
 225 Disable read clustering.
 226 .It Cm noclusterw
 227 Disable write clustering.
 228 .It Cm noexec
 229 Do not allow execution of any binaries on the mounted file system.
 230 This option is useful for a server that has file systems containing
 231 binaries for architectures other than its own.
 232 Note: This option was not designed as a security feature and no
 233 guarantee is made that it will prevent malicious code execution; for
 234 example, it is still possible to execute scripts which reside on a
 235 .Cm noexec
 236 mounted partition.
 237 .It Cm nosuid
 238 Do not allow set-user-identifier or set-group-identifier bits to take effect.
 239 Note: this option is worthless if a public available suid or sgid
 240 wrapper like
 241 .Xr suidperl 1
 242 is installed on your system.
 243 It is set automatically when the user does not have super-user privileges.
 244 .It Cm nosymfollow
 245 Do not follow symlinks
 246 on the mounted file system.
 247 .It Cm ro
 248 The same as
 249 .Fl r ;
 250 mount the file system read-only (even the super-user may not write it).
 251 .It Cm snapshot
 252 This option allows a snapshot of the specified file system to be taken.
 253 The
 254 .Fl u
 255 flag is required with this option.
 256 Note that snapshot files must be created in the file system that is being
 257 snapshotted.
 258 You may create up to 20 snapshots per file system.
 259 Active snapshots are recorded in the superblock, so they persist across unmount
 260 and remount operations and across system reboots.
 261 When you are done with a snapshot, it can be removed with the
 262 .Xr rm 1
 263 command.
 264 Snapshots may be removed in any order, however you may not get back all the
 265 space contained in the snapshot as another snapshot may claim some of the blocks
 266 that it is releasing.
 267 Note that the schg flag is set on snapshots to ensure that not even the root
 268 user can write to them.
 269 The unlink command makes an exception for snapshot files in that it allows them
 270 to be removed even though they have the schg flag set, so it is not necessary to
 271 clear the schg flag before removing a snapshot file.
 272 .Pp
 273 Once you have taken a snapshot, there are three interesting things that you can
 274 do with it:
 275 .Pp
 276 .Bl -enum -compact
 277 .It
 278 Run
 279 .Xr fsck 8
 280 on the snapshot file.
 281 Assuming that the file system was clean when it was mounted, you should always
 282 get a clean (and unchanging) result from running fsck on the snapshot.
 283 This is essentially what the background fsck process does.
 284 .Pp
 285 .It
 286 Run
 287 .Xr dump 8
 288 on the snapshot.
 289 You will get a dump that is consistent with the file system as of the timestamp
 290 of the snapshot.
 291 .Pp
 292 .It
 293 Mount the snapshot as a frozen image of the file system.
 294 To mount the snapshot
 295 .Pa /var/snapshot/snap1 :
 296 .Bd -literal
 297 mdconfig -a -t vnode -f /var/snapshot/snap1 -u 4
 298 mount -r /dev/md4 /mnt
 299 .Ed
 300 .Pp
 301 You can now cruise around your frozen
 302 .Pa /var
 303 file system at
 304 .Pa /mnt .
 305 Everything will be in the same state that it was at the time the snapshot was
 306 taken.
 307 The one exception is that any earlier snapshots will appear as zero length
 308 files.
 309 When you are done with the mounted snapshot:
 310 .Bd -literal
 311 umount /mnt
 312 mdconfig -d -u 4
 313 .Ed
 314 .El
 315 .It Cm suiddir
 316 A directory on the mounted file system will respond to the SUID bit
 317 being set, by setting the owner of any new files to be the same
 318 as the owner of the directory.
 319 New directories will inherit the bit from their parents.
 320 Execute bits are removed from
 321 the file, and it will not be given to root.
 322 .Pp
 323 This feature is designed for use on fileservers serving PC users via
 324 ftp, SAMBA, or netatalk.
 325 It provides security holes for shell users and as
 326 such should not be used on shell machines, especially on home directories.
 327 This option requires the SUIDDIR
 328 option in the kernel to work.
 329 Only UFS file systems support this option.
 330 See
 331 .Xr chmod 2
 332 for more information.
 333 .It Cm sync
 334 All
 335 .Tn I/O
 336 to the file system should be done synchronously.
 337 .It Cm update
 338 The same as
 339 .Fl u ;
 340 indicate that the status of an already mounted file system should be changed.
 341 .It Cm union
 342 Causes the namespace at the mount point to appear as the union
 343 of the mounted file system root and the existing directory.
 344 Lookups will be done in the mounted file system first.
 345 If those operations fail due to a non-existent file the underlying
 346 directory is then accessed.
 347 All creates are done in the mounted file system.
 348 .El
 349 .Pp
 350 Any additional options specific to a file system type that is not
 351 one of the internally known types (see the
 352 .Fl t
 353 option) may be passed as a comma separated list; these options are
 354 distinguished by a leading
 355 .Dq \&-
 356 (dash).
 357 For example, the
 358 .Nm
 359 command:
 360 .Bd -literal -offset indent
 361 mount -t cd9660 -o -e /dev/cd0 /cdrom
 362 .Ed
 363 .Pp
 364 causes
 365 .Nm
 366 to execute the equivalent of:
 367 .Bd -literal -offset indent
 368 /sbin/mount_cd9660 -e /dev/cd0 /cdrom
 369 .Ed
 370 .Pp
 371 Options that take a value are specified using the -option=value syntax:
 372 .Bd -literal -offset indent
 373 mount -t msdosfs -o -u=fred,-g=wheel /dev/da0s1 /mnt
 374 .Ed
 375 .Pp
 376 is equivalent to
 377 .Bd -literal -offset indent
 378 /sbin/mount_msdosfs -u fred -g wheel /dev/da0s1 /mnt
 379 .Ed
 380 .Pp
 381 Additional options specific to file system types
 382 which are not internally known
 383 (see the description of the
 384 .Fl t
 385 option below)
 386 may be described in the manual pages for the associated
 387 .Pa /sbin/mount_ Ns Sy XXX
 388 utilities.
 389 .It Fl p
 390 Print mount information in
 391 .Xr fstab 5
 392 format.
 393 Implies also the
 394 .Fl v
 395 option.
 396 .It Fl r
 397 The file system is to be mounted read-only.
 398 Mount the file system read-only (even the super-user may not write it).
 399 The same as the
 400 .Cm ro
 401 argument to the
 402 .Fl o
 403 option.
 404 .It Fl t Cm ufs | Ar external_type
 405 The argument following the
 406 .Fl t
 407 is used to indicate the file system type.
 408 The type
 409 .Cm ufs
 410 is the default.
 411 The
 412 .Fl t
 413 option can be used
 414 to indicate that the actions should only be taken on
 415 file systems of the specified type.
 416 More than one type may be specified in a comma separated list.
 417 The list of file system types can be prefixed with
 418 .Dq Li no
 419 to specify the file system types for which action should
 420 .Em not
 421 be taken.
 422 For example, the
 423 .Nm
 424 command:
 425 .Bd -literal -offset indent
 426 mount -a -t nonfs,nullfs
 427 .Ed
 428 .Pp
 429 mounts all file systems except those of type
 430 .Tn NFS
 431 and
 432 .Tn NULLFS .
 433 .Pp
 434 The default behavior of
 435 .Nm
 436 is to pass the
 437 .Fl t
 438 option directly to the
 439 .Xr nmount 2
 440 system call in the
 441 .Li fstype
 442 option.
 443 .Pp
 444 However, for the following file system types:
 445 .Cm cd9660 ,
 446 .Cm mfs ,
 447 .Cm msdosfs ,
 448 .Cm newnfs ,
 449 .Cm nfs ,
 450 .Cm ntfs ,
 451 .Cm nwfs ,
 452 .Cm nullfs ,
 453 .Cm portalfs ,
 454 .Cm smbfs ,
 455 .Cm udf ,
 456 and
 457 .Cm unionfs .
 458 .Nm
 459 will not call
 460 .Xr nmount 2
 461 directly and will instead attempt to execute a program in
 462 .Pa /sbin/mount_ Ns Sy XXX
 463 where
 464 .Sy XXX
 465 is replaced by the file system type name.
 466 For example, nfs file systems are mounted by the program
 467 .Pa /sbin/mount_nfs .
 468 .Pp
 469 Most file systems will be dynamically loaded by the kernel
 470 if not already present, and if the kernel module is available.
 471 .It Fl u
 472 The
 473 .Fl u
 474 flag indicates that the status of an already mounted file
 475 system should be changed.
 476 Any of the options discussed above (the
 477 .Fl o
 478 option)
 479 may be changed;
 480 also a file system can be changed from read-only to read-write
 481 or vice versa.
 482 An attempt to change from read-write to read-only will fail if any
 483 files on the file system are currently open for writing unless the
 484 .Fl f
 485 flag is also specified.
 486 The set of options is determined by applying the options specified
 487 in the argument to
 488 .Fl o
 489 and finally applying the
 490 .Fl r
 491 or
 492 .Fl w
 493 option.
 494 .It Fl v
 495 Verbose mode.
 496 If the
 497 .Fl v
 498 is used alone, show all file systems, including those that were mounted with the
 499 .Dv MNT_IGNORE
 500 flag and show additional information about each file system (including fsid
 501 when run by root).
 502 .It Fl w
 503 The file system object is to be read and write.
 504 .El
 505 .Sh ENVIRONMENT
 506 .Bl -tag -width ".Ev PATH_FSTAB"
 507 .It Ev PATH_FSTAB
 508 If the environment variable
 509 .Ev PATH_FSTAB
 510 is set, all operations are performed against the specified file.
 511 .Ev PATH_FSTAB
 512 will not be honored if the process environment or memory address space is
 513 considered
 514 .Dq tainted .
 515 (See
 516 .Xr issetugid 2
 517 for more information.)
 518 .El
 519 .Sh FILES
 520 .Bl -tag -width /etc/fstab -compact
 521 .It Pa /etc/fstab
 522 file system table
 523 .El
 524 .Sh DIAGNOSTICS
 525 Various, most of them are self-explanatory.
 526 .Pp
 527 .Dl XXXXX file system is not available
 528 .Pp
 529 The kernel does not support the respective file system type.
 530 Note that
 531 support for a particular file system might be provided either on a static
 532 (kernel compile-time), or dynamic basis (loaded as a kernel module by
 533 .Xr kldload 8 ) .
 534 .Sh SEE ALSO
 535 .Xr getfacl 1 ,
 536 .Xr setfacl 1 ,
 537 .Xr nmount 2 ,
 538 .Xr acl 3 ,
 539 .Xr mac 4 ,
 540 .Xr devfs 5 ,
 541 .Xr ext2fs 5 ,
 542 .Xr fstab 5 ,
 543 .Xr procfs 5 ,
 544 .Xr kldload 8 ,
 545 .Xr mount_cd9660 8 ,
 546 .Xr mount_msdosfs 8 ,
 547 .Xr mount_nfs 8 ,
 548 .Xr mount_ntfs 8 ,
 549 .Xr mount_nullfs 8 ,
 550 .Xr mount_nwfs 8 ,
 551 .Xr mount_portalfs 8 ,
 552 .Xr mount_smbfs 8 ,
 553 .Xr mount_udf 8 ,
 554 .Xr mount_unionfs 8 ,
 555 .Xr umount 8 ,
 556 .Xr zfs 8 ,
 557 .Xr zpool 8
 558 .Sh CAVEATS
 559 After a successful
 560 .Nm ,
 561 the permissions on the original mount point determine if
 562 .Pa ..\&
 563 is accessible from the mounted file system.
 564 The minimum permissions for
 565 the mount point for traversal across the mount point in both
 566 directions to be possible for all users is 0111 (execute for all).
 567 .Pp
 568 Use of the
 569 .Nm
 570 is preferred over the use of the file system specific
 571 .Pa mount_ Ns Sy XXX
 572 commands.
 573 In particular,
 574 .Xr mountd 8
 575 gets a
 576 .Dv SIGHUP
 577 signal (that causes an update of the export list)
 578 only when the file system is mounted via
 579 .Nm .
 580 .Sh HISTORY
 581 A
 582 .Nm
 583 utility appeared in
 584 .At v1 .
 585 .Sh BUGS
 586 It is possible for a corrupted file system to cause a crash.