2 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 Bill Paul.
15 .\" 4. Neither the name of the University nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nd "transfer NIS database from remote server to local host"
40 .Nm /usr/libexec/ypxfr
43 .Op Fl d Ar target domain
44 .Op Fl h Ar source host
45 .Op Fl s Ar source domain
47 .Op Fl C Ar taskid program-number ipaddr port
58 server to another using
64 is generally invoked by
66 when it receives a map transfer request from
70 utility is used primarily in environments where several
72 servers are in use in a single domain.
76 the canonical copies of all
78 maps, and all the other servers,
81 slaves, copy new versions of the maps from the master whenever
82 any updates are made (i.e., when a user updates their password via
87 creates a temporary database file in
88 .Pa /var/yp/[domainname] ,
89 and fills it with the contents of
91 as supplied by the specified
93 When the entire map has been transferred,
95 deletes the original copy of
97 and moves the temporary copy into its place.
101 will attempt to send a 'clear current map' request to the local
103 process to clear any possible references it may still have to the
106 Note that all files created by
108 are owner readable and writable only for security reasons.
111 maps and the directory in which they reside are normally owned by
112 root, this prevents non-privileged users from making unauthorized
115 In order to maintain consistency across all
119 can be run periodically in a
122 Maps which change infrequently
123 need only be updated once a day (preferably late at night when system
124 usage is lowest), whereas those that are subject to frequent changes
129 should be updated perhaps once every hour.
135 maps is not strictly mandatory since all updates should
142 master server, however it is good practice
143 on large networks where possible outages could cause
145 servers to fall out of sync with each other.
149 is invoked without a controlling terminal, e.g.\& from inside
151 it logs all its output using the
159 has support for a special map transfer protocol which works in
164 This protocol allows it to transfer raw map database files from
167 master server and can be many times faster than the standard
168 transfer method, particularly for very large
173 utility will check to see if the
175 server is registered on the
177 master server and attempt to use
179 If it is not it will fall back to the standard
180 transfer method, copying the map contents from
182 and creating new maps instead.
186 ypxfrd protocol is conceptually similar
187 to the SunOS ypxfrd protocol,
190 protocol is not compatible with
191 Sun's, therefore it will not work with Sun's ypxfrd server.
193 slave systems can still transfer maps from any
197 however they will only be able to take advantage of the faster protocol
198 if the master server is also running
201 The following options and flags are supported by
203 .Bl -tag -width indent
205 Force a map transfer.
208 will not transfer a map if it determines that the
211 is not newer than the existing copy already on the local host: the
213 flag forces a transfer regardless of which server's version is more recent.
215 Do not send a 'clear current map' request to the
217 process running on the local host.
218 This flag is normally used when
221 manually on a machine that is not yet running
223 Without this flag, failure to contact the local
227 to abort the transfer.
228 .It Fl d Ar target domain
229 Specify a target domain other than the current
232 .It Fl h Ar source host
233 Specify the name of the host from which to copy the
237 is used to ensure that
239 only copies maps from the
242 .It Fl s Ar source domain
243 Specify the domain from which to transfer a map, in the event that
244 the transfer is being done across two different
248 Specify the top level directory containing the
252 default, this path is
256 flag allows you to specify an alternate path should you wish to
259 maps in a different part of the file system.
266 if it too has been told to use an alternate path.
267 .It Fl C Ar taskid program-number ipaddr port
268 These options are used only when
272 in response to a map transfer request initiated by
276 needs to 'callback' to the
278 process and interact with it, so
280 passes to it an IP address
284 registered program number
288 that it can use to contact the waiting
290 process on the master server.
292 The name of the map to transfer.
295 .Bl -tag -width Pa -compact
296 .It Pa /var/yp/[domainname]/[maps]
299 maps for a particular
308 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu