VirtualBox

Changeset 56568 in vbox for trunk/doc


Ignore:
Timestamp:
Jun 20, 2015 8:36:01 PM (10 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
101194
Message:

Completed man_VBoxManage-debugvm.xml and implemented a few new tricks in docbook-refentry-to-C-help.xsl.

Location:
trunk/doc/manual
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Makefile.kmk

    r56565 r56568  
    877877        $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ \
    878878                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
    879 # ifdef VBOX_HAVE_XMLLINT
    880 #       $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
    881 # endif
     879if defined(VBOX_HAVE_XMLLINT) && "$(USER)" == "bird" # Effing stuff happends on build servers, probably kmk related...
     880        $$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
     881endif
    882882
    883883$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \

  • trunk/doc/manual/docbook-refentry-to-C-help.xsl

    r56565 r56568  
    2828  <xsl:output method="text" version="1.0" encoding="utf-8" indent="yes"/>
    2929  <xsl:strip-space elements="*"/>
     30
     31  <xsl:param name="g_fDebugText" select="0"/>
    3032
    3133  <xsl:variable name="g_sUnderlineRefSect1">
    … …  
    332334
    333335  <xsl:template match="varlistentry/listitem">
    334     <xsl:if test="text() or *[not(self::para or self::itemizedlist)]">
    335       <xsl:message terminate="yes">Expected varlistentry/listitem to only contain para elements</xsl:message>
     336    <xsl:if test="text() or *[not(self::para or self::itemizedlist or self::orderedlist)]">
     337      <xsl:message terminate="yes">Expected varlistentry/listitem to only contain para, itemizedlist and orderedlist elements</xsl:message>
    336338    </xsl:if>
    337339    <xsl:apply-templates select="*"/>
    … …  
    340342
    341343  <!--
    342     itemizedlist
    343     -->
    344   <xsl:template match="itemizedlist">
     344    itemizedlist and orderedlist
     345    -->
     346  <xsl:template match="itemizedlist|orderedlist">
    345347    <xsl:if test="*[not(self::listitem)]|text()">
    346       <xsl:message terminate="yes">Only listitem elements are supported in itemizedlist.</xsl:message>
     348      <xsl:message terminate="yes">Only listitem elements are supported in <xsl:value-of select="name()"/>.</xsl:message>
    347349    </xsl:if>
    348350    <xsl:if test="parent::para">
    349       <xsl:message terminate="yes">itemizedlist inside a para is current not supported. <!-- no newline
     351      <xsl:message terminate="yes"><xsl:value-of select="name()"/> inside a para is current not supported. <!-- no newline
    350352        -->Close the para before the list, it makes no difference to html and latex/pdf output.</xsl:message>
    351353    </xsl:if>
    … …  
    359361  </xsl:template>
    360362
    361   <xsl:template match="itemizedlist/listitem">
     363  <xsl:template match="itemizedlist/listitem|orderedlist/listitem">
    362364    <xsl:if test="text() or *[not(self::para)]">
    363       <xsl:message terminate="yes">Expected itemizedlist/listitem to only contain para elements</xsl:message>
     365      <xsl:message terminate="yes">Expected <xsl:value-of select="name()"/>/listitem to only contain para elements</xsl:message>
    364366    </xsl:if>
    365367    <xsl:if test="position() != 1 and @spaceing != 'compact'">
    … …  
    420422
    421423
    422 
    423424  <!--
    424425    Text escaping for C.
    425426    -->
    426427  <xsl:template match="text()" name="escape_text">
     428    <!-- Leading whitespace hack! -->
     429    <xsl:if test="substring(.,1,1) = ' ' and position() != 1">
     430      <xsl:text> </xsl:text>
     431      <xsl:if test="boolean($g_fDebugText)">
     432        <xsl:message>text: add space</xsl:message>
     433      </xsl:if>
     434    </xsl:if>
     435
     436    <!-- Body of text -->
    427437    <xsl:choose>
    428438
    … …  
    436446          </xsl:call-template>
    437447        </xsl:variable>
    438         <xsl:call-template name="str:subst">
    439           <xsl:with-param name="text" select="$sTmp"/>
    440           <xsl:with-param name="replace" select="'&quot;'"/>
    441           <xsl:with-param name="with" select="'\&quot;'"/>
    442           <xsl:with-param name="disable-output-escaping" select="yes"/>
    443         </xsl:call-template>
     448        <xsl:variable name="sTmp2">
     449          <xsl:call-template name="str:subst">
     450            <xsl:with-param name="text" select="$sTmp"/>
     451            <xsl:with-param name="replace" select="'&quot;'"/>
     452            <xsl:with-param name="with" select="'\&quot;'"/>
     453            <xsl:with-param name="disable-output-escaping" select="yes"/>
     454          </xsl:call-template>
     455        </xsl:variable>
     456        <xsl:value-of select="$sTmp2"/>
     457        <xsl:if test="boolean($g_fDebugText)">
     458          <xsl:message>text: |<xsl:value-of select="$sTmp2"/>|</xsl:message>
     459        </xsl:if>
    444460      </xsl:when>
    445461
    446462      <xsl:otherwise>
    447463        <xsl:value-of select="normalize-space(.)"/>
    448       </xsl:otherwise>
    449     </xsl:choose>
    450 
    451     <!-- Ugly whitespace hack! Mainly for <arg>-_-cpu <replaceable>id</replaceable></arg> -->
    452     <xsl:if test="substring(.,string-length(.)) = ' ' and position() != last()">
     464        <xsl:if test="boolean($g_fDebugText)">
     465          <xsl:message>text: |<xsl:value-of select="normalize-space(.)"/>|</xsl:message>
     466        </xsl:if>
     467      </xsl:otherwise>
     468    </xsl:choose>
     469
     470    <!-- Trailing whitespace hack! -->
     471    <xsl:if test="substring(.,string-length(.)) = ' ' and position() != last() and string-length(.) != 1">
    453472      <xsl:text> </xsl:text>
     473      <xsl:if test="boolean($g_fDebugText)">
     474        <xsl:message>text: add space</xsl:message>
     475      </xsl:if>
    454476    </xsl:if>
    455477
    … …  
    478500          </xsl:call-template>
    479501        </xsl:variable>
    480         <xsl:call-template name="str:subst">
    481           <xsl:with-param name="text" select="$sTmp2"/>
    482           <xsl:with-param name="replace" select="' '"/>
    483           <xsl:with-param name="with" select="'\b'"/>
    484           <xsl:with-param name="disable-output-escaping" select="yes"/>
    485         </xsl:call-template>
     502        <xsl:variable name="sTmp3">
     503          <xsl:call-template name="str:subst">
     504            <xsl:with-param name="text" select="$sTmp2"/>
     505            <xsl:with-param name="replace" select="' '"/>
     506            <xsl:with-param name="with" select="'\b'"/>
     507            <xsl:with-param name="disable-output-escaping" select="yes"/>
     508          </xsl:call-template>
     509        </xsl:variable>
     510        <xsl:value-of select="$sTmp3"/>
     511        <xsl:if test="boolean($g_fDebugText)">
     512          <xsl:message>text! |<xsl:value-of select="$sTmp3"/>|</xsl:message>
     513        </xsl:if>
    486514      </xsl:when>
    487515
    488516      <xsl:when test="contains($sText, ' ')">
    489         <xsl:call-template name="str:subst">
    490           <xsl:with-param name="text" select="$sText"/>
    491           <xsl:with-param name="replace" select="' '"/>
    492           <xsl:with-param name="with" select="'\b'"/>
    493           <xsl:with-param name="disable-output-escaping" select="yes"/>
    494         </xsl:call-template>
     517        <xsl:variable name="sTmp">
     518          <xsl:call-template name="str:subst">
     519            <xsl:with-param name="text" select="$sText"/>
     520            <xsl:with-param name="replace" select="' '"/>
     521            <xsl:with-param name="with" select="'\b'"/>
     522            <xsl:with-param name="disable-output-escaping" select="yes"/>
     523          </xsl:call-template>
     524        </xsl:variable>
     525        <xsl:value-of select="$sTmp"/>
     526        <xsl:if test="boolean($g_fDebugText)">
     527          <xsl:message>text! |<xsl:value-of select="$sTmp"/>|</xsl:message>
     528        </xsl:if>
    495529      </xsl:when>
    496530
    497531      <xsl:otherwise>
    498532        <xsl:value-of select="$sText"/>
     533        <xsl:if test="boolean($g_fDebugText)">
     534          <xsl:message>text! |<xsl:value-of select="$sText"/>|</xsl:message>
     535        </xsl:if>
    499536      </xsl:otherwise>
    500537    </xsl:choose>
    … …  
    562599
    563600    <xsl:for-each select="node()[not(self::remark)]">
    564       <xsl:if test="position() != 1">
    565         <xsl:text> </xsl:text>
    566       </xsl:if>
    567601      <xsl:choose>
    568602        <xsl:when test="name() = ''">
    … …  
    712746    <xsl:for-each select="ancestor-or-self::*">
    713747      <xsl:choose>
     748
    714749        <xsl:when test="self::refsect1
    715750                      | self::refsect2
    … …  
    718753          <xsl:text>  </xsl:text>
    719754        </xsl:when>
    720         <xsl:when test="self::term"/> <!-- currently no indent. -->
    721         <xsl:when test="self::listitem and parent::varlistentry">
     755
     756        <xsl:when test="self::term">
     757           <!-- currently no indent. -->
     758        </xsl:when>
     759
     760        <!-- Evidence here (especially with orderedlist) that doing list by for-each
     761             listitem in the template matching the list type would be easier... -->
     762        <xsl:when test="self::listitem and parent::itemizedlist and (position() + 1) = $iDepth">
     763          <xsl:text>  - </xsl:text>
     764        </xsl:when>
     765
     766        <xsl:when test="self::listitem and parent::orderedlist and (position() + 1) = $iDepth">
     767          <xsl:variable name="iNumber" select="count(preceding-sibling::listitem) + 1"/>
     768          <xsl:if test="$iNumber &lt;= 9">
     769            <xsl:text> </xsl:text>
     770          </xsl:if>
     771          <xsl:value-of select="$iNumber"/>
     772          <xsl:text>. </xsl:text>
     773        </xsl:when>
     774
     775        <xsl:when test="self::listitem">
    722776          <xsl:text>    </xsl:text>
    723777        </xsl:when>
    724         <xsl:when test="self::listitem and parent::itemizedlist and (position() + 1) = $iDepth">
    725           <xsl:text>  * </xsl:text>
    726         </xsl:when>
    727         <xsl:when test="self::listitem and parent::itemizedlist">
    728           <xsl:text>    </xsl:text>
    729         </xsl:when>
     778
    730779      </xsl:choose>
    731780    </xsl:for-each>

  • trunk/doc/manual/en_US/man_VBoxManage-debugvm.xml

    r56565 r56568  
    3737      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    3838      <arg choice="plain">dumpvmcore</arg>
    39       <arg>--filename <replaceable>name</replaceable></arg>
     39      <arg>--filename=<replaceable>name</replaceable></arg>
    4040    </cmdsynopsis>
    4141    <cmdsynopsis id="synopsis-vboxmanage-debugvm-info">
    … …  
    8686      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    8787      <arg choice="plain">osdmesg</arg>
    88       <arg>--lines <replaceable>lines</replaceable></arg>
     88      <arg>--lines=<replaceable>lines</replaceable></arg>
    8989    </cmdsynopsis>
    9090    <cmdsynopsis id="synopsis-vboxmanage-debugvm-getregisters">
    … …  
    9292      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    9393      <arg choice="plain">getregisters</arg>
    94       <arg>--cpu <replaceable>id</replaceable></arg>
     94      <arg>--cpu=<replaceable>id</replaceable></arg>
    9595      <arg rep="repeat"><replaceable>reg-set.reg-name</replaceable></arg>
    9696    </cmdsynopsis>
    … …  
    9999      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    100100      <arg choice="plain">setregisters</arg>
    101       <arg>--cpu <replaceable>id</replaceable></arg>
     101      <arg>--cpu=<replaceable>id</replaceable></arg>
    102102      <arg rep="repeat"><replaceable>reg-set.reg-name=value</replaceable></arg>
    103103    </cmdsynopsis>
    … …  
    115115      <arg>--reset</arg>
    116116      <arg>--descriptions</arg>
    117       <arg>--pattern <replaceable>pattern</replaceable></arg>
     117      <arg>--pattern=<replaceable>pattern</replaceable></arg>
    118118    </cmdsynopsis>
    119119  </refsynopsisdiv>
    … …  
    153153      <variablelist>
    154154        <varlistentry>
    155           <term><option>--filename <replaceable>filename</replaceable></option></term>
     155          <term><option>--filename=<replaceable>filename</replaceable></option></term>
    156156          <listitem><para>The name of the output file.</para></listitem>
    157157        </varlistentry>
    … …  
    204204      <remark role="help-copy-synopsis"/>
    205205      <para>
    206         TODO
     206        Changes the group settings for either debug (<option>--debug</option>)
     207        or release (<option>--release</option>) logger of the VM process.
     208      </para>
     209      <para>
     210        The <replaceable>group-settings</replaceable> are typically strings on the form
     211        <computeroutput>em.e.f.l</computeroutput>, <computeroutput>hm=~0</computeroutput>
     212        and <computeroutput>-em.f</computeroutput>.  Basic wildcards are supported for
     213        group matching.  The <computeroutput>all</computeroutput> group is an alias for
     214        all the groups.
     215      </para>
     216      <para>
     217        Please do keep in mind that the group settings are applied as modifications
     218        to the current ones.
     219      </para>
     220      <para>
     221        This corresponds to the <command>log</command> command in the debugger.
    207222      </para>
    208223    </refsect2>
    … …  
    212227      <remark role="help-copy-synopsis"/>
    213228      <para>
    214         TODO
     229        Changes the destination settings for either debug (<option>--debug</option>)
     230        or release (<option>--release</option>) logger of the VM process.  For details
     231        on the destination format, the best source is src/VBox/Runtime/common/log/log.cpp.
     232      </para>
     233      <para>
     234        The <replaceable>destinations</replaceable> is one or more mnemonics, optionally
     235        prefixed by "no" to disable them.  Some of them take values after a ":" or "="
     236        separator.  Multiple mnemonics can be separated by space or given as separate
     237        arguments on the command line.
     238      </para>
     239      <para>
     240        List of available destination:
     241      </para>
     242      <variablelist>
     243        <varlistentry>
     244          <term><option>file[=<replaceable>file</replaceable>], nofile</option></term>
     245          <listitem><para>Specifies a log file.  It no filname is given, one will be
     246              generated based on the current UTC time and VM process name and placed in
     247              the current directory of the VM process.  Note that this will currently not
     248              have any effect if the log file has already been opened.
     249          </para></listitem>
     250        </varlistentry>
     251        <varlistentry>
     252          <term><option>dir=<replaceable>directory</replaceable>, nodir</option></term>
     253          <listitem><para>Specifies the output directory for log files.  Note that this
     254              will currently not  have any effect if the log file has already been opened.
     255          </para></listitem>
     256        </varlistentry>
     257        <varlistentry>
     258          <term><option>history=<replaceable>count</replaceable>, nohistory</option></term>
     259          <listitem><para>A non-zero value enables log historization, with the value
     260            specifying how many old log files to keep.
     261          </para></listitem>
     262        </varlistentry>
     263        <varlistentry>
     264          <term><option>histsize=<replaceable>bytes</replaceable></option></term>
     265          <listitem><para>The max size of a log file before it is historized.  Default is infinite.</para></listitem>
     266        </varlistentry>
     267        <varlistentry>
     268          <term><option>histtime=<replaceable>seconds</replaceable></option></term>
     269          <listitem><para>The max age (in seconds) of a log file before it is historized.  Default is infinite.</para></listitem>
     270        </varlistentry>
     271        <varlistentry>
     272          <term><option>ringbuffer, noringbuffer</option></term>
     273          <listitem><para>Only log to the log buffer until an explicit flush (e.g. via an assertion)
     274              occurs.  This is fast and saves diskspace.</para></listitem>
     275        </varlistentry>
     276        <varlistentry>
     277          <term><option>stdout, nostdout</option></term>
     278          <listitem><para>Write the log content to standard output.</para></listitem>
     279        </varlistentry>
     280        <varlistentry>
     281          <term><option>stdout, nostdout</option></term>
     282          <listitem><para>Write the log content to standard error.</para></listitem>
     283        </varlistentry>
     284        <varlistentry>
     285          <term><option>debugger, nodebugger</option></term>
     286          <listitem><para>Write the log content to the debugger, if supported by the host OS.</para></listitem>
     287        </varlistentry>
     288        <varlistentry>
     289          <term><option>com, nocom</option></term>
     290          <listitem><para>Writes logging to the COM port. This is only applicable for raw-mode and ring-0 logging.</para></listitem>
     291        </varlistentry>
     292        <varlistentry>
     293          <term><option>user, nouser</option></term>
     294          <listitem><para>Custom destination which has no meaning to VM processes..</para></listitem>
     295        </varlistentry>
     296      </variablelist>
     297      <para>
     298        This corresponds to the <command>logdest</command> command in the debugger.
    215299      </para>
    216300    </refsect2>
    … …  
    220304      <remark role="help-copy-synopsis"/>
    221305      <para>
    222         TODO
     306        Changes the flags on either debug (<option>--debug</option>) or release
     307        (<option>--release</option>) logger of the VM process.  Please note that the
     308        modifications are applied onto the existing changes, they are not replacing them.
     309      </para>
     310      <para>
     311        The <replaceable>flags</replaceable> are a list of flag mnemonics, optionally
     312        prefixed by a "no", "!", "~" or "-" to negate their meaning.  The "+" prefix
     313        can be used to undo previous negation or use as a separator, though better use
     314        whitespace or separate arguments for that.
     315      </para>
     316      <para>
     317        List of log flag mnemonics, with their counter form where applicable
     318        (asterisk indicates defaults):
     319      </para>
     320      <variablelist>
     321        <varlistentry>
     322          <term><option>enabled*, disabled</option></term>
     323          <listitem><para>Enables or disables logging.</para></listitem>
     324        </varlistentry>
     325        <varlistentry>
     326          <term><option>buffered, unbuffered*</option></term>
     327          <listitem><para>Enabling buffering of log output before it hits the destinations.</para></listitem>
     328        </varlistentry>
     329        <varlistentry>
     330          <term><option>writethrough(/writethru)</option></term>
     331          <listitem><para>Whether to open the destination file with writethru buffering settings or not.</para></listitem>
     332        </varlistentry>
     333        <varlistentry>
     334          <term><option>flush</option></term>
     335          <listitem><para>Enables flushing of the output file (to disk) after each log statement.</para></listitem>
     336        </varlistentry>
     337        <!-- Prefixes -->
     338        <varlistentry>
     339          <term><option>lockcnts</option></term>
     340          <listitem><para>Prefix each log line with lock counts for the current thread.</para></listitem>
     341        </varlistentry>
     342        <varlistentry>
     343          <term><option>cpuid</option></term>
     344          <listitem><para>Prefix each log line with the ID of the current CPU.</para></listitem>
     345        </varlistentry>
     346        <varlistentry>
     347          <term><option>pid</option></term>
     348          <listitem><para>Prefix each log line with the current process ID.</para></listitem>
     349        </varlistentry>
     350        <varlistentry>
     351          <term><option>flagno</option></term>
     352          <listitem><para>Prefix each log line with the numberic flags corresponding to the log statement.</para></listitem>
     353        </varlistentry>
     354        <varlistentry>
     355          <term><option>flag</option></term>
     356          <listitem><para>Prefix each log line with the flag mnemonics corresponding to the log statement.</para></listitem>
     357        </varlistentry>
     358        <varlistentry>
     359          <term><option>groupno</option></term>
     360          <listitem><para>Prefix each log line with the log group number for the log statement producing it.</para></listitem>
     361        </varlistentry>
     362        <varlistentry>
     363          <term><option>group</option></term>
     364          <listitem><para>Prefix each log line with the log group name for the log statement producing it.</para></listitem>
     365        </varlistentry>
     366        <varlistentry>
     367          <term><option>tid</option></term>
     368          <listitem><para>Prefix each log line with the current thread identifier.</para></listitem>
     369        </varlistentry>
     370        <varlistentry>
     371          <term><option>thread</option></term>
     372          <listitem><para>Prefix each log line with the current thread name.</para></listitem>
     373        </varlistentry>
     374        <varlistentry>
     375          <term><option>time</option></term>
     376          <listitem><para>Prefix each log line with the current UTC wall time.</para></listitem>
     377        </varlistentry>
     378        <varlistentry>
     379          <term><option>timeprog</option></term>
     380          <listitem><para>Prefix each log line with the current monotonic time since the start of the program.</para></listitem>
     381        </varlistentry>
     382        <varlistentry>
     383          <term><option>msprog</option></term>
     384          <listitem><para>Prefix each log line with the current monotonic timestamp value in milliseconds since the start of the program.</para></listitem>
     385        </varlistentry>
     386        <varlistentry>
     387          <term><option>ts</option></term>
     388          <listitem><para>Prefix each log line with the current monotonic timestamp value in nanoseconds.</para></listitem>
     389        </varlistentry>
     390        <varlistentry>
     391          <term><option>tsc</option></term>
     392          <listitem><para>Prefix each log line with the current CPU timestamp counter (TSC) value.</para></listitem>
     393        </varlistentry>
     394        <varlistentry>
     395          <term><option>rel, abs*</option></term>
     396          <listitem><para>Selects the whether <computeroutput>ts</computeroutput> and
     397              <computeroutput>tsc</computeroutput> prefixes should be displayed as relative to the
     398              previous log line or as absolute time.</para></listitem>
     399        </varlistentry>
     400        <varlistentry>
     401          <term><option>hex*, dec</option></term>
     402          <listitem><para>Selects the whether the <computeroutput>ts</computeroutput> and
     403              <computeroutput>tsc</computeroutput> prefixes should be formatted as hexadecimal
     404              or decimal.</para></listitem>
     405        </varlistentry>
     406
     407        <!-- Suffixes and weird stuff. -->
     408        <varlistentry>
     409          <term><option>custom</option></term>
     410          <listitem><para>Custom log prefix, has by default no meaning for VM processes.</para></listitem>
     411        </varlistentry>
     412
     413        <varlistentry>
     414          <term><option>usecrlf, uself*</option></term>
     415          <listitem><para>Output with DOS style (CRLF) or just UNIX style (LF) line endings.</para></listitem>
     416        </varlistentry>
     417        <varlistentry>
     418          <term><option>overwrite*, append</option></term>
     419          <listitem><para>Overwrite the destination file or append to it.</para></listitem>
     420        </varlistentry>
     421      </variablelist>
     422
     423      <para>
     424        This corresponds to the <command>logflags</command> command in the debugger.
    223425      </para>
    224426    </refsect2>
    … …  
    253455      <variablelist>
    254456        <varlistentry>
    255           <term><option>--lines <replaceable>lines</replaceable></option></term>
     457          <term><option>--lines=<replaceable>lines</replaceable></option></term>
    256458          <listitem><para>Number of lines of the log to display, counting from
    257459          the end. The default is infinite.</para></listitem>
    … …  
    271473          <listitem>
    272474            <para>One of more registers, each having one of the following forms:</para>
    273             <itemizedlist>
    274               <listitem><para><replaceable>register-set.register-name.sub-field</replaceable></para></listitem>
    275               <listitem><para><replaceable>register-set.register-name</replaceable></para></listitem>
    276               <listitem><para><replaceable>cpu-register-name.sub-field</replaceable></para></listitem>
    277               <listitem><para><replaceable>cpu-register-name</replaceable></para></listitem>
    278               <listitem><para><replaceable>all</replaceable></para></listitem>
    279             </itemizedlist>
     475            <orderedlist>
     476              <listitem><para>register-set.register-name.sub-field</para></listitem>
     477              <listitem><para>register-set.register-name</para></listitem>
     478              <listitem><para>cpu-register-name.sub-field</para></listitem>
     479              <listitem><para>cpu-register-name</para></listitem>
     480              <listitem><para>all</para></listitem>
     481            </orderedlist>
    280482            <para>The <replaceable>all</replaceable> form will cause all registers
    281483              to be shown (no sub-fields).  The registers names are case-insensitive.
    … …  
    284486        </varlistentry>
    285487        <varlistentry>
     488          <term><option>--cpu=<replaceable>id</replaceable></option></term>
     489          <listitem><para>Selects the CPU register set when specifying just a
     490            CPU register (3rd and 4th form).  The default is 0.</para>
     491          </listitem>
     492        </varlistentry>
     493      </variablelist>
     494    </refsect2>
     495
     496    <refsect2 id="vboxmanage-debugvm-setregisters">
     497      <title>debugvm setregisters</title>
     498      <remark role="help-copy-synopsis"/>
     499      <para>
     500        Changes register values for guest CPUs and emulated devices.
     501      </para>
     502      <variablelist>
     503        <varlistentry>
     504          <term><replaceable>reg-set.reg-name=value</replaceable></term>
     505          <listitem>
     506            <para>One of more register assignment, each having one of the following forms:</para>
     507            <orderedlist>
     508              <listitem><para>register-set.register-name.sub-field=value</para></listitem>
     509              <listitem><para>register-set.register-name=value</para></listitem>
     510              <listitem><para>cpu-register-name.sub-field=value</para></listitem>
     511              <listitem><para>cpu-register-name=value</para></listitem>
     512            </orderedlist>
     513            <para>The value format should be in the same style as what
     514              <command>getregisters</command> displays, with the exception that
     515              both octal and decimal can be used instead of hexadecimal.</para>
     516          </listitem>
     517        </varlistentry>
     518        <varlistentry>
    286519          <term><option>--cpu <replaceable>id</replaceable></option></term>
    287520          <listitem><para>Selects the CPU register set when specifying just a
    … …  
    292525    </refsect2>
    293526
    294     <refsect2 id="vboxmanage-debugvm-setregisters">
    295       <title>debugvm setregisters</title>
    296       <remark role="help-copy-synopsis"/>
    297       <para>
    298         Changes register values for guest CPUs and emulated devices.
    299       </para>
    300       <variablelist>
    301         <varlistentry>
    302           <term><replaceable>reg-set.reg-name=value</replaceable></term>
    303           <listitem>
    304             <para>One of more register assignment, each having one of the following forms:</para>
    305             <itemizedlist>
    306               <listitem><para><replaceable>register-set.register-name.sub-field=value</replaceable></para></listitem>
    307               <listitem><para><replaceable>register-set.register-name=value</replaceable></para></listitem>
    308               <listitem><para><replaceable>cpu-register-name.sub-field=value</replaceable></para></listitem>
    309               <listitem><para><replaceable>cpu-register-name=value</replaceable></para></listitem>
    310             </itemizedlist>
    311             <para>The value format should be in the same style as what
    312               <command>getregisters</command> displays, with the exception that
    313               both octal and decimal can be used instead of hexadecimal.</para>
    314           </listitem>
    315         </varlistentry>
    316         <varlistentry>
    317           <term><option>--cpu <replaceable>id</replaceable></option></term>
    318           <listitem><para>Selects the CPU register set when specifying just a
    319             CPU register (3rd and 4th form).  The default is 0.</para>
    320           </listitem>
    321         </varlistentry>
    322       </variablelist>
    323     </refsect2>
    324 
    325527    <refsect2 id="vboxmanage-debugvm-show">
    326528      <title>debugvm show</title>
    327529      <remark role="help-copy-synopsis"/>
    328530      <para>
    329         TODO
    330       </para>
     531        Shows logging settings for the VM.
     532      </para>
     533      <variablelist>
     534        <varlistentry>
     535          <term><option>--human-readable</option></term>
     536          <listitem><para>Selects human readable output.</para></listitem>
     537        </varlistentry>
     538        <varlistentry>
     539          <term><option>--sh-export</option></term>
     540          <listitem><para>Selects output format as bourne shell style <command>export</command> commands.</para></listitem>
     541        </varlistentry>
     542        <varlistentry>
     543          <term><option>--sh-eval</option></term>
     544          <listitem><para>Selects output format as bourne shell style <command>eval</command> command input.</para></listitem>
     545        </varlistentry>
     546        <varlistentry>
     547          <term><option>--cmd-set</option></term>
     548          <listitem><para>Selects output format as DOS style <command>SET</command> commands.</para></listitem>
     549        </varlistentry>
     550        <varlistentry>
     551          <term><replaceable>settings-item</replaceable></term>
     552          <listitem>
     553            <para>What to display. One or more of the following:</para>
     554            <itemizedlist>
     555              <listitem><para>logdbg-settings - debug log settings.</para></listitem>
     556              <listitem><para>logrel-settings - release log settings.</para></listitem>
     557              <listitem><para>log-settings - alias for both debug and release log settings.</para></listitem>
     558            </itemizedlist>
     559          </listitem>
     560        </varlistentry>
     561      </variablelist>
     562
    331563    </refsect2>
    332564
    … …  
    342574      <variablelist>
    343575        <varlistentry>
    344           <term><option>--pattern <replaceable>pattern</replaceable></option></term>
     576          <term><option>--pattern=<replaceable>pattern</replaceable></option></term>
    345577          <listitem><para>DOS/NT-style wildcards patterns for selecting statistics.  Multiple
    346578            patterns can be specified by using the '|' (pipe) character as separator.</para>
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette