Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / 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: src/sbin/umount/umount.8,v 1.7.2.3 2001/12/14 15:17:57 ru Exp $
30 .\" $DragonFly: src/sbin/umount/umount.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
31 .\"
32 .Dd May 8, 1995
33 .Dt UMOUNT 8
34 .Os
35 .Sh NAME
36 .Nm umount
37 .Nd unmount filesystems
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl fv
41 .Ar special \&| node
42 .Nm
43 .Fl a | A
44 .Op Fl F Ar fstab
45 .Op Fl fv
46 .Op Fl h Ar host
47 .Op Fl t Ar type
48 .Sh DESCRIPTION
49 The
50 .Nm
51 command
52 calls the
53 .Xr unmount 2
54 system call to remove a
55 .Ar "special device"
56 or the remote node (rhost:path) from the filesystem tree at the point
57 .Ar node .
58 If either
59 .Ar special
60 or
61 .Ar node
62 are not provided, the appropriate information is taken from the
63 .Xr fstab 5
64 file.
65 .Pp
66 The options are as follows:
67 .Bl -tag -width indent
68 .It Fl a
69 All the filesystems described in
70 .Xr fstab 5
71 are unmounted.
72 .It Fl A
73 All the currently mounted filesystems except
74 the root are unmounted.
75 .It Fl F Ar fstab
76 Specify the
77 .Pa fstab
78 file to use.
79 .It Fl f
80 The filesystem is forcibly unmounted.
81 Active special devices continue to work,
82 but all other files return errors if further accesses are attempted.
83 The root filesystem cannot be forcibly unmounted.
84 .It Fl h Ar host
85 Only filesystems mounted from the specified host will be
86 unmounted.
87 This option implies the
88 .Fl A
89 option and, unless otherwise specified with the
90 .Fl t
91 option, will only unmount
92 .Tn NFS
93 filesystems.
94 .It Fl t Ar type
95 Is used to indicate the actions should only be taken on
96 filesystems of the specified type.
97 More than one type may be specified in a comma separated list.
98 The list of filesystem types can be prefixed with
99 .Dq no
100 to specify the filesystem types for which action should
101 .Em not
102 be taken.
103 For example, the
104 .Nm
105 command:
106 .Bd -literal -offset indent
107 umount -a -t nfs,mfs
108 .Ed
109 .Pp
110 unmounts all filesystems of the type
111 .Tn NFS
112 and
113 .Tn MFS
114 that are listed in the
115 .Xr fstab 5
116 file.
117 .It Fl v
118 Verbose, additional information is printed out as each filesystem
119 is unmounted.
120 .El
121 .Sh ENVIRONMENT
122 .Bl -tag -width PATH_FSTAB
123 .It Pa PATH_FSTAB
124 If the environment variable
125 .Pa PATH_FSTAB
126 is set all operations are performed against the specified file.
127 .El
128 .Sh FILES
129 .Bl -tag -width /etc/fstab -compact
130 .It Pa /etc/fstab
131 filesystem table
132 .El
133 .Sh SEE ALSO
134 .Xr unmount 2 ,
135 .Xr fstab 5 ,
136 .Xr mount 8
137 .Sh HISTORY
138 A
139 .Nm
140 command appeared in
141 .At v6 .