xref: /freebsd/usr.bin/uname/uname.1 (revision ef36b3f75658d201edb495068db5e1be49593de5)
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 May 31, 2017
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 aiKmnoprsUv
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 i
57Write the kernel ident to standard output.
58.It Fl K
59Write the
60.Fx
61version of the kernel.
62.It Fl m
63Write the type of the current hardware platform to standard output.
64.Po Xr make 1
65uses it to set the
66.Va MACHINE
67variable.
68.Pc
69.It Fl n
70Write the name of the system to standard output.
71.It Fl o
72This is a synonym for the
73.Fl s
74option, for compatibility with other systems.
75.It Fl p
76Write the type of the machine processor architecture to standard output.
77.Po Xr make 1
78uses it to set the
79.Va MACHINE_ARCH
80variable.
81.Pc
82.It Fl r
83Write the current release level of the operating system
84to standard output.
85.It Fl s
86Write the name of the operating system implementation to standard output.
87.It Fl U
88Write the
89.Fx
90version of the user environment.
91.It Fl v
92Write the version level of this release of the operating system
93to standard output.
94.El
95.Pp
96If the
97.Fl a
98flag is specified, or multiple flags are specified, all
99output is written on a single line, separated by spaces.
100.Pp
101The
102.Fl K
103and
104.Fl U
105flags are intended to be used for fine grain differentiation of incremental
106.Fx
107development and user visible changes.
108.Sh ENVIRONMENT
109An environment variable composed of the string
110.Ev UNAME_
111followed by any flag to the
112.Nm
113utility (except for
114.Fl a )
115will allow the corresponding data to be set to the contents
116of the environment variable.
117.Sh EXIT STATUS
118.Ex -std
119.Sh EXAMPLES
120The hardware platform
121.Pq Fl m
122can be different from the machine's processor architecture
123.Pq Fl p ,
124e.g., on 64-bit PowerPC,
125.Fl m
126would return
127.Va powerpc
128and
129.Fl p
130would return
131.Va powerpc64 .
132.Sh SEE ALSO
133.Xr feature_present 3 ,
134.Xr getosreldate 3 ,
135.Xr sysctl 3 ,
136.Xr uname 3 ,
137.Xr sysctl 8
138.Sh STANDARDS
139The
140.Nm
141command is expected to conform to the
142.St -p1003.2
143specification.
144.Sh HISTORY
145The
146.Nm
147command appeared in PWB UNIX.
148.Pp
149The
150.Fl K
151and
152.Fl U
153extension flags appeared in
154.Fx 10.0 .
155