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