xref: /netbsd/lib/libc/gen/getdomainname.3 (revision bf9ec67e)
1.\"	$NetBSD: getdomainname.3,v 1.11 2002/02/07 07:00:12 ross Exp $
2.\"
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 May 6, 1994
37.Dt GETDOMAINNAME 3
38.Os
39.Sh NAME
40.Nm getdomainname ,
41.Nm setdomainname
42.Nd get/set domain name of current host
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.Fd #include \*[Lt]unistd.h\*[Gt]
47.Ft int
48.Fn getdomainname "char *name" "size_t namelen"
49.Ft int
50.Fn setdomainname "const char *name" "size_t namelen"
51.Sh DESCRIPTION
52.Fn getdomainname
53returns the standard domain name for the current processor, as
54previously set by
55.Fn setdomainname .
56The parameter
57.Fa namelen
58specifies the size of the
59.Fa name
60array.  The returned name is null-terminated unless insufficient
61space is provided.
62.Pp
63.Fn setdomainname
64sets the domain name of the host machine to be
65.Fa name ,
66which has length
67.Fa namelen .
68This call is restricted to the super-user and
69is normally used only when the system is bootstrapped.
70.Sh RETURN VALUES
71If the call succeeds a value of 0 is returned.  If the call
72fails, a value of -1 is returned and an error code is
73placed in the global location
74.Va errno .
75.Sh ERRORS
76The following errors may be returned by these calls:
77.Bl -tag -width Er
78.It Bq Er EFAULT
79The
80.Fa name
81or
82.Fa namelen
83parameter gave an
84invalid address.
85.It Bq Er EPERM
86The caller tried to set the domain name and was not the super-user.
87.El
88.Sh SEE ALSO
89.Xr gethostid 3 ,
90.Xr gethostname 3 ,
91.Xr sysctl 3
92.Sh HISTORY
93The
94.Nm
95function call appeared in
96.Bx 4.2 .
97.Sh BUGS
98Domain names are limited to
99.Dv MAXHOSTNAMELEN
100(from
101.Ao Pa sys/param.h Ac )
102characters including null-termination, currently 256.
103