xref: /freebsd/bin/freebsd-version/freebsd-version.1 (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1.\"-
2.\" Copyright (c) 2013 Dag-Erling Smørgrav
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd October 1, 2021
27.Dt FREEBSD-VERSION 1
28.Os
29.Sh NAME
30.Nm freebsd-version
31.Nd print the version and patch level of the installed system
32.Sh SYNOPSIS
33.Nm
34.Op Fl kru
35.Op Fl j Ar jail
36.Sh DESCRIPTION
37The
38.Nm
39utility makes a best effort to determine the version and patch level
40of the installed kernel and / or userland.
41.Pp
42The following options are available:
43.Bl -tag -width Fl
44.It Fl k
45Print the version and patch level of the installed kernel.
46Unlike
47.Xr uname 1 ,
48if a new kernel has been installed but the system has not yet
49rebooted,
50.Nm
51will print the version and patch level of the new kernel.
52.It Fl r
53Print the version and patch level of the running kernel.
54Unlike
55.Xr uname 1 ,
56this is unaffected by environment variables.
57.It Fl u
58Print the version and patch level of the installed userland.
59These are hardcoded into
60.Nm
61during the build.
62.It Fl j Ar jail
63Print the version and patch level of the installed userland in the
64given jail specified by
65.Va jid
66or
67.Va name .
68This option can be specified multiple times.
69.El
70.Pp
71If several of the above options are specified,
72.Nm
73will print the installed kernel version first, then the running kernel
74version, next the userland version, and finally the userland version
75of the specified jails, on separate lines.
76If neither is specified, it will print the userland version only.
77.Sh IMPLEMENTATION NOTES
78The
79.Nm
80utility should provide the correct answer in the vast majority of
81cases, including on systems kept up-to-date using
82.Xr freebsd-update 8 ,
83which does not update the kernel version unless the kernel itself was
84affected by the latest patch.
85.Pp
86To determine the name (and hence the location) of a custom kernel, the
87.Nm
88utility will attempt to parse
89.Pa /boot/defaults/loader.conf
90and
91.Pa /boot/loader.conf ,
92looking for definitions of the
93.Va kernel
94and
95.Va bootfile
96variables, both with a default value of
97.Dq kernel .
98It may however fail to locate the correct kernel if either or both of
99these variables are defined in a non-standard location, such as in
100.Pa /boot/loader.rc .
101.Sh ENVIRONMENT
102.Bl -tag -width ROOT
103.It Ev ROOT
104Path to the root of the filesystem in which to look for
105.Pa loader.conf
106and the kernel.
107.El
108.Sh EXAMPLES
109To determine the version of the currently running userland:
110.Bd -literal -offset indent
111/bin/freebsd-version -u
112.Ed
113.Pp
114To inspect a system being repaired using a live system:
115.Bd -literal -offset indent
116mount -rt ufs /dev/ada0p2 /mnt
117env ROOT=/mnt /mnt/bin/freebsd-version -ku
118.Ed
119.Sh SEE ALSO
120.Xr uname 1 ,
121.Xr loader.conf 5
122.Sh HISTORY
123The
124.Nm
125command appeared in
126.Fx 10.0 .
127.Sh AUTHORS
128The
129.Nm
130utility and this manual page were written by
131.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
132