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