xref: /freebsd/usr.sbin/rpc.umntall/rpc.umntall.8 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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 file systems
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
42The
43.Nm
44utility is proposed in the
45.Tn NFS
46RPC specification; see
47.Rs
48.%T "NFS Version 3 Protocol Specification"
49.%O "RFC 1813, Appendix I"
50.Re
51It uses remote procedure calls to remove mount entries from
52.Pa /var/db/mountdtab
53on the remote NFS server.
54It is called automatically
55without any parameters during startup and shutdown of
56the system.
57This ensures that
58.Xr showmount 8
59does not display old and expired entries.
60The
61.Nm
62utility
63is only needed on client side, where
64.Xr mount_nfs 8
65adds a mount entry with the current date to
66.Pa /var/db/mounttab ,
67and
68.Xr umount 8
69removes the entry again.
70The
71.Nm
72utility
73cares about all remaining entries in this table which result from crashes
74or unproper shutdowns.
75.Pp
76The options are as follows:
77.Bl -tag -width indentxxx
78.It Fl e Ar expire
79All entries which are not actually mounted or older than
80.Ar expire
81(seconds) are removed from
82.Pa /var/db/mounttab .
83This may be the case
84for DNS changes or long out of service periods.
85Default expire time
86is 86400 seconds (one day).
87.It Fl h Ar host
88Only remove the specific hostname.
89Send a UMNTALL RPC to the NFS server.
90.It Fl k
91Keep entries for existing NFS file systems.
92Compare the NFS file systems from
93the mounttab against the kernel mountlist and do not send the RPC to
94existing mount entries.
95Useful during startup of the system.
96It may be
97possible that there are already mounted NFS file systems, so calling
98RPC UMOUNT isn't a good idea.
99This is the case if the user has rebooted
100to 'single user mode' and starts up the system again.
101.It Fl p Ar path
102Only remove the specific mount-path.
103Send a UMOUNT RPC to the NFS server.
104This option implies the
105.Fl host
106option.
107.It Fl v
108Verbose, additional information is printed for each processed mounttab
109entry.
110.El
111.Sh FILES
112.Bl -tag -width /var/db/mounttab -compact
113.It Pa /var/db/mounttab
114mounted nfs-file systems
115.El
116.Sh HISTORY
117The
118.Nm
119utility first appeared in
120.Fx 4.0 .
121.Sh SEE ALSO
122.Xr mountd 8 ,
123.Xr mount_nfs 8 ,
124.Xr umount 8
125.Sh AUTHORS
126.An Martin Blapp Aq mb@imp.ch
127