xref: /freebsd/lib/libc/gen/getdomainname.3 (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
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.\"     @(#)gethostname.3	8.1 (Berkeley) 6/4/93
29.\"
30.Dd May 6, 1994
31.Dt GETDOMAINNAME 3
32.Os
33.Sh NAME
34.Nm getdomainname ,
35.Nm setdomainname
36.Nd get/set the NIS domain name of current host
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In unistd.h
41.Ft int
42.Fn getdomainname "char *name" "int namelen"
43.Ft int
44.Fn setdomainname "const char *name" "int namelen"
45.Sh DESCRIPTION
46The
47.Fn getdomainname
48function
49returns the standard NIS domain name for the current host, as
50previously set by
51.Fn setdomainname .
52The
53.Fa namelen
54argument
55specifies the size of the
56.Fa name
57array.
58The returned name is null-terminated unless insufficient
59space is provided.
60.Pp
61The
62.Fn setdomainname
63function
64sets the NIS 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
71.Rv -std
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
80argument 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 HISTORY
90The
91.Fn getdomainname
92function appeared in
93.Bx 4.2 .
94.Sh BUGS
95Domain names are limited to
96.Dv MAXHOSTNAMELEN
97(from
98.In sys/param.h )
99characters, currently 256.
100