Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / compat-43 / gethostid.3
blob43cfd82b108ea459028562dd819d17124588ec86
1 .\"     $NetBSD: gethostid.3,v 1.11 2003/04/16 13:34:35 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 .\"     @(#)gethostid.3 8.1 (Berkeley) 6/2/93
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 int
46 .Fn sethostid "long hostid"
47 .Sh DESCRIPTION
48 .Fn sethostid
49 establishes a 32-bit identifier for the current processor that is
50 intended to be unique among all
51 .Ux
52 systems in existence.
53 This is normally a DARPA Internet address for the local machine.
54 This call is allowed only to the super-user and is normally performed
55 at boot time.
56 .Pp
57 .Fn gethostid
58 returns the 32-bit identifier for the current processor.
59 .Pp
60 This function has been deprecated.
61 The hostid should be set or retrieved by use of
62 .Xr sysctl 3 .
63 .Sh SEE ALSO
64 .Xr gethostname 3 ,
65 .Xr sysctl 3 ,
66 .Xr sysctl 8
67 .Sh HISTORY
68 The
69 .Fn gethostid
70 and
71 .Fn sethostid
72 syscalls appeared in
73 .Bx 4.2
74 and were dropped in
75 .Bx 4.4 .
76 .Sh BUGS
77 32 bits for the identifier is too small.