mount, umount: Implement the '-F' option to specify an alternate fstab file.
[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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)umount.8    8.2 (Berkeley) 5/8/95
33 .\" $FreeBSD: src/sbin/umount/umount.8,v 1.7.2.3 2001/12/14 15:17:57 ru Exp $
34 .\" $DragonFly: src/sbin/umount/umount.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
35 .\"
36 .Dd May 8, 1995
37 .Dt UMOUNT 8
38 .Os
39 .Sh NAME
40 .Nm umount
41 .Nd unmount filesystems
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl fv
45 .Ar special \&| node
46 .Nm
47 .Fl a | A
48 .Op Fl F Ar fstab
49 .Op Fl fv
50 .Op Fl h Ar host
51 .Op Fl t Ar type
52 .Sh DESCRIPTION
53 The
54 .Nm
55 command
56 calls the
57 .Xr unmount 2
58 system call to remove a
59 .Ar "special device"
60 or the remote node (rhost:path) from the filesystem tree at the point
61 .Ar node .
62 If either
63 .Ar special
64 or
65 .Ar node
66 are not provided, the appropriate information is taken from the
67 .Xr fstab 5
68 file.
69 .Pp
70 The options are as follows:
71 .Bl -tag -width indent
72 .It Fl a
73 All the filesystems described in
74 .Xr fstab 5
75 are unmounted.
76 .It Fl A
77 All the currently mounted filesystems except
78 the root are unmounted.
79 .It Fl F Ar fstab
80 Specify the
81 .Pa fstab
82 file to use.
83 .It Fl f
84 The filesystem is forcibly unmounted.
85 Active special devices continue to work,
86 but all other files return errors if further accesses are attempted.
87 The root filesystem cannot be forcibly unmounted.
88 .It Fl h Ar host
89 Only filesystems mounted from the specified host will be
90 unmounted.
91 This option implies the
92 .Fl A
93 option and, unless otherwise specified with the
94 .Fl t
95 option, will only unmount
96 .Tn NFS
97 filesystems.
98 .It Fl t Ar type
99 Is used to indicate the actions should only be taken on
100 filesystems of the specified type.
101 More than one type may be specified in a comma separated list.
102 The list of filesystem types can be prefixed with
103 .Dq no
104 to specify the filesystem types for which action should
105 .Em not
106 be taken.
107 For example, the
108 .Nm
109 command:
110 .Bd -literal -offset indent
111 umount -a -t nfs,mfs
112 .Ed
113 .Pp
114 unmounts all filesystems of the type
115 .Tn NFS
116 and
117 .Tn MFS
118 that are listed in the
119 .Xr fstab 5
120 file.
121 .It Fl v
122 Verbose, additional information is printed out as each filesystem
123 is unmounted.
124 .El
125 .Sh ENVIRONMENT
126 .Bl -tag -width PATH_FSTAB
127 .It Pa PATH_FSTAB
128 If the environment variable
129 .Pa PATH_FSTAB
130 is set all operations are performed against the specified file.
131 .El
132 .Sh FILES
133 .Bl -tag -width /etc/fstab -compact
134 .It Pa /etc/fstab
135 filesystem table
136 .El
137 .Sh SEE ALSO
138 .Xr unmount 2 ,
139 .Xr fstab 5 ,
140 .Xr mount 8
141 .Sh HISTORY
142 A
143 .Nm
144 command appeared in
145 .At v6 .