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