-
Notifications
You must be signed in to change notification settings - Fork 50
/
Copy pathseason-of-docs.html
127 lines (116 loc) · 5.25 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<!DOCTYPE html>
<html lang="en">
<!-- HEAD -->
<head>
<meta charset="utf-8">
<title>Season of Docs | TCPDUMP & LIBPCAP</title>
<meta name="description" content="Web site of Tcpdump and Libpcap">
<link href="style.css" rel="stylesheet" type="text/css" media="screen">
<link href="images/T-32x32.png" rel="shortcut icon" type="image/png">
</head>
<!-- END OF HTML HEAD -->
<!-- BODY -->
<body>
<!-- TOP MENU -->
<div id="menu">
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="security.html">Security</a></li>
<li><a href="faq.html">FAQ</a></li>
<li><a href="manpages/">Man Pages</a></li>
<li><a href="ci.html">CI</a></li>
<li><a href="linktypes.html">Link-Layer Header Types</a></li>
<li><a href="bpfexam/">BPF Exam</a></li>
<li><a href="related.html">See Also</a></li>
<li><a href="old_releases.html">Old Releases</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">
<div class="post">
<h2 class="title">
Season of Docs ideas
</h2>
<div class="entry">
<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 Tcpdump 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>
This web site contains many Unix-style man pages, most notably
<a href="manpages/tcpdump.1.html"><b>tcpdump</b></a>(1)
and <a href="manpages/pcap.3pcap.html"><b>pcap</b></a>(3PCAP), the latter of
which links to 60-some more specific man pages. In addition there is a set
of <a href="linktypes.html">link-layer header types</a>, which describe the kind of
information and meta-information that can be found in pcap files,
and an ancient <a href="pcap.html">pcap tutorial</a>. There is a
<a href="faq.html">FAQ</a>, which does not address all present day issues.
</p>
<p>
Some ideas for things to improve:
</p>
<ul>
<li>Rewrite the man pages to provide better reference, removing tutorial
contents, but including "contract" promises.</li>
<li>Add missing man pages for some functions (<code>pcap_open()</code>,
<code>pcap_createsrcstr()</code>, <code>pcap_parsesrcstr()</code>,
<code>pcap_findalldevs_ex()</code>, <code>pcap_setsampling()</code>,
<code>pcap_setbuff()</code>, <code>pcap_setmode()</code>,
<code>pcap_setmintocopy()</code>,
<code>pcap_remoteact_accept()</code>, <code>pcap_remoteact_accept_ex()</code>,
<code>pcap_remoteact_list()</code>, <code>pcap_remoteact_close()</code> and
<code>pcap_remoteact_cleanup()</code>).
</li>
<li>Create higher-level documentation, with
diagrams, to explain how to use libpcap to a programmer new to
libpcap.</li>
<li>Idem, to explain what is done where in libpcap source code.</li>
<li>Explain tuning for better performance of libpcap, advanced details on
Linux memory mapped packet interfaces, how to use threads with
libpcap.</li>
<li>Improve the
<span class=manref><a href="manpages/pcap-filter.7.html"><b>pcap-filter</b></a>(7)</span>
man page as suggested in
<a href="https://github.com/the-tcpdump-group/libpcap/issues/125">this</a>
libpcap bug report.</li>
<li>In the FAQ explain why it is a good idea to run tcpdump with
the <code>-n</code> flag at all times.</li>
<li>Ibid., explain in detail the recommended way to build other software
with libpcap using <code>pkg-config</code> and <code>pcap-config</code>.
</li>
<li>Add README files to document setup, usage and implemented features
of the DPDK, Netmap and RDMA modules in libpcap.</li>
</ul>
</div>
</div>
</div>
<!-- END OF PAGE CONTENTS -->
<!-- FOOTER -->
<div id="footer">
<p>
This web site is © 1999–2025 The Tcpdump Group
(<a href="https://github.com/the-tcpdump-group/tcpdump-htdocs/blob/master/README.md">more
information</a>).
</p>
</div>
<!-- END OF FOOTER -->
</body>
<!-- END OF HTML BODY -->
</html>