Update READMEs etc. for the forthcoming ppp-2.4.5 release
[ppp.git] / pppdump / pppdump.8
1 .\"     @(#) $Id: pppdump.8,v 1.2 2004/11/13 12:22:49 paulus Exp $
2 .TH PPPDUMP 8 "1 April 1999"
3 .SH NAME
4 pppdump \- convert PPP record file to readable format
5 .SH SYNOPSIS
6 .B pppdump
7 [
8 .B \-h
9 |
10 .B \-p
11 [
12 .B \-d
13 ]] [
14 .B \-r
15 ] [
16 .B \-m \fImru
17 ] [
18 .I file \fR...
19 ]
20 .ti 12
21 .SH DESCRIPTION
22 The
23 .B pppdump
24 utility converts the files written using the \fIrecord\fR option of
25 .B pppd
26 into a human-readable format.  If one or more filenames are specified,
27 .B pppdump
28 will read each in turn; otherwise it will read its standard input.  In
29 each case the result is written to standard output.
30 .PP
31 The options are as follows:
32 .TP
33 .B \-h
34 Prints the bytes sent and received in hexadecimal.  If neither this
35 option nor the \fB\-p\fR option is specified, the bytes are printed as
36 the characters themselves, with non-printing and non-ASCII characters
37 printed as escape sequences.
38 .TP
39 .B \-p
40 Collects the bytes sent and received into PPP packets, interpreting
41 the async HDLC framing and escape characters and checking the FCS
42 (frame check sequence) of each packet.  The packets are printed as hex
43 values and as characters (non-printable characters are printed as
44 `.').
45 .TP
46 .B \-d
47 With the \fB\-p\fR option, this option causes
48 .B pppdump
49 to decompress packets which have been compressed with the BSD-Compress
50 or Deflate methods.
51 .TP
52 .B \-r
53 Reverses the direction indicators, so that `sent' is printed for
54 bytes or packets received, and `rcvd' is printed for bytes or packets
55 sent.
56 .TP
57 .B \-m \fImru
58 Use \fImru\fR as the MRU (maximum receive unit) for both directions of
59 the link when checking for over-length PPP packets (with the \fB\-p\fR
60 option).
61 .SH SEE ALSO
62 pppd(8)