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