usr.sbin/rpc.umntall/rpc.umntall.8

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