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