xref: /freebsd/usr.bin/uname/uname.1 (revision ea09ac52750e93dd3188b70bca1a76d0fac701e4)
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 Novermber 13, 2020
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 operating system
86to standard output.
87.It Fl s
88Write the name of the operating system implementation to standard output.
89.It Fl U
90Write the
91.Fx
92version of the user environment.
93.It Fl v
94Write the version level of this release of the operating system
95to standard output.
96.El
97.Pp
98If the
99.Fl a
100flag is specified, or multiple flags are specified, all
101output is written on a single line, separated by spaces.
102.Pp
103The
104.Fl K
105and
106.Fl U
107flags are intended to be used for fine grain differentiation of incremental
108.Fx
109development and user visible changes.
110Note that when both of these two options are specified, regardless of their
111order, the kernel version would be printed first, followed by the user
112environment version.
113.Sh ENVIRONMENT
114An environment variable composed of the string
115.Ev UNAME_
116followed by any flag to the
117.Nm
118utility (except for
119.Fl a )
120will allow the corresponding data to be set to the contents
121of the environment variable.
122See
123.Xr uname 3
124for more information.
125.Sh EXIT STATUS
126.Ex -std
127.Sh EXAMPLES
128The hardware platform
129.Pq Fl m
130can be different from the machine's processor architecture
131.Pq Fl p ,
132e.g., on 64-bit PowerPC,
133.Fl m
134would return
135.Va powerpc
136and
137.Fl p
138would return
139.Va powerpc64 .
140.Sh SEE ALSO
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