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