xref: /freebsd/lib/libc/gen/getdomainname.3 (revision 952d112864d8008aa87278a30a539d888a8493cd)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)gethostname.3	8.1 (Berkeley) 6/4/93
33.\"	$Id$
34.\"
35.Dd May 6, 1994
36.Dt GETDOMAINNAME 3
37.Os BSD 4.2
38.Sh NAME
39.Nm getdomainname ,
40.Nm setdomainname
41.Nd get/set domain name of current host
42.Sh SYNOPSIS
43.Fd #include <unistd.h>
44.Ft int
45.Fn getdomainname "char *name" "int namelen"
46.Ft int
47.Fn setdomainname "const char *name" "int namelen"
48.Sh DESCRIPTION
49.Fn Getdomainname
50returns the standard domain name for the current processor, as
51previously set by
52.Fn setdomainname .
53The parameter
54.Fa namelen
55specifies the size of the
56.Fa name
57array.  The returned name is null-terminated unless insufficient
58space is provided.
59.Pp
60.Fn Setdomainname
61sets the domain name of the host machine to be
62.Fa name ,
63which has length
64.Fa namelen .
65This call is restricted to the super-user and
66is normally used only when the system is bootstrapped.
67.Sh RETURN VALUES
68If the call succeeds a value of 0 is returned.  If the call
69fails, a value of -1 is returned and an error code is
70placed in the global location
71.Va errno .
72.Sh ERRORS
73The following errors may be returned by these calls:
74.Bl -tag -width Er
75.It Bq Er EFAULT
76The
77.Fa name
78or
79.Fa namelen
80parameter gave an
81invalid address.
82.It Bq Er EPERM
83The caller tried to set the hostname and was not the super-user.
84.El
85.Sh SEE ALSO
86.Xr gethostid 3 ,
87.Xr gethostname 3 ,
88.Xr sysctl 3
89.Sh BUGS
90Domain names are limited to
91.Dv MAXHOSTNAMELEN
92(from
93.Ao Pa sys/param.h Ac )
94characters, currently 256.
95.Sh HISTORY
96The
97.Fn getdomainname
98function call appeared in
99.Bx 4.2 .
100