[apple/network_cmds.git] / ypbind.tproj / ypbind.8

.\"	$OpenBSD: ypbind.8,v 1.8 1997/06/18 23:50:12 deraadt Exp $
.\"	$NetBSD: ypbind.8,v 1.2 1996/02/28 01:21:00 thorpej Exp $
.\"
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Jason R. Thorpe.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd October 25, 1994
.Dt YPBIND 8
.Os
.Sh NAME
.Nm ypbind
.Nd create and maintain a binding to a YP server
.Sh SYNOPSIS
.Nm
.Op Fl ypset
.Op Fl ypsetme
.Op Fl insecure
.Sh DESCRIPTION
.Nm
finds the server for a particular YP domain and stores information about it
in a
.Pa binding file.
This binding information includes the IP address of the server associated with
that particular domain and which port the server is using.  This information
is stored in the directory
.Pa /var/yp/binding
in a file named with the convention
.Pa DOMAINNAME.version.
(The YP system only supplies information on version 2.)
.Pp
When
.Nm
starts the primary domain (or gets the first request for a new domain),
it checks if a file for the domain in question exists in the directory
.Pa /etc/yp/
(ie. /etc/yp/DOMAINNAME).
If such a file exists, it will list the hosts which
.Nm
should restrict it's server search to.
Otherwise,
.Nm
assumes it will need to use broadcasts to find a valid server.
Using either of these techniques,
.Nm
will search for a server willing to serve maps for the
client's domain.  Once a binding is established,
.Nm
maintains this binding by periodically communicating with the server to which
it is bound.  If the binding is somehow lost, e.g by server reboot,
.Nm
marks the domain as unbound and attempts to re-establish the binding.
When the binding is once again successful,
.Nm
marks the domain as bound and resumes its periodic check.
.Pp
The options are as follows:
.Bl -tag -width indentxx
.It Fl ypset
.Xr ypset 8
may be used to change the server to which a domain is bound.
.It Fl ypsetme
.Xr ypset 8
may be used only from this machine to change the server
to which a domain is bound.
.It Fl insecure
permit binding to a
.Xr ypserv 8
on a non-reserved port.  This is needed if receiving maps from
SunOS 3.x or Ultrix.
.El
.Pp
The
.Fl ypset
and
.Fl ypsetme
options are dangerous and should be avoided.
For greatest security, the use of a server list in
.Pa /etc/yp/DOMAINNAME
is recommended.
The file should contain a list of valid YP server hostnames,
with one hostname per line.
The comment character is #.
.Pp
If the directory
.Pa /var/yp/binding
exists, YP is started automatically at boot time by
.Pa /etc/rc .
.Sh FILES
.Pa /var/yp/binding/DOMAINNAME.version
- binding file for domainname
.Pa /etc/yp/DOMAINNNAME
- server list for this particular domain
.Sh SEE ALSO
.Xr domainname 1 ,
.Xr ypcat 1 ,
.Xr ypmatch 1 ,
.Xr yppoll 8 ,
.Xr ypset 8 ,
.Xr ypwhich 1 ,
.Xr ypserv 8 ,
.Xr yp 8
.Sh AUTHOR
Theo de Raadt
Commit	Line	Data
7ba0088d A	1	.\" $OpenBSD: ypbind.8,v 1.8 1997/06/18 23:50:12 deraadt Exp $
	2	.\" $NetBSD: ypbind.8,v 1.2 1996/02/28 01:21:00 thorpej Exp $
	3	.\"
	4	.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
	5	.\" All rights reserved.
	6	.\"
	7	.\" This code is derived from software contributed to The NetBSD Foundation
	8	.\" by Jason R. Thorpe.
	9	.\"
	10	.\" Redistribution and use in source and binary forms, with or without
	11	.\" modification, are permitted provided that the following conditions
	12	.\" are met:
	13	.\" 1. Redistributions of source code must retain the above copyright
	14	.\" notice, this list of conditions and the following disclaimer.
	15	.\" 2. Redistributions in binary form must reproduce the above copyright
	16	.\" notice, this list of conditions and the following disclaimer in the
	17	.\" documentation and/or other materials provided with the distribution.
	18	.\" 3. All advertising materials mentioning features or use of this software
	19	.\" must display the following acknowledgement:
	20	.\" This product includes software developed by the NetBSD
	21	.\" Foundation, Inc. and its contributors.
	22	.\" 4. Neither the name of The NetBSD Foundation nor the names of its
	23	.\" contributors may be used to endorse or promote products derived
	24	.\" from this software without specific prior written permission.
	25	.\"
	26	.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
	27	.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
	28	.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	29	.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
	30	.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	31	.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	32	.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	33	.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	34	.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	35	.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	36	.\" POSSIBILITY OF SUCH DAMAGE.
	37	.\"
	38	.Dd October 25, 1994
	39	.Dt YPBIND 8
	40	.Os
	41	.Sh NAME
	42	.Nm ypbind
	43	.Nd create and maintain a binding to a YP server
	44	.Sh SYNOPSIS
	45	.Nm
	46	.Op Fl ypset
	47	.Op Fl ypsetme
	48	.Op Fl insecure
	49	.Sh DESCRIPTION
	50	.Nm
	51	finds the server for a particular YP domain and stores information about it
	52	in a
	53	.Pa binding file.
	54	This binding information includes the IP address of the server associated with
	55	that particular domain and which port the server is using. This information
	56	is stored in the directory
	57	.Pa /var/yp/binding
	58	in a file named with the convention
	59	.Pa DOMAINNAME.version.
	60	(The YP system only supplies information on version 2.)
	61	.Pp
	62	When
	63	.Nm
	64	starts the primary domain (or gets the first request for a new domain),
65	it checks if a file for the domain in question exists in the directory
66	.Pa /etc/yp/
67	(ie. /etc/yp/DOMAINNAME).
68	If such a file exists, it will list the hosts which
69	.Nm
70	should restrict it's server search to.
71	Otherwise,
72	.Nm
73	assumes it will need to use broadcasts to find a valid server.
74	Using either of these techniques,
75	.Nm
76	will search for a server willing to serve maps for the
77	client's domain. Once a binding is established,
78	.Nm
79	maintains this binding by periodically communicating with the server to which
80	it is bound. If the binding is somehow lost, e.g by server reboot,
81	.Nm
82	marks the domain as unbound and attempts to re-establish the binding.
83	When the binding is once again successful,
84	.Nm
85	marks the domain as bound and resumes its periodic check.
86	.Pp
87	The options are as follows:
88	.Bl -tag -width indentxx
89	.It Fl ypset
90	.Xr ypset 8
91	may be used to change the server to which a domain is bound.
92	.It Fl ypsetme
93	.Xr ypset 8
94	may be used only from this machine to change the server
95	to which a domain is bound.
96	.It Fl insecure
97	permit binding to a
98	.Xr ypserv 8
99	on a non-reserved port. This is needed if receiving maps from
100	SunOS 3.x or Ultrix.
101	.El
102	.Pp
103	The
104	.Fl ypset
105	and
106	.Fl ypsetme
107	options are dangerous and should be avoided.
108	For greatest security, the use of a server list in
109	.Pa /etc/yp/DOMAINNAME
110	is recommended.
111	The file should contain a list of valid YP server hostnames,
112	with one hostname per line.
113	The comment character is #.
114	.Pp
115	If the directory
116	.Pa /var/yp/binding
117	exists, YP is started automatically at boot time by
118	.Pa /etc/rc .
119	.Sh FILES
120	.Pa /var/yp/binding/DOMAINNAME.version
121	- binding file for domainname
122	.Pa /etc/yp/DOMAINNNAME
123	- server list for this particular domain
124	.Sh SEE ALSO
125	.Xr domainname 1 ,
126	.Xr ypcat 1 ,
127	.Xr ypmatch 1 ,
128	.Xr yppoll 8 ,
129	.Xr ypset 8 ,
130	.Xr ypwhich 1 ,
131	.Xr ypserv 8 ,
132	.Xr yp 8
133	.Sh AUTHOR
134	Theo de Raadt