man2/getdomainname.2

   1 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified 1997-08-25 by Nicolás Lichtmaier <nick@debian.org>
  26 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  27 .\" Modified 2008-11-27 by mtk
  28 .\"
  29 .TH GETDOMAINNAME 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 getdomainname, setdomainname \- get/set NIS domain name
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <unistd.h>
  35 .PP
  36 .BI "int getdomainname(char *" name ", size_t " len );
  37 .BI "int setdomainname(const char *" name ", size_t " len );
  38 .fi
  39 .PP
  40 .RS -4
  41 Feature Test Macro Requirements for glibc (see
  42 .BR feature_test_macros (7)):
  43 .RE
  44 .PP
  45 .BR getdomainname (),
  46 .BR setdomainname ():
  47 .nf
  48     Since glibc 2.21:
  49 .\"             commit 266865c0e7b79d4196e2cc393693463f03c90bd8
  50         _DEFAULT_SOURCE
  51     In glibc 2.19 and 2.20:
  52         _DEFAULT_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)
  53     Up to and including glibc 2.19:
  54         _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)
  55 .fi
  56 .SH DESCRIPTION
  57 These functions are used to access or to change the NIS domain name of the
  58 host system.
  59 More precisely, they operate on the NIS domain name associated with the calling
  60 process's UTS namespace.
  61 .PP
  62 .BR setdomainname ()
  63 sets the domain name to the value given in the character array
  64 .IR name .
  65 The
  66 .I len
  67 argument specifies the number of bytes in
  68 .IR name .
  69 (Thus,
  70 .I name
  71 does not require a terminating null byte.)
  72 .PP
  73 .BR getdomainname ()
  74 returns the null-terminated domain name in the character array
  75 .IR name ,
  76 which has a length of
  77 .I len
  78 bytes.
  79 If the null-terminated domain name requires more than \fIlen\fP bytes,
  80 .BR getdomainname ()
  81 returns the first \fIlen\fP bytes (glibc) or gives an error (libc).
  82 .SH RETURN VALUE
  83 On success, zero is returned.
  84 On error, \-1 is returned, and
  85 .I errno
  86 is set to indicate the error.
  87 .SH ERRORS
  88 .BR setdomainname ()
  89 can fail with the following errors:
  90 .TP
  91 .B EFAULT
  92 .I name
  93 pointed outside of user address space.
  94 .TP
  95 .B EINVAL
  96 .I len
  97 was negative or too large.
  98 .TP
  99 .B EPERM
 100 The caller did not have the
 101 .B CAP_SYS_ADMIN
 102 capability in the user namespace associated with its UTS namespace (see
 103 .BR namespaces (7)).
 104 .PP
 105 .BR getdomainname ()
 106 can fail with the following errors:
 107 .TP
 108 .B EINVAL
 109 For
 110 .BR getdomainname ()
 111 under libc:
 112 .I name
 113 is NULL or
 114 .I name
 115 is longer than
 116 .I len
 117 bytes.
 118 .SH CONFORMING TO
 119 POSIX does not specify these calls.
 120 .\" But they appear on most systems...
 121 .SH NOTES
 122 Since Linux 1.0, the limit on the length of a domain name,
 123 including the terminating null byte, is 64 bytes.
 124 In older kernels, it was 8 bytes.
 125 .PP
 126 On most Linux architectures (including x86),
 127 there is no
 128 .BR getdomainname ()
 129 system call; instead, glibc implements
 130 .BR getdomainname ()
 131 as a library function that returns a copy of the
 132 .I domainname
 133 field returned from a call to
 134 .BR uname (2).
 135 .SH SEE ALSO
 136 .BR gethostname (2),
 137 .BR sethostname (2),
 138 .BR uname (2),
 139 .BR uts_namespaces (7)