xref: /netbsd/lib/libc/gen/uname.3 (revision bf9ec67e)
1.\"	$NetBSD: uname.3,v 1.7 2002/02/07 07:00:18 ross 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 LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include \*[Lt]sys/utsname.h\*[Gt]
46.Ft int
47.Fn uname "struct utsname *name"
48.Sh DESCRIPTION
49The
50.Fn uname
51function stores nul-terminated strings of information identifying
52the current system into the structure referenced by
53.Fa name .
54.Pp
55The
56.Li utsname
57structure is defined in the
58.Li \*[Lt]sys/utsname.h\*[Gt]
59header file, and contains the following members:
60.Bl -tag -width nodenameXXXX -offset indent
61.It sysname
62Name of the operating system implementation.
63.It nodename
64Network name of this machine.
65.It release
66Release level of the operating system.
67.It version
68Version level of the operating system.
69.It machine
70Machine hardware platform.
71.El
72.Sh RETURN VALUES
73If
74.Nm uname
75is successful, 0 is returned, otherwise, -1 is returned and
76.Va errno
77is set appropriately.
78.Sh ERRORS
79The
80.Fn uname
81function may fail and set
82.Va errno
83for any of the errors specified for the library functions
84.Xr sysctl 3 .
85.Sh SEE ALSO
86.Xr uname 1 ,
87.Xr sysctl 3
88.Sh STANDARDS
89The
90.Fn uname
91function conforms to
92.St -p1003.1-90 .
93.Sh HISTORY
94The
95.Nm uname
96function first appeared in
97.Bx 4.4 .
98