mirror of
https://github.com/Zenithsiz/ftmemsim-valgrind.git
synced 2026-02-03 18:13:01 +00:00
Bug 321738 Add manpages for vgdb and valgrind-listener.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13443
This commit is contained in:
Mark Wielaard
parent
7d4cc60c1f
commit
defd29702f
@ -11,6 +11,7 @@ dist_noinst_SCRIPTS = \
|
||||
posixtestsuite-1.5.1-diff-results
|
||||
|
||||
EXTRA_DIST = \
|
||||
docs/valgrind-listener-manpage.xml \
|
||||
DotToScc.hs \
|
||||
Merge3Way.hs \
|
||||
gsl16-badfree.patch \
|
||||
|
||||
74
auxprogs/docs/valgrind-listener-manpage.xml
Normal file
74
auxprogs/docs/valgrind-listener-manpage.xml
Normal file
@ -0,0 +1,74 @@
|
||||
<?xml version="1.0"?> <!-- -*- sgml -*- -->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
||||
[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
|
||||
|
||||
|
||||
<refentry id="listener">
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>valgrind-listener</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo>Release &rel-version;</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>valgrind-listener</refname>
|
||||
<refpurpose>listens on a socket for Valgrind commentary</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>valgrind-listener</command>
|
||||
<arg><replaceable>options</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
|
||||
<para><command>valgrind-listener</command> accepts (multiple) connections
|
||||
from <command>valgrind</command> processes that use the
|
||||
<option>--log-socket</option> option on the specified port and copies the
|
||||
commentary it is sent to stdout.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
|
||||
<xi:include href="../../docs/xml/manual-core.xml" xpointer="listener.opts.list"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1 id="see_also">
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
valgrind(1),
|
||||
<filename>&vg-docs-path;</filename> or
|
||||
<filename>&vg-docs-url;</filename>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 id="author">
|
||||
<title>Author</title>
|
||||
|
||||
<para>Julian Seward.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
</refentry>
|
||||
|
||||
|
||||
@ -24,7 +24,8 @@ endif
|
||||
EXTRA_DIST = \
|
||||
m_debuginfo/UNUSED_STABS.txt \
|
||||
m_debuginfo/README.txt \
|
||||
m_gdbserver/README_DEVELOPERS
|
||||
m_gdbserver/README_DEVELOPERS \
|
||||
docs/vgdb-manpage.xml
|
||||
|
||||
#----------------------------------------------------------------------------
|
||||
# The launcher. Built for the primary target only.
|
||||
|
||||
84
coregrind/docs/vgdb-manpage.xml
Normal file
84
coregrind/docs/vgdb-manpage.xml
Normal file
@ -0,0 +1,84 @@
|
||||
<?xml version="1.0"?> <!-- -*- sgml -*- -->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
||||
[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
|
||||
|
||||
|
||||
<refentry id="vgdb">
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>vgdb</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo>Release &rel-version;</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>vgdb</refname>
|
||||
<refpurpose>intermediary between Valgrind and GDB or a shell</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>vgdb</command>
|
||||
<arg><replaceable>options</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
|
||||
<para><command>vgdb</command> ("Valgrind to GDB") is used as an
|
||||
intermediary between Valgrind and GDB or a shell. It has two usage modes:
|
||||
</para>
|
||||
|
||||
<xi:include href="../../docs/xml/manual-core-adv.xml"
|
||||
xpointer="vgdb.desc.modes"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
|
||||
<xi:include href="../../docs/xml/manual-core-adv.xml"
|
||||
xpointer="vgdb.opts.list"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1 id="see_also">
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
valgrind(1),
|
||||
<filename>&vg-docs-path;</filename> or
|
||||
<filename>&vg-docs-url;</filename>,
|
||||
<ulink id="&vg-gdbserver-id;"
|
||||
xreflabel="&vg-gdbserver-label;"
|
||||
url="&vg-gdbserver-url;">&vg-gdbserver-label;</ulink>
|
||||
<ulink id="&vg-vgdb-id;"
|
||||
xreflabel="&vg-vgdb-label;"
|
||||
url="&vg-vgdb-url;">&vg-vgdb-label;</ulink>,
|
||||
<ulink id="&vg-monitor-id;"
|
||||
xreflabel="&vg-monitor-label;"
|
||||
url="&vg-monitor-url;">&vg-monitor-label;</ulink>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 id="author">
|
||||
<title>Author</title>
|
||||
|
||||
<para>Philippe Waroquiers.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
</refentry>
|
||||
|
||||
|
||||
@ -35,5 +35,13 @@
|
||||
<xi:include href="../../massif/docs/ms_print-manpage.xml" parse="xml"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
<!-- valgrind-listener -->
|
||||
<xi:include href="../../auxprogs/docs/valgrind-listener-manpage.xml"
|
||||
parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
<!-- vgdb -->
|
||||
<xi:include href="../../coregrind/docs/vgdb-manpage.xml"
|
||||
parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
</set>
|
||||
|
||||
|
||||
@ -1102,7 +1102,8 @@ $5 = 36
|
||||
intermediary between Valgrind and GDB or a shell.
|
||||
Therefore, it has two usage modes:
|
||||
</para>
|
||||
<orderedlist>
|
||||
<!-- start of xi:include in the manpage -->
|
||||
<orderedlist id="vgdb.desc.modes">
|
||||
<listitem id="manual-core-adv.vgdb-standalone" xreflabel="vgdb standalone">
|
||||
<para>As a standalone utility, it is used from a shell command
|
||||
line to send monitor commands to a process running under
|
||||
@ -1121,28 +1122,33 @@ Therefore, it has two usage modes:
|
||||
</listitem>
|
||||
|
||||
</orderedlist>
|
||||
<!-- end of xi:include in the manpage -->
|
||||
|
||||
<para><computeroutput>vgdb</computeroutput> accepts the following
|
||||
options:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><option>--pid=<number></option>: specifies the PID of
|
||||
<!-- start of xi:include in the manpage -->
|
||||
<variablelist id="vgdb.opts.list">
|
||||
<varlistentry>
|
||||
<term><option>--pid=<number></option></term>
|
||||
<listitem><para>Specifies the PID of
|
||||
the process to which vgdb must connect to. This option is useful
|
||||
in case more than one Valgrind gdbserver can be connected to. If
|
||||
the <option>--pid</option> argument is not given and multiple
|
||||
Valgrind gdbserver processes are running, vgdb will report the
|
||||
list of such processes and then exit.</para>
|
||||
</listitem>
|
||||
list of such processes and then exit.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>--vgdb-prefix</option> must be given to both
|
||||
<varlistentry>
|
||||
<term><option>--vgdb-prefix</option></term>
|
||||
<listitem><para>Must be given to both
|
||||
Valgrind and vgdb if you want to change the default prefix for the
|
||||
FIFOs (named pipes) used for communication between the Valgrind
|
||||
gdbserver and vgdb. </para>
|
||||
</listitem>
|
||||
gdbserver and vgdb.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>--wait=<number></option> instructs vgdb to
|
||||
<varlistentry>
|
||||
<term><option>--wait=<number></option></term>
|
||||
<listitem><para>Instructs vgdb to
|
||||
search for available Valgrind gdbservers for the specified number
|
||||
of seconds. This makes it possible start a vgdb process
|
||||
before starting the Valgrind gdbserver with which you intend the
|
||||
@ -1153,11 +1159,12 @@ options:</para>
|
||||
"target remote" command, you must set the GDB remotetimeout to a
|
||||
value bigger than the --wait argument value. See option
|
||||
<option>--max-invoke-ms</option> (just below)
|
||||
for an example of setting the remotetimeout value.</para>
|
||||
</listitem>
|
||||
for an example of setting the remotetimeout value.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>--max-invoke-ms=<number></option> gives the
|
||||
<varlistentry>
|
||||
<term><option>--max-invoke-ms=<number></option></term>
|
||||
<listitem><para>Gives the
|
||||
number of milliseconds after which vgdb will force the invocation
|
||||
of gdbserver embedded in Valgrind. The default value is 100
|
||||
milliseconds. A value of 0 disables forced invocation. The forced
|
||||
@ -1175,18 +1182,20 @@ options:</para>
|
||||
<screen><![CDATA[
|
||||
(gdb) set remotetimeout 6
|
||||
]]></screen>
|
||||
</para>
|
||||
</listitem>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>--cmd-time-out=<number></option> instructs a
|
||||
<varlistentry>
|
||||
<term><option>--cmd-time-out=<number></option></term>
|
||||
<listitem><para>Instructs a
|
||||
standalone vgdb to exit if the Valgrind gdbserver it is connected
|
||||
to does not process a command in the specified number of seconds.
|
||||
The default value is to never time out.</para>
|
||||
</listitem>
|
||||
The default value is to never time out.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>--port=<portnr></option> instructs vgdb to
|
||||
<varlistentry>
|
||||
<term><option>--port=<portnr></option></term>
|
||||
<listitem><para>Instructs vgdb to
|
||||
use tcp/ip and listen for GDB on the specified port nr rather than
|
||||
to use a pipe to communicate with GDB. Using tcp/ip allows to have
|
||||
GDB running on one computer and debugging a Valgrind process
|
||||
@ -1204,41 +1213,46 @@ gdb prog
|
||||
(gdb) target remote targetip:1234
|
||||
]]></screen>
|
||||
where targetip is the ip address or hostname of the target computer.
|
||||
</para>
|
||||
</listitem>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>-c</option> To give more than one command to a
|
||||
<varlistentry>
|
||||
<term><option>-c</option></term>
|
||||
<listitem><para>To give more than one command to a
|
||||
standalone vgdb, separate the commands by an
|
||||
option <option>-c</option>. Example:
|
||||
<screen><![CDATA[
|
||||
vgdb v.set log_output -c leak_check any
|
||||
]]></screen></para>
|
||||
</listitem>
|
||||
]]></screen></para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>-l</option> instructs a standalone vgdb to report
|
||||
<varlistentry>
|
||||
<term><option>-l</option></term>
|
||||
<listitem><para>Instructs a standalone vgdb to report
|
||||
the list of the Valgrind gdbserver processes running and then
|
||||
exit.</para>
|
||||
</listitem>
|
||||
exit.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>-D</option> instructs a standalone vgdb to show the
|
||||
<varlistentry>
|
||||
<term><option>-D</option></term>
|
||||
<listitem><para>Instructs a standalone vgdb to show the
|
||||
state of the shared memory used by the Valgrind gdbserver. vgdb
|
||||
will exit after having shown the Valgrind gdbserver shared memory
|
||||
state.</para>
|
||||
</listitem>
|
||||
state.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<listitem>
|
||||
<para><option>-d</option> instructs vgdb to produce debugging
|
||||
<varlistentry>
|
||||
<term><option>-d</option></term>
|
||||
<listitem><para>Instructs vgdb to produce debugging
|
||||
output. Give multiple <option>-d</option> args to increase the
|
||||
verbosity. When giving <option>-d</option> to a relay vgdb, you better
|
||||
redirect the standard error (stderr) of vgdb to a file to avoid
|
||||
interaction between GDB and vgdb debugging output.</para>
|
||||
</listitem>
|
||||
interaction between GDB and vgdb debugging output.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</variablelist>
|
||||
<!-- end of xi:include in the manpage -->
|
||||
|
||||
</sect2>
|
||||
|
||||
|
||||
|
||||
@ -237,21 +237,27 @@ re-run, passing the <option>-v</option> option to Valgrind. A second
|
||||
|
||||
<para><computeroutput>valgrind-listener</computeroutput> accepts two
|
||||
command-line options:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><option>-e</option> or <option>--exit-at-zero</option>:
|
||||
when the number of connected processes falls back to zero,
|
||||
exit. Without this, it will run forever, that is, until you
|
||||
send it Control-C.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><option>portnumber</option>: changes the port it listens
|
||||
on from the default (1500). The specified port must be in the
|
||||
range 1024 to 65535. The same restriction applies to port
|
||||
numbers specified by a <option>--log-socket</option> to
|
||||
Valgrind itself.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<!-- start of xi:include in the manpage -->
|
||||
<variablelist id="listener.opts.list">
|
||||
<varlistentry>
|
||||
<term><option>-e --exit-at-zero</option></term>
|
||||
<listitem>
|
||||
<para>When the number of connected processes falls back to zero,
|
||||
exit. Without this, it will run forever, that is, until you
|
||||
send it Control-C.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>portnumber</option></term>
|
||||
<listitem>
|
||||
<para>Changes the port it listens on from the default (1500).
|
||||
The specified port must be in the range 1024 to 65535.
|
||||
The same restriction applies to port numbers specified by a
|
||||
<option>--log-socket</option> to Valgrind itself.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<!-- end of xi:include in the manpage -->
|
||||
|
||||
<para>If a Valgrinded process fails to connect to a listener, for
|
||||
whatever reason (the listener isn't running, invalid or unreachable
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user