loginctl: make session/user arguments optional for a number commands, and imply calli...

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

diff --git a/man/systemd-detect-virt.xml b/man/systemd-detect-virt.xml
index 75cc714f52ae44c88665a1642816e2b633f9b6b6..d8e881cf2e82f49ed6b41207b84713ce7255f29e 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/>.
 -->
 
   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>
 
         <refentryinfo>
                 <title>systemd-detect-virt</title>


@@ -58,26 +59,117 @@
 
                 <para><command>systemd-detect-virt</command> detects
                 execution in a virtualized environment. It identifies
 
                 <para><command>systemd-detect-virt</command> detects
                 execution in a virtualized environment. It identifies

-                the virtualization technology and can distuingish full
+                the virtualization technology and can distinguish full

                 VM virtualization from container
                 VM virtualization from container

-                virtualization.</para>
+                virtualization. <filename>systemd-detect-virt</filename>
+                exits with a return value of 0 (success) if a
+                virtualization technology is detected, and non-zero
+                (error) otherwise. By default any type of
+                virtualization is detected, and the options
+                <option>--container</option> and <option>--vm</option>
+                can be used to limit what types of virtualization are
+                detected.</para>

 
                 <para>When executed without <option>--quiet</option>
                 will print a short identifier for the detected
                 virtualization technology. The following technologies
 
                 <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>openvz</varname>, <varname>lxc</varname>,
-                <varname>lxc-libvirt</varname>,
-                <varname>systemd-nspawn</varname>.</para>
-
-                <para>If multiple virtualization solutions are used
+                are currently identified:</para>
+
+                <table>
+                  <title>Known virtualization technologies (both
+                  VM, i.e. full hardware virtualization,
+                  and container, i.e. shared kernel virtualization)</title>
+                  <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+                    <colspec colname="type" />
+                    <colspec colname="id" />
+                    <colspec colname="product" />
+                    <thead>
+                      <row>
+                        <entry>Type</entry>
+                        <entry>ID</entry>
+                        <entry>Product</entry>
+                      </row>
+                    </thead>
+                    <tbody>
+                      <row>
+                        <entry morerows="8">VM</entry>
+                        <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>zvm</varname></entry>
+                        <entry>s390 z/VM</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 (only domU, not dom0)</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>
+
+                      <row>
+                        <entry morerows="5">container</entry>
+                        <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
                 means if both VM virtualization and container
                 only the "innermost" is detected and identified. That
                 means if both VM virtualization and container

-                virtualization are used in conjunction only the latter
+                virtualization are used in conjunction, only the latter

                 will be identified (unless <option>--vm</option> is
                 passed).</para>
         </refsect1>
                 will be identified (unless <option>--vm</option> is
                 passed).</para>
         </refsect1>


@@ -88,21 +180,6 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
                 <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>
                         <varlistentry>
                                 <term><option>-c</option></term>
                                 <term><option>--container</option></term>


@@ -130,6 +207,8 @@
                                 identifier.</para></listitem>
                         </varlistentry>
 
                                 identifier.</para></listitem>
                         </varlistentry>
 

+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />

                 </variablelist>
 
         </refsect1>
                 </variablelist>
 
         </refsect1>


@@ -137,14 +216,15 @@
         <refsect1>
                 <title>Exit status</title>
 
         <refsect1>
                 <title>Exit status</title>
 

-                <para>If a virtualization technology is detected 0 is
+                <para>If a virtualization technology is detected, 0 is

                 returned, a non-zero code otherwise.</para>
         </refsect1>
 
         <refsect1>
                 <title>See Also</title>
                 <para>
                 returned, a non-zero code otherwise.</para>
         </refsect1>
 
         <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>
 
                 </para>
         </refsect1>