lib/libc/gen/gethostname.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 .\"     $Id$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt GETHOSTNAME 3
  37 .Os BSD 4.2
  38 .Sh NAME
  39 .Nm gethostname ,
  40 .Nm sethostname
  41 .Nd get/set name of current host
  42 .Sh SYNOPSIS
  43 .Fd #include <unistd.h>
  44 .Ft int
  45 .Fn gethostname "char *name" "int namelen"
  46 .Ft int
  47 .Fn sethostname "const char *name" "int namelen"
  48 .Sh DESCRIPTION
  49 .Fn Gethostname
  50 returns the standard host name for the current processor, as
  51 previously set by
  52 .Fn sethostname .
  53 The parameter
  54 .Fa namelen
  55 specifies the size of the
  56 .Fa name
  57 array.  The returned name is null-terminated unless insufficient
  58 space is provided.
  59 .Pp
  60 .Fn Sethostname
  61 sets the name of the host machine to be
  62 .Fa name ,
  63 which has length
  64 .Fa namelen .
  65 This call is restricted to the super-user and
  66 is normally used only when the system is bootstrapped.
  67 .Sh RETURN VALUES
  68 If the call succeeds a value of 0 is returned.  If the call
  69 fails, a value of -1 is returned and an error code is
  70 placed in the global location
  71 .Va errno .
  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 sysctl 3
  88 .Sh BUGS
  89 Host 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 gethostname
  97 function call appeared in
  98 .Bx 4.2 .