Add log2pcap manpage
[Samba/gebeck_regimport.git] / docs / manpages / log2pcap.1
blobb2a2e53606f2a95a0144079cc141250f1c3e5f3c
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
20 .TH "LOG2PCAP" 1 "" "" ""
21 .SH NAME
22 log2pcap \- Extract network traces from Samba log files
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 9
27 \fBlog2pcap\fR [\-h] [logfile] [pcap_file]
28 .ad
29 .hy
31 .SH "DESCRIPTION"
33 .PP
34 This tool is part of the \fBSamba\fR(7) suite\&.
36 .PP
37 \fBlog2pcap\fR 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\&.
39 .PP
40 The log file must have a \fIlog level\fR of at least \fB5\fR to get the SMB header/parameters right, \fB10\fR to get the first 512 data bytes of the packet and \fB50\fR to get the whole packet\&.
42 .SH "OPTIONS"
44 .TP
45 \-h
46 If this parameter is specified the output file will be a hex dump, in a format that is readable by the text2pcap utility\&.
49 .TP
50 logfile
51 Samba log file\&. log2pcap will try to read the log from stdin if the log file is not specified\&.
54 .TP
55 pcap_file
56 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\&.
59 .TP
60 \-h|\-\-help
61 Print a summary of command line options\&.
64 .SH "EXAMPLES"
66 .PP
67 Extract all network traffic from all samba log files:
69 .PP
71 .nf
73         $ cat /var/log/* | log2pcap > trace\&.pcap
74         .fi
77 .PP
78 Convert to pcap using text2pcap:
80 .PP
82 .nf
84         $ log2pcap \-h samba\&.log | text2pcap \-T 139,139 \- trace\&.pcap
85         .fi
88 .SH "VERSION"
90 .PP
91 This man page is correct for version 3\&.0 of the Samba suite\&.
93 .SH "BUGS"
95 .PP
96 Only SMB data is extracted from the samba logs, no LDAP, NetBIOS lookup or other data\&.
98 .PP
99 The generated TCP and IP headers don't contain a valid checksum\&.
101 .SH "SEE ALSO"
104 \fBtext2pcap\fR(1), \fBethereal\fR(1)
106 .SH "AUTHOR"
109 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\&.
112 This manpage was written by Jelmer Vernooij\&.