.\" $OpenBSD: gethostname.3,v 1.18 2001/01/21 23:30:04 aaron Exp $
|
.\" $OpenBSD: gethostname.3,v 1.18 2001/01/21 23:30:04 aaron Exp $
|
.\"
|
.\"
|
.\" Copyright (c) 1983, 1991, 1993
|
.\" Copyright (c) 1983, 1991, 1993
|
.\" The Regents of the University of California. All rights reserved.
|
.\" The Regents of the University of California. All rights reserved.
|
.\"
|
.\"
|
.\" Redistribution and use in source and binary forms, with or without
|
.\" Redistribution and use in source and binary forms, with or without
|
.\" modification, are permitted provided that the following conditions
|
.\" modification, are permitted provided that the following conditions
|
.\" are met:
|
.\" are met:
|
.\" 1. Redistributions of source code must retain the above copyright
|
.\" 1. Redistributions of source code must retain the above copyright
|
.\" notice, this list of conditions and the following disclaimer.
|
.\" notice, this list of conditions and the following disclaimer.
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
.\" notice, this list of conditions and the following disclaimer in the
|
.\" notice, this list of conditions and the following disclaimer in the
|
.\" documentation and/or other materials provided with the distribution.
|
.\" documentation and/or other materials provided with the distribution.
|
.\" 3. All advertising materials mentioning features or use of this software
|
.\" 3. All advertising materials mentioning features or use of this software
|
.\" must display the following acknowledgement:
|
.\" must display the following acknowledgement:
|
.\" This product includes software developed by the University of
|
.\" This product includes software developed by the University of
|
.\" California, Berkeley and its contributors.
|
.\" California, Berkeley and its contributors.
|
.\" 4. Neither the name of the University nor the names of 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
|
.\" may be used to endorse or promote products derived from this software
|
.\" without specific prior written permission.
|
.\" without specific prior written permission.
|
.\"
|
.\"
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
.\" 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
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
.\" SUCH DAMAGE.
|
.\" SUCH DAMAGE.
|
.\"
|
.\"
|
.Dd June 4, 1993
|
.Dd June 4, 1993
|
.Dt GETHOSTNAME 3
|
.Dt GETHOSTNAME 3
|
.Os
|
.Os
|
.Sh NAME
|
.Sh NAME
|
.Nm gethostname ,
|
.Nm gethostname ,
|
.Nm sethostname
|
.Nm sethostname
|
.Nd get/set name of current host
|
.Nd get/set name of current host
|
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
.Fd #include
|
.Fd #include
|
.Ft int
|
.Ft int
|
.Fn gethostname "char *name" "size_t namelen"
|
.Fn gethostname "char *name" "size_t namelen"
|
.Ft int
|
.Ft int
|
.Fn sethostname "const char *name" "size_t namelen"
|
.Fn sethostname "const char *name" "size_t namelen"
|
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
The
|
The
|
.Fn gethostname
|
.Fn gethostname
|
function returns the standard host name for the current
|
function returns the standard host name for the current
|
processor, as previously set by
|
processor, as previously set by
|
.Fn sethostname .
|
.Fn sethostname .
|
The parameter
|
The parameter
|
.Fa namelen
|
.Fa namelen
|
specifies the size of the
|
specifies the size of the
|
.Fa name
|
.Fa name
|
array.
|
array.
|
If insufficient space is provided, the returned name is truncated.
|
If insufficient space is provided, the returned name is truncated.
|
The returned name is always null terminated.
|
The returned name is always null terminated.
|
.Pp
|
.Pp
|
.Fn sethostname
|
.Fn sethostname
|
sets the name of the host machine to be
|
sets the name of the host machine to be
|
.Fa name ,
|
.Fa name ,
|
which has length
|
which has length
|
.Fa namelen .
|
.Fa namelen .
|
This call is restricted to the superuser and
|
This call is restricted to the superuser and
|
is normally used only when the system is bootstrapped.
|
is normally used only when the system is bootstrapped.
|
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
If the call succeeds a value of 0 is returned.
|
If the call succeeds a value of 0 is returned.
|
If the call fails, a value of \-1 is returned and an error code is
|
If the call fails, a value of \-1 is returned and an error code is
|
placed in the global variable
|
placed in the global variable
|
.Va errno .
|
.Va errno .
|
.Sh ERRORS
|
.Sh ERRORS
|
The following errors may be returned by these calls:
|
The following errors may be returned by these calls:
|
.Bl -tag -width Er
|
.Bl -tag -width Er
|
.It Bq Er EFAULT
|
.It Bq Er EFAULT
|
The
|
The
|
.Fa name
|
.Fa name
|
or
|
or
|
.Fa namelen
|
.Fa namelen
|
parameter gave an invalid address.
|
parameter gave an invalid address.
|
.It Bq Er EPERM
|
.It Bq Er EPERM
|
The caller tried to set the hostname and was not the superuser.
|
The caller tried to set the hostname and was not the superuser.
|
.El
|
.El
|
.Sh SEE ALSO
|
.Sh SEE ALSO
|
.Xr hostname 1 ,
|
.Xr hostname 1 ,
|
.Xr getdomainname 3 ,
|
.Xr getdomainname 3 ,
|
.Xr gethostid 3 ,
|
.Xr gethostid 3 ,
|
.Xr sysctl 3 ,
|
.Xr sysctl 3 ,
|
.Xr sysctl 8 ,
|
.Xr sysctl 8 ,
|
.Xr yp 8
|
.Xr yp 8
|
.Sh STANDARDS
|
.Sh STANDARDS
|
The
|
The
|
.Fn gethostname
|
.Fn gethostname
|
function call conforms to
|
function call conforms to
|
.St -xpg4.2 .
|
.St -xpg4.2 .
|
.Sh HISTORY
|
.Sh HISTORY
|
The
|
The
|
.Fn gethostname
|
.Fn gethostname
|
function call appeared in
|
function call appeared in
|
.Bx 4.2 .
|
.Bx 4.2 .
|
.Sh BUGS
|
.Sh BUGS
|
Host names are limited to
|
Host names are limited to
|
.Dv MAXHOSTNAMELEN
|
.Dv MAXHOSTNAMELEN
|
(from
|
(from
|
.Ao Pa sys/param.h Ac )
|
.Ao Pa sys/param.h Ac )
|
characters, currently 256.
|
characters, currently 256.
|
This includes the terminating NUL character.
|
This includes the terminating NUL character.
|
.Pp
|
.Pp
|
If the buffer passed to
|
If the buffer passed to
|
.Fn gethostname
|
.Fn gethostname
|
is smaller than
|
is smaller than
|
.Dv MAXHOSTNAMELEN ,
|
.Dv MAXHOSTNAMELEN ,
|
other operating systems may not guarantee termination with NUL.
|
other operating systems may not guarantee termination with NUL.
|
|
|
