diff options
Diffstat (limited to 'static/freebsd/man5/os-release.5 3.html')
| -rw-r--r-- | static/freebsd/man5/os-release.5 3.html | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/static/freebsd/man5/os-release.5 3.html b/static/freebsd/man5/os-release.5 3.html new file mode 100644 index 00000000..be3bfd31 --- /dev/null +++ b/static/freebsd/man5/os-release.5 3.html @@ -0,0 +1,115 @@ +<table class="head"> + <tr> + <td class="head-ltitle">OS-RELEASE(5)</td> + <td class="head-vol">File Formats Manual</td> + <td class="head-rtitle">OS-RELEASE(5)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">os-release</code> — <span class="Nd">file + describing the current OS and some of its attributes</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">os-release</code> file is a new-line + separated list of key value pairs. The syntax of this file is a reduced + <a class="Xr">sh(1)</a> variable assignment with the following + restrictions:</p> +<ul class="Bl-bullet"> + <li>Strings cannot be concatenated together</li> + <li>No variable expansion is done</li> + <li>All shell special characters must be quoted as documented in + <a class="Xr">sh(1)</a></li> + <li>Variable assignments must be included inside of double quotes if they + contain characters outside of A-Z, a-z and 0-9</li> + <li>All strings should be UTF-8 format</li> + <li>Non-printable characters should not be used in the strings</li> +</ul> +<p class="Pp">Lines starting with the character + ‘<code class="Li">#</code>’ are ignored as comments.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="VARIABLES"><a class="permalink" href="#VARIABLES">VARIABLES</a></h1> +<p class="Pp">The following variables are defined by the standard.</p> +<dl class="Bl-tag Bl-compact"> + <dt id="NAME~2"><a class="permalink" href="#NAME~2"><code class="Dv">NAME</code></a></dt> + <dd>A string describing the preferred OS name.</dd> + <dt id="VERSION"><a class="permalink" href="#VERSION"><code class="Dv">VERSION</code></a></dt> + <dd>Version string for the OS, in its usual and customary format.</dd> + <dt id="ID"><a class="permalink" href="#ID"><code class="Dv">ID</code></a></dt> + <dd>Lower case version of the name with only a-z, 0-9, + ‘<code class="Li">.</code>’, + ‘<code class="Li">-</code>’, and + ‘<code class="Li">_</code>’.</dd> + <dt id="VERSION_ID"><a class="permalink" href="#VERSION_ID"><code class="Dv">VERSION_ID</code></a></dt> + <dd>Lower case version of the version with only a-z, 0-9, + ‘<code class="Li">.</code>’, + ‘<code class="Li">-</code>’, and + ‘<code class="Li">_</code>’.</dd> + <dt id="PRETTY_NAME"><a class="permalink" href="#PRETTY_NAME"><code class="Dv">PRETTY_NAME</code></a></dt> + <dd>A pretty version of the name presented to the user. May contain release + information.</dd> + <dt id="ANSI_COLOR"><a class="permalink" href="#ANSI_COLOR"><code class="Dv">ANSI_COLOR</code></a></dt> + <dd>Suggested color presentation for the OS. This string should be suitable + for inclusion within an ESC [ m ANSI/ECMA-48 escape sequence to render the + OS in its preferred color. This variable is optional.</dd> + <dt id="CPE_NAME"><a class="permalink" href="#CPE_NAME"><code class="Dv">CPE_NAME</code></a></dt> + <dd>A CPE name for the operating system. This field shall follow the NIST + Common Platform Enumeration specification.</dd> + <dt id="HOME_URL"><a class="permalink" href="#HOME_URL"><code class="Dv">HOME_URL</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SUPPORT_URL"><a class="permalink" href="#SUPPORT_URL"><code class="Dv">SUPPORT_URL</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="BUG_REPORT_URL"><a class="permalink" href="#BUG_REPORT_URL"><code class="Dv">BUG_REPORT_URL</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="PRIVACY_POLICY_URL"><a class="permalink" href="#PRIVACY_POLICY_URL"><code class="Dv">PRIVACY_POLICY_URL</code></a></dt> + <dd>Links on the internet, in RFC 3986 format for different aspects of this + OS. These variables are optional.</dd> + <dt id="BUILD_ID"><a class="permalink" href="#BUILD_ID"><code class="Dv">BUILD_ID</code></a></dt> + <dd>A string identifying the build. This variable is optional.</dd> + <dt id="VARIANT"><a class="permalink" href="#VARIANT"><code class="Dv">VARIANT</code></a></dt> + <dd>A string describing the variant of this operating system. This variable is + optional.</dd> + <dt id="VARIANT_ID"><a class="permalink" href="#VARIANT_ID"><code class="Dv">VARIANT_ID</code></a></dt> + <dd>Lower case version of the variant with only a-z, 0-9, + ‘<code class="Li">.</code>’, + ‘<code class="Li">-</code>’, and + ‘<code class="Li">_</code>’. This variable is optional.</dd> +</dl> +<p class="Pp">All other variables have no standard-defined meaning.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/etc/os-release</span></dt> + <dd>Symbolic link to actual <span class="Pa">os-release</span> file.</dd> + <dt><span class="Pa">/var/run/os-release</span></dt> + <dd>Generated os-release file describing the currently running system.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<dl class="Bl-tag Bl-compact"> + <dt>CPE Specification</dt> + <dd><a class="Lk" href="https://csrc.nist.gov/projects/security-content-automation-protocol/scap-specifications/cpe">https://csrc.nist.gov/projects/security-content-automation-protocol/scap-specifications/cpe</a></dd> + <dt>RFC 3986</dt> + <dd><a class="Lk" href="https://tools.ietf.org/html/rfc3986">https://tools.ietf.org/html/rfc3986</a></dd> + <dt>os-release Specification</dt> + <dd><a class="Lk" href="https://www.linux.org/docs/man5/os-release.html">https://www.linux.org/docs/man5/os-release.html</a></dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">This file first appeared in <span class="Ux">FreeBSD + 13.0</span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">November 23, 2021</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |