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 "3 July 2020"
  21 .SH NAME
  22 pcap_dump_open, pcap_dump_open_append, pcap_dump_fopen \- open a file to
  23 which to write packets
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .ft
  29 .nf
  30 .LP
  31 .ft B
  32 pcap_dumper_t *pcap_dump_open(pcap_t *p, const char *fname);
  33 pcap_dumper_t *pcap_dump_open_append(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 .BR 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 If the file does not exist, it will be created; if the file exists, it
  47 will be truncated and overwritten.
  48 The name "-" is a synonym
  49 for
  50 .BR stdout .
  51 .PP
  52 .BR pcap_dump_fopen ()
  53 is called to write data to an existing open stream
  54 .IR fp ;
  55 this stream will be closed by a subsequent call to
  56 .BR pcap_dump_close (3PCAP).
  57 The stream is assumed to be at the beginning of a file that has been
  58 newly created or truncated, so that writes will start at the beginning
  59 of the file.
  60 Note that on Windows, that stream should be opened in binary mode.
  61 .PP
  62 .I p
  63 is a capture or ``savefile'' handle returned by an earlier call to
  64 .BR pcap_create (3PCAP)
  65 and activated by an earlier call to
  66 .BR \%pcap_activate (3PCAP),
  67 or returned by an earlier call to
  68 .BR \%pcap_open_offline (3PCAP),
  69 .BR pcap_open_live (3PCAP),
  70 or
  71 .BR pcap_open_dead (3PCAP).
  72 The time stamp precision, link-layer type, and snapshot length from
  73 .I p
  74 are used as the link-layer type and snapshot length of the output file.
  75 .PP
  76 .BR pcap_dump_open_append ()
  77 is like
  78 .BR pcap_dump_open ()
  79 but, if the file already exists, and is a pcap file with the same byte
  80 order as the host opening the file, and has the same time stamp
  81 precision, link-layer header type, and snapshot length as
  82 .IR p ,
  83 it will write new packets at the end of the file.
  84 .SH RETURN VALUE
  85 A pointer to a
  86 .B pcap_dumper_t
  87 structure to use in subsequent
  88 .BR pcap_dump (3PCAP)
  89 and
  90 .BR pcap_dump_close (3PCAP)
  91 calls is returned on success.
  92 .B NULL
  93 is returned on failure.
  94 If
  95 .B NULL
  96 is returned,
  97 .BR pcap_geterr (3PCAP)
  98 can be used to get the error text.
  99 .SH BACKWARD COMPATIBILITY
 100 .PP
 101 The
 102 .BR pcap_dump_open_append ()
 103 function became available in libpcap release 1.7.2.  In previous
 104 releases, there is no support for appending packets to an existing
 105 savefile.
 106 .SH SEE ALSO
 107 .BR pcap (3PCAP),
 108 .BR \%pcap-savefile (@MAN_FILE_FORMATS@)