summaryrefslogtreecommitdiff
path: root/man/os-release.xml
diff options
context:
space:
mode:
authorStephen Gallagher <sgallagh@redhat.com>2015-04-29 08:19:05 -0400
committerDavid Herrmann <dh.herrmann@gmail.com>2015-05-05 21:07:13 +0200
commitbe7d0048ddda1e994f651e2825f96266d537d10d (patch)
treed7961fca7510f0e8731c5027231a0e560904c8ee /man/os-release.xml
parent2e8522767e27d5686206794c69e0aa95da6e798b (diff)
Add VARIANT as a standard value for /etc/os-release
Some distributions (such as Fedora) are using the VARIANT field to indicate to select packages which of several default configurations they should be using. For example, VARIANT=Server provides a different default firewall configuration (blocking basically everything but SSH and the management console) whereas VARIANT=Workstation opens many other ports for application compatibility. By adding this patch to the manual pages, we can standardize on a cross-distribution mechanism for accomplishing this. Fedora implementation details are available at https://fedoraproject.org/wiki/Packaging:Per-Product_Configuration (David: drop double paranthesis)
Diffstat (limited to 'man/os-release.xml')
-rw-r--r--man/os-release.xml35
1 files changed, 35 insertions, 0 deletions
diff --git a/man/os-release.xml b/man/os-release.xml
index 4f57323d49..4ca2e59706 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -273,6 +273,41 @@
</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>VARIANT=</varname></term>
+
+ <listitem><para>
+ A string identifying a specific variant or edition of the
+ operating system suitable for presentation to the user. This
+ field may be used to inform the user that the configuration of
+ this system is subject to a specific divergent set of rules or
+ default configuration settings. This field is optional and may
+ not be implemented on all systems.
+ Examples:
+ <literal>VARIANT="Server Edition"</literal>,
+ <literal>VARIANT="Smart Refrigerator Edition"</literal>
+ Note: this field is for display purposes only. The
+ <varname>VARIANT_ID</varname> field should be used for making
+ programmatic decisions.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>VARIANT_ID=</varname></term>
+
+ <listitem><para>
+ A lower-case string (no spaces or other characters outside of
+ 0-9, a-z, ".", "_" and "-"), identifying a specific variant or
+ edition of the operating system. This may be interpreted by
+ other packages in order to determine a divergent default
+ configuration. This field is optional and may not be
+ implemented on all systems.
+ Examples:
+ <literal>VARIANT_ID=server</literal>,
+ <literal>VARIANT_ID=embedded</literal>
+ </para></listitem>
+ </varlistentry>
+
</variablelist>
<para>If you are reading this file from C code or a shell script