docs-xml:manpages: Add man page for samba-log-parser

Signed-off-by: Pavel Filipenský <pfilipensky@samba.org>
Reviewed-by: Andreas Schneider <asn@samba.org>

diff --git a/docs-xml/manpages/samba-log-parser.1.xml b/docs-xml/manpages/samba-log-parser.1.xml
new file mode 100644 (file)
index 0000000..ea6fd91
--- /dev/null
+++ b/docs-xml/manpages/samba-log-parser.1.xml
@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="samba-log-parser.1">
+
+<refmeta>
+       <refentrytitle>samba-log-parser</refentrytitle>
+       <manvolnum>1</manvolnum>
+       <refmiscinfo class="source">Samba</refmiscinfo>
+       <refmiscinfo class="manual">User Commands</refmiscinfo>
+       <refmiscinfo class="version">&doc.version;</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+       <refname>samba-log-parser</refname>
+       <refpurpose>Samba (winbind) trace parser.</refpurpose>
+</refnamediv>
+options:
+  -h, --help     show this help message and exit
+  --traceid ID   specify the traceid of the trace records
+  --pid PID      specify the pid of winbind client
+  --breakdown    breakdown the traces into per traceid files
+  --merge        merge logs by timestamp
+  --flow         show the request/sub-request flow traces
+  --flow-compact show the request/sub-request flow traces without dcerpc details
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>samba-log-parser</command>
+               <arg choice="req">path</arg>
+               <arg choice="opt">--pid=PID</arg>
+       <arg choice="opt">--traceid=ID</arg>
+       <arg choice="opt">--breakdown</arg>
+               <arg choice="opt">--merge</arg>
+               <arg choice="opt">--flow</arg>
+               <arg choice="opt">--flow-compact</arg>
+               <arg choice="opt">-h|--help</arg>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+       <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+       <para>The <command>samba-log-parser</command> program parses samba winbind
+       logs.</para>
+</refsect1>
+
+
+<refsect1>
+       <title>OPTIONS</title>
+
+       <para>The following options are available to the <command>samba-log-parser</command> program.
+       </para>
+
+       <variablelist>
+               <varlistentry>
+               <term>--pid=PID</term>
+               <listitem><para>Display traces for winbind client with the matching PID.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>--traceid=ID</term>
+               <listitem><para>Display traces with matching traceid debug header field.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>--breakdown</term>
+       <listitem><para>Break down all traces to separate files in the current
+       working directory. For each traceid, three files are created:
+       traceid.full
+       traceid.flow
+       traceid.flowcompact
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>--merge</term>
+       <listitem><para>Sort the trace lines according to the timestamp.
+       </para></listitem>
+               </varlistentry>
+
+
+               <varlistentry>
+               <term>--flow</term>
+       <listitem><para>Display the request/sub-request flow.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>--flow-compact</term>
+       <listitem><para>Display the request/sub-request flow without dcerpc
+       call details.
+               </para></listitem>
+               </varlistentry>
+
+       </variablelist>
+</refsect1>
+
+
+<refsect1>
+       <title>EXAMPLES</title>
+
+       <para>Show the flow traces for trace id
+       <parameter>1234</parameter> from log file log.winbind:
+       </para>
+       <programlisting>
+       # samba-log-parser --traceid 1234 --flow /var/log/samba/log.winbind
+       </programlisting>
+
+       <para>Show the full traces for winbind client with PID
+       <parameter>999999</parameter>
+       sorted using the timestamp for log files found in the samba log directory:
+       </para>
+
+       <programlisting>
+       # samba-log-parser --pid 999999 --merge /var/log/samba
+       </programlisting>
+
+       <para>Break down the traces into separate files according to traceid sorted
+       using the timestamp for log files found in the samba log directory:
+       </para>
+
+       <programlisting>
+       # samba-log-parser --breakdown --merge /var/log/samba
+       </programlisting>
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>This man page is part of version &doc.version; of the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+       <title>AUTHOR</title>
+       <para>The original Samba software and related utilities
+       were created by Andrew Tridgell. Samba is now developed
+       by the Samba Team as an Open Source project similar
+       to the way the Linux kernel is developed.</para>
+</refsect1>
+
+</refentry>

diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build
index aa4fc0a12549068eadaa869ca925ad89587e1a88..95ed08ed1d8295937a303f7a8f445080f965b2b6 100644 (file)
--- a/docs-xml/wscript_build
+++ b/docs-xml/wscript_build
@@ -53,6 +53,7 @@ manpages='''
          manpages/traffic_replay.7
          manpages/wbinfo.1
          manpages/winbindd.8
+         manpages/samba-log-parser.1
          '''
 
 pam_winbind_manpages = '''