freebsd-dev/sbin/umount/umount.8

.\" Copyright (c) 1980, 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)umount.8	8.2 (Berkeley) 5/8/95
.\"	$Id$
.\"
.Dd May 8, 1995
.Dt UMOUNT 8
.Os BSD 4
.Sh NAME
.Nm umount
.Nd unmount filesystems
.Sh SYNOPSIS
.Nm
.Op Fl fv
.Ar special \&| node
.Nm umount
.Fl a | A
.Op Fl fv
.Op Fl h Ar host
.Op Fl t Ar type
.Sh DESCRIPTION
The
.Nm
command
calls the
.Xr unmount 2
system call to remove a
.Ar "special device"
or the remote node (rhost:path) from the filesystem tree at the point
.Ar node .
If either
.Ar special
or
.Ar node
are not provided, the appropriate information is taken from the
.Xr fstab 5
file.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl a
All the filesystems described in
.Xr fstab 5
are unmounted.
.It Fl A
All the currently mounted filesystems except
the root are unmounted.
.It Fl f
The filesystem is forcibly unmounted.
Active special devices continue to work,
but all other files return errors if further accesses are attempted.
The root filesystem cannot be forcibly unmounted.
.It Fl h Ar host
Only filesystems mounted from the specified host will be
unmounted.
This option implies the
.Fl A
option and, unless otherwise specified with the
.Fl t
option, will only unmount NFS filesystems.
.It Fl t Ar type
Is used to indicate the actions should only be taken on
filesystems of the specified type.
More than one type may be specified in a comma separated list.
The list of filesystem types can be prefixed with
.Dq no
to specify the filesystem types for which action should
.Em not
be taken.
For example, the
.Nm
command:
.Bd -literal -offset indent
umount -a -t nfs,mfs
.Ed
.Pp
umounts all filesystems of the type
.Tn NFS
and
.Tn MFS .
.It Fl v
Verbose, additional information is printed out as each filesystem
is unmounted.
.El
.Sh FILES
.Bl -tag -width /etc/fstab -compact
.It Pa /etc/fstab
filesystem table
.El
.Sh SEE ALSO
.Xr unmount 2 ,
.Xr fstab 5 ,
.Xr mount 8
.Sh BUGS
When using union filesystems,
.Xr umount 8
cannot always determine the node which is the mountpoint.
In this case,
it is necessary to specify the relevant directory to be unmounted
in the same form as that displayed by
.Xr mount 8 .
For example, given a mount entry like this:
.Bd -literal -offset indent
<above>/tmpdir on /cdrom (local, user mount)
.Ed
.Pp
then the command:
.Bd -literal -offset indent
umount '<above>/tmpdir'
.Ed
.Pp
would unmount 
.Ar /tmpdir 
from the mountpoint
.Ar /cdrom .
.Sh HISTORY
A
.Nm
command appeared in
.At v6 .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" Copyright (c) 1980, 1989, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.\" @(#)umount.8 8.2 (Berkeley) 5/8/95`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`.\" $Id$`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\"`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.Dd May 8, 1995`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Dt UMOUNT 8`
			`.Os BSD 4`
			`.Sh NAME`
			`.Nm umount`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.Nd unmount filesystems`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh SYNOPSIS`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Op Fl fv`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`.Ar special \&\| node`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Nm umount`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.Fl a \| A`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Op Fl fv`
			`.Op Fl h Ar host`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.Op Fl t Ar type`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh DESCRIPTION`
			`The`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`command`
			`calls the`
			`.Xr unmount 2`
			`system call to remove a`
			`.Ar "special device"`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`or the remote node (rhost:path) from the filesystem tree at the point`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Ar node .`
			`If either`
			`.Ar special`
			`or`
			`.Ar node`
			`are not provided, the appropriate information is taken from the`
			`.Xr fstab 5`
			`file.`
			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width indent`
			`.It Fl a`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`All the filesystems described in`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Xr fstab 5`
			`are unmounted.`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.It Fl A`
			`All the currently mounted filesystems except`
			`the root are unmounted.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl f`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`The filesystem is forcibly unmounted.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`Active special devices continue to work,`
			`but all other files return errors if further accesses are attempted.`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`The root filesystem cannot be forcibly unmounted.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl h Ar host`
			`Only filesystems mounted from the specified host will be`
			`unmounted.`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`This option implies the`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.Fl A`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`option and, unless otherwise specified with the`
			`.Fl t`
			`option, will only unmount NFS filesystems.`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`.It Fl t Ar type`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`Is used to indicate the actions should only be taken on`
			`filesystems of the specified type.`
			`More than one type may be specified in a comma separated list.`
			`The list of filesystem types can be prefixed with`
			`.Dq no`
			`to specify the filesystem types for which action should`
			`.Em not`
			`be taken.`
			`For example, the`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`command:`
			`.Bd -literal -offset indent`
			`umount -a -t nfs,mfs`
			`.Ed`
			`.Pp`
			`umounts all filesystems of the type`
			`.Tn NFS`
			`and`
			`.Tn MFS .`
			`.It Fl v`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`Verbose, additional information is printed out as each filesystem`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`is unmounted.`
			`.El`
			`.Sh FILES`
			`.Bl -tag -width /etc/fstab -compact`
			`.It Pa /etc/fstab`
Merge from Lite2. - use new getvfsbyname() interface. - new -A option, like -a except only mounted file systems are unmounted. All non-cosmetic FreeBSD changes in umount.c, except ignoring of realpath() failures, went away because they are done better in Lite2. realpath() failures must be ignored so that non-pathnames like "<above>:/foo" and "host:/bar" get as far as mount(2). Reviewed by: dfr 1997-06-16 11:20:05 +00:00			`filesystem table`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr unmount 2 ,`
			`.Xr fstab 5 ,`
			`.Xr mount 8`
From njw@cs.city.ac.uk (Nick Williams): /sbin/umount does not return the correct exit status due to incorrect logic in its internals. Further, because of the nature of the code, you cannot use it to umount a directory from a union mountpoint. Well, you can sometimes, it depends on if the directory is at the top of the union stack or not :) Submitted by: njw@cs.city.ac.uk (Nick Williams) 1994-11-04 17:51:37 +00:00			`.Sh BUGS`
			`When using union filesystems,`
			`.Xr umount 8`
			`cannot always determine the node which is the mountpoint.`
			`In this case,`
			`it is necessary to specify the relevant directory to be unmounted`
			`in the same form as that displayed by`
			`.Xr mount 8 .`
			`For example, given a mount entry like this:`
			`.Bd -literal -offset indent`
			`<above>/tmpdir on /cdrom (local, user mount)`
			`.Ed`
			`.Pp`
			`then the command:`
			`.Bd -literal -offset indent`
			`umount '<above>/tmpdir'`
			`.Ed`
			`.Pp`
			`would unmount`
			`.Ar /tmpdir`
			`from the mountpoint`
			`.Ar /cdrom .`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh HISTORY`
			`A`
Fix a typo and while here cleanup the use of the .Nm macro. PR: docs/4339 Submitted by: Matthew Hunt <mph@pobox.com> 1997-08-20 11:40:13 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`command appeared in`
			`.At v6 .`