1.\" 2.\" Copyright (c) 2019 M. Warner Losh <imp@FreeBSD.org> 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.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd November 23, 2021 28.Dt OS-RELEASE 5 29.Os 30.Sh NAME 31.Nm os-release 32.Nd file describing the current OS and some of its attributes 33.Sh DESCRIPTION 34The 35.Nm 36file is a new-line separated list of key value pairs. 37The syntax of this file is a reduced 38.Xr sh 1 39variable assignment with the 40following restrictions: 41.Bl -bullet 42.It 43Strings cannot be concatenated together 44.It 45No variable expansion is done 46.It 47All shell special characters must be quoted as documented in 48.Xr sh 1 49.It 50Variable assignments must be included inside of double quotes 51if they contain characters outside of A-Z, a-z and 0-9 52.It 53All strings should be UTF-8 format 54.It 55Non-printable characters should not be used in the strings 56.El 57.Pp 58Lines starting with the character 59.Ql # 60are ignored as comments. 61.Sh VARIABLES 62The following variables are defined by the standard. 63.Bl -tag -width XXXXXXXXXX -compact 64.It Dv NAME 65A string describing the preferred OS name. 66.It Dv VERSION 67Version string for the OS, in its usual and customary format. 68.It Dv ID 69Lower case version of the name with only a-z, 0-9, 70.Ql \&. , 71.Ql - , 72and 73.Ql _ . 74.It Dv VERSION_ID 75Lower case version of the version with only a-z, 0-9, 76.Ql \&. , 77.Ql - , 78and 79.Ql _ . 80.It Dv PRETTY_NAME 81A pretty version of the name presented to the user. 82May contain release information. 83.It Dv ANSI_COLOR 84Suggested color presentation for the OS. 85This string should be suitable for inclusion within an ESC [ m ANSI/ECMA-48 86escape sequence to render the OS in its preferred color. 87This variable is optional. 88.It Dv CPE_NAME 89A CPE name for the operating system. 90This field shall follow the NIST Common Platform Enumeration specification. 91.It Dv HOME_URL 92.It Dv SUPPORT_URL 93.It Dv BUG_REPORT_URL 94.It Dv PRIVACY_POLICY_URL 95Links on the internet, in RFC 3986 format for different aspects of this OS. 96These variables are optional. 97.It Dv BUILD_ID 98A string identifying the build. 99This variable is optional. 100.It Dv VARIANT 101A string describing the variant of this operating system. 102This variable is optional. 103.It Dv VARIANT_ID 104Lower case version of the variant with only a-z, 0-9, 105.Ql \&. , 106.Ql - , 107and 108.Ql _ . 109This variable is optional. 110.El 111.Pp 112All other variables have no standard-defined meaning. 113.Sh FILES 114.Bl -tag -width XXXXXXXXXX -compact 115.It Pa /etc/os-release 116Symbolic link to actual 117.Pa os-release 118file. 119.It Pa /var/run/os-release 120Generated os-release file describing the currently running system. 121.El 122.Sh SEE ALSO 123.Bl -tag -width XXXXXXXXXX -compact 124.It CPE Specification 125.Lk https://csrc.nist.gov/projects/security-content-automation-protocol/scap-specifications/cpe 126.It RFC 3986 127.Lk https://tools.ietf.org/html/rfc3986 128.It os-release Specification 129.Lk https://www.linux.org/docs/man5/os-release.html 130.El 131.Sh HISTORY 132This file first appeared in 133.Fx 13.0 . 134