From: Mark Wielaard <mark@klomp.org>
Date: Sun, 7 Apr 2019 16:28:40 +0000 (+0200)
Subject: Add (minimal) manual page for valgrind-di-server.
X-Git-Tag: VALGRIND_3_15_0~22
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=19906dc4d9a188d711d319ca07b0a6767205eb8f;p=thirdparty%2Fvalgrind.git

Add (minimal) manual page for valgrind-di-server.

This adds a minimal man page for the experimental valgrind-di-server
so that we have manual pages for all (auxiliary) programs we install.
---

diff --git a/auxprogs/Makefile.am b/auxprogs/Makefile.am
index aa92bec4d2..56cc5efc70 100644
--- a/auxprogs/Makefile.am
+++ b/auxprogs/Makefile.am
@@ -13,6 +13,7 @@ dist_noinst_SCRIPTS = \
 
 EXTRA_DIST = \
 	docs/valgrind-listener-manpage.xml \
+	docs/valgrind-di-server-manpage.xml \
 	gsl16-badfree.patch \
 	gsl16-wavelet.patch \
 	posixtestsuite-1.5.1-diff.txt \
diff --git a/auxprogs/docs/valgrind-di-server-manpage.xml b/auxprogs/docs/valgrind-di-server-manpage.xml
new file mode 100644
index 0000000000..deca81d0a4
--- /dev/null
+++ b/auxprogs/docs/valgrind-di-server-manpage.xml
@@ -0,0 +1,99 @@
+<?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="di-server">
+
+<refmeta>
+  <refentrytitle>valgrind-di-server</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo>Release &rel-version;</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>valgrind-di-server</refname>
+  <refpurpose>Experimental debuginfo server for valgrind</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+  <command>valgrind-di-server</command>
+  <arg><replaceable>options</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id="description">
+<title>Description</title>
+
+<para><command>valgrind-di-server</command> accepts (multiple) connections
+from <command>valgrind</command> processes that use the
+<option> --debuginfo-server</option> option on the specified port and serves
+(compressed) debuginfo files (in chunks) from the current working directory.
+</para>
+
+</refsect1>
+
+
+
+<refsect1 id="options">
+<title>Options</title>
+  <variablelist>
+     <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>--max-connect=INTEGER</option></term>
+       <listitem>
+         <para>By default, the server can connect to up to 50 processes.
+           Occasionally, that number is too small. Use this option to
+           provide a different limit. E.g.
+           <computeroutput>--max-connect=100</computeroutput>.
+         </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 the
+        <option>--debuginfo-server</option> option to Valgrind itself.</para>
+      </listitem>
+    </varlistentry>
+  </variablelist>
+</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>
+
+
diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml
index 7d774e5383..a038ee416f 100644
--- a/docs/xml/manpages-index.xml
+++ b/docs/xml/manpages-index.xml
@@ -39,6 +39,10 @@
 <xi:include href="../../auxprogs/docs/valgrind-listener-manpage.xml"
     parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
+<!-- valgrind-di-server -->
+<xi:include href="../../auxprogs/docs/valgrind-di-server-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" />