xref: /freebsd/lib/libc/gen/uname.3 (revision 87569f75a91f298c52a71823c04d41cf53c88889)
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 December 2, 2005
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.In 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 ENVIRONMENT
76.Bl -tag -width ".Ev UNAME_s"
77.It Ev UNAME_s
78If the environment variable
79.Ev UNAME_s
80is set, it will override the
81.Va sysname
82member.
83.It Ev UNAME_r
84If the environment variable
85.Ev UNAME_r
86is set, it will override the
87.Va release
88member.
89.It Ev UNAME_v
90If the environment variable
91.Ev UNAME_v
92is set, it will override the
93.Va version
94member.
95.It Ev UNAME_m
96If the environment variable
97.Ev UNAME_m
98is set, it will override the
99.Va machine
100member.
101.El
102.Sh ERRORS
103The
104.Fn uname
105function may fail and set
106.Va errno
107for any of the errors specified for the library functions
108.Xr sysctl 3 .
109.Sh SEE ALSO
110.Xr uname 1 ,
111.Xr sysctl 3
112.Sh STANDARDS
113The
114.Fn uname
115function conforms to
116.St -p1003.1-88 .
117.Sh HISTORY
118The
119.Fn uname
120function first appeared in
121.Bx 4.4 .
122