xref: /freebsd/lib/libc/gen/uname.3 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.\"	@(#)uname.3	8.1 (Berkeley) 1/4/94
29.\"
30.Dd December 2, 2005
31.Dt UNAME 3
32.Os
33.Sh NAME
34.Nm uname
35.Nd get system identification
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/utsname.h
40.Ft int
41.Fn uname "struct utsname *name"
42.Sh DESCRIPTION
43The
44.Fn uname
45function stores
46.Dv NUL Ns -terminated
47strings of information identifying
48the current system into the structure referenced by
49.Fa name .
50.Pp
51The
52.Vt 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 sysname
58Name of the operating system implementation.
59.It nodename
60Network name of this machine.
61.It release
62Release level of the operating system.
63.It version
64Version level of the operating system.
65.It machine
66Machine hardware platform.
67.El
68.Sh RETURN VALUES
69.Rv -std uname
70.Sh ENVIRONMENT
71.Bl -tag -width ".Ev UNAME_s"
72.It Ev UNAME_s
73If the environment variable
74.Ev UNAME_s
75is set, it will override the
76.Va sysname
77member.
78.It Ev UNAME_r
79If the environment variable
80.Ev UNAME_r
81is set, it will override the
82.Va release
83member.
84.It Ev UNAME_v
85If the environment variable
86.Ev UNAME_v
87is set, it will override the
88.Va version
89member.
90.It Ev UNAME_m
91If the environment variable
92.Ev UNAME_m
93is set, it will override the
94.Va machine
95member.
96.El
97.Sh ERRORS
98The
99.Fn uname
100function may fail and set
101.Va errno
102for any of the errors specified for the library functions
103.Xr sysctl 3 .
104.Sh SEE ALSO
105.Xr uname 1 ,
106.Xr sysctl 3
107.Sh STANDARDS
108The
109.Fn uname
110function conforms to
111.St -p1003.1-88 .
112.Sh HISTORY
113The
114.Fn uname
115function first appeared in
116.Bx 4.4 .
117