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