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