lib/libc/gen/getdomainname.3

   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: src/lib/libc/gen/getdomainname.3,v 1.9.2.5 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/getdomainname.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd May 6, 1994
  37 .Dt GETDOMAINNAME 3
  38 .Os
  39 .Sh NAME
  40 .Nm getdomainname ,
  41 .Nm setdomainname
  42 .Nd get/set domain name of current host
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft int
  48 .Fn getdomainname "char *name" "int namelen"
  49 .Ft int
  50 .Fn setdomainname "const char *name" "int namelen"
  51 .Sh DESCRIPTION
  52 .Fn Getdomainname
  53 returns the standard domain name for the current processor, as
  54 previously set by
  55 .Fn setdomainname .
  56 The parameter
  57 .Fa namelen
  58 specifies the size of the
  59 .Fa name
  60 array.  The returned name is null-terminated unless insufficient
  61 space is provided.
  62 .Pp
  63 .Fn Setdomainname
  64 sets the domain name of the host machine to be
  65 .Fa name ,
  66 which has length
  67 .Fa namelen .
  68 This call is restricted to the super-user and
  69 is normally used only when the system is bootstrapped.
  70 .Sh RETURN VALUES
  71 .Rv -std
  72 .Sh ERRORS
  73 The following errors may be returned by these calls:
  74 .Bl -tag -width Er
  75 .It Bq Er EFAULT
  76 The
  77 .Fa name
  78 or
  79 .Fa namelen
  80 parameter gave an
  81 invalid address.
  82 .It Bq Er EPERM
  83 The 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 BUGS
  90 Domain names are limited to
  91 .Dv MAXHOSTNAMELEN
  92 (from
  93 .Ao Pa sys/param.h Ac )
  94 characters, currently 256.
  95 .Sh HISTORY
  96 The
  97 .Fn getdomainname
  98 function call appeared in
  99 .Bx 4.2 .