xref: /freebsd/lib/libc/gen/getdomainname.3 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd May 6, 1994
29.Dt GETDOMAINNAME 3
30.Os
31.Sh NAME
32.Nm getdomainname ,
33.Nm setdomainname
34.Nd get/set the NIS domain name of current host
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In unistd.h
39.Ft int
40.Fn getdomainname "char *name" "int namelen"
41.Ft int
42.Fn setdomainname "const char *name" "int namelen"
43.Sh DESCRIPTION
44The
45.Fn getdomainname
46function
47returns the standard NIS domain name for the current host, as
48previously set by
49.Fn setdomainname .
50The
51.Fa namelen
52argument
53specifies the size of the
54.Fa name
55array.
56The returned name is null-terminated unless insufficient
57space is provided.
58.Pp
59The
60.Fn setdomainname
61function
62sets the NIS domain name of the host machine to be
63.Fa name ,
64which has length
65.Fa namelen .
66This call is restricted to the super-user and
67is normally used only when the system is bootstrapped.
68.Sh RETURN VALUES
69.Rv -std
70.Sh ERRORS
71The following errors may be returned by these calls:
72.Bl -tag -width Er
73.It Bq Er EFAULT
74The
75.Fa name
76or
77.Fa namelen
78argument gave an
79invalid address.
80.It Bq Er EPERM
81The caller tried to set the hostname and was not the super-user.
82.El
83.Sh SEE ALSO
84.Xr gethostid 3 ,
85.Xr gethostname 3 ,
86.Xr sysctl 3
87.Sh HISTORY
88The
89.Fn getdomainname
90function appeared in
91.Bx 4.2 .
92.Sh BUGS
93Domain names are limited to
94.Dv MAXHOSTNAMELEN
95(from
96.In sys/param.h )
97characters, currently 256.
98