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