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