contrib/libpcap/pcap_dump_open.3pcap.in

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_dump_open.3pcap.in,v 1.1.2.2 2008-10-23 05:59:43 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_OPEN 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_dump_open, pcap_dump_fopen \- open a file to which to write packets
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .nf
  31 .LP
  32 .ft B
  33 pcap_dumper_t *pcap_dump_open(pcap_t *p, const char *fname);
  34 pcap_dumper_t *pcap_dump_fopen(pcap_t *p, FILE *fp);
  35 .ft
  36 .fi
  37 .SH DESCRIPTION
  38 .B pcap_dump_open()
  39 is called to open a ``savefile'' for writing.
  40 .I fname
  41 specifies the name of the file to open. The file will have
  42 the same format as those used by
  43 .BR tcpdump (1)
  44 and
  45 .BR tcpslice (1).
  46 The name "-" in a synonym
  47 for
  48 .BR stdout .
  49 .PP
  50 .B pcap_dump_fopen()
  51 is called to write data to an existing open stream
  52 .IR fp .
  53 Note that on Windows, that stream should be opened in binary mode.
  54 .PP
  55 .I p
  56 is a capture or ``savefile'' handle returned by an earlier call to
  57 .B pcap_create()
  58 and activated by an earlier call to
  59 .BR pcap_activate() ,
  60 or returned by an earlier call to
  61 .BR pcap_open_offline() ,
  62 .BR pcap_open_live() ,
  63 or
  64 .BR pcap_open_dead() .
  65 The link-layer type and snapshot length from
  66 .I p
  67 are used as the link-layer type and snapshot length of the output file.
  68 .SH RETURN VALUES
  69 A pointer to a
  70 .B pcap_dumper_t
  71 structure to use in subsequent
  72 .B pcap_dump()
  73 and
  74 .B pcap_dump_close()
  75 calls is returned on success.
  76 .B NULL
  77 is returned on failure.
  78 If
  79 .B NULL
  80 is returned,
  81 .B pcap_geterr(\fIp\fB)
  82 can be used to get the error text.
  83 .SH SEE ALSO
  84 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  85 pcap_open_offline(3PCAP), pcap_open_live(3PCAP), pcap_open_dead(3PCAP),
  86 pcap_dump(3PCAP), pcap_dump_close(3PCAP), pcap_geterr(3PCAP),
  87 pcap-savefile(@MAN_FILE_FORMATS@)