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