contrib/libpcap/pcap_dump.3pcap

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