1996-02-11 19:15:40 +03:00
|
|
|
.\" $NetBSD: gethostname.3,v 1.3 1996/02/11 16:15:40 neil Exp $
|
1995-02-27 07:12:15 +03:00
|
|
|
.\"
|
1994-05-07 06:52:59 +04:00
|
|
|
.\" 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
|
|
|
|
|
.\"
|
|
|
|
|
.Dd June 4, 1993
|
|
|
|
|
.Dt GETHOSTNAME 3
|
|
|
|
|
.Os BSD 4.2
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm gethostname ,
|
|
|
|
|
.Nm sethostname
|
|
|
|
|
.Nd get/set name of current host
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Fd #include <unistd.h>
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn gethostname "char *name" "int namelen"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn sethostname "const char *name" "int namelen"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
.Fn Gethostname
|
|
|
|
|
returns the standard host name for the current processor, as
|
|
|
|
|
previously set by
|
|
|
|
|
.Fn sethostname .
|
|
|
|
|
The parameter
|
|
|
|
|
.Fa namelen
|
|
|
|
|
specifies the size of the
|
|
|
|
|
.Fa name
|
|
|
|
|
array. The returned name is null-terminated unless insufficient
|
|
|
|
|
space is provided.
|
|
|
|
|
.Pp
|
|
|
|
|
.Fn Sethostname
|
|
|
|
|
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
|
|
|
|
|
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
|
|
|
|
|
placed in the global location
|
|
|
|
|
.Va errno .
|
|
|
|
|
.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
|
|
|
|
|
parameter 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
|
1996-02-11 19:15:40 +03:00
|
|
|
.Xr sysctl 3
|
1994-05-07 06:52:59 +04:00
|
|
|
.Xr gethostid 3
|
1996-02-11 19:15:40 +03:00
|
|
|
.Xr sysctl 8
|
1994-05-07 06:52:59 +04:00
|
|
|
.Sh BUGS
|
|
|
|
|
Host names are limited to
|
|
|
|
|
.Dv MAXHOSTNAMELEN
|
|
|
|
|
(from
|
|
|
|
|
.Ao Pa sys/param.h Ac )
|
|
|
|
|
characters, currently 256.
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
function call appeared in
|
|
|
|
|
.Bx 4.2 .
|
