Changeset 103532 in vbox for trunk/doc/manual/en_US/man_VBoxManage-modifynvram.xml

Timestamp:

Feb 22, 2024 2:05:31 PM (10 months ago)

Author:

vboxsync

Message:

VBoxManage: Add subcommand for enabling UEFI secure boot (and show the status in the VM infos).
Main/NVRAMStore+UefiVariableStore: Tweaks to allow reading the UEFI secure boot state when the VM isn't mutable.
doc/manual: Update VBoxManage manpage.

File:

• trunk/doc/manual/en_US/man_VBoxManage-modifynvram.xml (modified) (2 diffs)

trunk/doc/manual/en_US/man_VBoxManage-modifynvram.xml

@@ -91 +91 @@
       <arg>--owner-uuid=<replaceable>uuid</replaceable></arg>
     </cmdsynopsis>
+    <cmdsynopsis id="synopsis-vboxmanage-modifynvram-secureboot">
+      <command>VBoxManage modifynvram</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg choice="plain">secureboot</arg>
+      <group choice="req">
+        <arg choice="plain">--enable</arg>
+        <arg choice="plain">--disable</arg>
+      </group>
+    </cmdsynopsis>
     <cmdsynopsis id="synopsis-vboxmanage-modifynvram-listvars">
       <command>VBoxManage modifynvram</command>
@@ -194 +206 @@
           <term><option>--owner-uuid=<replaceable>uuid</replaceable></option></term>
           <listitem><para>The UUID identifying the owner of the platform key.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
+    <refsect2 id="vboxmanage-modifynvram-secureboot">
+      <title>modifynvram secureboot</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Enables or disables UEFI secure boot.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--enable></option></term>
+          <listitem><para>Enables UEFI secure boot if the state of the key
+            enrolment permits.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--disable></option></term>
+          <listitem><para>Disables UEFI secure boot.</para>
           </listitem>
         </varlistentry>