Bug 497723 - forgot to restore callgrind output cleanup
[valgrind.git] / auxprogs / docs / valgrind-di-server-manpage.xml
blob3b029ee773f7cf1e451d487622eb3d675dd28d55
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; ]>
7 <refentry id="di-server">
9 <refmeta>
10   <refentrytitle>valgrind-di-server</refentrytitle>
11   <manvolnum>1</manvolnum>
12   <refmiscinfo class="version">Release &rel-version;</refmiscinfo>
13 </refmeta>
15 <refnamediv>
16   <refname>valgrind-di-server</refname>
17   <refpurpose>Experimental debuginfo server for valgrind</refpurpose>
18 </refnamediv>
20 <refsynopsisdiv>
21 <cmdsynopsis>
22   <command>valgrind-di-server</command>
23   <arg><replaceable>options</replaceable></arg>
24 </cmdsynopsis>
25 </refsynopsisdiv>
28 <refsect1 id="di-server-description">
29 <title>Description</title>
31 <para><command>valgrind-di-server</command> accepts (multiple) connections
32 from <command>valgrind</command> processes that use the
33 <option> --debuginfo-server</option> option on the specified port and serves
34 (compressed) debuginfo files (in chunks) from the current working directory.
35 </para>
37 </refsect1>
41 <refsect1 id="di-server-options">
42 <title>Options</title>
43   <variablelist>
44      <varlistentry>
45        <term><option>-e --exit-at-zero</option></term>
46        <listitem>
47          <para>When the number of connected processes falls back to zero,
48          exit.  Without this, it will run forever, that is, until you
49          send it Control-C.</para>
50        </listitem>
51      </varlistentry>
52      <varlistentry>
53        <term><option>--max-connect=INTEGER</option></term>
54        <listitem>
55          <para>By default, the server can connect to up to 50 processes.
56            Occasionally, that number is too small. Use this option to
57            provide a different limit. E.g.
58            <computeroutput>--max-connect=100</computeroutput>.
59          </para>
60        </listitem>
61      </varlistentry>
62      <varlistentry>
63       <term><option>portnumber</option></term>
64       <listitem>
65         <para>Changes the port it listens on from the default (1500).
66         The specified port must be in the range 1024 to 65535.
67         The same restriction applies to port numbers specified by the
68         <option>--debuginfo-server</option> option to Valgrind itself.</para>
69       </listitem>
70     </varlistentry>
71   </variablelist>
72 </refsect1>
77 <refsect1 id="di-server-see_also">
78 <title>See Also</title>
80 <para>
81 valgrind(1),
82 <filename>&vg-docs-path;</filename> or
83 <filename>&vg-docs-url;</filename>.
84 </para>
86 </refsect1>
89 <refsect1 id="di-server-author">
90 <title>Author</title>
92 <para>Julian Seward.</para>
94 </refsect1>
97 </refentry>