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