1.\" Copyright (c) 1997
2.\" Bill Paul <wpaul@ctr.columbia.edu>. 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 Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\" may be used to endorse or promote products derived from this software
17.\" without specific prior written permission.
18.\"
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 THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD: head/usr.sbin/ypserv/ypinit.8 50479 1999-08-28 01:35:59Z peter $
32.\"
33.Dd November 10, 1997
34.Dt YPINIT 8
35.Os FreeBSD 3.0
36.Sh NAME
37.Nm ypinit
38.Nd build and install NIS databases
39.Sh SYNOPSIS
40.Nm ypinit
41.Fl m
42.Op Ar domainname
43.Nm ypinit
44.Fl s
45.Ar master_server
46.Op Ar domainname
47.Nm ypinit
48.Fl u
49.Op Ar domainname
50.Sh DESCRIPTION
51The
52.Nm
53script sets up databases on a Network Information Service (NIS)
54master or slave server.
55.Pp
56On a master server,
57.Nm
58creates the
59.Pa /var/yp/$DOMAINNAME
60directory, the
61.Pa /var/yp/ypservers
62file, and calls
63.Pa /var/yp/Makefile
64to create and populate an initial set of NIS maps. The maps are
65created from local source files using the
66.Xr yp_mkdb 8
67command. The script will prompt the user for a list of servers
68that support the specified domain; this list is used to populate
69the ypservers map.
70.Pp
71On a slave server,
72.Nm
73creates the
74.Pa /var/yp/$DOMAINNAME ,
75populates it with copies of the NIS maps from the master. The maps
76are obtained from the master using the
77.Xr ypxfr 8
78command. The
79.Nm
80script obtains the list of maps to transfer in one of two ways: if
81the system is configured as an NIS client and is bound to the master
82server,
83.Nm
84is able to use the
85.Xr ypwhich 1
86command to obtain a list of maps exported by the master server.
87If the system is not configured as a client of the NIS master,
88.Nm
89uses a hardcoded list of maps, some of which may or may not actually
90exist on the master. The system administrator can edit the script and
91modify the map list if necessary. Otherwise, indivudual maps can
92be transfered manually from the master using
93.Xr ypxfr 8 .
94.Sh OPTIONS
95.Nm Ypinit
96supports the following options:
97.Bl -tag -width indent
98.It Fl m Op Ar domainname
99Set up a master server. By default, the script sets up a server for
100the system default domain. The user can override this default by specifying
101.Ar domainname
102explicitly.
103Maps are constructed from scratch using local files as templates using
104the
105.Xr yp_mkdb 8
106command.
107.It Fl s Ar master_server Op Ar domainname
108Set up a slave server using
109.Ar master_name
110as the master. Maps are copied from
111.Ar master_server
112to the slave using
113.Xr ypxfr 8 .
114By default, the script sets up a server for
115the system default domain. The user can override this default by specifying
116.Ar domainname
117explicitly.
118.It Fl u Op Ar domainname
119Update the ypservers map on the master server. When a new slave
120server is added to a domain, its hostname must be added to the
121ypservers map so that
122.Xr yppush 8
123can propagate updates on the master to all of the slaves.
124.Sh FILES
125.Bl -tag -width /var/yp/master.passwd -compact
126.It Pa /etc/bootparams
127Bootparams source file
128.It Pa /etc/ethers
129Ethers data source file
130.It Pa /etc/group
131Group source file
132.It Pa /etc/hosts
133Hostname/IP address source file
134.It Pa /etc/netid
135RPC netid source file
136.It Pa /etc/networks
137Networks source file
138.It Pa /etc/protocols
139Protocols source file
140.It Pa /etc/publickey
141RPC public key/secret key source file
142.It Pa /etc/services
143Services data source file
144.It Pa /var/yp/master.passwd
145Passwd database source file
146.It Pa /var/yp/netgroup
147Netgroup data source file
148.It Pa /var/yp/ypservers
149Ypservers source file (generated by
150.Nm Ns )
151.El
152.Sh SEE ALSO
153.Xr yp 4 ,
154.Xr mknetid 8 ,
155.Xr revnetgroup 8 ,
156.Xr yp_mkdb 8 ,
157.Xr yppush 8 ,
158.Xr ypserv 8 ,
159.Xr ypxfr 8
160.Sh HISTORY
161This version of
162.Nm
163is based on the
164.Nm
165script in
166.Bx Open .
167It first appeared in
168.Bx Free
169in
170.Fx 3.0 .
171.Sh AUTHORS
172The original script was written by
173.An Mats O Jansson Aq moj@stacken.kth.se .
174It was modified for
175.Bx Free
176by
177.An Bill Paul Aq wpaul@ctr.columbia.edu .
2.\" Bill Paul <wpaul@ctr.columbia.edu>. 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 Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\" may be used to endorse or promote products derived from this software
17.\" without specific prior written permission.
18.\"
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 THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD: head/usr.sbin/ypserv/ypinit.8 50479 1999-08-28 01:35:59Z peter $
32.\"
33.Dd November 10, 1997
34.Dt YPINIT 8
35.Os FreeBSD 3.0
36.Sh NAME
37.Nm ypinit
38.Nd build and install NIS databases
39.Sh SYNOPSIS
40.Nm ypinit
41.Fl m
42.Op Ar domainname
43.Nm ypinit
44.Fl s
45.Ar master_server
46.Op Ar domainname
47.Nm ypinit
48.Fl u
49.Op Ar domainname
50.Sh DESCRIPTION
51The
52.Nm
53script sets up databases on a Network Information Service (NIS)
54master or slave server.
55.Pp
56On a master server,
57.Nm
58creates the
59.Pa /var/yp/$DOMAINNAME
60directory, the
61.Pa /var/yp/ypservers
62file, and calls
63.Pa /var/yp/Makefile
64to create and populate an initial set of NIS maps. The maps are
65created from local source files using the
66.Xr yp_mkdb 8
67command. The script will prompt the user for a list of servers
68that support the specified domain; this list is used to populate
69the ypservers map.
70.Pp
71On a slave server,
72.Nm
73creates the
74.Pa /var/yp/$DOMAINNAME ,
75populates it with copies of the NIS maps from the master. The maps
76are obtained from the master using the
77.Xr ypxfr 8
78command. The
79.Nm
80script obtains the list of maps to transfer in one of two ways: if
81the system is configured as an NIS client and is bound to the master
82server,
83.Nm
84is able to use the
85.Xr ypwhich 1
86command to obtain a list of maps exported by the master server.
87If the system is not configured as a client of the NIS master,
88.Nm
89uses a hardcoded list of maps, some of which may or may not actually
90exist on the master. The system administrator can edit the script and
91modify the map list if necessary. Otherwise, indivudual maps can
92be transfered manually from the master using
93.Xr ypxfr 8 .
94.Sh OPTIONS
95.Nm Ypinit
96supports the following options:
97.Bl -tag -width indent
98.It Fl m Op Ar domainname
99Set up a master server. By default, the script sets up a server for
100the system default domain. The user can override this default by specifying
101.Ar domainname
102explicitly.
103Maps are constructed from scratch using local files as templates using
104the
105.Xr yp_mkdb 8
106command.
107.It Fl s Ar master_server Op Ar domainname
108Set up a slave server using
109.Ar master_name
110as the master. Maps are copied from
111.Ar master_server
112to the slave using
113.Xr ypxfr 8 .
114By default, the script sets up a server for
115the system default domain. The user can override this default by specifying
116.Ar domainname
117explicitly.
118.It Fl u Op Ar domainname
119Update the ypservers map on the master server. When a new slave
120server is added to a domain, its hostname must be added to the
121ypservers map so that
122.Xr yppush 8
123can propagate updates on the master to all of the slaves.
124.Sh FILES
125.Bl -tag -width /var/yp/master.passwd -compact
126.It Pa /etc/bootparams
127Bootparams source file
128.It Pa /etc/ethers
129Ethers data source file
130.It Pa /etc/group
131Group source file
132.It Pa /etc/hosts
133Hostname/IP address source file
134.It Pa /etc/netid
135RPC netid source file
136.It Pa /etc/networks
137Networks source file
138.It Pa /etc/protocols
139Protocols source file
140.It Pa /etc/publickey
141RPC public key/secret key source file
142.It Pa /etc/services
143Services data source file
144.It Pa /var/yp/master.passwd
145Passwd database source file
146.It Pa /var/yp/netgroup
147Netgroup data source file
148.It Pa /var/yp/ypservers
149Ypservers source file (generated by
150.Nm Ns )
151.El
152.Sh SEE ALSO
153.Xr yp 4 ,
154.Xr mknetid 8 ,
155.Xr revnetgroup 8 ,
156.Xr yp_mkdb 8 ,
157.Xr yppush 8 ,
158.Xr ypserv 8 ,
159.Xr ypxfr 8
160.Sh HISTORY
161This version of
162.Nm
163is based on the
164.Nm
165script in
166.Bx Open .
167It first appeared in
168.Bx Free
169in
170.Fx 3.0 .
171.Sh AUTHORS
172The original script was written by
173.An Mats O Jansson Aq moj@stacken.kth.se .
174It was modified for
175.Bx Free
176by
177.An Bill Paul Aq wpaul@ctr.columbia.edu .