forked from the-tcpdump-group/tcpdump-htdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
season-of-docs.html
90 lines (80 loc) · 3.45 KB
/
season-of-docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<TITLE>Season of Docs for tcpdump.org</TITLE>
<LINK REV="MADE" HREF="mailto:[email protected]">
<link href="style.css" rel="stylesheet" type="text/css" media="screen">
</HEAD>
<BODY>
<!-- TOP MENU -->
<div id="menu">
<ul>
<li class="current_page_item"><a href="#">Home</a></li>
<li><a href="#source">Source</a></li>
<li><a href="#latest-releases">Downloads</a></li>
<li><a href="#mailing-lists">Mailing list</a></li>
<li><a href="#security">Security</a></li>
<li><a href="#contribute">Contribute</a></li>
<li><a href="related.html">Related Projects</a></li>
<li><a href="linktypes.html">Link-Layer Header Types</a></li>
</ul>
</div>
<!-- END OF TOP MENU -->
<!-- PAGE HEADER -->
<div id="splash">
<br/><img src="images/logo.png" alt="" />
</div>
<div id="logo">
<hr />
</div>
<!-- END OF PAGE HEADER -->
<!-- PAGE CONTENTS -->
<div id="page">
<!-- RIGHT HAND SIDE PAGE CONTENTS -->
<div id="content">
<h2 class="title">Season of Docs ideas</h2>
<p>
To complement (I guess!) the Google Summer of Code, Google has started a
<a href="https://developers.google.com/season-of-docs/">Season of Docs</a>
to "Let's bring open source and technical writer communities together, to
the benefit of both. "
</p>
<p>
The TCPUMP group maintains the tcpdump packet decoder, and the libpcap capture
library. libpcap is used by wide variety of <a href="related.html">network diagnostic tools</a>
including the very
popular <a href="https://www.wireshark.org/">wireshark</a>.
</p>
<p>
TCPDUMP contains two sets of Unix-style manpages: <a href="manpages/tcpdump.1.html">tcpdump(1)</a>
and <a href="manpages/pcap.3pcap.html">pcap(3pcap)</a>. The later of
which links to 60-some additional pcap pages. In addition there is a set
of <a href="linktypes.html">link types</a> which describe the kind of
information and meta-information that can be found in pcap files,
an ancient <a href="pcap.html">pcap tutorial</a>. There is an ancient
<a href="faq.html">FAQ</a> which is hard to update and hard to add things
to.
</p>
<p>
Some ideas for things to redo:
<ul>
<li> rewrite the manpages to provide better reference, removing tutorial
contents, but including "contract" promises</li>
<li> create higher-level documentation (in HTML or markdown), with
diagrams, to explain how to use libpcap to a programmer new to
libpcap</li>
<li> illustrate an actual example via an API walkthrough with libpcap.
This could involve the tcpsplice code or something new.</li>
<li> tuning for better performance of libpcap, advanced details on
Linux memory mapped packet interfaces, how to use threads with
libpcap</li>
<li> moving the site from static CSS to jekyll, rehosting it all
on github </li>
</ul>
</p>
</div>
</div>
<hr>
by <a href="http://www.sandelman.ca/mcr/Bio.html">MCR</a>
</BODY></HTML>