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