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