xref: /freebsd/lib/libc/gen/getdomainname.3 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
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.\" $FreeBSD$
34.\"
35.Dd May 6, 1994
36.Dt GETDOMAINNAME 3
37.Os
38.Sh NAME
39.Nm getdomainname ,
40.Nm setdomainname
41.Nd get/set the NIS domain name of current host
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In unistd.h
46.Ft int
47.Fn getdomainname "char *name" "int namelen"
48.Ft int
49.Fn setdomainname "const char *name" "int namelen"
50.Sh DESCRIPTION
51The
52.Fn getdomainname
53function
54returns the standard NIS domain name for the current host, as
55previously set by
56.Fn setdomainname .
57The
58.Fa namelen
59argument
60specifies the size of the
61.Fa name
62array.
63The returned name is null-terminated unless insufficient
64space is provided.
65.Pp
66The
67.Fn setdomainname
68function
69sets the NIS domain name of the host machine to be
70.Fa name ,
71which has length
72.Fa namelen .
73This call is restricted to the super-user and
74is normally used only when the system is bootstrapped.
75.Sh RETURN VALUES
76.Rv -std
77.Sh ERRORS
78The following errors may be returned by these calls:
79.Bl -tag -width Er
80.It Bq Er EFAULT
81The
82.Fa name
83or
84.Fa namelen
85argument gave an
86invalid address.
87.It Bq Er EPERM
88The caller tried to set the hostname and was not the super-user.
89.El
90.Sh SEE ALSO
91.Xr gethostid 3 ,
92.Xr gethostname 3 ,
93.Xr sysctl 3
94.Sh BUGS
95Domain names are limited to
96.Dv MAXHOSTNAMELEN
97(from
98.In sys/param.h )
99characters, currently 256.
100.Sh HISTORY
101The
102.Fn getdomainname
103function appeared in
104.Bx 4.2 .
105