lib/libc/gen/gethostname.3

   1 .\"     $NetBSD: gethostname.3,v 1.17 2006/02/07 18:59:56 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)gethostname.3       8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd October 14, 2005
  33 .Dt GETHOSTNAME 3
  34 .Os
  35 .Sh NAME
  36 .Nm gethostname ,
  37 .Nm sethostname
  38 .Nd get/set name of current host
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In unistd.h
  43 .Ft int
  44 .Fn gethostname "char *name" "size_t namelen"
  45 .Ft int
  46 .Fn sethostname "const char *name" "size_t namelen"
  47 .Sh DESCRIPTION
  48 .Fn gethostname
  49 returns the standard host name for the current processor, as
  50 previously set by
  51 .Fn sethostname .
  52 The parameter
  53 .Fa namelen
  54 specifies the size of the
  55 .Fa name
  56 array.
  57 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.
  69 If the call 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 If the
  74 .Fn gethostname
  75 or
  76 .Fn sethostname
  77 functions fail,
  78 they will set
  79 .Va errno
  80 for any of the errors specified for the routine
  81 .Xr sysctl 3 .
  82 .Sh SEE ALSO
  83 .Xr gethostid 3 ,
  84 .Xr sysctl 3 ,
  85 .Xr sysctl 8
  86 .Sh STANDARDS
  87 The
  88 .Fn gethostname
  89 function conforms to
  90 .St -xpg4.2 .
  91 .Sh HISTORY
  92 The
  93 .Nm
  94 function call appeared in
  95 .Bx 4.2 .
  96 .Sh BUGS
  97 Host names are limited to
  98 .Dv MAXHOSTNAMELEN
  99 (from
 100 .Ao Pa sys/param.h Ac )
 101 characters including null-termination, currently 256.