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