d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
32d52c275d
freebsd-dev/lib/libc/gen/gethostname.3

132 lines
3.6 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)gethostname.3 8.1 (Berkeley) 6/4/93
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.\"
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.Dd August 18, 2003
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Dt GETHOSTNAME 3
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 13:41:46 +00:00
.Os
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh NAME
.Nm gethostname ,
.Nm sethostname
.Nd get/set name of current host
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In unistd.h
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Ft int
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.Fn gethostname "char *name" "size_t namelen"
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Ft int
.Fn sethostname "const char *name" "int namelen"
.Sh DESCRIPTION
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
The
.Fn gethostname
function
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
returns the standard host name for the current processor, as
previously set by
.Fn sethostname .
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
The
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fa namelen
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
argument
Whitespace only change: trim trailing whitespace.
2000-10-30 13:23:19 +00:00
specifies the size of the
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Fa name
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
array.
The returned name is null-terminated unless insufficient space is provided.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Pp
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
The
.Fn sethostname
function
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
sets the name of the host machine to be
.Fa name ,
which has length
.Fa namelen .
This call is restricted to the super-user and
is normally used only when the system is bootstrapped.
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.Pp
Host names are limited to
.Brq Dv HOST_NAME_MAX
characters, not including the trailing null, currently 255.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh RETURN VALUES
Use ``.Rv -std'' wherever possible. Submitted by: yar
2001-08-31 09:57:38 +00:00
.Rv -std
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh ERRORS
The following errors may be returned by these calls:
.Bl -tag -width Er
.It Bq Er EFAULT
The
.Fa name
or
.Fa namelen
mdoc(7) police: "The .Fa argument.".
2002-12-19 09:40:28 +00:00
argument gave an
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
invalid address.
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.It Bq Er ENAMETOOLONG
The current host name is longer than
Eliminate double whitespace.
2004-07-03 22:30:10 +00:00
.Fa namelen .
(For
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.Fn gethostname
only.)
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.It Bq Er EPERM
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
The caller tried to set the host name and was not the super-user.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.El
.Sh SEE ALSO
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.Xr sysconf 3 ,
Correct a bunch of man page cross references and generally try and silence "manck". ncurses, rpc, and some of the gnu stuff are still a big mess, however.
1996-02-11 22:38:05 +00:00
.Xr sysctl 3
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
.Sh STANDARDS
The
.Fn gethostname
function conforms to
.St -p1003.1-2001 .
Callers should be aware that
.Brq Dv HOST_NAME_MAX
may be variable or infinite, but is guaranteed to be no less than
.Brq Dv _POSIX_HOST_NAME_MAX .
On older systems, this limit was defined in the non-standard header
mdoc(7): Use the new feature of the .In macro.
2003-09-08 19:57:22 +00:00
.In sys/param.h
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
as
.Dv MAXHOSTNAMELEN ,
and counted the terminating null.
The
.Fn sethostname
function and the error returns for
.Fn gethostname
are not standardized.
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Sh HISTORY
The
Update a bunch of man pages to use .Fn instead of .Nm when referencing funciton names.
1996-08-22 22:05:59 +00:00
.Fn gethostname
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
function appeared in
BSD 4.4 Lite Lib Sources
1994-05-27 05:00:24 +00:00
.Bx 4.2 .
Change gethostname() to set errno to ENAMETOOLONG instead of ENOMEM when the buffer is not long enough to hold the current host name. POSIX does not standardize error returns for gethostname(), so it doesn't matter which one we use, but ENAMETOOLONG is at least a little more intuitive, and mi suggests the existence of prior art. I've been running with this change for a while on my home machine with no effect. At the same time, I've updated the prototype for gethostname() to use the correct standard type (size_t) for the namelen argument. All of the in-tree callers fall into one of the following categories: 1) Call perror() or equivalent when gethostname() fails. 2) Ignore gethostname()'s return value entirely, potentially resulting in data corruption if the buffer is too small. 3) Fall back to a (possibly sensible) default value if gethostname() fails. Many of the callers I examined shows signs of confusion about the correct sizing of the host name buffer. gethostname(3) now has more information about this, as well as updated standards information. PR: 48114 Submitted by: mi (in part)
2003-08-19 20:38:44 +00:00
The
.Fa namelen
argument to
.Fn gethostname
was changed to
.Vt size_t
in
.Fx 5.2
for alignment with
.St -p1003.1-2001 .
Reference in New Issue Copy Permalink