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