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