[Lsb-messages] /var/www/bzr/lsb/devel/lsbspec r4069: a number of tweaks to lsb_release, inspired by bug 3949 but not all because of it

Mats Wichmann mats at linuxfoundation.org
Fri Mar 13 19:03:06 UTC 2015


------------------------------------------------------------
revno: 4069
committer: Mats Wichmann <mats at linuxfoundation.org>
branch nick: lsbspec
timestamp: Fri 2015-03-13 13:03:06 -0600
message:
  a number of tweaks to lsb_release, inspired by bug 3949 but not all because of it
modified:
  Base/generic/command/command.sgml
  Base/generic/command/lsb_release.sgml
-------------- next part --------------
=== modified file 'Base/generic/command/command.sgml'
--- a/Base/generic/command/command.sgml	2015-02-10 23:13:47 +0000
+++ b/Base/generic/command/command.sgml	2015-03-13 19:03:06 +0000
@@ -3122,150 +3122,185 @@
 
 </REFENTRY>
 
-<REFENTRY id="lsbrelease">
-<REFMETA>
-<REFENTRYTITLE>
+<refentry id="lsbrelease">
+<refmeta>
+<refentrytitle>
 lsb_release
-</REFENTRYTITLE>
-</REFMETA>
-<REFNAMEDIV>
-<REFNAME>lsb_release</REFNAME>
-<REFPURPOSE>
+</refentrytitle>
+</refmeta>
+<refnamediv>
+<refname>lsb_release</refname>
+<refpurpose>
 print distribution specific information
-</REFPURPOSE>
-</REFNAMEDIV>
-<REFSYNOPSISDIV>
-<CMDSYNOPSIS>
-<COMMAND>lsb_release</COMMAND> <ARG rep=repeat>OPTION</ARG>
-</CMDSYNOPSIS>
-</REFSYNOPSISDIV>
-<REFSECT1>
-<TITLE>Description</TITLE>
-<PARA>
-The <COMMAND>lsb_release</COMMAND> command prints certain LSB (Linux Standard
+</refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>lsb_release</command>
+<arg rep=repeat>option</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>
+The <command>lsb_release</command> command prints certain LSB (Linux Standard
 Base) and Distribution information.
-</PARA>
-<PARA>
-If no options are given, the <parameter>-v</parameter> option is assumed.
-</PARA>
-</REFSECT1>
-<REFSECT1>
-<TITLE>Options</TITLE>
-<VARIABLELIST>
-<VARLISTENTRY>
-<TERM>-v, --version</TERM>
-<LISTITEM>
-<PARA>
-displays version of LSB against which distribution is compliant. The version
-is expressed as a colon separated list of LSB module descriptions. LSB module
-descriptions are dash separated tuples containing the module name, version,
-and architecture name, in that order.
-The output is a single line of text of the following format:
-</PARA>
-<PARA>
-<literal>LSB Version:\t<replaceable>ListAsDescribedAbove</replaceable></literal>
-</PARA>
-<NOTE><PARA>
-An implementation may support multiple releases of the same module.
+</para>
+<para>
+If no options are given, the <parameter>-v</parameter> option is the default.
+</para>
+</refsect1>
+<refsect1>
+<title>Options</title>
+<variablelist>
+<varlistentry>
+<term>-v, --version</term>
+<listiteM>
+<para>
+displays the LSB version the distribution is compliant with. The version
+is expressed as a colon separated list of versioned LSB module identifiers. 
+An LSB module identifier is a dash-separated tuple consisting of module name and version
+or module name, version and architecture name, in that order.
+The version output is presented as a single line of text beginning with
+<literal>LSB Version:</literal> followed by a tab character, then the list of LSB module identifiers.
+This format is intended to be easily parsable by programs which need to consume the data.
+Excepting <literal>core</literal>, which must always be present, the list of
+module identifiers may change over time depending on installations and removals
+of system software. 
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>LSB Version:	core-&packaging-depver;-amd64:core-&packaging-depver;-noarch:desktop-&packaging-depver;-amd64:desktop-&packaging-depver;-noarch:languages-&packaging-depver;:imaging-&packaging-depver;</computeroutput>
+</para>
+</informalexample>
+<note><para>
+An implementation may support multiple releases of the same module. To claim
+compliance, the implementation shall list all relevant module identifiers.
 Version specific library interfaces, if any, will be selected by the program interpreter,
-which changes from release to release. Version specific commands and utilities, if any,
+which may change from release to release. Version specific commands and utilities, if any,
 will be described in the relevant specification.
-</PARA></NOTE>
-<PARA>
-For reporting conformance with this release of the specification, the
-name for each module is found in the "Package Dependencies" section of
-the "Package Format and Installation" chapter for that module in the
-specification.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-i, --id</TERM>
-<LISTITEM>
-<PARA>
-displays string id of distributor.
-The output is a single line of text of the following format:
-</PARA>
-<PARA>
-<literal>Distributor ID:\t<replaceable>DistributorID</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-d, --description</TERM>
-<LISTITEM>
-<PARA>
-displays single line text description of distribution.
-The output is of the following format:
-</PARA>
-<PARA>
-<literal>Description:\t<replaceable>Description</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-r, --release</TERM>
-<LISTITEM>
-<PARA>
-displays release number of distribution.
-The output is a single line of text of the following format:
-</PARA>
-<PARA>
-<literal>Release:\t<replaceable>Release</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-c, --codename</TERM>
-<LISTITEM>
-<PARA>
-displays codename according to distribution release.
-The output is a single line of text of the following format.
-</PARA>
-<PARA>
-<literal>Codename:\t<replaceable>Codename</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-a, --all</TERM>
-<LISTITEM>
-<PARA>
+</para></note>
+<para>
+For reporting or querying compliance with this release of the specification, use the
+module names found in the <citetitle pubwork="section">Package Dependencies</citetitle>
+section of the <citetitle pubwork="chapter">Package Format and Installation</citetitle>
+chapter for that module specification. 
+</para>
+</listitem>
+</varlistentrY>
+<varlistentry>
+<term>-i, --id</term>
+<listitem>
+<para>
+displays a string identifying the distribution provider.
+The id output is a single line of text beginning with
+<literal>Distributor ID:</literal> followed by a tab character, then the id string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Distributor ID:	Frobnozz</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-d, --description</term>
+<listitem>
+<para>
+displays text describing the distribution.
+The description output is a single line of text beginning with
+<literal>Description:</literal> followed by a tab character, then the description string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Description:	Frobnozz release 9 (Gilpher)</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-r, --release</term>
+<listiteM>
+<para>
+displays the release number of distribution.
+The release output is a single line of text beginning with
+<literal>Release:</literal> followed by a tab character, then the release string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Release:	9</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-c, --codename</term>
+<listitem>
+<para>
+displays a codename which corresponds to the distribution release.
+The codename output is a single line of text beginning with
+<literal>Codename:</literal> followed by a tab character, then the codename string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Codename:	Gilpher</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-a, --all</term>
+<listitem>
+<para>
 displays all of the above information.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-s, --short</TERM>
-<LISTITEM>
-<PARA>
-displays all of the above information in short output format.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-h, --help</TERM>
-<LISTITEM>
-<PARA>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-s, --short</term>
+<listitem>
+<para>
+displays all of the above information in a short output format.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-h, --help</term>
+<listitem>
+<para>
 displays a human-readable help message.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-</VARIABLELIST>
-</REFSECT1>
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
 
-<REFSECT1>
-<TITLE>Example</TITLE>
-<PARA>
+<!--refsect1>  Superseded by using inline examples above
+<title>Example</title>
+<para>
 The following command will list the LSB Profiles which are currently supported
 on this platform.
-</PARA>
-<PROGRAMLISTING>
+</para>
+<programlisting>
 example% lsb_release -v
 LSB Version: core-&packaging-depver;-ia32:core-&packaging-depver;-noarch:graphics-&packaging-depver;-ia32:graphics-&packaging-depver;-noarch
-</PROGRAMLISTING>
-</REFSECT1>
-</REFENTRY>
+</programlisting>
+</refsect1-->
+
+</refentry>
 
 <REFENTRY id="m4">
 <REFMETA><REFENTRYTITLE>

=== modified file 'Base/generic/command/lsb_release.sgml'
--- a/Base/generic/command/lsb_release.sgml	2015-02-10 23:13:47 +0000
+++ b/Base/generic/command/lsb_release.sgml	2015-03-13 19:03:06 +0000
@@ -1,144 +1,179 @@
-<REFENTRY id="lsbrelease">
-<REFMETA>
-<REFENTRYTITLE>
+<refentry id="lsbrelease">
+<refmeta>
+<refentrytitle>
 lsb_release
-</REFENTRYTITLE>
-</REFMETA>
-<REFNAMEDIV>
-<REFNAME>lsb_release</REFNAME>
-<REFPURPOSE>
+</refentrytitle>
+</refmeta>
+<refnamediv>
+<refname>lsb_release</refname>
+<refpurpose>
 print distribution specific information
-</REFPURPOSE>
-</REFNAMEDIV>
-<REFSYNOPSISDIV>
-<CMDSYNOPSIS>
-<COMMAND>lsb_release</COMMAND> <ARG rep=repeat>OPTION</ARG>
-</CMDSYNOPSIS>
-</REFSYNOPSISDIV>
-<REFSECT1>
-<TITLE>Description</TITLE>
-<PARA>
-The <COMMAND>lsb_release</COMMAND> command prints certain LSB (Linux Standard
+</refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>lsb_release</command>
+<arg rep=repeat>option</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>
+The <command>lsb_release</command> command prints certain LSB (Linux Standard
 Base) and Distribution information.
-</PARA>
-<PARA>
-If no options are given, the <parameter>-v</parameter> option is assumed.
-</PARA>
-</REFSECT1>
-<REFSECT1>
-<TITLE>Options</TITLE>
-<VARIABLELIST>
-<VARLISTENTRY>
-<TERM>-v, --version</TERM>
-<LISTITEM>
-<PARA>
-displays version of LSB against which distribution is compliant. The version
-is expressed as a colon separated list of LSB module descriptions. LSB module
-descriptions are dash separated tuples containing the module name, version,
-and architecture name, in that order.
-The output is a single line of text of the following format:
-</PARA>
-<PARA>
-<literal>LSB Version:\t<replaceable>ListAsDescribedAbove</replaceable></literal>
-</PARA>
-<NOTE><PARA>
-An implementation may support multiple releases of the same module.
+</para>
+<para>
+If no options are given, the <parameter>-v</parameter> option is the default.
+</para>
+</refsect1>
+<refsect1>
+<title>Options</title>
+<variablelist>
+<varlistentry>
+<term>-v, --version</term>
+<listiteM>
+<para>
+displays the LSB version the distribution is compliant with. The version
+is expressed as a colon separated list of versioned LSB module identifiers. 
+An LSB module identifier is a dash-separated tuple consisting of module name and version
+or module name, version and architecture name, in that order.
+The version output is presented as a single line of text beginning with
+<literal>LSB Version:</literal> followed by a tab character, then the list of LSB module identifiers.
+This format is intended to be easily parsable by programs which need to consume the data.
+Excepting <literal>core</literal>, which must always be present, the list of
+module identifiers may change over time depending on installations and removals
+of system software. 
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>LSB Version:	core-&packaging-depver;-amd64:core-&packaging-depver;-noarch:desktop-&packaging-depver;-amd64:desktop-&packaging-depver;-noarch:languages-&packaging-depver;:imaging-&packaging-depver;</computeroutput>
+</para>
+</informalexample>
+<note><para>
+An implementation may support multiple releases of the same module. To claim
+compliance, the implementation shall list all relevant module identifiers.
 Version specific library interfaces, if any, will be selected by the program interpreter,
-which changes from release to release. Version specific commands and utilities, if any,
+which may change from release to release. Version specific commands and utilities, if any,
 will be described in the relevant specification.
-</PARA></NOTE>
-<PARA>
-For reporting conformance with this release of the specification, the
-name for each module is found in the "Package Dependencies" section of
-the "Package Format and Installation" chapter for that module in the
-specification.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-i, --id</TERM>
-<LISTITEM>
-<PARA>
-displays string id of distributor.
-The output is a single line of text of the following format:
-</PARA>
-<PARA>
-<literal>Distributor ID:\t<replaceable>DistributorID</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-d, --description</TERM>
-<LISTITEM>
-<PARA>
-displays single line text description of distribution.
-The output is of the following format:
-</PARA>
-<PARA>
-<literal>Description:\t<replaceable>Description</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-r, --release</TERM>
-<LISTITEM>
-<PARA>
-displays release number of distribution.
-The output is a single line of text of the following format:
-</PARA>
-<PARA>
-<literal>Release:\t<replaceable>Release</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-c, --codename</TERM>
-<LISTITEM>
-<PARA>
-displays codename according to distribution release.
-The output is a single line of text of the following format.
-</PARA>
-<PARA>
-<literal>Codename:\t<replaceable>Codename</replaceable></literal>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-a, --all</TERM>
-<LISTITEM>
-<PARA>
+</para></note>
+<para>
+For reporting or querying compliance with this release of the specification, use the
+module names found in the <citetitle pubwork="section">Package Dependencies</citetitle>
+section of the <citetitle pubwork="chapter">Package Format and Installation</citetitle>
+chapter for that module specification. 
+</para>
+</listitem>
+</varlistentrY>
+<varlistentry>
+<term>-i, --id</term>
+<listitem>
+<para>
+displays a string identifying the distribution provider.
+The id output is a single line of text beginning with
+<literal>Distributor ID:</literal> followed by a tab character, then the id string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Distributor ID:	Frobnozz</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-d, --description</term>
+<listitem>
+<para>
+displays text describing the distribution.
+The description output is a single line of text beginning with
+<literal>Description:</literal> followed by a tab character, then the description string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Description:	Frobnozz release 9 (Gilpher)</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-r, --release</term>
+<listiteM>
+<para>
+displays the release number of distribution.
+The release output is a single line of text beginning with
+<literal>Release:</literal> followed by a tab character, then the release string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Release:	9</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-c, --codename</term>
+<listitem>
+<para>
+displays a codename which corresponds to the distribution release.
+The codename output is a single line of text beginning with
+<literal>Codename:</literal> followed by a tab character, then the codename string.
+This specification assigns no meaning to the value of the string,
+the contents are at the discretion of the distribution provider.
+</para>
+<informalexample>
+<para>
+Example:
+<computeroutput>Codename:	Gilpher</computeroutput>
+</para>
+</informalexample>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-a, --all</term>
+<listitem>
+<para>
 displays all of the above information.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-s, --short</TERM>
-<LISTITEM>
-<PARA>
-displays all of the above information in short output format.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-<VARLISTENTRY>
-<TERM>-h, --help</TERM>
-<LISTITEM>
-<PARA>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-s, --short</term>
+<listitem>
+<para>
+displays all of the above information in a short output format.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-h, --help</term>
+<listitem>
+<para>
 displays a human-readable help message.
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-</VARIABLELIST>
-</REFSECT1>
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
 
-<REFSECT1>
-<TITLE>Example</TITLE>
-<PARA>
+<!--refsect1>  Superseded by using inline examples above
+<title>Example</title>
+<para>
 The following command will list the LSB Profiles which are currently supported
 on this platform.
-</PARA>
-<PROGRAMLISTING>
+</para>
+<programlisting>
 example% lsb_release -v
 LSB Version: core-&packaging-depver;-ia32:core-&packaging-depver;-noarch:graphics-&packaging-depver;-ia32:graphics-&packaging-depver;-noarch
-</PROGRAMLISTING>
-</REFSECT1>
-</REFENTRY>
+</programlisting>
+</refsect1-->
+
+</refentry>



More information about the lsb-messages mailing list