xref: /freebsd/usr.sbin/rpc.umntall/rpc.umntall.8 (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1.\"
2.\" Copyright (c) 1999 Martin Blapp
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd November 17, 1999
29.Dt RPC.UMNTALL 8
30.Os
31.Sh NAME
32.Nm rpc.umntall
33.Nd notify NFS servers about unmounted NFS filesystems
34.Sh SYNOPSIS
35.Nm
36.Op Fl e Ar expire
37.Op Fl h Ar host
38.Op Fl k
39.Op Fl p Ar remotepath
40.Op Fl v
41.Sh DESCRIPTION
42.Nm
43is as command as proposed in the
44.Tn NFS
45RPC specification; see
46.Rs
47.%T "NFS Version 3 Protocol Specification"
48.%O "RFC 1813, Appendix I"
49.Re
50It uses remote procedure calls to remove mount entries from
51.Pa /var/db/mountdtab
52on the remote NFS server.
53It is called automatically
54without any parameters during startup and shutdown of
55the system.
56This ensures that
57.Xr showmount 8
58does not display old and expired entries.
59The
60.Nm
61command
62is only needed on client side, where
63.Xr mount_nfs 8
64adds a mount entry with the current date to
65.Pa /var/db/mounttab ,
66and
67.Xr umount 8
68removes the entry again.
69The
70.Nm
71command
72cares about all remaining entries in this table which result from crashes
73or unproper shutdowns.
74.Pp
75The options are as follows:
76.Bl -tag -width indentxxx
77.It Fl e Ar expire
78All entries which are not actually mounted or older than
79.Ar expire
80(seconds) are removed from
81.Pa /var/db/mounttab .
82This may be the case
83for DNS changes or long out of service periods.
84Default expire time
85is 86400 seconds (one day).
86.It Fl h Ar host
87Only remove the specific hostname.
88Send a UMNTALL RPC to the NFS server.
89.It Fl k
90Keep entries for existing NFS filesystems.
91Compare the NFS filesystems from
92the mounttab against the kernel mountlist and do not send the RPC to
93existing mount entries.
94Useful during startup of the system.
95It may be
96possible that there are already mounted NFS filesystems, so calling
97RPC UMOUNT isn't a good idea.
98This is the case if the user has rebooted
99to 'single user mode' and starts up the system again.
100.It Fl p Ar path
101Only remove the specific mount-path.
102Send a UMOUNT RPC to the NFS server.
103This option implies the
104.Fl host
105option.
106.It Fl v
107Verbose, additional information is printed for each processed mounttab
108entry.
109.El
110.Sh FILES
111.Bl -tag -width /var/db/mounttab -compact
112.It Pa /var/db/mounttab
113mounted nfs-filesystems
114.El
115.Sh HISTORY
116The
117.Nm
118command first appeared in
119.Fx 4.0 .
120.Sh SEE ALSO
121.Xr mountd 8 ,
122.Xr mount_nfs 8 ,
123.Xr umount 8
124.Sh AUTHORS
125.An Martin Blapp Aq mb@imp.ch
126