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 .\" $FreeBSD: src/usr.sbin/yppush/yppush.8,v 1.18 2005/01/18 20:02:45 ru Exp $
  29 .\"
  30 .Dd February 5, 1995
  31 .Dt YPPUSH 8
  32 .Os
  33 .Sh NAME
  34 .Nm yppush
  35 .Nd "force propagation of updated NIS databases"
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl d Ar domain
  39 .Op Fl t Ar timeout
  40 .Op Fl j Ar #parallel jobs
  41 .Op Fl h Ar host
  42 .Op Fl p Ar path
  43 .Op Fl v
  44 .Ar mapname
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility distributes updated NIS databases (or
  49 .Pa maps )
  50 from an NIS master server to NIS slave servers within an NIS
  51 domain.
  52 It is normally only run on the NIS master by
  53 .Pa /var/yp/Makefile
  54 whenever any of the NIS maps are updated.
  55 Note that
  56 .Pa /var/yp/Makefile
  57 does not invoke
  58 .Nm
  59 by default: the
  60 .Dq Li NOPUSH=True
  61 entry in the Makefile must first be commented out
  62 (the default
  63 .Dx
  64 configuration assumes a small network with only
  65 a single NIS server; in such a configuration,
  66 .Nm
  67 is not needed).
  68 .Pp
  69 By default,
  70 .Nm
  71 determines the names of the slave servers for a domain by searching the
  72 .Pa ypservers
  73 map.
  74 A destination host (or a list of hosts) can also be manually
  75 specified on the command line.
  76 Once it has a complete list of slave servers, it sends a 'map transfer'
  77 request to each slave, which in turn reads a copy of the map from
  78 the master NIS server using
  79 .Xr ypxfr 8 .
  80 Included within each request is the name of the map to be copied
  81 and some special information required by
  82 .Xr ypxfr 8
  83 to successfully 'callback' to
  84 .Nm
  85 and carry out the transfer.
  86 Any error messages
  87 .Nm
  88 receives from
  89 .Xr ypxfr 8
  90 via callback will be printed to stderr.
  91 .Pp
  92 The following options are available:
  93 .Bl -tag -width indent
  94 .It Fl d Ar domain
  95 Specify a particular domain.
  96 The NIS domain of
  97 the local host system is used by default.
  98 If the local host's domain
  99 name is not set, the domain name must be specified with this flag.
 100 .It Fl t Ar timeout
 101 Specify a timeout value in seconds.
 102 This timeout
 103 controls how long
 104 .Nm
 105 will wait for a response from a slave server before sending a
 106 map transfer request to the next slave server in its list.
 107 .It Fl j Ar #parallel jobs
 108 The
 109 .Nm
 110 utility normally performs transfers serially, meaning that it will
 111 send a map transfer request to one slave server and then wait for
 112 it to respond before moving on to the next slave server.
 113 In environments
 114 with many slaves, it is more efficient to initiate several map transfers
 115 at once so that the transfers can take place in parallel.
 116 The
 117 .Fl j
 118 flag is used to specify the desired number of parallel jobs:
 119 .Nm
 120 will initiate the specified number of transfers immediately and
 121 listen for responses.
 122 If the number of specified parallel jobs is
 123 less than the number of slave servers,
 124 .Nm
 125 will initiate only the number of specified jobs and then wait
 126 for some of them to finish before starting any more.
 127 .Pp
 128 Note that
 129 .Nm
 130 handles callbacks asynchronously, which means that it will collect
 131 and display the callback information received from
 132 .Xr ypxfr 8
 133 as soon as it arrives, even it arrives before all of the map
 134 transfer requests have been sent.
 135 .It Fl h Ar host
 136 Can be used to transfer a map to a user-specified machine or
 137 group of machines instead of the list of servers contained in
 138 the
 139 .Pa ypservers
 140 map.
 141 A list of hosts can be specified by using multiple
 142 instances of the
 143 .Fl h
 144 flag.
 145 .It Fl p Ar path
 146 By default,
 147 .Nm
 148 expects all the local NIS maps to be stored under
 149 .Pa /var/yp .
 150 The
 151 .Fl p
 152 flag can be used to specify an alternate path in the event that
 153 the system administrator decides to store the NIS maps somewhere else.
 154 .It Fl v
 155 Verbose mode: it causes
 156 .Nm
 157 to print debugging messages as it runs.
 158 Specifying this flag twice
 159 makes
 160 .Nm
 161 even more verbose.
 162 .El
 163 .Sh FILES
 164 .Bl -tag -width Pa -compact
 165 .It Pa /var/yp/[domainname]/ypservers
 166 the NIS ypservers map containing the names of all servers in
 167 a particular NIS domain
 168 .El
 169 .Sh SEE ALSO
 170 .Xr yp 8 ,
 171 .Xr ypserv 8 ,
 172 .Xr ypxfr 8
 173 .Sh AUTHORS
 174 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu
 175 .Sh BUGS
 176 The mechanism for transferring NIS maps in NIS v1 is different
 177 than that in NIS version 2.
 178 This version of
 179 .Nm
 180 has support for transferring maps to NIS v2 systems only.