Return to gethostname.3 CVS log

Up to [cvs.NetBSD.org] / src / lib / libc / gen

Annotation of src/lib/libc/gen/gethostname.3, Revision 1.8.12.4

1.8.12.4! nathanw     1: .\"    $NetBSD$
1.2       cgd         2: .\"
1.1       cgd         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
1.8       garbled    38: .Os
1.1       cgd        39: .Sh NAME
                     40: .Nm gethostname ,
                     41: .Nm sethostname
                     42: .Nd get/set name of current host
1.5       perry      43: .Sh LIBRARY
                     44: .Lb libc
1.1       cgd        45: .Sh SYNOPSIS
1.8.12.2  nathanw    46: .Fd #include \*[Lt]unistd.h\*[Gt]
1.1       cgd        47: .Ft int
1.6       kleink     48: .Fn gethostname "char *name" "size_t namelen"
1.1       cgd        49: .Ft int
1.6       kleink     50: .Fn sethostname "const char *name" "size_t namelen"
1.1       cgd        51: .Sh DESCRIPTION
1.7       lukem      52: .Fn gethostname
1.1       cgd        53: returns the standard host name for the current processor, as
                     54: previously set by
                     55: .Fn sethostname .
                     56: The parameter
                     57: .Fa namelen
1.8.12.1  nathanw    58: specifies the size of the
1.1       cgd        59: .Fa name
1.8.12.4! nathanw    60: array.
        !            61: The returned name is null-terminated unless insufficient
1.1       cgd        62: space is provided.
                     63: .Pp
1.7       lukem      64: .Fn sethostname
1.1       cgd        65: sets the name of the host machine to be
                     66: .Fa name ,
                     67: which has length
                     68: .Fa namelen .
                     69: This call is restricted to the super-user and
                     70: is normally used only when the system is bootstrapped.
                     71: .Sh RETURN VALUES
1.8.12.4! nathanw    72: If the call succeeds a value of 0 is returned.
        !            73: If the call fails, a value of \-1 is returned and an error code is
1.1       cgd        74: placed in the global location
                     75: .Va errno .
                     76: .Sh ERRORS
                     77: The following errors may be returned by these calls:
                     78: .Bl -tag -width Er
                     79: .It Bq Er EFAULT
                     80: The
                     81: .Fa name
                     82: or
                     83: .Fa namelen
                     84: parameter gave an
                     85: invalid address.
                     86: .It Bq Er EPERM
                     87: The caller tried to set the hostname and was not the super-user.
                     88: .El
                     89: .Sh SEE ALSO
1.4       jtc        90: .Xr gethostid 3 ,
1.8.12.1  nathanw    91: .Xr sysctl 3 ,
1.3       neil       92: .Xr sysctl 8
1.6       kleink     93: .Sh STANDARDS
                     94: The
                     95: .Fn gethostname
                     96: function conforms to
                     97: .St -xpg4.2 .
1.8.12.1  nathanw    98: .Sh HISTORY
                     99: The
                    100: .Nm
                    101: function call appeared in
                    102: .Bx 4.2 .
1.1       cgd       103: .Sh BUGS
                    104: Host names are limited to
                    105: .Dv MAXHOSTNAMELEN
                    106: (from
                    107: .Ao Pa sys/param.h Ac )
1.6       kleink    108: characters including null-termination, currently 256.