BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / gethostname.2

diff --git a/usr/src/lib/libc/sys/gethostname.2 b/usr/src/lib/libc/sys/gethostname.2
index efc6439..19b5e2c 100644 (file)
--- a/usr/src/lib/libc/sys/gethostname.2
+++ b/usr/src/lib/libc/sys/gethostname.2
@@ -1,73 +1,96 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"    @(#)gethostname.2       6.6 (Berkeley) 6/23/90
+.\" 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.

 .\"
 .\"

-.TH GETHOSTNAME 2 "June 23, 1990"
-.UC 5
-.SH NAME
-gethostname, sethostname \- get/set name of current host
-.SH SYNOPSIS
-.nf
-.ft B
-gethostname(name, namelen)
-char *name;
-int namelen;
-.PP
-.ft B
-sethostname(name, namelen)
-char *name;
-int namelen;
-.fi
-.SH DESCRIPTION
-.I Gethostname
+.\"     @(#)gethostname.2      6.7 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt GETHOSTNAME 2
+.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
 returns the standard host name for the current processor, as
 previously set by

-.IR sethostname . 
+.Fn sethostname .

 The parameter
 The parameter

-.I namelen
+.Fa namelen

 specifies the size of the 
 specifies the size of the 

-.I name
+.Fa name

 array.  The returned name is null-terminated unless insufficient
 space is provided.
 array.  The returned name is null-terminated unless insufficient
 space is provided.

-.PP
-.I Sethostname
+.Pp
+.Fn Sethostname

 sets the name of the host machine to be
 sets the name of the host machine to be

-.IR name ,
+.Fa name ,

 which has length
 which has length

-.IR namelen .
+.Fa namelen .

 This call is restricted to the super-user and
 is normally used only when the system is bootstrapped.
 This call is restricted to the super-user and
 is normally used only when the system is bootstrapped.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

 If the call succeeds a value of 0 is returned.  If the call
 If the call succeeds a value of 0 is returned.  If the call

-fails, then a value of \-1 is returned and an error code is
-placed in the global location \fIerrno\fP.
-.SH "ERRORS
+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:
 The following errors may be returned by these calls:

-.TP 15
-[EFAULT]
-The \fIname\fP or \fInamelen\fP parameter gave an
+.Bl -tag -width Er
+.It Bq Er EFAULT
+The
+.Fa name
+or
+.Fa namelen
+parameter gave an

 invalid address.
 invalid address.

-.TP 15
-[EPERM]
+.It Bq Er EPERM

 The caller tried to set the hostname and was not the super-user.
 The caller tried to set the hostname and was not the super-user.

-.SH SEE ALSO
-gethostid(2)
-.SH BUGS
-Host names are limited to MAXHOSTNAMELEN (from
-.IR <sys/param.h> )
+.El
+.Sh SEE ALSO
+.Xr gethostid 2
+.Sh BUGS
+Host names are limited to
+.Dv MAXHOSTNAMELEN
+(from
+.Ao Pa sys/param.h Ac )

 characters, currently 64.
 characters, currently 64.

+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .