xref: /freebsd/lib/libc/gen/uname.3 (revision 6780ab54325a71e7e70112b11657973edde8655e)
1.\" Copyright (c) 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)uname.3	8.1 (Berkeley) 1/4/94
33.\" $FreeBSD$
34.\"
35.Dd January 4, 1994
36.Dt UNAME 3
37.Os
38.Sh NAME
39.Nm uname
40.Nd get system identification
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In sys/utsname.h
45.Ft int
46.Fn uname "struct utsname *name"
47.Sh DESCRIPTION
48The
49.Fn uname
50function stores
51.Dv NUL Ns -terminated
52strings of information identifying
53the current system into the structure referenced by
54.Fa name .
55.Pp
56The
57.Vt utsname
58structure is defined in the
59.Aq Pa sys/utsname.h
60header file, and contains the following members:
61.Bl -tag -width nodenameXXXX -offset indent
62.It sysname
63Name of the operating system implementation.
64.It nodename
65Network name of this machine.
66.It release
67Release level of the operating system.
68.It version
69Version level of the operating system.
70.It machine
71Machine hardware platform.
72.El
73.Sh RETURN VALUES
74.Rv -std uname
75.Sh ERRORS
76The
77.Fn uname
78function may fail and set
79.Va errno
80for any of the errors specified for the library functions
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