xref: /386bsd/usr/src/lib/libc/sys/gethostname.2 (revision a2142627)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" 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.2	6.7 (Berkeley) 3/10/91
33.\"
34.Dd March 10, 1991
35.Dt GETHOSTNAME 2
36.Os BSD 4.2
37.Sh NAME
38.Nm gethostname ,
39.Nm sethostname
40.Nd get/set name of current host
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft int
44.Fn gethostname "char *name" "int namelen"
45.Ft int
46.Fn sethostname "const char *name" "int namelen"
47.Sh DESCRIPTION
48.Fn Gethostname
49returns the standard host name for the current processor, as
50previously set by
51.Fn sethostname .
52The parameter
53.Fa namelen
54specifies the size of the
55.Fa name
56array.  The returned name is null-terminated unless insufficient
57space is provided.
58.Pp
59.Fn Sethostname
60sets the name of the host machine to be
61.Fa name ,
62which has length
63.Fa namelen .
64This call is restricted to the super-user and
65is normally used only when the system is bootstrapped.
66.Sh RETURN VALUES
67If the call succeeds a value of 0 is returned.  If the call
68fails, a value of -1 is returned and an error code is
69placed in the global location
70.Va errno .
71.Sh ERRORS
72The following errors may be returned by these calls:
73.Bl -tag -width Er
74.It Bq Er EFAULT
75The
76.Fa name
77or
78.Fa namelen
79parameter gave an
80invalid address.
81.It Bq Er EPERM
82The caller tried to set the hostname and was not the super-user.
83.El
84.Sh SEE ALSO
85.Xr gethostid 2
86.Sh BUGS
87Host names are limited to
88.Dv MAXHOSTNAMELEN
89(from
90.Ao Pa sys/param.h Ac )
91characters, currently 64.
92.Sh HISTORY
93The
94.Nm
95function call appeared in
96.Bx 4.2 .
97