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