sbin/umount/umount.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 .\" 3. 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 .\"     @(#)umount.8    8.2 (Berkeley) 5/8/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd April 14, 2020
  32 .Dt UMOUNT 8
  33 .Os
  34 .Sh NAME
  35 .Nm umount
  36 .Nd unmount file systems
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl fNnv
  40 .Ar special ... | node ... | fsid ...
  41 .Nm
  42 .Fl a | A
  43 .Op Fl F Ar fstab
  44 .Op Fl fnv
  45 .Op Fl h Ar host
  46 .Op Fl t Ar type
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility calls the
  51 .Xr unmount 2
  52 system call to remove a file system from the file system tree.
  53 The file system can be specified by its
  54 .Ar special
  55 device or remote node
  56 .Pq Ar rhost Ns Cm \& : Ns Ar path ,
  57 the path to the mount point
  58 .Ar node
  59 or by the file system ID
  60 .Ar fsid
  61 as reported by
  62 .Dq mount -v
  63 when run by root.
  64 .Pp
  65 The options are as follows:
  66 .Bl -tag -width "-F fstab"
  67 .It Fl a
  68 All the file systems described in
  69 .Xr fstab 5
  70 are unmounted.
  71 .It Fl A
  72 All the currently mounted file systems except
  73 the root are unmounted.
  74 .It Fl F Ar fstab
  75 Specify the
  76 .Pa fstab
  77 file to use.
  78 .It Fl f
  79 The file system is forcibly unmounted.
  80 Active special devices continue to work,
  81 but all other files return errors if further accesses are attempted.
  82 The root file system cannot be forcibly unmounted.
  83 For NFS, a forced dismount can take up to 1 minute or more to
  84 complete against an unresponsive server and may throw away
  85 data not yet written to the server for this case.
  86 If a process, such as
  87 .Nm
  88 without the
  89 .Fl f
  90 flag is hung on an
  91 .Tn NFS
  92 mount point, use the
  93 .Fl N
  94 flag instead.
  95 Also, doing a forced dismount of an NFSv3 mount when
  96 .Xr rpc.lockd 8
  97 is running is unsafe and can result in a crash.
  98 .It Fl h Ar host
  99 Only file systems mounted from the specified host will be
 100 unmounted.
 101 This option implies the
 102 .Fl A
 103 option and, unless otherwise specified with the
 104 .Fl t
 105 option, will only unmount
 106 .Tn NFS
 107 file systems.
 108 .It Fl N
 109 Do a forced dismount of an
 110 .Tn NFS
 111 mount point without checking the mount path.
 112 This option can only be used with the path to the mount point
 113 .Ar node
 114 and the path must be specified exactly as it was at mount time.
 115 This option is useful when a process is hung waiting for an unresponsive
 116 .Tn NFS
 117 server while holding a vnode lock on the mounted-on vnode, such that
 118 .Nm
 119 with the
 120 .Fl f
 121 flag can't complete.
 122 Using this option can result in a loss of file updates that have not been
 123 flushed to the
 124 .Tn NFS
 125 server.
 126 .It Fl n
 127 Unless the
 128 .Fl f
 129 is used, the
 130 .Nm
 131 will not unmount an active file system.
 132 It will, however, perform a flush.
 133 This flag disables this behaviour, preventing the flush
 134 if there are any files open.
 135 .It Fl t Ar type
 136 Is used to indicate the actions should only be taken on
 137 file systems of the specified type.
 138 More than one type may be specified in a comma separated list.
 139 The list of file system types can be prefixed with
 140 .Dq no
 141 to specify the file system types for which action should
 142 .Em not
 143 be taken.
 144 For example, the
 145 .Nm
 146 command:
 147 .Bd -literal -offset indent
 148 umount -a -t nfs,nullfs
 149 .Ed
 150 .Pp
 151 unmounts all file systems of the type
 152 .Tn NFS
 153 and
 154 .Tn NULLFS
 155 that are listed in the
 156 .Xr fstab 5
 157 file.
 158 .It Fl v
 159 Verbose, additional information is printed out as each file system
 160 is unmounted.
 161 .El
 162 .Sh ENVIRONMENT
 163 .Bl -tag -width ".Ev PATH_FSTAB"
 164 .It Ev PATH_FSTAB
 165 If the environment variable
 166 .Ev PATH_FSTAB
 167 is set, all operations are performed against the specified file.
 168 .Ev PATH_FSTAB
 169 will not be honored if the process environment or memory address space is
 170 considered
 171 .Dq tainted .
 172 (See
 173 .Xr issetugid 2
 174 for more information.)
 175 .El
 176 .Sh FILES
 177 .Bl -tag -width /etc/fstab -compact
 178 .It Pa /etc/fstab
 179 file system table
 180 .El
 181 .Sh SEE ALSO
 182 .Xr unmount 2 ,
 183 .Xr fstab 5 ,
 184 .Xr autounmountd 8 ,
 185 .Xr mount 8
 186 .Sh HISTORY
 187 A
 188 .Nm
 189 utility appeared in
 190 .At v1 .