lsa.idl: use 'boolean8 check_only' instead of 'uint8 check_only'
[samba.git] / librpc / tools / ndrdump.1.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 <refentry id="ndrdump.1">
4
5 <refmeta>
6         <refentrytitle>ndrdump</refentrytitle>
7         <manvolnum>1</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.0</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>ndrdump</refname>
16         <refpurpose>DCE/RPC Packet Parser and Dumper</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>ndrdump</command>
22                 <arg choice="opt">-c context</arg>
23                 <arg choice="req">pipe</arg>
24                 <arg choice="req">function</arg>
25                 <arg choice="req">in|out</arg>
26                 <arg choice="req">filename</arg>
27         </cmdsynopsis>
28         <cmdsynopsis>
29                 <command>ndrdump</command>
30                 <arg choice="opt">pipe</arg>
31         </cmdsynopsis>
32         <cmdsynopsis>
33                 <command>ndrdump</command>
34         </cmdsynopsis>
35 </refsynopsisdiv>
36
37 <refsect1>
38         <title>DESCRIPTION</title>
39
40         <para>ndrdump tries to parse the specified <replaceable>filename</replaceable>
41                 using Samba's parser for the specified pipe and function. The 
42                 third argument should be 
43                 either <emphasis>in</emphasis> or <emphasis>out</emphasis>, depending 
44                 on whether the data should be parsed as a request or a reply.</para>
45
46         <para>Running ndrdump without arguments will list the pipes for which 
47                 parsers are available.</para>
48
49         <para>Running ndrdump with one argument will list the functions that 
50                 Samba can parse for the specified pipe.</para>
51
52         <para>The primary function of ndrdump is debugging Samba's internal 
53                 DCE/RPC parsing functions. The file being parsed is usually 
54                 one exported by wiresharks <quote>Export selected packet bytes</quote> 
55                 function.</para>
56
57         <para>The context argument can be used to load context data from the request 
58                 packet when parsing reply packets (such as array lengths).</para>
59
60 </refsect1>
61
62 <refsect1>
63         <title>VERSION</title>
64
65         <para>This man page is correct for version 4.0 of the Samba suite.</para>
66 </refsect1>
67
68 <refsect1>
69         <title>SEE ALSO</title>
70
71         <para>wireshark, pidl</para>
72
73 </refsect1>
74
75 <refsect1>
76         <title>AUTHOR</title>
77
78         <para>This utility is part of the <ulink url="http://www.samba.org/">Samba</ulink> suite, which is developed by the global <ulink url="http://www.samba.org/samba/team/">Samba Team</ulink>.</para>
79
80         <para>ndrdump was written by Andrew Tridgell. </para>
81
82         <para>This manpage was written by Jelmer Vernooij. </para>
83         
84 </refsect1>
85
86 </refentry>