[apple/libc.git] / gen / getdomainname.3

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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 University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University 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 REGENTS 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.
.\"
.\"     @(#)gethostname.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/gen/getdomainname.3,v 1.14 2001/10/01 16:08:51 ru Exp $
.\"
.Dd May 6, 1994
.Dt GETDOMAINNAME 3
.Os
.Sh NAME
.Nm getdomainname ,
.Nm setdomainname
.Nd get/set NIS domain name of current host
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fn getdomainname "char *name" "int namelen"
.Ft int
.Fn setdomainname "const char *name" "int namelen"
.Sh DESCRIPTION
.Fn Getdomainname
returns the standard NIS domain name for the current host, as
previously set by
.Fn setdomainname .
The parameter
.Fa namelen
specifies the size of the
.Fa name
array.  The returned name is null-terminated unless insufficient
space is provided.
.Pp
.Fn Setdomainname
sets the NIS domain name of the host machine to be
.Fa name ,
which has length
.Fa namelen .
This call is restricted to the super-user and
is normally used only when the system is bootstrapped.
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
The following errors may be returned by these calls:
.Bl -tag -width Er
.It Bq Er EFAULT
The
.Fa name
or
.Fa namelen
parameter gave an
invalid address.
.It Bq Er EPERM
The caller tried to set the hostname and was not the super-user.
.El
.Sh SEE ALSO
.Xr gethostid 3 ,
.Xr gethostname 3 ,
.Xr sysctl 3
.Sh BUGS
Domain names are limited to
.Dv MAXHOSTNAMELEN
(from
.Ao Pa sys/param.h Ac )
characters, currently 256.
.Sh HISTORY
The
.Fn getdomainname
function call appeared in
.Bx 4.2 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1983, 1991, 1993
e9ce8d39 A	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	.\"
5b2abdfb A	32	.\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93
5b2abdfb A	33	.\" $FreeBSD: src/lib/libc/gen/getdomainname.3,v 1.14 2001/10/01 16:08:51 ru Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd May 6, 1994
5b2abdfb A	36	.Dt GETDOMAINNAME 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm getdomainname ,
5b2abdfb A	40	.Nm setdomainname
9385eb3d	41	.Nd get/set NIS domain name of current host
e9ce8d39 A	42	.Sh LIBRARY
	43	.Lb libc
	44	.Sh SYNOPSIS
5b2abdfb	45	.In unistd.h
e9ce8d39	46	.Ft int
5b2abdfb A	47	.Fn getdomainname "char *name" "int namelen"
	48	.Ft int
	49	.Fn setdomainname "const char *name" "int namelen"
e9ce8d39	50	.Sh DESCRIPTION
5b2abdfb	51	.Fn Getdomainname
9385eb3d	52	returns the standard NIS domain name for the current host, as
5b2abdfb A	53	previously set by
	54	.Fn setdomainname .
	55	The parameter
	56	.Fa namelen
	57	specifies the size of the
	58	.Fa name
	59	array. The returned name is null-terminated unless insufficient
	60	space is provided.
	61	.Pp
	62	.Fn Setdomainname
9385eb3d	63	sets the NIS domain name of the host machine to be
5b2abdfb A	64	.Fa name ,
	65	which has length
	66	.Fa namelen .
	67	This call is restricted to the super-user and
	68	is normally used only when the system is bootstrapped.
e9ce8d39	69	.Sh RETURN VALUES
5b2abdfb	70	.Rv -std
e9ce8d39	71	.Sh ERRORS
5b2abdfb	72	The following errors may be returned by these calls:
e9ce8d39	73	.Bl -tag -width Er
5b2abdfb A	74	.It Bq Er EFAULT
	75	The
	76	.Fa name
	77	or
	78	.Fa namelen
	79	parameter gave an
	80	invalid address.
	81	.It Bq Er EPERM
	82	The caller tried to set the hostname and was not the super-user.
	83	.El
e9ce8d39	84	.Sh SEE ALSO
5b2abdfb A	85	.Xr gethostid 3 ,
	86	.Xr gethostname 3 ,
	87	.Xr sysctl 3
	88	.Sh BUGS
	89	Domain names are limited to
	90	.Dv MAXHOSTNAMELEN
	91	(from
	92	.Ao Pa sys/param.h Ac )
	93	characters, currently 256.
e9ce8d39 A	94	.Sh HISTORY
e9ce8d39 A	95	The
5b2abdfb A	96	.Fn getdomainname
	97	function call appeared in
	98	.Bx 4.2 .