Skip to content
Browse files

documentation updates

  • Loading branch information...
1 parent 8c0715c commit 2f0b27b60ba95033beb355edd6d88622a382428b @atomontage committed Oct 5, 2011
Showing with 13 additions and 16 deletions.
  1. +1 −3 README.org
  2. +12 −13 doc/plokami.html
View
4 README.org
@@ -15,9 +15,7 @@ LispWorks (darwin/win32) but should work on every platform that
CFFI supports.
* Performance
-Minimal/non-existent overhead over plain libpcap. Low memory
-use with very few dynamic allocations. No GC delays/packet loss due to
-garbage collection.
+Minimal overhead over plain libpcap.
* License
The code comes with a BSD-style license so you can basically do with it
View
25 doc/plokami.html
@@ -51,20 +51,19 @@
that <a href="http://common-lisp.net/project/cffi/">CFFI</a> supports.
</p>
<p>
- <strong>Performance:</strong> Minimal/non-existent overhead over plain libpcap.
- Low memory use with very few dynamic allocations. No GC delays/packet loss due to garbage collection.
+ <strong>Performance:</strong> Minimal overhead over plain libpcap.
+ Low memory use with few dynamic allocations.
</p>
<p>
<strong>NOTE:</strong> Read timeouts, non-blocking mode operation and the
- use of select/epoll/kqueue on the live interface file descriptor (as returned
+ use of select/epoll/kqueue on the live interface descriptor (as returned
by <a href="#pcap-live-descriptor"><code>pcap-live-descriptor</code></a>)
- depend on support from operating system/libpcap. If things involving these
- operations do not work as they should, consult libpcap documentation
- and platform specific notes.
+ depend on support from operating system/libpcap. If issues arise,
+ consult libpcap documentation and platform specific notes.
<br /><br />
- The file descriptor
+ The descriptor
can not be used with <strong>kqueue</strong> on OSX (as of 10.5)
- although the same file descriptor works fine with <strong>select</strong>.
+ although the same descriptor works fine with <strong>select</strong>.
Recent FreeBSD versions have fixed this and <strong>kqueue</strong> works
with no issues on these platforms.
</p>
@@ -162,7 +161,7 @@
welcome) </p>
<p>If <a href="#find-all-devs"><code>find-all-devs</code></a>
returns <b><i>NIL</i></b>, make sure you have appropriate permissions for
- packet capture (read access on /dev/bpf* devices for OSX/BSD, root/CAP_NET_RAW on Linux).</p>
+ packet capture (read /dev/bpf* for OSX/BSD, root/CAP_NET_RAW on Linux).</p>
<pre class='code'>
<span style="color: #008ed1;">PLOKAMI&gt; </span><span style="color: #ffffff;">(find-all-devs)</span>
@@ -296,8 +295,8 @@
<blockquote><br />
Return a list of all network devices that can be opened for capture. Result
-list mirrors layout explained in pcap_findalldevs(3). <b><i>NIL</i></b> is returned when
-no interfaces are available, possibly due to permission issues.<br />
+list layout explained in pcap_findalldevs(3). <b><i>NIL</i></b> is returned when
+no interfaces are available (e.g. permissionissues)<br />
Signals <a href="#network-interface-error"><code>NETWORK-INTERFACE-ERROR</code></a> on errors.
</blockquote>
@@ -368,10 +367,10 @@
</p>
<blockquote><br />
-Returns packet capture statistics from the start of the run
+Return packet capture statistics from the start of the run
to the time of the call for live interface capture only. Statistics are
returned as multiple values and correspond to packets received,
-packets dropped and packets dropped by interface (in this order).
+packets dropped and packets dropped by interface (in that order).
<a href="#network-interface-error"><code>NETWORK-INTERFACE-ERROR</code></a> is signaled on failure.
</blockquote>

0 comments on commit 2f0b27b

Please sign in to comment.
Something went wrong with that request. Please try again.