1.\" $NetBSD: gethostname.3,v 1.2 1995/02/27 04:12:42 cgd Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt GETHOSTNAME 3 38.Os BSD 4.2 39.Sh NAME 40.Nm gethostname , 41.Nm sethostname 42.Nd get/set name of current host 43.Sh SYNOPSIS 44.Fd #include <unistd.h> 45.Ft int 46.Fn gethostname "char *name" "int namelen" 47.Ft int 48.Fn sethostname "const char *name" "int namelen" 49.Sh DESCRIPTION 50.Fn Gethostname 51returns the standard host name for the current processor, as 52previously set by 53.Fn sethostname . 54The parameter 55.Fa namelen 56specifies the size of the 57.Fa name 58array. The returned name is null-terminated unless insufficient 59space is provided. 60.Pp 61.Fn Sethostname 62sets the name of the host machine to be 63.Fa name , 64which has length 65.Fa namelen . 66This call is restricted to the super-user and 67is normally used only when the system is bootstrapped. 68.Sh RETURN VALUES 69If the call succeeds a value of 0 is returned. If the call 70fails, a value of -1 is returned and an error code is 71placed in the global location 72.Va errno . 73.Sh ERRORS 74The following errors may be returned by these calls: 75.Bl -tag -width Er 76.It Bq Er EFAULT 77The 78.Fa name 79or 80.Fa namelen 81parameter gave an 82invalid address. 83.It Bq Er EPERM 84The caller tried to set the hostname and was not the super-user. 85.El 86.Sh SEE ALSO 87.Xr sysctl 2 88.Xr gethostid 3 89.Sh BUGS 90Host names are limited to 91.Dv MAXHOSTNAMELEN 92(from 93.Ao Pa sys/param.h Ac ) 94characters, currently 256. 95.Sh HISTORY 96The 97.Nm 98function call appeared in 99.Bx 4.2 . 100