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