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