xref: /openbsd-src/lib/libc/gen/uname.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: uname.3,v 1.9 1999/07/02 16:57:48 aaron Exp $
2.\"
3.\" Copyright (c) 1994
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. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd January 4, 1994
35.Dt UNAME 3
36.Os
37.Sh NAME
38.Nm uname
39.Nd get system identification
40.Sh SYNOPSIS
41.Fd #include <sys/utsname.h>
42.Ft int
43.Fn uname "struct utsname *name"
44.Sh DESCRIPTION
45The
46.Fn uname
47function stores null-terminated strings of information identifying
48the current system into the structure referenced by
49.Fa name .
50.Pp
51The
52.Li utsname
53structure is defined in the
54.Aq Pa sys/utsname.h
55header file, and contains the following members:
56.Pp
57.Bl -tag -width nodenameXXXX -offset indent -compact
58.It Fa sysname
59Name of the operating system implementation.
60.It Fa nodename
61Network name of this machine.
62.It Fa release
63Release level of the operating system.
64.It Fa version
65Version level of the operating system.
66.It Fa machine
67Machine hardware platform.
68.El
69.Sh RETURN VALUES
70If
71.Fn uname
72is successful, 0 is returned; otherwise, \-1 is returned and
73.Va errno
74is set appropriately.
75.Sh ERRORS
76The
77.Fn uname
78function may fail and set
79.Va errno
80for any of the errors specified for the library function
81.Xr sysctl 3 .
82.Sh SEE ALSO
83.Xr uname 1 ,
84.Xr sysctl 3
85.Sh STANDARDS
86The
87.Fn uname
88function conforms to
89.St -p1003.1-88 .
90.Sh HISTORY
91The
92.Fn uname
93function first appeared in
94.Bx 4.4 .
95