usr.sbin/yppush/yppush.8

   1 .\" Copyright (c) 1991, 1993, 1995
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd February 5, 1995
  29 .Dt YPPUSH 8
  30 .Os
  31 .Sh NAME
  32 .Nm yppush
  33 .Nd "force propagation of updated NIS databases"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl d Ar domain
  37 .Op Fl t Ar timeout
  38 .Op Fl j Ar #parallel jobs
  39 .Op Fl h Ar host
  40 .Op Fl p Ar path
  41 .Op Fl v
  42 .Ar mapname
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility distributes updated NIS databases (or
  47 .Pa maps )
  48 from an NIS master server to NIS slave servers within an NIS
  49 domain.
  50 It is normally only run on the NIS master by
  51 .Pa /var/yp/Makefile
  52 whenever any of the NIS maps are updated.
  53 Note that
  54 .Pa /var/yp/Makefile
  55 does not invoke
  56 .Nm
  57 by default: the
  58 .Dq Li NOPUSH=True
  59 entry in the Makefile must first be commented out
  60 (the default
  61 .Fx
  62 configuration assumes a small network with only
  63 a single NIS server; in such a configuration,
  64 .Nm
  65 is not needed).
  66 .Pp
  67 By default,
  68 .Nm
  69 determines the names of the slave servers for a domain by searching the
  70 .Pa ypservers
  71 map.
  72 A destination host (or a list of hosts) can also be manually
  73 specified on the command line.
  74 Once it has a complete list of slave servers, it sends a 'map transfer'
  75 request to each slave, which in turn reads a copy of the map from
  76 the master NIS server using
  77 .Xr ypxfr 8 .
  78 Included within each request is the name of the map to be copied
  79 and some special information required by
  80 .Xr ypxfr 8
  81 to successfully 'callback' to
  82 .Nm
  83 and carry out the transfer.
  84 Any error messages
  85 .Nm
  86 receives from
  87 .Xr ypxfr 8
  88 via callback will be printed to stderr.
  89 .Pp
  90 The following options are available:
  91 .Bl -tag -width indent
  92 .It Fl d Ar domain
  93 Specify a particular domain.
  94 The NIS domain of
  95 the local host system is used by default.
  96 If the local host's domain
  97 name is not set, the domain name must be specified with this flag.
  98 .It Fl t Ar timeout
  99 Specify a timeout value in seconds.
 100 This timeout
 101 controls how long
 102 .Nm
 103 will wait for a response from a slave server before sending a
 104 map transfer request to the next slave server in its list.
 105 .It Fl j Ar #parallel jobs
 106 The
 107 .Nm
 108 utility normally performs transfers serially, meaning that it will
 109 send a map transfer request to one slave server and then wait for
 110 it to respond before moving on to the next slave server.
 111 In environments
 112 with many slaves, it is more efficient to initiate several map transfers
 113 at once so that the transfers can take place in parallel.
 114 The
 115 .Fl j
 116 flag is used to specify the desired number of parallel jobs:
 117 .Nm
 118 will initiate the specified number of transfers immediately and
 119 listen for responses.
 120 If the number of specified parallel jobs is
 121 less than the number of slave servers,
 122 .Nm
 123 will initiate only the number of specified jobs and then wait
 124 for some of them to finish before starting any more.
 125 .Pp
 126 Note that
 127 .Nm
 128 handles callbacks asynchronously, which means that it will collect
 129 and display the callback information received from
 130 .Xr ypxfr 8
 131 as soon as it arrives, even it arrives before all of the map
 132 transfer requests have been sent.
 133 .It Fl h Ar host
 134 Can be used to transfer a map to a user-specified machine or
 135 group of machines instead of the list of servers contained in
 136 the
 137 .Pa ypservers
 138 map.
 139 A list of hosts can be specified by using multiple
 140 instances of the
 141 .Fl h
 142 flag.
 143 .It Fl p Ar path
 144 By default,
 145 .Nm
 146 expects all the local NIS maps to be stored under
 147 .Pa /var/yp .
 148 The
 149 .Fl p
 150 flag can be used to specify an alternate path in the event that
 151 the system administrator decides to store the NIS maps somewhere else.
 152 .It Fl v
 153 Verbose mode: it causes
 154 .Nm
 155 to print debugging messages as it runs.
 156 Specifying this flag twice
 157 makes
 158 .Nm
 159 even more verbose.
 160 .El
 161 .Sh FILES
 162 .Bl -tag -width Pa -compact
 163 .It Pa /var/yp/[domainname]/ypservers
 164 the NIS ypservers map containing the names of all servers in
 165 a particular NIS domain
 166 .El
 167 .Sh SEE ALSO
 168 .Xr yp 8 ,
 169 .Xr ypserv 8 ,
 170 .Xr ypxfr 8
 171 .Sh AUTHORS
 172 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu
 173 .Sh BUGS
 174 The mechanism for transferring NIS maps in NIS v1 is different
 175 than that in NIS version 2.
 176 This version of
 177 .Nm
 178 has support for transferring maps to NIS v2 systems only.