xref: /freebsd/lib/libc/gen/uname.3 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd December 2, 2005
29.Dt UNAME 3
30.Os
31.Sh NAME
32.Nm uname
33.Nd get system identification
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/utsname.h
38.Ft int
39.Fn uname "struct utsname *name"
40.Sh DESCRIPTION
41The
42.Fn uname
43function stores
44.Dv NUL Ns -terminated
45strings of information identifying
46the current system into the structure referenced by
47.Fa name .
48.Pp
49The
50.Vt utsname
51structure is defined in the
52.In sys/utsname.h
53header file, and contains the following members:
54.Bl -tag -width nodenameXXXX -offset indent
55.It sysname
56Name of the operating system implementation.
57.It nodename
58Network name of this machine.
59.It release
60Release level of the operating system.
61.It version
62Version level of the operating system.
63.It machine
64Machine hardware platform.
65.El
66.Sh RETURN VALUES
67.Rv -std uname
68.Sh ENVIRONMENT
69.Bl -tag -width ".Ev UNAME_s"
70.It Ev UNAME_s
71If the environment variable
72.Ev UNAME_s
73is set, it will override the
74.Va sysname
75member.
76.It Ev UNAME_r
77If the environment variable
78.Ev UNAME_r
79is set, it will override the
80.Va release
81member.
82.It Ev UNAME_v
83If the environment variable
84.Ev UNAME_v
85is set, it will override the
86.Va version
87member.
88.It Ev UNAME_m
89If the environment variable
90.Ev UNAME_m
91is set, it will override the
92.Va machine
93member.
94.El
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-88 .
110.Sh HISTORY
111The
112.Fn uname
113function first appeared in
114.Bx 4.4 .
115