2 .\" Copyright (c) 2019 M. Warner Losh <imp@FreeBSD.org>
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd file describing the current OS and some of its attributes
36 file is a new-line separated list of key value pairs.
37 The syntax of this file is a reduced
39 variable assignment with the
40 following restrictions:
43 Strings cannot be concatenated together
45 No variable expansion is done
47 All shell special characters must be quoted as documented in
50 Variable assignments must be included inside of double quotes
51 if they contain characters outside of A-Z, a-z and 0-9
53 All strings should be UTF-8 format
55 Non-printable characters should not be used in the strings
58 Lines starting with the character
60 are ignored as comments.
62 The following variables are defined by the standard.
63 .Bl -tag -width XXXXXXXXXX -compact
65 A string describing the preferred OS name.
67 Version string for the OS, in its usual and customary format.
69 Lower case version of the name with only a-z, 0-9,
75 Lower case version of the version with only a-z, 0-9,
81 A pretty version of the name presented to the user.
82 May contain release information.
84 Suggested color presentation for the OS.
85 This string should be suitable for inclusion within an ESC [ m ANSI/ECMA-48
86 escape sequence to render the OS in its preferred color.
87 This variable is optional.
89 A CPE name for the operating system.
90 This field shall follow the NIST Common Platform Enumeration specification.
94 .It Dv PRIVACY_POLICY_URL
95 Links on the internet, in RFC 3986 format for different aspects of this OS.
96 These variables are optional.
98 A string identifying the build.
99 This variable is optional.
101 A string describing the variant of this operating system.
102 This variable is optional.
104 Lower case version of the variant with only a-z, 0-9,
109 This variable is optional.
112 All other variables have no standard-defined meaning.
114 .Bl -tag -width XXXXXXXXXX -compact
115 .It Pa /etc/os-release
116 Symbolic link to actual
119 .It Pa /var/run/os-release
120 Generated os-release file describing the currently running system.
122 .Bl -tag -width XXXXXXXXXX -compact
123 .It CPE Specification
124 .Lk https://csrc.nist.gov/projects/security-content-automation-protocol/scap-specifications/cpe
126 .Lk https://tools.ietf.org/html/rfc3986
127 .It os-release Specification
128 .Lk https://www.linux.org/docs/man5/os-release.html
130 This file first appeared in