[apple/libc.git] / gen / FreeBSD / gethostname.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/gethostname.3,v 1.13 2002/12/19 09:40:21 ru Exp $
.\"
.Dd June 4, 1993
.Dt GETHOSTNAME 3
.Os
.Sh NAME
.Nm gethostname ,
.Nm sethostname
.Nd get/set name of current host
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fn gethostname "char *name" "int namelen"
.Ft int
.Fn sethostname "const char *name" "int namelen"
.Sh DESCRIPTION
The
.Fn gethostname
function
returns the standard host name for the current processor, as
previously set by
.Fn sethostname .
The
.Fa namelen
argument
specifies the size of the
.Fa name
array.  The returned name is null-terminated unless insufficient
space is provided.
.Pp
The
.Fn sethostname
function
sets the 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
argument 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 sysctl 3
.Sh BUGS
Host names are limited to
.Dv MAXHOSTNAMELEN
(from
.Ao Pa sys/param.h Ac )
characters, currently 256.
This includes the trailing
.Dv NUL .
.Sh HISTORY
The
.Fn gethostname
function 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	32	.\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93
9385eb3d	33	.\" $FreeBSD: src/lib/libc/gen/gethostname.3,v 1.13 2002/12/19 09:40:21 ru Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd June 4, 1993
5b2abdfb A	36	.Dt GETHOSTNAME 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm gethostname ,
	40	.Nm sethostname
	41	.Nd get/set 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 gethostname "char *name" "int namelen"
	48	.Ft int
	49	.Fn sethostname "const char *name" "int namelen"
e9ce8d39	50	.Sh DESCRIPTION
9385eb3d A	51	The
	52	.Fn gethostname
	53	function
5b2abdfb A	54	returns the standard host name for the current processor, as
	55	previously set by
	56	.Fn sethostname .
9385eb3d	57	The
5b2abdfb	58	.Fa namelen
9385eb3d	59	argument
5b2abdfb A	60	specifies the size of the
	61	.Fa name
	62	array. The returned name is null-terminated unless insufficient
	63	space is provided.
	64	.Pp
9385eb3d A	65	The
	66	.Fn sethostname
	67	function
5b2abdfb A	68	sets the name of the host machine to be
	69	.Fa name ,
	70	which has length
	71	.Fa namelen .
	72	This call is restricted to the super-user and
	73	is normally used only when the system is bootstrapped.
e9ce8d39	74	.Sh RETURN VALUES
5b2abdfb	75	.Rv -std
e9ce8d39	76	.Sh ERRORS
5b2abdfb	77	The following errors may be returned by these calls:
e9ce8d39	78	.Bl -tag -width Er
5b2abdfb A	79	.It Bq Er EFAULT
	80	The
	81	.Fa name
	82	or
	83	.Fa namelen
9385eb3d	84	argument gave an
5b2abdfb A	85	invalid address.
	86	.It Bq Er EPERM
	87	The caller tried to set the hostname and was not the super-user.
	88	.El
e9ce8d39	89	.Sh SEE ALSO
5b2abdfb A	90	.Xr gethostid 3 ,
	91	.Xr sysctl 3
	92	.Sh BUGS
	93	Host names are limited to
	94	.Dv MAXHOSTNAMELEN
	95	(from
	96	.Ao Pa sys/param.h Ac )
	97	characters, currently 256.
	98	This includes the trailing
	99	.Dv NUL .
e9ce8d39 A	100	.Sh HISTORY
e9ce8d39 A	101	The
5b2abdfb	102	.Fn gethostname
9385eb3d	103	function appeared in
5b2abdfb	104	.Bx 4.2 .