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