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 "22 August 2018"
  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_open_append(pcap_t *p, const char *fname);
  33 pcap_dumper_t *pcap_dump_fopen(pcap_t *p, FILE *fp);
  34 .ft
  35 .fi
  36 .SH DESCRIPTION
  37 .B pcap_dump_open()
  38 is called to open a ``savefile'' for writing.
  39 .I fname
  40 specifies the name of the file to open. The file will have
  41 the same format as those used by
  42 .BR tcpdump (1)
  43 and
  44 .BR tcpslice (1).
  45 The name "-" is a synonym
  46 for
  47 .BR stdout .
  48 .PP
  49 .B pcap_dump_fopen()
  50 is called to write data to an existing open stream
  51 .IR fp ;
  52 this stream will be closed by a subsequent call to
  53 .BR pcap_dump_close(3PCAP) .
  54 Note that on Windows, that stream should be opened in binary mode.
  55 .PP
  56 .I p
  57 is a capture or ``savefile'' handle returned by an earlier call to
  58 .B pcap_create(3PCAP)
  59 and activated by an earlier call to
  60 .BR \%pcap_activate(3PCAP) ,
  61 or returned by an earlier call to
  62 .BR \%pcap_open_offline(3PCAP) ,
  63 .BR pcap_open_live(3PCAP) ,
  64 or
  65 .BR pcap_open_dead(3PCAP) .
  66 The time stamp precision, link-layer type, and snapshot length from
  67 .I p
  68 are used as the link-layer type and snapshot length of the output file.
  69 .PP
  70 .B pcap_dump_open_append()
  71 is like
  72 .B pcap_dump_open()
  73 but does not create the file if it does not exist and, if it does
  74 already exist, and is a pcap file with the same byte order as the host
  75 opening the file, and has the same time stamp precision, link-layer
  76 header type, and snapshot length as
  77 .IR p ,
  78 it will write new packets at the end of the file.
  79 .SH RETURN VALUES
  80 A pointer to a
  81 .B pcap_dumper_t
  82 structure to use in subsequent
  83 .B pcap_dump(3PCAP)
  84 and
  85 .B pcap_dump_close(3PCAP)
  86 calls is returned on success.
  87 .B NULL
  88 is returned on failure.
  89 If
  90 .B NULL
  91 is returned,
  92 .B pcap_geterr(3PCAP)
  93 can be used to get the error text.
  94 .SH BACKWARD COMPATIBILITY
  95 .PP
  96 The
  97 .B pcap_dump_open_append()
  98 function became available in libpcap release 1.7.2.  In previous
  99 releases, there is no support for appending packets to an existing
 100 savefile.
 101 .SH SEE ALSO
 102 pcap(3PCAP),
 103 \%pcap-savefile(@MAN_FILE_FORMATS@)