Merge illumos-gate
[unleashed.git] / contrib / libpcap / pcap_dump.3pcap
blob6402b4b4519b42f80376ca63879b0b36d8cdf385
1 .\" Copyright (c) 1994, 1996, 1997
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that: (1) source code distributions
6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
7 .\" distributions including binary code include the above copyright notice and
8 .\" this paragraph in its entirety in the documentation or other materials
9 .\" provided with the distribution, and (3) all advertising materials mentioning
10 .\" features or use of this software display the following acknowledgement:
11 .\" ``This product includes software developed by the University of California,
12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
13 .\" the University nor the names of its contributors may be used to endorse
14 .\" or promote products derived from this software without specific prior
15 .\" written permission.
16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
19 .\"
20 .TH PCAP_DUMP 3PCAP "8 March 2015"
21 .SH NAME
22 pcap_dump \- write a packet to a capture file
23 .SH SYNOPSIS
24 .nf
25 .ft B
26 #include <pcap/pcap.h>
27 .ft
28 .LP
29 .ft B
30 void pcap_dump(u_char *user, struct pcap_pkthdr *h,
31 .ti +8
32 u_char *sp);
33 .ft
34 .fi
35 .SH DESCRIPTION
36 .B pcap_dump()
37 outputs a packet to the ``savefile'' opened with
38 .BR pcap_dump_open() .
39 Note that its calling arguments are suitable for use with
40 .B pcap_dispatch()
42 .BR pcap_loop() .
43 If called directly, the
44 .I user
45 parameter is of type
46 .B pcap_dumper_t
47 as returned by
48 .BR pcap_dump_open() .
49 .SH SEE ALSO
50 pcap(3PCAP), pcap_dump_open(3PCAP), pcap_dispatch(3PCAP),
51 pcap_loop(3PCAP)