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