git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 1983, 1991, 1993
	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	.\"
	32	.\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93
	33	.\" $FreeBSD: src/lib/libc/gen/gethostname.3,v 1.13 2002/12/19 09:40:21 ru Exp $
	34	.\"
	35	.Dd June 4, 1993
	36	.Dt GETHOSTNAME 3
	37	.Os
	38	.Sh NAME
	39	.Nm gethostname ,
	40	.Nm sethostname
	41	.Nd get/set name of current host
	42	.Sh LIBRARY
	43	.Lb libc
	44	.Sh SYNOPSIS
	45	.In unistd.h
	46	.Ft int
	47	.Fn gethostname "char *name" "int namelen"
	48	.Ft int
	49	.Fn sethostname "const char *name" "int namelen"
	50	.Sh DESCRIPTION
	51	The
	52	.Fn gethostname
	53	function
	54	returns the standard host name for the current processor, as
	55	previously set by
	56	.Fn sethostname .
	57	The
	58	.Fa namelen
	59	argument
	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
	65	The
	66	.Fn sethostname
	67	function
	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.
	74	.Sh RETURN VALUES
	75	.Rv -std
	76	.Sh ERRORS
	77	The following errors may be returned by these calls:
	78	.Bl -tag -width Er
	79	.It Bq Er EFAULT
	80	The
	81	.Fa name
	82	or
	83	.Fa namelen
	84	argument gave an
	85	invalid address.
	86	.It Bq Er EPERM
	87	The caller tried to set the hostname and was not the super-user.
	88	.El
	89	.Sh SEE ALSO
	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 .
	100	.Sh HISTORY
	101	The
	102	.Fn gethostname
	103	function appeared in
	104	.Bx 4.2 .