xref: /minix3/lib/libc/gen/uname.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1.\"	$NetBSD: uname.3,v 1.13 2014/06/14 14:32:43 apb 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. 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.\"	@(#)uname.3	8.1 (Berkeley) 1/4/94
31.\"
32.Dd June 14, 2014
33.Dt UNAME 3
34.Os
35.Sh NAME
36.Nm uname
37.Nd get system identification
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In sys/utsname.h
42.Ft int
43.Fn uname "struct utsname *name"
44.Sh DESCRIPTION
45The
46.Fn uname
47function stores nul-terminated strings of information identifying
48the current system into the structure referenced by
49.Fa name .
50.Pp
51The
52.Em utsname
53structure is defined in the
54.In sys/utsname.h
55header file, and contains the following members:
56.Bl -tag -width nodenameXXXX -offset indent
57.It Va sysname
58Name of the operating system implementation.
59Equivalent to the
60.Xr sysctl 7
61.Va kern.ostype
62variable.
63.It Va nodename
64Network name of this machine.
65Equivalent to the
66.Xr sysctl 7
67.Va kern.hostname
68variable.
69.It Va release
70Release level of the operating system.
71Equivalent to the
72.Xr sysctl 7
73.Va kern.osrelease
74variable.
75.It Va version
76Version level of the operating system.
77Equivalent to the
78.Xr sysctl 7
79.Va kern.version
80variable, except that very long values are truncated,
81and newlines are converted to spaces.
82.It Va machine
83Machine hardware platform.
84Equivalent to the
85.Xr sysctl 7
86.Va hw.machine
87variable.
88.El
89.Sh RETURN VALUES
90If
91.Nm uname
92is successful, 0 is returned, otherwise, \-1 is returned and
93.Va errno
94is set appropriately.
95.Sh ERRORS
96The
97.Fn uname
98function may fail and set
99.Va errno
100for any of the errors specified for the library functions
101.Xr sysctl 3 .
102.Sh SEE ALSO
103.Xr uname 1 ,
104.Xr sysctl 3
105.Sh STANDARDS
106The
107.Fn uname
108function conforms to
109.St -p1003.1-90 .
110.Sh HISTORY
111The
112.Nm uname
113function first appeared in
114.Bx 4.4 .
115