Annotation of src/lib/libc/gen/gethostname.3, Revision 1.17
1.17 ! wiz 1: .\" $NetBSD: gethostname.3,v 1.16 2005/10/14 23:53:41 christos Exp $
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.
1.15 agc 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 cgd 15: .\" may be used to endorse or promote products derived from this software
16: .\" without specific prior written permission.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28: .\" SUCH DAMAGE.
29: .\"
30: .\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93
31: .\"
1.16 christos 32: .Dd October 14, 2005
1.1 cgd 33: .Dt GETHOSTNAME 3
1.8 garbled 34: .Os
1.1 cgd 35: .Sh NAME
36: .Nm gethostname ,
37: .Nm sethostname
38: .Nd get/set name of current host
1.5 perry 39: .Sh LIBRARY
40: .Lb libc
1.1 cgd 41: .Sh SYNOPSIS
1.14 wiz 42: .In unistd.h
1.1 cgd 43: .Ft int
1.6 kleink 44: .Fn gethostname "char *name" "size_t namelen"
1.1 cgd 45: .Ft int
1.6 kleink 46: .Fn sethostname "const char *name" "size_t namelen"
1.1 cgd 47: .Sh DESCRIPTION
1.7 lukem 48: .Fn gethostname
1.1 cgd 49: returns the standard host name for the current processor, as
50: previously set by
51: .Fn sethostname .
52: The parameter
53: .Fa namelen
1.9 wiz 54: specifies the size of the
1.1 cgd 55: .Fa name
1.12 wiz 56: array.
57: The returned name is null-terminated unless insufficient
1.1 cgd 58: space is provided.
59: .Pp
1.7 lukem 60: .Fn sethostname
1.1 cgd 61: sets the name of the host machine to be
62: .Fa name ,
63: which has length
64: .Fa namelen .
65: This call is restricted to the super-user and
66: is normally used only when the system is bootstrapped.
67: .Sh RETURN VALUES
1.12 wiz 68: If the call succeeds a value of 0 is returned.
1.13 wiz 69: If the call fails, a value of \-1 is returned and an error code is
1.1 cgd 70: placed in the global location
71: .Va errno .
72: .Sh ERRORS
1.16 christos 73: If the
1.17 ! wiz 74: .Fn gethostname
! 75: or
! 76: .Fn sethostname
1.16 christos 77: functions fail,
78: they will set
79: .Va errno
80: for any of the errors specified for the routine
81: .Xr sysctl 3 .
1.1 cgd 82: .Sh SEE ALSO
1.10 wiz 83: .Xr gethostid 3 ,
1.4 jtc 84: .Xr sysctl 3 ,
1.3 neil 85: .Xr sysctl 8
1.6 kleink 86: .Sh STANDARDS
87: The
88: .Fn gethostname
89: function conforms to
90: .St -xpg4.2 .
1.10 wiz 91: .Sh HISTORY
92: The
93: .Nm
94: function call appeared in
95: .Bx 4.2 .
1.1 cgd 96: .Sh BUGS
97: Host names are limited to
98: .Dv MAXHOSTNAMELEN
99: (from
100: .Ao Pa sys/param.h Ac )
1.6 kleink 101: characters including null-termination, currently 256.
CVSweb <webmaster@jp.NetBSD.org>