xref: /freebsd/usr.sbin/ypserv/ypinit.8 (revision 42249ef2)
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$
32.\"
33.Dd August 18, 2015
34.Dt YPINIT 8
35.Os
36.Sh NAME
37.Nm ypinit
38.Nd build and install NIS databases
39.Sh SYNOPSIS
40.Nm
41.Fl m
42.Op Ar domainname
43.Nm
44.Fl s
45.Ar master_server
46.Op Ar domainname
47.Nm
48.Fl u
49.Op Ar domainname
50.Sh DESCRIPTION
51The
52.Nm
53utility is a script which sets up databases on a Network Information Service
54(NIS)
55master or slave server.
56.Pp
57On a master server,
58.Nm
59creates the
60.Pa /var/yp/$DOMAINNAME
61directory, the
62.Pa /var/yp/ypservers
63file, and calls
64.Pa /var/yp/Makefile
65to create and populate an initial set of NIS maps.
66The maps are
67created from local source files using the
68.Xr yp_mkdb 8
69utility.
70The utility will prompt the user for a list of servers
71that support the specified domain; this list is used to populate
72the ypservers map.
73.Pp
74On a slave server,
75.Nm
76creates the
77.Pa /var/yp/$DOMAINNAME ,
78populates it with copies of the NIS maps from the master.
79The maps
80are obtained from the master using the
81.Xr ypxfr 8
82utility.
83The
84.Nm
85utility obtains the list of maps to transfer in one of two ways: if
86the system is configured as an NIS client and is bound to the master
87server,
88.Nm
89is able to use the
90.Xr ypwhich 1
91utility to obtain a list of maps exported by the master server.
92If the system is not configured as a client of the NIS master,
93.Nm
94uses a hardcoded list of maps, some of which may or may not actually
95exist on the master.
96The system administrator can edit the
97.Nm
98script and
99modify the map list if necessary.
100Otherwise, individual maps can
101be transferred manually from the master using
102.Xr ypxfr 8 .
103.Sh OPTIONS
104The
105.Nm
106utility supports the following options:
107.Bl -tag -width indent
108.It Fl m Op Ar domainname
109Set up a master server.
110By default,
111.Nm
112sets up a server for
113the system default domain.
114The user can override this default by specifying
115.Ar domainname
116explicitly.
117Maps are constructed from scratch using local files as templates using
118the
119.Xr yp_mkdb 8
120utility.
121.It Fl s Ar master_server Op Ar domainname
122Set up a slave server using
123.Ar master_name
124as the master.
125Maps are copied from
126.Ar master_server
127to the slave using
128.Xr ypxfr 8 .
129By default,
130.Nm
131sets up a server for
132the system default domain.
133The user can override this default by specifying
134.Ar domainname
135explicitly.
136.It Fl u Op Ar domainname
137Update the ypservers map on the master server.
138When a new slave
139server is added to a domain, its hostname must be added to the
140ypservers map so that
141.Xr yppush 8
142can propagate updates on the master to all of the slaves.
143.El
144.Sh FILES
145.Bl -tag -width /var/yp/master.passwd -compact
146.It Pa /etc/bootparams
147Bootparams source file
148.It Pa /etc/ethers
149Ethers data source file
150.It Pa /etc/eui64
151EUI64 data source file
152.It Pa /etc/group
153Group source file
154.It Pa /etc/hosts
155Hostname/IP address source file
156.It Pa /etc/netid
157RPC netid source file
158.It Pa /etc/networks
159Networks source file
160.It Pa /etc/protocols
161Protocols source file
162.It Pa /etc/publickey
163RPC public key/secret key source file
164.It Pa /etc/services
165Services data source file
166.It Pa /etc/shells
167Shells source file
168.It Pa /var/yp/master.passwd
169Passwd database source file
170.It Pa /var/yp/netgroup
171Netgroup data source file
172.It Pa /var/yp/ypservers
173Ypservers source file (generated by
174.Nm )
175.El
176.Sh SEE ALSO
177.Xr mknetid 8 ,
178.Xr revnetgroup 8 ,
179.Xr yp 8 ,
180.Xr yp_mkdb 8 ,
181.Xr yppush 8 ,
182.Xr ypserv 8 ,
183.Xr ypxfr 8
184.Sh HISTORY
185This version of
186.Nm
187is based on the
188.Nm
189script in
190.Ox .
191It first appeared in
192.Fx 3.0 .
193.Sh AUTHORS
194.An -nosplit
195The original script was written by
196.An Mats O Jansson Aq Mt moj@stacken.kth.se .
197It was modified for
198.Fx
199by
200.An Bill Paul Aq Mt wpaul@ctr.columbia.edu .
201