diff --git a/auxprogs/Makefile.am b/auxprogs/Makefile.am
index a9f4b03c0..7cb0308ef 100644
--- a/auxprogs/Makefile.am
+++ b/auxprogs/Makefile.am
@@ -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 \
diff --git a/auxprogs/docs/valgrind-listener-manpage.xml b/auxprogs/docs/valgrind-listener-manpage.xml
new file mode 100644
index 000000000..da761b101
--- /dev/null
+++ b/auxprogs/docs/valgrind-listener-manpage.xml
@@ -0,0 +1,74 @@
+
+ %vg-entities; ]>
+
+
+
+
+
+ valgrind-listener
+ 1
+ Release &rel-version;
+
+
+
+ valgrind-listener
+ listens on a socket for Valgrind commentary
+
+
+
+
+ valgrind-listener
+ options
+
+
+
+
+
+Description
+
+valgrind-listener accepts (multiple) connections
+from valgrind processes that use the
+ option on the specified port and copies the
+commentary it is sent to stdout.
+
+
+
+
+
+
+
+Options
+
+
+
+
+
+
+
+
+
+See Also
+
+
+valgrind(1),
+&vg-docs-path; or
+&vg-docs-url;.
+
+
+
+
+
+
+Author
+
+Julian Seward.
+
+
+
+
+
+
+
diff --git a/coregrind/Makefile.am b/coregrind/Makefile.am
index 6d0fe83ff..32b02867a 100644
--- a/coregrind/Makefile.am
+++ b/coregrind/Makefile.am
@@ -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.
diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml
new file mode 100644
index 000000000..85a62aadc
--- /dev/null
+++ b/coregrind/docs/vgdb-manpage.xml
@@ -0,0 +1,84 @@
+
+ %vg-entities; ]>
+
+
+
+
+
+ vgdb
+ 1
+ Release &rel-version;
+
+
+
+ vgdb
+ intermediary between Valgrind and GDB or a shell
+
+
+
+
+ vgdb
+ options
+
+
+
+
+
+Description
+
+vgdb ("Valgrind to GDB") is used as an
+intermediary between Valgrind and GDB or a shell. It has two usage modes:
+
+
+
+
+
+
+
+Options
+
+
+
+
+
+
+
+
+
+See Also
+
+
+valgrind(1),
+&vg-docs-path; or
+&vg-docs-url;,
+&vg-gdbserver-label;
+&vg-vgdb-label;,
+&vg-monitor-label;.
+
+
+
+
+
+
+Author
+
+Philippe Waroquiers.
+
+
+
+
+
+
+
diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml
index a1a89796e..7d774e538 100644
--- a/docs/xml/manpages-index.xml
+++ b/docs/xml/manpages-index.xml
@@ -35,5 +35,13 @@
+
+
+
+
+
+
diff --git a/docs/xml/manual-core-adv.xml b/docs/xml/manual-core-adv.xml
index 870996fc7..23b88fe52 100644
--- a/docs/xml/manual-core-adv.xml
+++ b/docs/xml/manual-core-adv.xml
@@ -1102,7 +1102,8 @@ $5 = 36
intermediary between Valgrind and GDB or a shell.
Therefore, it has two usage modes:
-
+
+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:
+
vgdb accepts the following
options:
-
-
- : specifies the PID of
+
+
+
+
+ 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 argument is not given and multiple
Valgrind gdbserver processes are running, vgdb will report the
- list of such processes and then exit.
-
+ list of such processes and then exit.
+
-
- must be given to both
+
+
+ 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.
-
+ gdbserver and vgdb.
+
-
- instructs vgdb to
+
+
+ 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:
"target remote" command, you must set the GDB remotetimeout to a
value bigger than the --wait argument value. See option
(just below)
- for an example of setting the remotetimeout value.
-
+ for an example of setting the remotetimeout value.
+
-
- gives the
+
+
+ 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:
-
-
+
+
-
- instructs a
+
+
+ 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.
-
+ The default value is to never time out.
+
-
- instructs vgdb to
+
+
+ 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
]]>
where targetip is the ip address or hostname of the target computer.
-
-
+
+
-
- To give more than one command to a
+
+
+ To give more than one command to a
standalone vgdb, separate the commands by an
option . Example:
-
+]]>
+
-
- instructs a standalone vgdb to report
+
+
+ Instructs a standalone vgdb to report
the list of the Valgrind gdbserver processes running and then
- exit.
-
+ exit.
+
-
- instructs a standalone vgdb to show the
+
+
+ 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.
-
+ state.
+
-
- instructs vgdb to produce debugging
+
+
+ Instructs vgdb to produce debugging
output. Give multiple args to increase the
verbosity. When giving 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.
-
+ interaction between GDB and vgdb debugging output.
+
-
-
+
+
+
diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml
index e489fd6f0..9e2708aee 100644
--- a/docs/xml/manual-core.xml
+++ b/docs/xml/manual-core.xml
@@ -237,21 +237,27 @@ re-run, passing the option to Valgrind. A second
valgrind-listener accepts two
command-line options:
-
-
- or :
- 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.
-
-
- : 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 to
- Valgrind itself.
-
-
+
+
+
+
+
+ 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.
+
+
+
+
+
+ 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
+ to Valgrind itself.
+
+
+
+
If a Valgrinded process fails to connect to a listener, for
whatever reason (the listener isn't running, invalid or unreachable