summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-08-18 17:57:20 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-08-18 17:57:20 +0000
commitf1b18e06d7a35724d15b21f8d1ac6fcb631b918e (patch)
tree1cc8f985d12d246af652d4f79fbff062de19a2fe /docs/docbook
parentc632aac08594ada375352e6608dfde39d6fd4c5b (diff)
downloadsamba-f1b18e06d7a35724d15b21f8d1ac6fcb631b918e.tar.gz
samba-f1b18e06d7a35724d15b21f8d1ac6fcb631b918e.tar.bz2
samba-f1b18e06d7a35724d15b21f8d1ac6fcb631b918e.zip
- Small fix in smbsh.1.xml
- Add manpage for log2pcap (This used to be commit edd749fc89b882cf0953d85d49ec337bbd082f18)
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/Makefile.in2
-rw-r--r--docs/docbook/manpages/log2pcap.1.xml131
-rw-r--r--docs/docbook/manpages/smbsh.1.xml2
3 files changed, 133 insertions, 2 deletions
diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in
index e8495073f9..14f9a7dfcb 100644
--- a/docs/docbook/Makefile.in
+++ b/docs/docbook/Makefile.in
@@ -21,7 +21,7 @@ MANPAGES_NAMES=findsmb.1 smbclient.1 \
smbcacls.1 smbsh.1 winbindd.8 \
tdbbackup.8 vfstest.1 \
profiles.1 smbtree.1 ntlm_auth.1 \
- editreg.1 smbcquotas.1
+ editreg.1 smbcquotas.1 log2pcap.1
## This part contains only rules. You shouldn't need to change it
## if you are adding docs
diff --git a/docs/docbook/manpages/log2pcap.1.xml b/docs/docbook/manpages/log2pcap.1.xml
new file mode 100644
index 0000000000..c375fcd515
--- /dev/null
+++ b/docs/docbook/manpages/log2pcap.1.xml
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
+<refentry id="log2pcap.1">
+
+<refmeta>
+ <refentrytitle>log2pcap</refentrytitle>
+ <manvolnum>1</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+ <refname>log2pcap</refname>
+ <refpurpose>Extract network traces from Samba log files</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>log2pcap</command>
+ <arg choice="opt">-h</arg>
+ <arg choice="opt">logfile</arg>
+ <arg choice="opt">pcap_file</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><command>log2pcap</command> reads in a
+ samba log file and generates a pcap file (readable
+ by most sniffers, such as ethereal or tcpdump) based on the packet
+ dumps in the log file.</para>
+
+ <para>The log file must have a <parameter>log level</parameter>
+ of at least <constant>5</constant> to get the SMB header/parameters
+ right, <constant>10</constant> to get the first 512 data bytes of the
+ packet and <constant>50</constant> to get the whole packet.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>-h</term>
+ <listitem><para>If this parameter is
+ specified the output file will be a
+ hex dump, in a format that is readable
+ by the <application>text2pcap</application> utility.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>logfile</term>
+ <listitem><para>
+ Samba log file. log2pcap will try to read the log from stdin
+ if the log file is not specified.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pcap_file</term>
+ <listitem><para>
+ Name of the output file to write the pcap (or hexdump) data to.
+ If this argument is not specified, output data will be written
+ to stdout.
+ </para></listitem>
+ </varlistentry>
+
+ &stdarg.help;
+
+ </variablelist>
+</refsect1>
+
+<refsect1>
+ <title>EXAMPLES</title>
+
+ <para>Extract all network traffic from all samba log files:</para>
+
+ <para><screen>
+ <prompt>$</prompt> cat /var/log/* | log2pcap > trace.pcap
+ </screen></para>
+
+ <para>Convert to pcap using text2pcap:</para>
+
+ <para><screen>
+ <prompt>$</prompt> log2pcap -h samba.log | text2pcap -T 139,139 - trace.pcap
+ </screen></para>
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+
+ <para>This man page is correct for version 3.0 of the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+ <title>BUGS</title>
+
+ <para>Only SMB data is extracted from the samba logs, no LDAP,
+ NetBIOS lookup or other data.</para>
+
+ <para>The generated TCP and IP headers don't contain a valid
+ checksum.</para>
+
+</refsect1>
+
+
+<refsect1>
+ <title>SEE ALSO</title>
+ <para><citerefentry><refentrytitle>text2pcap</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>ethereal</refentrytitle><manvolnum>1</manvolnum></citerefentry></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>
+
+ <para>This manpage was written by Jelmer Vernooij.</para>
+</refsect1>
+
+</refentry>
diff --git a/docs/docbook/manpages/smbsh.1.xml b/docs/docbook/manpages/smbsh.1.xml
index 948d586589..73eb04d4c6 100644
--- a/docs/docbook/manpages/smbsh.1.xml
+++ b/docs/docbook/manpages/smbsh.1.xml
@@ -13,7 +13,7 @@
<refnamediv>
<refname>smbsh</refname>
- <refpurpose>Allows access to Windows NT filesystem
+ <refpurpose>Allows access to remote SMB shares
using UNIX commands</refpurpose>
</refnamediv>