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