xref: /netbsd-src/lib/libc/gen/uname.3 (revision fdecd6a253f999ae92b139670d9e15cc9df4497c)
1.\"	$NetBSD: uname.3,v 1.3 1997/05/29 01:48:18 cgd 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.\"	@(#)uname.3	8.1 (Berkeley) 1/4/94
35.\"
36.Dd January 4, 1994
37.Dt UNAME 3
38.Os
39.Sh NAME
40.Nm uname
41.Nd get system identification
42.Sh SYNOPSIS
43.Fd #include <sys/utsname.h>
44.Ft int
45.Fn uname "struct utsname *name"
46.Sh DESCRIPTION
47The
48.Fn uname
49function stores nul-terminated strings of information identifying
50the current system into the structure referenced by
51.Fa name .
52.Pp
53The
54.Li utsname
55structure is defined in the
56.Li <sys/utsname.h>
57header file, and contains the following members:
58.Bl -tag -width nodenameXXXX -offset indent
59.It sysname
60Name of the operating system implementation.
61.It nodename
62Network name of this machine.
63.It release
64Release level of the operating system.
65.It version
66Version level of the operating system.
67.It machine
68Machine hardware platform.
69.El
70.Sh RETURN VALUES
71If
72.Nm uname
73is successful, 0 is returned, otherwise, -1 is returned and
74.Va errno
75is set appropriately.
76.Sh ERRORS
77The
78.Fn uname
79function may fail and set
80.Va errno
81for any of the errors specified for the library functions
82.Xr sysctl 3 .
83.Sh SEE ALSO
84.Xr uname 1 ,
85.Xr sysctl 3
86.Sh STANDARDS
87The
88.Fn uname
89function conforms to
90.St -p1003.1-88 .
91.Sh HISTORY
92The
93.Nm uname
94function first appeared in 4.4BSD.
95