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