Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / compat-43 / gethostid.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 .\"     @(#)gethostid.3 8.1 (Berkeley) 6/2/93
33 .\" $FreeBSD: src/lib/libc/compat-43/gethostid.3,v 1.5.2.6 2003/03/15 15:11:05 trhodes Exp $
34 .\"
35 .Dd June 2, 1993
36 .Dt GETHOSTID 3
37 .Os
38 .Sh NAME
39 .Nm gethostid ,
40 .Nm sethostid
41 .Nd get/set unique identifier of current host
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In unistd.h
46 .Ft long
47 .Fn gethostid void
48 .Ft void
49 .Fn sethostid "long hostid"
50 .Sh DESCRIPTION
51 The
52 .Fn sethostid
53 function
54 establishes a 32-bit identifier for the
55 current processor that is intended to be unique among all
56 UNIX systems in existence.  This is normally a DARPA Internet
57 address for the local machine.  This call is allowed only to the
58 super-user and is normally performed at boot time.
59 .Pp
60 The
61 .Fn gethostid
62 function
63 returns the 32-bit identifier for the current processor.
64 .Pp
65 This function has been deprecated.
66 The hostid should be set or retrieved by use of
67 .Xr sysctl 3 .
68 .Sh SEE ALSO
69 .Xr gethostname 3 ,
70 .Xr sysctl 3 ,
71 .Xr sysctl 8
72 .Sh BUGS
73 32 bits for the identifier is too small.
74 .Sh HISTORY
75 The
76 .Fn gethostid
77 and
78 .Fn sethostid
79 syscalls appeared in
80 .Bx 4.2
81 and were dropped in
82 .Bx 4.4 .