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