Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / amd / fixmount / fixmount.8
1 .\"
2 .\" Copyright (c) 1997-1999 Erez Zadok
3 .\" Copyright (c) 1990 Jan-Simon Pendry
4 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
5 .\" Copyright (c) 1990 The Regents of the University of California.
6 .\" All rights reserved.
7 .\"
8 .\" This code is derived from software contributed to Berkeley by
9 .\" Jan-Simon Pendry at Imperial College, London.
10 .\"
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
13 .\" are met:
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\"    notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\"    notice, this list of conditions and the following disclaimer in the
18 .\"    documentation and/or other materials provided with the distribution.
19 .\" 3. All advertising materials mentioning features or use of this software
20 .\"    must display the following acknowledgment:
21 .\"      This product includes software developed by the University of
22 .\"      California, Berkeley and its contributors.
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\"    may be used to endorse or promote products derived from this software
25 .\"    without specific prior written permission.
26 .\"
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .\" SUCH DAMAGE.
38 .\"
39 .\"     %W% (Berkeley) %G%
40 .\"
41 .\" $Id: fixmount.8,v 1.2 1999/01/10 21:54:26 ezk Exp $
42 .\" $FreeBSD: src/contrib/amd/fixmount/fixmount.8,v 1.5.2.2 2001/03/06 16:54:05 ru Exp $
43 .\"
44 .Dd February 26, 1993
45 .Dt FIXMOUNT 8
46 .Os
47 .Sh NAME
48 .Nm fixmount
49 .Nd fix remote mount entries
50 .Sh SYNOPSIS
51 .Nm
52 .Op Fl adervq
53 .Op Fl h Ar name
54 .Ar host
55 \&...
56 .Sh DESCRIPTION
57 .Nm
58 is a variant of 
59 .Xr showmount 8
60 that can delete bogus mount entries in remote
61 .Xr mountd 8
62 daemons.  The actions specified by the options are performed for each
63 .Ar host 
64 in turn.
65 .Sh OPTIONS
66 .Bl -tag -width Ds
67 .It Fl a Fl d Fl e
68 These options work as in
69 .Xr showmount 8
70 except that only entries pertaining to the local host are printed.
71 .It Fl r
72 Removes those remote mount entries on
73 .Ar host
74 that do not correspond to current mounts, i.e., which are left-over
75 from a crash or are the result of improper mount protocol.
76 The actuality of mounts is verified using the entries in
77 .Pa /etc/mtab .
78 .It Fl v
79 Verify remote mounts.  Similar to
80 .Fl r
81 except that only a notification message is printed for each bogus entry
82 found.  The remote mount table is not changed.
83 .It Fl A
84 Issues a command to the remote mountd declaring that
85 .Em all
86 of its filesystems have been unmounted.  This should be used with caution, as
87 it removes all remote mount entries pertaining to the local system, whether or
88 not any filesystems are still mounted locally.
89 .It Fl v
90 Be quiet.  Suppresses error messages due to timeouts and
91 .Dq Program not Registered ,
92 i.e., due to remote hosts not supporting RPC or not running
93 .Nm mountd .
94 .It Fl h Ar name
95 Pretend the local hostname is
96 .Ar name .
97 This is useful after the local hostname has been changed and rmtab entries
98 using the old name remain on a remote machine.
99 Unfortunately, most mountd's won't be able to successfully handle removal
100 of such entries, so this option is useful in combination with
101 .Fl v
102 only.
103 .Pp
104 This option also saves time as comparisons of remotely recorded and local
105 hostnames by address are avoided.
106 .El
107 .Sh FILES
108 .Bl -tag -width /axx
109 .It Pa /etc/mtab
110 List of current mounts.
111 .It Pa /etc/rmtab
112 Backup file for remote mount entries on
113 .Tn NFS
114 server.
115 .El
116 .Sh SEE ALSO
117 .Xr mtab 5 ,
118 .Xr rmtab 5 ,
119 .Xr mountd 8 ,
120 .Xr showmount 8
121 .Sh BUGS
122 No attempt is made to verify the information in
123 .Pa /etc/mtab
124 itself.
125 .Pp
126 Since swap file mounts are not recorded in
127 .Pa /etc/mtab ,
128 a heuristic specific to SunOS is used to determine whether such a mount
129 is actual (replacing the string 
130 .Ql swap 
131 with 
132 .Ql root
133 and verifying the resulting path).
134 .Pp
135 Symbolic links on the server will cause the path in the remote entry to differ
136 from the one in 
137 .Pa /etc/mtab .
138 To catch those cases, a filesystem is also deemed mounted if its
139 .Em local
140 mount point is identical to the remote entry.
141 I.e., on a SunOS diskless client,
142 .Pa server:/export/share/sunos.4.1.1
143 is actually
144 .Pa /usr/share .
145 Since the local mount point is
146 .Pa /usr/share
147 as well this will be handled correctly.
148 .Pp
149 There is no way to clear a stale entry in a remote 
150 .Nm mountd 
151 after the local hostname (or whatever reverse name resolution 
152 returns for it) has been changed.  To take care of these cases,
153 the remote
154 .Pa /etc/rmtab
155 file has to be edited and
156 .Nm mountd
157 restarted.
158 .Pp
159 The RPC timeouts for
160 .Nm mountd
161 calls can only be changed by recompiling. The defaults are 2 seconds 
162 for client handle creation and 5 seconds for RPC calls.
163 .Sh AUTHORS
164 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
165 Department of Computing, Imperial College, London, UK.
166 .Pp
167 .An Erez Zadok Aq ezk@cs.columbia.edu ,
168 Department of Computer Science, Columbia University, New York, USA.
169 .Pp
170 .An Other authors and contributors to 
171 .Nm am-utils
172 are listed in the
173 .Nm AUTHORS 
174 file distributed with
175 .Nm am-utils .
176 .Sh HISTORY
177 The
178 .Nm
179 utility appeared in
180 .Fx 3.0 .