man: rework VM/container identifier list into a table, and include descriptions for...

[elogind.git] / man / systemd-detect-virt.xml

diff --git a/man/systemd-detect-virt.xml b/man/systemd-detect-virt.xml
index 69785ceffac88380e0c08691a631c5a17e40b1d9..e167bddd07df5fcd744d666298f2062fa1c92f26 100644 (file)
--- a/man/systemd-detect-virt.xml
+++ b/man/systemd-detect-virt.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-detect-virt">
+<refentry id="systemd-detect-virt"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-detect-virt</title>
@@ -65,15 +66,102 @@
                 <para>When executed without <option>--quiet</option>
                 will print a short identifier for the detected
                 virtualization technology. The following technologies
-                are currently identified: <varname>qemu</varname>,
-                <varname>kvm</varname>, <varname>vmware</varname>,
-                <varname>microsoft</varname>,
-                <varname>oracle</varname>, <varname>xen</varname>,
-                <varname>bochs</varname>, <varname>chroot</varname>,
-                <varname>uml</varname>,
-                <varname>openvz</varname>, <varname>lxc</varname>,
-                <varname>lxc-libvirt</varname>,
-                <varname>systemd-nspawn</varname>.</para>
+                are currently identified:</para>
+
+                <table>
+                  <title>Known VM virtualization technologies</title>
+                  <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+                    <colspec colname="id" />
+                    <colspec colname="product" />
+                    <thead>
+                      <row>
+                        <entry>ID</entry>
+                        <entry>VM Product</entry>
+                      </row>
+                    </thead>
+                    <tbody>
+                      <row>
+                        <entry><varname>qemu</varname></entry>
+                        <entry>QEMU software virtualization</entry>
+                      </row>
+                      <row>
+                        <entry><varname>kvm</varname></entry>
+                        <entry>Linux KVM kernel virtual machine</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>vmware</varname></entry>
+                        <entry>VMware Workstation or Server, and related products</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>microsoft</varname></entry>
+                        <entry>Hyper-V, also known as Viridian or Windows Server Virtualization</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>oracle</varname></entry>
+                        <entry>Oracle VM VirtualBox (historically marketed by innotek and Sun Microsystems)</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>xen</varname></entry>
+                        <entry>Xen hypervisor</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>bochs</varname></entry>
+                        <entry>Bochs Emulator</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>uml</varname></entry>
+                        <entry>User-mode Linux</entry>
+                      </row>
+
+                    </tbody>
+                  </tgroup>
+                </table>
+
+                <table>
+                  <title>Known container virtualization technologies</title>
+                  <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+                    <colspec colname="id" />
+                    <colspec colname="product" />
+                    <thead>
+                      <row>
+                        <entry>ID</entry>
+                        <entry>Container Product</entry>
+                      </row>
+                    </thead>
+                    <tbody>
+                      <row>
+                        <entry><varname>openvz</varname></entry>
+                        <entry>OpenVZ/Virtuozzo</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>lxc</varname></entry>
+                        <entry>Linux container implementation by LXC</entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>lxc-libvirt</varname></entry>
+                        <entry>Linux container implementation by libvirt</entry>
+                      </row>
+
+                      <row>
+                         <entry><varname>systemd-nspawn</varname></entry>
+                         <entry>systemd's minimal container implementation, see <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></entry>
+                      </row>
+
+                      <row>
+                        <entry><varname>docker</varname></entry>
+                        <entry>Docker container manager</entry>
+                      </row>
+                    </tbody>
+                  </tgroup>
+                </table>
 
                 <para>If multiple virtualization solutions are used,
                 only the "innermost" is detected and identified. That
@@ -89,21 +177,6 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
-                        </varlistentry>
-
                         <varlistentry>
                                 <term><option>-c</option></term>
                                 <term><option>--container</option></term>
@@ -131,6 +204,8 @@
                                 identifier.</para></listitem>
                         </varlistentry>
 
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
                 </variablelist>
 
         </refsect1>
@@ -145,7 +220,8 @@
         <refsect1>
                 <title>See Also</title>
                 <para>
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 </para>
         </refsect1>