|author||guy <guy>||2008-04-05 20:19:41 +0000|
|committer||guy <guy>||2008-04-05 20:19:41 +0000|
Split the pcap(3) man page into a bunch of individual man pages for
functions plus an overall man page for libpcap, and put them all into section 3PCAP. That means you can actually do "man pcap_open_live" and get something meaningful, rather than having to do "man pcap" and then scroll through all the other stuff in the man page.
Diffstat (limited to 'pcap_stats.3pcap')
1 files changed, 59 insertions, 0 deletions
diff --git a/pcap_stats.3pcap b/pcap_stats.3pcap
new file mode 100644
@@ -0,0 +1,59 @@
+.\" @(#) $Header: /tcpdump/master/libpcap/pcap_stats.3pcap,v 1.1 2008-04-05 20:19:42 guy Exp $
+.\" Copyright (c) 1994, 1996, 1997
+.\" The Regents of the University of California. All rights reserved.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that: (1) source code distributions
+.\" retain the above copyright notice and this paragraph in its entirety, (2)
+.\" distributions including binary code include the above copyright notice and
+.\" this paragraph in its entirety in the documentation or other materials
+.\" provided with the distribution, and (3) all advertising materials mentioning
+.\" features or use of this software display the following acknowledgement:
+.\" ``This product includes software developed by the University of California,
+.\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
+.\" the University nor the names of its contributors may be used to endorse
+.\" or promote products derived from this software without specific prior
+.\" written permission.
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
+.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.TH PCAP_SNAPSHOT 3PCAP "4 April 2008"
+pcap_stats \- get capture statistics
+int pcap_stats(pcap_t *p, struct pcap_stat *ps);
+fills in the
+structure pointed to by its second argument. The values represent
+packet statistics from the start of the run to the time of the call.
+is supported only on live captures, not on ``savefiles''; no statistics
+are stored in ``savefiles'', so no statistics are available when reading
+from a ``savefile''.
+.SH RETURN VALUE
+returns 0 on success and returns \-1 if there is an error or the
+doesn't support packet statistics.
+If \-1 is returned,
+may be called with
+as an argument to fetch or display the error text.
+.SH SEE ALSO