[apple/mdnsresponder.git] / mDNSPosix / libnss_mdns.8

.\"
.\" See section LICENSE for license information.
.\"
.Dd June 15, 2004
.Dt LIBNSS_MDNS 8
.Os
.Sh NAME
.Nm libnss_mdns
.Nd name service switch module to support Apple mdnsd
.Sh DESCRIPTION
The
.Nm
shared library implements a name service switch module to interface with Apple
mdnsd.  It is enabled by adding
.Ql mdns
to the
.Ql hosts:
line of
.Xr nsswitch.conf 5 .
This will cause calls to
.Xr gethostbyname 3 ,
.Xr gethostbyname2 3
and
.Xr gethostbyaddr 3
to include mdnsd in their lookup path.
.Pp
The
.Nm
shared library should be installed in the system library paths, typically in
.Pa /lib .
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /etc/nss_mdns.conf
configuration options
.El
.Sh EXAMPLES
In
.Pa /etc/nsswitch.conf :
.Dl hosts: files mdns dns
.Pp
This will cause the name service switch to lookup hostnames first using
.Pa /etc/hosts ,
then mdns and finally via DNS.
.Sh DIAGNOSTICS
.Nm
dumps status information via
.Xr syslog 3 .
.Sh SEE ALSO
.\" Cross-references should be ordered by section (low to high), then in
.\"     alphabetical order.
.Xr nsswitch.conf 5 ,
.Xr nss_mdns.conf 5 ,
.Xr ldconfig 8
.Pp
.Li info libc Qq Name Service Switch
.\" .Sh STANDARDS
.Sh HISTORY
.Nm
was originally written for
.An NICTA Bq http://www.nicta.com.au/ .
.Sh AUTHORS
.An "Andrew White" Bq Andrew.White@nicta.com.au
.Sh BUGS
Return values for obscure error conditions may not match those expected by nsswitch code.
.Pp
Version 0.62 of mdnsd does not support an option to force link-local multicast lookups.
.Ql PTR
reverse lookups for non-link-local domains will not function correctly.
.Sh LICENSE
This software is licensed under the NICTA Public Source License version 1.0
.Ss NICTA Public Software Licence
Version 1.0
.Pp
Copyright 2004 National ICT Australia Ltd
.Pp
All rights reserved.
.Pp
By this licence, National ICT Australia Ltd (NICTA) grants permission,
free of charge, to any person who obtains a copy of this software
and any associated documentation files ("the Software") to use and
deal with the Software in source code and binary forms without
restriction, with or without modification, and to permit persons
to whom the Software is furnished to do so, provided that the
following conditions are met:
.Bl -bullet
.It
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimers.
.It
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimers in
the documentation and/or other materials provided with the
distribution.
.It
The name of NICTA may not be used to endorse or promote products
derived from this Software without specific prior written permission.
.El
.Pp
EXCEPT AS EXPRESSLY STATED IN THIS LICENCE AND TO THE FULL EXTENT
PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS PROVIDED "AS-IS" AND
NICTA MAKES NO REPRESENTATIONS, WARRANTIES OR CONDITIONS OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY
REPRESENTATIONS, WARRANTIES OR CONDITIONS REGARDING THE CONTENTS
OR ACCURACY OF THE SOFTWARE, OR OF TITLE, MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, THE ABSENCE OF LATENT
OR OTHER DEFECTS, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR
NOT DISCOVERABLE.
.Pp
TO THE FULL EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL
NICTA BE LIABLE ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) FOR ANY LOSS OR DAMAGE WHATSOEVER, INCLUDING (WITHOUT
LIMITATION) LOSS OF PRODUCTION OR OPERATION TIME, LOSS, DAMAGE OR
CORRUPTION OF DATA OR RECORDS; OR LOSS OF ANTICIPATED SAVINGS,
OPPORTUNITY, REVENUE, PROFIT OR GOODWILL, OR OTHER ECONOMIC LOSS;
OR ANY SPECIAL, INCIDENTAL, INDIRECT, CONSEQUENTIAL, PUNITIVE OR
EXEMPLARY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THIS LICENCE,
THE SOFTWARE OR THE USE OF THE SOFTWARE, EVEN IF NICTA HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.Pp
If applicable legislation implies warranties or conditions, or
imposes obligations or liability on NICTA in respect of the Software
that cannot be wholly or partly excluded, restricted or modified,
NICTA's liability is limited, to the full extent permitted by the
applicable legislation, at its option, to:
.Pp
.Bl -tag -width "a." -compact
.It a.
in the case of goods, any one or more of the following:
.Bl -tag -width "iii." -compact
.It i.
the replacement of the goods or the supply of equivalent goods;
.It ii.
the repair of the goods;
.It iii.
the payment of the cost of replacing the goods or of acquiring
equivalent goods;
.It iv.
the payment of the cost of having the goods repaired; or
.El
.It b.
in the case of services:
.Bl -tag -width "iii." -compact
.It i.
the supplying of the services again; or 
.It ii.
the payment of the cost of having the services supplied again.
.El
.El
Commit	Line	Data
7f0064bd A	1	.\"
	2	.\" See section LICENSE for license information.
	3	.\"
	4	.Dd June 15, 2004
	5	.Dt LIBNSS_MDNS 8
	6	.Os
	7	.Sh NAME
	8	.Nm libnss_mdns
	9	.Nd name service switch module to support Apple mdnsd
	10	.Sh DESCRIPTION
	11	The
	12	.Nm
	13	shared library implements a name service switch module to interface with Apple
	14	mdnsd. It is enabled by adding
	15	.Ql mdns
	16	to the
	17	.Ql hosts:
	18	line of
	19	.Xr nsswitch.conf 5 .
	20	This will cause calls to
	21	.Xr gethostbyname 3 ,
	22	.Xr gethostbyname2 3
	23	and
	24	.Xr gethostbyaddr 3
	25	to include mdnsd in their lookup path.
	26	.Pp
	27	The
	28	.Nm
	29	shared library should be installed in the system library paths, typically in
	30	.Pa /lib .
	31	.Sh FILES
	32	.Bl -tag -width Pa -compact
	33	.It Pa /etc/nss_mdns.conf
	34	configuration options
	35	.El
	36	.Sh EXAMPLES
	37	In
	38	.Pa /etc/nsswitch.conf :
	39	.Dl hosts: files mdns dns
	40	.Pp
	41	This will cause the name service switch to lookup hostnames first using
	42	.Pa /etc/hosts ,
	43	then mdns and finally via DNS.
	44	.Sh DIAGNOSTICS
	45	.Nm
	46	dumps status information via
	47	.Xr syslog 3 .
	48	.Sh SEE ALSO
	49	.\" Cross-references should be ordered by section (low to high), then in
	50	.\" alphabetical order.
	51	.Xr nsswitch.conf 5 ,
	52	.Xr nss_mdns.conf 5 ,
	53	.Xr ldconfig 8
	54	.Pp
	55	.Li info libc Qq Name Service Switch
	56	.\" .Sh STANDARDS
	57	.Sh HISTORY
	58	.Nm
	59	was originally written for
	60	.An NICTA Bq http://www.nicta.com.au/ .
	61	.Sh AUTHORS
	62	.An "Andrew White" Bq Andrew.White@nicta.com.au
	63	.Sh BUGS
	64	Return values for obscure error conditions may not match those expected by nsswitch code.
65	.Pp
66	Version 0.62 of mdnsd does not support an option to force link-local multicast lookups.
67	.Ql PTR
68	reverse lookups for non-link-local domains will not function correctly.
69	.Sh LICENSE
70	This software is licensed under the NICTA Public Source License version 1.0
71	.Ss NICTA Public Software Licence
72	Version 1.0
73	.Pp
74	Copyright 2004 National ICT Australia Ltd
75	.Pp
76	All rights reserved.
77	.Pp
78	By this licence, National ICT Australia Ltd (NICTA) grants permission,
79	free of charge, to any person who obtains a copy of this software
80	and any associated documentation files ("the Software") to use and
81	deal with the Software in source code and binary forms without
82	restriction, with or without modification, and to permit persons
83	to whom the Software is furnished to do so, provided that the
84	following conditions are met:
85	.Bl -bullet
86	.It
87	Redistributions of source code must retain the above copyright
88	notice, this list of conditions and the following disclaimers.
89	.It
90	Redistributions in binary form must reproduce the above copyright
91	notice, this list of conditions and the following disclaimers in
92	the documentation and/or other materials provided with the
93	distribution.
94	.It
95	The name of NICTA may not be used to endorse or promote products
96	derived from this Software without specific prior written permission.
97	.El
98	.Pp
99	EXCEPT AS EXPRESSLY STATED IN THIS LICENCE AND TO THE FULL EXTENT
100	PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS PROVIDED "AS-IS" AND
101	NICTA MAKES NO REPRESENTATIONS, WARRANTIES OR CONDITIONS OF ANY
102	KIND, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY
103	REPRESENTATIONS, WARRANTIES OR CONDITIONS REGARDING THE CONTENTS
104	OR ACCURACY OF THE SOFTWARE, OR OF TITLE, MERCHANTABILITY, FITNESS
105	FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, THE ABSENCE OF LATENT
106	OR OTHER DEFECTS, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR
107	NOT DISCOVERABLE.
108	.Pp
109	TO THE FULL EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL
110	NICTA BE LIABLE ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
111	NEGLIGENCE) FOR ANY LOSS OR DAMAGE WHATSOEVER, INCLUDING (WITHOUT
112	LIMITATION) LOSS OF PRODUCTION OR OPERATION TIME, LOSS, DAMAGE OR
113	CORRUPTION OF DATA OR RECORDS; OR LOSS OF ANTICIPATED SAVINGS,
114	OPPORTUNITY, REVENUE, PROFIT OR GOODWILL, OR OTHER ECONOMIC LOSS;
115	OR ANY SPECIAL, INCIDENTAL, INDIRECT, CONSEQUENTIAL, PUNITIVE OR
116	EXEMPLARY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THIS LICENCE,
117	THE SOFTWARE OR THE USE OF THE SOFTWARE, EVEN IF NICTA HAS BEEN
118	ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
119	.Pp
120	If applicable legislation implies warranties or conditions, or
121	imposes obligations or liability on NICTA in respect of the Software
122	that cannot be wholly or partly excluded, restricted or modified,
123	NICTA's liability is limited, to the full extent permitted by the
124	applicable legislation, at its option, to:
125	.Pp
126	.Bl -tag -width "a." -compact
127	.It a.
128	in the case of goods, any one or more of the following:
129	.Bl -tag -width "iii." -compact
130	.It i.
131	the replacement of the goods or the supply of equivalent goods;
132	.It ii.
133	the repair of the goods;
134	.It iii.
135	the payment of the cost of replacing the goods or of acquiring
136	equivalent goods;
137	.It iv.
138	the payment of the cost of having the goods repaired; or
139	.El
140	.It b.
141	in the case of services:
142	.Bl -tag -width "iii." -compact
143	.It i.
144	the supplying of the services again; or
145	.It ii.
146	the payment of the cost of having the services supplied again.
147	.El
148	.El