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