coregrind/docs/vgdb-manpage.xml

   1 <?xml version="1.0"?> <!-- -*- sgml -*- -->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3           "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
   4 [ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
   5
   6
   7 <refentry id="vgdb">
   8
   9 <refmeta>
  10   <refentrytitle>vgdb</refentrytitle>
  11   <manvolnum>1</manvolnum>
  12   <refmiscinfo class="version">Release &rel-version;</refmiscinfo>
  13 </refmeta>
  14
  15 <refnamediv>
  16   <refname>vgdb</refname>
  17   <refpurpose>intermediary between Valgrind and GDB or a shell</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21 <cmdsynopsis>
  22   <command>vgdb</command>
  23   <arg><replaceable>options</replaceable></arg>
  24 </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27
  28 <refsect1 id="vgdb-description">
  29 <title>Description</title>
  30
  31 <para><command>vgdb</command> ("Valgrind to GDB") is used as an
  32 intermediary between Valgrind and GDB or a shell.  It has three usage modes:
  33 </para>
  34
  35 <xi:include href="../../docs/xml/manual-core-adv.xml"
  36             xpointer="vgdb.desc.modes"
  37             xmlns:xi="http://www.w3.org/2001/XInclude" />
  38
  39 </refsect1>
  40
  41 <refsect1 id="vgdb-options">
  42 <title>Options</title>
  43
  44 <xi:include href="../../docs/xml/manual-core-adv.xml"
  45             xpointer="vgdb.opts.list"
  46             xmlns:xi="http://www.w3.org/2001/XInclude" />
  47
  48 </refsect1>
  49
  50
  51
  52
  53 <refsect1 id="vgdb-see_also">
  54 <title>See Also</title>
  55
  56 <para>
  57 valgrind(1),
  58 <filename>&vg-docs-path;</filename> or
  59 <filename>&vg-docs-url;</filename>,
  60 <!-- Note that the ids used have vgdb- prefixed.  This is because the same
  61      ids are used in the valgrind.1 man page.  That conflict even though
  62      the valgrind.1 and vgdb.1 manual page are generated separately.  It
  63      still works fine, since in vgdb the references are only direct in this
  64      "See Also" refsect. The labels and urls still come out as intended.  -->
  65 <ulink id="vgdb-&vg-gdbserver-id;"
  66        xreflabel="&vg-gdbserver-label;"
  67        url="&vg-gdbserver-url;">&vg-gdbserver-label;</ulink>
  68 <ulink id="vgdb-&vg-vgdb-id;"
  69        xreflabel="&vg-vgdb-label;"
  70        url="&vg-vgdb-url;">&vg-vgdb-label;</ulink>,
  71 <ulink id="vgdb-&vg-monitor-id;"
  72        xreflabel="&vg-monitor-label;"
  73        url="&vg-monitor-url;">&vg-monitor-label;</ulink>.
  74 </para>
  75
  76 </refsect1>
  77
  78
  79 <refsect1 id="vgdb-author">
  80 <title>Author</title>
  81
  82 <para>Philippe Waroquiers.</para>
  83
  84 </refsect1>
  85
  86
  87 </refentry>
  88
  89