chiark / gitweb /
build-sys: make PolicyKit support compile-time optional (was runtime-optional already)
[elogind.git] / man / systemd-detect-virt.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6   This file is part of systemd.
7
8   Copyright 2010 Lennart Poettering
9
10   systemd is free software; you can redistribute it and/or modify it
11   under the terms of the GNU Lesser General Public License as published by
12   the Free Software Foundation; either version 2.1 of the License, or
13   (at your option) any later version.
14
15   systemd is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   Lesser General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public License
21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd-detect-virt">
25
26         <refentryinfo>
27                 <title>systemd-detect-virt</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>systemd-detect-virt</refentrytitle>
42                 <manvolnum>1</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>systemd-detect-virt</refname>
47                 <refpurpose>Detect execution in a virtualized environment</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <cmdsynopsis>
52                         <command>systemd-detect-virt <arg choice="opt" rep="repeat">OPTIONS</arg></command>
53                 </cmdsynopsis>
54         </refsynopsisdiv>
55
56         <refsect1>
57                 <title>Description</title>
58
59                 <para><command>systemd-detect-virt</command> detects
60                 execution in a virtualized environment. It identifies
61                 the virtualization technology and can distinguish full
62                 VM virtualization from container
63                 virtualization.</para>
64
65                 <para>When executed without <option>--quiet</option>
66                 will print a short identifier for the detected
67                 virtualization technology. The following technologies
68                 are currently identified: <varname>qemu</varname>,
69                 <varname>kvm</varname>, <varname>vmware</varname>,
70                 <varname>microsoft</varname>,
71                 <varname>oracle</varname>, <varname>xen</varname>,
72                 <varname>bochs</varname>, <varname>chroot</varname>,
73                 <varname>openvz</varname>, <varname>lxc</varname>,
74                 <varname>lxc-libvirt</varname>,
75                 <varname>systemd-nspawn</varname>.</para>
76
77                 <para>If multiple virtualization solutions are used
78                 only the "innermost" is detected and identified. That
79                 means if both VM virtualization and container
80                 virtualization are used in conjunction only the latter
81                 will be identified (unless <option>--vm</option> is
82                 passed).</para>
83         </refsect1>
84
85         <refsect1>
86                 <title>Options</title>
87
88                 <para>The following options are understood:</para>
89
90                 <variablelist>
91                         <varlistentry>
92                                 <term><option>-h</option></term>
93                                 <term><option>--help</option></term>
94
95                                 <listitem><para>Prints a short help
96                                 text and exits.</para></listitem>
97                         </varlistentry>
98
99                         <varlistentry>
100                                 <term><option>--version</option></term>
101
102                                 <listitem><para>Prints a short version
103                                 string and exits.</para></listitem>
104                         </varlistentry>
105
106                         <varlistentry>
107                                 <term><option>-c</option></term>
108                                 <term><option>--container</option></term>
109
110                                 <listitem><para>Only detects container
111                                 virtualization (i.e. shared kernel
112                                 virtualization).</para></listitem>
113                         </varlistentry>
114
115                         <varlistentry>
116                                 <term><option>-v</option></term>
117                                 <term><option>--vm</option></term>
118
119                                 <listitem><para>Only detects VM
120                                 virtualization (i.e. full hardware
121                                 virtualization).</para></listitem>
122                         </varlistentry>
123
124                         <varlistentry>
125                                 <term><option>-q</option></term>
126                                 <term><option>--quiet</option></term>
127
128                                 <listitem><para>Suppress output of the
129                                 virtualization technology
130                                 identifier.</para></listitem>
131                         </varlistentry>
132
133                 </variablelist>
134
135         </refsect1>
136
137         <refsect1>
138                 <title>Exit status</title>
139
140                 <para>If a virtualization technology is detected 0 is
141                 returned, a non-zero code otherwise.</para>
142         </refsect1>
143
144         <refsect1>
145                 <title>See Also</title>
146                 <para>
147                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
148                 </para>
149         </refsect1>
150
151 </refentry>