xref: /freebsd/usr.bin/uname/uname.1 (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
1.\" Copyright (c) 1993
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.1	8.3 (Berkeley) 4/8/94
29.\" $FreeBSD$
30.\"
31.Dd September 14, 2022
32.Dt UNAME 1
33.Os
34.Sh NAME
35.Nm uname
36.Nd display information about the system
37.Sh SYNOPSIS
38.Nm
39.Op Fl abiKmnoprsUv
40.Sh DESCRIPTION
41The
42.Nm
43command writes the name of the operating system implementation to
44standard output.
45When options are specified, strings representing one or more system
46characteristics are written to standard output.
47.Pp
48The options are as follows:
49.Bl -tag -width indent
50.It Fl a
51Behave as though the options
52.Fl m , n , r , s ,
53and
54.Fl v
55were specified.
56.It Fl b
57Write the kernel's linker-generated build-id to standard output.
58.It Fl i
59Write the kernel ident to standard output.
60.It Fl K
61Write the
62.Fx
63version of the kernel.
64.It Fl m
65Write the type of the current hardware platform to standard output.
66.Po Xr make 1
67uses it to set the
68.Va MACHINE
69variable.
70.Pc
71.It Fl n
72Write the name of the system to standard output.
73.It Fl o
74This is a synonym for the
75.Fl s
76option, for compatibility with other systems.
77.It Fl p
78Write the type of the machine processor architecture to standard output.
79.Po Xr make 1
80uses it to set the
81.Va MACHINE_ARCH
82variable.
83.Pc
84.It Fl r
85Write the current release level of the kernel
86to standard output.
87.Xr freebsd-version 1
88can be used to print the release level of the userland.
89.It Fl s
90Write the name of the operating system implementation to standard output.
91.It Fl U
92Write the
93.Fx
94version of the user environment.
95.It Fl v
96Write the version level of this release of the operating system
97to standard output.
98.El
99.Pp
100If the
101.Fl a
102flag is specified, or multiple flags are specified, all
103output is written on a single line, separated by spaces.
104.Pp
105The
106.Fl K
107and
108.Fl U
109flags are intended to be used for fine grain differentiation of incremental
110.Fx
111development and user visible changes.
112Note that when both of these two options are specified, regardless of their
113order, the kernel version would be printed first, followed by the user
114environment version.
115.Sh ENVIRONMENT
116An environment variable composed of the string
117.Ev UNAME_
118followed by any flag to the
119.Nm
120utility (except for
121.Fl a )
122will allow the corresponding data to be set to the contents
123of the environment variable.
124See
125.Xr uname 3
126for more information.
127.Sh EXIT STATUS
128.Ex -std
129.Sh EXAMPLES
130The hardware platform
131.Pq Fl m
132can be different from the machine's processor architecture
133.Pq Fl p ,
134e.g., on 64-bit PowerPC,
135.Fl m
136would return
137.Va powerpc
138and
139.Fl p
140would return
141.Va powerpc64 .
142.Sh SEE ALSO
143.Xr freebsd-version 1 ,
144.Xr feature_present 3 ,
145.Xr getosreldate 3 ,
146.Xr sysctl 3 ,
147.Xr uname 3 ,
148.Xr sysctl 8
149.Sh STANDARDS
150The
151.Nm
152command is expected to conform to the
153.St -p1003.2
154specification.
155.Sh HISTORY
156The
157.Nm
158command appeared in PWB UNIX 1.0, however
159.Bx 4.4
160was the first Berkeley release with the
161.Nm
162command.
163.Pp
164The
165.Fl K
166and
167.Fl U
168extension flags appeared in
169.Fx 10.0 .
170The
171.Fl b
172extension flag appeared in
173.Fx 13.0 .
174