contrib/libpcap/pcap_dump_open.3pcap.in

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