From f215e02bf85f68d3a6106c2a1f4f7f063f819064 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Thu, 11 Apr 2024 10:17:27 +0200
Subject: Adding upstream version 7.0.14-dfsg.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 doc/manual/en_US/man_VBoxManage-showvminfo.xml | 221 +++++++++++++++++++++++++
 1 file changed, 221 insertions(+)
 create mode 100644 doc/manual/en_US/man_VBoxManage-showvminfo.xml

(limited to 'doc/manual/en_US/man_VBoxManage-showvminfo.xml')

diff --git a/doc/manual/en_US/man_VBoxManage-showvminfo.xml b/doc/manual/en_US/man_VBoxManage-showvminfo.xml
new file mode 100644
index 00000000..09967b58
--- /dev/null
+++ b/doc/manual/en_US/man_VBoxManage-showvminfo.xml
@@ -0,0 +1,221 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    manpage, user manual, usage: VBoxManage showvminfo
+-->
+<!--
+    Copyright (C) 2006-2023 Oracle and/or its affiliates.
+
+    This file is part of VirtualBox base platform packages, as
+    available from https://www.virtualbox.org.
+
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, in version 3 of the
+    License.
+
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, see <https://www.gnu.org/licenses>.
+
+    SPDX-License-Identifier: GPL-3.0-only
+-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<refentry id="vboxmanage-showvminfo" lang="en">
+  <refentryinfo>
+    <pubdate>$Date: 2023-01-18 00:40:56 +0100 (Wed, 18 Jan 2023) $</pubdate>
+    <title>VBoxManage showvminfo</title>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>VBoxManage-showvminfo</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>VBoxManage-showvminfo</refname>
+    <refpurpose>show configuration information or log file contents for a virtual
+      machine</refpurpose>
+    <refclass>&product-name;</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="synopsis-vboxmanage-showvminfo-default">
+<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
+      <command>VBoxManage showvminfo</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg>--details</arg>
+      <arg>--machinereadable</arg>
+      <arg>--password-id</arg>
+      <arg>--password</arg>
+    </cmdsynopsis>
+
+    <cmdsynopsis id="synopsis-vboxmanage-showvminfo-log">
+      <command>VBoxManage showvminfo</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg choice="req">--log=<replaceable>index</replaceable></arg>
+      <arg>--password-id <replaceable>id</replaceable></arg>
+      <arg>--password <replaceable>file</replaceable>|-</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      The <command>VBoxManage showvminfo</command> command outputs
+      configuration information or log file contents for a specified
+      virtual machine (VM).
+    </para>
+    <refsect2 id="vboxmanage-showvminfo-default">
+      <title>Viewing Virtual Machine Information</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage showvminfo</command> command outputs
+        information about the specified VM in a detailed format or in a
+        machine-readable format.
+      </para>
+      <para>
+        The <command>VBoxManage showvminfo</command> command shows the
+        same information for the specified VM in the same format as the
+        <command>VBoxManage list vms --long</command> command.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--details</option></term>
+          <listitem><para>
+              Includes detailed information about the VM.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--machinereadable</option></term>
+          <listitem><para>
+              Specifies that the VM information be in a machine-readable
+              format.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--password-id  <replaceable>id</replaceable></option></term>
+          <listitem><para>
+              Specifies password id of the VM if it is encrypted.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--password <replaceable>file</replaceable>|-</option></term>
+          <listitem><para>
+              Specifies password of the VM if it is encrypted. Either
+              specify the absolute pathname of a password file on the
+              host operating system, or <literal>-</literal> to prompt
+              you for the password.
+            </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+    <refsect2 id="vboxmanage-showvminfo-log">
+      <title>Viewing Virtual Machine Log Contents</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage showvminfo --log</command> command
+        outputs the contents of one of the specified VM's log files.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--log=<replaceable>index</replaceable></option></term>
+          <listitem><para>
+              Specifies a numerical index that identifies the log file.
+            </para><para>
+              The index value starts at <literal>0</literal>, which
+              indicates the <filename>VBox.log</filename> file. An index
+              value of <literal>1</literal> indicates the
+              <filename>VBoxHardening.log</filename> file. Index values
+              starting at <literal>2</literal> indicate other log files,
+              such as the <filename>VBox.log.1</filename> file.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--password-id <replaceable>id</replaceable></option></term>
+          <listitem><para>
+              Specifies password id of the VM if it is encrypted.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--password <replaceable>file</replaceable>|-</option></term>
+          <listitem><para>
+              Specifies password of the VM if it is encrypted. Either
+              specify the absolute pathname of a password file on the
+              host operating system, or <literal>-</literal> to prompt
+              you for the password.
+            </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <remark role="help-scope" condition="GLOBAL"/>
+    <para>
+      The following example shows typical output for this command:
+    </para>
+<screen>$ VBoxManage showvminfo "Windows 10"
+VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
+Copyright (C) 2005-2023 Oracle and/or its affiliates
+
+Name:            Windows 10
+Groups:          /
+Guest OS:        Windows 10 (64-bit)
+UUID:            1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
+Config file:     /home/username/VirtualBox VMs/Windows 10/Windows 10.vbox
+Snapshot folder: /home/username/VirtualBox VMs/Windows 10/Snapshots
+Log folder:      /home/username/VirtualBox VMs/Windows 10/Logs
+Hardware UUID:   1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
+Memory size:     2048MB
+Page Fusion:     off
+VRAM size:       12MB
+CPU exec cap:    100%
+...</screen>
+    <para>
+      The following example shows the information output in a
+      machine-readable format, which shows the entries as a
+      <replaceable>property</replaceable>=<replaceable>value</replaceable>
+      string:
+    </para>
+<screen>$ VBoxManage showvminfo "Windows 10" --machinereadable
+...
+groups="/"
+ostype="Windows 10 (64-bit)"
+UUID="1bf3464d-57c6-4d49-92a9-a5cc3816b7e7"
+...</screen>
+    <para>
+      The following example shows the contents of the
+      <filename>VBox.log</filename> log file:
+    </para>
+<screen>$ VBoxManage showvminfo "Windows 10" --log 0
+00:00:02.895106 VirtualBox VM 6.0.0_RC1 r127378 linux.amd64 (Dec 10 2018 17:16:06) release log
+00:00:02.895109 Log opened 2018-12-14T14:31:44.088259000Z
+00:00:02.895111 Build Type: release
+00:00:02.895115 OS Product: Linux
+00:00:02.895117 OS Release: 4.1.12-61.1.22.el7uek.x86_64
+00:00:02.895119 OS Version: #2 SMP Fri Dec 2 09:28:44 PST 2016
+...</screen>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <xref linkend="vboxmanage-list" />
+    </para>
+  </refsect1>
+</refentry>
-- 
cgit v1.2.3