Annotation of src/lib/libc/gen/getdomainname.3, Revision 1.15
1.15 ! agc 1: .\" $NetBSD: getdomainname.3,v 1.14 2003/04/16 13:34:36 wiz 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: .\"
1.2 cgd 30: .\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93
1.1 cgd 31: .\"
32: .Dd May 6, 1994
33: .Dt GETDOMAINNAME 3
1.8 garbled 34: .Os
1.1 cgd 35: .Sh NAME
36: .Nm getdomainname ,
37: .Nm setdomainname
38: .Nd get/set domain name of current host
1.4 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.5 kleink 44: .Fn getdomainname "char *name" "size_t namelen"
1.1 cgd 45: .Ft int
1.5 kleink 46: .Fn setdomainname "const char *name" "size_t namelen"
1.1 cgd 47: .Sh DESCRIPTION
1.7 lukem 48: .Fn getdomainname
1.1 cgd 49: returns the standard domain name for the current processor, as
50: previously set by
51: .Fn setdomainname .
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 setdomainname
1.1 cgd 61: sets the domain 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
73: The following errors may be returned by these calls:
74: .Bl -tag -width Er
75: .It Bq Er EFAULT
76: The
77: .Fa name
78: or
79: .Fa namelen
80: parameter gave an
81: invalid address.
82: .It Bq Er EPERM
1.6 kleink 83: The caller tried to set the domain name and was not the super-user.
1.1 cgd 84: .El
85: .Sh SEE ALSO
86: .Xr gethostid 3 ,
1.3 mikel 87: .Xr gethostname 3 ,
88: .Xr sysctl 3
1.10 wiz 89: .Sh HISTORY
90: The
91: .Nm
92: function call appeared in
93: .Bx 4.2 .
1.1 cgd 94: .Sh BUGS
1.6 kleink 95: Domain names are limited to
1.1 cgd 96: .Dv MAXHOSTNAMELEN
97: (from
98: .Ao Pa sys/param.h Ac )
1.5 kleink 99: characters including null-termination, currently 256.
CVSweb <webmaster@jp.NetBSD.org>