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